diff --git a/.openapi-generator/custom_templates/configuration.mustache b/.openapi-generator/custom_templates/configuration.mustache deleted file mode 100644 index 0cb59f8b4..000000000 --- a/.openapi-generator/custom_templates/configuration.mustache +++ /dev/null @@ -1,637 +0,0 @@ -{{>partial_header}} - -import copy -import logging -{{^asyncio}} -import multiprocessing -{{/asyncio}} -import sys -import urllib3 - -from http import client as http_client -from {{packageName}}.exceptions import ApiValueError - - -JSON_SCHEMA_VALIDATION_KEYWORDS = { - 'multipleOf', 'maximum', 'exclusiveMaximum', - 'minimum', 'exclusiveMinimum', 'maxLength', - 'minLength', 'pattern', 'maxItems', 'minItems' -} - -class Configuration(object): - """NOTE: This class is auto generated by OpenAPI Generator - - Ref: https://openapi-generator.tech - Do not edit the class manually. - - :param host: Base url - :param api_key: Dict to store API key(s). - Each entry in the dict specifies an API key. - The dict key is the name of the security scheme in the OAS specification. - The dict value is the API key secret. - :param api_key_prefix: Dict to store API prefix (e.g. Bearer) - The dict key is the name of the security scheme in the OAS specification. - The dict value is an API key prefix when generating the auth data. - :param username: Username for HTTP basic authentication - :param password: Password for HTTP basic authentication - :param discard_unknown_keys: Boolean value indicating whether to discard - unknown properties. A server may send a response that includes additional - properties that are not known by the client in the following scenarios: - 1. The OpenAPI document is incomplete, i.e. it does not match the server - implementation. - 2. The client was generated using an older version of the OpenAPI document - and the server has been upgraded since then. - If a schema in the OpenAPI document defines the additionalProperties attribute, - then all undeclared properties received by the server are injected into the - additional properties map. In that case, there are undeclared properties, and - nothing to discard. - :param disabled_client_side_validations (string): Comma-separated list of - JSON schema validation keywords to disable JSON schema structural validation - rules. The following keywords may be specified: multipleOf, maximum, - exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, - maxItems, minItems. - By default, the validation is performed for data generated locally by the client - and data received from the server, independent of any validation performed by - the server side. If the input data does not satisfy the JSON schema validation - rules specified in the OpenAPI document, an exception is raised. - If disabled_client_side_validations is set, structural validation is - disabled. This can be useful to troubleshoot data validation problem, such as - when the OpenAPI document validation rules do not match the actual API data - received by the server. -{{#hasHttpSignatureMethods}} - :param signing_info: Configuration parameters for the HTTP signature security scheme. - Must be an instance of {{{packageName}}}.signing.HttpSigningConfiguration -{{/hasHttpSignatureMethods}} - :param server_index: Index to servers configuration. - :param server_variables: Mapping with string values to replace variables in - templated server configuration. The validation of enums is performed for - variables with defined enum values before. - :param server_operation_index: Mapping from operation ID to an index to server - configuration. - :param server_operation_variables: Mapping from operation ID to a mapping with - string values to replace variables in templated server configuration. - The validation of enums is performed for variables with defined enum values before. - :param ssl_ca_cert: str - the path to a file of concatenated CA certificates - in PEM format - -{{#hasAuthMethods}} - :Example: -{{#hasApiKeyMethods}} - - API Key Authentication Example. - Given the following security scheme in the OpenAPI specification: - components: - securitySchemes: - cookieAuth: # name for the security scheme - type: apiKey - in: cookie - name: JSESSIONID # cookie name - - You can programmatically set the cookie: - -conf = {{{packageName}}}.Configuration( - api_key={'cookieAuth': 'abc123'} - api_key_prefix={'cookieAuth': 'JSESSIONID'} -) - - The following cookie will be added to the HTTP request: - Cookie: JSESSIONID abc123 -{{/hasApiKeyMethods}} -{{#hasHttpBasicMethods}} - - HTTP Basic Authentication Example. - Given the following security scheme in the OpenAPI specification: - components: - securitySchemes: - http_basic_auth: - type: http - scheme: basic - - Configure API client with HTTP basic authentication: - -conf = {{{packageName}}}.Configuration( - username='the-user', - password='the-password', -) - -{{/hasHttpBasicMethods}} -{{#hasHttpSignatureMethods}} - - HTTP Signature Authentication Example. - Given the following security scheme in the OpenAPI specification: - components: - securitySchemes: - http_basic_auth: - type: http - scheme: signature - - Configure API client with HTTP signature authentication. Use the 'hs2019' signature scheme, - sign the HTTP requests with the RSA-SSA-PSS signature algorithm, and set the expiration time - of the signature to 5 minutes after the signature has been created. - Note you can use the constants defined in the {{{packageName}}}.signing module, and you can - also specify arbitrary HTTP headers to be included in the HTTP signature, except for the - 'Authorization' header, which is used to carry the signature. - - One may be tempted to sign all headers by default, but in practice it rarely works. - This is because explicit proxies, transparent proxies, TLS termination endpoints or - load balancers may add/modify/remove headers. Include the HTTP headers that you know - are not going to be modified in transit. - -conf = {{{packageName}}}.Configuration( - signing_info = {{{packageName}}}.signing.HttpSigningConfiguration( - key_id = 'my-key-id', - private_key_path = 'rsa.pem', - signing_scheme = {{{packageName}}}.signing.SCHEME_HS2019, - signing_algorithm = {{{packageName}}}.signing.ALGORITHM_RSASSA_PSS, - signed_headers = [{{{packageName}}}.signing.HEADER_REQUEST_TARGET, - {{{packageName}}}.signing.HEADER_CREATED, - {{{packageName}}}.signing.HEADER_EXPIRES, - {{{packageName}}}.signing.HEADER_HOST, - {{{packageName}}}.signing.HEADER_DATE, - {{{packageName}}}.signing.HEADER_DIGEST, - 'Content-Type', - 'User-Agent' - ], - signature_max_validity = datetime.timedelta(minutes=5) - ) -) -{{/hasHttpSignatureMethods}} -{{/hasAuthMethods}} - """ - - _default = None - - def __init__(self, host=None, - api_key=None, api_key_prefix=None, - access_token=None, - username=None, password=None, - discard_unknown_keys=False, - disabled_client_side_validations="", -{{#hasHttpSignatureMethods}} - signing_info=None, -{{/hasHttpSignatureMethods}} - server_index=None, server_variables=None, - server_operation_index=None, server_operation_variables=None, - ssl_ca_cert=None, - ): - """Constructor - """ - self._base_path = "{{{basePath}}}" if host is None else host - """Default Base url - """ - self.server_index = 0 if server_index is None and host is None else server_index - self.server_operation_index = server_operation_index or {} - """Default server index - """ - self.server_variables = server_variables or {} - self.server_operation_variables = server_operation_variables or {} - """Default server variables - """ - self.temp_folder_path = None - """Temp file folder for downloading files - """ - # Authentication Settings - self.access_token = access_token - self.api_key = {} - if api_key: - self.api_key = api_key - """dict to store API key(s) - """ - self.api_key_prefix = {} - if api_key_prefix: - self.api_key_prefix = api_key_prefix - """dict to store API prefix (e.g. Bearer) - """ - self.refresh_api_key_hook = None - """function hook to refresh API key if expired - """ - self.username = username - """Username for HTTP basic authentication - """ - self.password = password - """Password for HTTP basic authentication - """ - self.discard_unknown_keys = discard_unknown_keys - self.disabled_client_side_validations = disabled_client_side_validations -{{#hasHttpSignatureMethods}} - if signing_info is not None: - signing_info.host = host - self.signing_info = signing_info - """The HTTP signing configuration - """ -{{/hasHttpSignatureMethods}} - self.logger = {} - """Logging Settings - """ - self.logger["package_logger"] = logging.getLogger("{{packageName}}") - self.logger["urllib3_logger"] = logging.getLogger("urllib3") - self.logger_format = '%(asctime)s %(levelname)s %(message)s' - """Log format - """ - self.logger_stream_handler = None - """Log stream handler - """ - self.logger_file_handler = None - """Log file handler - """ - self.logger_file = None - """Debug file location - """ - self.debug = False - """Debug switch - """ - - self.verify_ssl = True - """SSL/TLS verification - Set this to false to skip verifying SSL certificate when calling API - from https server. - """ - self.ssl_ca_cert = ssl_ca_cert - """Set this to customize the certificate file to verify the peer. - """ - self.cert_file = None - """client certificate file - """ - self.key_file = None - """client key file - """ - self.assert_hostname = None - """Set this to True/False to enable/disable SSL hostname verification. - """ - - {{#asyncio}} - self.connection_pool_maxsize = 100 - """This value is passed to the aiohttp to limit simultaneous connections. - Default values is 100, None means no-limit. - """ - {{/asyncio}} - {{^asyncio}} - self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 - """urllib3 connection pool's maximum number of connections saved - per pool. urllib3 uses 1 connection as default value, but this is - not the best value when you are making a lot of possibly parallel - requests to the same host, which is often the case here. - cpu_count * 5 is used as default value to increase performance. - """ - {{/asyncio}} - - self.proxy = None - """Proxy URL - """ - self.no_proxy = None - """bypass proxy for host in the no_proxy list. - """ - self.proxy_headers = None - """Proxy headers - """ - self.safe_chars_for_path_param = '' - """Safe chars for path_param - """ - self.retries = None - """Adding retries to override urllib3 default value 3 - """ - # Enable client side validation - self.client_side_validation = True - - # Options to pass down to the underlying urllib3 socket - self.socket_options = None - - def __deepcopy__(self, memo): - cls = self.__class__ - result = cls.__new__(cls) - memo[id(self)] = result - for k, v in self.__dict__.items(): - if k not in ('logger', 'logger_file_handler'): - setattr(result, k, copy.deepcopy(v, memo)) - # shallow copy of loggers - result.logger = copy.copy(self.logger) - # use setters to configure loggers - result.logger_file = self.logger_file - result.debug = self.debug - return result - - def __setattr__(self, name, value): - object.__setattr__(self, name, value) - if name == 'disabled_client_side_validations': - s = set(filter(None, value.split(','))) - for v in s: - if v not in JSON_SCHEMA_VALIDATION_KEYWORDS: - raise ApiValueError( - "Invalid keyword: '{0}''".format(v)) - self._disabled_client_side_validations = s -{{#hasHttpSignatureMethods}} - if name == "signing_info" and value is not None: - # Ensure the host parameter from signing info is the same as - # Configuration.host. - value.host = self.host -{{/hasHttpSignatureMethods}} - - @classmethod - def set_default(cls, default): - """Set default instance of configuration. - - It stores default configuration, which can be - returned by get_default_copy method. - - :param default: object of Configuration - """ - cls._default = copy.deepcopy(default) - - @classmethod - def get_default_copy(cls): - """Return new instance of configuration. - - This method returns newly created, based on default constructor, - object of Configuration class or returns a copy of default - configuration passed by the set_default method. - - :return: The configuration object. - """ - if cls._default is not None: - return copy.deepcopy(cls._default) - return Configuration() - - @property - def logger_file(self): - """The logger file. - - If the logger_file is None, then add stream handler and remove file - handler. Otherwise, add file handler and remove stream handler. - - :param value: The logger_file path. - :type: str - """ - return self.__logger_file - - @logger_file.setter - def logger_file(self, value): - """The logger file. - - If the logger_file is None, then add stream handler and remove file - handler. Otherwise, add file handler and remove stream handler. - - :param value: The logger_file path. - :type: str - """ - self.__logger_file = value - if self.__logger_file: - # If set logging file, - # then add file handler and remove stream handler. - self.logger_file_handler = logging.FileHandler(self.__logger_file) - self.logger_file_handler.setFormatter(self.logger_formatter) - for _, logger in self.logger.items(): - logger.addHandler(self.logger_file_handler) - - @property - def debug(self): - """Debug status - - :param value: The debug status, True or False. - :type: bool - """ - return self.__debug - - @debug.setter - def debug(self, value): - """Debug status - - :param value: The debug status, True or False. - :type: bool - """ - self.__debug = value - if self.__debug: - # if debug status is True, turn on debug logging - for _, logger in self.logger.items(): - logger.setLevel(logging.DEBUG) - # turn on http_client debug - http_client.HTTPConnection.debuglevel = 1 - else: - # if debug status is False, turn off debug logging, - # setting log level to default `logging.WARNING` - for _, logger in self.logger.items(): - logger.setLevel(logging.WARNING) - # turn off http_client debug - http_client.HTTPConnection.debuglevel = 0 - - @property - def logger_format(self): - """The logger format. - - The logger_formatter will be updated when sets logger_format. - - :param value: The format string. - :type: str - """ - return self.__logger_format - - @logger_format.setter - def logger_format(self, value): - """The logger format. - - The logger_formatter will be updated when sets logger_format. - - :param value: The format string. - :type: str - """ - self.__logger_format = value - self.logger_formatter = logging.Formatter(self.__logger_format) - - def get_api_key_with_prefix(self, identifier, alias=None): - """Gets API key (with prefix if set). - - :param identifier: The identifier of apiKey. - :param alias: The alternative identifier of apiKey. - :return: The token for api key authentication. - """ - if self.refresh_api_key_hook is not None: - self.refresh_api_key_hook(self) - key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None) - if key: - prefix = self.api_key_prefix.get(identifier) - if prefix: - return "%s %s" % (prefix, key) - else: - return key - - def get_basic_auth_token(self): - """Gets HTTP basic authentication header (string). - - :return: The token for basic HTTP authentication. - """ - username = "" - if self.username is not None: - username = self.username - password = "" - if self.password is not None: - password = self.password - return urllib3.util.make_headers( - basic_auth=username + ':' + password - ).get('authorization') - - def auth_settings(self): - """Gets Auth Settings dict for api client. - - :return: The Auth Settings information dict. - """ - auth = {} -{{#authMethods}} -{{#isApiKey}} - if '{{name}}' in self.api_key{{#vendorExtensions.x-auth-id-alias}} or '{{.}}' in self.api_key{{/vendorExtensions.x-auth-id-alias}}: - auth['{{name}}'] = { - 'type': 'api_key', - 'in': {{#isKeyInCookie}}'cookie'{{/isKeyInCookie}}{{#isKeyInHeader}}'header'{{/isKeyInHeader}}{{#isKeyInQuery}}'query'{{/isKeyInQuery}}, - 'key': '{{keyParamName}}', - 'value': self.get_api_key_with_prefix( - '{{name}}',{{#vendorExtensions.x-auth-id-alias}} - alias='{{.}}',{{/vendorExtensions.x-auth-id-alias}} - ), - } -{{/isApiKey}} -{{#isBasic}} - {{#isBasicBasic}} - if self.username is not None and self.password is not None: - auth['{{name}}'] = { - 'type': 'basic', - 'in': 'header', - 'key': 'Authorization', - 'value': self.get_basic_auth_token() - } - {{/isBasicBasic}} - {{#isBasicBearer}} - if self.access_token is not None: - auth['{{name}}'] = { - 'type': 'bearer', - 'in': 'header', - {{#bearerFormat}} - 'format': '{{{.}}}', - {{/bearerFormat}} - 'key': 'Authorization', - 'value': 'Bearer ' + self.access_token - } - {{/isBasicBearer}} - {{#isHttpSignature}} - if self.signing_info is not None: - auth['{{name}}'] = { - 'type': 'http-signature', - 'in': 'header', - 'key': 'Authorization', - 'value': None # Signature headers are calculated for every HTTP request - } - {{/isHttpSignature}} -{{/isBasic}} -{{#isOAuth}} - if self.access_token is not None: - auth['{{name}}'] = { - 'type': 'oauth2', - 'in': 'header', - 'key': 'Authorization', - 'value': 'Bearer ' + self.access_token - } -{{/isOAuth}} -{{/authMethods}} - return auth - - def to_debug_report(self): - """Gets the essential information for debugging. - - :return: The report for debugging. - """ - return "Python SDK Debug Report:\n"\ - "OS: {env}\n"\ - "Python Version: {pyversion}\n"\ - "Version of the API: {{version}}\n"\ - "SDK Package Version: {{packageVersion}}".\ - format(env=sys.platform, pyversion=sys.version) - - def get_host_settings(self): - """Gets an array of host settings - - :return: An array of host settings - """ - return [ - {{#servers}} - { - 'url': "{{{url}}}", - 'description': "{{{description}}}{{^description}}No description provided{{/description}}", - {{#variables}} - {{#-first}} - 'variables': { - {{/-first}} - '{{{name}}}': { - 'description': "{{{description}}}{{^description}}No description provided{{/description}}", - 'default_value': "{{{defaultValue}}}", - {{#enumValues}} - {{#-first}} - 'enum_values': [ - {{/-first}} - "{{{.}}}"{{^-last}},{{/-last}} - {{#-last}} - ] - {{/-last}} - {{/enumValues}} - }{{^-last}},{{/-last}} - {{#-last}} - } - {{/-last}} - {{/variables}} - }{{^-last}},{{/-last}} - {{/servers}} - ] - - def get_host_from_settings(self, index, variables=None, servers=None): - """Gets host URL based on the index and variables - :param index: array index of the host settings - :param variables: hash of variable and the corresponding value - :param servers: an array of host settings or None - :return: URL based on host settings - """ - if index is None: - return self._base_path - - variables = {} if variables is None else variables - servers = self.get_host_settings() if servers is None else servers - - try: - server = servers[index] - except IndexError: - raise ValueError( - "Invalid index {0} when selecting the host settings. " - "Must be less than {1}".format(index, len(servers))) - - url = server['url'] - - # go through variables and replace placeholders - for variable_name, variable in server.get('variables', {}).items(): - used_value = variables.get( - variable_name, variable['default_value']) - - if 'enum_values' in variable \ - and used_value not in variable['enum_values']: - raise ValueError( - "The variable `{0}` in the host URL has invalid value " - "{1}. Must be {2}.".format( - variable_name, variables[variable_name], - variable['enum_values'])) - - url = url.replace("{" + variable_name + "}", used_value) - - return url - - @property - def host(self): - """Return generated host.""" - return self.get_host_from_settings(self.server_index, variables=self.server_variables) - - @host.setter - def host(self, value): - """Fix base path.""" - self._base_path = value - self.server_index = None - - -class ConversionConfiguration: - _CONFIG: Configuration = Configuration() - - @classmethod - def get_configuration(cls): - return cls._CONFIG diff --git a/.openapi-generator/custom_templates/model_templates/methods_todict_tostr_eq_shared.mustache b/.openapi-generator/custom_templates/model_templates/methods_todict_tostr_eq_shared.mustache deleted file mode 100644 index 1bb52777f..000000000 --- a/.openapi-generator/custom_templates/model_templates/methods_todict_tostr_eq_shared.mustache +++ /dev/null @@ -1,29 +0,0 @@ - def to_dict(self, camel_case=False): - """Returns the model properties as a dict""" - return model_to_dict(self, serialize=camel_case) - - @classmethod - def from_dict(cls, dictionary, camel_case=True): - dictionary_cpy = deepcopy(dictionary) - return validate_and_convert_types(dictionary_cpy, (cls,), ['received_data'], camel_case, True, ConversionConfiguration.get_configuration()) - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, self.__class__): - return False - - if not set(self._data_store.keys()) == set(other._data_store.keys()): - return False - for _var_name, this_val in self._data_store.items(): - that_val = other._data_store[_var_name] - types = set() - types.add(this_val.__class__) - types.add(that_val.__class__) - vals_equal = this_val == that_val - if not vals_equal: - return False - return True diff --git a/.openapi-generator/custom_templates/model_utils.mustache b/.openapi-generator/custom_templates/model_utils.mustache deleted file mode 100644 index 84c13035b..000000000 --- a/.openapi-generator/custom_templates/model_utils.mustache +++ /dev/null @@ -1,1737 +0,0 @@ -{{>partial_header}} - -from datetime import date, datetime # noqa: F401 -from copy import deepcopy -import inspect -import io -import os -import pprint -import re -import tempfile -import uuid - -from dateutil.parser import parse - -from {{packageName}}.exceptions import ( - ApiKeyError, - ApiAttributeError, - ApiTypeError, - ApiValueError, -) - -from {{packageName}}.configuration import ConversionConfiguration - -none_type = type(None) -file_type = io.IOBase - - -def convert_js_args_to_python_args(fn): - from functools import wraps - @wraps(fn) - def wrapped_init(_self_sanitized, *args, **kwargs): - """ - An attribute named `self` received from the api will conflicts with the reserved `self` - parameter of a class method. During generation, `self` attributes are mapped - to `_self_sanitized` in models. Here, we name `_self_sanitized` instead of `self` to avoid conflicts. - """ - spec_property_naming = kwargs.get('_spec_property_naming', False) - if spec_property_naming: - kwargs = change_keys_js_to_python(kwargs, _self_sanitized if isinstance(_self_sanitized, type) else _self_sanitized.__class__) - return fn(_self_sanitized, *args, **kwargs) - return wrapped_init - - -class cached_property(object): - # this caches the result of the function call for fn with no inputs - # use this as a decorator on function methods that you want converted - # into cached properties - result_key = '_results' - - def __init__(self, fn): - self._fn = fn - - def __get__(self, instance, cls=None): - if self.result_key in vars(self): - return vars(self)[self.result_key] - else: - result = self._fn() - setattr(self, self.result_key, result) - return result - - -PRIMITIVE_TYPES = (list, float, int, bool, datetime, date, str, file_type) - -def allows_single_value_input(cls): - """ - This function returns True if the input composed schema model or any - descendant model allows a value only input - This is true for cases where oneOf contains items like: - oneOf: - - float - - NumberWithValidation - - StringEnum - - ArrayModel - - null - TODO: lru_cache this - """ - if ( - issubclass(cls, ModelSimple) or - cls in PRIMITIVE_TYPES - ): - return True - elif issubclass(cls, ModelComposed): - if not cls._composed_schemas['oneOf']: - return False - return any(allows_single_value_input(c) for c in cls._composed_schemas['oneOf']) - return False - -def composed_model_input_classes(cls): - """ - This function returns a list of the possible models that can be accepted as - inputs. - TODO: lru_cache this - """ - if issubclass(cls, ModelSimple) or cls in PRIMITIVE_TYPES: - return [cls] - elif issubclass(cls, ModelNormal): - if cls.discriminator is None: - return [cls] - else: - return get_discriminated_classes(cls) - elif issubclass(cls, ModelComposed): - if not cls._composed_schemas['oneOf']: - return [] - if cls.discriminator is None: - input_classes = [] - for c in cls._composed_schemas['oneOf']: - input_classes.extend(composed_model_input_classes(c)) - return input_classes - else: - return get_discriminated_classes(cls) - return [] - - -class OpenApiModel(object): - """The base class for all OpenAPIModels""" - -{{> model_templates/method_set_attribute }} - -{{> model_templates/methods_shared }} - - def __new__(cls, *args, **kwargs): - # this function uses the discriminator to - # pick a new schema/class to instantiate because a discriminator - # propertyName value was passed in - - if len(args) == 1: - arg = args[0] - if arg is None and is_type_nullable(cls): - # The input data is the 'null' value and the type is nullable. - return None - - if issubclass(cls, ModelComposed) and allows_single_value_input(cls): - model_kwargs = {} - oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) - return oneof_instance - - - visited_composed_classes = kwargs.get('_visited_composed_classes', ()) - if ( - cls.discriminator is None or - cls in visited_composed_classes - ): - # Use case 1: this openapi schema (cls) does not have a discriminator - # Use case 2: we have already visited this class before and are sure that we - # want to instantiate it this time. We have visited this class deserializing - # a payload with a discriminator. During that process we traveled through - # this class but did not make an instance of it. Now we are making an - # instance of a composed class which contains cls in it, so this time make an instance of cls. - # - # Here's an example of use case 2: If Animal has a discriminator - # petType and we pass in "Dog", and the class Dog - # allOf includes Animal, we move through Animal - # once using the discriminator, and pick Dog. - # Then in the composed schema dog Dog, we will make an instance of the - # Animal class (because Dal has allOf: Animal) but this time we won't travel - # through Animal's discriminator because we passed in - # _visited_composed_classes = (Animal,) - - return super(OpenApiModel, cls).__new__(cls) - - # Get the name and value of the discriminator property. - # The discriminator name is obtained from the discriminator meta-data - # and the discriminator value is obtained from the input data. - discr_propertyname_py = list(cls.discriminator.keys())[0] - discr_propertyname_js = cls.attribute_map[discr_propertyname_py] - if discr_propertyname_js in kwargs: - discr_value = kwargs[discr_propertyname_js] - elif discr_propertyname_py in kwargs: - discr_value = kwargs[discr_propertyname_py] - else: - # The input data does not contain the discriminator property. - path_to_item = kwargs.get('_path_to_item', ()) - raise ApiValueError( - "Cannot deserialize input data due to missing discriminator. " - "The discriminator property '%s' is missing at path: %s" % - (discr_propertyname_js, path_to_item) - ) - - # Implementation note: the last argument to get_discriminator_class - # is a list of visited classes. get_discriminator_class may recursively - # call itself and update the list of visited classes, and the initial - # value must be an empty list. Hence not using 'visited_composed_classes' - new_cls = get_discriminator_class( - cls, discr_propertyname_py, discr_value, []) - if new_cls is None: - path_to_item = kwargs.get('_path_to_item', ()) - disc_prop_value = kwargs.get( - discr_propertyname_js, kwargs.get(discr_propertyname_py)) - raise ApiValueError( - "Cannot deserialize input data due to invalid discriminator " - "value. The OpenAPI document has no mapping for discriminator " - "property '%s'='%s' at path: %s" % - (discr_propertyname_js, disc_prop_value, path_to_item) - ) - - if new_cls in visited_composed_classes: - # if we are making an instance of a composed schema Descendent - # which allOf includes Ancestor, then Ancestor contains - # a discriminator that includes Descendent. - # So if we make an instance of Descendent, we have to make an - # instance of Ancestor to hold the allOf properties. - # This code detects that use case and makes the instance of Ancestor - # For example: - # When making an instance of Dog, _visited_composed_classes = (Dog,) - # then we make an instance of Animal to include in dog._composed_instances - # so when we are here, cls is Animal - # cls.discriminator != None - # cls not in _visited_composed_classes - # new_cls = Dog - # but we know we know that we already have Dog - # because it is in visited_composed_classes - # so make Animal here - return super(OpenApiModel, cls).__new__(cls) - - # Build a list containing all oneOf and anyOf descendants. - oneof_anyof_classes = None - if cls._composed_schemas is not None: - oneof_anyof_classes = ( - cls._composed_schemas.get('oneOf', ()) + - cls._composed_schemas.get('anyOf', ())) - oneof_anyof_child = new_cls in oneof_anyof_classes - kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) - - if cls._composed_schemas.get('allOf') and oneof_anyof_child: - # Validate that we can make self because when we make the - # new_cls it will not include the allOf validations in self - self_inst = super(OpenApiModel, cls).__new__(cls) - self_inst.__init__(*args, **kwargs) - - if kwargs.get("_spec_property_naming", False): - # when true, implies new is from deserialization - new_inst = new_cls._new_from_openapi_data(*args, **kwargs) - else: - new_inst = new_cls.__new__(new_cls, *args, **kwargs) - new_inst.__init__(*args, **kwargs) - - return new_inst - - - @classmethod - @convert_js_args_to_python_args - def _new_from_openapi_data(cls, *args, **kwargs): - # this function uses the discriminator to - # pick a new schema/class to instantiate because a discriminator - # propertyName value was passed in - - if len(args) == 1: - arg = args[0] - if arg is None and is_type_nullable(cls): - # The input data is the 'null' value and the type is nullable. - return None - - if issubclass(cls, ModelComposed) and allows_single_value_input(cls): - model_kwargs = {} - oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) - return oneof_instance - - - visited_composed_classes = kwargs.get('_visited_composed_classes', ()) - if ( - cls.discriminator is None or - cls in visited_composed_classes - ): - # Use case 1: this openapi schema (cls) does not have a discriminator - # Use case 2: we have already visited this class before and are sure that we - # want to instantiate it this time. We have visited this class deserializing - # a payload with a discriminator. During that process we traveled through - # this class but did not make an instance of it. Now we are making an - # instance of a composed class which contains cls in it, so this time make an instance of cls. - # - # Here's an example of use case 2: If Animal has a discriminator - # petType and we pass in "Dog", and the class Dog - # allOf includes Animal, we move through Animal - # once using the discriminator, and pick Dog. - # Then in the composed schema dog Dog, we will make an instance of the - # Animal class (because Dal has allOf: Animal) but this time we won't travel - # through Animal's discriminator because we passed in - # _visited_composed_classes = (Animal,) - - return cls._from_openapi_data(*args, **kwargs) - - # Get the name and value of the discriminator property. - # The discriminator name is obtained from the discriminator meta-data - # and the discriminator value is obtained from the input data. - discr_propertyname_py = list(cls.discriminator.keys())[0] - discr_propertyname_js = cls.attribute_map[discr_propertyname_py] - if discr_propertyname_js in kwargs: - discr_value = kwargs[discr_propertyname_js] - elif discr_propertyname_py in kwargs: - discr_value = kwargs[discr_propertyname_py] - else: - # The input data does not contain the discriminator property. - path_to_item = kwargs.get('_path_to_item', ()) - raise ApiValueError( - "Cannot deserialize input data due to missing discriminator. " - "The discriminator property '%s' is missing at path: %s" % - (discr_propertyname_js, path_to_item) - ) - - # Implementation note: the last argument to get_discriminator_class - # is a list of visited classes. get_discriminator_class may recursively - # call itself and update the list of visited classes, and the initial - # value must be an empty list. Hence not using 'visited_composed_classes' - new_cls = get_discriminator_class( - cls, discr_propertyname_py, discr_value, []) - if new_cls is None: - path_to_item = kwargs.get('_path_to_item', ()) - disc_prop_value = kwargs.get( - discr_propertyname_js, kwargs.get(discr_propertyname_py)) - raise ApiValueError( - "Cannot deserialize input data due to invalid discriminator " - "value. The OpenAPI document has no mapping for discriminator " - "property '%s'='%s' at path: %s" % - (discr_propertyname_js, disc_prop_value, path_to_item) - ) - - if new_cls in visited_composed_classes: - # if we are making an instance of a composed schema Descendent - # which allOf includes Ancestor, then Ancestor contains - # a discriminator that includes Descendent. - # So if we make an instance of Descendent, we have to make an - # instance of Ancestor to hold the allOf properties. - # This code detects that use case and makes the instance of Ancestor - # For example: - # When making an instance of Dog, _visited_composed_classes = (Dog,) - # then we make an instance of Animal to include in dog._composed_instances - # so when we are here, cls is Animal - # cls.discriminator != None - # cls not in _visited_composed_classes - # new_cls = Dog - # but we know we know that we already have Dog - # because it is in visited_composed_classes - # so make Animal here - return cls._from_openapi_data(*args, **kwargs) - - # Build a list containing all oneOf and anyOf descendants. - oneof_anyof_classes = None - if cls._composed_schemas is not None: - oneof_anyof_classes = ( - cls._composed_schemas.get('oneOf', ()) + - cls._composed_schemas.get('anyOf', ())) - oneof_anyof_child = new_cls in oneof_anyof_classes - kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) - - if cls._composed_schemas.get('allOf') and oneof_anyof_child: - # Validate that we can make self because when we make the - # new_cls it will not include the allOf validations in self - self_inst = cls._from_openapi_data(*args, **kwargs) - - - new_inst = new_cls._new_from_openapi_data(*args, **kwargs) - return new_inst - - -class ModelSimple(OpenApiModel): - """the parent class of models whose type != object in their - swagger/openapi""" - -{{> model_templates/methods_setattr_getattr_normal }} - -{{> model_templates/methods_tostr_eq_simple }} - - -class ModelNormal(OpenApiModel): - """the parent class of models whose type == object in their - swagger/openapi""" - -{{> model_templates/methods_setattr_getattr_normal }} - -{{> model_templates/methods_todict_tostr_eq_shared}} - - -class ModelComposed(OpenApiModel): - """the parent class of models whose type == object in their - swagger/openapi and have oneOf/allOf/anyOf - - When one sets a property we use var_name_to_model_instances to store the value in - the correct class instances + run any type checking + validation code. - When one gets a property we use var_name_to_model_instances to get the value - from the correct class instances. - This allows multiple composed schemas to contain the same property with additive - constraints on the value. - - _composed_schemas (dict) stores the anyOf/allOf/oneOf classes - key (str): allOf/oneOf/anyOf - value (list): the classes in the XOf definition. - Note: none_type can be included when the openapi document version >= 3.1.0 - _composed_instances (list): stores a list of instances of the composed schemas - defined in _composed_schemas. When properties are accessed in the self instance, - they are returned from the self._data_store or the data stores in the instances - in self._composed_schemas - _var_name_to_model_instances (dict): maps between a variable name on self and - the composed instances (self included) which contain that data - key (str): property name - value (list): list of class instances, self or instances in _composed_instances - which contain the value that the key is referring to. - """ - -{{> model_templates/methods_setattr_getattr_composed }} - -{{> model_templates/methods_todict_tostr_eq_shared}} - - -COERCION_INDEX_BY_TYPE = { - ModelComposed: 0, - ModelNormal: 1, - ModelSimple: 2, - none_type: 3, # The type of 'None'. - list: 4, - dict: 5, - float: 6, - int: 7, - bool: 8, - datetime: 9, - date: 10, - str: 11, - file_type: 12, # 'file_type' is an alias for the built-in 'file' or 'io.IOBase' type. -} - -# these are used to limit what type conversions we try to do -# when we have a valid type already and we want to try converting -# to another type -UPCONVERSION_TYPE_PAIRS = ( - (str, datetime), - (str, date), - (int, float), # A float may be serialized as an integer, e.g. '3' is a valid serialized float. - (list, ModelComposed), - (dict, ModelComposed), - (str, ModelComposed), - (int, ModelComposed), - (float, ModelComposed), - (list, ModelComposed), - (list, ModelNormal), - (dict, ModelNormal), - (str, ModelSimple), - (int, ModelSimple), - (float, ModelSimple), - (list, ModelSimple), -) - -COERCIBLE_TYPE_PAIRS = { - False: ( # client instantiation of a model with client data - # (dict, ModelComposed), - # (list, ModelComposed), - # (dict, ModelNormal), - # (list, ModelNormal), - # (str, ModelSimple), - # (int, ModelSimple), - # (float, ModelSimple), - # (list, ModelSimple), - # (str, int), - # (str, float), - # (str, datetime), - # (str, date), - # (int, str), - # (float, str), - ), - True: ( # server -> client data - (dict, ModelComposed), - (list, ModelComposed), - (dict, ModelNormal), - (list, ModelNormal), - (str, ModelSimple), - (int, ModelSimple), - (float, ModelSimple), - (list, ModelSimple), - # (str, int), - # (str, float), - (str, datetime), - (str, date), - # (int, str), - # (float, str), - (str, file_type) - ), -} - - -def get_simple_class(input_value): - """Returns an input_value's simple class that we will use for type checking - Python2: - float and int will return int, where int is the python3 int backport - str and unicode will return str, where str is the python3 str backport - Note: float and int ARE both instances of int backport - Note: str_py2 and unicode_py2 are NOT both instances of str backport - - Args: - input_value (class/class_instance): the item for which we will return - the simple class - """ - if isinstance(input_value, type): - # input_value is a class - return input_value - elif isinstance(input_value, tuple): - return tuple - elif isinstance(input_value, list): - return list - elif isinstance(input_value, dict): - return dict - elif isinstance(input_value, none_type): - return none_type - elif isinstance(input_value, file_type): - return file_type - elif isinstance(input_value, bool): - # this must be higher than the int check because - # isinstance(True, int) == True - return bool - elif isinstance(input_value, int): - return int - elif isinstance(input_value, datetime): - # this must be higher than the date check because - # isinstance(datetime_instance, date) == True - return datetime - elif isinstance(input_value, date): - return date - elif isinstance(input_value, str): - return str - return type(input_value) - - -def check_allowed_values(allowed_values, input_variable_path, input_values): - """Raises an exception if the input_values are not allowed - - Args: - allowed_values (dict): the allowed_values dict - input_variable_path (tuple): the path to the input variable - input_values (list/str/int/float/date/datetime): the values that we - are checking to see if they are in allowed_values - """ - these_allowed_values = list(allowed_values[input_variable_path].values()) - if (isinstance(input_values, list) - and not set(input_values).issubset( - set(these_allowed_values))): - invalid_values = ", ".join( - map(str, set(input_values) - set(these_allowed_values))), - raise ApiValueError( - "Invalid values for `%s` [%s], must be a subset of [%s]" % - ( - input_variable_path[0], - invalid_values, - ", ".join(map(str, these_allowed_values)) - ) - ) - elif (isinstance(input_values, dict) - and not set( - input_values.keys()).issubset(set(these_allowed_values))): - invalid_values = ", ".join( - map(str, set(input_values.keys()) - set(these_allowed_values))) - raise ApiValueError( - "Invalid keys in `%s` [%s], must be a subset of [%s]" % - ( - input_variable_path[0], - invalid_values, - ", ".join(map(str, these_allowed_values)) - ) - ) - elif (not isinstance(input_values, (list, dict)) - and input_values not in these_allowed_values): - raise ApiValueError( - "Invalid value for `%s` (%s), must be one of %s" % - ( - input_variable_path[0], - input_values, - these_allowed_values - ) - ) - - -def is_json_validation_enabled(schema_keyword, configuration=None): - """Returns true if JSON schema validation is enabled for the specified - validation keyword. This can be used to skip JSON schema structural validation - as requested in the configuration. - - Args: - schema_keyword (string): the name of a JSON schema validation keyword. - configuration (Configuration): the configuration class. - """ - - return (configuration is None or - not hasattr(configuration, '_disabled_client_side_validations') or - schema_keyword not in configuration._disabled_client_side_validations) - - -def check_validations( - validations, input_variable_path, input_values, - configuration=None): - """Raises an exception if the input_values are invalid - - Args: - validations (dict): the validation dictionary. - input_variable_path (tuple): the path to the input variable. - input_values (list/str/int/float/date/datetime): the values that we - are checking. - configuration (Configuration): the configuration class. - """ - - if input_values is None: - return - - current_validations = validations[input_variable_path] - if (is_json_validation_enabled('multipleOf', configuration) and - 'multiple_of' in current_validations and - isinstance(input_values, (int, float)) and - not (float(input_values) / current_validations['multiple_of']).is_integer()): - # Note 'multipleOf' will be as good as the floating point arithmetic. - raise ApiValueError( - "Invalid value for `%s`, value must be a multiple of " - "`%s`" % ( - input_variable_path[0], - current_validations['multiple_of'] - ) - ) - - if (is_json_validation_enabled('maxLength', configuration) and - 'max_length' in current_validations and - len(input_values) > current_validations['max_length']): - raise ApiValueError( - "Invalid value for `%s`, length must be less than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['max_length'] - ) - ) - - if (is_json_validation_enabled('minLength', configuration) and - 'min_length' in current_validations and - len(input_values) < current_validations['min_length']): - raise ApiValueError( - "Invalid value for `%s`, length must be greater than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['min_length'] - ) - ) - - if (is_json_validation_enabled('maxItems', configuration) and - 'max_items' in current_validations and - len(input_values) > current_validations['max_items']): - raise ApiValueError( - "Invalid value for `%s`, number of items must be less than or " - "equal to `%s`" % ( - input_variable_path[0], - current_validations['max_items'] - ) - ) - - if (is_json_validation_enabled('minItems', configuration) and - 'min_items' in current_validations and - len(input_values) < current_validations['min_items']): - raise ValueError( - "Invalid value for `%s`, number of items must be greater than or " - "equal to `%s`" % ( - input_variable_path[0], - current_validations['min_items'] - ) - ) - - items = ('exclusive_maximum', 'inclusive_maximum', 'exclusive_minimum', - 'inclusive_minimum') - if (any(item in current_validations for item in items)): - if isinstance(input_values, list): - max_val = max(input_values) - min_val = min(input_values) - elif isinstance(input_values, dict): - max_val = max(input_values.values()) - min_val = min(input_values.values()) - else: - max_val = input_values - min_val = input_values - - if (is_json_validation_enabled('exclusiveMaximum', configuration) and - 'exclusive_maximum' in current_validations and - max_val >= current_validations['exclusive_maximum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value less than `%s`" % ( - input_variable_path[0], - current_validations['exclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('maximum', configuration) and - 'inclusive_maximum' in current_validations and - max_val > current_validations['inclusive_maximum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value less than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['inclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('exclusiveMinimum', configuration) and - 'exclusive_minimum' in current_validations and - min_val <= current_validations['exclusive_minimum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value greater than `%s`" % - ( - input_variable_path[0], - current_validations['exclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('minimum', configuration) and - 'inclusive_minimum' in current_validations and - min_val < current_validations['inclusive_minimum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value greater than or equal " - "to `%s`" % ( - input_variable_path[0], - current_validations['inclusive_minimum'] - ) - ) - flags = current_validations.get('regex', {}).get('flags', 0) - if (is_json_validation_enabled('pattern', configuration) and - 'regex' in current_validations and - not re.search(current_validations['regex']['pattern'], - input_values, flags=flags)): - err_msg = r"Invalid value for `%s`, must match regular expression `%s`" % ( - input_variable_path[0], - current_validations['regex']['pattern'] - ) - if flags != 0: - # Don't print the regex flags if the flags are not - # specified in the OAS document. - err_msg = r"%s with flags=`%s`" % (err_msg, flags) - raise ApiValueError(err_msg) - - -def order_response_types(required_types): - """Returns the required types sorted in coercion order - - Args: - required_types (list/tuple): collection of classes or instance of - list or dict with class information inside it. - - Returns: - (list): coercion order sorted collection of classes or instance - of list or dict with class information inside it. - """ - - def index_getter(class_or_instance): - if isinstance(class_or_instance, list): - return COERCION_INDEX_BY_TYPE[list] - elif isinstance(class_or_instance, dict): - return COERCION_INDEX_BY_TYPE[dict] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelComposed)): - return COERCION_INDEX_BY_TYPE[ModelComposed] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelNormal)): - return COERCION_INDEX_BY_TYPE[ModelNormal] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelSimple)): - return COERCION_INDEX_BY_TYPE[ModelSimple] - elif class_or_instance in COERCION_INDEX_BY_TYPE: - return COERCION_INDEX_BY_TYPE[class_or_instance] - raise ApiValueError("Unsupported type: %s" % class_or_instance) - - sorted_types = sorted( - required_types, - key=lambda class_or_instance: index_getter(class_or_instance) - ) - return sorted_types - - -def remove_uncoercible(required_types_classes, current_item, spec_property_naming, - must_convert=True): - """Only keeps the type conversions that are possible - - Args: - required_types_classes (tuple): tuple of classes that are required - these should be ordered by COERCION_INDEX_BY_TYPE - spec_property_naming (bool): True if the variable names in the input - data are serialized names as specified in the OpenAPI document. - False if the variables names in the input data are python - variable names in PEP-8 snake case. - current_item (any): the current item (input data) to be converted - - Keyword Args: - must_convert (bool): if True the item to convert is of the wrong - type and we want a big list of coercibles - if False, we want a limited list of coercibles - - Returns: - (list): the remaining coercible required types, classes only - """ - current_type_simple = get_simple_class(current_item) - - results_classes = [] - for required_type_class in required_types_classes: - # convert our models to OpenApiModel - required_type_class_simplified = required_type_class - if isinstance(required_type_class_simplified, type): - if issubclass(required_type_class_simplified, ModelComposed): - required_type_class_simplified = ModelComposed - elif issubclass(required_type_class_simplified, ModelNormal): - required_type_class_simplified = ModelNormal - elif issubclass(required_type_class_simplified, ModelSimple): - required_type_class_simplified = ModelSimple - - if required_type_class_simplified == current_type_simple: - # don't consider converting to one's own class - continue - - class_pair = (current_type_simple, required_type_class_simplified) - if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[spec_property_naming]: - results_classes.append(required_type_class) - elif class_pair in UPCONVERSION_TYPE_PAIRS: - results_classes.append(required_type_class) - return results_classes - -def get_discriminated_classes(cls): - """ - Returns all the classes that a discriminator converts to - TODO: lru_cache this - """ - possible_classes = [] - key = list(cls.discriminator.keys())[0] - if is_type_nullable(cls): - possible_classes.append(cls) - for discr_cls in cls.discriminator[key].values(): - if hasattr(discr_cls, 'discriminator') and discr_cls.discriminator is not None: - possible_classes.extend(get_discriminated_classes(discr_cls)) - else: - possible_classes.append(discr_cls) - return possible_classes - - -def get_possible_classes(cls, from_server_context): - # TODO: lru_cache this - possible_classes = [cls] - if from_server_context: - return possible_classes - if hasattr(cls, 'discriminator') and cls.discriminator is not None: - possible_classes = [] - possible_classes.extend(get_discriminated_classes(cls)) - elif issubclass(cls, ModelComposed): - possible_classes.extend(composed_model_input_classes(cls)) - return possible_classes - - -def get_required_type_classes(required_types_mixed, spec_property_naming): - """Converts the tuple required_types into a tuple and a dict described - below - - Args: - required_types_mixed (tuple/list): will contain either classes or - instance of list or dict - spec_property_naming (bool): if True these values came from the - server, and we use the data types in our endpoints. - If False, we are client side and we need to include - oneOf and discriminator classes inside the data types in our endpoints - - Returns: - (valid_classes, dict_valid_class_to_child_types_mixed): - valid_classes (tuple): the valid classes that the current item - should be - dict_valid_class_to_child_types_mixed (dict): - valid_class (class): this is the key - child_types_mixed (list/dict/tuple): describes the valid child - types - """ - valid_classes = [] - child_req_types_by_current_type = {} - for required_type in required_types_mixed: - if isinstance(required_type, list): - valid_classes.append(list) - child_req_types_by_current_type[list] = required_type - elif isinstance(required_type, tuple): - valid_classes.append(tuple) - child_req_types_by_current_type[tuple] = required_type - elif isinstance(required_type, dict): - valid_classes.append(dict) - child_req_types_by_current_type[dict] = required_type[str] - else: - valid_classes.extend(get_possible_classes(required_type, spec_property_naming)) - return tuple(valid_classes), child_req_types_by_current_type - - -def change_keys_js_to_python(input_dict, model_class): - """ - Converts from javascript_key keys in the input_dict to python_keys in - the output dict using the mapping in model_class. - If the input_dict contains a key which does not declared in the model_class, - the key is added to the output dict as is. The assumption is the model_class - may have undeclared properties (additionalProperties attribute in the OAS - document). - """ - - if getattr(model_class, 'attribute_map', None) is None: - return input_dict - output_dict = {} - reversed_attr_map = {value: key for key, value in - model_class.attribute_map.items()} - for javascript_key, value in input_dict.items(): - python_key = reversed_attr_map.get(javascript_key) - if python_key is None: - # if the key is unknown, it is in error or it is an - # additionalProperties variable - python_key = javascript_key - output_dict[python_key] = value - return output_dict - - -def get_type_error(var_value, path_to_item, valid_classes, key_type=False): - error_msg = type_error_message( - var_name=path_to_item[-1], - var_value=var_value, - valid_classes=valid_classes, - key_type=key_type - ) - return ApiTypeError( - error_msg, - path_to_item=path_to_item, - valid_classes=valid_classes, - key_type=key_type - ) - - -def deserialize_primitive(data, klass, path_to_item): - """Deserializes string to primitive type. - - :param data: str/int/float - :param klass: str/class the class to convert to - - :return: int, float, str, bool, date, datetime - """ - additional_message = "" - try: - if klass in {datetime, date}: - additional_message = ( - "If you need your parameter to have a fallback " - "string value, please set its type as `type: {}` in your " - "spec. That allows the value to be any type. " - ) - if klass == datetime: - if len(data) < 8: - raise ValueError("This is not a datetime") - # The string should be in iso8601 datetime format. - parsed_datetime = parse(data) - date_only = ( - parsed_datetime.hour == 0 and - parsed_datetime.minute == 0 and - parsed_datetime.second == 0 and - parsed_datetime.tzinfo is None and - 8 <= len(data) <= 10 - ) - if date_only: - raise ValueError("This is a date, not a datetime") - return parsed_datetime - elif klass == date: - if len(data) < 8: - raise ValueError("This is not a date") - return parse(data).date() - else: - converted_value = klass(data) - if isinstance(data, str) and klass == float: - if str(converted_value) != data: - # '7' -> 7.0 -> '7.0' != '7' - raise ValueError('This is not a float') - return converted_value - except (OverflowError, ValueError) as ex: - # parse can raise OverflowError - raise ApiValueError( - "{0}Failed to parse {1} as {2}".format( - additional_message, repr(data), klass.__name__ - ), - path_to_item=path_to_item - ) from ex - - -def get_discriminator_class(model_class, - discr_name, - discr_value, cls_visited): - """Returns the child class specified by the discriminator. - - Args: - model_class (OpenApiModel): the model class. - discr_name (string): the name of the discriminator property. - discr_value (any): the discriminator value. - cls_visited (list): list of model classes that have been visited. - Used to determine the discriminator class without - visiting circular references indefinitely. - - Returns: - used_model_class (class/None): the chosen child class that will be used - to deserialize the data, for example dog.Dog. - If a class is not found, None is returned. - """ - - if model_class in cls_visited: - # The class has already been visited and no suitable class was found. - return None - cls_visited.append(model_class) - used_model_class = None - if discr_name in model_class.discriminator: - class_name_to_discr_class = model_class.discriminator[discr_name] - used_model_class = class_name_to_discr_class.get(discr_value) - if used_model_class is None: - # We didn't find a discriminated class in class_name_to_discr_class. - # So look in the ancestor or descendant discriminators - # The discriminator mapping may exist in a descendant (anyOf, oneOf) - # or ancestor (allOf). - # Ancestor example: in the GrandparentAnimal -> ParentPet -> ChildCat - # hierarchy, the discriminator mappings may be defined at any level - # in the hierarchy. - # Descendant example: mammal -> whale/zebra/Pig -> BasquePig/DanishPig - # if we try to make BasquePig from mammal, we need to travel through - # the oneOf descendant discriminators to find BasquePig - descendant_classes = model_class._composed_schemas.get('oneOf', ()) + \ - model_class._composed_schemas.get('anyOf', ()) - ancestor_classes = model_class._composed_schemas.get('allOf', ()) - possible_classes = descendant_classes + ancestor_classes - for cls in possible_classes: - # Check if the schema has inherited discriminators. - if hasattr(cls, 'discriminator') and cls.discriminator is not None: - used_model_class = get_discriminator_class( - cls, discr_name, discr_value, cls_visited) - if used_model_class is not None: - return used_model_class - return used_model_class - - -def deserialize_model(model_data, model_class, path_to_item, check_type, - configuration, spec_property_naming): - """Deserializes model_data to model instance. - - Args: - model_data (int/str/float/bool/none_type/list/dict): data to instantiate the model - model_class (OpenApiModel): the model class - path_to_item (list): path to the model in the received data - check_type (bool): whether to check the data tupe for the values in - the model - configuration (Configuration): the instance to use to convert files - spec_property_naming (bool): True if the variable names in the input - data are serialized names as specified in the OpenAPI document. - False if the variables names in the input data are python - variable names in PEP-8 snake case. - - Returns: - model instance - - Raise: - ApiTypeError - ApiValueError - ApiKeyError - """ - - kw_args = dict(_check_type=check_type, - _path_to_item=path_to_item, - _configuration=configuration, - _spec_property_naming=spec_property_naming) - - if issubclass(model_class, ModelSimple): - return model_class._new_from_openapi_data(model_data, **kw_args) - elif isinstance(model_data, list): - return model_class._new_from_openapi_data(*model_data, **kw_args) - if isinstance(model_data, dict): - kw_args.update(model_data) - return model_class._new_from_openapi_data(**kw_args) - elif isinstance(model_data, PRIMITIVE_TYPES): - return model_class._new_from_openapi_data(model_data, **kw_args) - - -def deserialize_file(response_data, configuration, content_disposition=None): - """Deserializes body to file - - Saves response body into a file in a temporary folder, - using the filename from the `Content-Disposition` header if provided. - - Args: - param response_data (str): the file data to write - configuration (Configuration): the instance to use to convert files - - Keyword Args: - content_disposition (str): the value of the Content-Disposition - header - - Returns: - (file_type): the deserialized file which is open - The user is responsible for closing and reading the file - """ - fd, path = tempfile.mkstemp(dir=configuration.temp_folder_path) - os.close(fd) - os.remove(path) - - if content_disposition: - filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', - content_disposition, - flags=re.I) - if filename is not None: - filename = filename.group(1) - else: - filename = "default_" + str(uuid.uuid4()) - - path = os.path.join(os.path.dirname(path), filename) - - with open(path, "wb") as f: - if isinstance(response_data, str): - # change str to bytes so we can write it - response_data = response_data.encode('utf-8') - f.write(response_data) - - f = open(path, "rb") - return f - - -def attempt_convert_item(input_value, valid_classes, path_to_item, - configuration, spec_property_naming, key_type=False, - must_convert=False, check_type=True): - """ - Args: - input_value (any): the data to convert - valid_classes (any): the classes that are valid - path_to_item (list): the path to the item to convert - configuration (Configuration): the instance to use to convert files - spec_property_naming (bool): True if the variable names in the input - data are serialized names as specified in the OpenAPI document. - False if the variables names in the input data are python - variable names in PEP-8 snake case. - key_type (bool): if True we need to convert a key type (not supported) - must_convert (bool): if True we must convert - check_type (bool): if True we check the type or the returned data in - ModelComposed/ModelNormal/ModelSimple instances - - Returns: - instance (any) the fixed item - - Raises: - ApiTypeError - ApiValueError - ApiKeyError - """ - valid_classes_ordered = order_response_types(valid_classes) - valid_classes_coercible = remove_uncoercible( - valid_classes_ordered, input_value, spec_property_naming) - if not valid_classes_coercible or key_type: - # we do not handle keytype errors, json will take care - # of this for us - if configuration is None or not configuration.discard_unknown_keys: - raise get_type_error(input_value, path_to_item, valid_classes, - key_type=key_type) - for valid_class in valid_classes_coercible: - try: - if issubclass(valid_class, OpenApiModel): - return deserialize_model(input_value, valid_class, - path_to_item, check_type, - configuration, spec_property_naming) - elif valid_class == file_type: - return deserialize_file(input_value, configuration) - return deserialize_primitive(input_value, valid_class, - path_to_item) - except (ApiTypeError, ApiValueError, ApiKeyError) as conversion_exc: - if must_convert: - raise conversion_exc - # if we have conversion errors when must_convert == False - # we ignore the exception and move on to the next class - continue - # we were unable to convert, must_convert == False - return input_value - - -def is_type_nullable(input_type): - """ - Returns true if None is an allowed value for the specified input_type. - - A type is nullable if at least one of the following conditions is true: - 1. The OAS 'nullable' attribute has been specified, - 1. The type is the 'null' type, - 1. The type is a anyOf/oneOf composed schema, and a child schema is - the 'null' type. - Args: - input_type (type): the class of the input_value that we are - checking - Returns: - bool - """ - if input_type is none_type: - return True - if issubclass(input_type, OpenApiModel) and input_type._nullable: - return True - if issubclass(input_type, ModelComposed): - # If oneOf/anyOf, check if the 'null' type is one of the allowed types. - for t in input_type._composed_schemas.get('oneOf', ()): - if is_type_nullable(t): return True - for t in input_type._composed_schemas.get('anyOf', ()): - if is_type_nullable(t): return True - return False - - -def is_valid_type(input_class_simple, valid_classes): - """ - Args: - input_class_simple (class): the class of the input_value that we are - checking - valid_classes (tuple): the valid classes that the current item - should be - Returns: - bool - """ - if issubclass(input_class_simple, OpenApiModel) and \ - valid_classes == (bool, date, datetime, dict, float, int, list, str, none_type,): - return True - valid_type = input_class_simple in valid_classes - if not valid_type and ( - issubclass(input_class_simple, OpenApiModel) or - input_class_simple is none_type): - for valid_class in valid_classes: - if input_class_simple is none_type and is_type_nullable(valid_class): - # Schema is oneOf/anyOf and the 'null' type is one of the allowed types. - return True - if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator): - continue - discr_propertyname_py = list(valid_class.discriminator.keys())[0] - discriminator_classes = ( - valid_class.discriminator[discr_propertyname_py].values() - ) - valid_type = is_valid_type(input_class_simple, discriminator_classes) - if valid_type: - return True - return valid_type - - -def validate_and_convert_types(input_value, required_types_mixed, path_to_item, - spec_property_naming, _check_type, configuration=None): - """Raises a TypeError is there is a problem, otherwise returns value - - Args: - input_value (any): the data to validate/convert - required_types_mixed (list/dict/tuple): A list of - valid classes, or a list tuples of valid classes, or a dict where - the value is a tuple of value classes - path_to_item: (list) the path to the data being validated - this stores a list of keys or indices to get to the data being - validated - spec_property_naming (bool): True if the variable names in the input - data are serialized names as specified in the OpenAPI document. - False if the variables names in the input data are python - variable names in PEP-8 snake case. - _check_type: (boolean) if true, type will be checked and conversion - will be attempted. - configuration: (Configuration): the configuration class to use - when converting file_type items. - If passed, conversion will be attempted when possible - If not passed, no conversions will be attempted and - exceptions will be raised - - Returns: - the correctly typed value - - Raises: - ApiTypeError - """ - results = get_required_type_classes(required_types_mixed, spec_property_naming) - valid_classes, child_req_types_by_current_type = results - - input_class_simple = get_simple_class(input_value) - valid_type = is_valid_type(input_class_simple, valid_classes) - if not valid_type: - if (configuration - or (input_class_simple == dict - and not dict in valid_classes)): - # if input_value is not valid_type try to convert it - converted_instance = attempt_convert_item( - input_value, - valid_classes, - path_to_item, - configuration, - spec_property_naming, - key_type=False, - must_convert=True, - check_type=_check_type - ) - return converted_instance - else: - raise get_type_error(input_value, path_to_item, valid_classes, - key_type=False) - - # input_value's type is in valid_classes - if len(valid_classes) > 1 and configuration: - # there are valid classes which are not the current class - valid_classes_coercible = remove_uncoercible( - valid_classes, input_value, spec_property_naming, must_convert=False) - if valid_classes_coercible: - converted_instance = attempt_convert_item( - input_value, - valid_classes_coercible, - path_to_item, - configuration, - spec_property_naming, - key_type=False, - must_convert=False, - check_type=_check_type - ) - return converted_instance - - if child_req_types_by_current_type == {}: - # all types are of the required types and there are no more inner - # variables left to look at - return input_value - inner_required_types = child_req_types_by_current_type.get( - type(input_value) - ) - if inner_required_types is None: - # for this type, there are not more inner variables left to look at - return input_value - if isinstance(input_value, list): - if input_value == []: - # allow an empty list - return input_value - for index, inner_value in enumerate(input_value): - inner_path = list(path_to_item) - inner_path.append(index) - input_value[index] = validate_and_convert_types( - inner_value, - inner_required_types, - inner_path, - spec_property_naming, - _check_type, - configuration=configuration - ) - elif isinstance(input_value, dict): - if input_value == {}: - # allow an empty dict - return input_value - for inner_key, inner_val in input_value.items(): - inner_path = list(path_to_item) - inner_path.append(inner_key) - if get_simple_class(inner_key) != str: - raise get_type_error(inner_key, inner_path, valid_classes, - key_type=True) - input_value[inner_key] = validate_and_convert_types( - inner_val, - inner_required_types, - inner_path, - spec_property_naming, - _check_type, - configuration=configuration - ) - return input_value - - -def model_to_dict(model_instance, serialize=True): - """Returns the model properties as a dict - - Args: - model_instance (one of your model instances): the model instance that - will be converted to a dict. - - Keyword Args: - serialize (bool): if True, the keys in the dict will be values from - attribute_map - """ - result = {} - extract_item = lambda item: (item[0], model_to_dict(item[1], serialize=serialize)) if hasattr(item[1], '_data_store') else item - - model_instances = [model_instance] - if model_instance._composed_schemas: - model_instances.extend(model_instance._composed_instances) - seen_json_attribute_names = set() - used_fallback_python_attribute_names = set() - py_to_json_map = {} - for model_instance in model_instances: - for attr, value in model_instance._data_store.items(): - if serialize: - # we use get here because additional property key names do not - # exist in attribute_map - try: - attr = model_instance.attribute_map[attr] - py_to_json_map.update(model_instance.attribute_map) - seen_json_attribute_names.add(attr) - except KeyError: - used_fallback_python_attribute_names.add(attr) - if isinstance(value, list): - if not value: - # empty list or None - result[attr] = value - else: - res = [] - for v in value: - if isinstance(v, PRIMITIVE_TYPES) or v is None: - res.append(v) - elif isinstance(v, ModelSimple): - res.append(v.value) - elif isinstance(v, dict): - res.append(dict(map( - extract_item, - v.items() - ))) - else: - res.append(model_to_dict(v, serialize=serialize)) - result[attr] = res - elif isinstance(value, dict): - result[attr] = dict(map( - extract_item, - value.items() - )) - elif isinstance(value, ModelSimple): - result[attr] = value.value - elif hasattr(value, '_data_store'): - result[attr] = model_to_dict(value, serialize=serialize) - else: - result[attr] = value - if serialize: - for python_key in used_fallback_python_attribute_names: - json_key = py_to_json_map.get(python_key) - if json_key is None: - continue - if python_key == json_key: - continue - json_key_assigned_no_need_for_python_key = json_key in seen_json_attribute_names - if json_key_assigned_no_need_for_python_key: - del result[python_key] - - return result - - -def type_error_message(var_value=None, var_name=None, valid_classes=None, - key_type=None): - """ - Keyword Args: - var_value (any): the variable which has the type_error - var_name (str): the name of the variable which has the typ error - valid_classes (tuple): the accepted classes for current_item's - value - key_type (bool): False if our value is a value in a dict - True if it is a key in a dict - False if our item is an item in a list - """ - key_or_value = 'value' - if key_type: - key_or_value = 'key' - valid_classes_phrase = get_valid_classes_phrase(valid_classes) - msg = ( - "Invalid type for variable '{0}'. Required {1} type {2} and " - "passed type was {3}".format( - var_name, - key_or_value, - valid_classes_phrase, - type(var_value).__name__, - ) - ) - return msg - - -def get_valid_classes_phrase(input_classes): - """Returns a string phrase describing what types are allowed - """ - all_classes = list(input_classes) - all_classes = sorted(all_classes, key=lambda cls: cls.__name__) - all_class_names = [cls.__name__ for cls in all_classes] - if len(all_class_names) == 1: - return 'is {0}'.format(all_class_names[0]) - return "is one of [{0}]".format(", ".join(all_class_names)) - - -def get_allof_instances(self, model_args, constant_args): - """ - Args: - self: the class we are handling - model_args (dict): var_name to var_value - used to make instances - constant_args (dict): - metadata arguments: - _check_type - _path_to_item - _spec_property_naming - _configuration - _visited_composed_classes - - Returns - composed_instances (list) - """ - composed_instances = [] - for allof_class in self._composed_schemas['allOf']: - - try: - if constant_args.get('_spec_property_naming'): - allof_instance = allof_class._from_openapi_data(**model_args, **constant_args) - else: - allof_instance = allof_class(**model_args, **constant_args) - composed_instances.append(allof_instance) - except Exception as ex: - raise ApiValueError( - "Invalid inputs given to generate an instance of '%s'. The " - "input data was invalid for the allOf schema '%s' in the composed " - "schema '%s'. Error=%s" % ( - allof_class.__name__, - allof_class.__name__, - self.__class__.__name__, - str(ex) - ) - ) from ex - return composed_instances - - -def get_oneof_instance(cls, model_kwargs, constant_kwargs, model_arg=None): - """ - Find the oneOf schema that matches the input data (e.g. payload). - If exactly one schema matches the input data, an instance of that schema - is returned. - If zero or more than one schema match the input data, an exception is raised. - In OAS 3.x, the payload MUST, by validation, match exactly one of the - schemas described by oneOf. - - Args: - cls: the class we are handling - model_kwargs (dict): var_name to var_value - The input data, e.g. the payload that must match a oneOf schema - in the OpenAPI document. - constant_kwargs (dict): var_name to var_value - args that every model requires, including configuration, server - and path to item. - - Kwargs: - model_arg: (int, float, bool, str, date, datetime, ModelSimple, None): - the value to assign to a primitive class or ModelSimple class - Notes: - - this is only passed in when oneOf includes types which are not object - - None is used to suppress handling of model_arg, nullable models are handled in __new__ - - Returns - oneof_instance (instance) - """ - if len(cls._composed_schemas['oneOf']) == 0: - return None - - oneof_instances = [] - # Iterate over each oneOf schema and determine if the input data - # matches the oneOf schemas. - for oneof_class in cls._composed_schemas['oneOf']: - # The composed oneOf schema allows the 'null' type and the input data - # is the null value. This is a OAS >= 3.1 feature. - if oneof_class is none_type: - # skip none_types because we are deserializing dict data. - # none_type deserialization is handled in the __new__ method - continue - - single_value_input = allows_single_value_input(oneof_class) - - try: - if not single_value_input: - if constant_kwargs.get('_spec_property_naming'): - oneof_instance = oneof_class._from_openapi_data(**model_kwargs, **constant_kwargs) - else: - oneof_instance = oneof_class(**model_kwargs, **constant_kwargs) - - # Workaround for missing OneOf schema support by the generator - # Checks if the defined schema is a subset of received model - # This way we can ensure forward-compatibility support of new fields in API - assert len(set(model_kwargs.keys()).difference(set(oneof_class.openapi_types.keys()))) == 0 or set(oneof_class.openapi_types.keys()) <= set(model_kwargs.keys()) - - else: - if issubclass(oneof_class, ModelSimple): - if constant_kwargs.get('_spec_property_naming'): - oneof_instance = oneof_class._from_openapi_data(model_arg, **constant_kwargs) - else: - oneof_instance = oneof_class(model_arg, **constant_kwargs) - elif oneof_class in PRIMITIVE_TYPES: - oneof_instance = validate_and_convert_types( - model_arg, - (oneof_class,), - constant_kwargs['_path_to_item'], - constant_kwargs['_spec_property_naming'], - constant_kwargs['_check_type'], - configuration=constant_kwargs['_configuration'] - ) - oneof_instances.append(oneof_instance) - except Exception: - pass - if len(oneof_instances) == 0: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. None " - "of the oneOf schemas matched the input data." % - cls.__name__ - ) - elif len(oneof_instances) > 1: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. Multiple " - "oneOf schemas matched the inputs, but a max of one is allowed." % - cls.__name__ - ) - return oneof_instances[0] - - -def get_anyof_instances(self, model_args, constant_args): - """ - Args: - self: the class we are handling - model_args (dict): var_name to var_value - The input data, e.g. the payload that must match at least one - anyOf child schema in the OpenAPI document. - constant_args (dict): var_name to var_value - args that every model requires, including configuration, server - and path to item. - - Returns - anyof_instances (list) - """ - anyof_instances = [] - if len(self._composed_schemas['anyOf']) == 0: - return anyof_instances - - for anyof_class in self._composed_schemas['anyOf']: - # The composed oneOf schema allows the 'null' type and the input data - # is the null value. This is a OAS >= 3.1 feature. - if anyof_class is none_type: - # skip none_types because we are deserializing dict data. - # none_type deserialization is handled in the __new__ method - continue - - try: - if constant_args.get('_spec_property_naming'): - anyof_instance = anyof_class._from_openapi_data(**model_args, **constant_args) - else: - anyof_instance = anyof_class(**model_args, **constant_args) - anyof_instances.append(anyof_instance) - except Exception: - pass - if len(anyof_instances) == 0: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. None of the " - "anyOf schemas matched the inputs." % - self.__class__.__name__ - ) - return anyof_instances - - -def get_discarded_args(self, composed_instances, model_args): - """ - Gathers the args that were discarded by configuration.discard_unknown_keys - """ - model_arg_keys = model_args.keys() - discarded_args = set() - # arguments passed to self were already converted to python names - # before __init__ was called - for instance in composed_instances: - if instance.__class__ in self._composed_schemas['allOf']: - try: - keys = instance.to_dict().keys() - discarded_keys = model_args - keys - discarded_args.update(discarded_keys) - except Exception: - # allOf integer schema will throw exception - pass - else: - try: - all_keys = set(model_to_dict(instance, serialize=False).keys()) - js_keys = model_to_dict(instance, serialize=True).keys() - all_keys.update(js_keys) - discarded_keys = model_arg_keys - all_keys - discarded_args.update(discarded_keys) - except Exception: - # allOf integer schema will throw exception - pass - return discarded_args - - -def validate_get_composed_info(constant_args, model_args, self): - """ - For composed schemas, generate schema instances for - all schemas in the oneOf/anyOf/allOf definition. If additional - properties are allowed, also assign those properties on - all matched schemas that contain additionalProperties. - Openapi schemas are python classes. - - Exceptions are raised if: - - 0 or > 1 oneOf schema matches the model_args input data - - no anyOf schema matches the model_args input data - - any of the allOf schemas do not match the model_args input data - - Args: - constant_args (dict): these are the args that every model requires - model_args (dict): these are the required and optional spec args that - were passed in to make this model - self (class): the class that we are instantiating - This class contains self._composed_schemas - - Returns: - composed_info (list): length three - composed_instances (list): the composed instances which are not - self - var_name_to_model_instances (dict): a dict going from var_name - to the model_instance which holds that var_name - the model_instance may be self or an instance of one of the - classes in self.composed_instances() - additional_properties_model_instances (list): a list of the - model instances which have the property - additional_properties_type. This list can include self - """ - # create composed_instances - composed_instances = [] - allof_instances = get_allof_instances(self, model_args, constant_args) - composed_instances.extend(allof_instances) - oneof_instance = get_oneof_instance(self.__class__, model_args, constant_args) - if oneof_instance is not None: - composed_instances.append(oneof_instance) - anyof_instances = get_anyof_instances(self, model_args, constant_args) - composed_instances.extend(anyof_instances) - """ - set additional_properties_model_instances - additional properties must be evaluated at the schema level - so self's additional properties are most important - If self is a composed schema with: - - no properties defined in self - - additionalProperties: False - Then for object payloads every property is an additional property - and they are not allowed, so only empty dict is allowed - - Properties must be set on all matching schemas - so when a property is assigned toa composed instance, it must be set on all - composed instances regardless of additionalProperties presence - keeping it to prevent breaking changes in v5.0.1 - TODO remove cls._additional_properties_model_instances in 6.0.0 - """ - additional_properties_model_instances = [] - if self.additional_properties_type is not None: - additional_properties_model_instances = [self] - - """ - no need to set properties on self in here, they will be set in __init__ - By here all composed schema oneOf/anyOf/allOf instances have their properties set using - model_args - """ - discarded_args = get_discarded_args(self, composed_instances, model_args) - - # map variable names to composed_instances - var_name_to_model_instances = {} - for prop_name in model_args: - if prop_name not in discarded_args: - var_name_to_model_instances[prop_name] = [self] + composed_instances - - return [ - composed_instances, - var_name_to_model_instances, - additional_properties_model_instances, - discarded_args - ] diff --git a/.openapi-generator/custom_templates/setup.mustache b/.openapi-generator/custom_templates/setup.mustache index 898f30456..7a8057bd0 100644 --- a/.openapi-generator/custom_templates/setup.mustache +++ b/.openapi-generator/custom_templates/setup.mustache @@ -1,3 +1,5 @@ +# coding: utf-8 + {{>partial_header}} from setuptools import setup, find_packages # noqa: H301 @@ -19,18 +21,21 @@ VERSION = "{{packageVersion}}" # http://pypi.python.org/pypi/setuptools REQUIRES = [ - "urllib3 >= 1.25.3", - "python-dateutil", + "urllib3 >= 1.25.3, < 3.0.0", + "python-dateutil >= 2.8.2", {{#asyncio}} - "aiohttp >= 3.0.0", + "aiohttp >= 3.8.4", + "aiohttp-retry >= 2.8.3", {{/asyncio}} {{#tornado}} - "tornado>=4.2,<5", + "tornado>=4.2, < 5", {{/tornado}} {{#hasHttpSignatureMethods}} - "pem>=19.3.0", - "pycryptodome>=3.9.0", + "pem >= 19.3.0", + "pycryptodome >= 3.9.0", {{/hasHttpSignatureMethods}} + "pydantic >= 2", + "typing-extensions >= 4.7.1", ] setup( @@ -41,7 +46,7 @@ setup( author_email="{{infoEmail}}{{^infoEmail}}team@openapitools.org{{/infoEmail}}", url="{{packageUrl}}", keywords=["OpenAPI", "OpenAPI-Generator", "{{{appName}}}"], - python_requires=">=3.6", + python_requires=">=3.8", install_requires=REQUIRES, packages=find_packages(exclude=["test", "tests"]), include_package_data=True, diff --git a/gooddata-api-client/.openapi-generator/FILES b/gooddata-api-client/.openapi-generator/FILES index 7005b1136..a8841c5ed 100644 --- a/gooddata-api-client/.openapi-generator/FILES +++ b/gooddata-api-client/.openapi-generator/FILES @@ -59,9 +59,7 @@ docs/AttributeHeaderAttributeHeader.md docs/AttributeHierarchiesApi.md docs/AttributeItem.md docs/AttributeNegativeFilter.md -docs/AttributeNegativeFilterAllOf.md docs/AttributePositiveFilter.md -docs/AttributePositiveFilterAllOf.md docs/AttributeResultHeader.md docs/AttributesApi.md docs/AutomationAlert.md @@ -71,7 +69,6 @@ docs/AutomationExternalRecipient.md docs/AutomationImageExport.md docs/AutomationMetadata.md docs/AutomationNotification.md -docs/AutomationNotificationAllOf.md docs/AutomationOrganizationViewControllerApi.md docs/AutomationRawExport.md docs/AutomationSchedule.md @@ -91,7 +88,6 @@ docs/ChatResult.md docs/ChatUsageResponse.md docs/ClusteringRequest.md docs/ClusteringResult.md -docs/ColumnLocation.md docs/ColumnOverride.md docs/ColumnStatistic.md docs/ColumnStatisticWarning.md @@ -141,10 +137,8 @@ docs/DatasetReferenceIdentifier.md docs/DatasetWorkspaceDataFilterIdentifier.md docs/DatasetsApi.md docs/DateAbsoluteFilter.md -docs/DateAbsoluteFilterAllOf.md docs/DateFilter.md docs/DateRelativeFilter.md -docs/DateRelativeFilterAllOf.md docs/DateValue.md docs/DeclarativeAggregatedFact.md docs/DeclarativeAnalyticalDashboard.md @@ -152,9 +146,7 @@ docs/DeclarativeAnalyticalDashboardExtension.md docs/DeclarativeAnalyticalDashboardIdentifier.md docs/DeclarativeAnalyticalDashboardPermissionAssignment.md docs/DeclarativeAnalyticalDashboardPermissionForAssignee.md -docs/DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf.md docs/DeclarativeAnalyticalDashboardPermissionForAssigneeRule.md -docs/DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf.md docs/DeclarativeAnalyticalDashboardPermissionsInner.md docs/DeclarativeAnalytics.md docs/DeclarativeAnalyticsLayer.md @@ -231,17 +223,13 @@ docs/DeclarativeWorkspaceModel.md docs/DeclarativeWorkspacePermissions.md docs/DeclarativeWorkspaces.md docs/DefaultSmtp.md -docs/DefaultSmtpAllOf.md docs/DependencyGraphApi.md docs/DependentEntitiesGraph.md docs/DependentEntitiesNode.md docs/DependentEntitiesRequest.md docs/DependentEntitiesResponse.md docs/DependsOn.md -docs/DependsOnAllOf.md docs/DependsOnDateFilter.md -docs/DependsOnDateFilterAllOf.md -docs/DependsOnItem.md docs/DimAttribute.md docs/Dimension.md docs/DimensionHeader.md @@ -270,7 +258,6 @@ docs/ExportTemplatesApi.md docs/FactIdentifier.md docs/FactsApi.md docs/File.md -docs/Filter.md docs/FilterBy.md docs/FilterDefinition.md docs/FilterDefinitionForSimpleMeasure.md @@ -301,7 +288,6 @@ docs/IdentityProvidersApi.md docs/ImageExportApi.md docs/ImageExportRequest.md docs/InPlatform.md -docs/InPlatformAllOf.md docs/InlineFilterDefinition.md docs/InlineFilterDefinitionInline.md docs/InlineMeasureDefinition.md @@ -322,7 +308,6 @@ docs/JsonApiAggregatedFactOutRelationships.md docs/JsonApiAggregatedFactOutRelationshipsDataset.md docs/JsonApiAggregatedFactOutRelationshipsSourceFact.md docs/JsonApiAggregatedFactOutWithLinks.md -docs/JsonApiAggregatedFactToManyLinkage.md docs/JsonApiAnalyticalDashboardIn.md docs/JsonApiAnalyticalDashboardInAttributes.md docs/JsonApiAnalyticalDashboardInDocument.md @@ -349,7 +334,6 @@ docs/JsonApiAnalyticalDashboardPatchAttributes.md docs/JsonApiAnalyticalDashboardPatchDocument.md docs/JsonApiAnalyticalDashboardPostOptionalId.md docs/JsonApiAnalyticalDashboardPostOptionalIdDocument.md -docs/JsonApiAnalyticalDashboardToManyLinkage.md docs/JsonApiAnalyticalDashboardToOneLinkage.md docs/JsonApiApiTokenIn.md docs/JsonApiApiTokenInDocument.md @@ -372,7 +356,6 @@ docs/JsonApiAttributeHierarchyOutRelationshipsAttributes.md docs/JsonApiAttributeHierarchyOutWithLinks.md docs/JsonApiAttributeHierarchyPatch.md docs/JsonApiAttributeHierarchyPatchDocument.md -docs/JsonApiAttributeHierarchyToManyLinkage.md docs/JsonApiAttributeLinkage.md docs/JsonApiAttributeOut.md docs/JsonApiAttributeOutAttributes.md @@ -383,7 +366,6 @@ docs/JsonApiAttributeOutRelationships.md docs/JsonApiAttributeOutRelationshipsAttributeHierarchies.md docs/JsonApiAttributeOutRelationshipsDefaultView.md docs/JsonApiAttributeOutWithLinks.md -docs/JsonApiAttributeToManyLinkage.md docs/JsonApiAttributeToOneLinkage.md docs/JsonApiAutomationIn.md docs/JsonApiAutomationInAttributes.md @@ -420,7 +402,6 @@ docs/JsonApiAutomationResultOutAttributes.md docs/JsonApiAutomationResultOutRelationships.md docs/JsonApiAutomationResultOutRelationshipsAutomation.md docs/JsonApiAutomationResultOutWithLinks.md -docs/JsonApiAutomationResultToManyLinkage.md docs/JsonApiAutomationToOneLinkage.md docs/JsonApiColorPaletteIn.md docs/JsonApiColorPaletteInAttributes.md @@ -475,7 +456,6 @@ docs/JsonApiDashboardPluginPatch.md docs/JsonApiDashboardPluginPatchDocument.md docs/JsonApiDashboardPluginPostOptionalId.md docs/JsonApiDashboardPluginPostOptionalIdDocument.md -docs/JsonApiDashboardPluginToManyLinkage.md docs/JsonApiDataSourceIdentifierOut.md docs/JsonApiDataSourceIdentifierOutAttributes.md docs/JsonApiDataSourceIdentifierOutDocument.md @@ -510,7 +490,6 @@ docs/JsonApiDatasetOutRelationshipsAggregatedFacts.md docs/JsonApiDatasetOutRelationshipsFacts.md docs/JsonApiDatasetOutRelationshipsWorkspaceDataFilters.md docs/JsonApiDatasetOutWithLinks.md -docs/JsonApiDatasetToManyLinkage.md docs/JsonApiDatasetToOneLinkage.md docs/JsonApiEntitlementOut.md docs/JsonApiEntitlementOutAttributes.md @@ -535,7 +514,6 @@ docs/JsonApiExportDefinitionPatch.md docs/JsonApiExportDefinitionPatchDocument.md docs/JsonApiExportDefinitionPostOptionalId.md docs/JsonApiExportDefinitionPostOptionalIdDocument.md -docs/JsonApiExportDefinitionToManyLinkage.md docs/JsonApiExportTemplateIn.md docs/JsonApiExportTemplateInAttributes.md docs/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md @@ -557,7 +535,6 @@ docs/JsonApiFactOutDocument.md docs/JsonApiFactOutList.md docs/JsonApiFactOutRelationships.md docs/JsonApiFactOutWithLinks.md -docs/JsonApiFactToManyLinkage.md docs/JsonApiFactToOneLinkage.md docs/JsonApiFilterContextIn.md docs/JsonApiFilterContextInDocument.md @@ -572,7 +549,6 @@ docs/JsonApiFilterContextPatch.md docs/JsonApiFilterContextPatchDocument.md docs/JsonApiFilterContextPostOptionalId.md docs/JsonApiFilterContextPostOptionalIdDocument.md -docs/JsonApiFilterContextToManyLinkage.md docs/JsonApiFilterViewIn.md docs/JsonApiFilterViewInAttributes.md docs/JsonApiFilterViewInDocument.md @@ -616,7 +592,6 @@ docs/JsonApiLabelOutList.md docs/JsonApiLabelOutRelationships.md docs/JsonApiLabelOutRelationshipsAttribute.md docs/JsonApiLabelOutWithLinks.md -docs/JsonApiLabelToManyLinkage.md docs/JsonApiLabelToOneLinkage.md docs/JsonApiLlmEndpointIn.md docs/JsonApiLlmEndpointInAttributes.md @@ -646,7 +621,6 @@ docs/JsonApiMetricPatchAttributes.md docs/JsonApiMetricPatchDocument.md docs/JsonApiMetricPostOptionalId.md docs/JsonApiMetricPostOptionalIdDocument.md -docs/JsonApiMetricToManyLinkage.md docs/JsonApiNotificationChannelIdentifierOut.md docs/JsonApiNotificationChannelIdentifierOutAttributes.md docs/JsonApiNotificationChannelIdentifierOutDocument.md @@ -726,7 +700,6 @@ docs/JsonApiUserGroupOutList.md docs/JsonApiUserGroupOutWithLinks.md docs/JsonApiUserGroupPatch.md docs/JsonApiUserGroupPatchDocument.md -docs/JsonApiUserGroupToManyLinkage.md docs/JsonApiUserGroupToOneLinkage.md docs/JsonApiUserIdentifierLinkage.md docs/JsonApiUserIdentifierOut.md @@ -752,7 +725,6 @@ docs/JsonApiUserSettingOut.md docs/JsonApiUserSettingOutDocument.md docs/JsonApiUserSettingOutList.md docs/JsonApiUserSettingOutWithLinks.md -docs/JsonApiUserToManyLinkage.md docs/JsonApiUserToOneLinkage.md docs/JsonApiVisualizationObjectIn.md docs/JsonApiVisualizationObjectInAttributes.md @@ -768,7 +740,6 @@ docs/JsonApiVisualizationObjectPatchAttributes.md docs/JsonApiVisualizationObjectPatchDocument.md docs/JsonApiVisualizationObjectPostOptionalId.md docs/JsonApiVisualizationObjectPostOptionalIdDocument.md -docs/JsonApiVisualizationObjectToManyLinkage.md docs/JsonApiVisualizationObjectToOneLinkage.md docs/JsonApiWorkspaceAutomationOut.md docs/JsonApiWorkspaceAutomationOutIncludes.md @@ -800,8 +771,6 @@ docs/JsonApiWorkspaceDataFilterSettingOutList.md docs/JsonApiWorkspaceDataFilterSettingOutWithLinks.md docs/JsonApiWorkspaceDataFilterSettingPatch.md docs/JsonApiWorkspaceDataFilterSettingPatchDocument.md -docs/JsonApiWorkspaceDataFilterSettingToManyLinkage.md -docs/JsonApiWorkspaceDataFilterToManyLinkage.md docs/JsonApiWorkspaceDataFilterToOneLinkage.md docs/JsonApiWorkspaceIn.md docs/JsonApiWorkspaceInAttributes.md @@ -830,7 +799,6 @@ docs/JsonApiWorkspaceSettingPatchDocument.md docs/JsonApiWorkspaceSettingPostOptionalId.md docs/JsonApiWorkspaceSettingPostOptionalIdDocument.md docs/JsonApiWorkspaceToOneLinkage.md -docs/JsonNode.md docs/KeyDriversDimension.md docs/KeyDriversRequest.md docs/KeyDriversResponse.md @@ -841,7 +809,6 @@ docs/LabelIdentifier.md docs/LabelsApi.md docs/LayoutApi.md docs/ListLinks.md -docs/ListLinksAllOf.md docs/LocalIdentifier.md docs/LocaleRequest.md docs/ManageDashboardPermissionsRequestInner.md @@ -895,7 +862,6 @@ docs/PdmSql.md docs/PermissionsApi.md docs/PermissionsAssignment.md docs/PermissionsForAssignee.md -docs/PermissionsForAssigneeAllOf.md docs/PermissionsForAssigneeRule.md docs/PlatformUsage.md docs/PlatformUsageRequest.md @@ -964,7 +930,6 @@ docs/SlidesExportRequest.md docs/SmartFunctionResponse.md docs/SmartFunctionsApi.md docs/Smtp.md -docs/SmtpAllOf.md docs/SortKey.md docs/SortKeyAttribute.md docs/SortKeyAttributeAttribute.md @@ -974,11 +939,9 @@ docs/SortKeyValue.md docs/SortKeyValueValue.md docs/SqlColumn.md docs/SqlQuery.md -docs/SqlQueryAllOf.md docs/Suggestion.md docs/SwitchIdentityProviderRequest.md docs/Table.md -docs/TableAllOf.md docs/TableOverride.md docs/TableWarning.md docs/TabularExportApi.md @@ -987,7 +950,6 @@ docs/TestConnectionApi.md docs/TestDefinitionRequest.md docs/TestDestinationRequest.md docs/TestNotification.md -docs/TestNotificationAllOf.md docs/TestQueryDuration.md docs/TestRequest.md docs/TestResponse.md @@ -1032,7 +994,6 @@ docs/VisualExportApi.md docs/VisualExportRequest.md docs/VisualizationObjectApi.md docs/Webhook.md -docs/WebhookAllOf.md docs/WebhookAutomationInfo.md docs/WebhookMessage.md docs/WebhookMessageData.md @@ -1127,993 +1088,954 @@ gooddata_api_client/api/workspaces_declarative_apis_api.py gooddata_api_client/api/workspaces_entity_apis_api.py gooddata_api_client/api/workspaces_settings_api.py gooddata_api_client/api_client.py -gooddata_api_client/apis/__init__.py +gooddata_api_client/api_response.py gooddata_api_client/configuration.py gooddata_api_client/exceptions.py -gooddata_api_client/model/__init__.py -gooddata_api_client/model/absolute_date_filter.py -gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py -gooddata_api_client/model/abstract_measure_value_filter.py -gooddata_api_client/model/active_object_identification.py -gooddata_api_client/model/ad_hoc_automation.py -gooddata_api_client/model/afm.py -gooddata_api_client/model/afm_cancel_tokens.py -gooddata_api_client/model/afm_execution.py -gooddata_api_client/model/afm_execution_response.py -gooddata_api_client/model/afm_filters_inner.py -gooddata_api_client/model/afm_identifier.py -gooddata_api_client/model/afm_local_identifier.py -gooddata_api_client/model/afm_object_identifier.py -gooddata_api_client/model/afm_object_identifier_attribute.py -gooddata_api_client/model/afm_object_identifier_attribute_identifier.py -gooddata_api_client/model/afm_object_identifier_core.py -gooddata_api_client/model/afm_object_identifier_core_identifier.py -gooddata_api_client/model/afm_object_identifier_dataset.py -gooddata_api_client/model/afm_object_identifier_dataset_identifier.py -gooddata_api_client/model/afm_object_identifier_identifier.py -gooddata_api_client/model/afm_object_identifier_label.py -gooddata_api_client/model/afm_object_identifier_label_identifier.py -gooddata_api_client/model/afm_valid_descendants_query.py -gooddata_api_client/model/afm_valid_descendants_response.py -gooddata_api_client/model/afm_valid_objects_query.py -gooddata_api_client/model/afm_valid_objects_response.py -gooddata_api_client/model/alert_afm.py -gooddata_api_client/model/alert_condition.py -gooddata_api_client/model/alert_condition_operand.py -gooddata_api_client/model/alert_description.py -gooddata_api_client/model/alert_evaluation_row.py -gooddata_api_client/model/analytics_catalog_tags.py -gooddata_api_client/model/anomaly_detection_request.py -gooddata_api_client/model/anomaly_detection_result.py -gooddata_api_client/model/api_entitlement.py -gooddata_api_client/model/arithmetic_measure.py -gooddata_api_client/model/arithmetic_measure_definition.py -gooddata_api_client/model/arithmetic_measure_definition_arithmetic_measure.py -gooddata_api_client/model/assignee_identifier.py -gooddata_api_client/model/assignee_rule.py -gooddata_api_client/model/attribute_elements.py -gooddata_api_client/model/attribute_elements_by_ref.py -gooddata_api_client/model/attribute_elements_by_value.py -gooddata_api_client/model/attribute_execution_result_header.py -gooddata_api_client/model/attribute_filter.py -gooddata_api_client/model/attribute_filter_by_date.py -gooddata_api_client/model/attribute_filter_elements.py -gooddata_api_client/model/attribute_filter_parent.py -gooddata_api_client/model/attribute_format.py -gooddata_api_client/model/attribute_header.py -gooddata_api_client/model/attribute_header_attribute_header.py -gooddata_api_client/model/attribute_item.py -gooddata_api_client/model/attribute_negative_filter.py -gooddata_api_client/model/attribute_negative_filter_all_of.py -gooddata_api_client/model/attribute_positive_filter.py -gooddata_api_client/model/attribute_positive_filter_all_of.py -gooddata_api_client/model/attribute_result_header.py -gooddata_api_client/model/automation_alert.py -gooddata_api_client/model/automation_alert_condition.py -gooddata_api_client/model/automation_dashboard_tabular_export.py -gooddata_api_client/model/automation_external_recipient.py -gooddata_api_client/model/automation_image_export.py -gooddata_api_client/model/automation_metadata.py -gooddata_api_client/model/automation_notification.py -gooddata_api_client/model/automation_notification_all_of.py -gooddata_api_client/model/automation_raw_export.py -gooddata_api_client/model/automation_schedule.py -gooddata_api_client/model/automation_slides_export.py -gooddata_api_client/model/automation_tabular_export.py -gooddata_api_client/model/automation_visual_export.py -gooddata_api_client/model/available_assignees.py -gooddata_api_client/model/bounded_filter.py -gooddata_api_client/model/chat_history_interaction.py -gooddata_api_client/model/chat_history_request.py -gooddata_api_client/model/chat_history_result.py -gooddata_api_client/model/chat_request.py -gooddata_api_client/model/chat_result.py -gooddata_api_client/model/chat_usage_response.py -gooddata_api_client/model/clustering_request.py -gooddata_api_client/model/clustering_result.py -gooddata_api_client/model/column_location.py -gooddata_api_client/model/column_override.py -gooddata_api_client/model/column_statistic.py -gooddata_api_client/model/column_statistic_warning.py -gooddata_api_client/model/column_statistics_request.py -gooddata_api_client/model/column_statistics_request_from.py -gooddata_api_client/model/column_statistics_response.py -gooddata_api_client/model/column_warning.py -gooddata_api_client/model/comparison.py -gooddata_api_client/model/comparison_measure_value_filter.py -gooddata_api_client/model/comparison_measure_value_filter_comparison_measure_value_filter.py -gooddata_api_client/model/comparison_wrapper.py -gooddata_api_client/model/content_slide_template.py -gooddata_api_client/model/cover_slide_template.py -gooddata_api_client/model/created_visualization.py -gooddata_api_client/model/created_visualization_filters_inner.py -gooddata_api_client/model/created_visualizations.py -gooddata_api_client/model/custom_label.py -gooddata_api_client/model/custom_metric.py -gooddata_api_client/model/custom_override.py -gooddata_api_client/model/dashboard_attribute_filter.py -gooddata_api_client/model/dashboard_attribute_filter_attribute_filter.py -gooddata_api_client/model/dashboard_date_filter.py -gooddata_api_client/model/dashboard_date_filter_date_filter.py -gooddata_api_client/model/dashboard_date_filter_date_filter_from.py -gooddata_api_client/model/dashboard_export_settings.py -gooddata_api_client/model/dashboard_filter.py -gooddata_api_client/model/dashboard_permissions.py -gooddata_api_client/model/dashboard_permissions_assignment.py -gooddata_api_client/model/dashboard_slides_template.py -gooddata_api_client/model/dashboard_tabular_export_request.py -gooddata_api_client/model/dashboard_tabular_export_request_v2.py -gooddata_api_client/model/data_column_locator.py -gooddata_api_client/model/data_column_locators.py -gooddata_api_client/model/data_source_parameter.py -gooddata_api_client/model/data_source_permission_assignment.py -gooddata_api_client/model/data_source_schemata.py -gooddata_api_client/model/data_source_table_identifier.py -gooddata_api_client/model/dataset_grain.py -gooddata_api_client/model/dataset_reference_identifier.py -gooddata_api_client/model/dataset_workspace_data_filter_identifier.py -gooddata_api_client/model/date_absolute_filter.py -gooddata_api_client/model/date_absolute_filter_all_of.py -gooddata_api_client/model/date_filter.py -gooddata_api_client/model/date_relative_filter.py -gooddata_api_client/model/date_relative_filter_all_of.py -gooddata_api_client/model/date_value.py -gooddata_api_client/model/declarative_aggregated_fact.py -gooddata_api_client/model/declarative_analytical_dashboard.py -gooddata_api_client/model/declarative_analytical_dashboard_extension.py -gooddata_api_client/model/declarative_analytical_dashboard_identifier.py -gooddata_api_client/model/declarative_analytical_dashboard_permission_assignment.py -gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee.py -gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_all_of.py -gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_rule.py -gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_rule_all_of.py -gooddata_api_client/model/declarative_analytical_dashboard_permissions_inner.py -gooddata_api_client/model/declarative_analytics.py -gooddata_api_client/model/declarative_analytics_layer.py -gooddata_api_client/model/declarative_attribute.py -gooddata_api_client/model/declarative_attribute_hierarchy.py -gooddata_api_client/model/declarative_automation.py -gooddata_api_client/model/declarative_color_palette.py -gooddata_api_client/model/declarative_column.py -gooddata_api_client/model/declarative_csp_directive.py -gooddata_api_client/model/declarative_custom_application_setting.py -gooddata_api_client/model/declarative_dashboard_plugin.py -gooddata_api_client/model/declarative_data_source.py -gooddata_api_client/model/declarative_data_source_permission.py -gooddata_api_client/model/declarative_data_source_permissions.py -gooddata_api_client/model/declarative_data_sources.py -gooddata_api_client/model/declarative_dataset.py -gooddata_api_client/model/declarative_dataset_extension.py -gooddata_api_client/model/declarative_dataset_sql.py -gooddata_api_client/model/declarative_date_dataset.py -gooddata_api_client/model/declarative_export_definition.py -gooddata_api_client/model/declarative_export_definition_identifier.py -gooddata_api_client/model/declarative_export_definition_request_payload.py -gooddata_api_client/model/declarative_export_template.py -gooddata_api_client/model/declarative_export_templates.py -gooddata_api_client/model/declarative_fact.py -gooddata_api_client/model/declarative_filter_context.py -gooddata_api_client/model/declarative_filter_view.py -gooddata_api_client/model/declarative_identity_provider.py -gooddata_api_client/model/declarative_identity_provider_identifier.py -gooddata_api_client/model/declarative_jwk.py -gooddata_api_client/model/declarative_jwk_specification.py -gooddata_api_client/model/declarative_label.py -gooddata_api_client/model/declarative_ldm.py -gooddata_api_client/model/declarative_metric.py -gooddata_api_client/model/declarative_model.py -gooddata_api_client/model/declarative_notification_channel.py -gooddata_api_client/model/declarative_notification_channel_destination.py -gooddata_api_client/model/declarative_notification_channel_identifier.py -gooddata_api_client/model/declarative_notification_channels.py -gooddata_api_client/model/declarative_organization.py -gooddata_api_client/model/declarative_organization_info.py -gooddata_api_client/model/declarative_organization_permission.py -gooddata_api_client/model/declarative_reference.py -gooddata_api_client/model/declarative_reference_source.py -gooddata_api_client/model/declarative_rsa_specification.py -gooddata_api_client/model/declarative_setting.py -gooddata_api_client/model/declarative_single_workspace_permission.py -gooddata_api_client/model/declarative_source_fact_reference.py -gooddata_api_client/model/declarative_table.py -gooddata_api_client/model/declarative_tables.py -gooddata_api_client/model/declarative_theme.py -gooddata_api_client/model/declarative_user.py -gooddata_api_client/model/declarative_user_data_filter.py -gooddata_api_client/model/declarative_user_data_filters.py -gooddata_api_client/model/declarative_user_group.py -gooddata_api_client/model/declarative_user_group_identifier.py -gooddata_api_client/model/declarative_user_group_permission.py -gooddata_api_client/model/declarative_user_group_permissions.py -gooddata_api_client/model/declarative_user_groups.py -gooddata_api_client/model/declarative_user_identifier.py -gooddata_api_client/model/declarative_user_permission.py -gooddata_api_client/model/declarative_user_permissions.py -gooddata_api_client/model/declarative_users.py -gooddata_api_client/model/declarative_users_user_groups.py -gooddata_api_client/model/declarative_visualization_object.py -gooddata_api_client/model/declarative_workspace.py -gooddata_api_client/model/declarative_workspace_data_filter.py -gooddata_api_client/model/declarative_workspace_data_filter_column.py -gooddata_api_client/model/declarative_workspace_data_filter_references.py -gooddata_api_client/model/declarative_workspace_data_filter_setting.py -gooddata_api_client/model/declarative_workspace_data_filters.py -gooddata_api_client/model/declarative_workspace_hierarchy_permission.py -gooddata_api_client/model/declarative_workspace_model.py -gooddata_api_client/model/declarative_workspace_permissions.py -gooddata_api_client/model/declarative_workspaces.py -gooddata_api_client/model/default_smtp.py -gooddata_api_client/model/default_smtp_all_of.py -gooddata_api_client/model/dependent_entities_graph.py -gooddata_api_client/model/dependent_entities_node.py -gooddata_api_client/model/dependent_entities_request.py -gooddata_api_client/model/dependent_entities_response.py -gooddata_api_client/model/depends_on.py -gooddata_api_client/model/depends_on_all_of.py -gooddata_api_client/model/depends_on_date_filter.py -gooddata_api_client/model/depends_on_date_filter_all_of.py -gooddata_api_client/model/depends_on_item.py -gooddata_api_client/model/dim_attribute.py -gooddata_api_client/model/dimension.py -gooddata_api_client/model/dimension_header.py -gooddata_api_client/model/element.py -gooddata_api_client/model/elements_request.py -gooddata_api_client/model/elements_request_depends_on_inner.py -gooddata_api_client/model/elements_response.py -gooddata_api_client/model/entitlements_request.py -gooddata_api_client/model/entity_identifier.py -gooddata_api_client/model/execution_links.py -gooddata_api_client/model/execution_response.py -gooddata_api_client/model/execution_result.py -gooddata_api_client/model/execution_result_data_source_message.py -gooddata_api_client/model/execution_result_grand_total.py -gooddata_api_client/model/execution_result_header.py -gooddata_api_client/model/execution_result_metadata.py -gooddata_api_client/model/execution_result_paging.py -gooddata_api_client/model/execution_settings.py -gooddata_api_client/model/export_request.py -gooddata_api_client/model/export_response.py -gooddata_api_client/model/export_result.py -gooddata_api_client/model/fact_identifier.py -gooddata_api_client/model/file.py -gooddata_api_client/model/filter.py -gooddata_api_client/model/filter_by.py -gooddata_api_client/model/filter_definition.py -gooddata_api_client/model/filter_definition_for_simple_measure.py -gooddata_api_client/model/forecast_request.py -gooddata_api_client/model/forecast_result.py -gooddata_api_client/model/found_objects.py -gooddata_api_client/model/frequency.py -gooddata_api_client/model/frequency_bucket.py -gooddata_api_client/model/frequency_properties.py -gooddata_api_client/model/generate_ldm_request.py -gooddata_api_client/model/get_image_export202_response_inner.py -gooddata_api_client/model/get_quality_issues_response.py -gooddata_api_client/model/grain_identifier.py -gooddata_api_client/model/granted_permission.py -gooddata_api_client/model/granularities_formatting.py -gooddata_api_client/model/header_group.py -gooddata_api_client/model/hierarchy_object_identification.py -gooddata_api_client/model/histogram.py -gooddata_api_client/model/histogram_bucket.py -gooddata_api_client/model/histogram_properties.py -gooddata_api_client/model/identifier_duplications.py -gooddata_api_client/model/identifier_ref.py -gooddata_api_client/model/identifier_ref_identifier.py -gooddata_api_client/model/image_export_request.py -gooddata_api_client/model/in_platform.py -gooddata_api_client/model/in_platform_all_of.py -gooddata_api_client/model/inline_filter_definition.py -gooddata_api_client/model/inline_filter_definition_inline.py -gooddata_api_client/model/inline_measure_definition.py -gooddata_api_client/model/inline_measure_definition_inline.py -gooddata_api_client/model/intro_slide_template.py -gooddata_api_client/model/json_api_aggregated_fact_linkage.py -gooddata_api_client/model/json_api_aggregated_fact_out.py -gooddata_api_client/model/json_api_aggregated_fact_out_attributes.py -gooddata_api_client/model/json_api_aggregated_fact_out_document.py -gooddata_api_client/model/json_api_aggregated_fact_out_includes.py -gooddata_api_client/model/json_api_aggregated_fact_out_list.py -gooddata_api_client/model/json_api_aggregated_fact_out_list_meta.py -gooddata_api_client/model/json_api_aggregated_fact_out_meta.py -gooddata_api_client/model/json_api_aggregated_fact_out_meta_origin.py -gooddata_api_client/model/json_api_aggregated_fact_out_relationships.py -gooddata_api_client/model/json_api_aggregated_fact_out_relationships_dataset.py -gooddata_api_client/model/json_api_aggregated_fact_out_relationships_source_fact.py -gooddata_api_client/model/json_api_aggregated_fact_out_with_links.py -gooddata_api_client/model/json_api_aggregated_fact_to_many_linkage.py -gooddata_api_client/model/json_api_analytical_dashboard_in.py -gooddata_api_client/model/json_api_analytical_dashboard_in_attributes.py -gooddata_api_client/model/json_api_analytical_dashboard_in_document.py -gooddata_api_client/model/json_api_analytical_dashboard_linkage.py -gooddata_api_client/model/json_api_analytical_dashboard_out.py -gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py -gooddata_api_client/model/json_api_analytical_dashboard_out_document.py -gooddata_api_client/model/json_api_analytical_dashboard_out_includes.py -gooddata_api_client/model/json_api_analytical_dashboard_out_list.py -gooddata_api_client/model/json_api_analytical_dashboard_out_meta.py -gooddata_api_client/model/json_api_analytical_dashboard_out_meta_access_info.py -gooddata_api_client/model/json_api_analytical_dashboard_out_relationships.py -gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_analytical_dashboards.py -gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_created_by.py -gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_dashboard_plugins.py -gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_datasets.py -gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_filter_contexts.py -gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_labels.py -gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_metrics.py -gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_visualization_objects.py -gooddata_api_client/model/json_api_analytical_dashboard_out_with_links.py -gooddata_api_client/model/json_api_analytical_dashboard_patch.py -gooddata_api_client/model/json_api_analytical_dashboard_patch_attributes.py -gooddata_api_client/model/json_api_analytical_dashboard_patch_document.py -gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id.py -gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id_document.py -gooddata_api_client/model/json_api_analytical_dashboard_to_many_linkage.py -gooddata_api_client/model/json_api_analytical_dashboard_to_one_linkage.py -gooddata_api_client/model/json_api_api_token_in.py -gooddata_api_client/model/json_api_api_token_in_document.py -gooddata_api_client/model/json_api_api_token_out.py -gooddata_api_client/model/json_api_api_token_out_attributes.py -gooddata_api_client/model/json_api_api_token_out_document.py -gooddata_api_client/model/json_api_api_token_out_list.py -gooddata_api_client/model/json_api_api_token_out_with_links.py -gooddata_api_client/model/json_api_attribute_hierarchy_in.py -gooddata_api_client/model/json_api_attribute_hierarchy_in_attributes.py -gooddata_api_client/model/json_api_attribute_hierarchy_in_document.py -gooddata_api_client/model/json_api_attribute_hierarchy_linkage.py -gooddata_api_client/model/json_api_attribute_hierarchy_out.py -gooddata_api_client/model/json_api_attribute_hierarchy_out_attributes.py -gooddata_api_client/model/json_api_attribute_hierarchy_out_document.py -gooddata_api_client/model/json_api_attribute_hierarchy_out_includes.py -gooddata_api_client/model/json_api_attribute_hierarchy_out_list.py -gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships.py -gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships_attributes.py -gooddata_api_client/model/json_api_attribute_hierarchy_out_with_links.py -gooddata_api_client/model/json_api_attribute_hierarchy_patch.py -gooddata_api_client/model/json_api_attribute_hierarchy_patch_document.py -gooddata_api_client/model/json_api_attribute_hierarchy_to_many_linkage.py -gooddata_api_client/model/json_api_attribute_linkage.py -gooddata_api_client/model/json_api_attribute_out.py -gooddata_api_client/model/json_api_attribute_out_attributes.py -gooddata_api_client/model/json_api_attribute_out_document.py -gooddata_api_client/model/json_api_attribute_out_includes.py -gooddata_api_client/model/json_api_attribute_out_list.py -gooddata_api_client/model/json_api_attribute_out_relationships.py -gooddata_api_client/model/json_api_attribute_out_relationships_attribute_hierarchies.py -gooddata_api_client/model/json_api_attribute_out_relationships_default_view.py -gooddata_api_client/model/json_api_attribute_out_with_links.py -gooddata_api_client/model/json_api_attribute_to_many_linkage.py -gooddata_api_client/model/json_api_attribute_to_one_linkage.py -gooddata_api_client/model/json_api_automation_in.py -gooddata_api_client/model/json_api_automation_in_attributes.py -gooddata_api_client/model/json_api_automation_in_attributes_alert.py -gooddata_api_client/model/json_api_automation_in_attributes_dashboard_tabular_exports_inner.py -gooddata_api_client/model/json_api_automation_in_attributes_external_recipients_inner.py -gooddata_api_client/model/json_api_automation_in_attributes_image_exports_inner.py -gooddata_api_client/model/json_api_automation_in_attributes_metadata.py -gooddata_api_client/model/json_api_automation_in_attributes_raw_exports_inner.py -gooddata_api_client/model/json_api_automation_in_attributes_schedule.py -gooddata_api_client/model/json_api_automation_in_attributes_slides_exports_inner.py -gooddata_api_client/model/json_api_automation_in_attributes_tabular_exports_inner.py -gooddata_api_client/model/json_api_automation_in_attributes_visual_exports_inner.py -gooddata_api_client/model/json_api_automation_in_document.py -gooddata_api_client/model/json_api_automation_in_relationships.py -gooddata_api_client/model/json_api_automation_in_relationships_analytical_dashboard.py -gooddata_api_client/model/json_api_automation_in_relationships_export_definitions.py -gooddata_api_client/model/json_api_automation_in_relationships_notification_channel.py -gooddata_api_client/model/json_api_automation_in_relationships_recipients.py -gooddata_api_client/model/json_api_automation_linkage.py -gooddata_api_client/model/json_api_automation_out.py -gooddata_api_client/model/json_api_automation_out_attributes.py -gooddata_api_client/model/json_api_automation_out_document.py -gooddata_api_client/model/json_api_automation_out_includes.py -gooddata_api_client/model/json_api_automation_out_list.py -gooddata_api_client/model/json_api_automation_out_relationships.py -gooddata_api_client/model/json_api_automation_out_relationships_automation_results.py -gooddata_api_client/model/json_api_automation_out_with_links.py -gooddata_api_client/model/json_api_automation_patch.py -gooddata_api_client/model/json_api_automation_patch_document.py -gooddata_api_client/model/json_api_automation_result_linkage.py -gooddata_api_client/model/json_api_automation_result_out.py -gooddata_api_client/model/json_api_automation_result_out_attributes.py -gooddata_api_client/model/json_api_automation_result_out_relationships.py -gooddata_api_client/model/json_api_automation_result_out_relationships_automation.py -gooddata_api_client/model/json_api_automation_result_out_with_links.py -gooddata_api_client/model/json_api_automation_result_to_many_linkage.py -gooddata_api_client/model/json_api_automation_to_one_linkage.py -gooddata_api_client/model/json_api_color_palette_in.py -gooddata_api_client/model/json_api_color_palette_in_attributes.py -gooddata_api_client/model/json_api_color_palette_in_document.py -gooddata_api_client/model/json_api_color_palette_out.py -gooddata_api_client/model/json_api_color_palette_out_document.py -gooddata_api_client/model/json_api_color_palette_out_list.py -gooddata_api_client/model/json_api_color_palette_out_with_links.py -gooddata_api_client/model/json_api_color_palette_patch.py -gooddata_api_client/model/json_api_color_palette_patch_attributes.py -gooddata_api_client/model/json_api_color_palette_patch_document.py -gooddata_api_client/model/json_api_cookie_security_configuration_in.py -gooddata_api_client/model/json_api_cookie_security_configuration_in_attributes.py -gooddata_api_client/model/json_api_cookie_security_configuration_in_document.py -gooddata_api_client/model/json_api_cookie_security_configuration_out.py -gooddata_api_client/model/json_api_cookie_security_configuration_out_document.py -gooddata_api_client/model/json_api_cookie_security_configuration_patch.py -gooddata_api_client/model/json_api_cookie_security_configuration_patch_document.py -gooddata_api_client/model/json_api_csp_directive_in.py -gooddata_api_client/model/json_api_csp_directive_in_attributes.py -gooddata_api_client/model/json_api_csp_directive_in_document.py -gooddata_api_client/model/json_api_csp_directive_out.py -gooddata_api_client/model/json_api_csp_directive_out_document.py -gooddata_api_client/model/json_api_csp_directive_out_list.py -gooddata_api_client/model/json_api_csp_directive_out_with_links.py -gooddata_api_client/model/json_api_csp_directive_patch.py -gooddata_api_client/model/json_api_csp_directive_patch_attributes.py -gooddata_api_client/model/json_api_csp_directive_patch_document.py -gooddata_api_client/model/json_api_custom_application_setting_in.py -gooddata_api_client/model/json_api_custom_application_setting_in_attributes.py -gooddata_api_client/model/json_api_custom_application_setting_in_document.py -gooddata_api_client/model/json_api_custom_application_setting_out.py -gooddata_api_client/model/json_api_custom_application_setting_out_document.py -gooddata_api_client/model/json_api_custom_application_setting_out_list.py -gooddata_api_client/model/json_api_custom_application_setting_out_with_links.py -gooddata_api_client/model/json_api_custom_application_setting_patch.py -gooddata_api_client/model/json_api_custom_application_setting_patch_attributes.py -gooddata_api_client/model/json_api_custom_application_setting_patch_document.py -gooddata_api_client/model/json_api_custom_application_setting_post_optional_id.py -gooddata_api_client/model/json_api_custom_application_setting_post_optional_id_document.py -gooddata_api_client/model/json_api_dashboard_plugin_in.py -gooddata_api_client/model/json_api_dashboard_plugin_in_attributes.py -gooddata_api_client/model/json_api_dashboard_plugin_in_document.py -gooddata_api_client/model/json_api_dashboard_plugin_linkage.py -gooddata_api_client/model/json_api_dashboard_plugin_out.py -gooddata_api_client/model/json_api_dashboard_plugin_out_attributes.py -gooddata_api_client/model/json_api_dashboard_plugin_out_document.py -gooddata_api_client/model/json_api_dashboard_plugin_out_list.py -gooddata_api_client/model/json_api_dashboard_plugin_out_relationships.py -gooddata_api_client/model/json_api_dashboard_plugin_out_with_links.py -gooddata_api_client/model/json_api_dashboard_plugin_patch.py -gooddata_api_client/model/json_api_dashboard_plugin_patch_document.py -gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id.py -gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id_document.py -gooddata_api_client/model/json_api_dashboard_plugin_to_many_linkage.py -gooddata_api_client/model/json_api_data_source_identifier_out.py -gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py -gooddata_api_client/model/json_api_data_source_identifier_out_document.py -gooddata_api_client/model/json_api_data_source_identifier_out_list.py -gooddata_api_client/model/json_api_data_source_identifier_out_meta.py -gooddata_api_client/model/json_api_data_source_identifier_out_with_links.py -gooddata_api_client/model/json_api_data_source_in.py -gooddata_api_client/model/json_api_data_source_in_attributes.py -gooddata_api_client/model/json_api_data_source_in_attributes_parameters_inner.py -gooddata_api_client/model/json_api_data_source_in_document.py -gooddata_api_client/model/json_api_data_source_out.py -gooddata_api_client/model/json_api_data_source_out_attributes.py -gooddata_api_client/model/json_api_data_source_out_document.py -gooddata_api_client/model/json_api_data_source_out_list.py -gooddata_api_client/model/json_api_data_source_out_with_links.py -gooddata_api_client/model/json_api_data_source_patch.py -gooddata_api_client/model/json_api_data_source_patch_attributes.py -gooddata_api_client/model/json_api_data_source_patch_document.py -gooddata_api_client/model/json_api_dataset_linkage.py -gooddata_api_client/model/json_api_dataset_out.py -gooddata_api_client/model/json_api_dataset_out_attributes.py -gooddata_api_client/model/json_api_dataset_out_attributes_grain_inner.py -gooddata_api_client/model/json_api_dataset_out_attributes_reference_properties_inner.py -gooddata_api_client/model/json_api_dataset_out_attributes_sql.py -gooddata_api_client/model/json_api_dataset_out_attributes_workspace_data_filter_columns_inner.py -gooddata_api_client/model/json_api_dataset_out_attributes_workspace_data_filter_references_inner.py -gooddata_api_client/model/json_api_dataset_out_document.py -gooddata_api_client/model/json_api_dataset_out_includes.py -gooddata_api_client/model/json_api_dataset_out_list.py -gooddata_api_client/model/json_api_dataset_out_relationships.py -gooddata_api_client/model/json_api_dataset_out_relationships_aggregated_facts.py -gooddata_api_client/model/json_api_dataset_out_relationships_facts.py -gooddata_api_client/model/json_api_dataset_out_relationships_workspace_data_filters.py -gooddata_api_client/model/json_api_dataset_out_with_links.py -gooddata_api_client/model/json_api_dataset_to_many_linkage.py -gooddata_api_client/model/json_api_dataset_to_one_linkage.py -gooddata_api_client/model/json_api_entitlement_out.py -gooddata_api_client/model/json_api_entitlement_out_attributes.py -gooddata_api_client/model/json_api_entitlement_out_document.py -gooddata_api_client/model/json_api_entitlement_out_list.py -gooddata_api_client/model/json_api_entitlement_out_with_links.py -gooddata_api_client/model/json_api_export_definition_in.py -gooddata_api_client/model/json_api_export_definition_in_attributes.py -gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py -gooddata_api_client/model/json_api_export_definition_in_document.py -gooddata_api_client/model/json_api_export_definition_in_relationships.py -gooddata_api_client/model/json_api_export_definition_in_relationships_visualization_object.py -gooddata_api_client/model/json_api_export_definition_linkage.py -gooddata_api_client/model/json_api_export_definition_out.py -gooddata_api_client/model/json_api_export_definition_out_attributes.py -gooddata_api_client/model/json_api_export_definition_out_document.py -gooddata_api_client/model/json_api_export_definition_out_includes.py -gooddata_api_client/model/json_api_export_definition_out_list.py -gooddata_api_client/model/json_api_export_definition_out_relationships.py -gooddata_api_client/model/json_api_export_definition_out_with_links.py -gooddata_api_client/model/json_api_export_definition_patch.py -gooddata_api_client/model/json_api_export_definition_patch_document.py -gooddata_api_client/model/json_api_export_definition_post_optional_id.py -gooddata_api_client/model/json_api_export_definition_post_optional_id_document.py -gooddata_api_client/model/json_api_export_definition_to_many_linkage.py -gooddata_api_client/model/json_api_export_template_in.py -gooddata_api_client/model/json_api_export_template_in_attributes.py -gooddata_api_client/model/json_api_export_template_in_attributes_dashboard_slides_template.py -gooddata_api_client/model/json_api_export_template_in_attributes_widget_slides_template.py -gooddata_api_client/model/json_api_export_template_in_document.py -gooddata_api_client/model/json_api_export_template_out.py -gooddata_api_client/model/json_api_export_template_out_document.py -gooddata_api_client/model/json_api_export_template_out_list.py -gooddata_api_client/model/json_api_export_template_out_with_links.py -gooddata_api_client/model/json_api_export_template_patch.py -gooddata_api_client/model/json_api_export_template_patch_attributes.py -gooddata_api_client/model/json_api_export_template_patch_document.py -gooddata_api_client/model/json_api_export_template_post_optional_id.py -gooddata_api_client/model/json_api_export_template_post_optional_id_document.py -gooddata_api_client/model/json_api_fact_linkage.py -gooddata_api_client/model/json_api_fact_out.py -gooddata_api_client/model/json_api_fact_out_attributes.py -gooddata_api_client/model/json_api_fact_out_document.py -gooddata_api_client/model/json_api_fact_out_list.py -gooddata_api_client/model/json_api_fact_out_relationships.py -gooddata_api_client/model/json_api_fact_out_with_links.py -gooddata_api_client/model/json_api_fact_to_many_linkage.py -gooddata_api_client/model/json_api_fact_to_one_linkage.py -gooddata_api_client/model/json_api_filter_context_in.py -gooddata_api_client/model/json_api_filter_context_in_document.py -gooddata_api_client/model/json_api_filter_context_linkage.py -gooddata_api_client/model/json_api_filter_context_out.py -gooddata_api_client/model/json_api_filter_context_out_document.py -gooddata_api_client/model/json_api_filter_context_out_includes.py -gooddata_api_client/model/json_api_filter_context_out_list.py -gooddata_api_client/model/json_api_filter_context_out_relationships.py -gooddata_api_client/model/json_api_filter_context_out_with_links.py -gooddata_api_client/model/json_api_filter_context_patch.py -gooddata_api_client/model/json_api_filter_context_patch_document.py -gooddata_api_client/model/json_api_filter_context_post_optional_id.py -gooddata_api_client/model/json_api_filter_context_post_optional_id_document.py -gooddata_api_client/model/json_api_filter_context_to_many_linkage.py -gooddata_api_client/model/json_api_filter_view_in.py -gooddata_api_client/model/json_api_filter_view_in_attributes.py -gooddata_api_client/model/json_api_filter_view_in_document.py -gooddata_api_client/model/json_api_filter_view_in_relationships.py -gooddata_api_client/model/json_api_filter_view_in_relationships_user.py -gooddata_api_client/model/json_api_filter_view_out.py -gooddata_api_client/model/json_api_filter_view_out_document.py -gooddata_api_client/model/json_api_filter_view_out_includes.py -gooddata_api_client/model/json_api_filter_view_out_list.py -gooddata_api_client/model/json_api_filter_view_out_with_links.py -gooddata_api_client/model/json_api_filter_view_patch.py -gooddata_api_client/model/json_api_filter_view_patch_attributes.py -gooddata_api_client/model/json_api_filter_view_patch_document.py -gooddata_api_client/model/json_api_identity_provider_in.py -gooddata_api_client/model/json_api_identity_provider_in_attributes.py -gooddata_api_client/model/json_api_identity_provider_in_document.py -gooddata_api_client/model/json_api_identity_provider_linkage.py -gooddata_api_client/model/json_api_identity_provider_out.py -gooddata_api_client/model/json_api_identity_provider_out_attributes.py -gooddata_api_client/model/json_api_identity_provider_out_document.py -gooddata_api_client/model/json_api_identity_provider_out_list.py -gooddata_api_client/model/json_api_identity_provider_out_with_links.py -gooddata_api_client/model/json_api_identity_provider_patch.py -gooddata_api_client/model/json_api_identity_provider_patch_document.py -gooddata_api_client/model/json_api_identity_provider_to_one_linkage.py -gooddata_api_client/model/json_api_jwk_in.py -gooddata_api_client/model/json_api_jwk_in_attributes.py -gooddata_api_client/model/json_api_jwk_in_attributes_content.py -gooddata_api_client/model/json_api_jwk_in_document.py -gooddata_api_client/model/json_api_jwk_out.py -gooddata_api_client/model/json_api_jwk_out_document.py -gooddata_api_client/model/json_api_jwk_out_list.py -gooddata_api_client/model/json_api_jwk_out_with_links.py -gooddata_api_client/model/json_api_jwk_patch.py -gooddata_api_client/model/json_api_jwk_patch_document.py -gooddata_api_client/model/json_api_label_linkage.py -gooddata_api_client/model/json_api_label_out.py -gooddata_api_client/model/json_api_label_out_attributes.py -gooddata_api_client/model/json_api_label_out_document.py -gooddata_api_client/model/json_api_label_out_list.py -gooddata_api_client/model/json_api_label_out_relationships.py -gooddata_api_client/model/json_api_label_out_relationships_attribute.py -gooddata_api_client/model/json_api_label_out_with_links.py -gooddata_api_client/model/json_api_label_to_many_linkage.py -gooddata_api_client/model/json_api_label_to_one_linkage.py -gooddata_api_client/model/json_api_llm_endpoint_in.py -gooddata_api_client/model/json_api_llm_endpoint_in_attributes.py -gooddata_api_client/model/json_api_llm_endpoint_in_document.py -gooddata_api_client/model/json_api_llm_endpoint_out.py -gooddata_api_client/model/json_api_llm_endpoint_out_attributes.py -gooddata_api_client/model/json_api_llm_endpoint_out_document.py -gooddata_api_client/model/json_api_llm_endpoint_out_list.py -gooddata_api_client/model/json_api_llm_endpoint_out_with_links.py -gooddata_api_client/model/json_api_llm_endpoint_patch.py -gooddata_api_client/model/json_api_llm_endpoint_patch_attributes.py -gooddata_api_client/model/json_api_llm_endpoint_patch_document.py -gooddata_api_client/model/json_api_metric_in.py -gooddata_api_client/model/json_api_metric_in_attributes.py -gooddata_api_client/model/json_api_metric_in_attributes_content.py -gooddata_api_client/model/json_api_metric_in_document.py -gooddata_api_client/model/json_api_metric_linkage.py -gooddata_api_client/model/json_api_metric_out.py -gooddata_api_client/model/json_api_metric_out_attributes.py -gooddata_api_client/model/json_api_metric_out_document.py -gooddata_api_client/model/json_api_metric_out_includes.py -gooddata_api_client/model/json_api_metric_out_list.py -gooddata_api_client/model/json_api_metric_out_relationships.py -gooddata_api_client/model/json_api_metric_out_with_links.py -gooddata_api_client/model/json_api_metric_patch.py -gooddata_api_client/model/json_api_metric_patch_attributes.py -gooddata_api_client/model/json_api_metric_patch_document.py -gooddata_api_client/model/json_api_metric_post_optional_id.py -gooddata_api_client/model/json_api_metric_post_optional_id_document.py -gooddata_api_client/model/json_api_metric_to_many_linkage.py -gooddata_api_client/model/json_api_notification_channel_identifier_out.py -gooddata_api_client/model/json_api_notification_channel_identifier_out_attributes.py -gooddata_api_client/model/json_api_notification_channel_identifier_out_document.py -gooddata_api_client/model/json_api_notification_channel_identifier_out_list.py -gooddata_api_client/model/json_api_notification_channel_identifier_out_with_links.py -gooddata_api_client/model/json_api_notification_channel_in.py -gooddata_api_client/model/json_api_notification_channel_in_attributes.py -gooddata_api_client/model/json_api_notification_channel_in_attributes_destination.py -gooddata_api_client/model/json_api_notification_channel_in_document.py -gooddata_api_client/model/json_api_notification_channel_linkage.py -gooddata_api_client/model/json_api_notification_channel_out.py -gooddata_api_client/model/json_api_notification_channel_out_attributes.py -gooddata_api_client/model/json_api_notification_channel_out_document.py -gooddata_api_client/model/json_api_notification_channel_out_list.py -gooddata_api_client/model/json_api_notification_channel_out_with_links.py -gooddata_api_client/model/json_api_notification_channel_patch.py -gooddata_api_client/model/json_api_notification_channel_patch_document.py -gooddata_api_client/model/json_api_notification_channel_post_optional_id.py -gooddata_api_client/model/json_api_notification_channel_post_optional_id_document.py -gooddata_api_client/model/json_api_notification_channel_to_one_linkage.py -gooddata_api_client/model/json_api_organization_in.py -gooddata_api_client/model/json_api_organization_in_attributes.py -gooddata_api_client/model/json_api_organization_in_document.py -gooddata_api_client/model/json_api_organization_in_relationships.py -gooddata_api_client/model/json_api_organization_in_relationships_identity_provider.py -gooddata_api_client/model/json_api_organization_out.py -gooddata_api_client/model/json_api_organization_out_attributes.py -gooddata_api_client/model/json_api_organization_out_attributes_cache_settings.py -gooddata_api_client/model/json_api_organization_out_document.py -gooddata_api_client/model/json_api_organization_out_includes.py -gooddata_api_client/model/json_api_organization_out_meta.py -gooddata_api_client/model/json_api_organization_out_relationships.py -gooddata_api_client/model/json_api_organization_out_relationships_bootstrap_user_group.py -gooddata_api_client/model/json_api_organization_patch.py -gooddata_api_client/model/json_api_organization_patch_document.py -gooddata_api_client/model/json_api_organization_setting_in.py -gooddata_api_client/model/json_api_organization_setting_in_attributes.py -gooddata_api_client/model/json_api_organization_setting_in_document.py -gooddata_api_client/model/json_api_organization_setting_out.py -gooddata_api_client/model/json_api_organization_setting_out_document.py -gooddata_api_client/model/json_api_organization_setting_out_list.py -gooddata_api_client/model/json_api_organization_setting_out_with_links.py -gooddata_api_client/model/json_api_organization_setting_patch.py -gooddata_api_client/model/json_api_organization_setting_patch_document.py -gooddata_api_client/model/json_api_theme_in.py -gooddata_api_client/model/json_api_theme_in_document.py -gooddata_api_client/model/json_api_theme_out.py -gooddata_api_client/model/json_api_theme_out_document.py -gooddata_api_client/model/json_api_theme_out_list.py -gooddata_api_client/model/json_api_theme_out_with_links.py -gooddata_api_client/model/json_api_theme_patch.py -gooddata_api_client/model/json_api_theme_patch_document.py -gooddata_api_client/model/json_api_user_data_filter_in.py -gooddata_api_client/model/json_api_user_data_filter_in_attributes.py -gooddata_api_client/model/json_api_user_data_filter_in_document.py -gooddata_api_client/model/json_api_user_data_filter_in_relationships.py -gooddata_api_client/model/json_api_user_data_filter_out.py -gooddata_api_client/model/json_api_user_data_filter_out_document.py -gooddata_api_client/model/json_api_user_data_filter_out_includes.py -gooddata_api_client/model/json_api_user_data_filter_out_list.py -gooddata_api_client/model/json_api_user_data_filter_out_relationships.py -gooddata_api_client/model/json_api_user_data_filter_out_with_links.py -gooddata_api_client/model/json_api_user_data_filter_patch.py -gooddata_api_client/model/json_api_user_data_filter_patch_attributes.py -gooddata_api_client/model/json_api_user_data_filter_patch_document.py -gooddata_api_client/model/json_api_user_data_filter_post_optional_id.py -gooddata_api_client/model/json_api_user_data_filter_post_optional_id_document.py -gooddata_api_client/model/json_api_user_group_in.py -gooddata_api_client/model/json_api_user_group_in_attributes.py -gooddata_api_client/model/json_api_user_group_in_document.py -gooddata_api_client/model/json_api_user_group_in_relationships.py -gooddata_api_client/model/json_api_user_group_in_relationships_parents.py -gooddata_api_client/model/json_api_user_group_linkage.py -gooddata_api_client/model/json_api_user_group_out.py -gooddata_api_client/model/json_api_user_group_out_document.py -gooddata_api_client/model/json_api_user_group_out_list.py -gooddata_api_client/model/json_api_user_group_out_with_links.py -gooddata_api_client/model/json_api_user_group_patch.py -gooddata_api_client/model/json_api_user_group_patch_document.py -gooddata_api_client/model/json_api_user_group_to_many_linkage.py -gooddata_api_client/model/json_api_user_group_to_one_linkage.py -gooddata_api_client/model/json_api_user_identifier_linkage.py -gooddata_api_client/model/json_api_user_identifier_out.py -gooddata_api_client/model/json_api_user_identifier_out_attributes.py -gooddata_api_client/model/json_api_user_identifier_out_document.py -gooddata_api_client/model/json_api_user_identifier_out_list.py -gooddata_api_client/model/json_api_user_identifier_out_with_links.py -gooddata_api_client/model/json_api_user_identifier_to_one_linkage.py -gooddata_api_client/model/json_api_user_in.py -gooddata_api_client/model/json_api_user_in_attributes.py -gooddata_api_client/model/json_api_user_in_document.py -gooddata_api_client/model/json_api_user_in_relationships.py -gooddata_api_client/model/json_api_user_linkage.py -gooddata_api_client/model/json_api_user_out.py -gooddata_api_client/model/json_api_user_out_document.py -gooddata_api_client/model/json_api_user_out_list.py -gooddata_api_client/model/json_api_user_out_with_links.py -gooddata_api_client/model/json_api_user_patch.py -gooddata_api_client/model/json_api_user_patch_document.py -gooddata_api_client/model/json_api_user_setting_in.py -gooddata_api_client/model/json_api_user_setting_in_document.py -gooddata_api_client/model/json_api_user_setting_out.py -gooddata_api_client/model/json_api_user_setting_out_document.py -gooddata_api_client/model/json_api_user_setting_out_list.py -gooddata_api_client/model/json_api_user_setting_out_with_links.py -gooddata_api_client/model/json_api_user_to_many_linkage.py -gooddata_api_client/model/json_api_user_to_one_linkage.py -gooddata_api_client/model/json_api_visualization_object_in.py -gooddata_api_client/model/json_api_visualization_object_in_attributes.py -gooddata_api_client/model/json_api_visualization_object_in_document.py -gooddata_api_client/model/json_api_visualization_object_linkage.py -gooddata_api_client/model/json_api_visualization_object_out.py -gooddata_api_client/model/json_api_visualization_object_out_attributes.py -gooddata_api_client/model/json_api_visualization_object_out_document.py -gooddata_api_client/model/json_api_visualization_object_out_list.py -gooddata_api_client/model/json_api_visualization_object_out_with_links.py -gooddata_api_client/model/json_api_visualization_object_patch.py -gooddata_api_client/model/json_api_visualization_object_patch_attributes.py -gooddata_api_client/model/json_api_visualization_object_patch_document.py -gooddata_api_client/model/json_api_visualization_object_post_optional_id.py -gooddata_api_client/model/json_api_visualization_object_post_optional_id_document.py -gooddata_api_client/model/json_api_visualization_object_to_many_linkage.py -gooddata_api_client/model/json_api_visualization_object_to_one_linkage.py -gooddata_api_client/model/json_api_workspace_automation_out.py -gooddata_api_client/model/json_api_workspace_automation_out_includes.py -gooddata_api_client/model/json_api_workspace_automation_out_list.py -gooddata_api_client/model/json_api_workspace_automation_out_relationships.py -gooddata_api_client/model/json_api_workspace_automation_out_relationships_workspace.py -gooddata_api_client/model/json_api_workspace_automation_out_with_links.py -gooddata_api_client/model/json_api_workspace_data_filter_in.py -gooddata_api_client/model/json_api_workspace_data_filter_in_attributes.py -gooddata_api_client/model/json_api_workspace_data_filter_in_document.py -gooddata_api_client/model/json_api_workspace_data_filter_in_relationships.py -gooddata_api_client/model/json_api_workspace_data_filter_in_relationships_filter_settings.py -gooddata_api_client/model/json_api_workspace_data_filter_linkage.py -gooddata_api_client/model/json_api_workspace_data_filter_out.py -gooddata_api_client/model/json_api_workspace_data_filter_out_document.py -gooddata_api_client/model/json_api_workspace_data_filter_out_list.py -gooddata_api_client/model/json_api_workspace_data_filter_out_with_links.py -gooddata_api_client/model/json_api_workspace_data_filter_patch.py -gooddata_api_client/model/json_api_workspace_data_filter_patch_document.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_in.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_in_attributes.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_in_document.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_in_relationships.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_linkage.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_out.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_out_list.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_out_with_links.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_patch.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_patch_document.py -gooddata_api_client/model/json_api_workspace_data_filter_setting_to_many_linkage.py -gooddata_api_client/model/json_api_workspace_data_filter_to_many_linkage.py -gooddata_api_client/model/json_api_workspace_data_filter_to_one_linkage.py -gooddata_api_client/model/json_api_workspace_in.py -gooddata_api_client/model/json_api_workspace_in_attributes.py -gooddata_api_client/model/json_api_workspace_in_attributes_data_source.py -gooddata_api_client/model/json_api_workspace_in_document.py -gooddata_api_client/model/json_api_workspace_in_relationships.py -gooddata_api_client/model/json_api_workspace_linkage.py -gooddata_api_client/model/json_api_workspace_out.py -gooddata_api_client/model/json_api_workspace_out_document.py -gooddata_api_client/model/json_api_workspace_out_list.py -gooddata_api_client/model/json_api_workspace_out_meta.py -gooddata_api_client/model/json_api_workspace_out_meta_config.py -gooddata_api_client/model/json_api_workspace_out_meta_data_model.py -gooddata_api_client/model/json_api_workspace_out_meta_hierarchy.py -gooddata_api_client/model/json_api_workspace_out_with_links.py -gooddata_api_client/model/json_api_workspace_patch.py -gooddata_api_client/model/json_api_workspace_patch_document.py -gooddata_api_client/model/json_api_workspace_setting_in.py -gooddata_api_client/model/json_api_workspace_setting_in_document.py -gooddata_api_client/model/json_api_workspace_setting_out.py -gooddata_api_client/model/json_api_workspace_setting_out_document.py -gooddata_api_client/model/json_api_workspace_setting_out_list.py -gooddata_api_client/model/json_api_workspace_setting_out_with_links.py -gooddata_api_client/model/json_api_workspace_setting_patch.py -gooddata_api_client/model/json_api_workspace_setting_patch_document.py -gooddata_api_client/model/json_api_workspace_setting_post_optional_id.py -gooddata_api_client/model/json_api_workspace_setting_post_optional_id_document.py -gooddata_api_client/model/json_api_workspace_to_one_linkage.py -gooddata_api_client/model/json_node.py -gooddata_api_client/model/key_drivers_dimension.py -gooddata_api_client/model/key_drivers_request.py -gooddata_api_client/model/key_drivers_response.py -gooddata_api_client/model/key_drivers_result.py -gooddata_api_client/model/label_identifier.py -gooddata_api_client/model/list_links.py -gooddata_api_client/model/list_links_all_of.py -gooddata_api_client/model/local_identifier.py -gooddata_api_client/model/locale_request.py -gooddata_api_client/model/manage_dashboard_permissions_request_inner.py -gooddata_api_client/model/measure_definition.py -gooddata_api_client/model/measure_execution_result_header.py -gooddata_api_client/model/measure_group_headers.py -gooddata_api_client/model/measure_header.py -gooddata_api_client/model/measure_item.py -gooddata_api_client/model/measure_item_definition.py -gooddata_api_client/model/measure_result_header.py -gooddata_api_client/model/measure_value_filter.py -gooddata_api_client/model/memory_item.py -gooddata_api_client/model/memory_item_use_cases.py -gooddata_api_client/model/metric.py -gooddata_api_client/model/metric_record.py -gooddata_api_client/model/negative_attribute_filter.py -gooddata_api_client/model/negative_attribute_filter_negative_attribute_filter.py -gooddata_api_client/model/note.py -gooddata_api_client/model/notes.py -gooddata_api_client/model/notification.py -gooddata_api_client/model/notification_channel_destination.py -gooddata_api_client/model/notification_content.py -gooddata_api_client/model/notification_data.py -gooddata_api_client/model/notification_filter.py -gooddata_api_client/model/notifications.py -gooddata_api_client/model/notifications_meta.py -gooddata_api_client/model/notifications_meta_total.py -gooddata_api_client/model/object_links.py -gooddata_api_client/model/object_links_container.py -gooddata_api_client/model/organization_automation_identifier.py -gooddata_api_client/model/organization_automation_management_bulk_request.py -gooddata_api_client/model/organization_permission_assignment.py -gooddata_api_client/model/over.py -gooddata_api_client/model/page_metadata.py -gooddata_api_client/model/paging.py -gooddata_api_client/model/parameter.py -gooddata_api_client/model/pdf_table_style.py -gooddata_api_client/model/pdf_table_style_property.py -gooddata_api_client/model/pdm_ldm_request.py -gooddata_api_client/model/pdm_sql.py -gooddata_api_client/model/permissions_assignment.py -gooddata_api_client/model/permissions_for_assignee.py -gooddata_api_client/model/permissions_for_assignee_all_of.py -gooddata_api_client/model/permissions_for_assignee_rule.py -gooddata_api_client/model/platform_usage.py -gooddata_api_client/model/platform_usage_request.py -gooddata_api_client/model/pop_dataset.py -gooddata_api_client/model/pop_dataset_measure_definition.py -gooddata_api_client/model/pop_dataset_measure_definition_previous_period_measure.py -gooddata_api_client/model/pop_date.py -gooddata_api_client/model/pop_date_measure_definition.py -gooddata_api_client/model/pop_date_measure_definition_over_period_measure.py -gooddata_api_client/model/pop_measure_definition.py -gooddata_api_client/model/positive_attribute_filter.py -gooddata_api_client/model/positive_attribute_filter_positive_attribute_filter.py -gooddata_api_client/model/quality_issue.py -gooddata_api_client/model/quality_issue_object.py -gooddata_api_client/model/range.py -gooddata_api_client/model/range_measure_value_filter.py -gooddata_api_client/model/range_measure_value_filter_range_measure_value_filter.py -gooddata_api_client/model/range_wrapper.py -gooddata_api_client/model/ranking_filter.py -gooddata_api_client/model/ranking_filter_ranking_filter.py -gooddata_api_client/model/raw_custom_label.py -gooddata_api_client/model/raw_custom_metric.py -gooddata_api_client/model/raw_custom_override.py -gooddata_api_client/model/raw_export_automation_request.py -gooddata_api_client/model/raw_export_request.py -gooddata_api_client/model/reference_identifier.py -gooddata_api_client/model/reference_source_column.py -gooddata_api_client/model/relative.py -gooddata_api_client/model/relative_bounded_date_filter.py -gooddata_api_client/model/relative_date_filter.py -gooddata_api_client/model/relative_date_filter_relative_date_filter.py -gooddata_api_client/model/relative_wrapper.py -gooddata_api_client/model/resolve_settings_request.py -gooddata_api_client/model/resolved_llm_endpoint.py -gooddata_api_client/model/resolved_llm_endpoints.py -gooddata_api_client/model/resolved_setting.py -gooddata_api_client/model/rest_api_identifier.py -gooddata_api_client/model/result_cache_metadata.py -gooddata_api_client/model/result_dimension.py -gooddata_api_client/model/result_dimension_header.py -gooddata_api_client/model/result_spec.py -gooddata_api_client/model/route_result.py -gooddata_api_client/model/rsa_specification.py -gooddata_api_client/model/rule_permission.py -gooddata_api_client/model/running_section.py -gooddata_api_client/model/saved_visualization.py -gooddata_api_client/model/scan_request.py -gooddata_api_client/model/scan_result_pdm.py -gooddata_api_client/model/scan_sql_request.py -gooddata_api_client/model/scan_sql_response.py -gooddata_api_client/model/search_relationship_object.py -gooddata_api_client/model/search_request.py -gooddata_api_client/model/search_result.py -gooddata_api_client/model/search_result_object.py -gooddata_api_client/model/section_slide_template.py -gooddata_api_client/model/settings.py -gooddata_api_client/model/simple_measure_definition.py -gooddata_api_client/model/simple_measure_definition_measure.py -gooddata_api_client/model/skeleton.py -gooddata_api_client/model/slides_export_request.py -gooddata_api_client/model/smart_function_response.py -gooddata_api_client/model/smtp.py -gooddata_api_client/model/smtp_all_of.py -gooddata_api_client/model/sort_key.py -gooddata_api_client/model/sort_key_attribute.py -gooddata_api_client/model/sort_key_attribute_attribute.py -gooddata_api_client/model/sort_key_total.py -gooddata_api_client/model/sort_key_total_total.py -gooddata_api_client/model/sort_key_value.py -gooddata_api_client/model/sort_key_value_value.py -gooddata_api_client/model/sql_column.py -gooddata_api_client/model/sql_query.py -gooddata_api_client/model/sql_query_all_of.py -gooddata_api_client/model/suggestion.py -gooddata_api_client/model/switch_identity_provider_request.py -gooddata_api_client/model/table.py -gooddata_api_client/model/table_all_of.py -gooddata_api_client/model/table_override.py -gooddata_api_client/model/table_warning.py -gooddata_api_client/model/tabular_export_request.py -gooddata_api_client/model/test_definition_request.py -gooddata_api_client/model/test_destination_request.py -gooddata_api_client/model/test_notification.py -gooddata_api_client/model/test_notification_all_of.py -gooddata_api_client/model/test_query_duration.py -gooddata_api_client/model/test_request.py -gooddata_api_client/model/test_response.py -gooddata_api_client/model/total.py -gooddata_api_client/model/total_dimension.py -gooddata_api_client/model/total_execution_result_header.py -gooddata_api_client/model/total_result_header.py -gooddata_api_client/model/trigger_automation_request.py -gooddata_api_client/model/user_assignee.py -gooddata_api_client/model/user_context.py -gooddata_api_client/model/user_group_assignee.py -gooddata_api_client/model/user_group_identifier.py -gooddata_api_client/model/user_group_permission.py -gooddata_api_client/model/user_management_data_source_permission_assignment.py -gooddata_api_client/model/user_management_permission_assignments.py -gooddata_api_client/model/user_management_user_group_member.py -gooddata_api_client/model/user_management_user_group_members.py -gooddata_api_client/model/user_management_user_groups.py -gooddata_api_client/model/user_management_user_groups_item.py -gooddata_api_client/model/user_management_users.py -gooddata_api_client/model/user_management_users_item.py -gooddata_api_client/model/user_management_workspace_permission_assignment.py -gooddata_api_client/model/user_permission.py -gooddata_api_client/model/validate_by_item.py -gooddata_api_client/model/validate_llm_endpoint_by_id_request.py -gooddata_api_client/model/validate_llm_endpoint_request.py -gooddata_api_client/model/validate_llm_endpoint_response.py -gooddata_api_client/model/value.py -gooddata_api_client/model/visible_filter.py -gooddata_api_client/model/visual_export_request.py -gooddata_api_client/model/webhook.py -gooddata_api_client/model/webhook_all_of.py -gooddata_api_client/model/webhook_automation_info.py -gooddata_api_client/model/webhook_message.py -gooddata_api_client/model/webhook_message_data.py -gooddata_api_client/model/webhook_recipient.py -gooddata_api_client/model/widget_slides_template.py -gooddata_api_client/model/workspace_automation_identifier.py -gooddata_api_client/model/workspace_automation_management_bulk_request.py -gooddata_api_client/model/workspace_data_source.py -gooddata_api_client/model/workspace_identifier.py -gooddata_api_client/model/workspace_permission_assignment.py -gooddata_api_client/model/workspace_user.py -gooddata_api_client/model/workspace_user_group.py -gooddata_api_client/model/workspace_user_groups.py -gooddata_api_client/model/workspace_users.py -gooddata_api_client/model/xliff.py -gooddata_api_client/model_utils.py gooddata_api_client/models/__init__.py +gooddata_api_client/models/absolute_date_filter.py +gooddata_api_client/models/absolute_date_filter_absolute_date_filter.py +gooddata_api_client/models/abstract_measure_value_filter.py +gooddata_api_client/models/active_object_identification.py +gooddata_api_client/models/ad_hoc_automation.py +gooddata_api_client/models/afm.py +gooddata_api_client/models/afm_cancel_tokens.py +gooddata_api_client/models/afm_execution.py +gooddata_api_client/models/afm_execution_response.py +gooddata_api_client/models/afm_filters_inner.py +gooddata_api_client/models/afm_identifier.py +gooddata_api_client/models/afm_local_identifier.py +gooddata_api_client/models/afm_object_identifier.py +gooddata_api_client/models/afm_object_identifier_attribute.py +gooddata_api_client/models/afm_object_identifier_attribute_identifier.py +gooddata_api_client/models/afm_object_identifier_core.py +gooddata_api_client/models/afm_object_identifier_core_identifier.py +gooddata_api_client/models/afm_object_identifier_dataset.py +gooddata_api_client/models/afm_object_identifier_dataset_identifier.py +gooddata_api_client/models/afm_object_identifier_identifier.py +gooddata_api_client/models/afm_object_identifier_label.py +gooddata_api_client/models/afm_object_identifier_label_identifier.py +gooddata_api_client/models/afm_valid_descendants_query.py +gooddata_api_client/models/afm_valid_descendants_response.py +gooddata_api_client/models/afm_valid_objects_query.py +gooddata_api_client/models/afm_valid_objects_response.py +gooddata_api_client/models/alert_afm.py +gooddata_api_client/models/alert_condition.py +gooddata_api_client/models/alert_condition_operand.py +gooddata_api_client/models/alert_description.py +gooddata_api_client/models/alert_evaluation_row.py +gooddata_api_client/models/analytics_catalog_tags.py +gooddata_api_client/models/anomaly_detection_request.py +gooddata_api_client/models/anomaly_detection_result.py +gooddata_api_client/models/api_entitlement.py +gooddata_api_client/models/arithmetic_measure.py +gooddata_api_client/models/arithmetic_measure_definition.py +gooddata_api_client/models/arithmetic_measure_definition_arithmetic_measure.py +gooddata_api_client/models/assignee_identifier.py +gooddata_api_client/models/assignee_rule.py +gooddata_api_client/models/attribute_elements.py +gooddata_api_client/models/attribute_elements_by_ref.py +gooddata_api_client/models/attribute_elements_by_value.py +gooddata_api_client/models/attribute_execution_result_header.py +gooddata_api_client/models/attribute_filter.py +gooddata_api_client/models/attribute_filter_by_date.py +gooddata_api_client/models/attribute_filter_elements.py +gooddata_api_client/models/attribute_filter_parent.py +gooddata_api_client/models/attribute_format.py +gooddata_api_client/models/attribute_header.py +gooddata_api_client/models/attribute_header_attribute_header.py +gooddata_api_client/models/attribute_item.py +gooddata_api_client/models/attribute_negative_filter.py +gooddata_api_client/models/attribute_positive_filter.py +gooddata_api_client/models/attribute_result_header.py +gooddata_api_client/models/automation_alert.py +gooddata_api_client/models/automation_alert_condition.py +gooddata_api_client/models/automation_dashboard_tabular_export.py +gooddata_api_client/models/automation_external_recipient.py +gooddata_api_client/models/automation_image_export.py +gooddata_api_client/models/automation_metadata.py +gooddata_api_client/models/automation_notification.py +gooddata_api_client/models/automation_raw_export.py +gooddata_api_client/models/automation_schedule.py +gooddata_api_client/models/automation_slides_export.py +gooddata_api_client/models/automation_tabular_export.py +gooddata_api_client/models/automation_visual_export.py +gooddata_api_client/models/available_assignees.py +gooddata_api_client/models/bounded_filter.py +gooddata_api_client/models/chat_history_interaction.py +gooddata_api_client/models/chat_history_request.py +gooddata_api_client/models/chat_history_result.py +gooddata_api_client/models/chat_request.py +gooddata_api_client/models/chat_result.py +gooddata_api_client/models/chat_usage_response.py +gooddata_api_client/models/clustering_request.py +gooddata_api_client/models/clustering_result.py +gooddata_api_client/models/column_override.py +gooddata_api_client/models/column_statistic.py +gooddata_api_client/models/column_statistic_warning.py +gooddata_api_client/models/column_statistics_request.py +gooddata_api_client/models/column_statistics_request_from.py +gooddata_api_client/models/column_statistics_response.py +gooddata_api_client/models/column_warning.py +gooddata_api_client/models/comparison.py +gooddata_api_client/models/comparison_measure_value_filter.py +gooddata_api_client/models/comparison_measure_value_filter_comparison_measure_value_filter.py +gooddata_api_client/models/comparison_wrapper.py +gooddata_api_client/models/content_slide_template.py +gooddata_api_client/models/cover_slide_template.py +gooddata_api_client/models/created_visualization.py +gooddata_api_client/models/created_visualization_filters_inner.py +gooddata_api_client/models/created_visualizations.py +gooddata_api_client/models/custom_label.py +gooddata_api_client/models/custom_metric.py +gooddata_api_client/models/custom_override.py +gooddata_api_client/models/dashboard_attribute_filter.py +gooddata_api_client/models/dashboard_attribute_filter_attribute_filter.py +gooddata_api_client/models/dashboard_date_filter.py +gooddata_api_client/models/dashboard_date_filter_date_filter.py +gooddata_api_client/models/dashboard_date_filter_date_filter_from.py +gooddata_api_client/models/dashboard_export_settings.py +gooddata_api_client/models/dashboard_filter.py +gooddata_api_client/models/dashboard_permissions.py +gooddata_api_client/models/dashboard_permissions_assignment.py +gooddata_api_client/models/dashboard_slides_template.py +gooddata_api_client/models/dashboard_tabular_export_request.py +gooddata_api_client/models/dashboard_tabular_export_request_v2.py +gooddata_api_client/models/data_column_locator.py +gooddata_api_client/models/data_column_locators.py +gooddata_api_client/models/data_source_parameter.py +gooddata_api_client/models/data_source_permission_assignment.py +gooddata_api_client/models/data_source_schemata.py +gooddata_api_client/models/data_source_table_identifier.py +gooddata_api_client/models/dataset_grain.py +gooddata_api_client/models/dataset_reference_identifier.py +gooddata_api_client/models/dataset_workspace_data_filter_identifier.py +gooddata_api_client/models/date_absolute_filter.py +gooddata_api_client/models/date_filter.py +gooddata_api_client/models/date_relative_filter.py +gooddata_api_client/models/date_value.py +gooddata_api_client/models/declarative_aggregated_fact.py +gooddata_api_client/models/declarative_analytical_dashboard.py +gooddata_api_client/models/declarative_analytical_dashboard_extension.py +gooddata_api_client/models/declarative_analytical_dashboard_identifier.py +gooddata_api_client/models/declarative_analytical_dashboard_permission_assignment.py +gooddata_api_client/models/declarative_analytical_dashboard_permission_for_assignee.py +gooddata_api_client/models/declarative_analytical_dashboard_permission_for_assignee_rule.py +gooddata_api_client/models/declarative_analytical_dashboard_permissions_inner.py +gooddata_api_client/models/declarative_analytics.py +gooddata_api_client/models/declarative_analytics_layer.py +gooddata_api_client/models/declarative_attribute.py +gooddata_api_client/models/declarative_attribute_hierarchy.py +gooddata_api_client/models/declarative_automation.py +gooddata_api_client/models/declarative_color_palette.py +gooddata_api_client/models/declarative_column.py +gooddata_api_client/models/declarative_csp_directive.py +gooddata_api_client/models/declarative_custom_application_setting.py +gooddata_api_client/models/declarative_dashboard_plugin.py +gooddata_api_client/models/declarative_data_source.py +gooddata_api_client/models/declarative_data_source_permission.py +gooddata_api_client/models/declarative_data_source_permissions.py +gooddata_api_client/models/declarative_data_sources.py +gooddata_api_client/models/declarative_dataset.py +gooddata_api_client/models/declarative_dataset_extension.py +gooddata_api_client/models/declarative_dataset_sql.py +gooddata_api_client/models/declarative_date_dataset.py +gooddata_api_client/models/declarative_export_definition.py +gooddata_api_client/models/declarative_export_definition_identifier.py +gooddata_api_client/models/declarative_export_definition_request_payload.py +gooddata_api_client/models/declarative_export_template.py +gooddata_api_client/models/declarative_export_templates.py +gooddata_api_client/models/declarative_fact.py +gooddata_api_client/models/declarative_filter_context.py +gooddata_api_client/models/declarative_filter_view.py +gooddata_api_client/models/declarative_identity_provider.py +gooddata_api_client/models/declarative_identity_provider_identifier.py +gooddata_api_client/models/declarative_jwk.py +gooddata_api_client/models/declarative_jwk_specification.py +gooddata_api_client/models/declarative_label.py +gooddata_api_client/models/declarative_ldm.py +gooddata_api_client/models/declarative_metric.py +gooddata_api_client/models/declarative_model.py +gooddata_api_client/models/declarative_notification_channel.py +gooddata_api_client/models/declarative_notification_channel_destination.py +gooddata_api_client/models/declarative_notification_channel_identifier.py +gooddata_api_client/models/declarative_notification_channels.py +gooddata_api_client/models/declarative_organization.py +gooddata_api_client/models/declarative_organization_info.py +gooddata_api_client/models/declarative_organization_permission.py +gooddata_api_client/models/declarative_reference.py +gooddata_api_client/models/declarative_reference_source.py +gooddata_api_client/models/declarative_rsa_specification.py +gooddata_api_client/models/declarative_setting.py +gooddata_api_client/models/declarative_single_workspace_permission.py +gooddata_api_client/models/declarative_source_fact_reference.py +gooddata_api_client/models/declarative_table.py +gooddata_api_client/models/declarative_tables.py +gooddata_api_client/models/declarative_theme.py +gooddata_api_client/models/declarative_user.py +gooddata_api_client/models/declarative_user_data_filter.py +gooddata_api_client/models/declarative_user_data_filters.py +gooddata_api_client/models/declarative_user_group.py +gooddata_api_client/models/declarative_user_group_identifier.py +gooddata_api_client/models/declarative_user_group_permission.py +gooddata_api_client/models/declarative_user_group_permissions.py +gooddata_api_client/models/declarative_user_groups.py +gooddata_api_client/models/declarative_user_identifier.py +gooddata_api_client/models/declarative_user_permission.py +gooddata_api_client/models/declarative_user_permissions.py +gooddata_api_client/models/declarative_users.py +gooddata_api_client/models/declarative_users_user_groups.py +gooddata_api_client/models/declarative_visualization_object.py +gooddata_api_client/models/declarative_workspace.py +gooddata_api_client/models/declarative_workspace_data_filter.py +gooddata_api_client/models/declarative_workspace_data_filter_column.py +gooddata_api_client/models/declarative_workspace_data_filter_references.py +gooddata_api_client/models/declarative_workspace_data_filter_setting.py +gooddata_api_client/models/declarative_workspace_data_filters.py +gooddata_api_client/models/declarative_workspace_hierarchy_permission.py +gooddata_api_client/models/declarative_workspace_model.py +gooddata_api_client/models/declarative_workspace_permissions.py +gooddata_api_client/models/declarative_workspaces.py +gooddata_api_client/models/default_smtp.py +gooddata_api_client/models/dependent_entities_graph.py +gooddata_api_client/models/dependent_entities_node.py +gooddata_api_client/models/dependent_entities_request.py +gooddata_api_client/models/dependent_entities_response.py +gooddata_api_client/models/depends_on.py +gooddata_api_client/models/depends_on_date_filter.py +gooddata_api_client/models/dim_attribute.py +gooddata_api_client/models/dimension.py +gooddata_api_client/models/dimension_header.py +gooddata_api_client/models/element.py +gooddata_api_client/models/elements_request.py +gooddata_api_client/models/elements_request_depends_on_inner.py +gooddata_api_client/models/elements_response.py +gooddata_api_client/models/entitlements_request.py +gooddata_api_client/models/entity_identifier.py +gooddata_api_client/models/execution_links.py +gooddata_api_client/models/execution_response.py +gooddata_api_client/models/execution_result.py +gooddata_api_client/models/execution_result_data_source_message.py +gooddata_api_client/models/execution_result_grand_total.py +gooddata_api_client/models/execution_result_header.py +gooddata_api_client/models/execution_result_metadata.py +gooddata_api_client/models/execution_result_paging.py +gooddata_api_client/models/execution_settings.py +gooddata_api_client/models/export_request.py +gooddata_api_client/models/export_response.py +gooddata_api_client/models/export_result.py +gooddata_api_client/models/fact_identifier.py +gooddata_api_client/models/file.py +gooddata_api_client/models/filter_by.py +gooddata_api_client/models/filter_definition.py +gooddata_api_client/models/filter_definition_for_simple_measure.py +gooddata_api_client/models/forecast_request.py +gooddata_api_client/models/forecast_result.py +gooddata_api_client/models/found_objects.py +gooddata_api_client/models/frequency.py +gooddata_api_client/models/frequency_bucket.py +gooddata_api_client/models/frequency_properties.py +gooddata_api_client/models/generate_ldm_request.py +gooddata_api_client/models/get_image_export202_response_inner.py +gooddata_api_client/models/get_quality_issues_response.py +gooddata_api_client/models/grain_identifier.py +gooddata_api_client/models/granted_permission.py +gooddata_api_client/models/granularities_formatting.py +gooddata_api_client/models/header_group.py +gooddata_api_client/models/hierarchy_object_identification.py +gooddata_api_client/models/histogram.py +gooddata_api_client/models/histogram_bucket.py +gooddata_api_client/models/histogram_properties.py +gooddata_api_client/models/identifier_duplications.py +gooddata_api_client/models/identifier_ref.py +gooddata_api_client/models/identifier_ref_identifier.py +gooddata_api_client/models/image_export_request.py +gooddata_api_client/models/in_platform.py +gooddata_api_client/models/inline_filter_definition.py +gooddata_api_client/models/inline_filter_definition_inline.py +gooddata_api_client/models/inline_measure_definition.py +gooddata_api_client/models/inline_measure_definition_inline.py +gooddata_api_client/models/intro_slide_template.py +gooddata_api_client/models/json_api_aggregated_fact_linkage.py +gooddata_api_client/models/json_api_aggregated_fact_out.py +gooddata_api_client/models/json_api_aggregated_fact_out_attributes.py +gooddata_api_client/models/json_api_aggregated_fact_out_document.py +gooddata_api_client/models/json_api_aggregated_fact_out_includes.py +gooddata_api_client/models/json_api_aggregated_fact_out_list.py +gooddata_api_client/models/json_api_aggregated_fact_out_list_meta.py +gooddata_api_client/models/json_api_aggregated_fact_out_meta.py +gooddata_api_client/models/json_api_aggregated_fact_out_meta_origin.py +gooddata_api_client/models/json_api_aggregated_fact_out_relationships.py +gooddata_api_client/models/json_api_aggregated_fact_out_relationships_dataset.py +gooddata_api_client/models/json_api_aggregated_fact_out_relationships_source_fact.py +gooddata_api_client/models/json_api_aggregated_fact_out_with_links.py +gooddata_api_client/models/json_api_analytical_dashboard_in.py +gooddata_api_client/models/json_api_analytical_dashboard_in_attributes.py +gooddata_api_client/models/json_api_analytical_dashboard_in_document.py +gooddata_api_client/models/json_api_analytical_dashboard_linkage.py +gooddata_api_client/models/json_api_analytical_dashboard_out.py +gooddata_api_client/models/json_api_analytical_dashboard_out_attributes.py +gooddata_api_client/models/json_api_analytical_dashboard_out_document.py +gooddata_api_client/models/json_api_analytical_dashboard_out_includes.py +gooddata_api_client/models/json_api_analytical_dashboard_out_list.py +gooddata_api_client/models/json_api_analytical_dashboard_out_meta.py +gooddata_api_client/models/json_api_analytical_dashboard_out_meta_access_info.py +gooddata_api_client/models/json_api_analytical_dashboard_out_relationships.py +gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_analytical_dashboards.py +gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_created_by.py +gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_dashboard_plugins.py +gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_datasets.py +gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_filter_contexts.py +gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_labels.py +gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_metrics.py +gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_visualization_objects.py +gooddata_api_client/models/json_api_analytical_dashboard_out_with_links.py +gooddata_api_client/models/json_api_analytical_dashboard_patch.py +gooddata_api_client/models/json_api_analytical_dashboard_patch_attributes.py +gooddata_api_client/models/json_api_analytical_dashboard_patch_document.py +gooddata_api_client/models/json_api_analytical_dashboard_post_optional_id.py +gooddata_api_client/models/json_api_analytical_dashboard_post_optional_id_document.py +gooddata_api_client/models/json_api_analytical_dashboard_to_one_linkage.py +gooddata_api_client/models/json_api_api_token_in.py +gooddata_api_client/models/json_api_api_token_in_document.py +gooddata_api_client/models/json_api_api_token_out.py +gooddata_api_client/models/json_api_api_token_out_attributes.py +gooddata_api_client/models/json_api_api_token_out_document.py +gooddata_api_client/models/json_api_api_token_out_list.py +gooddata_api_client/models/json_api_api_token_out_with_links.py +gooddata_api_client/models/json_api_attribute_hierarchy_in.py +gooddata_api_client/models/json_api_attribute_hierarchy_in_attributes.py +gooddata_api_client/models/json_api_attribute_hierarchy_in_document.py +gooddata_api_client/models/json_api_attribute_hierarchy_linkage.py +gooddata_api_client/models/json_api_attribute_hierarchy_out.py +gooddata_api_client/models/json_api_attribute_hierarchy_out_attributes.py +gooddata_api_client/models/json_api_attribute_hierarchy_out_document.py +gooddata_api_client/models/json_api_attribute_hierarchy_out_includes.py +gooddata_api_client/models/json_api_attribute_hierarchy_out_list.py +gooddata_api_client/models/json_api_attribute_hierarchy_out_relationships.py +gooddata_api_client/models/json_api_attribute_hierarchy_out_relationships_attributes.py +gooddata_api_client/models/json_api_attribute_hierarchy_out_with_links.py +gooddata_api_client/models/json_api_attribute_hierarchy_patch.py +gooddata_api_client/models/json_api_attribute_hierarchy_patch_document.py +gooddata_api_client/models/json_api_attribute_linkage.py +gooddata_api_client/models/json_api_attribute_out.py +gooddata_api_client/models/json_api_attribute_out_attributes.py +gooddata_api_client/models/json_api_attribute_out_document.py +gooddata_api_client/models/json_api_attribute_out_includes.py +gooddata_api_client/models/json_api_attribute_out_list.py +gooddata_api_client/models/json_api_attribute_out_relationships.py +gooddata_api_client/models/json_api_attribute_out_relationships_attribute_hierarchies.py +gooddata_api_client/models/json_api_attribute_out_relationships_default_view.py +gooddata_api_client/models/json_api_attribute_out_with_links.py +gooddata_api_client/models/json_api_attribute_to_one_linkage.py +gooddata_api_client/models/json_api_automation_in.py +gooddata_api_client/models/json_api_automation_in_attributes.py +gooddata_api_client/models/json_api_automation_in_attributes_alert.py +gooddata_api_client/models/json_api_automation_in_attributes_dashboard_tabular_exports_inner.py +gooddata_api_client/models/json_api_automation_in_attributes_external_recipients_inner.py +gooddata_api_client/models/json_api_automation_in_attributes_image_exports_inner.py +gooddata_api_client/models/json_api_automation_in_attributes_metadata.py +gooddata_api_client/models/json_api_automation_in_attributes_raw_exports_inner.py +gooddata_api_client/models/json_api_automation_in_attributes_schedule.py +gooddata_api_client/models/json_api_automation_in_attributes_slides_exports_inner.py +gooddata_api_client/models/json_api_automation_in_attributes_tabular_exports_inner.py +gooddata_api_client/models/json_api_automation_in_attributes_visual_exports_inner.py +gooddata_api_client/models/json_api_automation_in_document.py +gooddata_api_client/models/json_api_automation_in_relationships.py +gooddata_api_client/models/json_api_automation_in_relationships_analytical_dashboard.py +gooddata_api_client/models/json_api_automation_in_relationships_export_definitions.py +gooddata_api_client/models/json_api_automation_in_relationships_notification_channel.py +gooddata_api_client/models/json_api_automation_in_relationships_recipients.py +gooddata_api_client/models/json_api_automation_linkage.py +gooddata_api_client/models/json_api_automation_out.py +gooddata_api_client/models/json_api_automation_out_attributes.py +gooddata_api_client/models/json_api_automation_out_document.py +gooddata_api_client/models/json_api_automation_out_includes.py +gooddata_api_client/models/json_api_automation_out_list.py +gooddata_api_client/models/json_api_automation_out_relationships.py +gooddata_api_client/models/json_api_automation_out_relationships_automation_results.py +gooddata_api_client/models/json_api_automation_out_with_links.py +gooddata_api_client/models/json_api_automation_patch.py +gooddata_api_client/models/json_api_automation_patch_document.py +gooddata_api_client/models/json_api_automation_result_linkage.py +gooddata_api_client/models/json_api_automation_result_out.py +gooddata_api_client/models/json_api_automation_result_out_attributes.py +gooddata_api_client/models/json_api_automation_result_out_relationships.py +gooddata_api_client/models/json_api_automation_result_out_relationships_automation.py +gooddata_api_client/models/json_api_automation_result_out_with_links.py +gooddata_api_client/models/json_api_automation_to_one_linkage.py +gooddata_api_client/models/json_api_color_palette_in.py +gooddata_api_client/models/json_api_color_palette_in_attributes.py +gooddata_api_client/models/json_api_color_palette_in_document.py +gooddata_api_client/models/json_api_color_palette_out.py +gooddata_api_client/models/json_api_color_palette_out_document.py +gooddata_api_client/models/json_api_color_palette_out_list.py +gooddata_api_client/models/json_api_color_palette_out_with_links.py +gooddata_api_client/models/json_api_color_palette_patch.py +gooddata_api_client/models/json_api_color_palette_patch_attributes.py +gooddata_api_client/models/json_api_color_palette_patch_document.py +gooddata_api_client/models/json_api_cookie_security_configuration_in.py +gooddata_api_client/models/json_api_cookie_security_configuration_in_attributes.py +gooddata_api_client/models/json_api_cookie_security_configuration_in_document.py +gooddata_api_client/models/json_api_cookie_security_configuration_out.py +gooddata_api_client/models/json_api_cookie_security_configuration_out_document.py +gooddata_api_client/models/json_api_cookie_security_configuration_patch.py +gooddata_api_client/models/json_api_cookie_security_configuration_patch_document.py +gooddata_api_client/models/json_api_csp_directive_in.py +gooddata_api_client/models/json_api_csp_directive_in_attributes.py +gooddata_api_client/models/json_api_csp_directive_in_document.py +gooddata_api_client/models/json_api_csp_directive_out.py +gooddata_api_client/models/json_api_csp_directive_out_document.py +gooddata_api_client/models/json_api_csp_directive_out_list.py +gooddata_api_client/models/json_api_csp_directive_out_with_links.py +gooddata_api_client/models/json_api_csp_directive_patch.py +gooddata_api_client/models/json_api_csp_directive_patch_attributes.py +gooddata_api_client/models/json_api_csp_directive_patch_document.py +gooddata_api_client/models/json_api_custom_application_setting_in.py +gooddata_api_client/models/json_api_custom_application_setting_in_attributes.py +gooddata_api_client/models/json_api_custom_application_setting_in_document.py +gooddata_api_client/models/json_api_custom_application_setting_out.py +gooddata_api_client/models/json_api_custom_application_setting_out_document.py +gooddata_api_client/models/json_api_custom_application_setting_out_list.py +gooddata_api_client/models/json_api_custom_application_setting_out_with_links.py +gooddata_api_client/models/json_api_custom_application_setting_patch.py +gooddata_api_client/models/json_api_custom_application_setting_patch_attributes.py +gooddata_api_client/models/json_api_custom_application_setting_patch_document.py +gooddata_api_client/models/json_api_custom_application_setting_post_optional_id.py +gooddata_api_client/models/json_api_custom_application_setting_post_optional_id_document.py +gooddata_api_client/models/json_api_dashboard_plugin_in.py +gooddata_api_client/models/json_api_dashboard_plugin_in_attributes.py +gooddata_api_client/models/json_api_dashboard_plugin_in_document.py +gooddata_api_client/models/json_api_dashboard_plugin_linkage.py +gooddata_api_client/models/json_api_dashboard_plugin_out.py +gooddata_api_client/models/json_api_dashboard_plugin_out_attributes.py +gooddata_api_client/models/json_api_dashboard_plugin_out_document.py +gooddata_api_client/models/json_api_dashboard_plugin_out_list.py +gooddata_api_client/models/json_api_dashboard_plugin_out_relationships.py +gooddata_api_client/models/json_api_dashboard_plugin_out_with_links.py +gooddata_api_client/models/json_api_dashboard_plugin_patch.py +gooddata_api_client/models/json_api_dashboard_plugin_patch_document.py +gooddata_api_client/models/json_api_dashboard_plugin_post_optional_id.py +gooddata_api_client/models/json_api_dashboard_plugin_post_optional_id_document.py +gooddata_api_client/models/json_api_data_source_identifier_out.py +gooddata_api_client/models/json_api_data_source_identifier_out_attributes.py +gooddata_api_client/models/json_api_data_source_identifier_out_document.py +gooddata_api_client/models/json_api_data_source_identifier_out_list.py +gooddata_api_client/models/json_api_data_source_identifier_out_meta.py +gooddata_api_client/models/json_api_data_source_identifier_out_with_links.py +gooddata_api_client/models/json_api_data_source_in.py +gooddata_api_client/models/json_api_data_source_in_attributes.py +gooddata_api_client/models/json_api_data_source_in_attributes_parameters_inner.py +gooddata_api_client/models/json_api_data_source_in_document.py +gooddata_api_client/models/json_api_data_source_out.py +gooddata_api_client/models/json_api_data_source_out_attributes.py +gooddata_api_client/models/json_api_data_source_out_document.py +gooddata_api_client/models/json_api_data_source_out_list.py +gooddata_api_client/models/json_api_data_source_out_with_links.py +gooddata_api_client/models/json_api_data_source_patch.py +gooddata_api_client/models/json_api_data_source_patch_attributes.py +gooddata_api_client/models/json_api_data_source_patch_document.py +gooddata_api_client/models/json_api_dataset_linkage.py +gooddata_api_client/models/json_api_dataset_out.py +gooddata_api_client/models/json_api_dataset_out_attributes.py +gooddata_api_client/models/json_api_dataset_out_attributes_grain_inner.py +gooddata_api_client/models/json_api_dataset_out_attributes_reference_properties_inner.py +gooddata_api_client/models/json_api_dataset_out_attributes_sql.py +gooddata_api_client/models/json_api_dataset_out_attributes_workspace_data_filter_columns_inner.py +gooddata_api_client/models/json_api_dataset_out_attributes_workspace_data_filter_references_inner.py +gooddata_api_client/models/json_api_dataset_out_document.py +gooddata_api_client/models/json_api_dataset_out_includes.py +gooddata_api_client/models/json_api_dataset_out_list.py +gooddata_api_client/models/json_api_dataset_out_relationships.py +gooddata_api_client/models/json_api_dataset_out_relationships_aggregated_facts.py +gooddata_api_client/models/json_api_dataset_out_relationships_facts.py +gooddata_api_client/models/json_api_dataset_out_relationships_workspace_data_filters.py +gooddata_api_client/models/json_api_dataset_out_with_links.py +gooddata_api_client/models/json_api_dataset_to_one_linkage.py +gooddata_api_client/models/json_api_entitlement_out.py +gooddata_api_client/models/json_api_entitlement_out_attributes.py +gooddata_api_client/models/json_api_entitlement_out_document.py +gooddata_api_client/models/json_api_entitlement_out_list.py +gooddata_api_client/models/json_api_entitlement_out_with_links.py +gooddata_api_client/models/json_api_export_definition_in.py +gooddata_api_client/models/json_api_export_definition_in_attributes.py +gooddata_api_client/models/json_api_export_definition_in_attributes_request_payload.py +gooddata_api_client/models/json_api_export_definition_in_document.py +gooddata_api_client/models/json_api_export_definition_in_relationships.py +gooddata_api_client/models/json_api_export_definition_in_relationships_visualization_object.py +gooddata_api_client/models/json_api_export_definition_linkage.py +gooddata_api_client/models/json_api_export_definition_out.py +gooddata_api_client/models/json_api_export_definition_out_attributes.py +gooddata_api_client/models/json_api_export_definition_out_document.py +gooddata_api_client/models/json_api_export_definition_out_includes.py +gooddata_api_client/models/json_api_export_definition_out_list.py +gooddata_api_client/models/json_api_export_definition_out_relationships.py +gooddata_api_client/models/json_api_export_definition_out_with_links.py +gooddata_api_client/models/json_api_export_definition_patch.py +gooddata_api_client/models/json_api_export_definition_patch_document.py +gooddata_api_client/models/json_api_export_definition_post_optional_id.py +gooddata_api_client/models/json_api_export_definition_post_optional_id_document.py +gooddata_api_client/models/json_api_export_template_in.py +gooddata_api_client/models/json_api_export_template_in_attributes.py +gooddata_api_client/models/json_api_export_template_in_attributes_dashboard_slides_template.py +gooddata_api_client/models/json_api_export_template_in_attributes_widget_slides_template.py +gooddata_api_client/models/json_api_export_template_in_document.py +gooddata_api_client/models/json_api_export_template_out.py +gooddata_api_client/models/json_api_export_template_out_document.py +gooddata_api_client/models/json_api_export_template_out_list.py +gooddata_api_client/models/json_api_export_template_out_with_links.py +gooddata_api_client/models/json_api_export_template_patch.py +gooddata_api_client/models/json_api_export_template_patch_attributes.py +gooddata_api_client/models/json_api_export_template_patch_document.py +gooddata_api_client/models/json_api_export_template_post_optional_id.py +gooddata_api_client/models/json_api_export_template_post_optional_id_document.py +gooddata_api_client/models/json_api_fact_linkage.py +gooddata_api_client/models/json_api_fact_out.py +gooddata_api_client/models/json_api_fact_out_attributes.py +gooddata_api_client/models/json_api_fact_out_document.py +gooddata_api_client/models/json_api_fact_out_list.py +gooddata_api_client/models/json_api_fact_out_relationships.py +gooddata_api_client/models/json_api_fact_out_with_links.py +gooddata_api_client/models/json_api_fact_to_one_linkage.py +gooddata_api_client/models/json_api_filter_context_in.py +gooddata_api_client/models/json_api_filter_context_in_document.py +gooddata_api_client/models/json_api_filter_context_linkage.py +gooddata_api_client/models/json_api_filter_context_out.py +gooddata_api_client/models/json_api_filter_context_out_document.py +gooddata_api_client/models/json_api_filter_context_out_includes.py +gooddata_api_client/models/json_api_filter_context_out_list.py +gooddata_api_client/models/json_api_filter_context_out_relationships.py +gooddata_api_client/models/json_api_filter_context_out_with_links.py +gooddata_api_client/models/json_api_filter_context_patch.py +gooddata_api_client/models/json_api_filter_context_patch_document.py +gooddata_api_client/models/json_api_filter_context_post_optional_id.py +gooddata_api_client/models/json_api_filter_context_post_optional_id_document.py +gooddata_api_client/models/json_api_filter_view_in.py +gooddata_api_client/models/json_api_filter_view_in_attributes.py +gooddata_api_client/models/json_api_filter_view_in_document.py +gooddata_api_client/models/json_api_filter_view_in_relationships.py +gooddata_api_client/models/json_api_filter_view_in_relationships_user.py +gooddata_api_client/models/json_api_filter_view_out.py +gooddata_api_client/models/json_api_filter_view_out_document.py +gooddata_api_client/models/json_api_filter_view_out_includes.py +gooddata_api_client/models/json_api_filter_view_out_list.py +gooddata_api_client/models/json_api_filter_view_out_with_links.py +gooddata_api_client/models/json_api_filter_view_patch.py +gooddata_api_client/models/json_api_filter_view_patch_attributes.py +gooddata_api_client/models/json_api_filter_view_patch_document.py +gooddata_api_client/models/json_api_identity_provider_in.py +gooddata_api_client/models/json_api_identity_provider_in_attributes.py +gooddata_api_client/models/json_api_identity_provider_in_document.py +gooddata_api_client/models/json_api_identity_provider_linkage.py +gooddata_api_client/models/json_api_identity_provider_out.py +gooddata_api_client/models/json_api_identity_provider_out_attributes.py +gooddata_api_client/models/json_api_identity_provider_out_document.py +gooddata_api_client/models/json_api_identity_provider_out_list.py +gooddata_api_client/models/json_api_identity_provider_out_with_links.py +gooddata_api_client/models/json_api_identity_provider_patch.py +gooddata_api_client/models/json_api_identity_provider_patch_document.py +gooddata_api_client/models/json_api_identity_provider_to_one_linkage.py +gooddata_api_client/models/json_api_jwk_in.py +gooddata_api_client/models/json_api_jwk_in_attributes.py +gooddata_api_client/models/json_api_jwk_in_attributes_content.py +gooddata_api_client/models/json_api_jwk_in_document.py +gooddata_api_client/models/json_api_jwk_out.py +gooddata_api_client/models/json_api_jwk_out_document.py +gooddata_api_client/models/json_api_jwk_out_list.py +gooddata_api_client/models/json_api_jwk_out_with_links.py +gooddata_api_client/models/json_api_jwk_patch.py +gooddata_api_client/models/json_api_jwk_patch_document.py +gooddata_api_client/models/json_api_label_linkage.py +gooddata_api_client/models/json_api_label_out.py +gooddata_api_client/models/json_api_label_out_attributes.py +gooddata_api_client/models/json_api_label_out_document.py +gooddata_api_client/models/json_api_label_out_list.py +gooddata_api_client/models/json_api_label_out_relationships.py +gooddata_api_client/models/json_api_label_out_relationships_attribute.py +gooddata_api_client/models/json_api_label_out_with_links.py +gooddata_api_client/models/json_api_label_to_one_linkage.py +gooddata_api_client/models/json_api_llm_endpoint_in.py +gooddata_api_client/models/json_api_llm_endpoint_in_attributes.py +gooddata_api_client/models/json_api_llm_endpoint_in_document.py +gooddata_api_client/models/json_api_llm_endpoint_out.py +gooddata_api_client/models/json_api_llm_endpoint_out_attributes.py +gooddata_api_client/models/json_api_llm_endpoint_out_document.py +gooddata_api_client/models/json_api_llm_endpoint_out_list.py +gooddata_api_client/models/json_api_llm_endpoint_out_with_links.py +gooddata_api_client/models/json_api_llm_endpoint_patch.py +gooddata_api_client/models/json_api_llm_endpoint_patch_attributes.py +gooddata_api_client/models/json_api_llm_endpoint_patch_document.py +gooddata_api_client/models/json_api_metric_in.py +gooddata_api_client/models/json_api_metric_in_attributes.py +gooddata_api_client/models/json_api_metric_in_attributes_content.py +gooddata_api_client/models/json_api_metric_in_document.py +gooddata_api_client/models/json_api_metric_linkage.py +gooddata_api_client/models/json_api_metric_out.py +gooddata_api_client/models/json_api_metric_out_attributes.py +gooddata_api_client/models/json_api_metric_out_document.py +gooddata_api_client/models/json_api_metric_out_includes.py +gooddata_api_client/models/json_api_metric_out_list.py +gooddata_api_client/models/json_api_metric_out_relationships.py +gooddata_api_client/models/json_api_metric_out_with_links.py +gooddata_api_client/models/json_api_metric_patch.py +gooddata_api_client/models/json_api_metric_patch_attributes.py +gooddata_api_client/models/json_api_metric_patch_document.py +gooddata_api_client/models/json_api_metric_post_optional_id.py +gooddata_api_client/models/json_api_metric_post_optional_id_document.py +gooddata_api_client/models/json_api_notification_channel_identifier_out.py +gooddata_api_client/models/json_api_notification_channel_identifier_out_attributes.py +gooddata_api_client/models/json_api_notification_channel_identifier_out_document.py +gooddata_api_client/models/json_api_notification_channel_identifier_out_list.py +gooddata_api_client/models/json_api_notification_channel_identifier_out_with_links.py +gooddata_api_client/models/json_api_notification_channel_in.py +gooddata_api_client/models/json_api_notification_channel_in_attributes.py +gooddata_api_client/models/json_api_notification_channel_in_attributes_destination.py +gooddata_api_client/models/json_api_notification_channel_in_document.py +gooddata_api_client/models/json_api_notification_channel_linkage.py +gooddata_api_client/models/json_api_notification_channel_out.py +gooddata_api_client/models/json_api_notification_channel_out_attributes.py +gooddata_api_client/models/json_api_notification_channel_out_document.py +gooddata_api_client/models/json_api_notification_channel_out_list.py +gooddata_api_client/models/json_api_notification_channel_out_with_links.py +gooddata_api_client/models/json_api_notification_channel_patch.py +gooddata_api_client/models/json_api_notification_channel_patch_document.py +gooddata_api_client/models/json_api_notification_channel_post_optional_id.py +gooddata_api_client/models/json_api_notification_channel_post_optional_id_document.py +gooddata_api_client/models/json_api_notification_channel_to_one_linkage.py +gooddata_api_client/models/json_api_organization_in.py +gooddata_api_client/models/json_api_organization_in_attributes.py +gooddata_api_client/models/json_api_organization_in_document.py +gooddata_api_client/models/json_api_organization_in_relationships.py +gooddata_api_client/models/json_api_organization_in_relationships_identity_provider.py +gooddata_api_client/models/json_api_organization_out.py +gooddata_api_client/models/json_api_organization_out_attributes.py +gooddata_api_client/models/json_api_organization_out_attributes_cache_settings.py +gooddata_api_client/models/json_api_organization_out_document.py +gooddata_api_client/models/json_api_organization_out_includes.py +gooddata_api_client/models/json_api_organization_out_meta.py +gooddata_api_client/models/json_api_organization_out_relationships.py +gooddata_api_client/models/json_api_organization_out_relationships_bootstrap_user_group.py +gooddata_api_client/models/json_api_organization_patch.py +gooddata_api_client/models/json_api_organization_patch_document.py +gooddata_api_client/models/json_api_organization_setting_in.py +gooddata_api_client/models/json_api_organization_setting_in_attributes.py +gooddata_api_client/models/json_api_organization_setting_in_document.py +gooddata_api_client/models/json_api_organization_setting_out.py +gooddata_api_client/models/json_api_organization_setting_out_document.py +gooddata_api_client/models/json_api_organization_setting_out_list.py +gooddata_api_client/models/json_api_organization_setting_out_with_links.py +gooddata_api_client/models/json_api_organization_setting_patch.py +gooddata_api_client/models/json_api_organization_setting_patch_document.py +gooddata_api_client/models/json_api_theme_in.py +gooddata_api_client/models/json_api_theme_in_document.py +gooddata_api_client/models/json_api_theme_out.py +gooddata_api_client/models/json_api_theme_out_document.py +gooddata_api_client/models/json_api_theme_out_list.py +gooddata_api_client/models/json_api_theme_out_with_links.py +gooddata_api_client/models/json_api_theme_patch.py +gooddata_api_client/models/json_api_theme_patch_document.py +gooddata_api_client/models/json_api_user_data_filter_in.py +gooddata_api_client/models/json_api_user_data_filter_in_attributes.py +gooddata_api_client/models/json_api_user_data_filter_in_document.py +gooddata_api_client/models/json_api_user_data_filter_in_relationships.py +gooddata_api_client/models/json_api_user_data_filter_out.py +gooddata_api_client/models/json_api_user_data_filter_out_document.py +gooddata_api_client/models/json_api_user_data_filter_out_includes.py +gooddata_api_client/models/json_api_user_data_filter_out_list.py +gooddata_api_client/models/json_api_user_data_filter_out_relationships.py +gooddata_api_client/models/json_api_user_data_filter_out_with_links.py +gooddata_api_client/models/json_api_user_data_filter_patch.py +gooddata_api_client/models/json_api_user_data_filter_patch_attributes.py +gooddata_api_client/models/json_api_user_data_filter_patch_document.py +gooddata_api_client/models/json_api_user_data_filter_post_optional_id.py +gooddata_api_client/models/json_api_user_data_filter_post_optional_id_document.py +gooddata_api_client/models/json_api_user_group_in.py +gooddata_api_client/models/json_api_user_group_in_attributes.py +gooddata_api_client/models/json_api_user_group_in_document.py +gooddata_api_client/models/json_api_user_group_in_relationships.py +gooddata_api_client/models/json_api_user_group_in_relationships_parents.py +gooddata_api_client/models/json_api_user_group_linkage.py +gooddata_api_client/models/json_api_user_group_out.py +gooddata_api_client/models/json_api_user_group_out_document.py +gooddata_api_client/models/json_api_user_group_out_list.py +gooddata_api_client/models/json_api_user_group_out_with_links.py +gooddata_api_client/models/json_api_user_group_patch.py +gooddata_api_client/models/json_api_user_group_patch_document.py +gooddata_api_client/models/json_api_user_group_to_one_linkage.py +gooddata_api_client/models/json_api_user_identifier_linkage.py +gooddata_api_client/models/json_api_user_identifier_out.py +gooddata_api_client/models/json_api_user_identifier_out_attributes.py +gooddata_api_client/models/json_api_user_identifier_out_document.py +gooddata_api_client/models/json_api_user_identifier_out_list.py +gooddata_api_client/models/json_api_user_identifier_out_with_links.py +gooddata_api_client/models/json_api_user_identifier_to_one_linkage.py +gooddata_api_client/models/json_api_user_in.py +gooddata_api_client/models/json_api_user_in_attributes.py +gooddata_api_client/models/json_api_user_in_document.py +gooddata_api_client/models/json_api_user_in_relationships.py +gooddata_api_client/models/json_api_user_linkage.py +gooddata_api_client/models/json_api_user_out.py +gooddata_api_client/models/json_api_user_out_document.py +gooddata_api_client/models/json_api_user_out_list.py +gooddata_api_client/models/json_api_user_out_with_links.py +gooddata_api_client/models/json_api_user_patch.py +gooddata_api_client/models/json_api_user_patch_document.py +gooddata_api_client/models/json_api_user_setting_in.py +gooddata_api_client/models/json_api_user_setting_in_document.py +gooddata_api_client/models/json_api_user_setting_out.py +gooddata_api_client/models/json_api_user_setting_out_document.py +gooddata_api_client/models/json_api_user_setting_out_list.py +gooddata_api_client/models/json_api_user_setting_out_with_links.py +gooddata_api_client/models/json_api_user_to_one_linkage.py +gooddata_api_client/models/json_api_visualization_object_in.py +gooddata_api_client/models/json_api_visualization_object_in_attributes.py +gooddata_api_client/models/json_api_visualization_object_in_document.py +gooddata_api_client/models/json_api_visualization_object_linkage.py +gooddata_api_client/models/json_api_visualization_object_out.py +gooddata_api_client/models/json_api_visualization_object_out_attributes.py +gooddata_api_client/models/json_api_visualization_object_out_document.py +gooddata_api_client/models/json_api_visualization_object_out_list.py +gooddata_api_client/models/json_api_visualization_object_out_with_links.py +gooddata_api_client/models/json_api_visualization_object_patch.py +gooddata_api_client/models/json_api_visualization_object_patch_attributes.py +gooddata_api_client/models/json_api_visualization_object_patch_document.py +gooddata_api_client/models/json_api_visualization_object_post_optional_id.py +gooddata_api_client/models/json_api_visualization_object_post_optional_id_document.py +gooddata_api_client/models/json_api_visualization_object_to_one_linkage.py +gooddata_api_client/models/json_api_workspace_automation_out.py +gooddata_api_client/models/json_api_workspace_automation_out_includes.py +gooddata_api_client/models/json_api_workspace_automation_out_list.py +gooddata_api_client/models/json_api_workspace_automation_out_relationships.py +gooddata_api_client/models/json_api_workspace_automation_out_relationships_workspace.py +gooddata_api_client/models/json_api_workspace_automation_out_with_links.py +gooddata_api_client/models/json_api_workspace_data_filter_in.py +gooddata_api_client/models/json_api_workspace_data_filter_in_attributes.py +gooddata_api_client/models/json_api_workspace_data_filter_in_document.py +gooddata_api_client/models/json_api_workspace_data_filter_in_relationships.py +gooddata_api_client/models/json_api_workspace_data_filter_in_relationships_filter_settings.py +gooddata_api_client/models/json_api_workspace_data_filter_linkage.py +gooddata_api_client/models/json_api_workspace_data_filter_out.py +gooddata_api_client/models/json_api_workspace_data_filter_out_document.py +gooddata_api_client/models/json_api_workspace_data_filter_out_list.py +gooddata_api_client/models/json_api_workspace_data_filter_out_with_links.py +gooddata_api_client/models/json_api_workspace_data_filter_patch.py +gooddata_api_client/models/json_api_workspace_data_filter_patch_document.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_in.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_in_attributes.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_in_document.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_in_relationships.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_linkage.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_out.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_out_document.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_out_list.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_out_with_links.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_patch.py +gooddata_api_client/models/json_api_workspace_data_filter_setting_patch_document.py +gooddata_api_client/models/json_api_workspace_data_filter_to_one_linkage.py +gooddata_api_client/models/json_api_workspace_in.py +gooddata_api_client/models/json_api_workspace_in_attributes.py +gooddata_api_client/models/json_api_workspace_in_attributes_data_source.py +gooddata_api_client/models/json_api_workspace_in_document.py +gooddata_api_client/models/json_api_workspace_in_relationships.py +gooddata_api_client/models/json_api_workspace_linkage.py +gooddata_api_client/models/json_api_workspace_out.py +gooddata_api_client/models/json_api_workspace_out_document.py +gooddata_api_client/models/json_api_workspace_out_list.py +gooddata_api_client/models/json_api_workspace_out_meta.py +gooddata_api_client/models/json_api_workspace_out_meta_config.py +gooddata_api_client/models/json_api_workspace_out_meta_data_model.py +gooddata_api_client/models/json_api_workspace_out_meta_hierarchy.py +gooddata_api_client/models/json_api_workspace_out_with_links.py +gooddata_api_client/models/json_api_workspace_patch.py +gooddata_api_client/models/json_api_workspace_patch_document.py +gooddata_api_client/models/json_api_workspace_setting_in.py +gooddata_api_client/models/json_api_workspace_setting_in_document.py +gooddata_api_client/models/json_api_workspace_setting_out.py +gooddata_api_client/models/json_api_workspace_setting_out_document.py +gooddata_api_client/models/json_api_workspace_setting_out_list.py +gooddata_api_client/models/json_api_workspace_setting_out_with_links.py +gooddata_api_client/models/json_api_workspace_setting_patch.py +gooddata_api_client/models/json_api_workspace_setting_patch_document.py +gooddata_api_client/models/json_api_workspace_setting_post_optional_id.py +gooddata_api_client/models/json_api_workspace_setting_post_optional_id_document.py +gooddata_api_client/models/json_api_workspace_to_one_linkage.py +gooddata_api_client/models/key_drivers_dimension.py +gooddata_api_client/models/key_drivers_request.py +gooddata_api_client/models/key_drivers_response.py +gooddata_api_client/models/key_drivers_result.py +gooddata_api_client/models/label_identifier.py +gooddata_api_client/models/list_links.py +gooddata_api_client/models/local_identifier.py +gooddata_api_client/models/locale_request.py +gooddata_api_client/models/manage_dashboard_permissions_request_inner.py +gooddata_api_client/models/measure_definition.py +gooddata_api_client/models/measure_execution_result_header.py +gooddata_api_client/models/measure_group_headers.py +gooddata_api_client/models/measure_header.py +gooddata_api_client/models/measure_item.py +gooddata_api_client/models/measure_item_definition.py +gooddata_api_client/models/measure_result_header.py +gooddata_api_client/models/measure_value_filter.py +gooddata_api_client/models/memory_item.py +gooddata_api_client/models/memory_item_use_cases.py +gooddata_api_client/models/metric.py +gooddata_api_client/models/metric_record.py +gooddata_api_client/models/negative_attribute_filter.py +gooddata_api_client/models/negative_attribute_filter_negative_attribute_filter.py +gooddata_api_client/models/note.py +gooddata_api_client/models/notes.py +gooddata_api_client/models/notification.py +gooddata_api_client/models/notification_channel_destination.py +gooddata_api_client/models/notification_content.py +gooddata_api_client/models/notification_data.py +gooddata_api_client/models/notification_filter.py +gooddata_api_client/models/notifications.py +gooddata_api_client/models/notifications_meta.py +gooddata_api_client/models/notifications_meta_total.py +gooddata_api_client/models/object_links.py +gooddata_api_client/models/object_links_container.py +gooddata_api_client/models/organization_automation_identifier.py +gooddata_api_client/models/organization_automation_management_bulk_request.py +gooddata_api_client/models/organization_permission_assignment.py +gooddata_api_client/models/over.py +gooddata_api_client/models/page_metadata.py +gooddata_api_client/models/paging.py +gooddata_api_client/models/parameter.py +gooddata_api_client/models/pdf_table_style.py +gooddata_api_client/models/pdf_table_style_property.py +gooddata_api_client/models/pdm_ldm_request.py +gooddata_api_client/models/pdm_sql.py +gooddata_api_client/models/permissions_assignment.py +gooddata_api_client/models/permissions_for_assignee.py +gooddata_api_client/models/permissions_for_assignee_rule.py +gooddata_api_client/models/platform_usage.py +gooddata_api_client/models/platform_usage_request.py +gooddata_api_client/models/pop_dataset.py +gooddata_api_client/models/pop_dataset_measure_definition.py +gooddata_api_client/models/pop_dataset_measure_definition_previous_period_measure.py +gooddata_api_client/models/pop_date.py +gooddata_api_client/models/pop_date_measure_definition.py +gooddata_api_client/models/pop_date_measure_definition_over_period_measure.py +gooddata_api_client/models/pop_measure_definition.py +gooddata_api_client/models/positive_attribute_filter.py +gooddata_api_client/models/positive_attribute_filter_positive_attribute_filter.py +gooddata_api_client/models/quality_issue.py +gooddata_api_client/models/quality_issue_object.py +gooddata_api_client/models/range.py +gooddata_api_client/models/range_measure_value_filter.py +gooddata_api_client/models/range_measure_value_filter_range_measure_value_filter.py +gooddata_api_client/models/range_wrapper.py +gooddata_api_client/models/ranking_filter.py +gooddata_api_client/models/ranking_filter_ranking_filter.py +gooddata_api_client/models/raw_custom_label.py +gooddata_api_client/models/raw_custom_metric.py +gooddata_api_client/models/raw_custom_override.py +gooddata_api_client/models/raw_export_automation_request.py +gooddata_api_client/models/raw_export_request.py +gooddata_api_client/models/reference_identifier.py +gooddata_api_client/models/reference_source_column.py +gooddata_api_client/models/relative.py +gooddata_api_client/models/relative_bounded_date_filter.py +gooddata_api_client/models/relative_date_filter.py +gooddata_api_client/models/relative_date_filter_relative_date_filter.py +gooddata_api_client/models/relative_wrapper.py +gooddata_api_client/models/resolve_settings_request.py +gooddata_api_client/models/resolved_llm_endpoint.py +gooddata_api_client/models/resolved_llm_endpoints.py +gooddata_api_client/models/resolved_setting.py +gooddata_api_client/models/rest_api_identifier.py +gooddata_api_client/models/result_cache_metadata.py +gooddata_api_client/models/result_dimension.py +gooddata_api_client/models/result_dimension_header.py +gooddata_api_client/models/result_spec.py +gooddata_api_client/models/route_result.py +gooddata_api_client/models/rsa_specification.py +gooddata_api_client/models/rule_permission.py +gooddata_api_client/models/running_section.py +gooddata_api_client/models/saved_visualization.py +gooddata_api_client/models/scan_request.py +gooddata_api_client/models/scan_result_pdm.py +gooddata_api_client/models/scan_sql_request.py +gooddata_api_client/models/scan_sql_response.py +gooddata_api_client/models/search_relationship_object.py +gooddata_api_client/models/search_request.py +gooddata_api_client/models/search_result.py +gooddata_api_client/models/search_result_object.py +gooddata_api_client/models/section_slide_template.py +gooddata_api_client/models/settings.py +gooddata_api_client/models/simple_measure_definition.py +gooddata_api_client/models/simple_measure_definition_measure.py +gooddata_api_client/models/skeleton.py +gooddata_api_client/models/slides_export_request.py +gooddata_api_client/models/smart_function_response.py +gooddata_api_client/models/smtp.py +gooddata_api_client/models/sort_key.py +gooddata_api_client/models/sort_key_attribute.py +gooddata_api_client/models/sort_key_attribute_attribute.py +gooddata_api_client/models/sort_key_total.py +gooddata_api_client/models/sort_key_total_total.py +gooddata_api_client/models/sort_key_value.py +gooddata_api_client/models/sort_key_value_value.py +gooddata_api_client/models/sql_column.py +gooddata_api_client/models/sql_query.py +gooddata_api_client/models/suggestion.py +gooddata_api_client/models/switch_identity_provider_request.py +gooddata_api_client/models/table.py +gooddata_api_client/models/table_override.py +gooddata_api_client/models/table_warning.py +gooddata_api_client/models/tabular_export_request.py +gooddata_api_client/models/test_definition_request.py +gooddata_api_client/models/test_destination_request.py +gooddata_api_client/models/test_notification.py +gooddata_api_client/models/test_query_duration.py +gooddata_api_client/models/test_request.py +gooddata_api_client/models/test_response.py +gooddata_api_client/models/total.py +gooddata_api_client/models/total_dimension.py +gooddata_api_client/models/total_execution_result_header.py +gooddata_api_client/models/total_result_header.py +gooddata_api_client/models/trigger_automation_request.py +gooddata_api_client/models/user_assignee.py +gooddata_api_client/models/user_context.py +gooddata_api_client/models/user_group_assignee.py +gooddata_api_client/models/user_group_identifier.py +gooddata_api_client/models/user_group_permission.py +gooddata_api_client/models/user_management_data_source_permission_assignment.py +gooddata_api_client/models/user_management_permission_assignments.py +gooddata_api_client/models/user_management_user_group_member.py +gooddata_api_client/models/user_management_user_group_members.py +gooddata_api_client/models/user_management_user_groups.py +gooddata_api_client/models/user_management_user_groups_item.py +gooddata_api_client/models/user_management_users.py +gooddata_api_client/models/user_management_users_item.py +gooddata_api_client/models/user_management_workspace_permission_assignment.py +gooddata_api_client/models/user_permission.py +gooddata_api_client/models/validate_by_item.py +gooddata_api_client/models/validate_llm_endpoint_by_id_request.py +gooddata_api_client/models/validate_llm_endpoint_request.py +gooddata_api_client/models/validate_llm_endpoint_response.py +gooddata_api_client/models/value.py +gooddata_api_client/models/visible_filter.py +gooddata_api_client/models/visual_export_request.py +gooddata_api_client/models/webhook.py +gooddata_api_client/models/webhook_automation_info.py +gooddata_api_client/models/webhook_message.py +gooddata_api_client/models/webhook_message_data.py +gooddata_api_client/models/webhook_recipient.py +gooddata_api_client/models/widget_slides_template.py +gooddata_api_client/models/workspace_automation_identifier.py +gooddata_api_client/models/workspace_automation_management_bulk_request.py +gooddata_api_client/models/workspace_data_source.py +gooddata_api_client/models/workspace_identifier.py +gooddata_api_client/models/workspace_permission_assignment.py +gooddata_api_client/models/workspace_user.py +gooddata_api_client/models/workspace_user_group.py +gooddata_api_client/models/workspace_user_groups.py +gooddata_api_client/models/workspace_users.py +gooddata_api_client/models/xliff.py +gooddata_api_client/py.typed gooddata_api_client/rest.py +pyproject.toml requirements.txt setup.cfg setup.py diff --git a/gooddata-api-client/.openapi-generator/VERSION b/gooddata-api-client/.openapi-generator/VERSION index 66672d4e9..b23eb2752 100644 --- a/gooddata-api-client/.openapi-generator/VERSION +++ b/gooddata-api-client/.openapi-generator/VERSION @@ -1 +1 @@ -6.1.0-SNAPSHOT \ No newline at end of file +7.11.0 diff --git a/gooddata-api-client/README.md b/gooddata-api-client/README.md index a78be6aaf..c98de5e4f 100644 --- a/gooddata-api-client/README.md +++ b/gooddata-api-client/README.md @@ -5,11 +5,12 @@ This Python package is automatically generated by the [OpenAPI Generator](https: - API version: v0 - Package version: 1.51.0 +- Generator version: 7.11.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen ## Requirements. -Python >=3.6 +Python 3.8+ ## Installation & Usage ### pip install @@ -40,16 +41,20 @@ Then import the package: import gooddata_api_client ``` +### Tests + +Execute `pytest` to run the tests. + ## Getting Started Please follow the [installation procedure](#installation--usage) and then run the following: ```python -import time import gooddata_api_client +from gooddata_api_client.rest import ApiException from pprint import pprint -from gooddata_api_client.api import ai_api + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -61,14 +66,15 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.AIApi(api_client) + workspace_id = 'workspace_id_example' # str | try: # (BETA) Sync Metadata to other services api_instance.metadata_sync(workspace_id) - except gooddata_api_client.ApiException as e: + except ApiException as e: print("Exception when calling AIApi->metadata_sync: %s\n" % e) + ``` ## Documentation for API Endpoints @@ -1022,9 +1028,7 @@ Class | Method | HTTP request | Description - [AttributeHeaderAttributeHeader](docs/AttributeHeaderAttributeHeader.md) - [AttributeItem](docs/AttributeItem.md) - [AttributeNegativeFilter](docs/AttributeNegativeFilter.md) - - [AttributeNegativeFilterAllOf](docs/AttributeNegativeFilterAllOf.md) - [AttributePositiveFilter](docs/AttributePositiveFilter.md) - - [AttributePositiveFilterAllOf](docs/AttributePositiveFilterAllOf.md) - [AttributeResultHeader](docs/AttributeResultHeader.md) - [AutomationAlert](docs/AutomationAlert.md) - [AutomationAlertCondition](docs/AutomationAlertCondition.md) @@ -1033,7 +1037,6 @@ Class | Method | HTTP request | Description - [AutomationImageExport](docs/AutomationImageExport.md) - [AutomationMetadata](docs/AutomationMetadata.md) - [AutomationNotification](docs/AutomationNotification.md) - - [AutomationNotificationAllOf](docs/AutomationNotificationAllOf.md) - [AutomationRawExport](docs/AutomationRawExport.md) - [AutomationSchedule](docs/AutomationSchedule.md) - [AutomationSlidesExport](docs/AutomationSlidesExport.md) @@ -1049,7 +1052,6 @@ Class | Method | HTTP request | Description - [ChatUsageResponse](docs/ChatUsageResponse.md) - [ClusteringRequest](docs/ClusteringRequest.md) - [ClusteringResult](docs/ClusteringResult.md) - - [ColumnLocation](docs/ColumnLocation.md) - [ColumnOverride](docs/ColumnOverride.md) - [ColumnStatistic](docs/ColumnStatistic.md) - [ColumnStatisticWarning](docs/ColumnStatisticWarning.md) @@ -1091,10 +1093,8 @@ Class | Method | HTTP request | Description - [DatasetReferenceIdentifier](docs/DatasetReferenceIdentifier.md) - [DatasetWorkspaceDataFilterIdentifier](docs/DatasetWorkspaceDataFilterIdentifier.md) - [DateAbsoluteFilter](docs/DateAbsoluteFilter.md) - - [DateAbsoluteFilterAllOf](docs/DateAbsoluteFilterAllOf.md) - [DateFilter](docs/DateFilter.md) - [DateRelativeFilter](docs/DateRelativeFilter.md) - - [DateRelativeFilterAllOf](docs/DateRelativeFilterAllOf.md) - [DateValue](docs/DateValue.md) - [DeclarativeAggregatedFact](docs/DeclarativeAggregatedFact.md) - [DeclarativeAnalyticalDashboard](docs/DeclarativeAnalyticalDashboard.md) @@ -1102,9 +1102,7 @@ Class | Method | HTTP request | Description - [DeclarativeAnalyticalDashboardIdentifier](docs/DeclarativeAnalyticalDashboardIdentifier.md) - [DeclarativeAnalyticalDashboardPermissionAssignment](docs/DeclarativeAnalyticalDashboardPermissionAssignment.md) - [DeclarativeAnalyticalDashboardPermissionForAssignee](docs/DeclarativeAnalyticalDashboardPermissionForAssignee.md) - - [DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf](docs/DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf.md) - [DeclarativeAnalyticalDashboardPermissionForAssigneeRule](docs/DeclarativeAnalyticalDashboardPermissionForAssigneeRule.md) - - [DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf](docs/DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf.md) - [DeclarativeAnalyticalDashboardPermissionsInner](docs/DeclarativeAnalyticalDashboardPermissionsInner.md) - [DeclarativeAnalytics](docs/DeclarativeAnalytics.md) - [DeclarativeAnalyticsLayer](docs/DeclarativeAnalyticsLayer.md) @@ -1181,16 +1179,12 @@ Class | Method | HTTP request | Description - [DeclarativeWorkspacePermissions](docs/DeclarativeWorkspacePermissions.md) - [DeclarativeWorkspaces](docs/DeclarativeWorkspaces.md) - [DefaultSmtp](docs/DefaultSmtp.md) - - [DefaultSmtpAllOf](docs/DefaultSmtpAllOf.md) - [DependentEntitiesGraph](docs/DependentEntitiesGraph.md) - [DependentEntitiesNode](docs/DependentEntitiesNode.md) - [DependentEntitiesRequest](docs/DependentEntitiesRequest.md) - [DependentEntitiesResponse](docs/DependentEntitiesResponse.md) - [DependsOn](docs/DependsOn.md) - - [DependsOnAllOf](docs/DependsOnAllOf.md) - [DependsOnDateFilter](docs/DependsOnDateFilter.md) - - [DependsOnDateFilterAllOf](docs/DependsOnDateFilterAllOf.md) - - [DependsOnItem](docs/DependsOnItem.md) - [DimAttribute](docs/DimAttribute.md) - [Dimension](docs/Dimension.md) - [DimensionHeader](docs/DimensionHeader.md) @@ -1214,7 +1208,6 @@ Class | Method | HTTP request | Description - [ExportResult](docs/ExportResult.md) - [FactIdentifier](docs/FactIdentifier.md) - [File](docs/File.md) - - [Filter](docs/Filter.md) - [FilterBy](docs/FilterBy.md) - [FilterDefinition](docs/FilterDefinition.md) - [FilterDefinitionForSimpleMeasure](docs/FilterDefinitionForSimpleMeasure.md) @@ -1240,7 +1233,6 @@ Class | Method | HTTP request | Description - [IdentifierRefIdentifier](docs/IdentifierRefIdentifier.md) - [ImageExportRequest](docs/ImageExportRequest.md) - [InPlatform](docs/InPlatform.md) - - [InPlatformAllOf](docs/InPlatformAllOf.md) - [InlineFilterDefinition](docs/InlineFilterDefinition.md) - [InlineFilterDefinitionInline](docs/InlineFilterDefinitionInline.md) - [InlineMeasureDefinition](docs/InlineMeasureDefinition.md) @@ -1259,7 +1251,6 @@ Class | Method | HTTP request | Description - [JsonApiAggregatedFactOutRelationshipsDataset](docs/JsonApiAggregatedFactOutRelationshipsDataset.md) - [JsonApiAggregatedFactOutRelationshipsSourceFact](docs/JsonApiAggregatedFactOutRelationshipsSourceFact.md) - [JsonApiAggregatedFactOutWithLinks](docs/JsonApiAggregatedFactOutWithLinks.md) - - [JsonApiAggregatedFactToManyLinkage](docs/JsonApiAggregatedFactToManyLinkage.md) - [JsonApiAnalyticalDashboardIn](docs/JsonApiAnalyticalDashboardIn.md) - [JsonApiAnalyticalDashboardInAttributes](docs/JsonApiAnalyticalDashboardInAttributes.md) - [JsonApiAnalyticalDashboardInDocument](docs/JsonApiAnalyticalDashboardInDocument.md) @@ -1286,7 +1277,6 @@ Class | Method | HTTP request | Description - [JsonApiAnalyticalDashboardPatchDocument](docs/JsonApiAnalyticalDashboardPatchDocument.md) - [JsonApiAnalyticalDashboardPostOptionalId](docs/JsonApiAnalyticalDashboardPostOptionalId.md) - [JsonApiAnalyticalDashboardPostOptionalIdDocument](docs/JsonApiAnalyticalDashboardPostOptionalIdDocument.md) - - [JsonApiAnalyticalDashboardToManyLinkage](docs/JsonApiAnalyticalDashboardToManyLinkage.md) - [JsonApiAnalyticalDashboardToOneLinkage](docs/JsonApiAnalyticalDashboardToOneLinkage.md) - [JsonApiApiTokenIn](docs/JsonApiApiTokenIn.md) - [JsonApiApiTokenInDocument](docs/JsonApiApiTokenInDocument.md) @@ -1309,7 +1299,6 @@ Class | Method | HTTP request | Description - [JsonApiAttributeHierarchyOutWithLinks](docs/JsonApiAttributeHierarchyOutWithLinks.md) - [JsonApiAttributeHierarchyPatch](docs/JsonApiAttributeHierarchyPatch.md) - [JsonApiAttributeHierarchyPatchDocument](docs/JsonApiAttributeHierarchyPatchDocument.md) - - [JsonApiAttributeHierarchyToManyLinkage](docs/JsonApiAttributeHierarchyToManyLinkage.md) - [JsonApiAttributeLinkage](docs/JsonApiAttributeLinkage.md) - [JsonApiAttributeOut](docs/JsonApiAttributeOut.md) - [JsonApiAttributeOutAttributes](docs/JsonApiAttributeOutAttributes.md) @@ -1320,7 +1309,6 @@ Class | Method | HTTP request | Description - [JsonApiAttributeOutRelationshipsAttributeHierarchies](docs/JsonApiAttributeOutRelationshipsAttributeHierarchies.md) - [JsonApiAttributeOutRelationshipsDefaultView](docs/JsonApiAttributeOutRelationshipsDefaultView.md) - [JsonApiAttributeOutWithLinks](docs/JsonApiAttributeOutWithLinks.md) - - [JsonApiAttributeToManyLinkage](docs/JsonApiAttributeToManyLinkage.md) - [JsonApiAttributeToOneLinkage](docs/JsonApiAttributeToOneLinkage.md) - [JsonApiAutomationIn](docs/JsonApiAutomationIn.md) - [JsonApiAutomationInAttributes](docs/JsonApiAutomationInAttributes.md) @@ -1357,7 +1345,6 @@ Class | Method | HTTP request | Description - [JsonApiAutomationResultOutRelationships](docs/JsonApiAutomationResultOutRelationships.md) - [JsonApiAutomationResultOutRelationshipsAutomation](docs/JsonApiAutomationResultOutRelationshipsAutomation.md) - [JsonApiAutomationResultOutWithLinks](docs/JsonApiAutomationResultOutWithLinks.md) - - [JsonApiAutomationResultToManyLinkage](docs/JsonApiAutomationResultToManyLinkage.md) - [JsonApiAutomationToOneLinkage](docs/JsonApiAutomationToOneLinkage.md) - [JsonApiColorPaletteIn](docs/JsonApiColorPaletteIn.md) - [JsonApiColorPaletteInAttributes](docs/JsonApiColorPaletteInAttributes.md) @@ -1412,7 +1399,6 @@ Class | Method | HTTP request | Description - [JsonApiDashboardPluginPatchDocument](docs/JsonApiDashboardPluginPatchDocument.md) - [JsonApiDashboardPluginPostOptionalId](docs/JsonApiDashboardPluginPostOptionalId.md) - [JsonApiDashboardPluginPostOptionalIdDocument](docs/JsonApiDashboardPluginPostOptionalIdDocument.md) - - [JsonApiDashboardPluginToManyLinkage](docs/JsonApiDashboardPluginToManyLinkage.md) - [JsonApiDataSourceIdentifierOut](docs/JsonApiDataSourceIdentifierOut.md) - [JsonApiDataSourceIdentifierOutAttributes](docs/JsonApiDataSourceIdentifierOutAttributes.md) - [JsonApiDataSourceIdentifierOutDocument](docs/JsonApiDataSourceIdentifierOutDocument.md) @@ -1447,7 +1433,6 @@ Class | Method | HTTP request | Description - [JsonApiDatasetOutRelationshipsFacts](docs/JsonApiDatasetOutRelationshipsFacts.md) - [JsonApiDatasetOutRelationshipsWorkspaceDataFilters](docs/JsonApiDatasetOutRelationshipsWorkspaceDataFilters.md) - [JsonApiDatasetOutWithLinks](docs/JsonApiDatasetOutWithLinks.md) - - [JsonApiDatasetToManyLinkage](docs/JsonApiDatasetToManyLinkage.md) - [JsonApiDatasetToOneLinkage](docs/JsonApiDatasetToOneLinkage.md) - [JsonApiEntitlementOut](docs/JsonApiEntitlementOut.md) - [JsonApiEntitlementOutAttributes](docs/JsonApiEntitlementOutAttributes.md) @@ -1472,7 +1457,6 @@ Class | Method | HTTP request | Description - [JsonApiExportDefinitionPatchDocument](docs/JsonApiExportDefinitionPatchDocument.md) - [JsonApiExportDefinitionPostOptionalId](docs/JsonApiExportDefinitionPostOptionalId.md) - [JsonApiExportDefinitionPostOptionalIdDocument](docs/JsonApiExportDefinitionPostOptionalIdDocument.md) - - [JsonApiExportDefinitionToManyLinkage](docs/JsonApiExportDefinitionToManyLinkage.md) - [JsonApiExportTemplateIn](docs/JsonApiExportTemplateIn.md) - [JsonApiExportTemplateInAttributes](docs/JsonApiExportTemplateInAttributes.md) - [JsonApiExportTemplateInAttributesDashboardSlidesTemplate](docs/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md) @@ -1494,7 +1478,6 @@ Class | Method | HTTP request | Description - [JsonApiFactOutList](docs/JsonApiFactOutList.md) - [JsonApiFactOutRelationships](docs/JsonApiFactOutRelationships.md) - [JsonApiFactOutWithLinks](docs/JsonApiFactOutWithLinks.md) - - [JsonApiFactToManyLinkage](docs/JsonApiFactToManyLinkage.md) - [JsonApiFactToOneLinkage](docs/JsonApiFactToOneLinkage.md) - [JsonApiFilterContextIn](docs/JsonApiFilterContextIn.md) - [JsonApiFilterContextInDocument](docs/JsonApiFilterContextInDocument.md) @@ -1509,7 +1492,6 @@ Class | Method | HTTP request | Description - [JsonApiFilterContextPatchDocument](docs/JsonApiFilterContextPatchDocument.md) - [JsonApiFilterContextPostOptionalId](docs/JsonApiFilterContextPostOptionalId.md) - [JsonApiFilterContextPostOptionalIdDocument](docs/JsonApiFilterContextPostOptionalIdDocument.md) - - [JsonApiFilterContextToManyLinkage](docs/JsonApiFilterContextToManyLinkage.md) - [JsonApiFilterViewIn](docs/JsonApiFilterViewIn.md) - [JsonApiFilterViewInAttributes](docs/JsonApiFilterViewInAttributes.md) - [JsonApiFilterViewInDocument](docs/JsonApiFilterViewInDocument.md) @@ -1553,7 +1535,6 @@ Class | Method | HTTP request | Description - [JsonApiLabelOutRelationships](docs/JsonApiLabelOutRelationships.md) - [JsonApiLabelOutRelationshipsAttribute](docs/JsonApiLabelOutRelationshipsAttribute.md) - [JsonApiLabelOutWithLinks](docs/JsonApiLabelOutWithLinks.md) - - [JsonApiLabelToManyLinkage](docs/JsonApiLabelToManyLinkage.md) - [JsonApiLabelToOneLinkage](docs/JsonApiLabelToOneLinkage.md) - [JsonApiLlmEndpointIn](docs/JsonApiLlmEndpointIn.md) - [JsonApiLlmEndpointInAttributes](docs/JsonApiLlmEndpointInAttributes.md) @@ -1583,7 +1564,6 @@ Class | Method | HTTP request | Description - [JsonApiMetricPatchDocument](docs/JsonApiMetricPatchDocument.md) - [JsonApiMetricPostOptionalId](docs/JsonApiMetricPostOptionalId.md) - [JsonApiMetricPostOptionalIdDocument](docs/JsonApiMetricPostOptionalIdDocument.md) - - [JsonApiMetricToManyLinkage](docs/JsonApiMetricToManyLinkage.md) - [JsonApiNotificationChannelIdentifierOut](docs/JsonApiNotificationChannelIdentifierOut.md) - [JsonApiNotificationChannelIdentifierOutAttributes](docs/JsonApiNotificationChannelIdentifierOutAttributes.md) - [JsonApiNotificationChannelIdentifierOutDocument](docs/JsonApiNotificationChannelIdentifierOutDocument.md) @@ -1663,7 +1643,6 @@ Class | Method | HTTP request | Description - [JsonApiUserGroupOutWithLinks](docs/JsonApiUserGroupOutWithLinks.md) - [JsonApiUserGroupPatch](docs/JsonApiUserGroupPatch.md) - [JsonApiUserGroupPatchDocument](docs/JsonApiUserGroupPatchDocument.md) - - [JsonApiUserGroupToManyLinkage](docs/JsonApiUserGroupToManyLinkage.md) - [JsonApiUserGroupToOneLinkage](docs/JsonApiUserGroupToOneLinkage.md) - [JsonApiUserIdentifierLinkage](docs/JsonApiUserIdentifierLinkage.md) - [JsonApiUserIdentifierOut](docs/JsonApiUserIdentifierOut.md) @@ -1689,7 +1668,6 @@ Class | Method | HTTP request | Description - [JsonApiUserSettingOutDocument](docs/JsonApiUserSettingOutDocument.md) - [JsonApiUserSettingOutList](docs/JsonApiUserSettingOutList.md) - [JsonApiUserSettingOutWithLinks](docs/JsonApiUserSettingOutWithLinks.md) - - [JsonApiUserToManyLinkage](docs/JsonApiUserToManyLinkage.md) - [JsonApiUserToOneLinkage](docs/JsonApiUserToOneLinkage.md) - [JsonApiVisualizationObjectIn](docs/JsonApiVisualizationObjectIn.md) - [JsonApiVisualizationObjectInAttributes](docs/JsonApiVisualizationObjectInAttributes.md) @@ -1705,7 +1683,6 @@ Class | Method | HTTP request | Description - [JsonApiVisualizationObjectPatchDocument](docs/JsonApiVisualizationObjectPatchDocument.md) - [JsonApiVisualizationObjectPostOptionalId](docs/JsonApiVisualizationObjectPostOptionalId.md) - [JsonApiVisualizationObjectPostOptionalIdDocument](docs/JsonApiVisualizationObjectPostOptionalIdDocument.md) - - [JsonApiVisualizationObjectToManyLinkage](docs/JsonApiVisualizationObjectToManyLinkage.md) - [JsonApiVisualizationObjectToOneLinkage](docs/JsonApiVisualizationObjectToOneLinkage.md) - [JsonApiWorkspaceAutomationOut](docs/JsonApiWorkspaceAutomationOut.md) - [JsonApiWorkspaceAutomationOutIncludes](docs/JsonApiWorkspaceAutomationOutIncludes.md) @@ -1737,8 +1714,6 @@ Class | Method | HTTP request | Description - [JsonApiWorkspaceDataFilterSettingOutWithLinks](docs/JsonApiWorkspaceDataFilterSettingOutWithLinks.md) - [JsonApiWorkspaceDataFilterSettingPatch](docs/JsonApiWorkspaceDataFilterSettingPatch.md) - [JsonApiWorkspaceDataFilterSettingPatchDocument](docs/JsonApiWorkspaceDataFilterSettingPatchDocument.md) - - [JsonApiWorkspaceDataFilterSettingToManyLinkage](docs/JsonApiWorkspaceDataFilterSettingToManyLinkage.md) - - [JsonApiWorkspaceDataFilterToManyLinkage](docs/JsonApiWorkspaceDataFilterToManyLinkage.md) - [JsonApiWorkspaceDataFilterToOneLinkage](docs/JsonApiWorkspaceDataFilterToOneLinkage.md) - [JsonApiWorkspaceIn](docs/JsonApiWorkspaceIn.md) - [JsonApiWorkspaceInAttributes](docs/JsonApiWorkspaceInAttributes.md) @@ -1767,14 +1742,12 @@ Class | Method | HTTP request | Description - [JsonApiWorkspaceSettingPostOptionalId](docs/JsonApiWorkspaceSettingPostOptionalId.md) - [JsonApiWorkspaceSettingPostOptionalIdDocument](docs/JsonApiWorkspaceSettingPostOptionalIdDocument.md) - [JsonApiWorkspaceToOneLinkage](docs/JsonApiWorkspaceToOneLinkage.md) - - [JsonNode](docs/JsonNode.md) - [KeyDriversDimension](docs/KeyDriversDimension.md) - [KeyDriversRequest](docs/KeyDriversRequest.md) - [KeyDriversResponse](docs/KeyDriversResponse.md) - [KeyDriversResult](docs/KeyDriversResult.md) - [LabelIdentifier](docs/LabelIdentifier.md) - [ListLinks](docs/ListLinks.md) - - [ListLinksAllOf](docs/ListLinksAllOf.md) - [LocalIdentifier](docs/LocalIdentifier.md) - [LocaleRequest](docs/LocaleRequest.md) - [ManageDashboardPermissionsRequestInner](docs/ManageDashboardPermissionsRequestInner.md) @@ -1817,7 +1790,6 @@ Class | Method | HTTP request | Description - [PdmSql](docs/PdmSql.md) - [PermissionsAssignment](docs/PermissionsAssignment.md) - [PermissionsForAssignee](docs/PermissionsForAssignee.md) - - [PermissionsForAssigneeAllOf](docs/PermissionsForAssigneeAllOf.md) - [PermissionsForAssigneeRule](docs/PermissionsForAssigneeRule.md) - [PlatformUsage](docs/PlatformUsage.md) - [PlatformUsageRequest](docs/PlatformUsageRequest.md) @@ -1880,7 +1852,6 @@ Class | Method | HTTP request | Description - [SlidesExportRequest](docs/SlidesExportRequest.md) - [SmartFunctionResponse](docs/SmartFunctionResponse.md) - [Smtp](docs/Smtp.md) - - [SmtpAllOf](docs/SmtpAllOf.md) - [SortKey](docs/SortKey.md) - [SortKeyAttribute](docs/SortKeyAttribute.md) - [SortKeyAttributeAttribute](docs/SortKeyAttributeAttribute.md) @@ -1890,18 +1861,15 @@ Class | Method | HTTP request | Description - [SortKeyValueValue](docs/SortKeyValueValue.md) - [SqlColumn](docs/SqlColumn.md) - [SqlQuery](docs/SqlQuery.md) - - [SqlQueryAllOf](docs/SqlQueryAllOf.md) - [Suggestion](docs/Suggestion.md) - [SwitchIdentityProviderRequest](docs/SwitchIdentityProviderRequest.md) - [Table](docs/Table.md) - - [TableAllOf](docs/TableAllOf.md) - [TableOverride](docs/TableOverride.md) - [TableWarning](docs/TableWarning.md) - [TabularExportRequest](docs/TabularExportRequest.md) - [TestDefinitionRequest](docs/TestDefinitionRequest.md) - [TestDestinationRequest](docs/TestDestinationRequest.md) - [TestNotification](docs/TestNotification.md) - - [TestNotificationAllOf](docs/TestNotificationAllOf.md) - [TestQueryDuration](docs/TestQueryDuration.md) - [TestRequest](docs/TestRequest.md) - [TestResponse](docs/TestResponse.md) @@ -1933,7 +1901,6 @@ Class | Method | HTTP request | Description - [VisibleFilter](docs/VisibleFilter.md) - [VisualExportRequest](docs/VisualExportRequest.md) - [Webhook](docs/Webhook.md) - - [WebhookAllOf](docs/WebhookAllOf.md) - [WebhookAutomationInfo](docs/WebhookAutomationInfo.md) - [WebhookMessage](docs/WebhookMessage.md) - [WebhookMessageData](docs/WebhookMessageData.md) @@ -1951,31 +1918,14 @@ Class | Method | HTTP request | Description - [Xliff](docs/Xliff.md) + ## Documentation For Authorization - All endpoints do not require authorization. +Endpoints do not require authorization. + ## Author support@gooddata.com -## Notes for Large OpenAPI documents -If the OpenAPI document is large, imports in gooddata_api_client.apis and gooddata_api_client.models may fail with a -RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: - -Solution 1: -Use specific imports for apis and models like: -- `from gooddata_api_client.api.default_api import DefaultApi` -- `from gooddata_api_client.model.pet import Pet` - -Solution 2: -Before importing the package, adjust the maximum recursion limit as shown below: -``` -import sys -sys.setrecursionlimit(1500) -import gooddata_api_client -from gooddata_api_client.apis import * -from gooddata_api_client.models import * -``` - diff --git a/gooddata-api-client/docs/AFM.md b/gooddata-api-client/docs/AFM.md index f0e919ef5..2041f4f8c 100644 --- a/gooddata-api-client/docs/AFM.md +++ b/gooddata-api-client/docs/AFM.md @@ -3,14 +3,31 @@ Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | [**[AttributeItem]**](AttributeItem.md) | Attributes to be used in the computation. | -**filters** | [**[AFMFiltersInner]**](AFMFiltersInner.md) | Various filter types to filter the execution result. | -**measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be computed. | -**aux_measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**attributes** | [**List[AttributeItem]**](AttributeItem.md) | Attributes to be used in the computation. | +**aux_measures** | [**List[MeasureItem]**](MeasureItem.md) | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | [optional] +**filters** | [**List[AFMFiltersInner]**](AFMFiltersInner.md) | Various filter types to filter the execution result. | +**measures** | [**List[MeasureItem]**](MeasureItem.md) | Metrics to be computed. | + +## Example + +```python +from gooddata_api_client.models.afm import AFM + +# TODO update the JSON string below +json = "{}" +# create an instance of AFM from a JSON string +afm_instance = AFM.from_json(json) +# print the JSON string representation of the object +print(AFM.to_json()) +# convert the object into a dict +afm_dict = afm_instance.to_dict() +# create an instance of AFM from a dict +afm_from_dict = AFM.from_dict(afm_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AFMFiltersInner.md b/gooddata-api-client/docs/AFMFiltersInner.md index dbac5d910..9ed452ff5 100644 --- a/gooddata-api-client/docs/AFMFiltersInner.md +++ b/gooddata-api-client/docs/AFMFiltersInner.md @@ -2,17 +2,35 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comparison_measure_value_filter** | [**ComparisonMeasureValueFilterComparisonMeasureValueFilter**](ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) | | [optional] -**range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | [optional] -**ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | [optional] -**absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] -**relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] -**negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] -**positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | [optional] -**inline** | [**InlineFilterDefinitionInline**](InlineFilterDefinitionInline.md) | | [optional] +**comparison_measure_value_filter** | [**ComparisonMeasureValueFilterComparisonMeasureValueFilter**](ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) | | +**range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | +**ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | +**absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | +**relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | +**negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | +**positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | +**inline** | [**InlineFilterDefinitionInline**](InlineFilterDefinitionInline.md) | | + +## Example + +```python +from gooddata_api_client.models.afm_filters_inner import AFMFiltersInner + +# TODO update the JSON string below +json = "{}" +# create an instance of AFMFiltersInner from a JSON string +afm_filters_inner_instance = AFMFiltersInner.from_json(json) +# print the JSON string representation of the object +print(AFMFiltersInner.to_json()) +# convert the object into a dict +afm_filters_inner_dict = afm_filters_inner_instance.to_dict() +# create an instance of AFMFiltersInner from a dict +afm_filters_inner_from_dict = AFMFiltersInner.from_dict(afm_filters_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AIApi.md b/gooddata-api-client/docs/AIApi.md index 0156ed9b8..cdc4616cb 100644 --- a/gooddata-api-client/docs/AIApi.md +++ b/gooddata-api-client/docs/AIApi.md @@ -19,10 +19,10 @@ Method | HTTP request | Description ```python -import time import gooddata_api_client -from gooddata_api_client.api import ai_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -31,25 +31,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.AIApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # (BETA) Sync Metadata to other services api_instance.metadata_sync(workspace_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AIApi->metadata_sync: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type @@ -64,7 +65,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -84,10 +84,10 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import ai_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -96,20 +96,21 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = gooddata_api_client.AIApi(api_client) - # example, this endpoint has no required or optional parameters try: # (BETA) Sync organization scope Metadata to other services api_instance.metadata_sync_organization() - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AIApi->metadata_sync_organization: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -125,7 +126,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/APITokensApi.md b/gooddata-api-client/docs/APITokensApi.md index 8250932ad..2c28ce5f9 100644 --- a/gooddata-api-client/docs/APITokensApi.md +++ b/gooddata-api-client/docs/APITokensApi.md @@ -19,12 +19,12 @@ Post a new API token for the user ```python -import time import gooddata_api_client -from gooddata_api_client.api import api_tokens_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -33,33 +33,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = api_tokens_api.APITokensApi(api_client) - user_id = "userId_example" # str | - json_api_api_token_in_document = JsonApiApiTokenInDocument( - data=JsonApiApiTokenIn( - id="id1", - type="apiToken", - ), - ) # JsonApiApiTokenInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.APITokensApi(api_client) + user_id = 'user_id_example' # str | + json_api_api_token_in_document = gooddata_api_client.JsonApiApiTokenInDocument() # JsonApiApiTokenInDocument | + try: # Post a new API token for the user api_response = api_instance.create_entity_api_tokens(user_id, json_api_api_token_in_document) + print("The response of APITokensApi->create_entity_api_tokens:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling APITokensApi->create_entity_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **json_api_api_token_in_document** | [**JsonApiApiTokenInDocument**](JsonApiApiTokenInDocument.md)| | + **user_id** | **str**| | + **json_api_api_token_in_document** | [**JsonApiApiTokenInDocument**](JsonApiApiTokenInDocument.md)| | ### Return type @@ -74,7 +71,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -84,7 +80,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_api_tokens** -> delete_entity_api_tokens(user_id, id) +> delete_entity_api_tokens(user_id, id, filter=filter) Delete an API Token for a user @@ -92,10 +88,10 @@ Delete an API Token for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import api_tokens_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -104,37 +100,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = api_tokens_api.APITokensApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.APITokensApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'bearerToken==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete an API Token for a user - api_instance.delete_entity_api_tokens(user_id, id) - except gooddata_api_client.ApiException as e: - print("Exception when calling APITokensApi->delete_entity_api_tokens: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete an API Token for a user api_instance.delete_entity_api_tokens(user_id, id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling APITokensApi->delete_entity_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -149,7 +138,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -159,7 +147,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_api_tokens** -> JsonApiApiTokenOutList get_all_entities_api_tokens(user_id) +> JsonApiApiTokenOutList get_all_entities_api_tokens(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) List all api tokens for a user @@ -167,11 +155,11 @@ List all api tokens for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import api_tokens_api -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -180,49 +168,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = api_tokens_api.APITokensApi(api_client) - user_id = "userId_example" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # List all api tokens for a user - api_response = api_instance.get_all_entities_api_tokens(user_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling APITokensApi->get_all_entities_api_tokens: %s\n" % e) + api_instance = gooddata_api_client.APITokensApi(api_client) + user_id = 'user_id_example' # str | + filter = 'bearerToken==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # List all api tokens for a user api_response = api_instance.get_all_entities_api_tokens(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of APITokensApi->get_all_entities_api_tokens:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling APITokensApi->get_all_entities_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **user_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -237,7 +214,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -247,7 +223,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_api_tokens** -> JsonApiApiTokenOutDocument get_entity_api_tokens(user_id, id) +> JsonApiApiTokenOutDocument get_entity_api_tokens(user_id, id, filter=filter) Get an API Token for a user @@ -255,11 +231,11 @@ Get an API Token for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import api_tokens_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -268,39 +244,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = api_tokens_api.APITokensApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.APITokensApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'bearerToken==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get an API Token for a user - api_response = api_instance.get_entity_api_tokens(user_id, id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling APITokensApi->get_entity_api_tokens: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get an API Token for a user api_response = api_instance.get_entity_api_tokens(user_id, id, filter=filter) + print("The response of APITokensApi->get_entity_api_tokens:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling APITokensApi->get_entity_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -315,7 +284,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/AbsoluteDateFilter.md b/gooddata-api-client/docs/AbsoluteDateFilter.md index 9041702f4..3f45f3a48 100644 --- a/gooddata-api-client/docs/AbsoluteDateFilter.md +++ b/gooddata-api-client/docs/AbsoluteDateFilter.md @@ -3,11 +3,28 @@ A datetime filter specifying exact from and to values. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.absolute_date_filter import AbsoluteDateFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of AbsoluteDateFilter from a JSON string +absolute_date_filter_instance = AbsoluteDateFilter.from_json(json) +# print the JSON string representation of the object +print(AbsoluteDateFilter.to_json()) + +# convert the object into a dict +absolute_date_filter_dict = absolute_date_filter_instance.to_dict() +# create an instance of AbsoluteDateFilter from a dict +absolute_date_filter_from_dict = AbsoluteDateFilter.from_dict(absolute_date_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AbsoluteDateFilterAbsoluteDateFilter.md b/gooddata-api-client/docs/AbsoluteDateFilterAbsoluteDateFilter.md index a82af8ee5..a6de7cbd4 100644 --- a/gooddata-api-client/docs/AbsoluteDateFilterAbsoluteDateFilter.md +++ b/gooddata-api-client/docs/AbsoluteDateFilterAbsoluteDateFilter.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dataset** | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | | -**_from** | **str** | | -**to** | **str** | | **apply_on_result** | **bool** | | [optional] +**dataset** | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | | +**var_from** | **str** | | **local_identifier** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**to** | **str** | | + +## Example + +```python +from gooddata_api_client.models.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of AbsoluteDateFilterAbsoluteDateFilter from a JSON string +absolute_date_filter_absolute_date_filter_instance = AbsoluteDateFilterAbsoluteDateFilter.from_json(json) +# print the JSON string representation of the object +print(AbsoluteDateFilterAbsoluteDateFilter.to_json()) +# convert the object into a dict +absolute_date_filter_absolute_date_filter_dict = absolute_date_filter_absolute_date_filter_instance.to_dict() +# create an instance of AbsoluteDateFilterAbsoluteDateFilter from a dict +absolute_date_filter_absolute_date_filter_from_dict = AbsoluteDateFilterAbsoluteDateFilter.from_dict(absolute_date_filter_absolute_date_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AbstractMeasureValueFilter.md b/gooddata-api-client/docs/AbstractMeasureValueFilter.md index d5a719c6e..872c13421 100644 --- a/gooddata-api-client/docs/AbstractMeasureValueFilter.md +++ b/gooddata-api-client/docs/AbstractMeasureValueFilter.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comparison_measure_value_filter** | [**ComparisonMeasureValueFilterComparisonMeasureValueFilter**](ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) | | [optional] -**range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | [optional] -**ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**comparison_measure_value_filter** | [**ComparisonMeasureValueFilterComparisonMeasureValueFilter**](ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) | | +**range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | +**ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | + +## Example + +```python +from gooddata_api_client.models.abstract_measure_value_filter import AbstractMeasureValueFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of AbstractMeasureValueFilter from a JSON string +abstract_measure_value_filter_instance = AbstractMeasureValueFilter.from_json(json) +# print the JSON string representation of the object +print(AbstractMeasureValueFilter.to_json()) +# convert the object into a dict +abstract_measure_value_filter_dict = abstract_measure_value_filter_instance.to_dict() +# create an instance of AbstractMeasureValueFilter from a dict +abstract_measure_value_filter_from_dict = AbstractMeasureValueFilter.from_dict(abstract_measure_value_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ActionsApi.md b/gooddata-api-client/docs/ActionsApi.md index b7471a690..9bbfc7be5 100644 --- a/gooddata-api-client/docs/ActionsApi.md +++ b/gooddata-api-client/docs/ActionsApi.md @@ -117,12 +117,12 @@ Method | HTTP request | Description ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.chat_request import ChatRequest +from gooddata_api_client.models.chat_request import ChatRequest +from gooddata_api_client.models.chat_result import ChatResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -131,44 +131,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - chat_request = ChatRequest( - limit_create=3, - limit_create_context=10, - limit_search=5, - question="question_example", - relevant_score_threshold=0.45, - search_score_threshold=0.9, - thread_id_suffix="thread_id_suffix_example", - title_to_descriptor_ratio=0.7, - user_context=UserContext( - active_object=ActiveObjectIdentification( - id="id_example", - type="type_example", - workspace_id="workspace_id_example", - ), - ), - ) # ChatRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + chat_request = gooddata_api_client.ChatRequest() # ChatRequest | + try: # (BETA) Chat with AI api_response = api_instance.ai_chat(workspace_id, chat_request) + print("The response of ActionsApi->ai_chat:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->ai_chat: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **chat_request** | [**ChatRequest**](ChatRequest.md)| | + **workspace_id** | **str**| Workspace identifier | + **chat_request** | [**ChatRequest**](ChatRequest.md)| | ### Return type @@ -183,7 +169,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -203,12 +188,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_history_request import ChatHistoryRequest +from gooddata_api_client.models.chat_history_request import ChatHistoryRequest +from gooddata_api_client.models.chat_history_result import ChatHistoryResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -217,38 +202,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - chat_history_request = ChatHistoryRequest( - chat_history_interaction_id="chat_history_interaction_id_example", - reset=True, - response_state="SUCCESSFUL", - saved_visualization=SavedVisualization( - created_visualization_id="created_visualization_id_example", - saved_visualization_id="saved_visualization_id_example", - ), - thread_id_suffix="thread_id_suffix_example", - user_feedback="POSITIVE", - ) # ChatHistoryRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + chat_history_request = gooddata_api_client.ChatHistoryRequest() # ChatHistoryRequest | + try: # (BETA) Get Chat History api_response = api_instance.ai_chat_history(workspace_id, chat_history_request) + print("The response of ActionsApi->ai_chat_history:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->ai_chat_history: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **chat_history_request** | [**ChatHistoryRequest**](ChatHistoryRequest.md)| | + **workspace_id** | **str**| Workspace identifier | + **chat_history_request** | [**ChatHistoryRequest**](ChatHistoryRequest.md)| | ### Return type @@ -263,7 +240,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -273,7 +249,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_chat_stream** -> [dict] ai_chat_stream(workspace_id, chat_request) +> List[object] ai_chat_stream(workspace_id, chat_request) (BETA) Chat with AI @@ -283,11 +259,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.chat_request import ChatRequest +from gooddata_api_client.models.chat_request import ChatRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -296,48 +272,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - chat_request = ChatRequest( - limit_create=3, - limit_create_context=10, - limit_search=5, - question="question_example", - relevant_score_threshold=0.45, - search_score_threshold=0.9, - thread_id_suffix="thread_id_suffix_example", - title_to_descriptor_ratio=0.7, - user_context=UserContext( - active_object=ActiveObjectIdentification( - id="id_example", - type="type_example", - workspace_id="workspace_id_example", - ), - ), - ) # ChatRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + chat_request = gooddata_api_client.ChatRequest() # ChatRequest | + try: # (BETA) Chat with AI api_response = api_instance.ai_chat_stream(workspace_id, chat_request) + print("The response of ActionsApi->ai_chat_stream:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->ai_chat_stream: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **chat_request** | [**ChatRequest**](ChatRequest.md)| | + **workspace_id** | **str**| Workspace identifier | + **chat_request** | [**ChatRequest**](ChatRequest.md)| | ### Return type -**[dict]** +**List[object]** ### Authorization @@ -348,7 +310,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: text/event-stream - ### HTTP response details | Status code | Description | Response headers | @@ -368,11 +329,11 @@ Returns usage statistics of chat for a user in a workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.chat_usage_response import ChatUsageResponse +from gooddata_api_client.models.chat_usage_response import ChatUsageResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -381,26 +342,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier - # example passing only required values which don't have defaults set try: # Get Chat Usage api_response = api_instance.ai_chat_usage(workspace_id) + print("The response of ActionsApi->ai_chat_usage:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->ai_chat_usage: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| Workspace identifier | ### Return type @@ -415,7 +378,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -435,12 +397,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.search_result import SearchResult -from gooddata_api_client.model.search_request import SearchRequest +from gooddata_api_client.models.search_request import SearchRequest +from gooddata_api_client.models.search_result import SearchResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -449,38 +411,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - search_request = SearchRequest( - deep_search=False, - include_hidden=False, - limit=10, - object_types=[ - "attribute", - ], - question="question_example", - relevant_score_threshold=0.3, - title_to_descriptor_ratio=0.7, - ) # SearchRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + search_request = gooddata_api_client.SearchRequest() # SearchRequest | + try: # (BETA) Semantic Search in Metadata api_response = api_instance.ai_search(workspace_id, search_request) + print("The response of ActionsApi->ai_search:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->ai_search: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **search_request** | [**SearchRequest**](SearchRequest.md)| | + **workspace_id** | **str**| Workspace identifier | + **search_request** | [**SearchRequest**](SearchRequest.md)| | ### Return type @@ -495,7 +449,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -505,7 +458,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **all_platform_usage** -> [PlatformUsage] all_platform_usage() +> List[PlatformUsage] all_platform_usage() Info about the platform usage. @@ -515,11 +468,11 @@ Provides information about platform usage, like amount of users, workspaces, ... ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage import PlatformUsage +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -528,26 +481,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) + api_instance = gooddata_api_client.ActionsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Info about the platform usage. api_response = api_instance.all_platform_usage() + print("The response of ActionsApi->all_platform_usage:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->all_platform_usage: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -[**[PlatformUsage]**](PlatformUsage.md) +[**List[PlatformUsage]**](PlatformUsage.md) ### Authorization @@ -558,7 +513,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -568,7 +522,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **anomaly_detection** -> SmartFunctionResponse anomaly_detection(workspace_id, result_id, anomaly_detection_request) +> SmartFunctionResponse anomaly_detection(workspace_id, result_id, anomaly_detection_request, skip_cache=skip_cache) (EXPERIMENTAL) Smart functions - Anomaly Detection @@ -578,12 +532,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.anomaly_detection_request import AnomalyDetectionRequest -from gooddata_api_client.model.smart_function_response import SmartFunctionResponse +from gooddata_api_client.models.anomaly_detection_request import AnomalyDetectionRequest +from gooddata_api_client.models.smart_function_response import SmartFunctionResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -592,43 +546,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "9bd52018570364264fcf62d373da6bed313120e8" # str | Input result ID to be used in the computation - anomaly_detection_request = AnomalyDetectionRequest( - sensitivity=3.14, - ) # AnomalyDetectionRequest | - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Smart functions - Anomaly Detection - api_response = api_instance.anomaly_detection(workspace_id, result_id, anomaly_detection_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->anomaly_detection: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = '9bd52018570364264fcf62d373da6bed313120e8' # str | Input result ID to be used in the computation + anomaly_detection_request = gooddata_api_client.AnomalyDetectionRequest() # AnomalyDetectionRequest | + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Smart functions - Anomaly Detection api_response = api_instance.anomaly_detection(workspace_id, result_id, anomaly_detection_request, skip_cache=skip_cache) + print("The response of ActionsApi->anomaly_detection:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->anomaly_detection: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Input result ID to be used in the computation | - **anomaly_detection_request** | [**AnomalyDetectionRequest**](AnomalyDetectionRequest.md)| | - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Input result ID to be used in the computation | + **anomaly_detection_request** | [**AnomalyDetectionRequest**](AnomalyDetectionRequest.md)| | + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] ### Return type @@ -643,7 +588,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -653,7 +597,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **anomaly_detection_result** -> AnomalyDetectionResult anomaly_detection_result(workspace_id, result_id) +> AnomalyDetectionResult anomaly_detection_result(workspace_id, result_id, offset=offset, limit=limit) (EXPERIMENTAL) Smart functions - Anomaly Detection Result @@ -663,11 +607,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.anomaly_detection_result import AnomalyDetectionResult +from gooddata_api_client.models.anomaly_detection_result import AnomalyDetectionResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -676,41 +620,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID - offset = 1 # int | (optional) - limit = 1 # int | (optional) - - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Smart functions - Anomaly Detection Result - api_response = api_instance.anomaly_detection_result(workspace_id, result_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->anomaly_detection_result: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID + offset = 56 # int | (optional) + limit = 56 # int | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Smart functions - Anomaly Detection Result api_response = api_instance.anomaly_detection_result(workspace_id, result_id, offset=offset, limit=limit) + print("The response of ActionsApi->anomaly_detection_result:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->anomaly_detection_result: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | - **offset** | **int**| | [optional] - **limit** | **int**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **offset** | **int**| | [optional] + **limit** | **int**| | [optional] ### Return type @@ -725,7 +662,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -743,11 +679,11 @@ Get Available Assignees ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.available_assignees import AvailableAssignees +from gooddata_api_client.models.available_assignees import AvailableAssignees +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -756,28 +692,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - dashboard_id = "dashboardId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + dashboard_id = 'dashboard_id_example' # str | - # example passing only required values which don't have defaults set try: # Get Available Assignees api_response = api_instance.available_assignees(workspace_id, dashboard_id) + print("The response of ActionsApi->available_assignees:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->available_assignees: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **dashboard_id** | **str**| | + **workspace_id** | **str**| | + **dashboard_id** | **str**| | ### Return type @@ -792,7 +730,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -812,11 +749,11 @@ Each cancel token corresponds to one unique execution request for the same resul ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens +from gooddata_api_client.models.afm_cancel_tokens import AfmCancelTokens +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -825,32 +762,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - afm_cancel_tokens = AfmCancelTokens( - result_id_to_cancel_token_pairs={ - "key": "key_example", - }, - ) # AfmCancelTokens | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + afm_cancel_tokens = gooddata_api_client.AfmCancelTokens() # AfmCancelTokens | + try: # Applies all the given cancel tokens. api_response = api_instance.cancel_executions(workspace_id, afm_cancel_tokens) + print("The response of ActionsApi->cancel_executions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->cancel_executions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **afm_cancel_tokens** | [**AfmCancelTokens**](AfmCancelTokens.md)| | + **workspace_id** | **str**| Workspace identifier | + **afm_cancel_tokens** | [**AfmCancelTokens**](AfmCancelTokens.md)| | ### Return type @@ -865,7 +800,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -875,7 +809,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **check_entity_overrides** -> [IdentifierDuplications] check_entity_overrides(workspace_id, hierarchy_object_identification) +> List[IdentifierDuplications] check_entity_overrides(workspace_id, hierarchy_object_identification) Finds entities with given ID in hierarchy. @@ -885,12 +819,12 @@ Finds entities with given ID in hierarchy (e.g. to check possible future conflic ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.hierarchy_object_identification import HierarchyObjectIdentification +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -899,37 +833,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - hierarchy_object_identification = [ - HierarchyObjectIdentification( - id="id_example", - type="metric", - ), - ] # [HierarchyObjectIdentification] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + hierarchy_object_identification = [gooddata_api_client.HierarchyObjectIdentification()] # List[HierarchyObjectIdentification] | + try: # Finds entities with given ID in hierarchy. api_response = api_instance.check_entity_overrides(workspace_id, hierarchy_object_identification) + print("The response of ActionsApi->check_entity_overrides:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->check_entity_overrides: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **hierarchy_object_identification** | [**[HierarchyObjectIdentification]**](HierarchyObjectIdentification.md)| | + **workspace_id** | **str**| | + **hierarchy_object_identification** | [**List[HierarchyObjectIdentification]**](HierarchyObjectIdentification.md)| | ### Return type -[**[IdentifierDuplications]**](IdentifierDuplications.md) +[**List[IdentifierDuplications]**](IdentifierDuplications.md) ### Authorization @@ -940,7 +871,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -960,11 +890,11 @@ Cleans up all translations for a particular locale. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.locale_request import LocaleRequest +from gooddata_api_client.models.locale_request import LocaleRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -973,29 +903,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - locale_request = LocaleRequest( - locale="en-US", - ) # LocaleRequest | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + locale_request = gooddata_api_client.LocaleRequest() # LocaleRequest | - # example passing only required values which don't have defaults set try: # Cleans up translations. api_instance.clean_translations(workspace_id, locale_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->clean_translations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **locale_request** | [**LocaleRequest**](LocaleRequest.md)| | + **workspace_id** | **str**| | + **locale_request** | [**LocaleRequest**](LocaleRequest.md)| | ### Return type @@ -1010,7 +939,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1020,7 +948,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **clustering** -> SmartFunctionResponse clustering(workspace_id, result_id, clustering_request) +> SmartFunctionResponse clustering(workspace_id, result_id, clustering_request, skip_cache=skip_cache) (EXPERIMENTAL) Smart functions - Clustering @@ -1030,12 +958,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.clustering_request import ClusteringRequest -from gooddata_api_client.model.smart_function_response import SmartFunctionResponse +from gooddata_api_client.models.clustering_request import ClusteringRequest +from gooddata_api_client.models.smart_function_response import SmartFunctionResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1044,44 +972,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "9bd52018570364264fcf62d373da6bed313120e8" # str | Input result ID to be used in the computation - clustering_request = ClusteringRequest( - number_of_clusters=1, - threshold=0.03, - ) # ClusteringRequest | - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Smart functions - Clustering - api_response = api_instance.clustering(workspace_id, result_id, clustering_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->clustering: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = '9bd52018570364264fcf62d373da6bed313120e8' # str | Input result ID to be used in the computation + clustering_request = gooddata_api_client.ClusteringRequest() # ClusteringRequest | + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Smart functions - Clustering api_response = api_instance.clustering(workspace_id, result_id, clustering_request, skip_cache=skip_cache) + print("The response of ActionsApi->clustering:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->clustering: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Input result ID to be used in the computation | - **clustering_request** | [**ClusteringRequest**](ClusteringRequest.md)| | - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Input result ID to be used in the computation | + **clustering_request** | [**ClusteringRequest**](ClusteringRequest.md)| | + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] ### Return type @@ -1096,7 +1014,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1106,7 +1023,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **clustering_result** -> ClusteringResult clustering_result(workspace_id, result_id) +> ClusteringResult clustering_result(workspace_id, result_id, offset=offset, limit=limit) (EXPERIMENTAL) Smart functions - Clustering Result @@ -1116,11 +1033,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.clustering_result import ClusteringResult +from gooddata_api_client.models.clustering_result import ClusteringResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1129,41 +1046,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID - offset = 1 # int | (optional) - limit = 1 # int | (optional) - - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Smart functions - Clustering Result - api_response = api_instance.clustering_result(workspace_id, result_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->clustering_result: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID + offset = 56 # int | (optional) + limit = 56 # int | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Smart functions - Clustering Result api_response = api_instance.clustering_result(workspace_id, result_id, offset=offset, limit=limit) + print("The response of ActionsApi->clustering_result:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->clustering_result: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | - **offset** | **int**| | [optional] - **limit** | **int**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **offset** | **int**| | [optional] + **limit** | **int**| | [optional] ### Return type @@ -1178,7 +1088,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1198,12 +1107,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.column_statistics_response import ColumnStatisticsResponse -from gooddata_api_client.model.column_statistics_request import ColumnStatisticsRequest +from gooddata_api_client.models.column_statistics_request import ColumnStatisticsRequest +from gooddata_api_client.models.column_statistics_response import ColumnStatisticsResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1212,40 +1121,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - data_source_id = "dataSourceId_example" # str | - column_statistics_request = ColumnStatisticsRequest( - column_name="column_name_example", - frequency=FrequencyProperties( - value_limit=10, - ), - _from=ColumnStatisticsRequestFrom(None), - histogram=HistogramProperties( - bucket_count=1, - ), - statistics=[ - "COUNT", - ], - ) # ColumnStatisticsRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + data_source_id = 'data_source_id_example' # str | + column_statistics_request = gooddata_api_client.ColumnStatisticsRequest() # ColumnStatisticsRequest | + try: # (EXPERIMENTAL) Compute column statistics api_response = api_instance.column_statistics(data_source_id, column_statistics_request) + print("The response of ActionsApi->column_statistics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->column_statistics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | - **column_statistics_request** | [**ColumnStatisticsRequest**](ColumnStatisticsRequest.md)| | + **data_source_id** | **str**| | + **column_statistics_request** | [**ColumnStatisticsRequest**](ColumnStatisticsRequest.md)| | ### Return type @@ -1260,7 +1159,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1270,7 +1168,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **compute_label_elements_post** -> ElementsResponse compute_label_elements_post(workspace_id, elements_request) +> ElementsResponse compute_label_elements_post(workspace_id, elements_request, offset=offset, limit=limit, skip_cache=skip_cache) Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. @@ -1280,12 +1178,12 @@ Returns paged list of elements (values) of given label satisfying given filterin ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.elements_request import ElementsRequest -from gooddata_api_client.model.elements_response import ElementsResponse +from gooddata_api_client.models.elements_request import ElementsRequest +from gooddata_api_client.models.elements_response import ElementsResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1294,66 +1192,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - elements_request = ElementsRequest( - cache_id="cache_id_example", - complement_filter=False, - data_sampling_percentage=100.0, - depends_on=[ - ElementsRequestDependsOnInner(None), - ], - exact_filter=[ - "exact_filter_example", - ], - exclude_primary_label=False, - filter_by=FilterBy( - label_type="REQUESTED", - ), - label="label_id", - pattern_filter="pattern_filter_example", - sort_order="ASC", - validate_by=[ - ValidateByItem( - id="id_example", - type="fact", - ), - ], - ) # ElementsRequest | - offset = 0 # int | Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. (optional) if omitted the server will use the default value of 0 - limit = 1000 # int | Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. (optional) if omitted the server will use the default value of 1000 - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. - api_response = api_instance.compute_label_elements_post(workspace_id, elements_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->compute_label_elements_post: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + elements_request = gooddata_api_client.ElementsRequest() # ElementsRequest | + offset = 0 # int | Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. (optional) (default to 0) + limit = 1000 # int | Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. (optional) (default to 1000) + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. api_response = api_instance.compute_label_elements_post(workspace_id, elements_request, offset=offset, limit=limit, skip_cache=skip_cache) + print("The response of ActionsApi->compute_label_elements_post:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->compute_label_elements_post: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **elements_request** | [**ElementsRequest**](ElementsRequest.md)| | - **offset** | **int**| Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. | [optional] if omitted the server will use the default value of 0 - **limit** | **int**| Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. | [optional] if omitted the server will use the default value of 1000 - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| Workspace identifier | + **elements_request** | [**ElementsRequest**](ElementsRequest.md)| | + **offset** | **int**| Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. | [optional] [default to 0] + **limit** | **int**| Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. | [optional] [default to 1000] + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] ### Return type @@ -1368,7 +1236,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1378,7 +1245,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **compute_report** -> AfmExecutionResponse compute_report(workspace_id, afm_execution) +> AfmExecutionResponse compute_report(workspace_id, afm_execution, skip_cache=skip_cache, timestamp=timestamp) Executes analytical request and returns link to the result @@ -1388,12 +1255,12 @@ AFM is a combination of attributes, measures and filters that describe a query y ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution_response import AfmExecutionResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1402,99 +1269,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - afm_execution = AfmExecution( - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - result_spec=ResultSpec( - dimensions=[ - Dimension( - item_identifiers=["attribute_1","measureGroup"], - local_identifier="firstDimension", - sorting=[ - SortKey(), - ], - ), - ], - totals=[ - Total( - function="SUM", - local_identifier="firstTotal", - metric="metric_1", - total_dimensions=[ - TotalDimension( - dimension_identifier="firstDimension", - total_dimension_items=["measureGroup"], - ), - ], - ), - ], - ), - settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - ) # AfmExecution | - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - timestamp = "2020-06-03T10:15:30+01:00" # str | (optional) - - # example passing only required values which don't have defaults set - try: - # Executes analytical request and returns link to the result - api_response = api_instance.compute_report(workspace_id, afm_execution) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->compute_report: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + afm_execution = gooddata_api_client.AfmExecution() # AfmExecution | + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) + timestamp = '2020-06-03T10:15:30+01:00' # str | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Executes analytical request and returns link to the result api_response = api_instance.compute_report(workspace_id, afm_execution, skip_cache=skip_cache, timestamp=timestamp) + print("The response of ActionsApi->compute_report:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->compute_report: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **afm_execution** | [**AfmExecution**](AfmExecution.md)| | - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False - **timestamp** | **str**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **afm_execution** | [**AfmExecution**](AfmExecution.md)| | + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] + **timestamp** | **str**| | [optional] ### Return type @@ -1509,7 +1311,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1529,12 +1330,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.afm_valid_descendants_query import AfmValidDescendantsQuery -from gooddata_api_client.model.afm_valid_descendants_response import AfmValidDescendantsResponse +from gooddata_api_client.models.afm_valid_descendants_query import AfmValidDescendantsQuery +from gooddata_api_client.models.afm_valid_descendants_response import AfmValidDescendantsResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1543,37 +1344,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - afm_valid_descendants_query = AfmValidDescendantsQuery( - attributes=[ - AfmObjectIdentifierAttribute( - identifier=AfmObjectIdentifierAttributeIdentifier( - id="sample_item.price", - type="attribute", - ), - ), - ], - ) # AfmValidDescendantsQuery | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + afm_valid_descendants_query = gooddata_api_client.AfmValidDescendantsQuery() # AfmValidDescendantsQuery | + try: # (BETA) Valid descendants api_response = api_instance.compute_valid_descendants(workspace_id, afm_valid_descendants_query) + print("The response of ActionsApi->compute_valid_descendants:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->compute_valid_descendants: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **afm_valid_descendants_query** | [**AfmValidDescendantsQuery**](AfmValidDescendantsQuery.md)| | + **workspace_id** | **str**| Workspace identifier | + **afm_valid_descendants_query** | [**AfmValidDescendantsQuery**](AfmValidDescendantsQuery.md)| | ### Return type @@ -1588,7 +1382,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1608,12 +1401,12 @@ Returns list containing attributes, facts, or metrics, which can be added to giv ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.afm_valid_objects_query import AfmValidObjectsQuery -from gooddata_api_client.model.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.models.afm_valid_objects_query import AfmValidObjectsQuery +from gooddata_api_client.models.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1622,61 +1415,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - afm_valid_objects_query = AfmValidObjectsQuery( - afm=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - types=[ - "facts", - ], - ) # AfmValidObjectsQuery | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + afm_valid_objects_query = gooddata_api_client.AfmValidObjectsQuery() # AfmValidObjectsQuery | + try: # Valid objects api_response = api_instance.compute_valid_objects(workspace_id, afm_valid_objects_query) + print("The response of ActionsApi->compute_valid_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->compute_valid_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **afm_valid_objects_query** | [**AfmValidObjectsQuery**](AfmValidObjectsQuery.md)| | + **workspace_id** | **str**| Workspace identifier | + **afm_valid_objects_query** | [**AfmValidObjectsQuery**](AfmValidObjectsQuery.md)| | ### Return type @@ -1691,7 +1453,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1711,12 +1472,12 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.dashboard_tabular_export_request import DashboardTabularExportRequest +from gooddata_api_client.models.dashboard_tabular_export_request import DashboardTabularExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1725,45 +1486,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - dashboard_id = "dashboardId_example" # str | - dashboard_tabular_export_request = DashboardTabularExportRequest( - dashboard_filters_override=[ - DashboardFilter(), - ], - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ) # DashboardTabularExportRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + dashboard_id = 'dashboard_id_example' # str | + dashboard_tabular_export_request = gooddata_api_client.DashboardTabularExportRequest() # DashboardTabularExportRequest | + try: # (EXPERIMENTAL) Create dashboard tabular export request api_response = api_instance.create_dashboard_export_request(workspace_id, dashboard_id, dashboard_tabular_export_request) + print("The response of ActionsApi->create_dashboard_export_request:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->create_dashboard_export_request: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **dashboard_id** | **str**| | - **dashboard_tabular_export_request** | [**DashboardTabularExportRequest**](DashboardTabularExportRequest.md)| | + **workspace_id** | **str**| | + **dashboard_id** | **str**| | + **dashboard_tabular_export_request** | [**DashboardTabularExportRequest**](DashboardTabularExportRequest.md)| | ### Return type @@ -1778,7 +1526,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1798,12 +1545,12 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.image_export_request import ImageExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.image_export_request import ImageExportRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1812,36 +1559,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - image_export_request = ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ) # ImageExportRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + image_export_request = gooddata_api_client.ImageExportRequest() # ImageExportRequest | + try: # (EXPERIMENTAL) Create image export request api_response = api_instance.create_image_export(workspace_id, image_export_request) + print("The response of ActionsApi->create_image_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->create_image_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **image_export_request** | [**ImageExportRequest**](ImageExportRequest.md)| | + **workspace_id** | **str**| | + **image_export_request** | [**ImageExportRequest**](ImageExportRequest.md)| | ### Return type @@ -1856,7 +1597,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1876,11 +1616,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.memory_item import MemoryItem +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1889,45 +1629,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - memory_item = MemoryItem( - id="id_example", - instruction="instruction_example", - keywords=[ - "keywords_example", - ], - strategy="MEMORY_ITEM_STRATEGY_ALLWAYS", - use_cases=MemoryItemUseCases( - general=True, - howto=True, - keywords=True, - metric=True, - normalize=True, - router=True, - search=True, - visualization=True, - ), - ) # MemoryItem | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + memory_item = gooddata_api_client.MemoryItem() # MemoryItem | + try: # (EXPERIMENTAL) Create new memory item api_response = api_instance.create_memory_item(workspace_id, memory_item) + print("The response of ActionsApi->create_memory_item:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->create_memory_item: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **memory_item** | [**MemoryItem**](MemoryItem.md)| | + **workspace_id** | **str**| Workspace identifier | + **memory_item** | [**MemoryItem**](MemoryItem.md)| | ### Return type @@ -1942,7 +1667,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1952,7 +1676,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_pdf_export** -> ExportResponse create_pdf_export(workspace_id, visual_export_request) +> ExportResponse create_pdf_export(workspace_id, visual_export_request, x_gdc_debug=x_gdc_debug) Create visual - pdf export request @@ -1962,12 +1686,12 @@ An visual export job will be created based on the export request and put to queu ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.visual_export_request import VisualExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.visual_export_request import VisualExportRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1976,43 +1700,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - visual_export_request = VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ) # VisualExportRequest | - x_gdc_debug = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Create visual - pdf export request - api_response = api_instance.create_pdf_export(workspace_id, visual_export_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->create_pdf_export: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + visual_export_request = gooddata_api_client.VisualExportRequest() # VisualExportRequest | + x_gdc_debug = False # bool | (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # Create visual - pdf export request api_response = api_instance.create_pdf_export(workspace_id, visual_export_request, x_gdc_debug=x_gdc_debug) + print("The response of ActionsApi->create_pdf_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->create_pdf_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **visual_export_request** | [**VisualExportRequest**](VisualExportRequest.md)| | - **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| | + **visual_export_request** | [**VisualExportRequest**](VisualExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] [default to False] ### Return type @@ -2027,7 +1740,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -2047,12 +1759,12 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.raw_export_request import RawExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.raw_export_request import RawExportRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2061,76 +1773,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - raw_export_request = RawExportRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - ) # RawExportRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + raw_export_request = gooddata_api_client.RawExportRequest() # RawExportRequest | + try: # (EXPERIMENTAL) Create raw export request api_response = api_instance.create_raw_export(workspace_id, raw_export_request) + print("The response of ActionsApi->create_raw_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->create_raw_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **raw_export_request** | [**RawExportRequest**](RawExportRequest.md)| | + **workspace_id** | **str**| | + **raw_export_request** | [**RawExportRequest**](RawExportRequest.md)| | ### Return type @@ -2145,7 +1811,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -2155,7 +1820,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_slides_export** -> ExportResponse create_slides_export(workspace_id, slides_export_request) +> ExportResponse create_slides_export(workspace_id, slides_export_request, x_gdc_debug=x_gdc_debug) (EXPERIMENTAL) Create slides export request @@ -2165,12 +1830,12 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.slides_export_request import SlidesExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.slides_export_request import SlidesExportRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2179,51 +1844,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - slides_export_request = SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ) # SlidesExportRequest | - x_gdc_debug = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Create slides export request - api_response = api_instance.create_slides_export(workspace_id, slides_export_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->create_slides_export: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + slides_export_request = gooddata_api_client.SlidesExportRequest() # SlidesExportRequest | + x_gdc_debug = False # bool | (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Create slides export request api_response = api_instance.create_slides_export(workspace_id, slides_export_request, x_gdc_debug=x_gdc_debug) + print("The response of ActionsApi->create_slides_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->create_slides_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **slides_export_request** | [**SlidesExportRequest**](SlidesExportRequest.md)| | - **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| | + **slides_export_request** | [**SlidesExportRequest**](SlidesExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] [default to False] ### Return type @@ -2238,7 +1884,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -2258,12 +1903,12 @@ An tabular export job will be created based on the export request and put to que ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2272,72 +1917,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - tabular_export_request = TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ) # TabularExportRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + tabular_export_request = gooddata_api_client.TabularExportRequest() # TabularExportRequest | + try: # Create tabular export request api_response = api_instance.create_tabular_export(workspace_id, tabular_export_request) + print("The response of ActionsApi->create_tabular_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->create_tabular_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **tabular_export_request** | [**TabularExportRequest**](TabularExportRequest.md)| | + **workspace_id** | **str**| | + **tabular_export_request** | [**TabularExportRequest**](TabularExportRequest.md)| | ### Return type @@ -2352,7 +1955,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -2370,11 +1972,11 @@ Get Dashboard Permissions ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.dashboard_permissions import DashboardPermissions +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2383,28 +1985,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - dashboard_id = "dashboardId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + dashboard_id = 'dashboard_id_example' # str | - # example passing only required values which don't have defaults set try: # Get Dashboard Permissions api_response = api_instance.dashboard_permissions(workspace_id, dashboard_id) + print("The response of ActionsApi->dashboard_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->dashboard_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **dashboard_id** | **str**| | + **workspace_id** | **str**| | + **dashboard_id** | **str**| | ### Return type @@ -2419,7 +2023,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -2437,11 +2040,11 @@ Delete selected automations across all workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2450,32 +2053,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( - automations=[ - OrganizationAutomationIdentifier( - id="id_example", - workspace_id="workspace_id_example", - ), - ], - ) # OrganizationAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + organization_automation_management_bulk_request = gooddata_api_client.OrganizationAutomationManagementBulkRequest() # OrganizationAutomationManagementBulkRequest | + try: # Delete selected automations across all workspaces api_instance.delete_organization_automations(organization_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->delete_organization_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | ### Return type @@ -2490,7 +2087,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2508,11 +2104,11 @@ Delete selected automations in the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2521,33 +2117,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( - automations=[ - WorkspaceAutomationIdentifier( - id="id_example", - ), - ], - ) # WorkspaceAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + workspace_automation_management_bulk_request = gooddata_api_client.WorkspaceAutomationManagementBulkRequest() # WorkspaceAutomationManagementBulkRequest | + try: # Delete selected automations in the workspace api_instance.delete_workspace_automations(workspace_id, workspace_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->delete_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | ### Return type @@ -2562,7 +2153,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2572,7 +2162,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **explain_afm** -> explain_afm(workspace_id, afm_execution) +> explain_afm(workspace_id, afm_execution, explain_type=explain_type) AFM explain resource. @@ -2582,11 +2172,11 @@ The resource provides static structures needed for investigation of a problem wi ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution import AfmExecution +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2595,95 +2185,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - afm_execution = AfmExecution( - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - result_spec=ResultSpec( - dimensions=[ - Dimension( - item_identifiers=["attribute_1","measureGroup"], - local_identifier="firstDimension", - sorting=[ - SortKey(), - ], - ), - ], - totals=[ - Total( - function="SUM", - local_identifier="firstTotal", - metric="metric_1", - total_dimensions=[ - TotalDimension( - dimension_identifier="firstDimension", - total_dimension_items=["measureGroup"], - ), - ], - ), - ], - ), - settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - ) # AfmExecution | - explain_type = "MAQL" # str | Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request (optional) - - # example passing only required values which don't have defaults set - try: - # AFM explain resource. - api_instance.explain_afm(workspace_id, afm_execution) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->explain_afm: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + afm_execution = gooddata_api_client.AfmExecution() # AfmExecution | + explain_type = 'explain_type_example' # str | Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request (optional) - # example passing only required values which don't have defaults set - # and optional values try: # AFM explain resource. api_instance.explain_afm(workspace_id, afm_execution, explain_type=explain_type) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->explain_afm: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **afm_execution** | [**AfmExecution**](AfmExecution.md)| | - **explain_type** | **str**| Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request | [optional] + **workspace_id** | **str**| Workspace identifier | + **afm_execution** | [**AfmExecution**](AfmExecution.md)| | + **explain_type** | **str**| Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request | [optional] ### Return type @@ -2698,7 +2223,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json, application/sql, application/zip, image/svg+xml - ### HTTP response details | Status code | Description | Response headers | @@ -2708,7 +2232,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **forecast** -> SmartFunctionResponse forecast(workspace_id, result_id, forecast_request) +> SmartFunctionResponse forecast(workspace_id, result_id, forecast_request, skip_cache=skip_cache) (BETA) Smart functions - Forecast @@ -2718,12 +2242,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.forecast_request import ForecastRequest -from gooddata_api_client.model.smart_function_response import SmartFunctionResponse +from gooddata_api_client.models.forecast_request import ForecastRequest +from gooddata_api_client.models.smart_function_response import SmartFunctionResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2732,45 +2256,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "9bd52018570364264fcf62d373da6bed313120e8" # str | Input result ID to be used in the computation - forecast_request = ForecastRequest( - confidence_level=0.95, - forecast_period=1, - seasonal=False, - ) # ForecastRequest | - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # (BETA) Smart functions - Forecast - api_response = api_instance.forecast(workspace_id, result_id, forecast_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->forecast: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = '9bd52018570364264fcf62d373da6bed313120e8' # str | Input result ID to be used in the computation + forecast_request = gooddata_api_client.ForecastRequest() # ForecastRequest | + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # (BETA) Smart functions - Forecast api_response = api_instance.forecast(workspace_id, result_id, forecast_request, skip_cache=skip_cache) + print("The response of ActionsApi->forecast:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->forecast: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Input result ID to be used in the computation | - **forecast_request** | [**ForecastRequest**](ForecastRequest.md)| | - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Input result ID to be used in the computation | + **forecast_request** | [**ForecastRequest**](ForecastRequest.md)| | + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] ### Return type @@ -2785,7 +2298,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -2795,7 +2307,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **forecast_result** -> ForecastResult forecast_result(workspace_id, result_id) +> ForecastResult forecast_result(workspace_id, result_id, offset=offset, limit=limit) (BETA) Smart functions - Forecast Result @@ -2805,11 +2317,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.forecast_result import ForecastResult +from gooddata_api_client.models.forecast_result import ForecastResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2818,41 +2330,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID - offset = 1 # int | (optional) - limit = 1 # int | (optional) - - # example passing only required values which don't have defaults set - try: - # (BETA) Smart functions - Forecast Result - api_response = api_instance.forecast_result(workspace_id, result_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->forecast_result: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID + offset = 56 # int | (optional) + limit = 56 # int | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # (BETA) Smart functions - Forecast Result api_response = api_instance.forecast_result(workspace_id, result_id, offset=offset, limit=limit) + print("The response of ActionsApi->forecast_result:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->forecast_result: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | - **offset** | **int**| | [optional] - **limit** | **int**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **offset** | **int**| | [optional] + **limit** | **int**| | [optional] ### Return type @@ -2867,7 +2372,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -2887,12 +2391,12 @@ Generate logical data model (LDM) from physical data model (PDM) stored in data ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.declarative_model import DeclarativeModel -from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2901,90 +2405,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - data_source_id = "dataSourceId_example" # str | - generate_ldm_request = GenerateLdmRequest( - aggregated_fact_prefix="aggr", - date_granularities="all", - denorm_prefix="dr", - fact_prefix="f", - generate_long_ids=False, - grain_multivalue_reference_prefix="grmr", - grain_prefix="gr", - grain_reference_prefix="grr", - multivalue_reference_prefix="mr", - pdm=PdmLdmRequest( - sqls=[ - PdmSql( - columns=[ - SqlColumn( - data_type="INT", - name="customer_id", - ), - ], - statement="select * from abc", - title="My special dataset", - ), - ], - table_overrides=[ - TableOverride( - columns=[ - ColumnOverride( - label_target_column="users", - label_type="HYPERLINK", - ldm_type_override="FACT", - name="column_name", - ), - ], - path=["schema","table_name"], - ), - ], - tables=[ - DeclarativeTable( - columns=[ - DeclarativeColumn( - data_type="INT", - is_primary_key=True, - name="customer_id", - referenced_table_column="customer_id", - referenced_table_id="customers", - ), - ], - id="customers", - name_prefix="out_gooddata", - path=["table_schema","table_name"], - type="TABLE", - ), - ], - ), - primary_label_prefix="pl", - reference_prefix="r", - secondary_label_prefix="ls", - separator="__", - table_prefix="out_table", - view_prefix="out_view", - wdf_prefix="wdf", - workspace_id="workspace_id_example", - ) # GenerateLdmRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + data_source_id = 'data_source_id_example' # str | + generate_ldm_request = gooddata_api_client.GenerateLdmRequest() # GenerateLdmRequest | + try: # Generate logical data model (LDM) from physical data model (PDM) api_response = api_instance.generate_logical_model(data_source_id, generate_ldm_request) + print("The response of ActionsApi->generate_logical_model:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->generate_logical_model: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | - **generate_ldm_request** | [**GenerateLdmRequest**](GenerateLdmRequest.md)| | + **data_source_id** | **str**| | + **generate_ldm_request** | [**GenerateLdmRequest**](GenerateLdmRequest.md)| | ### Return type @@ -2999,7 +2443,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -3019,11 +2462,11 @@ It scans a database and reads metadata. The result of the request contains a lis ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.data_source_schemata import DataSourceSchemata +from gooddata_api_client.models.data_source_schemata import DataSourceSchemata +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3032,26 +2475,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - data_source_id = "myPostgres" # str | Data source id + api_instance = gooddata_api_client.ActionsApi(api_client) + data_source_id = 'myPostgres' # str | Data source id - # example passing only required values which don't have defaults set try: # Get a list of schema names of a database api_response = api_instance.get_data_source_schemata(data_source_id) + print("The response of ActionsApi->get_data_source_schemata:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_data_source_schemata: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| Data source id | + **data_source_id** | **str**| Data source id | ### Return type @@ -3066,7 +2511,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -3086,11 +2530,11 @@ Computes the dependent entities graph ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3099,26 +2543,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Computes the dependent entities graph api_response = api_instance.get_dependent_entities_graph(workspace_id) + print("The response of ActionsApi->get_dependent_entities_graph:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_dependent_entities_graph: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type @@ -3133,7 +2579,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -3153,12 +2598,12 @@ Computes the dependent entities graph from given entry points ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3167,35 +2612,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - dependent_entities_request = DependentEntitiesRequest( - identifiers=[ - EntityIdentifier( - id="/6bUUGjjNSwg0_bs", - type="metric", - ), - ], - ) # DependentEntitiesRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + dependent_entities_request = gooddata_api_client.DependentEntitiesRequest() # DependentEntitiesRequest | + try: # Computes the dependent entities graph from given entry points api_response = api_instance.get_dependent_entities_graph_from_entry_points(workspace_id, dependent_entities_request) + print("The response of ActionsApi->get_dependent_entities_graph_from_entry_points:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_dependent_entities_graph_from_entry_points: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **dependent_entities_request** | [**DependentEntitiesRequest**](DependentEntitiesRequest.md)| | + **workspace_id** | **str**| | + **dependent_entities_request** | [**DependentEntitiesRequest**](DependentEntitiesRequest.md)| | ### Return type @@ -3210,7 +2650,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -3220,7 +2659,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_exported_file** -> file_type get_exported_file(workspace_id, export_id) +> bytearray get_exported_file(workspace_id, export_id) Retrieve exported files @@ -3230,10 +2669,10 @@ Returns 202 until original POST export request is not processed.Returns 200 with ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3242,32 +2681,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # Retrieve exported files api_response = api_instance.get_exported_file(workspace_id, export_id) + print("The response of ActionsApi->get_exported_file:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_exported_file: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -**file_type** +**bytearray** ### Authorization @@ -3278,7 +2719,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/pdf - ### HTTP response details | Status code | Description | Response headers | @@ -3289,7 +2729,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_image_export** -> file_type get_image_export(workspace_id, export_id) +> bytearray get_image_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -3299,11 +2739,10 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3312,32 +2751,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files api_response = api_instance.get_image_export(workspace_id, export_id) + print("The response of ActionsApi->get_image_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_image_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -**file_type** +**bytearray** ### Authorization @@ -3348,7 +2789,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: image/png - ### HTTP response details | Status code | Description | Response headers | @@ -3369,10 +2809,10 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3381,27 +2821,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve metadata context api_instance.get_image_export_metadata(workspace_id, export_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_image_export_metadata: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type @@ -3416,7 +2857,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -3436,11 +2876,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.memory_item import MemoryItem +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3449,28 +2889,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - memory_id = "memoryId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + memory_id = 'memory_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Get memory item api_response = api_instance.get_memory_item(workspace_id, memory_id) + print("The response of ActionsApi->get_memory_item:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_memory_item: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **memory_id** | **str**| | + **workspace_id** | **str**| Workspace identifier | + **memory_id** | **str**| | ### Return type @@ -3485,7 +2927,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -3505,10 +2946,10 @@ This endpoint serves as a cache for user-defined metadata of the export for the ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3517,27 +2958,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # Retrieve metadata context api_instance.get_metadata(workspace_id, export_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_metadata: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type @@ -3552,7 +2994,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -3562,7 +3003,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_notifications** -> Notifications get_notifications() +> Notifications get_notifications(workspace_id=workspace_id, is_read=is_read, page=page, size=size, meta_include=meta_include) Get latest notifications. @@ -3572,11 +3013,11 @@ Get latest in-platform notifications for the current user. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.notifications import Notifications +from gooddata_api_client.models.notifications import Notifications +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3585,37 +3026,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | Workspace ID to filter notifications by. (optional) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace ID to filter notifications by. (optional) is_read = True # bool | Filter notifications by read status. (optional) - page = "0" # str | Zero-based page index (0..N) (optional) if omitted the server will use the default value of "0" - size = "20" # str | The size of the page to be returned. (optional) if omitted the server will use the default value of "20" - meta_include = [ - "total", - ] # [str] | Additional meta information to include in the response. (optional) - - # example passing only required values which don't have defaults set - # and optional values + page = '0' # str | Zero-based page index (0..N) (optional) (default to '0') + size = '20' # str | The size of the page to be returned. (optional) (default to '20') + meta_include = ['meta_include_example'] # List[str] | Additional meta information to include in the response. (optional) + try: # Get latest notifications. api_response = api_instance.get_notifications(workspace_id=workspace_id, is_read=is_read, page=page, size=size, meta_include=meta_include) + print("The response of ActionsApi->get_notifications:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_notifications: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace ID to filter notifications by. | [optional] - **is_read** | **bool**| Filter notifications by read status. | [optional] - **page** | **str**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of "0" - **size** | **str**| The size of the page to be returned. | [optional] if omitted the server will use the default value of "20" - **meta_include** | **[str]**| Additional meta information to include in the response. | [optional] + **workspace_id** | **str**| Workspace ID to filter notifications by. | [optional] + **is_read** | **bool**| Filter notifications by read status. | [optional] + **page** | **str**| Zero-based page index (0..N) | [optional] [default to '0'] + **size** | **str**| The size of the page to be returned. | [optional] [default to '20'] + **meta_include** | [**List[str]**](str.md)| Additional meta information to include in the response. | [optional] ### Return type @@ -3630,7 +3070,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -3650,11 +3089,11 @@ Returns metadata quality issues detected by the platform linter. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse +from gooddata_api_client.models.get_quality_issues_response import GetQualityIssuesResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3663,26 +3102,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier - # example passing only required values which don't have defaults set try: # Get Quality Issues api_response = api_instance.get_quality_issues(workspace_id) + print("The response of ActionsApi->get_quality_issues:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_quality_issues: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| Workspace identifier | ### Return type @@ -3697,7 +3138,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -3707,7 +3147,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_raw_export** -> file_type get_raw_export(workspace_id, export_id) +> bytearray get_raw_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -3717,10 +3157,10 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3729,32 +3169,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files api_response = api_instance.get_raw_export(workspace_id, export_id) + print("The response of ActionsApi->get_raw_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_raw_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -**file_type** +**bytearray** ### Authorization @@ -3765,7 +3207,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.apache.arrow.file, application/vnd.apache.arrow.stream, text/csv - ### HTTP response details | Status code | Description | Response headers | @@ -3776,7 +3217,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_slides_export** -> file_type get_slides_export(workspace_id, export_id) +> bytearray get_slides_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -3786,11 +3227,10 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3799,32 +3239,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files api_response = api_instance.get_slides_export(workspace_id, export_id) + print("The response of ActionsApi->get_slides_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_slides_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -**file_type** +**bytearray** ### Authorization @@ -3835,7 +3277,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation - ### HTTP response details | Status code | Description | Response headers | @@ -3856,10 +3297,10 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3868,27 +3309,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve metadata context api_instance.get_slides_export_metadata(workspace_id, export_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_slides_export_metadata: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type @@ -3903,7 +3345,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -3913,7 +3354,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_tabular_export** -> file_type get_tabular_export(workspace_id, export_id) +> bytearray get_tabular_export(workspace_id, export_id) Retrieve exported files @@ -3923,10 +3364,10 @@ After clients creates a POST export request, the processing of it will start sho ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3935,32 +3376,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # Retrieve exported files api_response = api_instance.get_tabular_export(workspace_id, export_id) + print("The response of ActionsApi->get_tabular_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_tabular_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -**file_type** +**bytearray** ### Authorization @@ -3971,7 +3414,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, text/csv, text/html - ### HTTP response details | Status code | Description | Response headers | @@ -3982,7 +3424,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_translation_tags** -> [str] get_translation_tags(workspace_id) +> List[str] get_translation_tags(workspace_id) Get translation tags. @@ -3992,10 +3434,10 @@ Provides a list of effective translation tags. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4004,30 +3446,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Get translation tags. api_response = api_instance.get_translation_tags(workspace_id) + print("The response of ActionsApi->get_translation_tags:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->get_translation_tags: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type -**[str]** +**List[str]** ### Authorization @@ -4038,7 +3482,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -4048,7 +3491,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **inherited_entity_conflicts** -> [IdentifierDuplications] inherited_entity_conflicts(workspace_id) +> List[IdentifierDuplications] inherited_entity_conflicts(workspace_id) Finds identifier conflicts in workspace hierarchy. @@ -4058,11 +3501,11 @@ Finds API identifier conflicts in given workspace hierarchy. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4071,30 +3514,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Finds identifier conflicts in workspace hierarchy. api_response = api_instance.inherited_entity_conflicts(workspace_id) + print("The response of ActionsApi->inherited_entity_conflicts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->inherited_entity_conflicts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type -[**[IdentifierDuplications]**](IdentifierDuplications.md) +[**List[IdentifierDuplications]**](IdentifierDuplications.md) ### Authorization @@ -4105,7 +3550,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -4115,7 +3559,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **inherited_entity_prefixes** -> [str] inherited_entity_prefixes(workspace_id) +> List[str] inherited_entity_prefixes(workspace_id) Get used entity prefixes in hierarchy @@ -4125,10 +3569,10 @@ Get used entity prefixes in hierarchy of parent workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4137,30 +3581,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Get used entity prefixes in hierarchy api_response = api_instance.inherited_entity_prefixes(workspace_id) + print("The response of ActionsApi->inherited_entity_prefixes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->inherited_entity_prefixes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type -**[str]** +**List[str]** ### Authorization @@ -4171,7 +3617,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -4181,7 +3626,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **key_driver_analysis** -> KeyDriversResponse key_driver_analysis(workspace_id, key_drivers_request) +> KeyDriversResponse key_driver_analysis(workspace_id, key_drivers_request, skip_cache=skip_cache) (EXPERIMENTAL) Compute key driver analysis @@ -4191,12 +3636,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.key_drivers_response import KeyDriversResponse -from gooddata_api_client.model.key_drivers_request import KeyDriversRequest +from gooddata_api_client.models.key_drivers_request import KeyDriversRequest +from gooddata_api_client.models.key_drivers_response import KeyDriversResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4205,51 +3650,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - key_drivers_request = KeyDriversRequest( - aux_metrics=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - metric=MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - sort_direction="DESC", - ) # KeyDriversRequest | - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Compute key driver analysis - api_response = api_instance.key_driver_analysis(workspace_id, key_drivers_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->key_driver_analysis: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + key_drivers_request = gooddata_api_client.KeyDriversRequest() # KeyDriversRequest | + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Compute key driver analysis api_response = api_instance.key_driver_analysis(workspace_id, key_drivers_request, skip_cache=skip_cache) + print("The response of ActionsApi->key_driver_analysis:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->key_driver_analysis: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **key_drivers_request** | [**KeyDriversRequest**](KeyDriversRequest.md)| | - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| Workspace identifier | + **key_drivers_request** | [**KeyDriversRequest**](KeyDriversRequest.md)| | + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] ### Return type @@ -4264,7 +3690,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -4274,7 +3699,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **key_driver_analysis_result** -> KeyDriversResult key_driver_analysis_result(workspace_id, result_id) +> KeyDriversResult key_driver_analysis_result(workspace_id, result_id, offset=offset, limit=limit) (EXPERIMENTAL) Get key driver analysis result @@ -4284,11 +3709,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.key_drivers_result import KeyDriversResult +from gooddata_api_client.models.key_drivers_result import KeyDriversResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4297,41 +3722,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID - offset = 1 # int | (optional) - limit = 1 # int | (optional) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID + offset = 56 # int | (optional) + limit = 56 # int | (optional) - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Get key driver analysis result - api_response = api_instance.key_driver_analysis_result(workspace_id, result_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->key_driver_analysis_result: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Get key driver analysis result api_response = api_instance.key_driver_analysis_result(workspace_id, result_id, offset=offset, limit=limit) + print("The response of ActionsApi->key_driver_analysis_result:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->key_driver_analysis_result: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | - **offset** | **int**| | [optional] - **limit** | **int**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **offset** | **int**| | [optional] + **limit** | **int**| | [optional] ### Return type @@ -4346,7 +3764,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -4356,7 +3773,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **list_memory_items** -> [MemoryItem] list_memory_items(workspace_id) +> List[MemoryItem] list_memory_items(workspace_id) (EXPERIMENTAL) List all memory items @@ -4366,11 +3783,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.memory_item import MemoryItem +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4379,30 +3796,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) List all memory items api_response = api_instance.list_memory_items(workspace_id) + print("The response of ActionsApi->list_memory_items:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->list_memory_items: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| Workspace identifier | ### Return type -[**[MemoryItem]**](MemoryItem.md) +[**List[MemoryItem]**](MemoryItem.md) ### Authorization @@ -4413,7 +3832,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -4423,7 +3841,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **list_workspace_user_groups** -> WorkspaceUserGroups list_workspace_user_groups(workspace_id) +> WorkspaceUserGroups list_workspace_user_groups(workspace_id, page=page, size=size, name=name) @@ -4431,11 +3849,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.workspace_user_groups import WorkspaceUserGroups +from gooddata_api_client.models.workspace_user_groups import WorkspaceUserGroups +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4444,39 +3862,33 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - page = page=0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = size=20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 - name = "name=charles" # str | Filter by user name. Note that user name is case insensitive. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.list_workspace_user_groups(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->list_workspace_user_groups: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned. (optional) (default to 20) + name = 'name=charles' # str | Filter by user name. Note that user name is case insensitive. (optional) - # example passing only required values which don't have defaults set - # and optional values try: api_response = api_instance.list_workspace_user_groups(workspace_id, page=page, size=size, name=name) + print("The response of ActionsApi->list_workspace_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->list_workspace_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 - **name** | **str**| Filter by user name. Note that user name is case insensitive. | [optional] + **workspace_id** | **str**| | + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned. | [optional] [default to 20] + **name** | **str**| Filter by user name. Note that user name is case insensitive. | [optional] ### Return type @@ -4491,7 +3903,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -4501,7 +3912,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **list_workspace_users** -> WorkspaceUsers list_workspace_users(workspace_id) +> WorkspaceUsers list_workspace_users(workspace_id, page=page, size=size, name=name) @@ -4509,11 +3920,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.workspace_users import WorkspaceUsers +from gooddata_api_client.models.workspace_users import WorkspaceUsers +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4522,39 +3933,33 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - page = page=0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = size=20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 - name = "name=charles" # str | Filter by user name. Note that user name is case insensitive. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.list_workspace_users(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->list_workspace_users: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned. (optional) (default to 20) + name = 'name=charles' # str | Filter by user name. Note that user name is case insensitive. (optional) - # example passing only required values which don't have defaults set - # and optional values try: api_response = api_instance.list_workspace_users(workspace_id, page=page, size=size, name=name) + print("The response of ActionsApi->list_workspace_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->list_workspace_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 - **name** | **str**| Filter by user name. Note that user name is case insensitive. | [optional] + **workspace_id** | **str**| | + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned. | [optional] [default to 20] + **name** | **str**| Filter by user name. Note that user name is case insensitive. | [optional] ### Return type @@ -4569,7 +3974,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -4587,11 +3991,11 @@ Manage Permissions for a Dashboard ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.models.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4600,31 +4004,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - dashboard_id = "dashboardId_example" # str | - manage_dashboard_permissions_request_inner = [ - ManageDashboardPermissionsRequestInner(None), - ] # [ManageDashboardPermissionsRequestInner] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + dashboard_id = 'dashboard_id_example' # str | + manage_dashboard_permissions_request_inner = [gooddata_api_client.ManageDashboardPermissionsRequestInner()] # List[ManageDashboardPermissionsRequestInner] | + try: # Manage Permissions for a Dashboard api_instance.manage_dashboard_permissions(workspace_id, dashboard_id, manage_dashboard_permissions_request_inner) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->manage_dashboard_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **dashboard_id** | **str**| | - **manage_dashboard_permissions_request_inner** | [**[ManageDashboardPermissionsRequestInner]**](ManageDashboardPermissionsRequestInner.md)| | + **workspace_id** | **str**| | + **dashboard_id** | **str**| | + **manage_dashboard_permissions_request_inner** | [**List[ManageDashboardPermissionsRequestInner]**](ManageDashboardPermissionsRequestInner.md)| | ### Return type @@ -4639,7 +4042,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4659,11 +4061,11 @@ Manage Permissions for a Data Source ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment +from gooddata_api_client.models.data_source_permission_assignment import DataSourcePermissionAssignment +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4672,37 +4074,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - data_source_id = "dataSourceId_example" # str | - data_source_permission_assignment = [ - DataSourcePermissionAssignment( - assignee_identifier=AssigneeIdentifier( - id="id_example", - type="user", - ), - permissions=[ - "MANAGE", - ], - ), - ] # [DataSourcePermissionAssignment] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + data_source_id = 'data_source_id_example' # str | + data_source_permission_assignment = [gooddata_api_client.DataSourcePermissionAssignment()] # List[DataSourcePermissionAssignment] | + try: # Manage Permissions for a Data Source api_instance.manage_data_source_permissions(data_source_id, data_source_permission_assignment) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->manage_data_source_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | - **data_source_permission_assignment** | [**[DataSourcePermissionAssignment]**](DataSourcePermissionAssignment.md)| | + **data_source_id** | **str**| | + **data_source_permission_assignment** | [**List[DataSourcePermissionAssignment]**](DataSourcePermissionAssignment.md)| | ### Return type @@ -4717,7 +4110,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4737,11 +4129,11 @@ Manage Permissions for a Organization ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment +from gooddata_api_client.models.organization_permission_assignment import OrganizationPermissionAssignment +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4750,35 +4142,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - organization_permission_assignment = [ - OrganizationPermissionAssignment( - assignee_identifier=AssigneeIdentifier( - id="id_example", - type="user", - ), - permissions=[ - "MANAGE", - ], - ), - ] # [OrganizationPermissionAssignment] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + organization_permission_assignment = [gooddata_api_client.OrganizationPermissionAssignment()] # List[OrganizationPermissionAssignment] | + try: # Manage Permissions for a Organization api_instance.manage_organization_permissions(organization_permission_assignment) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->manage_organization_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organization_permission_assignment** | [**[OrganizationPermissionAssignment]**](OrganizationPermissionAssignment.md)| | + **organization_permission_assignment** | [**List[OrganizationPermissionAssignment]**](OrganizationPermissionAssignment.md)| | ### Return type @@ -4793,7 +4176,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4813,11 +4195,11 @@ Manage Permissions for a Workspace and its Workspace Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment +from gooddata_api_client.models.workspace_permission_assignment import WorkspacePermissionAssignment +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4826,40 +4208,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - workspace_permission_assignment = [ - WorkspacePermissionAssignment( - assignee_identifier=AssigneeIdentifier( - id="id_example", - type="user", - ), - hierarchy_permissions=[ - "MANAGE", - ], - permissions=[ - "MANAGE", - ], - ), - ] # [WorkspacePermissionAssignment] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + workspace_permission_assignment = [gooddata_api_client.WorkspacePermissionAssignment()] # List[WorkspacePermissionAssignment] | + try: # Manage Permissions for a Workspace api_instance.manage_workspace_permissions(workspace_id, workspace_permission_assignment) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->manage_workspace_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **workspace_permission_assignment** | [**[WorkspacePermissionAssignment]**](WorkspacePermissionAssignment.md)| | + **workspace_id** | **str**| | + **workspace_permission_assignment** | [**List[WorkspacePermissionAssignment]**](WorkspacePermissionAssignment.md)| | ### Return type @@ -4874,7 +4244,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4894,10 +4263,10 @@ Mark in-platform notification by its ID as read. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4906,25 +4275,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - notification_id = "notificationId_example" # str | Notification ID to mark as read. + api_instance = gooddata_api_client.ActionsApi(api_client) + notification_id = 'notification_id_example' # str | Notification ID to mark as read. - # example passing only required values which don't have defaults set try: # Mark notification as read. api_instance.mark_as_read_notification(notification_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->mark_as_read_notification: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **notification_id** | **str**| Notification ID to mark as read. | + **notification_id** | **str**| Notification ID to mark as read. | ### Return type @@ -4939,7 +4309,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4949,7 +4318,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **mark_as_read_notification_all** -> mark_as_read_notification_all() +> mark_as_read_notification_all(workspace_id=workspace_id) Mark all notifications as read. @@ -4959,10 +4328,10 @@ Mark all user in-platform notifications as read. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4971,26 +4340,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | Workspace ID where to mark notifications as read. (optional) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace ID where to mark notifications as read. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Mark all notifications as read. api_instance.mark_as_read_notification_all(workspace_id=workspace_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->mark_as_read_notification_all: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace ID where to mark notifications as read. | [optional] + **workspace_id** | **str**| Workspace ID where to mark notifications as read. | [optional] ### Return type @@ -5005,7 +4374,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5025,10 +4393,10 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5037,25 +4405,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # (BETA) Sync Metadata to other services api_instance.metadata_sync(workspace_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->metadata_sync: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type @@ -5070,7 +4439,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5090,10 +4458,10 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5102,20 +4470,21 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) + api_instance = gooddata_api_client.ActionsApi(api_client) - # example, this endpoint has no required or optional parameters try: # (BETA) Sync organization scope Metadata to other services api_instance.metadata_sync_organization() - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->metadata_sync_organization: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -5131,7 +4500,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5141,7 +4509,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **overridden_child_entities** -> [IdentifierDuplications] overridden_child_entities(workspace_id) +> List[IdentifierDuplications] overridden_child_entities(workspace_id) Finds identifier overrides in workspace hierarchy. @@ -5151,11 +4519,11 @@ Finds API identifier overrides in given workspace hierarchy. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5164,30 +4532,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Finds identifier overrides in workspace hierarchy. api_response = api_instance.overridden_child_entities(workspace_id) + print("The response of ActionsApi->overridden_child_entities:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->overridden_child_entities: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type -[**[IdentifierDuplications]**](IdentifierDuplications.md) +[**List[IdentifierDuplications]**](IdentifierDuplications.md) ### Authorization @@ -5198,7 +4568,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -5208,7 +4577,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **particular_platform_usage** -> [PlatformUsage] particular_platform_usage(platform_usage_request) +> List[PlatformUsage] particular_platform_usage(platform_usage_request) Info about the platform usage for particular items. @@ -5218,12 +4587,12 @@ Provides information about platform usage, like amount of users, workspaces, ... ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage_request import PlatformUsageRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5232,34 +4601,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - platform_usage_request = PlatformUsageRequest( - usage_item_names=[ - "UserCount", - ], - ) # PlatformUsageRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + platform_usage_request = gooddata_api_client.PlatformUsageRequest() # PlatformUsageRequest | + try: # Info about the platform usage for particular items. api_response = api_instance.particular_platform_usage(platform_usage_request) + print("The response of ActionsApi->particular_platform_usage:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->particular_platform_usage: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **platform_usage_request** | [**PlatformUsageRequest**](PlatformUsageRequest.md)| | + **platform_usage_request** | [**PlatformUsageRequest**](PlatformUsageRequest.md)| | ### Return type -[**[PlatformUsage]**](PlatformUsage.md) +[**List[PlatformUsage]**](PlatformUsage.md) ### Authorization @@ -5270,7 +4637,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -5288,11 +4654,11 @@ Pause selected automations across all workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5301,32 +4667,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( - automations=[ - OrganizationAutomationIdentifier( - id="id_example", - workspace_id="workspace_id_example", - ), - ], - ) # OrganizationAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + organization_automation_management_bulk_request = gooddata_api_client.OrganizationAutomationManagementBulkRequest() # OrganizationAutomationManagementBulkRequest | + try: # Pause selected automations across all workspaces api_instance.pause_organization_automations(organization_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->pause_organization_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | ### Return type @@ -5341,7 +4701,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5359,11 +4718,11 @@ Pause selected automations in the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5372,33 +4731,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( - automations=[ - WorkspaceAutomationIdentifier( - id="id_example", - ), - ], - ) # WorkspaceAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + workspace_automation_management_bulk_request = gooddata_api_client.WorkspaceAutomationManagementBulkRequest() # WorkspaceAutomationManagementBulkRequest | + try: # Pause selected automations in the workspace api_instance.pause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->pause_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | ### Return type @@ -5413,7 +4767,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5433,10 +4786,10 @@ Notification sets up all reports to be computed again with new data. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5445,25 +4798,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - data_source_id = "dataSourceId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + data_source_id = 'data_source_id_example' # str | - # example passing only required values which don't have defaults set try: # Register an upload notification api_instance.register_upload_notification(data_source_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->register_upload_notification: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | + **data_source_id** | **str**| | ### Return type @@ -5478,7 +4832,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5498,10 +4851,10 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5510,27 +4863,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - memory_id = "memoryId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + memory_id = 'memory_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Remove memory item api_instance.remove_memory_item(workspace_id, memory_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->remove_memory_item: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **memory_id** | **str**| | + **workspace_id** | **str**| Workspace identifier | + **memory_id** | **str**| | ### Return type @@ -5545,7 +4899,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5555,7 +4908,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **resolve_all_entitlements** -> [ApiEntitlement] resolve_all_entitlements() +> List[ApiEntitlement] resolve_all_entitlements() Values for all public entitlements. @@ -5565,11 +4918,11 @@ Resolves values of available entitlements for the organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.api_entitlement import ApiEntitlement +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5578,26 +4931,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) + api_instance = gooddata_api_client.ActionsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Values for all public entitlements. api_response = api_instance.resolve_all_entitlements() + print("The response of ActionsApi->resolve_all_entitlements:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->resolve_all_entitlements: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -[**[ApiEntitlement]**](ApiEntitlement.md) +[**List[ApiEntitlement]**](ApiEntitlement.md) ### Authorization @@ -5608,7 +4963,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -5618,7 +4972,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **resolve_all_settings_without_workspace** -> [ResolvedSetting] resolve_all_settings_without_workspace() +> List[ResolvedSetting] resolve_all_settings_without_workspace() Values for all settings without workspace. @@ -5628,11 +4982,11 @@ Resolves values for all settings without workspace by current user, organization ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5641,26 +4995,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) + api_instance = gooddata_api_client.ActionsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Values for all settings without workspace. api_response = api_instance.resolve_all_settings_without_workspace() + print("The response of ActionsApi->resolve_all_settings_without_workspace:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->resolve_all_settings_without_workspace: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -[**[ResolvedSetting]**](ResolvedSetting.md) +[**List[ResolvedSetting]**](ResolvedSetting.md) ### Authorization @@ -5671,7 +5027,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -5691,11 +5046,11 @@ Returns a list of available LLM Endpoints ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.resolved_llm_endpoints import ResolvedLlmEndpoints +from gooddata_api_client.models.resolved_llm_endpoints import ResolvedLlmEndpoints +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5704,26 +5059,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier - # example passing only required values which don't have defaults set try: # Get Active LLM Endpoints for this workspace api_response = api_instance.resolve_llm_endpoints(workspace_id) + print("The response of ActionsApi->resolve_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->resolve_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| Workspace identifier | ### Return type @@ -5738,7 +5095,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -5748,7 +5104,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **resolve_requested_entitlements** -> [ApiEntitlement] resolve_requested_entitlements(entitlements_request) +> List[ApiEntitlement] resolve_requested_entitlements(entitlements_request) Values for requested public entitlements. @@ -5758,12 +5114,12 @@ Resolves values for requested entitlements in the organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.api_entitlement import ApiEntitlement -from gooddata_api_client.model.entitlements_request import EntitlementsRequest +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.models.entitlements_request import EntitlementsRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5772,34 +5128,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - entitlements_request = EntitlementsRequest( - entitlements_name=[ - "CacheStrategy", - ], - ) # EntitlementsRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + entitlements_request = gooddata_api_client.EntitlementsRequest() # EntitlementsRequest | + try: # Values for requested public entitlements. api_response = api_instance.resolve_requested_entitlements(entitlements_request) + print("The response of ActionsApi->resolve_requested_entitlements:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->resolve_requested_entitlements: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **entitlements_request** | [**EntitlementsRequest**](EntitlementsRequest.md)| | + **entitlements_request** | [**EntitlementsRequest**](EntitlementsRequest.md)| | ### Return type -[**[ApiEntitlement]**](ApiEntitlement.md) +[**List[ApiEntitlement]**](ApiEntitlement.md) ### Authorization @@ -5810,7 +5164,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -5820,7 +5173,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **resolve_settings_without_workspace** -> [ResolvedSetting] resolve_settings_without_workspace(resolve_settings_request) +> List[ResolvedSetting] resolve_settings_without_workspace(resolve_settings_request) Values for selected settings without workspace. @@ -5830,12 +5183,12 @@ Resolves values for selected settings without workspace by current user, organiz ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5844,32 +5197,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - resolve_settings_request = ResolveSettingsRequest( - settings=["timezone"], - ) # ResolveSettingsRequest | + api_instance = gooddata_api_client.ActionsApi(api_client) + resolve_settings_request = gooddata_api_client.ResolveSettingsRequest() # ResolveSettingsRequest | - # example passing only required values which don't have defaults set try: # Values for selected settings without workspace. api_response = api_instance.resolve_settings_without_workspace(resolve_settings_request) + print("The response of ActionsApi->resolve_settings_without_workspace:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->resolve_settings_without_workspace: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **resolve_settings_request** | [**ResolveSettingsRequest**](ResolveSettingsRequest.md)| | + **resolve_settings_request** | [**ResolveSettingsRequest**](ResolveSettingsRequest.md)| | ### Return type -[**[ResolvedSetting]**](ResolvedSetting.md) +[**List[ResolvedSetting]**](ResolvedSetting.md) ### Authorization @@ -5880,7 +5233,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -5900,11 +5252,11 @@ The resource provides execution result's metadata as AFM and resultSpec used in ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.models.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5913,28 +5265,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID - # example passing only required values which don't have defaults set try: # Get a single execution result's metadata. api_response = api_instance.retrieve_execution_metadata(workspace_id, result_id) + print("The response of ActionsApi->retrieve_execution_metadata:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->retrieve_execution_metadata: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | ### Return type @@ -5949,7 +5303,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -5959,7 +5312,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **retrieve_result** -> ExecutionResult retrieve_result(workspace_id, result_id) +> ExecutionResult retrieve_result(workspace_id, result_id, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions, x_gdc_cancel_token=x_gdc_cancel_token) Get a single execution result @@ -5969,11 +5322,11 @@ Gets a single execution result. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.execution_result import ExecutionResult +from gooddata_api_client.models.execution_result import ExecutionResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5982,51 +5335,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID - offset = [ - offset=1,10, - ] # [int] | Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. (optional) if omitted the server will use the default value of [] - limit = [ - limit=1,10, - ] # [int] | Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. (optional) if omitted the server will use the default value of [] - excluded_total_dimensions = [ - "excludedTotalDimensions=dim_0,dim_1", - ] # [str] | Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. (optional) if omitted the server will use the default value of [] - x_gdc_cancel_token = "X-GDC-CANCEL-TOKEN_example" # str | (optional) - - # example passing only required values which don't have defaults set - try: - # Get a single execution result - api_response = api_instance.retrieve_result(workspace_id, result_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->retrieve_result: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID + offset = [] # List[int] | Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. (optional) (default to []) + limit = [] # List[int] | Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. (optional) (default to []) + excluded_total_dimensions = [] # List[str] | Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. (optional) (default to []) + x_gdc_cancel_token = 'x_gdc_cancel_token_example' # str | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a single execution result api_response = api_instance.retrieve_result(workspace_id, result_id, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions, x_gdc_cancel_token=x_gdc_cancel_token) + print("The response of ActionsApi->retrieve_result:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->retrieve_result: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | - **offset** | **[int]**| Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. | [optional] if omitted the server will use the default value of [] - **limit** | **[int]**| Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. | [optional] if omitted the server will use the default value of [] - **excluded_total_dimensions** | **[str]**| Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. | [optional] if omitted the server will use the default value of [] - **x_gdc_cancel_token** | **str**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **offset** | [**List[int]**](int.md)| Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. | [optional] [default to []] + **limit** | [**List[int]**](int.md)| Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. | [optional] [default to []] + **excluded_total_dimensions** | [**List[str]**](str.md)| Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. | [optional] [default to []] + **x_gdc_cancel_token** | **str**| | [optional] ### Return type @@ -6041,7 +5381,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -6061,12 +5400,12 @@ Retrieve all translation for existing entities in a particular locale. The sourc ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.locale_request import LocaleRequest -from gooddata_api_client.model.xliff import Xliff +from gooddata_api_client.models.locale_request import LocaleRequest +from gooddata_api_client.models.xliff import Xliff +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6075,30 +5414,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - locale_request = LocaleRequest( - locale="en-US", - ) # LocaleRequest | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + locale_request = gooddata_api_client.LocaleRequest() # LocaleRequest | - # example passing only required values which don't have defaults set try: # Retrieve translations for entities. api_response = api_instance.retrieve_translations(workspace_id, locale_request) + print("The response of ActionsApi->retrieve_translations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->retrieve_translations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **locale_request** | [**LocaleRequest**](LocaleRequest.md)| | + **workspace_id** | **str**| | + **locale_request** | [**LocaleRequest**](LocaleRequest.md)| | ### Return type @@ -6113,7 +5452,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/xml - ### HTTP response details | Status code | Description | Response headers | @@ -6133,12 +5471,12 @@ It scans a database and transforms its metadata to a declarative definition of t ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.scan_request import ScanRequest -from gooddata_api_client.model.scan_result_pdm import ScanResultPdm +from gooddata_api_client.models.scan_request import ScanRequest +from gooddata_api_client.models.scan_result_pdm import ScanResultPdm +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6147,35 +5485,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - data_source_id = "myPostgres" # str | Data source id - scan_request = ScanRequest( - scan_tables=True, - scan_views=True, - schemata=["tpch","demo"], - separator="__", - table_prefix="out_table", - view_prefix="out_view", - ) # ScanRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + data_source_id = 'myPostgres' # str | Data source id + scan_request = gooddata_api_client.ScanRequest() # ScanRequest | + try: # Scan a database to get a physical data model (PDM) api_response = api_instance.scan_data_source(data_source_id, scan_request) + print("The response of ActionsApi->scan_data_source:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->scan_data_source: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| Data source id | - **scan_request** | [**ScanRequest**](ScanRequest.md)| | + **data_source_id** | **str**| Data source id | + **scan_request** | [**ScanRequest**](ScanRequest.md)| | ### Return type @@ -6190,7 +5523,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -6210,12 +5542,12 @@ It executes SQL query against specified data source and extracts metadata. Metad ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.scan_sql_response import ScanSqlResponse -from gooddata_api_client.model.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6224,30 +5556,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - data_source_id = "myPostgres" # str | Data source id - scan_sql_request = ScanSqlRequest( - sql="SELECT a.special_value as result FROM tableA a", - ) # ScanSqlRequest | + api_instance = gooddata_api_client.ActionsApi(api_client) + data_source_id = 'myPostgres' # str | Data source id + scan_sql_request = gooddata_api_client.ScanSqlRequest() # ScanSqlRequest | - # example passing only required values which don't have defaults set try: # Collect metadata about SQL query api_response = api_instance.scan_sql(data_source_id, scan_sql_request) + print("The response of ActionsApi->scan_sql:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->scan_sql: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| Data source id | - **scan_sql_request** | [**ScanSqlRequest**](ScanSqlRequest.md)| | + **data_source_id** | **str**| Data source id | + **scan_sql_request** | [**ScanSqlRequest**](ScanSqlRequest.md)| | ### Return type @@ -6262,7 +5594,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -6282,11 +5613,11 @@ Set translation for existing entities in a particular locale. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.xliff import Xliff +from gooddata_api_client.models.xliff import Xliff +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6295,75 +5626,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - xliff = Xliff( - file=[ - File( - any=[ - {}, - ], - can_resegment="YES", - id="id_example", - notes=Notes( - note=[ - Note( - applies_to="SOURCE", - category="category_example", - content="content_example", - id="id_example", - other_attributes={ - "key": "key_example", - }, - priority=1, - ), - ], - ), - original="original_example", - other_attributes={ - "key": "key_example", - }, - skeleton=Skeleton( - content=[ - {}, - ], - href="href_example", - ), - space="space_example", - src_dir="LTR", - translate="YES", - trg_dir="LTR", - unit_or_group=[ - {}, - ], - ), - ], - other_attributes={ - "key": "key_example", - }, - space="space_example", - src_lang="src_lang_example", - trg_lang="trg_lang_example", - version="version_example", - ) # Xliff | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + xliff = gooddata_api_client.Xliff() # Xliff | + try: # Set translations for entities. api_instance.set_translations(workspace_id, xliff) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->set_translations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **xliff** | [**Xliff**](Xliff.md)| | + **workspace_id** | **str**| | + **xliff** | [**Xliff**](Xliff.md)| | ### Return type @@ -6378,7 +5662,6 @@ No authorization required - **Content-Type**: application/xml - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -6398,11 +5681,11 @@ Switch the active identity provider for the organization. Requires MANAGE permis ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.switch_identity_provider_request import SwitchIdentityProviderRequest +from gooddata_api_client.models.switch_identity_provider_request import SwitchIdentityProviderRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6411,27 +5694,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - switch_identity_provider_request = SwitchIdentityProviderRequest( - idp_id="my-idp-123", - ) # SwitchIdentityProviderRequest | + api_instance = gooddata_api_client.ActionsApi(api_client) + switch_identity_provider_request = gooddata_api_client.SwitchIdentityProviderRequest() # SwitchIdentityProviderRequest | - # example passing only required values which don't have defaults set try: # Switch Active Identity Provider api_instance.switch_active_identity_provider(switch_identity_provider_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->switch_active_identity_provider: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **switch_identity_provider_request** | [**SwitchIdentityProviderRequest**](SwitchIdentityProviderRequest.md)| | + **switch_identity_provider_request** | [**SwitchIdentityProviderRequest**](SwitchIdentityProviderRequest.md)| | ### Return type @@ -6446,7 +5728,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -6466,11 +5747,11 @@ Returns a list of tags for this workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags +from gooddata_api_client.models.analytics_catalog_tags import AnalyticsCatalogTags +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6479,26 +5760,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier - # example passing only required values which don't have defaults set try: # Get Analytics Catalog Tags api_response = api_instance.tags(workspace_id) + print("The response of ActionsApi->tags:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->tags: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| Workspace identifier | ### Return type @@ -6513,7 +5796,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -6533,12 +5815,12 @@ Test if it is possible to connect to a database using an existing data source de ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_request import TestRequest +from gooddata_api_client.models.test_request import TestRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6547,44 +5829,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - data_source_id = "myPostgres" # str | Data source id - test_request = TestRequest( - client_id="client_id_example", - client_secret="client_secret_example", - parameters=[ - DataSourceParameter( - name="name_example", - value="value_example", - ), - ], - password="admin123", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="public", - token="token_example", - url="jdbc:postgresql://localhost:5432/db_name", - username="dbadmin", - ) # TestRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + data_source_id = 'myPostgres' # str | Data source id + test_request = gooddata_api_client.TestRequest() # TestRequest | + try: # Test data source connection by data source id api_response = api_instance.test_data_source(data_source_id, test_request) + print("The response of ActionsApi->test_data_source:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->test_data_source: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| Data source id | - **test_request** | [**TestRequest**](TestRequest.md)| | + **data_source_id** | **str**| Data source id | + **test_request** | [**TestRequest**](TestRequest.md)| | ### Return type @@ -6599,7 +5867,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -6619,12 +5886,12 @@ Test if it is possible to connect to a database using a connection provided by t ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6633,43 +5900,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - test_definition_request = TestDefinitionRequest( - client_id="client_id_example", - client_secret="client_secret_example", - parameters=[ - DataSourceParameter( - name="name_example", - value="value_example", - ), - ], - password="admin123", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="public", - token="token_example", - type="POSTGRESQL", - url="jdbc:postgresql://localhost:5432/db_name", - username="dbadmin", - ) # TestDefinitionRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + test_definition_request = gooddata_api_client.TestDefinitionRequest() # TestDefinitionRequest | + try: # Test connection by data source definition api_response = api_instance.test_data_source_definition(test_definition_request) + print("The response of ActionsApi->test_data_source_definition:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->test_data_source_definition: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **test_definition_request** | [**TestDefinitionRequest**](TestDefinitionRequest.md)| | + **test_definition_request** | [**TestDefinitionRequest**](TestDefinitionRequest.md)| | ### Return type @@ -6684,7 +5936,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -6694,7 +5945,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **test_existing_notification_channel** -> TestResponse test_existing_notification_channel(notification_channel_id) +> TestResponse test_existing_notification_channel(notification_channel_id, test_destination_request=test_destination_request) Test existing notification channel. @@ -6704,12 +5955,12 @@ Tests the existing notification channel by sending a test notification. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6718,44 +5969,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - notification_channel_id = "notificationChannelId_example" # str | - test_destination_request = TestDestinationRequest( - destination=DeclarativeNotificationChannelDestination(None), - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - ) # TestDestinationRequest | (optional) - - # example passing only required values which don't have defaults set - try: - # Test existing notification channel. - api_response = api_instance.test_existing_notification_channel(notification_channel_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->test_existing_notification_channel: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + notification_channel_id = 'notification_channel_id_example' # str | + test_destination_request = gooddata_api_client.TestDestinationRequest() # TestDestinationRequest | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Test existing notification channel. api_response = api_instance.test_existing_notification_channel(notification_channel_id, test_destination_request=test_destination_request) + print("The response of ActionsApi->test_existing_notification_channel:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->test_existing_notification_channel: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **notification_channel_id** | **str**| | - **test_destination_request** | [**TestDestinationRequest**](TestDestinationRequest.md)| | [optional] + **notification_channel_id** | **str**| | + **test_destination_request** | [**TestDestinationRequest**](TestDestinationRequest.md)| | [optional] ### Return type @@ -6770,7 +6007,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -6790,12 +6026,12 @@ Tests the notification channel by sending a test notification. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6804,33 +6040,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - test_destination_request = TestDestinationRequest( - destination=DeclarativeNotificationChannelDestination(None), - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - ) # TestDestinationRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + test_destination_request = gooddata_api_client.TestDestinationRequest() # TestDestinationRequest | + try: # Test notification channel. api_response = api_instance.test_notification_channel(test_destination_request) + print("The response of ActionsApi->test_notification_channel:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->test_notification_channel: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **test_destination_request** | [**TestDestinationRequest**](TestDestinationRequest.md)| | + **test_destination_request** | [**TestDestinationRequest**](TestDestinationRequest.md)| | ### Return type @@ -6845,7 +6076,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -6865,11 +6095,11 @@ Trigger the automation in the request. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest +from gooddata_api_client.models.trigger_automation_request import TriggerAutomationRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6878,261 +6108,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - trigger_automation_request = TriggerAutomationRequest( - automation=AdHocAutomation( - alert=AutomationAlert( - condition=AutomationAlertCondition(None), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - dashboard_tabular_exports=[ - AutomationDashboardTabularExport( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={ - "key": "key_example", - }, - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - image_exports=[ - AutomationImageExport( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=AutomationMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - notification_channel=DeclarativeNotificationChannelIdentifier( - id="webhook123", - type="notificationChannel", - ), - raw_exports=[ - AutomationRawExport( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - recipients=[ - DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ], - slides_exports=[ - AutomationSlidesExport( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - tabular_exports=[ - AutomationTabularExport( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=["Revenue","Sales"], - title="title_example", - visual_exports=[ - AutomationVisualExport( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - ) # TriggerAutomationRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + trigger_automation_request = gooddata_api_client.TriggerAutomationRequest() # TriggerAutomationRequest | + try: # Trigger automation. api_instance.trigger_automation(workspace_id, trigger_automation_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->trigger_automation: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **trigger_automation_request** | [**TriggerAutomationRequest**](TriggerAutomationRequest.md)| | + **workspace_id** | **str**| | + **trigger_automation_request** | [**TriggerAutomationRequest**](TriggerAutomationRequest.md)| | ### Return type @@ -7147,7 +6144,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -7167,10 +6163,10 @@ Trigger the existing automation to execute immediately. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7179,27 +6175,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - automation_id = "automationId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + automation_id = 'automation_id_example' # str | - # example passing only required values which don't have defaults set try: # Trigger existing automation. api_instance.trigger_existing_automation(workspace_id, automation_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->trigger_existing_automation: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **automation_id** | **str**| | + **workspace_id** | **str**| | + **automation_id** | **str**| | ### Return type @@ -7214,7 +6211,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -7232,11 +6228,11 @@ Unpause selected automations across all workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7245,32 +6241,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( - automations=[ - OrganizationAutomationIdentifier( - id="id_example", - workspace_id="workspace_id_example", - ), - ], - ) # OrganizationAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + organization_automation_management_bulk_request = gooddata_api_client.OrganizationAutomationManagementBulkRequest() # OrganizationAutomationManagementBulkRequest | + try: # Unpause selected automations across all workspaces api_instance.unpause_organization_automations(organization_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->unpause_organization_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | ### Return type @@ -7285,7 +6275,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -7303,11 +6292,11 @@ Unpause selected automations in the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7316,33 +6305,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( - automations=[ - WorkspaceAutomationIdentifier( - id="id_example", - ), - ], - ) # WorkspaceAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + workspace_automation_management_bulk_request = gooddata_api_client.WorkspaceAutomationManagementBulkRequest() # WorkspaceAutomationManagementBulkRequest | + try: # Unpause selected automations in the workspace api_instance.unpause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->unpause_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | ### Return type @@ -7357,7 +6341,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -7375,10 +6358,10 @@ Unsubscribe from all automations in all workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7387,20 +6370,21 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) + api_instance = gooddata_api_client.ActionsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Unsubscribe from all automations in all workspaces api_instance.unsubscribe_all_automations() - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->unsubscribe_all_automations: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -7416,7 +6400,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -7434,10 +6417,10 @@ Unsubscribe from an automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7446,27 +6429,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - automation_id = "automationId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + automation_id = 'automation_id_example' # str | - # example passing only required values which don't have defaults set try: # Unsubscribe from an automation api_instance.unsubscribe_automation(workspace_id, automation_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->unsubscribe_automation: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **automation_id** | **str**| | + **workspace_id** | **str**| | + **automation_id** | **str**| | ### Return type @@ -7481,7 +6465,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -7499,11 +6482,11 @@ Unsubscribe from selected automations across all workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7512,32 +6495,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( - automations=[ - OrganizationAutomationIdentifier( - id="id_example", - workspace_id="workspace_id_example", - ), - ], - ) # OrganizationAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + organization_automation_management_bulk_request = gooddata_api_client.OrganizationAutomationManagementBulkRequest() # OrganizationAutomationManagementBulkRequest | + try: # Unsubscribe from selected automations across all workspaces api_instance.unsubscribe_organization_automations(organization_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->unsubscribe_organization_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | ### Return type @@ -7552,7 +6529,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -7570,11 +6546,11 @@ Unsubscribe from selected automations in the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7583,33 +6559,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( - automations=[ - WorkspaceAutomationIdentifier( - id="id_example", - ), - ], - ) # WorkspaceAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + workspace_automation_management_bulk_request = gooddata_api_client.WorkspaceAutomationManagementBulkRequest() # WorkspaceAutomationManagementBulkRequest | + try: # Unsubscribe from selected automations in the workspace api_instance.unsubscribe_selected_workspace_automations(workspace_id, workspace_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->unsubscribe_selected_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | ### Return type @@ -7624,7 +6595,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -7642,10 +6612,10 @@ Unsubscribe from all automations in the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7654,25 +6624,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Unsubscribe from all automations in the workspace api_instance.unsubscribe_workspace_automations(workspace_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->unsubscribe_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type @@ -7687,7 +6658,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -7707,11 +6677,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.memory_item import MemoryItem +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7720,47 +6690,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - memory_id = "memoryId_example" # str | - memory_item = MemoryItem( - id="id_example", - instruction="instruction_example", - keywords=[ - "keywords_example", - ], - strategy="MEMORY_ITEM_STRATEGY_ALLWAYS", - use_cases=MemoryItemUseCases( - general=True, - howto=True, - keywords=True, - metric=True, - normalize=True, - router=True, - search=True, - visualization=True, - ), - ) # MemoryItem | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + memory_id = 'memory_id_example' # str | + memory_item = gooddata_api_client.MemoryItem() # MemoryItem | + try: # (EXPERIMENTAL) Update memory item api_response = api_instance.update_memory_item(workspace_id, memory_id, memory_item) + print("The response of ActionsApi->update_memory_item:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->update_memory_item: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **memory_id** | **str**| | - **memory_item** | [**MemoryItem**](MemoryItem.md)| | + **workspace_id** | **str**| Workspace identifier | + **memory_id** | **str**| | + **memory_item** | [**MemoryItem**](MemoryItem.md)| | ### Return type @@ -7775,7 +6730,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -7795,12 +6749,12 @@ Validates LLM endpoint with provided parameters. ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse -from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest +from gooddata_api_client.models.validate_llm_endpoint_request import ValidateLLMEndpointRequest +from gooddata_api_client.models.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7809,32 +6763,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - validate_llm_endpoint_request = ValidateLLMEndpointRequest( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="provider_example", - token="token_example", - ) # ValidateLLMEndpointRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ActionsApi(api_client) + validate_llm_endpoint_request = gooddata_api_client.ValidateLLMEndpointRequest() # ValidateLLMEndpointRequest | + try: # Validate LLM Endpoint api_response = api_instance.validate_llm_endpoint(validate_llm_endpoint_request) + print("The response of ActionsApi->validate_llm_endpoint:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->validate_llm_endpoint: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **validate_llm_endpoint_request** | [**ValidateLLMEndpointRequest**](ValidateLLMEndpointRequest.md)| | + **validate_llm_endpoint_request** | [**ValidateLLMEndpointRequest**](ValidateLLMEndpointRequest.md)| | ### Return type @@ -7849,7 +6799,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -7859,7 +6808,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **validate_llm_endpoint_by_id** -> ValidateLLMEndpointResponse validate_llm_endpoint_by_id(llm_endpoint_id) +> ValidateLLMEndpointResponse validate_llm_endpoint_by_id(llm_endpoint_id, validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request) Validate LLM Endpoint By Id @@ -7869,12 +6818,12 @@ Validates existing LLM endpoint with provided parameters and updates it if they ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse -from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest +from gooddata_api_client.models.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest +from gooddata_api_client.models.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7883,43 +6832,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - llm_endpoint_id = "llmEndpointId_example" # str | - validate_llm_endpoint_by_id_request = ValidateLLMEndpointByIdRequest( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="provider_example", - token="token_example", - ) # ValidateLLMEndpointByIdRequest | (optional) - - # example passing only required values which don't have defaults set - try: - # Validate LLM Endpoint By Id - api_response = api_instance.validate_llm_endpoint_by_id(llm_endpoint_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->validate_llm_endpoint_by_id: %s\n" % e) + api_instance = gooddata_api_client.ActionsApi(api_client) + llm_endpoint_id = 'llm_endpoint_id_example' # str | + validate_llm_endpoint_by_id_request = gooddata_api_client.ValidateLLMEndpointByIdRequest() # ValidateLLMEndpointByIdRequest | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Validate LLM Endpoint By Id api_response = api_instance.validate_llm_endpoint_by_id(llm_endpoint_id, validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request) + print("The response of ActionsApi->validate_llm_endpoint_by_id:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->validate_llm_endpoint_by_id: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **llm_endpoint_id** | **str**| | - **validate_llm_endpoint_by_id_request** | [**ValidateLLMEndpointByIdRequest**](ValidateLLMEndpointByIdRequest.md)| | [optional] + **llm_endpoint_id** | **str**| | + **validate_llm_endpoint_by_id_request** | [**ValidateLLMEndpointByIdRequest**](ValidateLLMEndpointByIdRequest.md)| | [optional] ### Return type @@ -7934,7 +6870,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -7944,7 +6879,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **workspace_resolve_all_settings** -> [ResolvedSetting] workspace_resolve_all_settings(workspace_id) +> List[ResolvedSetting] workspace_resolve_all_settings(workspace_id) Values for all settings. @@ -7954,11 +6889,11 @@ Resolves values for all settings in a workspace by current user, workspace, orga ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7967,30 +6902,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Values for all settings. api_response = api_instance.workspace_resolve_all_settings(workspace_id) + print("The response of ActionsApi->workspace_resolve_all_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->workspace_resolve_all_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type -[**[ResolvedSetting]**](ResolvedSetting.md) +[**List[ResolvedSetting]**](ResolvedSetting.md) ### Authorization @@ -8001,7 +6938,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -8011,7 +6947,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **workspace_resolve_settings** -> [ResolvedSetting] workspace_resolve_settings(workspace_id, resolve_settings_request) +> List[ResolvedSetting] workspace_resolve_settings(workspace_id, resolve_settings_request) Values for selected settings. @@ -8021,12 +6957,12 @@ Resolves value for selected settings in a workspace by current user, workspace, ```python -import time import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8035,34 +6971,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | - resolve_settings_request = ResolveSettingsRequest( - settings=["timezone"], - ) # ResolveSettingsRequest | + api_instance = gooddata_api_client.ActionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + resolve_settings_request = gooddata_api_client.ResolveSettingsRequest() # ResolveSettingsRequest | - # example passing only required values which don't have defaults set try: # Values for selected settings. api_response = api_instance.workspace_resolve_settings(workspace_id, resolve_settings_request) + print("The response of ActionsApi->workspace_resolve_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ActionsApi->workspace_resolve_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **resolve_settings_request** | [**ResolveSettingsRequest**](ResolveSettingsRequest.md)| | + **workspace_id** | **str**| | + **resolve_settings_request** | [**ResolveSettingsRequest**](ResolveSettingsRequest.md)| | ### Return type -[**[ResolvedSetting]**](ResolvedSetting.md) +[**List[ResolvedSetting]**](ResolvedSetting.md) ### Authorization @@ -8073,7 +7009,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ActiveObjectIdentification.md b/gooddata-api-client/docs/ActiveObjectIdentification.md index d9a2475ae..c09964b2d 100644 --- a/gooddata-api-client/docs/ActiveObjectIdentification.md +++ b/gooddata-api-client/docs/ActiveObjectIdentification.md @@ -3,13 +3,30 @@ Object, with which the user is actively working. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Object ID. | **type** | **str** | Object type, e.g. dashboard. | **workspace_id** | **str** | Workspace ID. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.active_object_identification import ActiveObjectIdentification + +# TODO update the JSON string below +json = "{}" +# create an instance of ActiveObjectIdentification from a JSON string +active_object_identification_instance = ActiveObjectIdentification.from_json(json) +# print the JSON string representation of the object +print(ActiveObjectIdentification.to_json()) + +# convert the object into a dict +active_object_identification_dict = active_object_identification_instance.to_dict() +# create an instance of ActiveObjectIdentification from a dict +active_object_identification_from_dict = ActiveObjectIdentification.from_dict(active_object_identification_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AdHocAutomation.md b/gooddata-api-client/docs/AdHocAutomation.md index 260008b58..7ae238bd2 100644 --- a/gooddata-api-client/docs/AdHocAutomation.md +++ b/gooddata-api-client/docs/AdHocAutomation.md @@ -2,26 +2,43 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **alert** | [**AutomationAlert**](AutomationAlert.md) | | [optional] **analytical_dashboard** | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | | [optional] -**dashboard_tabular_exports** | [**[AutomationDashboardTabularExport]**](AutomationDashboardTabularExport.md) | | [optional] +**dashboard_tabular_exports** | [**List[AutomationDashboardTabularExport]**](AutomationDashboardTabularExport.md) | | [optional] **description** | **str** | | [optional] -**details** | **{str: (str,)}** | Additional details to be included in the automated message. | [optional] -**external_recipients** | [**[AutomationExternalRecipient]**](AutomationExternalRecipient.md) | External recipients of the automation action results. | [optional] -**image_exports** | [**[AutomationImageExport]**](AutomationImageExport.md) | | [optional] +**details** | **Dict[str, str]** | Additional details to be included in the automated message. | [optional] +**external_recipients** | [**List[AutomationExternalRecipient]**](AutomationExternalRecipient.md) | External recipients of the automation action results. | [optional] +**image_exports** | [**List[AutomationImageExport]**](AutomationImageExport.md) | | [optional] **metadata** | [**AutomationMetadata**](AutomationMetadata.md) | | [optional] **notification_channel** | [**DeclarativeNotificationChannelIdentifier**](DeclarativeNotificationChannelIdentifier.md) | | [optional] -**raw_exports** | [**[AutomationRawExport]**](AutomationRawExport.md) | | [optional] -**recipients** | [**[DeclarativeUserIdentifier]**](DeclarativeUserIdentifier.md) | | [optional] -**slides_exports** | [**[AutomationSlidesExport]**](AutomationSlidesExport.md) | | [optional] -**tabular_exports** | [**[AutomationTabularExport]**](AutomationTabularExport.md) | | [optional] -**tags** | **[str]** | A list of tags. | [optional] +**raw_exports** | [**List[AutomationRawExport]**](AutomationRawExport.md) | | [optional] +**recipients** | [**List[DeclarativeUserIdentifier]**](DeclarativeUserIdentifier.md) | | [optional] +**slides_exports** | [**List[AutomationSlidesExport]**](AutomationSlidesExport.md) | | [optional] +**tabular_exports** | [**List[AutomationTabularExport]**](AutomationTabularExport.md) | | [optional] +**tags** | **List[str]** | A list of tags. | [optional] **title** | **str** | | [optional] -**visual_exports** | [**[AutomationVisualExport]**](AutomationVisualExport.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**visual_exports** | [**List[AutomationVisualExport]**](AutomationVisualExport.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.ad_hoc_automation import AdHocAutomation + +# TODO update the JSON string below +json = "{}" +# create an instance of AdHocAutomation from a JSON string +ad_hoc_automation_instance = AdHocAutomation.from_json(json) +# print the JSON string representation of the object +print(AdHocAutomation.to_json()) +# convert the object into a dict +ad_hoc_automation_dict = ad_hoc_automation_instance.to_dict() +# create an instance of AdHocAutomation from a dict +ad_hoc_automation_from_dict = AdHocAutomation.from_dict(ad_hoc_automation_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmCancelTokens.md b/gooddata-api-client/docs/AfmCancelTokens.md index edc56953f..425f5d936 100644 --- a/gooddata-api-client/docs/AfmCancelTokens.md +++ b/gooddata-api-client/docs/AfmCancelTokens.md @@ -3,11 +3,28 @@ Any information related to cancellation. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result_id_to_cancel_token_pairs** | **{str: (str,)}** | resultId to cancel token pairs | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**result_id_to_cancel_token_pairs** | **Dict[str, str]** | resultId to cancel token pairs | + +## Example + +```python +from gooddata_api_client.models.afm_cancel_tokens import AfmCancelTokens + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmCancelTokens from a JSON string +afm_cancel_tokens_instance = AfmCancelTokens.from_json(json) +# print the JSON string representation of the object +print(AfmCancelTokens.to_json()) +# convert the object into a dict +afm_cancel_tokens_dict = afm_cancel_tokens_instance.to_dict() +# create an instance of AfmCancelTokens from a dict +afm_cancel_tokens_from_dict = AfmCancelTokens.from_dict(afm_cancel_tokens_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmExecution.md b/gooddata-api-client/docs/AfmExecution.md index 5428f8861..f9e08383c 100644 --- a/gooddata-api-client/docs/AfmExecution.md +++ b/gooddata-api-client/docs/AfmExecution.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution** | [**AFM**](AFM.md) | | **result_spec** | [**ResultSpec**](ResultSpec.md) | | **settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.afm_execution import AfmExecution + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmExecution from a JSON string +afm_execution_instance = AfmExecution.from_json(json) +# print the JSON string representation of the object +print(AfmExecution.to_json()) + +# convert the object into a dict +afm_execution_dict = afm_execution_instance.to_dict() +# create an instance of AfmExecution from a dict +afm_execution_from_dict = AfmExecution.from_dict(afm_execution_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmExecutionResponse.md b/gooddata-api-client/docs/AfmExecutionResponse.md index c8ff903a4..5fdcac48b 100644 --- a/gooddata-api-client/docs/AfmExecutionResponse.md +++ b/gooddata-api-client/docs/AfmExecutionResponse.md @@ -3,11 +3,28 @@ Response to AFM execution request ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_response** | [**ExecutionResponse**](ExecutionResponse.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.afm_execution_response import AfmExecutionResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmExecutionResponse from a JSON string +afm_execution_response_instance = AfmExecutionResponse.from_json(json) +# print the JSON string representation of the object +print(AfmExecutionResponse.to_json()) + +# convert the object into a dict +afm_execution_response_dict = afm_execution_response_instance.to_dict() +# create an instance of AfmExecutionResponse from a dict +afm_execution_response_from_dict = AfmExecutionResponse.from_dict(afm_execution_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmIdentifier.md b/gooddata-api-client/docs/AfmIdentifier.md index 20783beed..539dffeff 100644 --- a/gooddata-api-client/docs/AfmIdentifier.md +++ b/gooddata-api-client/docs/AfmIdentifier.md @@ -3,12 +3,29 @@ Reference to the attribute label to which the filter should be applied. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**identifier** | [**AfmObjectIdentifierIdentifier**](AfmObjectIdentifierIdentifier.md) | | [optional] -**local_identifier** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**identifier** | [**AfmObjectIdentifierIdentifier**](AfmObjectIdentifierIdentifier.md) | | +**local_identifier** | **str** | | + +## Example + +```python +from gooddata_api_client.models.afm_identifier import AfmIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmIdentifier from a JSON string +afm_identifier_instance = AfmIdentifier.from_json(json) +# print the JSON string representation of the object +print(AfmIdentifier.to_json()) +# convert the object into a dict +afm_identifier_dict = afm_identifier_instance.to_dict() +# create an instance of AfmIdentifier from a dict +afm_identifier_from_dict = AfmIdentifier.from_dict(afm_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmLocalIdentifier.md b/gooddata-api-client/docs/AfmLocalIdentifier.md index 1cfa23221..be809323d 100644 --- a/gooddata-api-client/docs/AfmLocalIdentifier.md +++ b/gooddata-api-client/docs/AfmLocalIdentifier.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **local_identifier** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.afm_local_identifier import AfmLocalIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmLocalIdentifier from a JSON string +afm_local_identifier_instance = AfmLocalIdentifier.from_json(json) +# print the JSON string representation of the object +print(AfmLocalIdentifier.to_json()) + +# convert the object into a dict +afm_local_identifier_dict = afm_local_identifier_instance.to_dict() +# create an instance of AfmLocalIdentifier from a dict +afm_local_identifier_from_dict = AfmLocalIdentifier.from_dict(afm_local_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmObjectIdentifier.md b/gooddata-api-client/docs/AfmObjectIdentifier.md index c74c00e85..a0515d566 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifier.md +++ b/gooddata-api-client/docs/AfmObjectIdentifier.md @@ -3,11 +3,28 @@ ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identifier** | [**AfmObjectIdentifierIdentifier**](AfmObjectIdentifierIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.afm_object_identifier import AfmObjectIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmObjectIdentifier from a JSON string +afm_object_identifier_instance = AfmObjectIdentifier.from_json(json) +# print the JSON string representation of the object +print(AfmObjectIdentifier.to_json()) + +# convert the object into a dict +afm_object_identifier_dict = afm_object_identifier_instance.to_dict() +# create an instance of AfmObjectIdentifier from a dict +afm_object_identifier_from_dict = AfmObjectIdentifier.from_dict(afm_object_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmObjectIdentifierAttribute.md b/gooddata-api-client/docs/AfmObjectIdentifierAttribute.md index 60edb9ed7..fe1202144 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifierAttribute.md +++ b/gooddata-api-client/docs/AfmObjectIdentifierAttribute.md @@ -3,11 +3,28 @@ Reference to the date attribute to use. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identifier** | [**AfmObjectIdentifierAttributeIdentifier**](AfmObjectIdentifierAttributeIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.afm_object_identifier_attribute import AfmObjectIdentifierAttribute + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmObjectIdentifierAttribute from a JSON string +afm_object_identifier_attribute_instance = AfmObjectIdentifierAttribute.from_json(json) +# print the JSON string representation of the object +print(AfmObjectIdentifierAttribute.to_json()) + +# convert the object into a dict +afm_object_identifier_attribute_dict = afm_object_identifier_attribute_instance.to_dict() +# create an instance of AfmObjectIdentifierAttribute from a dict +afm_object_identifier_attribute_from_dict = AfmObjectIdentifierAttribute.from_dict(afm_object_identifier_attribute_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmObjectIdentifierAttributeIdentifier.md b/gooddata-api-client/docs/AfmObjectIdentifierAttributeIdentifier.md index d67a6054d..4f79aa17e 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifierAttributeIdentifier.md +++ b/gooddata-api-client/docs/AfmObjectIdentifierAttributeIdentifier.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "attribute" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.afm_object_identifier_attribute_identifier import AfmObjectIdentifierAttributeIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmObjectIdentifierAttributeIdentifier from a JSON string +afm_object_identifier_attribute_identifier_instance = AfmObjectIdentifierAttributeIdentifier.from_json(json) +# print the JSON string representation of the object +print(AfmObjectIdentifierAttributeIdentifier.to_json()) +# convert the object into a dict +afm_object_identifier_attribute_identifier_dict = afm_object_identifier_attribute_identifier_instance.to_dict() +# create an instance of AfmObjectIdentifierAttributeIdentifier from a dict +afm_object_identifier_attribute_identifier_from_dict = AfmObjectIdentifierAttributeIdentifier.from_dict(afm_object_identifier_attribute_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmObjectIdentifierCore.md b/gooddata-api-client/docs/AfmObjectIdentifierCore.md index 115c9558d..2223d58c9 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifierCore.md +++ b/gooddata-api-client/docs/AfmObjectIdentifierCore.md @@ -3,11 +3,28 @@ Reference to the metric, fact or attribute object to use for the metric. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identifier** | [**AfmObjectIdentifierCoreIdentifier**](AfmObjectIdentifierCoreIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.afm_object_identifier_core import AfmObjectIdentifierCore + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmObjectIdentifierCore from a JSON string +afm_object_identifier_core_instance = AfmObjectIdentifierCore.from_json(json) +# print the JSON string representation of the object +print(AfmObjectIdentifierCore.to_json()) + +# convert the object into a dict +afm_object_identifier_core_dict = afm_object_identifier_core_instance.to_dict() +# create an instance of AfmObjectIdentifierCore from a dict +afm_object_identifier_core_from_dict = AfmObjectIdentifierCore.from_dict(afm_object_identifier_core_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmObjectIdentifierCoreIdentifier.md b/gooddata-api-client/docs/AfmObjectIdentifierCoreIdentifier.md index d04de0d14..b411eb756 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifierCoreIdentifier.md +++ b/gooddata-api-client/docs/AfmObjectIdentifierCoreIdentifier.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.afm_object_identifier_core_identifier import AfmObjectIdentifierCoreIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmObjectIdentifierCoreIdentifier from a JSON string +afm_object_identifier_core_identifier_instance = AfmObjectIdentifierCoreIdentifier.from_json(json) +# print the JSON string representation of the object +print(AfmObjectIdentifierCoreIdentifier.to_json()) + +# convert the object into a dict +afm_object_identifier_core_identifier_dict = afm_object_identifier_core_identifier_instance.to_dict() +# create an instance of AfmObjectIdentifierCoreIdentifier from a dict +afm_object_identifier_core_identifier_from_dict = AfmObjectIdentifierCoreIdentifier.from_dict(afm_object_identifier_core_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmObjectIdentifierDataset.md b/gooddata-api-client/docs/AfmObjectIdentifierDataset.md index e8b2b2c97..229521471 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifierDataset.md +++ b/gooddata-api-client/docs/AfmObjectIdentifierDataset.md @@ -3,11 +3,28 @@ Reference to the date dataset to which the filter should be applied. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identifier** | [**AfmObjectIdentifierDatasetIdentifier**](AfmObjectIdentifierDatasetIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.afm_object_identifier_dataset import AfmObjectIdentifierDataset + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmObjectIdentifierDataset from a JSON string +afm_object_identifier_dataset_instance = AfmObjectIdentifierDataset.from_json(json) +# print the JSON string representation of the object +print(AfmObjectIdentifierDataset.to_json()) + +# convert the object into a dict +afm_object_identifier_dataset_dict = afm_object_identifier_dataset_instance.to_dict() +# create an instance of AfmObjectIdentifierDataset from a dict +afm_object_identifier_dataset_from_dict = AfmObjectIdentifierDataset.from_dict(afm_object_identifier_dataset_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmObjectIdentifierDatasetIdentifier.md b/gooddata-api-client/docs/AfmObjectIdentifierDatasetIdentifier.md index a7afa2e03..cccc1ab2f 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifierDatasetIdentifier.md +++ b/gooddata-api-client/docs/AfmObjectIdentifierDatasetIdentifier.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "dataset" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.afm_object_identifier_dataset_identifier import AfmObjectIdentifierDatasetIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmObjectIdentifierDatasetIdentifier from a JSON string +afm_object_identifier_dataset_identifier_instance = AfmObjectIdentifierDatasetIdentifier.from_json(json) +# print the JSON string representation of the object +print(AfmObjectIdentifierDatasetIdentifier.to_json()) +# convert the object into a dict +afm_object_identifier_dataset_identifier_dict = afm_object_identifier_dataset_identifier_instance.to_dict() +# create an instance of AfmObjectIdentifierDatasetIdentifier from a dict +afm_object_identifier_dataset_identifier_from_dict = AfmObjectIdentifierDatasetIdentifier.from_dict(afm_object_identifier_dataset_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmObjectIdentifierIdentifier.md b/gooddata-api-client/docs/AfmObjectIdentifierIdentifier.md index 383161b81..6edf98210 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifierIdentifier.md +++ b/gooddata-api-client/docs/AfmObjectIdentifierIdentifier.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.afm_object_identifier_identifier import AfmObjectIdentifierIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmObjectIdentifierIdentifier from a JSON string +afm_object_identifier_identifier_instance = AfmObjectIdentifierIdentifier.from_json(json) +# print the JSON string representation of the object +print(AfmObjectIdentifierIdentifier.to_json()) + +# convert the object into a dict +afm_object_identifier_identifier_dict = afm_object_identifier_identifier_instance.to_dict() +# create an instance of AfmObjectIdentifierIdentifier from a dict +afm_object_identifier_identifier_from_dict = AfmObjectIdentifierIdentifier.from_dict(afm_object_identifier_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmObjectIdentifierLabel.md b/gooddata-api-client/docs/AfmObjectIdentifierLabel.md index 4618a0d40..a4cb3bfae 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifierLabel.md +++ b/gooddata-api-client/docs/AfmObjectIdentifierLabel.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identifier** | [**AfmObjectIdentifierLabelIdentifier**](AfmObjectIdentifierLabelIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.afm_object_identifier_label import AfmObjectIdentifierLabel + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmObjectIdentifierLabel from a JSON string +afm_object_identifier_label_instance = AfmObjectIdentifierLabel.from_json(json) +# print the JSON string representation of the object +print(AfmObjectIdentifierLabel.to_json()) + +# convert the object into a dict +afm_object_identifier_label_dict = afm_object_identifier_label_instance.to_dict() +# create an instance of AfmObjectIdentifierLabel from a dict +afm_object_identifier_label_from_dict = AfmObjectIdentifierLabel.from_dict(afm_object_identifier_label_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmObjectIdentifierLabelIdentifier.md b/gooddata-api-client/docs/AfmObjectIdentifierLabelIdentifier.md index f47d11e58..525d0beb2 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifierLabelIdentifier.md +++ b/gooddata-api-client/docs/AfmObjectIdentifierLabelIdentifier.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "label" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.afm_object_identifier_label_identifier import AfmObjectIdentifierLabelIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmObjectIdentifierLabelIdentifier from a JSON string +afm_object_identifier_label_identifier_instance = AfmObjectIdentifierLabelIdentifier.from_json(json) +# print the JSON string representation of the object +print(AfmObjectIdentifierLabelIdentifier.to_json()) +# convert the object into a dict +afm_object_identifier_label_identifier_dict = afm_object_identifier_label_identifier_instance.to_dict() +# create an instance of AfmObjectIdentifierLabelIdentifier from a dict +afm_object_identifier_label_identifier_from_dict = AfmObjectIdentifierLabelIdentifier.from_dict(afm_object_identifier_label_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmValidDescendantsQuery.md b/gooddata-api-client/docs/AfmValidDescendantsQuery.md index a1b1937f1..447d7b3f7 100644 --- a/gooddata-api-client/docs/AfmValidDescendantsQuery.md +++ b/gooddata-api-client/docs/AfmValidDescendantsQuery.md @@ -3,11 +3,28 @@ Entity describing the valid descendants request. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | [**[AfmObjectIdentifierAttribute]**](AfmObjectIdentifierAttribute.md) | List of identifiers of the attributes to get the valid descendants for. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**attributes** | [**List[AfmObjectIdentifierAttribute]**](AfmObjectIdentifierAttribute.md) | List of identifiers of the attributes to get the valid descendants for. | + +## Example + +```python +from gooddata_api_client.models.afm_valid_descendants_query import AfmValidDescendantsQuery + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmValidDescendantsQuery from a JSON string +afm_valid_descendants_query_instance = AfmValidDescendantsQuery.from_json(json) +# print the JSON string representation of the object +print(AfmValidDescendantsQuery.to_json()) +# convert the object into a dict +afm_valid_descendants_query_dict = afm_valid_descendants_query_instance.to_dict() +# create an instance of AfmValidDescendantsQuery from a dict +afm_valid_descendants_query_from_dict = AfmValidDescendantsQuery.from_dict(afm_valid_descendants_query_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmValidDescendantsResponse.md b/gooddata-api-client/docs/AfmValidDescendantsResponse.md index 860e188f1..aa33f0b24 100644 --- a/gooddata-api-client/docs/AfmValidDescendantsResponse.md +++ b/gooddata-api-client/docs/AfmValidDescendantsResponse.md @@ -3,11 +3,28 @@ Entity describing the valid descendants response. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**valid_descendants** | **{str: ([AfmObjectIdentifierAttribute],)}** | Map of attribute identifiers to list of valid descendants identifiers. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**valid_descendants** | **Dict[str, List[AfmObjectIdentifierAttribute]]** | Map of attribute identifiers to list of valid descendants identifiers. | + +## Example + +```python +from gooddata_api_client.models.afm_valid_descendants_response import AfmValidDescendantsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmValidDescendantsResponse from a JSON string +afm_valid_descendants_response_instance = AfmValidDescendantsResponse.from_json(json) +# print the JSON string representation of the object +print(AfmValidDescendantsResponse.to_json()) +# convert the object into a dict +afm_valid_descendants_response_dict = afm_valid_descendants_response_instance.to_dict() +# create an instance of AfmValidDescendantsResponse from a dict +afm_valid_descendants_response_from_dict = AfmValidDescendantsResponse.from_dict(afm_valid_descendants_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmValidObjectsQuery.md b/gooddata-api-client/docs/AfmValidObjectsQuery.md index b5755d852..f2fec1be9 100644 --- a/gooddata-api-client/docs/AfmValidObjectsQuery.md +++ b/gooddata-api-client/docs/AfmValidObjectsQuery.md @@ -3,12 +3,29 @@ Entity holding AFM and list of object types whose validity should be computed. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **afm** | [**AFM**](AFM.md) | | -**types** | **[str]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**types** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.afm_valid_objects_query import AfmValidObjectsQuery + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmValidObjectsQuery from a JSON string +afm_valid_objects_query_instance = AfmValidObjectsQuery.from_json(json) +# print the JSON string representation of the object +print(AfmValidObjectsQuery.to_json()) +# convert the object into a dict +afm_valid_objects_query_dict = afm_valid_objects_query_instance.to_dict() +# create an instance of AfmValidObjectsQuery from a dict +afm_valid_objects_query_from_dict = AfmValidObjectsQuery.from_dict(afm_valid_objects_query_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AfmValidObjectsResponse.md b/gooddata-api-client/docs/AfmValidObjectsResponse.md index 45a5a25b2..565044a99 100644 --- a/gooddata-api-client/docs/AfmValidObjectsResponse.md +++ b/gooddata-api-client/docs/AfmValidObjectsResponse.md @@ -3,11 +3,28 @@ All objects of specified types valid with respect to given AFM. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**items** | [**[RestApiIdentifier]**](RestApiIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**items** | [**List[RestApiIdentifier]**](RestApiIdentifier.md) | | + +## Example + +```python +from gooddata_api_client.models.afm_valid_objects_response import AfmValidObjectsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of AfmValidObjectsResponse from a JSON string +afm_valid_objects_response_instance = AfmValidObjectsResponse.from_json(json) +# print the JSON string representation of the object +print(AfmValidObjectsResponse.to_json()) +# convert the object into a dict +afm_valid_objects_response_dict = afm_valid_objects_response_instance.to_dict() +# create an instance of AfmValidObjectsResponse from a dict +afm_valid_objects_response_from_dict = AfmValidObjectsResponse.from_dict(afm_valid_objects_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AlertAfm.md b/gooddata-api-client/docs/AlertAfm.md index dfefad620..4f14afe05 100644 --- a/gooddata-api-client/docs/AlertAfm.md +++ b/gooddata-api-client/docs/AlertAfm.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**filters** | [**[FilterDefinition]**](FilterDefinition.md) | Various filter types to filter execution result. | -**measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other. | -**attributes** | [**[AttributeItem]**](AttributeItem.md) | Attributes to be used in the computation. | [optional] -**aux_measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**attributes** | [**List[AttributeItem]**](AttributeItem.md) | Attributes to be used in the computation. | [optional] +**aux_measures** | [**List[MeasureItem]**](MeasureItem.md) | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | [optional] +**filters** | [**List[FilterDefinition]**](FilterDefinition.md) | Various filter types to filter execution result. | +**measures** | [**List[MeasureItem]**](MeasureItem.md) | Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other. | + +## Example + +```python +from gooddata_api_client.models.alert_afm import AlertAfm + +# TODO update the JSON string below +json = "{}" +# create an instance of AlertAfm from a JSON string +alert_afm_instance = AlertAfm.from_json(json) +# print the JSON string representation of the object +print(AlertAfm.to_json()) +# convert the object into a dict +alert_afm_dict = alert_afm_instance.to_dict() +# create an instance of AlertAfm from a dict +alert_afm_from_dict = AlertAfm.from_dict(alert_afm_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AlertCondition.md b/gooddata-api-client/docs/AlertCondition.md index 6ad87592b..6ee5b9107 100644 --- a/gooddata-api-client/docs/AlertCondition.md +++ b/gooddata-api-client/docs/AlertCondition.md @@ -3,13 +3,30 @@ Alert trigger condition. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comparison** | [**Comparison**](Comparison.md) | | [optional] -**range** | [**Range**](Range.md) | | [optional] -**relative** | [**Relative**](Relative.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**comparison** | [**Comparison**](Comparison.md) | | +**range** | [**Range**](Range.md) | | +**relative** | [**Relative**](Relative.md) | | + +## Example + +```python +from gooddata_api_client.models.alert_condition import AlertCondition + +# TODO update the JSON string below +json = "{}" +# create an instance of AlertCondition from a JSON string +alert_condition_instance = AlertCondition.from_json(json) +# print the JSON string representation of the object +print(AlertCondition.to_json()) +# convert the object into a dict +alert_condition_dict = alert_condition_instance.to_dict() +# create an instance of AlertCondition from a dict +alert_condition_from_dict = AlertCondition.from_dict(alert_condition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AlertConditionOperand.md b/gooddata-api-client/docs/AlertConditionOperand.md index 7d062ed1d..384a7314c 100644 --- a/gooddata-api-client/docs/AlertConditionOperand.md +++ b/gooddata-api-client/docs/AlertConditionOperand.md @@ -3,14 +3,31 @@ Operand of the alert condition. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str, none_type** | Metric format. | [optional] if omitted the server will use the default value of "#,##0.00" -**title** | **str, none_type** | Metric title. | [optional] -**local_identifier** | **str** | Local identifier of the metric to be compared. | [optional] -**value** | **float** | Value of the alert threshold to compare the metric to. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**format** | **str** | Metric format. | [optional] [default to '#,##0.00'] +**local_identifier** | **str** | Local identifier of the metric to be compared. | +**title** | **str** | Metric title. | [optional] +**value** | **float** | Value of the alert threshold to compare the metric to. | + +## Example + +```python +from gooddata_api_client.models.alert_condition_operand import AlertConditionOperand + +# TODO update the JSON string below +json = "{}" +# create an instance of AlertConditionOperand from a JSON string +alert_condition_operand_instance = AlertConditionOperand.from_json(json) +# print the JSON string representation of the object +print(AlertConditionOperand.to_json()) +# convert the object into a dict +alert_condition_operand_dict = alert_condition_operand_instance.to_dict() +# create an instance of AlertConditionOperand from a dict +alert_condition_operand_from_dict = AlertConditionOperand.from_dict(alert_condition_operand_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AlertDescription.md b/gooddata-api-client/docs/AlertDescription.md index d2097cd38..106001ea7 100644 --- a/gooddata-api-client/docs/AlertDescription.md +++ b/gooddata-api-client/docs/AlertDescription.md @@ -2,15 +2,16 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**condition** | **str** | | -**metric** | **str** | | **attribute** | **str** | | [optional] -**current_values** | [**[AlertEvaluationRow]**](AlertEvaluationRow.md) | | [optional] +**condition** | **str** | | +**current_values** | [**List[AlertEvaluationRow]**](AlertEvaluationRow.md) | | [optional] **error_message** | **str** | | [optional] **formatted_threshold** | **str** | | [optional] **lower_threshold** | **float** | | [optional] +**metric** | **str** | | **remaining_alert_evaluation_count** | **int** | | [optional] **status** | **str** | | [optional] **threshold** | **float** | | [optional] @@ -19,8 +20,24 @@ Name | Type | Description | Notes **triggered_at** | **datetime** | | [optional] **triggered_count** | **int** | | [optional] **upper_threshold** | **float** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.alert_description import AlertDescription + +# TODO update the JSON string below +json = "{}" +# create an instance of AlertDescription from a JSON string +alert_description_instance = AlertDescription.from_json(json) +# print the JSON string representation of the object +print(AlertDescription.to_json()) + +# convert the object into a dict +alert_description_dict = alert_description_instance.to_dict() +# create an instance of AlertDescription from a dict +alert_description_from_dict = AlertDescription.from_dict(alert_description_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AlertEvaluationRow.md b/gooddata-api-client/docs/AlertEvaluationRow.md index ffd81181a..3aa8b470b 100644 --- a/gooddata-api-client/docs/AlertEvaluationRow.md +++ b/gooddata-api-client/docs/AlertEvaluationRow.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **computed_metric** | [**MetricRecord**](MetricRecord.md) | | [optional] **label_value** | **str** | | [optional] **primary_metric** | [**MetricRecord**](MetricRecord.md) | | [optional] **secondary_metric** | [**MetricRecord**](MetricRecord.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.alert_evaluation_row import AlertEvaluationRow + +# TODO update the JSON string below +json = "{}" +# create an instance of AlertEvaluationRow from a JSON string +alert_evaluation_row_instance = AlertEvaluationRow.from_json(json) +# print the JSON string representation of the object +print(AlertEvaluationRow.to_json()) + +# convert the object into a dict +alert_evaluation_row_dict = alert_evaluation_row_instance.to_dict() +# create an instance of AlertEvaluationRow from a dict +alert_evaluation_row_from_dict = AlertEvaluationRow.from_dict(alert_evaluation_row_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AnalyticsCatalogTags.md b/gooddata-api-client/docs/AnalyticsCatalogTags.md index bf5382897..d2bc44a45 100644 --- a/gooddata-api-client/docs/AnalyticsCatalogTags.md +++ b/gooddata-api-client/docs/AnalyticsCatalogTags.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tags** | **[str]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tags** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.analytics_catalog_tags import AnalyticsCatalogTags + +# TODO update the JSON string below +json = "{}" +# create an instance of AnalyticsCatalogTags from a JSON string +analytics_catalog_tags_instance = AnalyticsCatalogTags.from_json(json) +# print the JSON string representation of the object +print(AnalyticsCatalogTags.to_json()) +# convert the object into a dict +analytics_catalog_tags_dict = analytics_catalog_tags_instance.to_dict() +# create an instance of AnalyticsCatalogTags from a dict +analytics_catalog_tags_from_dict = AnalyticsCatalogTags.from_dict(analytics_catalog_tags_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AnalyticsModelApi.md b/gooddata-api-client/docs/AnalyticsModelApi.md index a79074278..c73bee4f7 100644 --- a/gooddata-api-client/docs/AnalyticsModelApi.md +++ b/gooddata-api-client/docs/AnalyticsModelApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **get_analytics_model** -> DeclarativeAnalytics get_analytics_model(workspace_id) +> DeclarativeAnalytics get_analytics_model(workspace_id, exclude=exclude) Get analytics model @@ -19,11 +19,11 @@ Retrieve current analytics model of the workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import analytics_model_api -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -32,39 +32,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = analytics_model_api.AnalyticsModelApi(api_client) - workspace_id = "workspaceId_example" # str | - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) + api_instance = gooddata_api_client.AnalyticsModelApi(api_client) + workspace_id = 'workspace_id_example' # str | + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - try: - # Get analytics model - api_response = api_instance.get_analytics_model(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AnalyticsModelApi->get_analytics_model: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get analytics model api_response = api_instance.get_analytics_model(workspace_id, exclude=exclude) + print("The response of AnalyticsModelApi->get_analytics_model:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AnalyticsModelApi->get_analytics_model: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **exclude** | **[str]**| | [optional] + **workspace_id** | **str**| | + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type @@ -79,7 +70,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -99,11 +89,11 @@ Set effective analytics model of the workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import analytics_model_api -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -112,165 +102,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = analytics_model_api.AnalyticsModelApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_analytics = DeclarativeAnalytics( - analytics=DeclarativeAnalyticsLayer( - analytical_dashboard_extensions=[ - DeclarativeAnalyticalDashboardExtension( - id="revenues-analysis", - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - ), - ], - analytical_dashboards=[ - DeclarativeAnalyticalDashboard( - content=JsonNode(), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Period to period comparison of revenues in main sectors.", - id="revenues-analysis", - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - tags=["Revenues"], - title="Revenues analysis", - ), - ], - attribute_hierarchies=[ - DeclarativeAttributeHierarchy( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - dashboard_plugins=[ - DeclarativeDashboardPlugin( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Three dimensional view of data.", - id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="3D map renderer", - ), - ], - export_definitions=[ - DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="export-definition-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), - tags=["Revenues"], - title="My regular export", - ), - ], - filter_contexts=[ - DeclarativeFilterContext( - content=JsonNode(), - description="Filter Context for Sales team.", - id="filter-sales", - tags=["Revenues"], - title="Filter Context for Sales team", - ), - ], - metrics=[ - DeclarativeMetric( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Sales for all the data available.", - id="total-sales", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Total sales", - ), - ], - visualization_objects=[ - DeclarativeVisualizationObject( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="visualization-1", - is_hidden=False, - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - ), - ) # DeclarativeAnalytics | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AnalyticsModelApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_analytics = gooddata_api_client.DeclarativeAnalytics() # DeclarativeAnalytics | + try: # Set analytics model api_instance.set_analytics_model(workspace_id, declarative_analytics) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AnalyticsModelApi->set_analytics_model: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_analytics** | [**DeclarativeAnalytics**](DeclarativeAnalytics.md)| | + **workspace_id** | **str**| | + **declarative_analytics** | [**DeclarativeAnalytics**](DeclarativeAnalytics.md)| | ### Return type @@ -285,7 +138,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/AnomalyDetectionRequest.md b/gooddata-api-client/docs/AnomalyDetectionRequest.md index 907acf6e9..b75a2b991 100644 --- a/gooddata-api-client/docs/AnomalyDetectionRequest.md +++ b/gooddata-api-client/docs/AnomalyDetectionRequest.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sensitivity** | **float** | Anomaly detection sensitivity. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.anomaly_detection_request import AnomalyDetectionRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of AnomalyDetectionRequest from a JSON string +anomaly_detection_request_instance = AnomalyDetectionRequest.from_json(json) +# print the JSON string representation of the object +print(AnomalyDetectionRequest.to_json()) + +# convert the object into a dict +anomaly_detection_request_dict = anomaly_detection_request_instance.to_dict() +# create an instance of AnomalyDetectionRequest from a dict +anomaly_detection_request_from_dict = AnomalyDetectionRequest.from_dict(anomaly_detection_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AnomalyDetectionResult.md b/gooddata-api-client/docs/AnomalyDetectionResult.md index f7dedcfe4..16188ee99 100644 --- a/gooddata-api-client/docs/AnomalyDetectionResult.md +++ b/gooddata-api-client/docs/AnomalyDetectionResult.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**anomaly_flag** | **[bool, none_type]** | | -**attribute** | **[str]** | | -**values** | **[float, none_type]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**anomaly_flag** | **List[Optional[bool]]** | | +**attribute** | **List[str]** | | +**values** | **List[Optional[float]]** | | + +## Example + +```python +from gooddata_api_client.models.anomaly_detection_result import AnomalyDetectionResult + +# TODO update the JSON string below +json = "{}" +# create an instance of AnomalyDetectionResult from a JSON string +anomaly_detection_result_instance = AnomalyDetectionResult.from_json(json) +# print the JSON string representation of the object +print(AnomalyDetectionResult.to_json()) +# convert the object into a dict +anomaly_detection_result_dict = anomaly_detection_result_instance.to_dict() +# create an instance of AnomalyDetectionResult from a dict +anomaly_detection_result_from_dict = AnomalyDetectionResult.from_dict(anomaly_detection_result_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ApiEntitlement.md b/gooddata-api-client/docs/ApiEntitlement.md index 28e9587dd..2852f98e0 100644 --- a/gooddata-api-client/docs/ApiEntitlement.md +++ b/gooddata-api-client/docs/ApiEntitlement.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | | **expiry** | **date** | | [optional] +**name** | **str** | | **value** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.api_entitlement import ApiEntitlement + +# TODO update the JSON string below +json = "{}" +# create an instance of ApiEntitlement from a JSON string +api_entitlement_instance = ApiEntitlement.from_json(json) +# print the JSON string representation of the object +print(ApiEntitlement.to_json()) + +# convert the object into a dict +api_entitlement_dict = api_entitlement_instance.to_dict() +# create an instance of ApiEntitlement from a dict +api_entitlement_from_dict = ApiEntitlement.from_dict(api_entitlement_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AppearanceApi.md b/gooddata-api-client/docs/AppearanceApi.md index 1fab07e3b..1fcf1a3a2 100644 --- a/gooddata-api-client/docs/AppearanceApi.md +++ b/gooddata-api-client/docs/AppearanceApi.md @@ -27,12 +27,12 @@ Post Color Pallettes ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -41,35 +41,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - json_api_color_palette_in_document = JsonApiColorPaletteInDocument( - data=JsonApiColorPaletteIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="colorPalette", - ), - ) # JsonApiColorPaletteInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AppearanceApi(api_client) + json_api_color_palette_in_document = gooddata_api_client.JsonApiColorPaletteInDocument() # JsonApiColorPaletteInDocument | + try: # Post Color Pallettes api_response = api_instance.create_entity_color_palettes(json_api_color_palette_in_document) + print("The response of AppearanceApi->create_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->create_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | + **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | ### Return type @@ -84,7 +77,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -102,12 +94,12 @@ Post Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -116,35 +108,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - json_api_theme_in_document = JsonApiThemeInDocument( - data=JsonApiThemeIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="theme", - ), - ) # JsonApiThemeInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AppearanceApi(api_client) + json_api_theme_in_document = gooddata_api_client.JsonApiThemeInDocument() # JsonApiThemeInDocument | + try: # Post Theming api_response = api_instance.create_entity_themes(json_api_theme_in_document) + print("The response of AppearanceApi->create_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->create_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | + **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | ### Return type @@ -159,7 +144,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -169,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_color_palettes** -> delete_entity_color_palettes(id) +> delete_entity_color_palettes(id, filter=filter) Delete a Color Pallette @@ -177,10 +161,10 @@ Delete a Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -189,35 +173,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.AppearanceApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Color Pallette - api_instance.delete_entity_color_palettes(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->delete_entity_color_palettes: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Color Pallette api_instance.delete_entity_color_palettes(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->delete_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -232,7 +209,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -242,7 +218,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_themes** -> delete_entity_themes(id) +> delete_entity_themes(id, filter=filter) Delete Theming @@ -250,10 +226,10 @@ Delete Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -262,35 +238,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.AppearanceApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Theming - api_instance.delete_entity_themes(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->delete_entity_themes: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Theming api_instance.delete_entity_themes(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->delete_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -305,7 +274,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -315,7 +283,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_color_palettes** -> JsonApiColorPaletteOutList get_all_entities_color_palettes() +> JsonApiColorPaletteOutList get_all_entities_color_palettes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Color Pallettes @@ -323,11 +291,11 @@ Get all Color Pallettes ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -336,39 +304,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.AppearanceApi(api_client) + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Color Pallettes api_response = api_instance.get_all_entities_color_palettes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of AppearanceApi->get_all_entities_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->get_all_entities_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -383,7 +348,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -393,7 +357,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_themes** -> JsonApiThemeOutList get_all_entities_themes() +> JsonApiThemeOutList get_all_entities_themes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Theming entities @@ -401,11 +365,11 @@ Get all Theming entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -414,39 +378,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.AppearanceApi(api_client) + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Theming entities api_response = api_instance.get_all_entities_themes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of AppearanceApi->get_all_entities_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->get_all_entities_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -461,7 +422,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -471,7 +431,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_color_palettes** -> JsonApiColorPaletteOutDocument get_entity_color_palettes(id) +> JsonApiColorPaletteOutDocument get_entity_color_palettes(id, filter=filter) Get Color Pallette @@ -479,11 +439,11 @@ Get Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -492,37 +452,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get Color Pallette - api_response = api_instance.get_entity_color_palettes(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->get_entity_color_palettes: %s\n" % e) + api_instance = gooddata_api_client.AppearanceApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Color Pallette api_response = api_instance.get_entity_color_palettes(id, filter=filter) + print("The response of AppearanceApi->get_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->get_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -537,7 +490,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -547,7 +499,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_themes** -> JsonApiThemeOutDocument get_entity_themes(id) +> JsonApiThemeOutDocument get_entity_themes(id, filter=filter) Get Theming @@ -555,11 +507,11 @@ Get Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -568,37 +520,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.AppearanceApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Theming - api_response = api_instance.get_entity_themes(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->get_entity_themes: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Theming api_response = api_instance.get_entity_themes(id, filter=filter) + print("The response of AppearanceApi->get_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->get_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -613,7 +558,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -623,7 +567,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_color_palettes** -> JsonApiColorPaletteOutDocument patch_entity_color_palettes(id, json_api_color_palette_patch_document) +> JsonApiColorPaletteOutDocument patch_entity_color_palettes(id, json_api_color_palette_patch_document, filter=filter) Patch Color Pallette @@ -631,12 +575,12 @@ Patch Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -645,48 +589,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_color_palette_patch_document = JsonApiColorPalettePatchDocument( - data=JsonApiColorPalettePatch( - attributes=JsonApiColorPalettePatchAttributes( - content={}, - name="name_example", - ), - id="id1", - type="colorPalette", - ), - ) # JsonApiColorPalettePatchDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Color Pallette - api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->patch_entity_color_palettes: %s\n" % e) + api_instance = gooddata_api_client.AppearanceApi(api_client) + id = 'id_example' # str | + json_api_color_palette_patch_document = gooddata_api_client.JsonApiColorPalettePatchDocument() # JsonApiColorPalettePatchDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Color Pallette api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document, filter=filter) + print("The response of AppearanceApi->patch_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->patch_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_color_palette_patch_document** | [**JsonApiColorPalettePatchDocument**](JsonApiColorPalettePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_color_palette_patch_document** | [**JsonApiColorPalettePatchDocument**](JsonApiColorPalettePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -701,7 +629,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -711,7 +638,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_themes** -> JsonApiThemeOutDocument patch_entity_themes(id, json_api_theme_patch_document) +> JsonApiThemeOutDocument patch_entity_themes(id, json_api_theme_patch_document, filter=filter) Patch Theming @@ -719,12 +646,12 @@ Patch Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -733,48 +660,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_theme_patch_document = JsonApiThemePatchDocument( - data=JsonApiThemePatch( - attributes=JsonApiColorPalettePatchAttributes( - content={}, - name="name_example", - ), - id="id1", - type="theme", - ), - ) # JsonApiThemePatchDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Theming - api_response = api_instance.patch_entity_themes(id, json_api_theme_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->patch_entity_themes: %s\n" % e) + api_instance = gooddata_api_client.AppearanceApi(api_client) + id = 'id_example' # str | + json_api_theme_patch_document = gooddata_api_client.JsonApiThemePatchDocument() # JsonApiThemePatchDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Theming api_response = api_instance.patch_entity_themes(id, json_api_theme_patch_document, filter=filter) + print("The response of AppearanceApi->patch_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->patch_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_theme_patch_document** | [**JsonApiThemePatchDocument**](JsonApiThemePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_theme_patch_document** | [**JsonApiThemePatchDocument**](JsonApiThemePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -789,7 +700,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -799,7 +709,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_color_palettes** -> JsonApiColorPaletteOutDocument update_entity_color_palettes(id, json_api_color_palette_in_document) +> JsonApiColorPaletteOutDocument update_entity_color_palettes(id, json_api_color_palette_in_document, filter=filter) Put Color Pallette @@ -807,12 +717,12 @@ Put Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -821,48 +731,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_color_palette_in_document = JsonApiColorPaletteInDocument( - data=JsonApiColorPaletteIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="colorPalette", - ), - ) # JsonApiColorPaletteInDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Color Pallette - api_response = api_instance.update_entity_color_palettes(id, json_api_color_palette_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->update_entity_color_palettes: %s\n" % e) + api_instance = gooddata_api_client.AppearanceApi(api_client) + id = 'id_example' # str | + json_api_color_palette_in_document = gooddata_api_client.JsonApiColorPaletteInDocument() # JsonApiColorPaletteInDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Color Pallette api_response = api_instance.update_entity_color_palettes(id, json_api_color_palette_in_document, filter=filter) + print("The response of AppearanceApi->update_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->update_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -877,7 +771,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -887,7 +780,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_themes** -> JsonApiThemeOutDocument update_entity_themes(id, json_api_theme_in_document) +> JsonApiThemeOutDocument update_entity_themes(id, json_api_theme_in_document, filter=filter) Put Theming @@ -895,12 +788,12 @@ Put Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -909,48 +802,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_theme_in_document = JsonApiThemeInDocument( - data=JsonApiThemeIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="theme", - ), - ) # JsonApiThemeInDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Theming - api_response = api_instance.update_entity_themes(id, json_api_theme_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->update_entity_themes: %s\n" % e) + api_instance = gooddata_api_client.AppearanceApi(api_client) + id = 'id_example' # str | + json_api_theme_in_document = gooddata_api_client.JsonApiThemeInDocument() # JsonApiThemeInDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Theming api_response = api_instance.update_entity_themes(id, json_api_theme_in_document, filter=filter) + print("The response of AppearanceApi->update_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AppearanceApi->update_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -965,7 +842,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ArithmeticMeasure.md b/gooddata-api-client/docs/ArithmeticMeasure.md index f1633d912..e402c0882 100644 --- a/gooddata-api-client/docs/ArithmeticMeasure.md +++ b/gooddata-api-client/docs/ArithmeticMeasure.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **left** | [**LocalIdentifier**](LocalIdentifier.md) | | **operator** | **str** | Arithmetic operator. DIFFERENCE - m₁−m₂ - the difference between two metrics. CHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics. | **right** | [**LocalIdentifier**](LocalIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.arithmetic_measure import ArithmeticMeasure + +# TODO update the JSON string below +json = "{}" +# create an instance of ArithmeticMeasure from a JSON string +arithmetic_measure_instance = ArithmeticMeasure.from_json(json) +# print the JSON string representation of the object +print(ArithmeticMeasure.to_json()) + +# convert the object into a dict +arithmetic_measure_dict = arithmetic_measure_instance.to_dict() +# create an instance of ArithmeticMeasure from a dict +arithmetic_measure_from_dict = ArithmeticMeasure.from_dict(arithmetic_measure_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ArithmeticMeasureDefinition.md b/gooddata-api-client/docs/ArithmeticMeasureDefinition.md index ae1778fd0..82b51527a 100644 --- a/gooddata-api-client/docs/ArithmeticMeasureDefinition.md +++ b/gooddata-api-client/docs/ArithmeticMeasureDefinition.md @@ -3,11 +3,28 @@ Metric representing arithmetics between other metrics. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arithmetic_measure** | [**ArithmeticMeasureDefinitionArithmeticMeasure**](ArithmeticMeasureDefinitionArithmeticMeasure.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.arithmetic_measure_definition import ArithmeticMeasureDefinition + +# TODO update the JSON string below +json = "{}" +# create an instance of ArithmeticMeasureDefinition from a JSON string +arithmetic_measure_definition_instance = ArithmeticMeasureDefinition.from_json(json) +# print the JSON string representation of the object +print(ArithmeticMeasureDefinition.to_json()) + +# convert the object into a dict +arithmetic_measure_definition_dict = arithmetic_measure_definition_instance.to_dict() +# create an instance of ArithmeticMeasureDefinition from a dict +arithmetic_measure_definition_from_dict = ArithmeticMeasureDefinition.from_dict(arithmetic_measure_definition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ArithmeticMeasureDefinitionArithmeticMeasure.md b/gooddata-api-client/docs/ArithmeticMeasureDefinitionArithmeticMeasure.md index e06f33fa7..eb00645d2 100644 --- a/gooddata-api-client/docs/ArithmeticMeasureDefinitionArithmeticMeasure.md +++ b/gooddata-api-client/docs/ArithmeticMeasureDefinitionArithmeticMeasure.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**measure_identifiers** | [**[AfmLocalIdentifier]**](AfmLocalIdentifier.md) | List of metrics to apply arithmetic operation by chosen operator. | +**measure_identifiers** | [**List[AfmLocalIdentifier]**](AfmLocalIdentifier.md) | List of metrics to apply arithmetic operation by chosen operator. | **operator** | **str** | Arithmetic operator describing operation between metrics. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.arithmetic_measure_definition_arithmetic_measure import ArithmeticMeasureDefinitionArithmeticMeasure + +# TODO update the JSON string below +json = "{}" +# create an instance of ArithmeticMeasureDefinitionArithmeticMeasure from a JSON string +arithmetic_measure_definition_arithmetic_measure_instance = ArithmeticMeasureDefinitionArithmeticMeasure.from_json(json) +# print the JSON string representation of the object +print(ArithmeticMeasureDefinitionArithmeticMeasure.to_json()) + +# convert the object into a dict +arithmetic_measure_definition_arithmetic_measure_dict = arithmetic_measure_definition_arithmetic_measure_instance.to_dict() +# create an instance of ArithmeticMeasureDefinitionArithmeticMeasure from a dict +arithmetic_measure_definition_arithmetic_measure_from_dict = ArithmeticMeasureDefinitionArithmeticMeasure.from_dict(arithmetic_measure_definition_arithmetic_measure_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AssigneeIdentifier.md b/gooddata-api-client/docs/AssigneeIdentifier.md index 4ab713a35..c48000962 100644 --- a/gooddata-api-client/docs/AssigneeIdentifier.md +++ b/gooddata-api-client/docs/AssigneeIdentifier.md @@ -3,12 +3,29 @@ Identifier of a user or user-group. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of AssigneeIdentifier from a JSON string +assignee_identifier_instance = AssigneeIdentifier.from_json(json) +# print the JSON string representation of the object +print(AssigneeIdentifier.to_json()) + +# convert the object into a dict +assignee_identifier_dict = assignee_identifier_instance.to_dict() +# create an instance of AssigneeIdentifier from a dict +assignee_identifier_from_dict = AssigneeIdentifier.from_dict(assignee_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AssigneeRule.md b/gooddata-api-client/docs/AssigneeRule.md index 44ffd11ee..1b487f758 100644 --- a/gooddata-api-client/docs/AssigneeRule.md +++ b/gooddata-api-client/docs/AssigneeRule.md @@ -3,11 +3,28 @@ Identifier of an assignee rule. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | | defaults to "allWorkspaceUsers" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.assignee_rule import AssigneeRule + +# TODO update the JSON string below +json = "{}" +# create an instance of AssigneeRule from a JSON string +assignee_rule_instance = AssigneeRule.from_json(json) +# print the JSON string representation of the object +print(AssigneeRule.to_json()) +# convert the object into a dict +assignee_rule_dict = assignee_rule_instance.to_dict() +# create an instance of AssigneeRule from a dict +assignee_rule_from_dict = AssigneeRule.from_dict(assignee_rule_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeElements.md b/gooddata-api-client/docs/AttributeElements.md index 0115fe4a3..4cdf944e8 100644 --- a/gooddata-api-client/docs/AttributeElements.md +++ b/gooddata-api-client/docs/AttributeElements.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uris** | **[str, none_type]** | List of attribute elements by reference | [optional] -**values** | **[str, none_type]** | List of attribute elements by value | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**uris** | **List[Optional[str]]** | List of attribute elements by reference | +**values** | **List[Optional[str]]** | List of attribute elements by value | + +## Example + +```python +from gooddata_api_client.models.attribute_elements import AttributeElements + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeElements from a JSON string +attribute_elements_instance = AttributeElements.from_json(json) +# print the JSON string representation of the object +print(AttributeElements.to_json()) +# convert the object into a dict +attribute_elements_dict = attribute_elements_instance.to_dict() +# create an instance of AttributeElements from a dict +attribute_elements_from_dict = AttributeElements.from_dict(attribute_elements_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeElementsByRef.md b/gooddata-api-client/docs/AttributeElementsByRef.md index d2819f0a3..09fb6c327 100644 --- a/gooddata-api-client/docs/AttributeElementsByRef.md +++ b/gooddata-api-client/docs/AttributeElementsByRef.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uris** | **[str, none_type]** | List of attribute elements by reference | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**uris** | **List[Optional[str]]** | List of attribute elements by reference | + +## Example + +```python +from gooddata_api_client.models.attribute_elements_by_ref import AttributeElementsByRef + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeElementsByRef from a JSON string +attribute_elements_by_ref_instance = AttributeElementsByRef.from_json(json) +# print the JSON string representation of the object +print(AttributeElementsByRef.to_json()) +# convert the object into a dict +attribute_elements_by_ref_dict = attribute_elements_by_ref_instance.to_dict() +# create an instance of AttributeElementsByRef from a dict +attribute_elements_by_ref_from_dict = AttributeElementsByRef.from_dict(attribute_elements_by_ref_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeElementsByValue.md b/gooddata-api-client/docs/AttributeElementsByValue.md index 980064b06..b04eaf3f7 100644 --- a/gooddata-api-client/docs/AttributeElementsByValue.md +++ b/gooddata-api-client/docs/AttributeElementsByValue.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**values** | **[str, none_type]** | List of attribute elements by value | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**values** | **List[Optional[str]]** | List of attribute elements by value | + +## Example + +```python +from gooddata_api_client.models.attribute_elements_by_value import AttributeElementsByValue + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeElementsByValue from a JSON string +attribute_elements_by_value_instance = AttributeElementsByValue.from_json(json) +# print the JSON string representation of the object +print(AttributeElementsByValue.to_json()) +# convert the object into a dict +attribute_elements_by_value_dict = attribute_elements_by_value_instance.to_dict() +# create an instance of AttributeElementsByValue from a dict +attribute_elements_by_value_from_dict = AttributeElementsByValue.from_dict(attribute_elements_by_value_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeExecutionResultHeader.md b/gooddata-api-client/docs/AttributeExecutionResultHeader.md index c337ca4ce..fd20e8c1c 100644 --- a/gooddata-api-client/docs/AttributeExecutionResultHeader.md +++ b/gooddata-api-client/docs/AttributeExecutionResultHeader.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute_header** | [**AttributeResultHeader**](AttributeResultHeader.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.attribute_execution_result_header import AttributeExecutionResultHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeExecutionResultHeader from a JSON string +attribute_execution_result_header_instance = AttributeExecutionResultHeader.from_json(json) +# print the JSON string representation of the object +print(AttributeExecutionResultHeader.to_json()) + +# convert the object into a dict +attribute_execution_result_header_dict = attribute_execution_result_header_instance.to_dict() +# create an instance of AttributeExecutionResultHeader from a dict +attribute_execution_result_header_from_dict = AttributeExecutionResultHeader.from_dict(attribute_execution_result_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeFilter.md b/gooddata-api-client/docs/AttributeFilter.md index ae94fd974..537879bc8 100644 --- a/gooddata-api-client/docs/AttributeFilter.md +++ b/gooddata-api-client/docs/AttributeFilter.md @@ -3,12 +3,29 @@ Abstract filter definition type attributes ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] -**positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | +**positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | + +## Example + +```python +from gooddata_api_client.models.attribute_filter import AttributeFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeFilter from a JSON string +attribute_filter_instance = AttributeFilter.from_json(json) +# print the JSON string representation of the object +print(AttributeFilter.to_json()) +# convert the object into a dict +attribute_filter_dict = attribute_filter_instance.to_dict() +# create an instance of AttributeFilter from a dict +attribute_filter_from_dict = AttributeFilter.from_dict(attribute_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeFilterByDate.md b/gooddata-api-client/docs/AttributeFilterByDate.md index 3923f0f59..bb767e7e3 100644 --- a/gooddata-api-client/docs/AttributeFilterByDate.md +++ b/gooddata-api-client/docs/AttributeFilterByDate.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **filter_local_identifier** | **str** | | **is_common_date** | **bool** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.attribute_filter_by_date import AttributeFilterByDate + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeFilterByDate from a JSON string +attribute_filter_by_date_instance = AttributeFilterByDate.from_json(json) +# print the JSON string representation of the object +print(AttributeFilterByDate.to_json()) + +# convert the object into a dict +attribute_filter_by_date_dict = attribute_filter_by_date_instance.to_dict() +# create an instance of AttributeFilterByDate from a dict +attribute_filter_by_date_from_dict = AttributeFilterByDate.from_dict(attribute_filter_by_date_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeFilterElements.md b/gooddata-api-client/docs/AttributeFilterElements.md index 497b02678..4efe4d171 100644 --- a/gooddata-api-client/docs/AttributeFilterElements.md +++ b/gooddata-api-client/docs/AttributeFilterElements.md @@ -3,11 +3,28 @@ Filter on specific set of label values. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**values** | **[str, none_type]** | Set of label values. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**values** | **List[Optional[str]]** | Set of label values. | + +## Example + +```python +from gooddata_api_client.models.attribute_filter_elements import AttributeFilterElements + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeFilterElements from a JSON string +attribute_filter_elements_instance = AttributeFilterElements.from_json(json) +# print the JSON string representation of the object +print(AttributeFilterElements.to_json()) +# convert the object into a dict +attribute_filter_elements_dict = attribute_filter_elements_instance.to_dict() +# create an instance of AttributeFilterElements from a dict +attribute_filter_elements_from_dict = AttributeFilterElements.from_dict(attribute_filter_elements_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeFilterParent.md b/gooddata-api-client/docs/AttributeFilterParent.md index 9678405a4..9725190d3 100644 --- a/gooddata-api-client/docs/AttributeFilterParent.md +++ b/gooddata-api-client/docs/AttributeFilterParent.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **filter_local_identifier** | **str** | | **over** | [**Over**](Over.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.attribute_filter_parent import AttributeFilterParent + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeFilterParent from a JSON string +attribute_filter_parent_instance = AttributeFilterParent.from_json(json) +# print the JSON string representation of the object +print(AttributeFilterParent.to_json()) + +# convert the object into a dict +attribute_filter_parent_dict = attribute_filter_parent_instance.to_dict() +# create an instance of AttributeFilterParent from a dict +attribute_filter_parent_from_dict = AttributeFilterParent.from_dict(attribute_filter_parent_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeFormat.md b/gooddata-api-client/docs/AttributeFormat.md index 5b1519ef8..3e615e79b 100644 --- a/gooddata-api-client/docs/AttributeFormat.md +++ b/gooddata-api-client/docs/AttributeFormat.md @@ -3,13 +3,30 @@ Attribute format describes formatting information to effectively format attribute values when needed. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **locale** | **str** | Format locale code like 'en-US', 'cs-CZ', etc. | **pattern** | **str** | ICU formatting pattern like 'y', 'dd.MM.y', etc. | **timezone** | **str** | Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.attribute_format import AttributeFormat + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeFormat from a JSON string +attribute_format_instance = AttributeFormat.from_json(json) +# print the JSON string representation of the object +print(AttributeFormat.to_json()) + +# convert the object into a dict +attribute_format_dict = attribute_format_instance.to_dict() +# create an instance of AttributeFormat from a dict +attribute_format_from_dict = AttributeFormat.from_dict(attribute_format_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeHeader.md b/gooddata-api-client/docs/AttributeHeader.md index ef93870a2..c10146722 100644 --- a/gooddata-api-client/docs/AttributeHeader.md +++ b/gooddata-api-client/docs/AttributeHeader.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute_header** | [**AttributeHeaderAttributeHeader**](AttributeHeaderAttributeHeader.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.attribute_header import AttributeHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeHeader from a JSON string +attribute_header_instance = AttributeHeader.from_json(json) +# print the JSON string representation of the object +print(AttributeHeader.to_json()) + +# convert the object into a dict +attribute_header_dict = attribute_header_instance.to_dict() +# create an instance of AttributeHeader from a dict +attribute_header_from_dict = AttributeHeader.from_dict(attribute_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeHeaderAttributeHeader.md b/gooddata-api-client/docs/AttributeHeaderAttributeHeader.md index 236d6dfb8..1af7f7505 100644 --- a/gooddata-api-client/docs/AttributeHeaderAttributeHeader.md +++ b/gooddata-api-client/docs/AttributeHeaderAttributeHeader.md @@ -2,19 +2,36 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute** | [**RestApiIdentifier**](RestApiIdentifier.md) | | **attribute_name** | **str** | Attribute name. | +**format** | [**AttributeFormat**](AttributeFormat.md) | | [optional] +**granularity** | **str** | Date granularity of the attribute, only filled for date attributes. | [optional] **label** | [**RestApiIdentifier**](RestApiIdentifier.md) | | **label_name** | **str** | Label name. | **local_identifier** | **str** | Local identifier of the attribute this header relates to. | **primary_label** | [**RestApiIdentifier**](RestApiIdentifier.md) | | -**format** | [**AttributeFormat**](AttributeFormat.md) | | [optional] -**granularity** | **str** | Date granularity of the attribute, only filled for date attributes. | [optional] **value_type** | **str** | Attribute value type. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.attribute_header_attribute_header import AttributeHeaderAttributeHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeHeaderAttributeHeader from a JSON string +attribute_header_attribute_header_instance = AttributeHeaderAttributeHeader.from_json(json) +# print the JSON string representation of the object +print(AttributeHeaderAttributeHeader.to_json()) + +# convert the object into a dict +attribute_header_attribute_header_dict = attribute_header_attribute_header_instance.to_dict() +# create an instance of AttributeHeaderAttributeHeader from a dict +attribute_header_attribute_header_from_dict = AttributeHeaderAttributeHeader.from_dict(attribute_header_attribute_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeHierarchiesApi.md b/gooddata-api-client/docs/AttributeHierarchiesApi.md index 9360d45b1..de2de727d 100644 --- a/gooddata-api-client/docs/AttributeHierarchiesApi.md +++ b/gooddata-api-client/docs/AttributeHierarchiesApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **create_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document) +> JsonApiAttributeHierarchyOutDocument create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, include=include, meta_include=meta_include) Post Attribute Hierarchies @@ -21,12 +21,12 @@ Post Attribute Hierarchies ```python -import time import gooddata_api_client -from gooddata_api_client.api import attribute_hierarchies_api -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -35,59 +35,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_attribute_hierarchy_in_document = JsonApiAttributeHierarchyInDocument( - data=JsonApiAttributeHierarchyIn( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyInDocument | - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Attribute Hierarchies - api_response = api_instance.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AttributeHierarchiesApi->create_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.AttributeHierarchiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_attribute_hierarchy_in_document = gooddata_api_client.JsonApiAttributeHierarchyInDocument() # JsonApiAttributeHierarchyInDocument | + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Attribute Hierarchies api_response = api_instance.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, include=include, meta_include=meta_include) + print("The response of AttributeHierarchiesApi->create_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AttributeHierarchiesApi->create_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -102,7 +77,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -112,7 +86,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_attribute_hierarchies** -> delete_entity_attribute_hierarchies(workspace_id, object_id) +> delete_entity_attribute_hierarchies(workspace_id, object_id, filter=filter) Delete an Attribute Hierarchy @@ -120,10 +94,10 @@ Delete an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import attribute_hierarchies_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -132,37 +106,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete an Attribute Hierarchy - api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling AttributeHierarchiesApi->delete_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.AttributeHierarchiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete an Attribute Hierarchy api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AttributeHierarchiesApi->delete_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -177,7 +144,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -187,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_attribute_hierarchies** -> JsonApiAttributeHierarchyOutList get_all_entities_attribute_hierarchies(workspace_id) +> JsonApiAttributeHierarchyOutList get_all_entities_attribute_hierarchies(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Attribute Hierarchies @@ -195,11 +161,11 @@ Get all Attribute Hierarchies ```python -import time import gooddata_api_client -from gooddata_api_client.api import attribute_hierarchies_api -from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.models.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -208,57 +174,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Attribute Hierarchies - api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AttributeHierarchiesApi->get_all_entities_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.AttributeHierarchiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Attribute Hierarchies api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of AttributeHierarchiesApi->get_all_entities_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AttributeHierarchiesApi->get_all_entities_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -273,7 +226,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -283,7 +235,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument get_entity_attribute_hierarchies(workspace_id, object_id) +> JsonApiAttributeHierarchyOutDocument get_entity_attribute_hierarchies(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Attribute Hierarchy @@ -291,11 +243,11 @@ Get an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import attribute_hierarchies_api -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -304,49 +256,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Attribute Hierarchy - api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AttributeHierarchiesApi->get_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.AttributeHierarchiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Attribute Hierarchy api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of AttributeHierarchiesApi->get_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AttributeHierarchiesApi->get_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -361,7 +302,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -371,7 +311,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) +> JsonApiAttributeHierarchyOutDocument patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, filter=filter, include=include) Patch an Attribute Hierarchy @@ -379,12 +319,12 @@ Patch an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import attribute_hierarchies_api -from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -393,59 +333,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_attribute_hierarchy_patch_document = JsonApiAttributeHierarchyPatchDocument( - data=JsonApiAttributeHierarchyPatch( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Attribute Hierarchy - api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AttributeHierarchiesApi->patch_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.AttributeHierarchiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_attribute_hierarchy_patch_document = gooddata_api_client.JsonApiAttributeHierarchyPatchDocument() # JsonApiAttributeHierarchyPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch an Attribute Hierarchy api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, filter=filter, include=include) + print("The response of AttributeHierarchiesApi->patch_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AttributeHierarchiesApi->patch_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_attribute_hierarchy_patch_document** | [**JsonApiAttributeHierarchyPatchDocument**](JsonApiAttributeHierarchyPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_attribute_hierarchy_patch_document** | [**JsonApiAttributeHierarchyPatchDocument**](JsonApiAttributeHierarchyPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -460,7 +377,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -470,7 +386,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document) +> JsonApiAttributeHierarchyOutDocument update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, filter=filter, include=include) Put an Attribute Hierarchy @@ -478,12 +394,12 @@ Put an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import attribute_hierarchies_api -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -492,59 +408,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_attribute_hierarchy_in_document = JsonApiAttributeHierarchyInDocument( - data=JsonApiAttributeHierarchyIn( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Attribute Hierarchy - api_response = api_instance.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AttributeHierarchiesApi->update_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.AttributeHierarchiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_attribute_hierarchy_in_document = gooddata_api_client.JsonApiAttributeHierarchyInDocument() # JsonApiAttributeHierarchyInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put an Attribute Hierarchy api_response = api_instance.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, filter=filter, include=include) + print("The response of AttributeHierarchiesApi->update_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AttributeHierarchiesApi->update_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -559,7 +452,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/AttributeItem.md b/gooddata-api-client/docs/AttributeItem.md index c482502f0..6f22a2fea 100644 --- a/gooddata-api-client/docs/AttributeItem.md +++ b/gooddata-api-client/docs/AttributeItem.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **label** | [**AfmObjectIdentifierLabel**](AfmObjectIdentifierLabel.md) | | **local_identifier** | **str** | Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition. | -**show_all_values** | **bool** | Indicates whether to show all values of given attribute even if the data bound to those values is not available. | [optional] if omitted the server will use the default value of False -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**show_all_values** | **bool** | Indicates whether to show all values of given attribute even if the data bound to those values is not available. | [optional] [default to False] + +## Example + +```python +from gooddata_api_client.models.attribute_item import AttributeItem + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeItem from a JSON string +attribute_item_instance = AttributeItem.from_json(json) +# print the JSON string representation of the object +print(AttributeItem.to_json()) +# convert the object into a dict +attribute_item_dict = attribute_item_instance.to_dict() +# create an instance of AttributeItem from a dict +attribute_item_from_dict = AttributeItem.from_dict(attribute_item_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeNegativeFilter.md b/gooddata-api-client/docs/AttributeNegativeFilter.md index c58e94687..cb8361e71 100644 --- a/gooddata-api-client/docs/AttributeNegativeFilter.md +++ b/gooddata-api-client/docs/AttributeNegativeFilter.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**exclude** | **[str]** | | +**exclude** | **List[str]** | | **using** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.attribute_negative_filter import AttributeNegativeFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeNegativeFilter from a JSON string +attribute_negative_filter_instance = AttributeNegativeFilter.from_json(json) +# print the JSON string representation of the object +print(AttributeNegativeFilter.to_json()) + +# convert the object into a dict +attribute_negative_filter_dict = attribute_negative_filter_instance.to_dict() +# create an instance of AttributeNegativeFilter from a dict +attribute_negative_filter_from_dict = AttributeNegativeFilter.from_dict(attribute_negative_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributeNegativeFilterAllOf.md b/gooddata-api-client/docs/AttributeNegativeFilterAllOf.md deleted file mode 100644 index dd0d8887d..000000000 --- a/gooddata-api-client/docs/AttributeNegativeFilterAllOf.md +++ /dev/null @@ -1,13 +0,0 @@ -# AttributeNegativeFilterAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**exclude** | **[str]** | | [optional] -**using** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/AttributePositiveFilter.md b/gooddata-api-client/docs/AttributePositiveFilter.md index f0f19fe7c..4b7e68c7c 100644 --- a/gooddata-api-client/docs/AttributePositiveFilter.md +++ b/gooddata-api-client/docs/AttributePositiveFilter.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**include** | **[str]** | | +**include** | **List[str]** | | **using** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.attribute_positive_filter import AttributePositiveFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributePositiveFilter from a JSON string +attribute_positive_filter_instance = AttributePositiveFilter.from_json(json) +# print the JSON string representation of the object +print(AttributePositiveFilter.to_json()) + +# convert the object into a dict +attribute_positive_filter_dict = attribute_positive_filter_instance.to_dict() +# create an instance of AttributePositiveFilter from a dict +attribute_positive_filter_from_dict = AttributePositiveFilter.from_dict(attribute_positive_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributePositiveFilterAllOf.md b/gooddata-api-client/docs/AttributePositiveFilterAllOf.md deleted file mode 100644 index a272e79e3..000000000 --- a/gooddata-api-client/docs/AttributePositiveFilterAllOf.md +++ /dev/null @@ -1,13 +0,0 @@ -# AttributePositiveFilterAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**include** | **[str]** | | [optional] -**using** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/AttributeResultHeader.md b/gooddata-api-client/docs/AttributeResultHeader.md index d6502435c..79ca02c7a 100644 --- a/gooddata-api-client/docs/AttributeResultHeader.md +++ b/gooddata-api-client/docs/AttributeResultHeader.md @@ -3,12 +3,29 @@ Header containing the information related to attributes. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **label_value** | **str** | A value of the current attribute label. | **primary_label_value** | **str** | A value of the primary attribute label. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.attribute_result_header import AttributeResultHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of AttributeResultHeader from a JSON string +attribute_result_header_instance = AttributeResultHeader.from_json(json) +# print the JSON string representation of the object +print(AttributeResultHeader.to_json()) + +# convert the object into a dict +attribute_result_header_dict = attribute_result_header_instance.to_dict() +# create an instance of AttributeResultHeader from a dict +attribute_result_header_from_dict = AttributeResultHeader.from_dict(attribute_result_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AttributesApi.md b/gooddata-api-client/docs/AttributesApi.md index 6fac74bbc..a3d7f31d3 100644 --- a/gooddata-api-client/docs/AttributesApi.md +++ b/gooddata-api-client/docs/AttributesApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **get_all_entities_attributes** -> JsonApiAttributeOutList get_all_entities_attributes(workspace_id) +> JsonApiAttributeOutList get_all_entities_attributes(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Attributes @@ -17,11 +17,11 @@ Get all Attributes ```python -import time import gooddata_api_client -from gooddata_api_client.api import attributes_api -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -30,57 +30,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = attributes_api.AttributesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,defaultView,labels,attributeHierarchies", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Attributes - api_response = api_instance.get_all_entities_attributes(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AttributesApi->get_all_entities_attributes: %s\n" % e) + api_instance = gooddata_api_client.AttributesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;dataset.id==321;defaultView.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset,defaultView,labels,attributeHierarchies'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Attributes api_response = api_instance.get_all_entities_attributes(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of AttributesApi->get_all_entities_attributes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AttributesApi->get_all_entities_attributes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -95,7 +82,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -105,7 +91,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_attributes** -> JsonApiAttributeOutDocument get_entity_attributes(workspace_id, object_id) +> JsonApiAttributeOutDocument get_entity_attributes(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Attribute @@ -113,11 +99,11 @@ Get an Attribute ```python -import time import gooddata_api_client -from gooddata_api_client.api import attributes_api -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -126,49 +112,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = attributes_api.AttributesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,defaultView,labels,attributeHierarchies", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Attribute - api_response = api_instance.get_entity_attributes(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AttributesApi->get_entity_attributes: %s\n" % e) + api_instance = gooddata_api_client.AttributesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;dataset.id==321;defaultView.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset,defaultView,labels,attributeHierarchies'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Attribute api_response = api_instance.get_entity_attributes(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of AttributesApi->get_entity_attributes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AttributesApi->get_entity_attributes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -183,7 +158,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/AutomationAlert.md b/gooddata-api-client/docs/AutomationAlert.md index 15a95153d..87e0bc068 100644 --- a/gooddata-api-client/docs/AutomationAlert.md +++ b/gooddata-api-client/docs/AutomationAlert.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **condition** | [**AutomationAlertCondition**](AutomationAlertCondition.md) | | **execution** | [**AlertAfm**](AlertAfm.md) | | -**trigger** | **str** | Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. | [optional] if omitted the server will use the default value of "ALWAYS" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**trigger** | **str** | Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. | [optional] [default to 'ALWAYS'] + +## Example + +```python +from gooddata_api_client.models.automation_alert import AutomationAlert + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationAlert from a JSON string +automation_alert_instance = AutomationAlert.from_json(json) +# print the JSON string representation of the object +print(AutomationAlert.to_json()) +# convert the object into a dict +automation_alert_dict = automation_alert_instance.to_dict() +# create an instance of AutomationAlert from a dict +automation_alert_from_dict = AutomationAlert.from_dict(automation_alert_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationAlertCondition.md b/gooddata-api-client/docs/AutomationAlertCondition.md index 74fc9606e..1e8eaa3f1 100644 --- a/gooddata-api-client/docs/AutomationAlertCondition.md +++ b/gooddata-api-client/docs/AutomationAlertCondition.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comparison** | [**Comparison**](Comparison.md) | | [optional] -**range** | [**Range**](Range.md) | | [optional] -**relative** | [**Relative**](Relative.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**comparison** | [**Comparison**](Comparison.md) | | +**range** | [**Range**](Range.md) | | +**relative** | [**Relative**](Relative.md) | | + +## Example + +```python +from gooddata_api_client.models.automation_alert_condition import AutomationAlertCondition + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationAlertCondition from a JSON string +automation_alert_condition_instance = AutomationAlertCondition.from_json(json) +# print the JSON string representation of the object +print(AutomationAlertCondition.to_json()) +# convert the object into a dict +automation_alert_condition_dict = automation_alert_condition_instance.to_dict() +# create an instance of AutomationAlertCondition from a dict +automation_alert_condition_from_dict = AutomationAlertCondition.from_dict(automation_alert_condition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationDashboardTabularExport.md b/gooddata-api-client/docs/AutomationDashboardTabularExport.md index cb8fed783..56435c756 100644 --- a/gooddata-api-client/docs/AutomationDashboardTabularExport.md +++ b/gooddata-api-client/docs/AutomationDashboardTabularExport.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.automation_dashboard_tabular_export import AutomationDashboardTabularExport + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationDashboardTabularExport from a JSON string +automation_dashboard_tabular_export_instance = AutomationDashboardTabularExport.from_json(json) +# print the JSON string representation of the object +print(AutomationDashboardTabularExport.to_json()) + +# convert the object into a dict +automation_dashboard_tabular_export_dict = automation_dashboard_tabular_export_instance.to_dict() +# create an instance of AutomationDashboardTabularExport from a dict +automation_dashboard_tabular_export_from_dict = AutomationDashboardTabularExport.from_dict(automation_dashboard_tabular_export_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationExternalRecipient.md b/gooddata-api-client/docs/AutomationExternalRecipient.md index d239391e5..74f21ba8a 100644 --- a/gooddata-api-client/docs/AutomationExternalRecipient.md +++ b/gooddata-api-client/docs/AutomationExternalRecipient.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **str** | E-mail address to send notifications from. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.automation_external_recipient import AutomationExternalRecipient + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationExternalRecipient from a JSON string +automation_external_recipient_instance = AutomationExternalRecipient.from_json(json) +# print the JSON string representation of the object +print(AutomationExternalRecipient.to_json()) + +# convert the object into a dict +automation_external_recipient_dict = automation_external_recipient_instance.to_dict() +# create an instance of AutomationExternalRecipient from a dict +automation_external_recipient_from_dict = AutomationExternalRecipient.from_dict(automation_external_recipient_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationImageExport.md b/gooddata-api-client/docs/AutomationImageExport.md index e68769e11..358bc28de 100644 --- a/gooddata-api-client/docs/AutomationImageExport.md +++ b/gooddata-api-client/docs/AutomationImageExport.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**ImageExportRequest**](ImageExportRequest.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.automation_image_export import AutomationImageExport + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationImageExport from a JSON string +automation_image_export_instance = AutomationImageExport.from_json(json) +# print the JSON string representation of the object +print(AutomationImageExport.to_json()) + +# convert the object into a dict +automation_image_export_dict = automation_image_export_instance.to_dict() +# create an instance of AutomationImageExport from a dict +automation_image_export_from_dict = AutomationImageExport.from_dict(automation_image_export_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationMetadata.md b/gooddata-api-client/docs/AutomationMetadata.md index 9f4c599c5..5b5649e44 100644 --- a/gooddata-api-client/docs/AutomationMetadata.md +++ b/gooddata-api-client/docs/AutomationMetadata.md @@ -3,12 +3,29 @@ Additional information for the automation. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**visible_filters** | [**[VisibleFilter]**](VisibleFilter.md) | | [optional] +**visible_filters** | [**List[VisibleFilter]**](VisibleFilter.md) | | [optional] **widget** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.automation_metadata import AutomationMetadata + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationMetadata from a JSON string +automation_metadata_instance = AutomationMetadata.from_json(json) +# print the JSON string representation of the object +print(AutomationMetadata.to_json()) + +# convert the object into a dict +automation_metadata_dict = automation_metadata_instance.to_dict() +# create an instance of AutomationMetadata from a dict +automation_metadata_from_dict = AutomationMetadata.from_dict(automation_metadata_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationNotification.md b/gooddata-api-client/docs/AutomationNotification.md index 78fb7c72e..0a50219c1 100644 --- a/gooddata-api-client/docs/AutomationNotification.md +++ b/gooddata-api-client/docs/AutomationNotification.md @@ -2,12 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | [**WebhookMessage**](WebhookMessage.md) | | -**type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.automation_notification import AutomationNotification + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationNotification from a JSON string +automation_notification_instance = AutomationNotification.from_json(json) +# print the JSON string representation of the object +print(AutomationNotification.to_json()) + +# convert the object into a dict +automation_notification_dict = automation_notification_instance.to_dict() +# create an instance of AutomationNotification from a dict +automation_notification_from_dict = AutomationNotification.from_dict(automation_notification_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationNotificationAllOf.md b/gooddata-api-client/docs/AutomationNotificationAllOf.md deleted file mode 100644 index 00ed6706b..000000000 --- a/gooddata-api-client/docs/AutomationNotificationAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# AutomationNotificationAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**content** | [**WebhookMessage**](WebhookMessage.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/AutomationOrganizationViewControllerApi.md b/gooddata-api-client/docs/AutomationOrganizationViewControllerApi.md index 44b167539..7973efd25 100644 --- a/gooddata-api-client/docs/AutomationOrganizationViewControllerApi.md +++ b/gooddata-api-client/docs/AutomationOrganizationViewControllerApi.md @@ -8,7 +8,7 @@ Method | HTTP request | Description # **get_all_automations_workspace_automations** -> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations() +> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get all Automations across all Workspaces @@ -16,11 +16,11 @@ Get all Automations across all Workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import automation_organization_view_controller_api -from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.models.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -29,43 +29,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automation_organization_view_controller_api.AutomationOrganizationViewControllerApi(api_client) - filter = "title==someString;description==someString;workspace.id==321;notificationChannel.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.AutomationOrganizationViewControllerApi(api_client) + filter = 'title==someString;description==someString;workspace.id==321;notificationChannel.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Automations across all Workspaces api_response = api_instance.get_all_automations_workspace_automations(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of AutomationOrganizationViewControllerApi->get_all_automations_workspace_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationOrganizationViewControllerApi->get_all_automations_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -80,7 +75,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/AutomationRawExport.md b/gooddata-api-client/docs/AutomationRawExport.md index 85e9e6143..2becd592f 100644 --- a/gooddata-api-client/docs/AutomationRawExport.md +++ b/gooddata-api-client/docs/AutomationRawExport.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.automation_raw_export import AutomationRawExport + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationRawExport from a JSON string +automation_raw_export_instance = AutomationRawExport.from_json(json) +# print the JSON string representation of the object +print(AutomationRawExport.to_json()) + +# convert the object into a dict +automation_raw_export_dict = automation_raw_export_instance.to_dict() +# create an instance of AutomationRawExport from a dict +automation_raw_export_from_dict = AutomationRawExport.from_dict(automation_raw_export_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationSchedule.md b/gooddata-api-client/docs/AutomationSchedule.md index 4046aaba8..aaa7f087b 100644 --- a/gooddata-api-client/docs/AutomationSchedule.md +++ b/gooddata-api-client/docs/AutomationSchedule.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **cron** | **str** | Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays. | -**timezone** | **str** | Timezone in which the schedule is defined. | **cron_description** | **str** | Human-readable description of the cron expression. | [optional] [readonly] **first_run** | **datetime** | Timestamp of the first scheduled action. If not provided default to the next scheduled time. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**timezone** | **str** | Timezone in which the schedule is defined. | + +## Example + +```python +from gooddata_api_client.models.automation_schedule import AutomationSchedule + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationSchedule from a JSON string +automation_schedule_instance = AutomationSchedule.from_json(json) +# print the JSON string representation of the object +print(AutomationSchedule.to_json()) +# convert the object into a dict +automation_schedule_dict = automation_schedule_instance.to_dict() +# create an instance of AutomationSchedule from a dict +automation_schedule_from_dict = AutomationSchedule.from_dict(automation_schedule_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationSlidesExport.md b/gooddata-api-client/docs/AutomationSlidesExport.md index edbc4cc9f..bc9300813 100644 --- a/gooddata-api-client/docs/AutomationSlidesExport.md +++ b/gooddata-api-client/docs/AutomationSlidesExport.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**SlidesExportRequest**](SlidesExportRequest.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.automation_slides_export import AutomationSlidesExport + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationSlidesExport from a JSON string +automation_slides_export_instance = AutomationSlidesExport.from_json(json) +# print the JSON string representation of the object +print(AutomationSlidesExport.to_json()) + +# convert the object into a dict +automation_slides_export_dict = automation_slides_export_instance.to_dict() +# create an instance of AutomationSlidesExport from a dict +automation_slides_export_from_dict = AutomationSlidesExport.from_dict(automation_slides_export_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationTabularExport.md b/gooddata-api-client/docs/AutomationTabularExport.md index 970e2f2c4..803230863 100644 --- a/gooddata-api-client/docs/AutomationTabularExport.md +++ b/gooddata-api-client/docs/AutomationTabularExport.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**TabularExportRequest**](TabularExportRequest.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.automation_tabular_export import AutomationTabularExport + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationTabularExport from a JSON string +automation_tabular_export_instance = AutomationTabularExport.from_json(json) +# print the JSON string representation of the object +print(AutomationTabularExport.to_json()) + +# convert the object into a dict +automation_tabular_export_dict = automation_tabular_export_instance.to_dict() +# create an instance of AutomationTabularExport from a dict +automation_tabular_export_from_dict = AutomationTabularExport.from_dict(automation_tabular_export_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationVisualExport.md b/gooddata-api-client/docs/AutomationVisualExport.md index 718e20792..8d47f4425 100644 --- a/gooddata-api-client/docs/AutomationVisualExport.md +++ b/gooddata-api-client/docs/AutomationVisualExport.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**VisualExportRequest**](VisualExportRequest.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.automation_visual_export import AutomationVisualExport + +# TODO update the JSON string below +json = "{}" +# create an instance of AutomationVisualExport from a JSON string +automation_visual_export_instance = AutomationVisualExport.from_json(json) +# print the JSON string representation of the object +print(AutomationVisualExport.to_json()) + +# convert the object into a dict +automation_visual_export_dict = automation_visual_export_instance.to_dict() +# create an instance of AutomationVisualExport from a dict +automation_visual_export_from_dict = AutomationVisualExport.from_dict(automation_visual_export_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationsApi.md b/gooddata-api-client/docs/AutomationsApi.md index 8402bf348..4745bdbf5 100644 --- a/gooddata-api-client/docs/AutomationsApi.md +++ b/gooddata-api-client/docs/AutomationsApi.md @@ -29,7 +29,7 @@ Method | HTTP request | Description # **create_entity_automations** -> JsonApiAutomationOutDocument create_entity_automations(workspace_id, json_api_automation_in_document) +> JsonApiAutomationOutDocument create_entity_automations(workspace_id, json_api_automation_in_document, include=include, meta_include=meta_include) Post Automations @@ -37,12 +37,12 @@ Post Automations ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -51,301 +51,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_automation_in_document = JsonApiAutomationInDocument( - data=JsonApiAutomationIn( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationInDocument | - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Automations - api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AutomationsApi->create_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_automation_in_document = gooddata_api_client.JsonApiAutomationInDocument() # JsonApiAutomationInDocument | + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Automations api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document, include=include, meta_include=meta_include) + print("The response of AutomationsApi->create_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->create_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -360,7 +93,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -370,7 +102,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_automations** -> delete_entity_automations(workspace_id, object_id) +> delete_entity_automations(workspace_id, object_id, filter=filter) Delete an Automation @@ -378,10 +110,10 @@ Delete an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -390,37 +122,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete an Automation - api_instance.delete_entity_automations(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling AutomationsApi->delete_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete an Automation api_instance.delete_entity_automations(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->delete_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -435,7 +160,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -453,11 +177,11 @@ Delete selected automations across all workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -466,32 +190,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( - automations=[ - OrganizationAutomationIdentifier( - id="id_example", - workspace_id="workspace_id_example", - ), - ], - ) # OrganizationAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AutomationsApi(api_client) + organization_automation_management_bulk_request = gooddata_api_client.OrganizationAutomationManagementBulkRequest() # OrganizationAutomationManagementBulkRequest | + try: # Delete selected automations across all workspaces api_instance.delete_organization_automations(organization_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->delete_organization_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | ### Return type @@ -506,7 +224,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -524,11 +241,11 @@ Delete selected automations in the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -537,33 +254,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( - automations=[ - WorkspaceAutomationIdentifier( - id="id_example", - ), - ], - ) # WorkspaceAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + workspace_automation_management_bulk_request = gooddata_api_client.WorkspaceAutomationManagementBulkRequest() # WorkspaceAutomationManagementBulkRequest | + try: # Delete selected automations in the workspace api_instance.delete_workspace_automations(workspace_id, workspace_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->delete_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | ### Return type @@ -578,7 +290,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -588,7 +299,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_automations_workspace_automations** -> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations() +> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get all Automations across all Workspaces @@ -596,11 +307,11 @@ Get all Automations across all Workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.models.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -609,43 +320,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - filter = "title==someString;description==someString;workspace.id==321;notificationChannel.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.AutomationsApi(api_client) + filter = 'title==someString;description==someString;workspace.id==321;notificationChannel.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Automations across all Workspaces api_response = api_instance.get_all_automations_workspace_automations(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of AutomationsApi->get_all_automations_workspace_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->get_all_automations_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -660,7 +366,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -670,7 +375,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_automations** -> JsonApiAutomationOutList get_all_entities_automations(workspace_id) +> JsonApiAutomationOutList get_all_entities_automations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Automations @@ -678,11 +383,11 @@ Get all Automations ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.models.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -691,57 +396,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Automations - api_response = api_instance.get_all_entities_automations(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AutomationsApi->get_all_entities_automations: %s\n" % e) + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Automations api_response = api_instance.get_all_entities_automations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of AutomationsApi->get_all_entities_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->get_all_entities_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -756,7 +448,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -766,7 +457,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_automations** -> [DeclarativeAutomation] get_automations(workspace_id) +> List[DeclarativeAutomation] get_automations(workspace_id, exclude=exclude) Get automations @@ -776,11 +467,11 @@ Retrieve automations for the specific workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.declarative_automation import DeclarativeAutomation +from gooddata_api_client.models.declarative_automation import DeclarativeAutomation +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -789,43 +480,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - try: - # Get automations - api_response = api_instance.get_automations(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AutomationsApi->get_automations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get automations api_response = api_instance.get_automations(workspace_id, exclude=exclude) + print("The response of AutomationsApi->get_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->get_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **exclude** | **[str]**| | [optional] + **workspace_id** | **str**| | + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type -[**[DeclarativeAutomation]**](DeclarativeAutomation.md) +[**List[DeclarativeAutomation]**](DeclarativeAutomation.md) ### Authorization @@ -836,7 +518,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -846,7 +527,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_automations** -> JsonApiAutomationOutDocument get_entity_automations(workspace_id, object_id) +> JsonApiAutomationOutDocument get_entity_automations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Automation @@ -854,11 +535,11 @@ Get an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -867,49 +548,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Automation - api_response = api_instance.get_entity_automations(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AutomationsApi->get_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Automation api_response = api_instance.get_entity_automations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of AutomationsApi->get_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->get_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -924,7 +594,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -934,7 +603,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_automations** -> JsonApiAutomationOutDocument patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) +> JsonApiAutomationOutDocument patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, filter=filter, include=include) Patch an Automation @@ -942,12 +611,12 @@ Patch an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -956,301 +625,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_automation_patch_document = JsonApiAutomationPatchDocument( - data=JsonApiAutomationPatch( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationPatchDocument | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Automation - api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AutomationsApi->patch_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_automation_patch_document = gooddata_api_client.JsonApiAutomationPatchDocument() # JsonApiAutomationPatchDocument | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch an Automation api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, filter=filter, include=include) + print("The response of AutomationsApi->patch_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->patch_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_automation_patch_document** | [**JsonApiAutomationPatchDocument**](JsonApiAutomationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_automation_patch_document** | [**JsonApiAutomationPatchDocument**](JsonApiAutomationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -1265,7 +669,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1283,11 +686,11 @@ Pause selected automations across all workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1296,32 +699,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( - automations=[ - OrganizationAutomationIdentifier( - id="id_example", - workspace_id="workspace_id_example", - ), - ], - ) # OrganizationAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AutomationsApi(api_client) + organization_automation_management_bulk_request = gooddata_api_client.OrganizationAutomationManagementBulkRequest() # OrganizationAutomationManagementBulkRequest | + try: # Pause selected automations across all workspaces api_instance.pause_organization_automations(organization_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->pause_organization_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | ### Return type @@ -1336,7 +733,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1354,11 +750,11 @@ Pause selected automations in the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1367,33 +763,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( - automations=[ - WorkspaceAutomationIdentifier( - id="id_example", - ), - ], - ) # WorkspaceAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + workspace_automation_management_bulk_request = gooddata_api_client.WorkspaceAutomationManagementBulkRequest() # WorkspaceAutomationManagementBulkRequest | + try: # Pause selected automations in the workspace api_instance.pause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->pause_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | ### Return type @@ -1408,7 +799,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1428,11 +818,11 @@ Set automations for the specific workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.declarative_automation import DeclarativeAutomation +from gooddata_api_client.models.declarative_automation import DeclarativeAutomation +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1441,287 +831,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_automation = [ - DeclarativeAutomation( - alert=AutomationAlert( - condition=AutomationAlertCondition(None), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - dashboard_tabular_exports=[ - AutomationDashboardTabularExport( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={ - "key": "key_example", - }, - evaluation_mode="PER_RECIPIENT", - export_definitions=[ - DeclarativeExportDefinitionIdentifier( - id="export123", - type="exportDefinition", - ), - ], - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - id="/6bUUGjjNSwg0_bs", - image_exports=[ - AutomationImageExport( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=AutomationMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - notification_channel=DeclarativeNotificationChannelIdentifier( - id="webhook123", - type="notificationChannel", - ), - raw_exports=[ - AutomationRawExport( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - recipients=[ - DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ], - schedule=AutomationSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - AutomationSlidesExport( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - AutomationTabularExport( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - visual_exports=[ - AutomationVisualExport( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - ] # [DeclarativeAutomation] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_automation = [gooddata_api_client.DeclarativeAutomation()] # List[DeclarativeAutomation] | + try: # Set automations api_instance.set_automations(workspace_id, declarative_automation) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->set_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_automation** | [**[DeclarativeAutomation]**](DeclarativeAutomation.md)| | + **workspace_id** | **str**| | + **declarative_automation** | [**List[DeclarativeAutomation]**](DeclarativeAutomation.md)| | ### Return type @@ -1736,7 +867,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1756,11 +886,11 @@ Trigger the automation in the request. ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest +from gooddata_api_client.models.trigger_automation_request import TriggerAutomationRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1769,261 +899,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - trigger_automation_request = TriggerAutomationRequest( - automation=AdHocAutomation( - alert=AutomationAlert( - condition=AutomationAlertCondition(None), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - dashboard_tabular_exports=[ - AutomationDashboardTabularExport( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={ - "key": "key_example", - }, - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - image_exports=[ - AutomationImageExport( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=AutomationMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - notification_channel=DeclarativeNotificationChannelIdentifier( - id="webhook123", - type="notificationChannel", - ), - raw_exports=[ - AutomationRawExport( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - recipients=[ - DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ], - slides_exports=[ - AutomationSlidesExport( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - tabular_exports=[ - AutomationTabularExport( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=["Revenue","Sales"], - title="title_example", - visual_exports=[ - AutomationVisualExport( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - ) # TriggerAutomationRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + trigger_automation_request = gooddata_api_client.TriggerAutomationRequest() # TriggerAutomationRequest | + try: # Trigger automation. api_instance.trigger_automation(workspace_id, trigger_automation_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->trigger_automation: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **trigger_automation_request** | [**TriggerAutomationRequest**](TriggerAutomationRequest.md)| | + **workspace_id** | **str**| | + **trigger_automation_request** | [**TriggerAutomationRequest**](TriggerAutomationRequest.md)| | ### Return type @@ -2038,7 +935,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2058,10 +954,10 @@ Trigger the existing automation to execute immediately. ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2070,27 +966,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - automation_id = "automationId_example" # str | + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + automation_id = 'automation_id_example' # str | - # example passing only required values which don't have defaults set try: # Trigger existing automation. api_instance.trigger_existing_automation(workspace_id, automation_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->trigger_existing_automation: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **automation_id** | **str**| | + **workspace_id** | **str**| | + **automation_id** | **str**| | ### Return type @@ -2105,7 +1002,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2123,11 +1019,11 @@ Unpause selected automations across all workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2136,32 +1032,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( - automations=[ - OrganizationAutomationIdentifier( - id="id_example", - workspace_id="workspace_id_example", - ), - ], - ) # OrganizationAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AutomationsApi(api_client) + organization_automation_management_bulk_request = gooddata_api_client.OrganizationAutomationManagementBulkRequest() # OrganizationAutomationManagementBulkRequest | + try: # Unpause selected automations across all workspaces api_instance.unpause_organization_automations(organization_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->unpause_organization_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | ### Return type @@ -2176,7 +1066,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2194,11 +1083,11 @@ Unpause selected automations in the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2207,33 +1096,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( - automations=[ - WorkspaceAutomationIdentifier( - id="id_example", - ), - ], - ) # WorkspaceAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + workspace_automation_management_bulk_request = gooddata_api_client.WorkspaceAutomationManagementBulkRequest() # WorkspaceAutomationManagementBulkRequest | + try: # Unpause selected automations in the workspace api_instance.unpause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->unpause_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | ### Return type @@ -2248,7 +1132,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2266,10 +1149,10 @@ Unsubscribe from all automations in all workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2278,20 +1161,21 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) + api_instance = gooddata_api_client.AutomationsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Unsubscribe from all automations in all workspaces api_instance.unsubscribe_all_automations() - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->unsubscribe_all_automations: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -2307,7 +1191,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2325,10 +1208,10 @@ Unsubscribe from an automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2337,27 +1220,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - automation_id = "automationId_example" # str | + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + automation_id = 'automation_id_example' # str | - # example passing only required values which don't have defaults set try: # Unsubscribe from an automation api_instance.unsubscribe_automation(workspace_id, automation_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->unsubscribe_automation: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **automation_id** | **str**| | + **workspace_id** | **str**| | + **automation_id** | **str**| | ### Return type @@ -2372,7 +1256,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2390,11 +1273,11 @@ Unsubscribe from selected automations across all workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2403,32 +1286,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( - automations=[ - OrganizationAutomationIdentifier( - id="id_example", - workspace_id="workspace_id_example", - ), - ], - ) # OrganizationAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AutomationsApi(api_client) + organization_automation_management_bulk_request = gooddata_api_client.OrganizationAutomationManagementBulkRequest() # OrganizationAutomationManagementBulkRequest | + try: # Unsubscribe from selected automations across all workspaces api_instance.unsubscribe_organization_automations(organization_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->unsubscribe_organization_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | ### Return type @@ -2443,7 +1320,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2461,11 +1337,11 @@ Unsubscribe from selected automations in the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2474,33 +1350,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( - automations=[ - WorkspaceAutomationIdentifier( - id="id_example", - ), - ], - ) # WorkspaceAutomationManagementBulkRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + workspace_automation_management_bulk_request = gooddata_api_client.WorkspaceAutomationManagementBulkRequest() # WorkspaceAutomationManagementBulkRequest | + try: # Unsubscribe from selected automations in the workspace api_instance.unsubscribe_selected_workspace_automations(workspace_id, workspace_automation_management_bulk_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->unsubscribe_selected_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | ### Return type @@ -2515,7 +1386,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2533,10 +1403,10 @@ Unsubscribe from all automations in the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2545,25 +1415,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Unsubscribe from all automations in the workspace api_instance.unsubscribe_workspace_automations(workspace_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->unsubscribe_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type @@ -2578,7 +1449,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2588,7 +1458,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_automations** -> JsonApiAutomationOutDocument update_entity_automations(workspace_id, object_id, json_api_automation_in_document) +> JsonApiAutomationOutDocument update_entity_automations(workspace_id, object_id, json_api_automation_in_document, filter=filter, include=include) Put an Automation @@ -2596,12 +1466,12 @@ Put an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import automations_api -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2610,301 +1480,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = automations_api.AutomationsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_automation_in_document = JsonApiAutomationInDocument( - data=JsonApiAutomationIn( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationInDocument | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Automation - api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AutomationsApi->update_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.AutomationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_automation_in_document = gooddata_api_client.JsonApiAutomationInDocument() # JsonApiAutomationInDocument | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put an Automation api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, filter=filter, include=include) + print("The response of AutomationsApi->update_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AutomationsApi->update_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -2919,7 +1524,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/AvailableAssignees.md b/gooddata-api-client/docs/AvailableAssignees.md index 9720855bc..52ca7c311 100644 --- a/gooddata-api-client/docs/AvailableAssignees.md +++ b/gooddata-api-client/docs/AvailableAssignees.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user_groups** | [**[UserGroupAssignee]**](UserGroupAssignee.md) | List of user groups | -**users** | [**[UserAssignee]**](UserAssignee.md) | List of users | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**user_groups** | [**List[UserGroupAssignee]**](UserGroupAssignee.md) | List of user groups | +**users** | [**List[UserAssignee]**](UserAssignee.md) | List of users | + +## Example + +```python +from gooddata_api_client.models.available_assignees import AvailableAssignees + +# TODO update the JSON string below +json = "{}" +# create an instance of AvailableAssignees from a JSON string +available_assignees_instance = AvailableAssignees.from_json(json) +# print the JSON string representation of the object +print(AvailableAssignees.to_json()) +# convert the object into a dict +available_assignees_dict = available_assignees_instance.to_dict() +# create an instance of AvailableAssignees from a dict +available_assignees_from_dict = AvailableAssignees.from_dict(available_assignees_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AvailableDriversApi.md b/gooddata-api-client/docs/AvailableDriversApi.md index 15a6dd24d..5d693ba62 100644 --- a/gooddata-api-client/docs/AvailableDriversApi.md +++ b/gooddata-api-client/docs/AvailableDriversApi.md @@ -8,7 +8,7 @@ Method | HTTP request | Description # **get_data_source_drivers** -> {str: (str,)} get_data_source_drivers() +> Dict[str, str] get_data_source_drivers() Get all available data source drivers @@ -18,10 +18,10 @@ Retrieves a list of all supported data sources along with information about the ```python -import time import gooddata_api_client -from gooddata_api_client.api import available_drivers_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -30,26 +30,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = available_drivers_api.AvailableDriversApi(api_client) + api_instance = gooddata_api_client.AvailableDriversApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all available data source drivers api_response = api_instance.get_data_source_drivers() + print("The response of AvailableDriversApi->get_data_source_drivers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling AvailableDriversApi->get_data_source_drivers: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -**{str: (str,)}** +**Dict[str, str]** ### Authorization @@ -60,7 +62,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/BoundedFilter.md b/gooddata-api-client/docs/BoundedFilter.md index 1182bb38c..68d70363d 100644 --- a/gooddata-api-client/docs/BoundedFilter.md +++ b/gooddata-api-client/docs/BoundedFilter.md @@ -3,13 +3,30 @@ Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**var_from** | **int** | Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded. | [optional] **granularity** | **str** | Date granularity specifying particular date attribute in given dimension. | -**_from** | **int, none_type** | Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded. | [optional] -**to** | **int, none_type** | End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**to** | **int** | End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded. | [optional] + +## Example + +```python +from gooddata_api_client.models.bounded_filter import BoundedFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of BoundedFilter from a JSON string +bounded_filter_instance = BoundedFilter.from_json(json) +# print the JSON string representation of the object +print(BoundedFilter.to_json()) +# convert the object into a dict +bounded_filter_dict = bounded_filter_instance.to_dict() +# create an instance of BoundedFilter from a dict +bounded_filter_from_dict = BoundedFilter.from_dict(bounded_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/CSPDirectivesApi.md b/gooddata-api-client/docs/CSPDirectivesApi.md index 39059d822..58b2bd0fa 100644 --- a/gooddata-api-client/docs/CSPDirectivesApi.md +++ b/gooddata-api-client/docs/CSPDirectivesApi.md @@ -23,12 +23,12 @@ Post CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import csp_directives_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -37,36 +37,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = csp_directives_api.CSPDirectivesApi(api_client) - json_api_csp_directive_in_document = JsonApiCspDirectiveInDocument( - data=JsonApiCspDirectiveIn( - attributes=JsonApiCspDirectiveInAttributes( - sources=[ - "sources_example", - ], - ), - id="id1", - type="cspDirective", - ), - ) # JsonApiCspDirectiveInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.CSPDirectivesApi(api_client) + json_api_csp_directive_in_document = gooddata_api_client.JsonApiCspDirectiveInDocument() # JsonApiCspDirectiveInDocument | + try: # Post CSP Directives api_response = api_instance.create_entity_csp_directives(json_api_csp_directive_in_document) + print("The response of CSPDirectivesApi->create_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling CSPDirectivesApi->create_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | + **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | ### Return type @@ -81,7 +73,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -91,7 +82,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_csp_directives** -> delete_entity_csp_directives(id) +> delete_entity_csp_directives(id, filter=filter) Delete CSP Directives @@ -101,10 +92,10 @@ Delete CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import csp_directives_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -113,35 +104,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = csp_directives_api.CSPDirectivesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.CSPDirectivesApi(api_client) + id = 'id_example' # str | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete CSP Directives - api_instance.delete_entity_csp_directives(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling CSPDirectivesApi->delete_entity_csp_directives: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete CSP Directives api_instance.delete_entity_csp_directives(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling CSPDirectivesApi->delete_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -156,7 +140,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -166,7 +149,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_csp_directives** -> JsonApiCspDirectiveOutList get_all_entities_csp_directives() +> JsonApiCspDirectiveOutList get_all_entities_csp_directives(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get CSP Directives @@ -176,11 +159,11 @@ Get CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import csp_directives_api -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -189,39 +172,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = csp_directives_api.CSPDirectivesApi(api_client) - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.CSPDirectivesApi(api_client) + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get CSP Directives api_response = api_instance.get_all_entities_csp_directives(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of CSPDirectivesApi->get_all_entities_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling CSPDirectivesApi->get_all_entities_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -236,7 +216,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -246,7 +225,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_csp_directives** -> JsonApiCspDirectiveOutDocument get_entity_csp_directives(id) +> JsonApiCspDirectiveOutDocument get_entity_csp_directives(id, filter=filter) Get CSP Directives @@ -256,11 +235,11 @@ Get CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import csp_directives_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -269,37 +248,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = csp_directives_api.CSPDirectivesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.CSPDirectivesApi(api_client) + id = 'id_example' # str | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get CSP Directives - api_response = api_instance.get_entity_csp_directives(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling CSPDirectivesApi->get_entity_csp_directives: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get CSP Directives api_response = api_instance.get_entity_csp_directives(id, filter=filter) + print("The response of CSPDirectivesApi->get_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling CSPDirectivesApi->get_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -314,7 +286,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -324,7 +295,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_csp_directives** -> JsonApiCspDirectiveOutDocument patch_entity_csp_directives(id, json_api_csp_directive_patch_document) +> JsonApiCspDirectiveOutDocument patch_entity_csp_directives(id, json_api_csp_directive_patch_document, filter=filter) Patch CSP Directives @@ -334,12 +305,12 @@ Patch CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import csp_directives_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -348,49 +319,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = csp_directives_api.CSPDirectivesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_csp_directive_patch_document = JsonApiCspDirectivePatchDocument( - data=JsonApiCspDirectivePatch( - attributes=JsonApiCspDirectivePatchAttributes( - sources=[ - "sources_example", - ], - ), - id="id1", - type="cspDirective", - ), - ) # JsonApiCspDirectivePatchDocument | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch CSP Directives - api_response = api_instance.patch_entity_csp_directives(id, json_api_csp_directive_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling CSPDirectivesApi->patch_entity_csp_directives: %s\n" % e) + api_instance = gooddata_api_client.CSPDirectivesApi(api_client) + id = 'id_example' # str | + json_api_csp_directive_patch_document = gooddata_api_client.JsonApiCspDirectivePatchDocument() # JsonApiCspDirectivePatchDocument | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch CSP Directives api_response = api_instance.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, filter=filter) + print("The response of CSPDirectivesApi->patch_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling CSPDirectivesApi->patch_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_csp_directive_patch_document** | [**JsonApiCspDirectivePatchDocument**](JsonApiCspDirectivePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_csp_directive_patch_document** | [**JsonApiCspDirectivePatchDocument**](JsonApiCspDirectivePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -405,7 +359,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -415,7 +368,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_csp_directives** -> JsonApiCspDirectiveOutDocument update_entity_csp_directives(id, json_api_csp_directive_in_document) +> JsonApiCspDirectiveOutDocument update_entity_csp_directives(id, json_api_csp_directive_in_document, filter=filter) Put CSP Directives @@ -425,12 +378,12 @@ Put CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import csp_directives_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -439,49 +392,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = csp_directives_api.CSPDirectivesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_csp_directive_in_document = JsonApiCspDirectiveInDocument( - data=JsonApiCspDirectiveIn( - attributes=JsonApiCspDirectiveInAttributes( - sources=[ - "sources_example", - ], - ), - id="id1", - type="cspDirective", - ), - ) # JsonApiCspDirectiveInDocument | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put CSP Directives - api_response = api_instance.update_entity_csp_directives(id, json_api_csp_directive_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling CSPDirectivesApi->update_entity_csp_directives: %s\n" % e) + api_instance = gooddata_api_client.CSPDirectivesApi(api_client) + id = 'id_example' # str | + json_api_csp_directive_in_document = gooddata_api_client.JsonApiCspDirectiveInDocument() # JsonApiCspDirectiveInDocument | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put CSP Directives api_response = api_instance.update_entity_csp_directives(id, json_api_csp_directive_in_document, filter=filter) + print("The response of CSPDirectivesApi->update_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling CSPDirectivesApi->update_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -496,7 +432,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ChatHistoryInteraction.md b/gooddata-api-client/docs/ChatHistoryInteraction.md index 7f348776c..1b8348fbb 100644 --- a/gooddata-api-client/docs/ChatHistoryInteraction.md +++ b/gooddata-api-client/docs/ChatHistoryInteraction.md @@ -3,20 +3,37 @@ List of chat history interactions. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **chat_history_interaction_id** | **str** | Chat History interaction ID. Unique ID for each interaction. | -**interaction_finished** | **bool** | Has the interaction already finished? Can be used for polling when interaction is in progress. | -**question** | **str** | User question | -**routing** | [**RouteResult**](RouteResult.md) | | **created_visualizations** | [**CreatedVisualizations**](CreatedVisualizations.md) | | [optional] **error_response** | **str** | Error response in anything fails. | [optional] **found_objects** | [**FoundObjects**](FoundObjects.md) | | [optional] +**interaction_finished** | **bool** | Has the interaction already finished? Can be used for polling when interaction is in progress. | +**question** | **str** | User question | +**routing** | [**RouteResult**](RouteResult.md) | | **text_response** | **str** | Text response for general questions. | [optional] **thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] **user_feedback** | **str** | User feedback. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.chat_history_interaction import ChatHistoryInteraction + +# TODO update the JSON string below +json = "{}" +# create an instance of ChatHistoryInteraction from a JSON string +chat_history_interaction_instance = ChatHistoryInteraction.from_json(json) +# print the JSON string representation of the object +print(ChatHistoryInteraction.to_json()) + +# convert the object into a dict +chat_history_interaction_dict = chat_history_interaction_instance.to_dict() +# create an instance of ChatHistoryInteraction from a dict +chat_history_interaction_from_dict = ChatHistoryInteraction.from_dict(chat_history_interaction_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ChatHistoryRequest.md b/gooddata-api-client/docs/ChatHistoryRequest.md index 776ef3e7f..2ea86272c 100644 --- a/gooddata-api-client/docs/ChatHistoryRequest.md +++ b/gooddata-api-client/docs/ChatHistoryRequest.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **chat_history_interaction_id** | **str** | Return chat history records only after this interaction ID. If empty, complete chat history is returned. | [optional] @@ -10,8 +11,24 @@ Name | Type | Description | Notes **saved_visualization** | [**SavedVisualization**](SavedVisualization.md) | | [optional] **thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] **user_feedback** | **str** | User feedback. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.chat_history_request import ChatHistoryRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ChatHistoryRequest from a JSON string +chat_history_request_instance = ChatHistoryRequest.from_json(json) +# print the JSON string representation of the object +print(ChatHistoryRequest.to_json()) + +# convert the object into a dict +chat_history_request_dict = chat_history_request_instance.to_dict() +# create an instance of ChatHistoryRequest from a dict +chat_history_request_from_dict = ChatHistoryRequest.from_dict(chat_history_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ChatHistoryResult.md b/gooddata-api-client/docs/ChatHistoryResult.md index 2d9afc5fc..ee770148f 100644 --- a/gooddata-api-client/docs/ChatHistoryResult.md +++ b/gooddata-api-client/docs/ChatHistoryResult.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**interactions** | [**[ChatHistoryInteraction]**](ChatHistoryInteraction.md) | List of chat history interactions. | +**interactions** | [**List[ChatHistoryInteraction]**](ChatHistoryInteraction.md) | List of chat history interactions. | **thread_id** | **str** | The conversation thread ID. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.chat_history_result import ChatHistoryResult + +# TODO update the JSON string below +json = "{}" +# create an instance of ChatHistoryResult from a JSON string +chat_history_result_instance = ChatHistoryResult.from_json(json) +# print the JSON string representation of the object +print(ChatHistoryResult.to_json()) + +# convert the object into a dict +chat_history_result_dict = chat_history_result_instance.to_dict() +# create an instance of ChatHistoryResult from a dict +chat_history_result_from_dict = ChatHistoryResult.from_dict(chat_history_result_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ChatRequest.md b/gooddata-api-client/docs/ChatRequest.md index 43fd3a043..a5c0947c4 100644 --- a/gooddata-api-client/docs/ChatRequest.md +++ b/gooddata-api-client/docs/ChatRequest.md @@ -2,19 +2,36 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**limit_create** | **int** | Maximum number of created results. | [optional] [default to 3] +**limit_create_context** | **int** | Maximum number of relevant objects included into context for LLM (for each object type). | [optional] [default to 10] +**limit_search** | **int** | Maximum number of search results. | [optional] [default to 5] **question** | **str** | User question | -**limit_create** | **int** | Maximum number of created results. | [optional] if omitted the server will use the default value of 3 -**limit_create_context** | **int** | Maximum number of relevant objects included into context for LLM (for each object type). | [optional] if omitted the server will use the default value of 10 -**limit_search** | **int** | Maximum number of search results. | [optional] if omitted the server will use the default value of 5 -**relevant_score_threshold** | **float** | Score, above which we return found objects. Below this score objects are not relevant. | [optional] if omitted the server will use the default value of 0.45 -**search_score_threshold** | **float** | Score, above which we return found object(s) and don't call LLM to create new objects. | [optional] if omitted the server will use the default value of 0.9 +**relevant_score_threshold** | **float** | Score, above which we return found objects. Below this score objects are not relevant. | [optional] [default to 0.45] +**search_score_threshold** | **float** | Score, above which we return found object(s) and don't call LLM to create new objects. | [optional] [default to 0.9] **thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] -**title_to_descriptor_ratio** | **float** | Temporary for experiments. Ratio of title score to descriptor score. | [optional] if omitted the server will use the default value of 0.7 +**title_to_descriptor_ratio** | **float** | Temporary for experiments. Ratio of title score to descriptor score. | [optional] [default to 0.7] **user_context** | [**UserContext**](UserContext.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.chat_request import ChatRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ChatRequest from a JSON string +chat_request_instance = ChatRequest.from_json(json) +# print the JSON string representation of the object +print(ChatRequest.to_json()) + +# convert the object into a dict +chat_request_dict = chat_request_instance.to_dict() +# create an instance of ChatRequest from a dict +chat_request_from_dict = ChatRequest.from_dict(chat_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ChatResult.md b/gooddata-api-client/docs/ChatResult.md index ab4a1c7b1..97662c6bb 100644 --- a/gooddata-api-client/docs/ChatResult.md +++ b/gooddata-api-client/docs/ChatResult.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **chat_history_interaction_id** | **str** | Chat History interaction ID. Unique ID for each interaction. | [optional] @@ -11,8 +12,24 @@ Name | Type | Description | Notes **routing** | [**RouteResult**](RouteResult.md) | | [optional] **text_response** | **str** | Text response for general questions. | [optional] **thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.chat_result import ChatResult + +# TODO update the JSON string below +json = "{}" +# create an instance of ChatResult from a JSON string +chat_result_instance = ChatResult.from_json(json) +# print the JSON string representation of the object +print(ChatResult.to_json()) + +# convert the object into a dict +chat_result_dict = chat_result_instance.to_dict() +# create an instance of ChatResult from a dict +chat_result_from_dict = ChatResult.from_dict(chat_result_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ChatUsageResponse.md b/gooddata-api-client/docs/ChatUsageResponse.md index 79f7c4130..1536418ed 100644 --- a/gooddata-api-client/docs/ChatUsageResponse.md +++ b/gooddata-api-client/docs/ChatUsageResponse.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **interaction_count** | **int** | Number of interactions in the time window | **interaction_limit** | **int** | Maximum number of interactions in the time window any user can do in the workspace | **time_window_hours** | **int** | Time window in hours | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.chat_usage_response import ChatUsageResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ChatUsageResponse from a JSON string +chat_usage_response_instance = ChatUsageResponse.from_json(json) +# print the JSON string representation of the object +print(ChatUsageResponse.to_json()) + +# convert the object into a dict +chat_usage_response_dict = chat_usage_response_instance.to_dict() +# create an instance of ChatUsageResponse from a dict +chat_usage_response_from_dict = ChatUsageResponse.from_dict(chat_usage_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ClusteringRequest.md b/gooddata-api-client/docs/ClusteringRequest.md index 4d2e21790..acefefbdd 100644 --- a/gooddata-api-client/docs/ClusteringRequest.md +++ b/gooddata-api-client/docs/ClusteringRequest.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **number_of_clusters** | **int** | Number of clusters to create | -**threshold** | **float** | Threshold used for algorithm | [optional] if omitted the server will use the default value of 0.03 -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**threshold** | **float** | Threshold used for algorithm | [optional] [default to 0.03] + +## Example + +```python +from gooddata_api_client.models.clustering_request import ClusteringRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ClusteringRequest from a JSON string +clustering_request_instance = ClusteringRequest.from_json(json) +# print the JSON string representation of the object +print(ClusteringRequest.to_json()) +# convert the object into a dict +clustering_request_dict = clustering_request_instance.to_dict() +# create an instance of ClusteringRequest from a dict +clustering_request_from_dict = ClusteringRequest.from_dict(clustering_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ClusteringResult.md b/gooddata-api-client/docs/ClusteringResult.md index 4bf71a5de..2cf502a76 100644 --- a/gooddata-api-client/docs/ClusteringResult.md +++ b/gooddata-api-client/docs/ClusteringResult.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attribute** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | -**clusters** | **[int, none_type]** | | -**xcoord** | **[float]** | | -**ycoord** | **[float]** | | -**x_coord** | **[float, none_type]** | | [optional] -**y_coord** | **[float, none_type]** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**attribute** | **List[object]** | | +**clusters** | **List[Optional[int]]** | | +**x_coord** | **List[Optional[float]]** | | [optional] +**xcoord** | **List[float]** | | +**y_coord** | **List[Optional[float]]** | | [optional] +**ycoord** | **List[float]** | | + +## Example + +```python +from gooddata_api_client.models.clustering_result import ClusteringResult + +# TODO update the JSON string below +json = "{}" +# create an instance of ClusteringResult from a JSON string +clustering_result_instance = ClusteringResult.from_json(json) +# print the JSON string representation of the object +print(ClusteringResult.to_json()) +# convert the object into a dict +clustering_result_dict = clustering_result_instance.to_dict() +# create an instance of ClusteringResult from a dict +clustering_result_from_dict = ClusteringResult.from_dict(clustering_result_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ColumnLocation.md b/gooddata-api-client/docs/ColumnLocation.md deleted file mode 100644 index 4793453cf..000000000 --- a/gooddata-api-client/docs/ColumnLocation.md +++ /dev/null @@ -1,11 +0,0 @@ -# ColumnLocation - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ColumnOverride.md b/gooddata-api-client/docs/ColumnOverride.md index 75ab9d6c6..c134f2d54 100644 --- a/gooddata-api-client/docs/ColumnOverride.md +++ b/gooddata-api-client/docs/ColumnOverride.md @@ -3,14 +3,31 @@ Table column override. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Column name. | **label_target_column** | **str** | Specifies the attribute's column to which this label is associated. | [optional] **label_type** | **str** | Label type for the target attribute. | [optional] **ldm_type_override** | **str** | Logical Data Model type for the column. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**name** | **str** | Column name. | + +## Example + +```python +from gooddata_api_client.models.column_override import ColumnOverride + +# TODO update the JSON string below +json = "{}" +# create an instance of ColumnOverride from a JSON string +column_override_instance = ColumnOverride.from_json(json) +# print the JSON string representation of the object +print(ColumnOverride.to_json()) +# convert the object into a dict +column_override_dict = column_override_instance.to_dict() +# create an instance of ColumnOverride from a dict +column_override_from_dict = ColumnOverride.from_dict(column_override_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ColumnStatistic.md b/gooddata-api-client/docs/ColumnStatistic.md index a768548b8..8bce08216 100644 --- a/gooddata-api-client/docs/ColumnStatistic.md +++ b/gooddata-api-client/docs/ColumnStatistic.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | | **value** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.column_statistic import ColumnStatistic + +# TODO update the JSON string below +json = "{}" +# create an instance of ColumnStatistic from a JSON string +column_statistic_instance = ColumnStatistic.from_json(json) +# print the JSON string representation of the object +print(ColumnStatistic.to_json()) + +# convert the object into a dict +column_statistic_dict = column_statistic_instance.to_dict() +# create an instance of ColumnStatistic from a dict +column_statistic_from_dict = ColumnStatistic.from_dict(column_statistic_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ColumnStatisticWarning.md b/gooddata-api-client/docs/ColumnStatisticWarning.md index e02cc3578..cde03fdfc 100644 --- a/gooddata-api-client/docs/ColumnStatisticWarning.md +++ b/gooddata-api-client/docs/ColumnStatisticWarning.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **action** | **str** | | **message** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.column_statistic_warning import ColumnStatisticWarning + +# TODO update the JSON string below +json = "{}" +# create an instance of ColumnStatisticWarning from a JSON string +column_statistic_warning_instance = ColumnStatisticWarning.from_json(json) +# print the JSON string representation of the object +print(ColumnStatisticWarning.to_json()) + +# convert the object into a dict +column_statistic_warning_dict = column_statistic_warning_instance.to_dict() +# create an instance of ColumnStatisticWarning from a dict +column_statistic_warning_from_dict = ColumnStatisticWarning.from_dict(column_statistic_warning_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ColumnStatisticsRequest.md b/gooddata-api-client/docs/ColumnStatisticsRequest.md index 18ab1ea45..6cc0dad4e 100644 --- a/gooddata-api-client/docs/ColumnStatisticsRequest.md +++ b/gooddata-api-client/docs/ColumnStatisticsRequest.md @@ -3,15 +3,32 @@ A request to retrieve statistics for a column. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **column_name** | **str** | | -**_from** | [**ColumnStatisticsRequestFrom**](ColumnStatisticsRequestFrom.md) | | **frequency** | [**FrequencyProperties**](FrequencyProperties.md) | | [optional] +**var_from** | [**ColumnStatisticsRequestFrom**](ColumnStatisticsRequestFrom.md) | | **histogram** | [**HistogramProperties**](HistogramProperties.md) | | [optional] -**statistics** | **[str]** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**statistics** | **List[str]** | | [optional] + +## Example + +```python +from gooddata_api_client.models.column_statistics_request import ColumnStatisticsRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ColumnStatisticsRequest from a JSON string +column_statistics_request_instance = ColumnStatisticsRequest.from_json(json) +# print the JSON string representation of the object +print(ColumnStatisticsRequest.to_json()) +# convert the object into a dict +column_statistics_request_dict = column_statistics_request_instance.to_dict() +# create an instance of ColumnStatisticsRequest from a dict +column_statistics_request_from_dict = ColumnStatisticsRequest.from_dict(column_statistics_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ColumnStatisticsRequestFrom.md b/gooddata-api-client/docs/ColumnStatisticsRequestFrom.md index e73cc8531..3a08c7f36 100644 --- a/gooddata-api-client/docs/ColumnStatisticsRequestFrom.md +++ b/gooddata-api-client/docs/ColumnStatisticsRequestFrom.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sql** | **str** | | [optional] -**table_name** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**sql** | **str** | | +**table_name** | **str** | | + +## Example + +```python +from gooddata_api_client.models.column_statistics_request_from import ColumnStatisticsRequestFrom + +# TODO update the JSON string below +json = "{}" +# create an instance of ColumnStatisticsRequestFrom from a JSON string +column_statistics_request_from_instance = ColumnStatisticsRequestFrom.from_json(json) +# print the JSON string representation of the object +print(ColumnStatisticsRequestFrom.to_json()) +# convert the object into a dict +column_statistics_request_from_dict = column_statistics_request_from_instance.to_dict() +# create an instance of ColumnStatisticsRequestFrom from a dict +column_statistics_request_from_from_dict = ColumnStatisticsRequestFrom.from_dict(column_statistics_request_from_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ColumnStatisticsResponse.md b/gooddata-api-client/docs/ColumnStatisticsResponse.md index e262a7962..9d9df8b5e 100644 --- a/gooddata-api-client/docs/ColumnStatisticsResponse.md +++ b/gooddata-api-client/docs/ColumnStatisticsResponse.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **frequency** | [**Frequency**](Frequency.md) | | [optional] **histogram** | [**Histogram**](Histogram.md) | | [optional] -**statistics** | [**[ColumnStatistic]**](ColumnStatistic.md) | | [optional] -**warnings** | [**[ColumnStatisticWarning]**](ColumnStatisticWarning.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**statistics** | [**List[ColumnStatistic]**](ColumnStatistic.md) | | [optional] +**warnings** | [**List[ColumnStatisticWarning]**](ColumnStatisticWarning.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.column_statistics_response import ColumnStatisticsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ColumnStatisticsResponse from a JSON string +column_statistics_response_instance = ColumnStatisticsResponse.from_json(json) +# print the JSON string representation of the object +print(ColumnStatisticsResponse.to_json()) +# convert the object into a dict +column_statistics_response_dict = column_statistics_response_instance.to_dict() +# create an instance of ColumnStatisticsResponse from a dict +column_statistics_response_from_dict = ColumnStatisticsResponse.from_dict(column_statistics_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ColumnWarning.md b/gooddata-api-client/docs/ColumnWarning.md index b3253cccd..bbd2431d7 100644 --- a/gooddata-api-client/docs/ColumnWarning.md +++ b/gooddata-api-client/docs/ColumnWarning.md @@ -3,12 +3,29 @@ Warning related to single column. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **message** | **str** | Warning message related to the column. | **name** | **str** | Column name. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.column_warning import ColumnWarning + +# TODO update the JSON string below +json = "{}" +# create an instance of ColumnWarning from a JSON string +column_warning_instance = ColumnWarning.from_json(json) +# print the JSON string representation of the object +print(ColumnWarning.to_json()) + +# convert the object into a dict +column_warning_dict = column_warning_instance.to_dict() +# create an instance of ColumnWarning from a dict +column_warning_from_dict = ColumnWarning.from_dict(column_warning_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Comparison.md b/gooddata-api-client/docs/Comparison.md index 87a8ab9ef..0e8e942a3 100644 --- a/gooddata-api-client/docs/Comparison.md +++ b/gooddata-api-client/docs/Comparison.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **left** | [**LocalIdentifier**](LocalIdentifier.md) | | **operator** | **str** | | **right** | [**AlertConditionOperand**](AlertConditionOperand.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.comparison import Comparison + +# TODO update the JSON string below +json = "{}" +# create an instance of Comparison from a JSON string +comparison_instance = Comparison.from_json(json) +# print the JSON string representation of the object +print(Comparison.to_json()) + +# convert the object into a dict +comparison_dict = comparison_instance.to_dict() +# create an instance of Comparison from a dict +comparison_from_dict = Comparison.from_dict(comparison_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ComparisonMeasureValueFilter.md b/gooddata-api-client/docs/ComparisonMeasureValueFilter.md index adda7f7f3..651753fab 100644 --- a/gooddata-api-client/docs/ComparisonMeasureValueFilter.md +++ b/gooddata-api-client/docs/ComparisonMeasureValueFilter.md @@ -3,11 +3,28 @@ Filter the result by comparing specified metric to given constant value, using given comparison operator. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comparison_measure_value_filter** | [**ComparisonMeasureValueFilterComparisonMeasureValueFilter**](ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.comparison_measure_value_filter import ComparisonMeasureValueFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of ComparisonMeasureValueFilter from a JSON string +comparison_measure_value_filter_instance = ComparisonMeasureValueFilter.from_json(json) +# print the JSON string representation of the object +print(ComparisonMeasureValueFilter.to_json()) + +# convert the object into a dict +comparison_measure_value_filter_dict = comparison_measure_value_filter_instance.to_dict() +# create an instance of ComparisonMeasureValueFilter from a dict +comparison_measure_value_filter_from_dict = ComparisonMeasureValueFilter.from_dict(comparison_measure_value_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ComparisonMeasureValueFilterComparisonMeasureValueFilter.md b/gooddata-api-client/docs/ComparisonMeasureValueFilterComparisonMeasureValueFilter.md index d55392519..0dab36d7a 100644 --- a/gooddata-api-client/docs/ComparisonMeasureValueFilterComparisonMeasureValueFilter.md +++ b/gooddata-api-client/docs/ComparisonMeasureValueFilterComparisonMeasureValueFilter.md @@ -2,17 +2,34 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**measure** | [**AfmIdentifier**](AfmIdentifier.md) | | -**operator** | **str** | | -**value** | **float** | | **apply_on_result** | **bool** | | [optional] -**dimensionality** | [**[AfmIdentifier]**](AfmIdentifier.md) | References to the attributes to be used when filtering. | [optional] +**dimensionality** | [**List[AfmIdentifier]**](AfmIdentifier.md) | References to the attributes to be used when filtering. | [optional] **local_identifier** | **str** | | [optional] +**measure** | [**AfmIdentifier**](AfmIdentifier.md) | | +**operator** | **str** | | **treat_null_values_as** | **float** | A value that will be substituted for null values in the metric for the comparisons. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**value** | **float** | | + +## Example + +```python +from gooddata_api_client.models.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of ComparisonMeasureValueFilterComparisonMeasureValueFilter from a JSON string +comparison_measure_value_filter_comparison_measure_value_filter_instance = ComparisonMeasureValueFilterComparisonMeasureValueFilter.from_json(json) +# print the JSON string representation of the object +print(ComparisonMeasureValueFilterComparisonMeasureValueFilter.to_json()) +# convert the object into a dict +comparison_measure_value_filter_comparison_measure_value_filter_dict = comparison_measure_value_filter_comparison_measure_value_filter_instance.to_dict() +# create an instance of ComparisonMeasureValueFilterComparisonMeasureValueFilter from a dict +comparison_measure_value_filter_comparison_measure_value_filter_from_dict = ComparisonMeasureValueFilterComparisonMeasureValueFilter.from_dict(comparison_measure_value_filter_comparison_measure_value_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ComparisonWrapper.md b/gooddata-api-client/docs/ComparisonWrapper.md index 69c11fe50..e4cedee90 100644 --- a/gooddata-api-client/docs/ComparisonWrapper.md +++ b/gooddata-api-client/docs/ComparisonWrapper.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comparison** | [**Comparison**](Comparison.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.comparison_wrapper import ComparisonWrapper + +# TODO update the JSON string below +json = "{}" +# create an instance of ComparisonWrapper from a JSON string +comparison_wrapper_instance = ComparisonWrapper.from_json(json) +# print the JSON string representation of the object +print(ComparisonWrapper.to_json()) + +# convert the object into a dict +comparison_wrapper_dict = comparison_wrapper_instance.to_dict() +# create an instance of ComparisonWrapper from a dict +comparison_wrapper_from_dict = ComparisonWrapper.from_dict(comparison_wrapper_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ComputationApi.md b/gooddata-api-client/docs/ComputationApi.md index 86a67d936..6876e0a13 100644 --- a/gooddata-api-client/docs/ComputationApi.md +++ b/gooddata-api-client/docs/ComputationApi.md @@ -27,12 +27,12 @@ Method | HTTP request | Description ```python -import time import gooddata_api_client -from gooddata_api_client.api import computation_api -from gooddata_api_client.model.column_statistics_response import ColumnStatisticsResponse -from gooddata_api_client.model.column_statistics_request import ColumnStatisticsRequest +from gooddata_api_client.models.column_statistics_request import ColumnStatisticsRequest +from gooddata_api_client.models.column_statistics_response import ColumnStatisticsResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -41,40 +41,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = computation_api.ComputationApi(api_client) - data_source_id = "dataSourceId_example" # str | - column_statistics_request = ColumnStatisticsRequest( - column_name="column_name_example", - frequency=FrequencyProperties( - value_limit=10, - ), - _from=ColumnStatisticsRequestFrom(None), - histogram=HistogramProperties( - bucket_count=1, - ), - statistics=[ - "COUNT", - ], - ) # ColumnStatisticsRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ComputationApi(api_client) + data_source_id = 'data_source_id_example' # str | + column_statistics_request = gooddata_api_client.ColumnStatisticsRequest() # ColumnStatisticsRequest | + try: # (EXPERIMENTAL) Compute column statistics api_response = api_instance.column_statistics(data_source_id, column_statistics_request) + print("The response of ComputationApi->column_statistics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ComputationApi->column_statistics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | - **column_statistics_request** | [**ColumnStatisticsRequest**](ColumnStatisticsRequest.md)| | + **data_source_id** | **str**| | + **column_statistics_request** | [**ColumnStatisticsRequest**](ColumnStatisticsRequest.md)| | ### Return type @@ -89,7 +79,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -99,7 +88,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **compute_label_elements_post** -> ElementsResponse compute_label_elements_post(workspace_id, elements_request) +> ElementsResponse compute_label_elements_post(workspace_id, elements_request, offset=offset, limit=limit, skip_cache=skip_cache) Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. @@ -109,12 +98,12 @@ Returns paged list of elements (values) of given label satisfying given filterin ```python -import time import gooddata_api_client -from gooddata_api_client.api import computation_api -from gooddata_api_client.model.elements_request import ElementsRequest -from gooddata_api_client.model.elements_response import ElementsResponse +from gooddata_api_client.models.elements_request import ElementsRequest +from gooddata_api_client.models.elements_response import ElementsResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -123,66 +112,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = computation_api.ComputationApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - elements_request = ElementsRequest( - cache_id="cache_id_example", - complement_filter=False, - data_sampling_percentage=100.0, - depends_on=[ - ElementsRequestDependsOnInner(None), - ], - exact_filter=[ - "exact_filter_example", - ], - exclude_primary_label=False, - filter_by=FilterBy( - label_type="REQUESTED", - ), - label="label_id", - pattern_filter="pattern_filter_example", - sort_order="ASC", - validate_by=[ - ValidateByItem( - id="id_example", - type="fact", - ), - ], - ) # ElementsRequest | - offset = 0 # int | Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. (optional) if omitted the server will use the default value of 0 - limit = 1000 # int | Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. (optional) if omitted the server will use the default value of 1000 - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. - api_response = api_instance.compute_label_elements_post(workspace_id, elements_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ComputationApi->compute_label_elements_post: %s\n" % e) + api_instance = gooddata_api_client.ComputationApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + elements_request = gooddata_api_client.ElementsRequest() # ElementsRequest | + offset = 0 # int | Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. (optional) (default to 0) + limit = 1000 # int | Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. (optional) (default to 1000) + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. api_response = api_instance.compute_label_elements_post(workspace_id, elements_request, offset=offset, limit=limit, skip_cache=skip_cache) + print("The response of ComputationApi->compute_label_elements_post:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ComputationApi->compute_label_elements_post: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **elements_request** | [**ElementsRequest**](ElementsRequest.md)| | - **offset** | **int**| Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. | [optional] if omitted the server will use the default value of 0 - **limit** | **int**| Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. | [optional] if omitted the server will use the default value of 1000 - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| Workspace identifier | + **elements_request** | [**ElementsRequest**](ElementsRequest.md)| | + **offset** | **int**| Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. | [optional] [default to 0] + **limit** | **int**| Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. | [optional] [default to 1000] + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] ### Return type @@ -197,7 +156,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -207,7 +165,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **compute_report** -> AfmExecutionResponse compute_report(workspace_id, afm_execution) +> AfmExecutionResponse compute_report(workspace_id, afm_execution, skip_cache=skip_cache, timestamp=timestamp) Executes analytical request and returns link to the result @@ -217,12 +175,12 @@ AFM is a combination of attributes, measures and filters that describe a query y ```python -import time import gooddata_api_client -from gooddata_api_client.api import computation_api -from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution_response import AfmExecutionResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -231,99 +189,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = computation_api.ComputationApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - afm_execution = AfmExecution( - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - result_spec=ResultSpec( - dimensions=[ - Dimension( - item_identifiers=["attribute_1","measureGroup"], - local_identifier="firstDimension", - sorting=[ - SortKey(), - ], - ), - ], - totals=[ - Total( - function="SUM", - local_identifier="firstTotal", - metric="metric_1", - total_dimensions=[ - TotalDimension( - dimension_identifier="firstDimension", - total_dimension_items=["measureGroup"], - ), - ], - ), - ], - ), - settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - ) # AfmExecution | - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - timestamp = "2020-06-03T10:15:30+01:00" # str | (optional) - - # example passing only required values which don't have defaults set - try: - # Executes analytical request and returns link to the result - api_response = api_instance.compute_report(workspace_id, afm_execution) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ComputationApi->compute_report: %s\n" % e) + api_instance = gooddata_api_client.ComputationApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + afm_execution = gooddata_api_client.AfmExecution() # AfmExecution | + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) + timestamp = '2020-06-03T10:15:30+01:00' # str | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Executes analytical request and returns link to the result api_response = api_instance.compute_report(workspace_id, afm_execution, skip_cache=skip_cache, timestamp=timestamp) + print("The response of ComputationApi->compute_report:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ComputationApi->compute_report: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **afm_execution** | [**AfmExecution**](AfmExecution.md)| | - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False - **timestamp** | **str**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **afm_execution** | [**AfmExecution**](AfmExecution.md)| | + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] + **timestamp** | **str**| | [optional] ### Return type @@ -338,7 +231,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -358,12 +250,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import computation_api -from gooddata_api_client.model.afm_valid_descendants_query import AfmValidDescendantsQuery -from gooddata_api_client.model.afm_valid_descendants_response import AfmValidDescendantsResponse +from gooddata_api_client.models.afm_valid_descendants_query import AfmValidDescendantsQuery +from gooddata_api_client.models.afm_valid_descendants_response import AfmValidDescendantsResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -372,37 +264,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = computation_api.ComputationApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - afm_valid_descendants_query = AfmValidDescendantsQuery( - attributes=[ - AfmObjectIdentifierAttribute( - identifier=AfmObjectIdentifierAttributeIdentifier( - id="sample_item.price", - type="attribute", - ), - ), - ], - ) # AfmValidDescendantsQuery | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ComputationApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + afm_valid_descendants_query = gooddata_api_client.AfmValidDescendantsQuery() # AfmValidDescendantsQuery | + try: # (BETA) Valid descendants api_response = api_instance.compute_valid_descendants(workspace_id, afm_valid_descendants_query) + print("The response of ComputationApi->compute_valid_descendants:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ComputationApi->compute_valid_descendants: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **afm_valid_descendants_query** | [**AfmValidDescendantsQuery**](AfmValidDescendantsQuery.md)| | + **workspace_id** | **str**| Workspace identifier | + **afm_valid_descendants_query** | [**AfmValidDescendantsQuery**](AfmValidDescendantsQuery.md)| | ### Return type @@ -417,7 +302,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -437,12 +321,12 @@ Returns list containing attributes, facts, or metrics, which can be added to giv ```python -import time import gooddata_api_client -from gooddata_api_client.api import computation_api -from gooddata_api_client.model.afm_valid_objects_query import AfmValidObjectsQuery -from gooddata_api_client.model.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.models.afm_valid_objects_query import AfmValidObjectsQuery +from gooddata_api_client.models.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -451,61 +335,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = computation_api.ComputationApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - afm_valid_objects_query = AfmValidObjectsQuery( - afm=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - types=[ - "facts", - ], - ) # AfmValidObjectsQuery | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ComputationApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + afm_valid_objects_query = gooddata_api_client.AfmValidObjectsQuery() # AfmValidObjectsQuery | + try: # Valid objects api_response = api_instance.compute_valid_objects(workspace_id, afm_valid_objects_query) + print("The response of ComputationApi->compute_valid_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ComputationApi->compute_valid_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **afm_valid_objects_query** | [**AfmValidObjectsQuery**](AfmValidObjectsQuery.md)| | + **workspace_id** | **str**| Workspace identifier | + **afm_valid_objects_query** | [**AfmValidObjectsQuery**](AfmValidObjectsQuery.md)| | ### Return type @@ -520,7 +373,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -530,7 +382,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **explain_afm** -> explain_afm(workspace_id, afm_execution) +> explain_afm(workspace_id, afm_execution, explain_type=explain_type) AFM explain resource. @@ -540,11 +392,11 @@ The resource provides static structures needed for investigation of a problem wi ```python -import time import gooddata_api_client -from gooddata_api_client.api import computation_api -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution import AfmExecution +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -553,95 +405,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = computation_api.ComputationApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - afm_execution = AfmExecution( - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - result_spec=ResultSpec( - dimensions=[ - Dimension( - item_identifiers=["attribute_1","measureGroup"], - local_identifier="firstDimension", - sorting=[ - SortKey(), - ], - ), - ], - totals=[ - Total( - function="SUM", - local_identifier="firstTotal", - metric="metric_1", - total_dimensions=[ - TotalDimension( - dimension_identifier="firstDimension", - total_dimension_items=["measureGroup"], - ), - ], - ), - ], - ), - settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - ) # AfmExecution | - explain_type = "MAQL" # str | Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request (optional) - - # example passing only required values which don't have defaults set - try: - # AFM explain resource. - api_instance.explain_afm(workspace_id, afm_execution) - except gooddata_api_client.ApiException as e: - print("Exception when calling ComputationApi->explain_afm: %s\n" % e) + api_instance = gooddata_api_client.ComputationApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + afm_execution = gooddata_api_client.AfmExecution() # AfmExecution | + explain_type = 'explain_type_example' # str | Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request (optional) - # example passing only required values which don't have defaults set - # and optional values try: # AFM explain resource. api_instance.explain_afm(workspace_id, afm_execution, explain_type=explain_type) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ComputationApi->explain_afm: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **afm_execution** | [**AfmExecution**](AfmExecution.md)| | - **explain_type** | **str**| Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request | [optional] + **workspace_id** | **str**| Workspace identifier | + **afm_execution** | [**AfmExecution**](AfmExecution.md)| | + **explain_type** | **str**| Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request | [optional] ### Return type @@ -656,7 +443,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json, application/sql, application/zip, image/svg+xml - ### HTTP response details | Status code | Description | Response headers | @@ -666,7 +452,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **key_driver_analysis** -> KeyDriversResponse key_driver_analysis(workspace_id, key_drivers_request) +> KeyDriversResponse key_driver_analysis(workspace_id, key_drivers_request, skip_cache=skip_cache) (EXPERIMENTAL) Compute key driver analysis @@ -676,12 +462,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import computation_api -from gooddata_api_client.model.key_drivers_response import KeyDriversResponse -from gooddata_api_client.model.key_drivers_request import KeyDriversRequest +from gooddata_api_client.models.key_drivers_request import KeyDriversRequest +from gooddata_api_client.models.key_drivers_response import KeyDriversResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -690,51 +476,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = computation_api.ComputationApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - key_drivers_request = KeyDriversRequest( - aux_metrics=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - metric=MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - sort_direction="DESC", - ) # KeyDriversRequest | - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Compute key driver analysis - api_response = api_instance.key_driver_analysis(workspace_id, key_drivers_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ComputationApi->key_driver_analysis: %s\n" % e) + api_instance = gooddata_api_client.ComputationApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + key_drivers_request = gooddata_api_client.KeyDriversRequest() # KeyDriversRequest | + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Compute key driver analysis api_response = api_instance.key_driver_analysis(workspace_id, key_drivers_request, skip_cache=skip_cache) + print("The response of ComputationApi->key_driver_analysis:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ComputationApi->key_driver_analysis: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **key_drivers_request** | [**KeyDriversRequest**](KeyDriversRequest.md)| | - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| Workspace identifier | + **key_drivers_request** | [**KeyDriversRequest**](KeyDriversRequest.md)| | + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] ### Return type @@ -749,7 +516,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -759,7 +525,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **key_driver_analysis_result** -> KeyDriversResult key_driver_analysis_result(workspace_id, result_id) +> KeyDriversResult key_driver_analysis_result(workspace_id, result_id, offset=offset, limit=limit) (EXPERIMENTAL) Get key driver analysis result @@ -769,11 +535,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import computation_api -from gooddata_api_client.model.key_drivers_result import KeyDriversResult +from gooddata_api_client.models.key_drivers_result import KeyDriversResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -782,41 +548,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = computation_api.ComputationApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID - offset = 1 # int | (optional) - limit = 1 # int | (optional) + api_instance = gooddata_api_client.ComputationApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID + offset = 56 # int | (optional) + limit = 56 # int | (optional) - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Get key driver analysis result - api_response = api_instance.key_driver_analysis_result(workspace_id, result_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ComputationApi->key_driver_analysis_result: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Get key driver analysis result api_response = api_instance.key_driver_analysis_result(workspace_id, result_id, offset=offset, limit=limit) + print("The response of ComputationApi->key_driver_analysis_result:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ComputationApi->key_driver_analysis_result: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | - **offset** | **int**| | [optional] - **limit** | **int**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **offset** | **int**| | [optional] + **limit** | **int**| | [optional] ### Return type @@ -831,7 +590,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -851,11 +609,11 @@ The resource provides execution result's metadata as AFM and resultSpec used in ```python -import time import gooddata_api_client -from gooddata_api_client.api import computation_api -from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.models.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -864,28 +622,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = computation_api.ComputationApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID + api_instance = gooddata_api_client.ComputationApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID - # example passing only required values which don't have defaults set try: # Get a single execution result's metadata. api_response = api_instance.retrieve_execution_metadata(workspace_id, result_id) + print("The response of ComputationApi->retrieve_execution_metadata:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ComputationApi->retrieve_execution_metadata: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | ### Return type @@ -900,7 +660,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -910,7 +669,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **retrieve_result** -> ExecutionResult retrieve_result(workspace_id, result_id) +> ExecutionResult retrieve_result(workspace_id, result_id, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions, x_gdc_cancel_token=x_gdc_cancel_token) Get a single execution result @@ -920,11 +679,11 @@ Gets a single execution result. ```python -import time import gooddata_api_client -from gooddata_api_client.api import computation_api -from gooddata_api_client.model.execution_result import ExecutionResult +from gooddata_api_client.models.execution_result import ExecutionResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -933,51 +692,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = computation_api.ComputationApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID - offset = [ - offset=1,10, - ] # [int] | Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. (optional) if omitted the server will use the default value of [] - limit = [ - limit=1,10, - ] # [int] | Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. (optional) if omitted the server will use the default value of [] - excluded_total_dimensions = [ - "excludedTotalDimensions=dim_0,dim_1", - ] # [str] | Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. (optional) if omitted the server will use the default value of [] - x_gdc_cancel_token = "X-GDC-CANCEL-TOKEN_example" # str | (optional) - - # example passing only required values which don't have defaults set - try: - # Get a single execution result - api_response = api_instance.retrieve_result(workspace_id, result_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ComputationApi->retrieve_result: %s\n" % e) + api_instance = gooddata_api_client.ComputationApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID + offset = [] # List[int] | Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. (optional) (default to []) + limit = [] # List[int] | Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. (optional) (default to []) + excluded_total_dimensions = [] # List[str] | Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. (optional) (default to []) + x_gdc_cancel_token = 'x_gdc_cancel_token_example' # str | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a single execution result api_response = api_instance.retrieve_result(workspace_id, result_id, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions, x_gdc_cancel_token=x_gdc_cancel_token) + print("The response of ComputationApi->retrieve_result:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ComputationApi->retrieve_result: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | - **offset** | **[int]**| Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. | [optional] if omitted the server will use the default value of [] - **limit** | **[int]**| Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. | [optional] if omitted the server will use the default value of [] - **excluded_total_dimensions** | **[str]**| Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. | [optional] if omitted the server will use the default value of [] - **x_gdc_cancel_token** | **str**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **offset** | [**List[int]**](int.md)| Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. | [optional] [default to []] + **limit** | [**List[int]**](int.md)| Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. | [optional] [default to []] + **excluded_total_dimensions** | [**List[str]**](str.md)| Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. | [optional] [default to []] + **x_gdc_cancel_token** | **str**| | [optional] ### Return type @@ -992,7 +738,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ContentSlideTemplate.md b/gooddata-api-client/docs/ContentSlideTemplate.md index 4907ec8bc..71241d32a 100644 --- a/gooddata-api-client/docs/ContentSlideTemplate.md +++ b/gooddata-api-client/docs/ContentSlideTemplate.md @@ -3,13 +3,30 @@ Settings for content slide. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**description_field** | **str, none_type** | | [optional] +**description_field** | **str** | | [optional] **footer** | [**RunningSection**](RunningSection.md) | | [optional] **header** | [**RunningSection**](RunningSection.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.content_slide_template import ContentSlideTemplate + +# TODO update the JSON string below +json = "{}" +# create an instance of ContentSlideTemplate from a JSON string +content_slide_template_instance = ContentSlideTemplate.from_json(json) +# print the JSON string representation of the object +print(ContentSlideTemplate.to_json()) + +# convert the object into a dict +content_slide_template_dict = content_slide_template_instance.to_dict() +# create an instance of ContentSlideTemplate from a dict +content_slide_template_from_dict = ContentSlideTemplate.from_dict(content_slide_template_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ContextFiltersApi.md b/gooddata-api-client/docs/ContextFiltersApi.md index f4bc87f84..d148e68a5 100644 --- a/gooddata-api-client/docs/ContextFiltersApi.md +++ b/gooddata-api-client/docs/ContextFiltersApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **create_entity_filter_contexts** -> JsonApiFilterContextOutDocument create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document) +> JsonApiFilterContextOutDocument create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, include=include, meta_include=meta_include) Post Context Filters @@ -21,12 +21,12 @@ Post Context Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import context_filters_api -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -35,59 +35,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = context_filters_api.ContextFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_filter_context_post_optional_id_document = JsonApiFilterContextPostOptionalIdDocument( - data=JsonApiFilterContextPostOptionalId( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextPostOptionalIdDocument | - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Context Filters - api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ContextFiltersApi->create_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.ContextFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_filter_context_post_optional_id_document = gooddata_api_client.JsonApiFilterContextPostOptionalIdDocument() # JsonApiFilterContextPostOptionalIdDocument | + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Context Filters api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of ContextFiltersApi->create_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ContextFiltersApi->create_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_filter_context_post_optional_id_document** | [**JsonApiFilterContextPostOptionalIdDocument**](JsonApiFilterContextPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_filter_context_post_optional_id_document** | [**JsonApiFilterContextPostOptionalIdDocument**](JsonApiFilterContextPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -102,7 +77,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -112,7 +86,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_filter_contexts** -> delete_entity_filter_contexts(workspace_id, object_id) +> delete_entity_filter_contexts(workspace_id, object_id, filter=filter) Delete a Context Filter @@ -120,10 +94,10 @@ Delete a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import context_filters_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -132,37 +106,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = context_filters_api.ContextFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Context Filter - api_instance.delete_entity_filter_contexts(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling ContextFiltersApi->delete_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.ContextFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Context Filter api_instance.delete_entity_filter_contexts(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ContextFiltersApi->delete_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -177,7 +144,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -187,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_filter_contexts** -> JsonApiFilterContextOutList get_all_entities_filter_contexts(workspace_id) +> JsonApiFilterContextOutList get_all_entities_filter_contexts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Context Filters @@ -195,11 +161,11 @@ Get all Context Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import context_filters_api -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -208,57 +174,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = context_filters_api.ContextFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Context Filters - api_response = api_instance.get_all_entities_filter_contexts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ContextFiltersApi->get_all_entities_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.ContextFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Context Filters api_response = api_instance.get_all_entities_filter_contexts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of ContextFiltersApi->get_all_entities_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ContextFiltersApi->get_all_entities_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -273,7 +226,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -283,7 +235,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_filter_contexts** -> JsonApiFilterContextOutDocument get_entity_filter_contexts(workspace_id, object_id) +> JsonApiFilterContextOutDocument get_entity_filter_contexts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Context Filter @@ -291,11 +243,11 @@ Get a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import context_filters_api -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -304,49 +256,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = context_filters_api.ContextFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Context Filter - api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ContextFiltersApi->get_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.ContextFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Context Filter api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of ContextFiltersApi->get_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ContextFiltersApi->get_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -361,7 +302,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -371,7 +311,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_filter_contexts** -> JsonApiFilterContextOutDocument patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) +> JsonApiFilterContextOutDocument patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, filter=filter, include=include) Patch a Context Filter @@ -379,12 +319,12 @@ Patch a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import context_filters_api -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -393,59 +333,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = context_filters_api.ContextFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_context_patch_document = JsonApiFilterContextPatchDocument( - data=JsonApiFilterContextPatch( - attributes=JsonApiAnalyticalDashboardPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextPatchDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Context Filter - api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ContextFiltersApi->patch_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.ContextFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_context_patch_document = gooddata_api_client.JsonApiFilterContextPatchDocument() # JsonApiFilterContextPatchDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Context Filter api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, filter=filter, include=include) + print("The response of ContextFiltersApi->patch_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ContextFiltersApi->patch_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_context_patch_document** | [**JsonApiFilterContextPatchDocument**](JsonApiFilterContextPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_context_patch_document** | [**JsonApiFilterContextPatchDocument**](JsonApiFilterContextPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -460,7 +377,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -470,7 +386,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_filter_contexts** -> JsonApiFilterContextOutDocument update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document) +> JsonApiFilterContextOutDocument update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, filter=filter, include=include) Put a Context Filter @@ -478,12 +394,12 @@ Put a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import context_filters_api -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -492,59 +408,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = context_filters_api.ContextFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_context_in_document = JsonApiFilterContextInDocument( - data=JsonApiFilterContextIn( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextInDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Context Filter - api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ContextFiltersApi->update_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.ContextFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_context_in_document = gooddata_api_client.JsonApiFilterContextInDocument() # JsonApiFilterContextInDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Context Filter api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, filter=filter, include=include) + print("The response of ContextFiltersApi->update_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ContextFiltersApi->update_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_context_in_document** | [**JsonApiFilterContextInDocument**](JsonApiFilterContextInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_context_in_document** | [**JsonApiFilterContextInDocument**](JsonApiFilterContextInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -559,7 +452,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/CookieSecurityConfigurationApi.md b/gooddata-api-client/docs/CookieSecurityConfigurationApi.md index 14d132876..bd7e4af23 100644 --- a/gooddata-api-client/docs/CookieSecurityConfigurationApi.md +++ b/gooddata-api-client/docs/CookieSecurityConfigurationApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description # **get_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument get_entity_cookie_security_configurations(id) +> JsonApiCookieSecurityConfigurationOutDocument get_entity_cookie_security_configurations(id, filter=filter) Get CookieSecurityConfiguration @@ -18,11 +18,11 @@ Get CookieSecurityConfiguration ```python -import time import gooddata_api_client -from gooddata_api_client.api import cookie_security_configuration_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -31,37 +31,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = cookie_security_configuration_api.CookieSecurityConfigurationApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.CookieSecurityConfigurationApi(api_client) + id = 'id_example' # str | + filter = 'lastRotation==InstantValue;rotationInterval==DurationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get CookieSecurityConfiguration - api_response = api_instance.get_entity_cookie_security_configurations(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling CookieSecurityConfigurationApi->get_entity_cookie_security_configurations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get CookieSecurityConfiguration api_response = api_instance.get_entity_cookie_security_configurations(id, filter=filter) + print("The response of CookieSecurityConfigurationApi->get_entity_cookie_security_configurations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling CookieSecurityConfigurationApi->get_entity_cookie_security_configurations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -76,7 +69,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -86,7 +78,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) +> JsonApiCookieSecurityConfigurationOutDocument patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, filter=filter) Patch CookieSecurityConfiguration @@ -94,12 +86,12 @@ Patch CookieSecurityConfiguration ```python -import time import gooddata_api_client -from gooddata_api_client.api import cookie_security_configuration_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -108,48 +100,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = cookie_security_configuration_api.CookieSecurityConfigurationApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_cookie_security_configuration_patch_document = JsonApiCookieSecurityConfigurationPatchDocument( - data=JsonApiCookieSecurityConfigurationPatch( - attributes=JsonApiCookieSecurityConfigurationInAttributes( - last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), - rotation_interval="P30D", - ), - id="id1", - type="cookieSecurityConfiguration", - ), - ) # JsonApiCookieSecurityConfigurationPatchDocument | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch CookieSecurityConfiguration - api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling CookieSecurityConfigurationApi->patch_entity_cookie_security_configurations: %s\n" % e) + api_instance = gooddata_api_client.CookieSecurityConfigurationApi(api_client) + id = 'id_example' # str | + json_api_cookie_security_configuration_patch_document = gooddata_api_client.JsonApiCookieSecurityConfigurationPatchDocument() # JsonApiCookieSecurityConfigurationPatchDocument | + filter = 'lastRotation==InstantValue;rotationInterval==DurationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch CookieSecurityConfiguration api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, filter=filter) + print("The response of CookieSecurityConfigurationApi->patch_entity_cookie_security_configurations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling CookieSecurityConfigurationApi->patch_entity_cookie_security_configurations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_cookie_security_configuration_patch_document** | [**JsonApiCookieSecurityConfigurationPatchDocument**](JsonApiCookieSecurityConfigurationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_cookie_security_configuration_patch_document** | [**JsonApiCookieSecurityConfigurationPatchDocument**](JsonApiCookieSecurityConfigurationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -164,7 +140,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -174,7 +149,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document) +> JsonApiCookieSecurityConfigurationOutDocument update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, filter=filter) Put CookieSecurityConfiguration @@ -182,12 +157,12 @@ Put CookieSecurityConfiguration ```python -import time import gooddata_api_client -from gooddata_api_client.api import cookie_security_configuration_api -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -196,48 +171,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = cookie_security_configuration_api.CookieSecurityConfigurationApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_cookie_security_configuration_in_document = JsonApiCookieSecurityConfigurationInDocument( - data=JsonApiCookieSecurityConfigurationIn( - attributes=JsonApiCookieSecurityConfigurationInAttributes( - last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), - rotation_interval="P30D", - ), - id="id1", - type="cookieSecurityConfiguration", - ), - ) # JsonApiCookieSecurityConfigurationInDocument | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put CookieSecurityConfiguration - api_response = api_instance.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling CookieSecurityConfigurationApi->update_entity_cookie_security_configurations: %s\n" % e) + api_instance = gooddata_api_client.CookieSecurityConfigurationApi(api_client) + id = 'id_example' # str | + json_api_cookie_security_configuration_in_document = gooddata_api_client.JsonApiCookieSecurityConfigurationInDocument() # JsonApiCookieSecurityConfigurationInDocument | + filter = 'lastRotation==InstantValue;rotationInterval==DurationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put CookieSecurityConfiguration api_response = api_instance.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, filter=filter) + print("The response of CookieSecurityConfigurationApi->update_entity_cookie_security_configurations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling CookieSecurityConfigurationApi->update_entity_cookie_security_configurations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_cookie_security_configuration_in_document** | [**JsonApiCookieSecurityConfigurationInDocument**](JsonApiCookieSecurityConfigurationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_cookie_security_configuration_in_document** | [**JsonApiCookieSecurityConfigurationInDocument**](JsonApiCookieSecurityConfigurationInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -252,7 +211,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/CoverSlideTemplate.md b/gooddata-api-client/docs/CoverSlideTemplate.md index c2814bec1..f7edf60cf 100644 --- a/gooddata-api-client/docs/CoverSlideTemplate.md +++ b/gooddata-api-client/docs/CoverSlideTemplate.md @@ -3,14 +3,31 @@ Settings for cover slide. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**background_image** | **bool** | Show background image on the slide. | [optional] if omitted the server will use the default value of True -**description_field** | **str, none_type** | | [optional] +**background_image** | **bool** | Show background image on the slide. | [optional] [default to True] +**description_field** | **str** | | [optional] **footer** | [**RunningSection**](RunningSection.md) | | [optional] **header** | [**RunningSection**](RunningSection.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.cover_slide_template import CoverSlideTemplate + +# TODO update the JSON string below +json = "{}" +# create an instance of CoverSlideTemplate from a JSON string +cover_slide_template_instance = CoverSlideTemplate.from_json(json) +# print the JSON string representation of the object +print(CoverSlideTemplate.to_json()) + +# convert the object into a dict +cover_slide_template_dict = cover_slide_template_instance.to_dict() +# create an instance of CoverSlideTemplate from a dict +cover_slide_template_from_dict = CoverSlideTemplate.from_dict(cover_slide_template_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/CreatedVisualization.md b/gooddata-api-client/docs/CreatedVisualization.md index 66c0bf3e4..faa07a202 100644 --- a/gooddata-api-client/docs/CreatedVisualization.md +++ b/gooddata-api-client/docs/CreatedVisualization.md @@ -3,18 +3,35 @@ List of created visualization objects ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dimensionality** | [**[DimAttribute]**](DimAttribute.md) | List of attributes representing the dimensionality of the new visualization | -**filters** | [**[CreatedVisualizationFiltersInner]**](CreatedVisualizationFiltersInner.md) | List of filters to be applied to the new visualization | +**dimensionality** | [**List[DimAttribute]**](DimAttribute.md) | List of attributes representing the dimensionality of the new visualization | +**filters** | [**List[CreatedVisualizationFiltersInner]**](CreatedVisualizationFiltersInner.md) | List of filters to be applied to the new visualization | **id** | **str** | Proposed ID of the new visualization | -**metrics** | [**[Metric]**](Metric.md) | List of metrics to be used in the new visualization | -**suggestions** | [**[Suggestion]**](Suggestion.md) | Suggestions for next steps | +**metrics** | [**List[Metric]**](Metric.md) | List of metrics to be used in the new visualization | +**saved_visualization_id** | **str** | Saved visualization ID. | [optional] +**suggestions** | [**List[Suggestion]**](Suggestion.md) | Suggestions for next steps | **title** | **str** | Proposed title of the new visualization | **visualization_type** | **str** | Visualization type requested in question | -**saved_visualization_id** | **str** | Saved visualization ID. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.created_visualization import CreatedVisualization + +# TODO update the JSON string below +json = "{}" +# create an instance of CreatedVisualization from a JSON string +created_visualization_instance = CreatedVisualization.from_json(json) +# print the JSON string representation of the object +print(CreatedVisualization.to_json()) + +# convert the object into a dict +created_visualization_dict = created_visualization_instance.to_dict() +# create an instance of CreatedVisualization from a dict +created_visualization_from_dict = CreatedVisualization.from_dict(created_visualization_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/CreatedVisualizationFiltersInner.md b/gooddata-api-client/docs/CreatedVisualizationFiltersInner.md index ad5908c7b..b33bf856a 100644 --- a/gooddata-api-client/docs/CreatedVisualizationFiltersInner.md +++ b/gooddata-api-client/docs/CreatedVisualizationFiltersInner.md @@ -2,17 +2,34 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**exclude** | **[str]** | | [optional] -**using** | **str** | | [optional] -**include** | **[str]** | | [optional] -**_from** | **int** | | [optional] -**to** | **int** | | [optional] -**granularity** | **str** | | [optional] -**ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**exclude** | **List[str]** | | +**using** | **str** | | +**include** | **List[str]** | | +**var_from** | **int** | | +**to** | **int** | | +**granularity** | **str** | | +**ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | + +## Example + +```python +from gooddata_api_client.models.created_visualization_filters_inner import CreatedVisualizationFiltersInner + +# TODO update the JSON string below +json = "{}" +# create an instance of CreatedVisualizationFiltersInner from a JSON string +created_visualization_filters_inner_instance = CreatedVisualizationFiltersInner.from_json(json) +# print the JSON string representation of the object +print(CreatedVisualizationFiltersInner.to_json()) +# convert the object into a dict +created_visualization_filters_inner_dict = created_visualization_filters_inner_instance.to_dict() +# create an instance of CreatedVisualizationFiltersInner from a dict +created_visualization_filters_inner_from_dict = CreatedVisualizationFiltersInner.from_dict(created_visualization_filters_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/CreatedVisualizations.md b/gooddata-api-client/docs/CreatedVisualizations.md index b77a480d8..48f03dafe 100644 --- a/gooddata-api-client/docs/CreatedVisualizations.md +++ b/gooddata-api-client/docs/CreatedVisualizations.md @@ -3,13 +3,30 @@ Visualization definitions created by AI. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**objects** | [**[CreatedVisualization]**](CreatedVisualization.md) | List of created visualization objects | +**objects** | [**List[CreatedVisualization]**](CreatedVisualization.md) | List of created visualization objects | **reasoning** | **str** | Reasoning from LLM. Description of how and why the answer was generated. | -**suggestions** | [**[Suggestion]**](Suggestion.md) | List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**suggestions** | [**List[Suggestion]**](Suggestion.md) | List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. | + +## Example + +```python +from gooddata_api_client.models.created_visualizations import CreatedVisualizations + +# TODO update the JSON string below +json = "{}" +# create an instance of CreatedVisualizations from a JSON string +created_visualizations_instance = CreatedVisualizations.from_json(json) +# print the JSON string representation of the object +print(CreatedVisualizations.to_json()) +# convert the object into a dict +created_visualizations_dict = created_visualizations_instance.to_dict() +# create an instance of CreatedVisualizations from a dict +created_visualizations_from_dict = CreatedVisualizations.from_dict(created_visualizations_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/CustomLabel.md b/gooddata-api-client/docs/CustomLabel.md index 0b38b23d0..92fdd9323 100644 --- a/gooddata-api-client/docs/CustomLabel.md +++ b/gooddata-api-client/docs/CustomLabel.md @@ -3,11 +3,28 @@ Custom label object override. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **str** | Override value. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.custom_label import CustomLabel + +# TODO update the JSON string below +json = "{}" +# create an instance of CustomLabel from a JSON string +custom_label_instance = CustomLabel.from_json(json) +# print the JSON string representation of the object +print(CustomLabel.to_json()) + +# convert the object into a dict +custom_label_dict = custom_label_instance.to_dict() +# create an instance of CustomLabel from a dict +custom_label_from_dict = CustomLabel.from_dict(custom_label_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/CustomMetric.md b/gooddata-api-client/docs/CustomMetric.md index b1924fb65..b88c817e1 100644 --- a/gooddata-api-client/docs/CustomMetric.md +++ b/gooddata-api-client/docs/CustomMetric.md @@ -3,12 +3,29 @@ Custom metric object override. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **format** | **str** | Format override. | **title** | **str** | Metric title override. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.custom_metric import CustomMetric + +# TODO update the JSON string below +json = "{}" +# create an instance of CustomMetric from a JSON string +custom_metric_instance = CustomMetric.from_json(json) +# print the JSON string representation of the object +print(CustomMetric.to_json()) + +# convert the object into a dict +custom_metric_dict = custom_metric_instance.to_dict() +# create an instance of CustomMetric from a dict +custom_metric_from_dict = CustomMetric.from_dict(custom_metric_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/CustomOverride.md b/gooddata-api-client/docs/CustomOverride.md index 6572873c5..051eaca8c 100644 --- a/gooddata-api-client/docs/CustomOverride.md +++ b/gooddata-api-client/docs/CustomOverride.md @@ -3,12 +3,29 @@ Custom cell value overrides (IDs will be replaced with specified values). ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**labels** | [**{str: (CustomLabel,)}**](CustomLabel.md) | Map of CustomLabels with keys used as placeholders in document. | [optional] -**metrics** | [**{str: (CustomMetric,)}**](CustomMetric.md) | Map of CustomMetrics with keys used as placeholders in document. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**labels** | [**Dict[str, CustomLabel]**](CustomLabel.md) | Map of CustomLabels with keys used as placeholders in document. | [optional] +**metrics** | [**Dict[str, CustomMetric]**](CustomMetric.md) | Map of CustomMetrics with keys used as placeholders in document. | [optional] + +## Example + +```python +from gooddata_api_client.models.custom_override import CustomOverride + +# TODO update the JSON string below +json = "{}" +# create an instance of CustomOverride from a JSON string +custom_override_instance = CustomOverride.from_json(json) +# print the JSON string representation of the object +print(CustomOverride.to_json()) +# convert the object into a dict +custom_override_dict = custom_override_instance.to_dict() +# create an instance of CustomOverride from a dict +custom_override_from_dict = CustomOverride.from_dict(custom_override_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardAttributeFilter.md b/gooddata-api-client/docs/DashboardAttributeFilter.md index 9ba0fb4b9..9018ce79b 100644 --- a/gooddata-api-client/docs/DashboardAttributeFilter.md +++ b/gooddata-api-client/docs/DashboardAttributeFilter.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute_filter** | [**DashboardAttributeFilterAttributeFilter**](DashboardAttributeFilterAttributeFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.dashboard_attribute_filter import DashboardAttributeFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardAttributeFilter from a JSON string +dashboard_attribute_filter_instance = DashboardAttributeFilter.from_json(json) +# print the JSON string representation of the object +print(DashboardAttributeFilter.to_json()) + +# convert the object into a dict +dashboard_attribute_filter_dict = dashboard_attribute_filter_instance.to_dict() +# create an instance of DashboardAttributeFilter from a dict +dashboard_attribute_filter_from_dict = DashboardAttributeFilter.from_dict(dashboard_attribute_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardAttributeFilterAttributeFilter.md b/gooddata-api-client/docs/DashboardAttributeFilterAttributeFilter.md index 4c4a9b7e3..9bf8f143e 100644 --- a/gooddata-api-client/docs/DashboardAttributeFilterAttributeFilter.md +++ b/gooddata-api-client/docs/DashboardAttributeFilterAttributeFilter.md @@ -2,19 +2,36 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute_elements** | [**AttributeElements**](AttributeElements.md) | | **display_form** | [**IdentifierRef**](IdentifierRef.md) | | -**negative_selection** | **bool** | | -**filter_elements_by** | [**[AttributeFilterParent]**](AttributeFilterParent.md) | | [optional] -**filter_elements_by_date** | [**[AttributeFilterByDate]**](AttributeFilterByDate.md) | | [optional] +**filter_elements_by** | [**List[AttributeFilterParent]**](AttributeFilterParent.md) | | [optional] +**filter_elements_by_date** | [**List[AttributeFilterByDate]**](AttributeFilterByDate.md) | | [optional] **local_identifier** | **str** | | [optional] +**negative_selection** | **bool** | | **selection_mode** | **str** | | [optional] **title** | **str** | | [optional] -**validate_elements_by** | [**[IdentifierRef]**](IdentifierRef.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**validate_elements_by** | [**List[IdentifierRef]**](IdentifierRef.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.dashboard_attribute_filter_attribute_filter import DashboardAttributeFilterAttributeFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardAttributeFilterAttributeFilter from a JSON string +dashboard_attribute_filter_attribute_filter_instance = DashboardAttributeFilterAttributeFilter.from_json(json) +# print the JSON string representation of the object +print(DashboardAttributeFilterAttributeFilter.to_json()) +# convert the object into a dict +dashboard_attribute_filter_attribute_filter_dict = dashboard_attribute_filter_attribute_filter_instance.to_dict() +# create an instance of DashboardAttributeFilterAttributeFilter from a dict +dashboard_attribute_filter_attribute_filter_from_dict = DashboardAttributeFilterAttributeFilter.from_dict(dashboard_attribute_filter_attribute_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardDateFilter.md b/gooddata-api-client/docs/DashboardDateFilter.md index 09033a4c8..25ce0c4fc 100644 --- a/gooddata-api-client/docs/DashboardDateFilter.md +++ b/gooddata-api-client/docs/DashboardDateFilter.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **date_filter** | [**DashboardDateFilterDateFilter**](DashboardDateFilterDateFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.dashboard_date_filter import DashboardDateFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardDateFilter from a JSON string +dashboard_date_filter_instance = DashboardDateFilter.from_json(json) +# print the JSON string representation of the object +print(DashboardDateFilter.to_json()) + +# convert the object into a dict +dashboard_date_filter_dict = dashboard_date_filter_instance.to_dict() +# create an instance of DashboardDateFilter from a dict +dashboard_date_filter_from_dict = DashboardDateFilter.from_dict(dashboard_date_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardDateFilterDateFilter.md b/gooddata-api-client/docs/DashboardDateFilterDateFilter.md index 6e73f89f2..9f8e0a9e8 100644 --- a/gooddata-api-client/docs/DashboardDateFilterDateFilter.md +++ b/gooddata-api-client/docs/DashboardDateFilterDateFilter.md @@ -2,18 +2,35 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**granularity** | **str** | | -**type** | **str** | | **attribute** | [**IdentifierRef**](IdentifierRef.md) | | [optional] **bounded_filter** | [**RelativeBoundedDateFilter**](RelativeBoundedDateFilter.md) | | [optional] **data_set** | [**IdentifierRef**](IdentifierRef.md) | | [optional] -**_from** | [**DashboardDateFilterDateFilterFrom**](DashboardDateFilterDateFilterFrom.md) | | [optional] +**var_from** | [**DashboardDateFilterDateFilterFrom**](DashboardDateFilterDateFilterFrom.md) | | [optional] +**granularity** | **str** | | **local_identifier** | **str** | | [optional] **to** | [**DashboardDateFilterDateFilterFrom**](DashboardDateFilterDateFilterFrom.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.dashboard_date_filter_date_filter import DashboardDateFilterDateFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardDateFilterDateFilter from a JSON string +dashboard_date_filter_date_filter_instance = DashboardDateFilterDateFilter.from_json(json) +# print the JSON string representation of the object +print(DashboardDateFilterDateFilter.to_json()) +# convert the object into a dict +dashboard_date_filter_date_filter_dict = dashboard_date_filter_date_filter_instance.to_dict() +# create an instance of DashboardDateFilterDateFilter from a dict +dashboard_date_filter_date_filter_from_dict = DashboardDateFilterDateFilter.from_dict(dashboard_date_filter_date_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardDateFilterDateFilterFrom.md b/gooddata-api-client/docs/DashboardDateFilterDateFilterFrom.md index a39f31afc..8bd19d947 100644 --- a/gooddata-api-client/docs/DashboardDateFilterDateFilterFrom.md +++ b/gooddata-api-client/docs/DashboardDateFilterDateFilterFrom.md @@ -2,10 +2,27 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.dashboard_date_filter_date_filter_from import DashboardDateFilterDateFilterFrom + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardDateFilterDateFilterFrom from a JSON string +dashboard_date_filter_date_filter_from_instance = DashboardDateFilterDateFilterFrom.from_json(json) +# print the JSON string representation of the object +print(DashboardDateFilterDateFilterFrom.to_json()) + +# convert the object into a dict +dashboard_date_filter_date_filter_from_dict = dashboard_date_filter_date_filter_from_instance.to_dict() +# create an instance of DashboardDateFilterDateFilterFrom from a dict +dashboard_date_filter_date_filter_from_from_dict = DashboardDateFilterDateFilterFrom.from_dict(dashboard_date_filter_date_filter_from_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardExportSettings.md b/gooddata-api-client/docs/DashboardExportSettings.md index 4b0af9920..9caae7104 100644 --- a/gooddata-api-client/docs/DashboardExportSettings.md +++ b/gooddata-api-client/docs/DashboardExportSettings.md @@ -3,14 +3,31 @@ Additional settings. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**export_info** | **bool** | If true, the export will contain the information about the export – exported date, dashboard filters, etc. | [optional] if omitted the server will use the default value of False -**merge_headers** | **bool** | Merge equal headers in neighbouring cells. Used for [XLSX] format only. | [optional] if omitted the server will use the default value of False -**page_orientation** | **str** | Set page orientation. (PDF) | [optional] if omitted the server will use the default value of "PORTRAIT" -**page_size** | **str** | Set page size. (PDF) | [optional] if omitted the server will use the default value of "A4" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**export_info** | **bool** | If true, the export will contain the information about the export – exported date, dashboard filters, etc. | [optional] [default to False] +**merge_headers** | **bool** | Merge equal headers in neighbouring cells. Used for [XLSX] format only. | [optional] [default to False] +**page_orientation** | **str** | Set page orientation. (PDF) | [optional] [default to 'PORTRAIT'] +**page_size** | **str** | Set page size. (PDF) | [optional] [default to 'A4'] + +## Example + +```python +from gooddata_api_client.models.dashboard_export_settings import DashboardExportSettings + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardExportSettings from a JSON string +dashboard_export_settings_instance = DashboardExportSettings.from_json(json) +# print the JSON string representation of the object +print(DashboardExportSettings.to_json()) +# convert the object into a dict +dashboard_export_settings_dict = dashboard_export_settings_instance.to_dict() +# create an instance of DashboardExportSettings from a dict +dashboard_export_settings_from_dict = DashboardExportSettings.from_dict(dashboard_export_settings_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardFilter.md b/gooddata-api-client/docs/DashboardFilter.md index 0ba59320f..6bae197fc 100644 --- a/gooddata-api-client/docs/DashboardFilter.md +++ b/gooddata-api-client/docs/DashboardFilter.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attribute_filter** | [**DashboardAttributeFilterAttributeFilter**](DashboardAttributeFilterAttributeFilter.md) | | [optional] -**date_filter** | [**DashboardDateFilterDateFilter**](DashboardDateFilterDateFilter.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**attribute_filter** | [**DashboardAttributeFilterAttributeFilter**](DashboardAttributeFilterAttributeFilter.md) | | +**date_filter** | [**DashboardDateFilterDateFilter**](DashboardDateFilterDateFilter.md) | | + +## Example + +```python +from gooddata_api_client.models.dashboard_filter import DashboardFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardFilter from a JSON string +dashboard_filter_instance = DashboardFilter.from_json(json) +# print the JSON string representation of the object +print(DashboardFilter.to_json()) +# convert the object into a dict +dashboard_filter_dict = dashboard_filter_instance.to_dict() +# create an instance of DashboardFilter from a dict +dashboard_filter_from_dict = DashboardFilter.from_dict(dashboard_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardPermissions.md b/gooddata-api-client/docs/DashboardPermissions.md index ef2ff5777..7da2fe40b 100644 --- a/gooddata-api-client/docs/DashboardPermissions.md +++ b/gooddata-api-client/docs/DashboardPermissions.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**rules** | [**[RulePermission]**](RulePermission.md) | List of rules | -**user_groups** | [**[UserGroupPermission]**](UserGroupPermission.md) | List of user groups | -**users** | [**[UserPermission]**](UserPermission.md) | List of users | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**rules** | [**List[RulePermission]**](RulePermission.md) | List of rules | +**user_groups** | [**List[UserGroupPermission]**](UserGroupPermission.md) | List of user groups | +**users** | [**List[UserPermission]**](UserPermission.md) | List of users | + +## Example + +```python +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardPermissions from a JSON string +dashboard_permissions_instance = DashboardPermissions.from_json(json) +# print the JSON string representation of the object +print(DashboardPermissions.to_json()) +# convert the object into a dict +dashboard_permissions_dict = dashboard_permissions_instance.to_dict() +# create an instance of DashboardPermissions from a dict +dashboard_permissions_from_dict = DashboardPermissions.from_dict(dashboard_permissions_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardPermissionsAssignment.md b/gooddata-api-client/docs/DashboardPermissionsAssignment.md index 538afa054..a2c65c7b6 100644 --- a/gooddata-api-client/docs/DashboardPermissionsAssignment.md +++ b/gooddata-api-client/docs/DashboardPermissionsAssignment.md @@ -3,11 +3,28 @@ Desired levels of permissions for an assignee. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permissions** | **[str]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.dashboard_permissions_assignment import DashboardPermissionsAssignment + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardPermissionsAssignment from a JSON string +dashboard_permissions_assignment_instance = DashboardPermissionsAssignment.from_json(json) +# print the JSON string representation of the object +print(DashboardPermissionsAssignment.to_json()) +# convert the object into a dict +dashboard_permissions_assignment_dict = dashboard_permissions_assignment_instance.to_dict() +# create an instance of DashboardPermissionsAssignment from a dict +dashboard_permissions_assignment_from_dict = DashboardPermissionsAssignment.from_dict(dashboard_permissions_assignment_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardSlidesTemplate.md b/gooddata-api-client/docs/DashboardSlidesTemplate.md index 70ef4b2a6..fb4977ed6 100644 --- a/gooddata-api-client/docs/DashboardSlidesTemplate.md +++ b/gooddata-api-client/docs/DashboardSlidesTemplate.md @@ -3,15 +3,32 @@ Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**applied_on** | **[str]** | Export types this template applies to. | +**applied_on** | **List[str]** | Export types this template applies to. | **content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] **cover_slide** | [**CoverSlideTemplate**](CoverSlideTemplate.md) | | [optional] **intro_slide** | [**IntroSlideTemplate**](IntroSlideTemplate.md) | | [optional] **section_slide** | [**SectionSlideTemplate**](SectionSlideTemplate.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.dashboard_slides_template import DashboardSlidesTemplate + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardSlidesTemplate from a JSON string +dashboard_slides_template_instance = DashboardSlidesTemplate.from_json(json) +# print the JSON string representation of the object +print(DashboardSlidesTemplate.to_json()) + +# convert the object into a dict +dashboard_slides_template_dict = dashboard_slides_template_instance.to_dict() +# create an instance of DashboardSlidesTemplate from a dict +dashboard_slides_template_from_dict = DashboardSlidesTemplate.from_dict(dashboard_slides_template_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardTabularExportRequest.md b/gooddata-api-client/docs/DashboardTabularExportRequest.md index 511095920..5827f4a9f 100644 --- a/gooddata-api-client/docs/DashboardTabularExportRequest.md +++ b/gooddata-api-client/docs/DashboardTabularExportRequest.md @@ -3,15 +3,32 @@ Export request object describing the export properties for dashboard tabular exports. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**dashboard_filters_override** | [**List[DashboardFilter]**](DashboardFilter.md) | List of filters that will be used instead of the default dashboard filters. | [optional] **file_name** | **str** | Filename of downloaded file without extension. | **format** | **str** | Requested tabular export type. | -**dashboard_filters_override** | [**[DashboardFilter]**](DashboardFilter.md) | List of filters that will be used instead of the default dashboard filters. | [optional] **settings** | [**DashboardExportSettings**](DashboardExportSettings.md) | | [optional] -**widget_ids** | **[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**widget_ids** | **List[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | [optional] + +## Example + +```python +from gooddata_api_client.models.dashboard_tabular_export_request import DashboardTabularExportRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardTabularExportRequest from a JSON string +dashboard_tabular_export_request_instance = DashboardTabularExportRequest.from_json(json) +# print the JSON string representation of the object +print(DashboardTabularExportRequest.to_json()) +# convert the object into a dict +dashboard_tabular_export_request_dict = dashboard_tabular_export_request_instance.to_dict() +# create an instance of DashboardTabularExportRequest from a dict +dashboard_tabular_export_request_from_dict = DashboardTabularExportRequest.from_dict(dashboard_tabular_export_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardTabularExportRequestV2.md b/gooddata-api-client/docs/DashboardTabularExportRequestV2.md index a9242c74b..fa7fb45f2 100644 --- a/gooddata-api-client/docs/DashboardTabularExportRequestV2.md +++ b/gooddata-api-client/docs/DashboardTabularExportRequestV2.md @@ -3,16 +3,33 @@ Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId). ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**dashboard_filters_override** | [**List[DashboardFilter]**](DashboardFilter.md) | List of filters that will be used instead of the default dashboard filters. | [optional] **dashboard_id** | **str** | Dashboard identifier | **file_name** | **str** | Filename of downloaded file without extension. | **format** | **str** | Requested tabular export type. | -**dashboard_filters_override** | [**[DashboardFilter]**](DashboardFilter.md) | List of filters that will be used instead of the default dashboard filters. | [optional] **settings** | [**DashboardExportSettings**](DashboardExportSettings.md) | | [optional] -**widget_ids** | **[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**widget_ids** | **List[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | [optional] + +## Example + +```python +from gooddata_api_client.models.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 + +# TODO update the JSON string below +json = "{}" +# create an instance of DashboardTabularExportRequestV2 from a JSON string +dashboard_tabular_export_request_v2_instance = DashboardTabularExportRequestV2.from_json(json) +# print the JSON string representation of the object +print(DashboardTabularExportRequestV2.to_json()) +# convert the object into a dict +dashboard_tabular_export_request_v2_dict = dashboard_tabular_export_request_v2_instance.to_dict() +# create an instance of DashboardTabularExportRequestV2 from a dict +dashboard_tabular_export_request_v2_from_dict = DashboardTabularExportRequestV2.from_dict(dashboard_tabular_export_request_v2_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardsApi.md b/gooddata-api-client/docs/DashboardsApi.md index 99931a09a..89060f5c9 100644 --- a/gooddata-api-client/docs/DashboardsApi.md +++ b/gooddata-api-client/docs/DashboardsApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **create_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document) +> JsonApiAnalyticalDashboardOutDocument create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, include=include, meta_include=meta_include) Post Dashboards @@ -21,12 +21,12 @@ Post Dashboards ```python -import time import gooddata_api_client -from gooddata_api_client.api import dashboards_api -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -35,59 +35,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = dashboards_api.DashboardsApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_analytical_dashboard_post_optional_id_document = JsonApiAnalyticalDashboardPostOptionalIdDocument( - data=JsonApiAnalyticalDashboardPostOptionalId( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=permissions,origin,accessInfo,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Dashboards - api_response = api_instance.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DashboardsApi->create_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.DashboardsApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_analytical_dashboard_post_optional_id_document = gooddata_api_client.JsonApiAnalyticalDashboardPostOptionalIdDocument() # JsonApiAnalyticalDashboardPostOptionalIdDocument | + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=permissions,origin,accessInfo,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Dashboards api_response = api_instance.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of DashboardsApi->create_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DashboardsApi->create_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_analytical_dashboard_post_optional_id_document** | [**JsonApiAnalyticalDashboardPostOptionalIdDocument**](JsonApiAnalyticalDashboardPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_analytical_dashboard_post_optional_id_document** | [**JsonApiAnalyticalDashboardPostOptionalIdDocument**](JsonApiAnalyticalDashboardPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -102,7 +77,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -112,7 +86,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_analytical_dashboards** -> delete_entity_analytical_dashboards(workspace_id, object_id) +> delete_entity_analytical_dashboards(workspace_id, object_id, filter=filter) Delete a Dashboard @@ -120,10 +94,10 @@ Delete a Dashboard ```python -import time import gooddata_api_client -from gooddata_api_client.api import dashboards_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -132,37 +106,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = dashboards_api.DashboardsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Dashboard - api_instance.delete_entity_analytical_dashboards(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling DashboardsApi->delete_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.DashboardsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Dashboard api_instance.delete_entity_analytical_dashboards(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DashboardsApi->delete_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -177,7 +144,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -187,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_analytical_dashboards** -> JsonApiAnalyticalDashboardOutList get_all_entities_analytical_dashboards(workspace_id) +> JsonApiAnalyticalDashboardOutList get_all_entities_analytical_dashboards(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Dashboards @@ -195,11 +161,11 @@ Get all Dashboards ```python -import time import gooddata_api_client -from gooddata_api_client.api import dashboards_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -208,57 +174,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = dashboards_api.DashboardsApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=permissions,origin,accessInfo,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Dashboards - api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DashboardsApi->get_all_entities_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.DashboardsApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=permissions,origin,accessInfo,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Dashboards api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of DashboardsApi->get_all_entities_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DashboardsApi->get_all_entities_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -273,7 +226,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -283,7 +235,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id) +> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Dashboard @@ -291,11 +243,11 @@ Get a Dashboard ```python -import time import gooddata_api_client -from gooddata_api_client.api import dashboards_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -304,49 +256,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = dashboards_api.DashboardsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=permissions,origin,accessInfo,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Dashboard - api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DashboardsApi->get_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.DashboardsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=permissions,origin,accessInfo,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Dashboard api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of DashboardsApi->get_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DashboardsApi->get_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -361,7 +302,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -371,7 +311,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) +> JsonApiAnalyticalDashboardOutDocument patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, filter=filter, include=include) Patch a Dashboard @@ -379,12 +319,12 @@ Patch a Dashboard ```python -import time import gooddata_api_client -from gooddata_api_client.api import dashboards_api -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -393,59 +333,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = dashboards_api.DashboardsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_analytical_dashboard_patch_document = JsonApiAnalyticalDashboardPatchDocument( - data=JsonApiAnalyticalDashboardPatch( - attributes=JsonApiAnalyticalDashboardPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Dashboard - api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DashboardsApi->patch_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.DashboardsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_analytical_dashboard_patch_document = gooddata_api_client.JsonApiAnalyticalDashboardPatchDocument() # JsonApiAnalyticalDashboardPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Dashboard api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, filter=filter, include=include) + print("The response of DashboardsApi->patch_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DashboardsApi->patch_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_analytical_dashboard_patch_document** | [**JsonApiAnalyticalDashboardPatchDocument**](JsonApiAnalyticalDashboardPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_analytical_dashboard_patch_document** | [**JsonApiAnalyticalDashboardPatchDocument**](JsonApiAnalyticalDashboardPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -460,7 +377,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -470,7 +386,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document) +> JsonApiAnalyticalDashboardOutDocument update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, filter=filter, include=include) Put Dashboards @@ -478,12 +394,12 @@ Put Dashboards ```python -import time import gooddata_api_client -from gooddata_api_client.api import dashboards_api -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -492,59 +408,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = dashboards_api.DashboardsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_analytical_dashboard_in_document = JsonApiAnalyticalDashboardInDocument( - data=JsonApiAnalyticalDashboardIn( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Dashboards - api_response = api_instance.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DashboardsApi->update_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.DashboardsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_analytical_dashboard_in_document = gooddata_api_client.JsonApiAnalyticalDashboardInDocument() # JsonApiAnalyticalDashboardInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Dashboards api_response = api_instance.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, filter=filter, include=include) + print("The response of DashboardsApi->update_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DashboardsApi->update_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_analytical_dashboard_in_document** | [**JsonApiAnalyticalDashboardInDocument**](JsonApiAnalyticalDashboardInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_analytical_dashboard_in_document** | [**JsonApiAnalyticalDashboardInDocument**](JsonApiAnalyticalDashboardInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -559,7 +452,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/DataColumnLocator.md b/gooddata-api-client/docs/DataColumnLocator.md index 5719d2e95..a54a8514d 100644 --- a/gooddata-api-client/docs/DataColumnLocator.md +++ b/gooddata-api-client/docs/DataColumnLocator.md @@ -3,11 +3,28 @@ Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**properties** | **{str: (str,)}** | Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**properties** | **Dict[str, str]** | Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified. | + +## Example + +```python +from gooddata_api_client.models.data_column_locator import DataColumnLocator + +# TODO update the JSON string below +json = "{}" +# create an instance of DataColumnLocator from a JSON string +data_column_locator_instance = DataColumnLocator.from_json(json) +# print the JSON string representation of the object +print(DataColumnLocator.to_json()) +# convert the object into a dict +data_column_locator_dict = data_column_locator_instance.to_dict() +# create an instance of DataColumnLocator from a dict +data_column_locator_from_dict = DataColumnLocator.from_dict(data_column_locator_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DataColumnLocators.md b/gooddata-api-client/docs/DataColumnLocators.md index e081e7cd4..4f8c9eb27 100644 --- a/gooddata-api-client/docs/DataColumnLocators.md +++ b/gooddata-api-client/docs/DataColumnLocators.md @@ -3,11 +3,28 @@ Data column locators for the values. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**properties** | [**{str: (DataColumnLocator,)}**](DataColumnLocator.md) | Mapping from dimensions to data column locators. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**properties** | [**Dict[str, DataColumnLocator]**](DataColumnLocator.md) | Mapping from dimensions to data column locators. | [optional] + +## Example + +```python +from gooddata_api_client.models.data_column_locators import DataColumnLocators + +# TODO update the JSON string below +json = "{}" +# create an instance of DataColumnLocators from a JSON string +data_column_locators_instance = DataColumnLocators.from_json(json) +# print the JSON string representation of the object +print(DataColumnLocators.to_json()) +# convert the object into a dict +data_column_locators_dict = data_column_locators_instance.to_dict() +# create an instance of DataColumnLocators from a dict +data_column_locators_from_dict = DataColumnLocators.from_dict(data_column_locators_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DataFiltersApi.md b/gooddata-api-client/docs/DataFiltersApi.md index 3871d97ff..be445d05b 100644 --- a/gooddata-api-client/docs/DataFiltersApi.md +++ b/gooddata-api-client/docs/DataFiltersApi.md @@ -27,7 +27,7 @@ Method | HTTP request | Description # **create_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) +> JsonApiUserDataFilterOutDocument create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, include=include, meta_include=meta_include) Post User Data Filters @@ -35,12 +35,12 @@ Post User Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -49,67 +49,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_user_data_filter_post_optional_id_document = JsonApiUserDataFilterPostOptionalIdDocument( - data=JsonApiUserDataFilterPostOptionalId( - attributes=JsonApiUserDataFilterInAttributes( - are_relations_valid=True, - description="description_example", - maql="maql_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", - ), - ) # JsonApiUserDataFilterPostOptionalIdDocument | - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post User Data Filters - api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->create_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_user_data_filter_post_optional_id_document = gooddata_api_client.JsonApiUserDataFilterPostOptionalIdDocument() # JsonApiUserDataFilterPostOptionalIdDocument | + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post User Data Filters api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of DataFiltersApi->create_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->create_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_user_data_filter_post_optional_id_document** | [**JsonApiUserDataFilterPostOptionalIdDocument**](JsonApiUserDataFilterPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_user_data_filter_post_optional_id_document** | [**JsonApiUserDataFilterPostOptionalIdDocument**](JsonApiUserDataFilterPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -124,7 +91,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -134,7 +100,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) +> JsonApiWorkspaceDataFilterSettingOutDocument create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, include=include, meta_include=meta_include) Post Settings for Workspace Data Filters @@ -142,12 +108,12 @@ Post Settings for Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -156,62 +122,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( - data=JsonApiWorkspaceDataFilterSettingIn( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", - ), - ) # JsonApiWorkspaceDataFilterSettingInDocument | - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Settings for Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->create_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_workspace_data_filter_setting_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterSettingInDocument() # JsonApiWorkspaceDataFilterSettingInDocument | + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Settings for Workspace Data Filters api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, include=include, meta_include=meta_include) + print("The response of DataFiltersApi->create_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->create_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -226,7 +164,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -236,7 +173,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) +> JsonApiWorkspaceDataFilterOutDocument create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, include=include, meta_include=meta_include) Post Workspace Data Filters @@ -244,12 +181,12 @@ Post Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -258,65 +195,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( - data=JsonApiWorkspaceDataFilterIn( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), - ), - ), - type="workspaceDataFilter", - ), - ) # JsonApiWorkspaceDataFilterInDocument | - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->create_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_workspace_data_filter_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterInDocument() # JsonApiWorkspaceDataFilterInDocument | + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Workspace Data Filters api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, include=include, meta_include=meta_include) + print("The response of DataFiltersApi->create_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->create_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -331,7 +237,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -341,7 +246,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_user_data_filters** -> delete_entity_user_data_filters(workspace_id, object_id) +> delete_entity_user_data_filters(workspace_id, object_id, filter=filter) Delete a User Data Filter @@ -349,10 +254,10 @@ Delete a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -361,37 +266,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a User Data Filter - api_instance.delete_entity_user_data_filters(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->delete_entity_user_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a User Data Filter api_instance.delete_entity_user_data_filters(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->delete_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -406,7 +304,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -416,7 +313,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspace_data_filter_settings** -> delete_entity_workspace_data_filter_settings(workspace_id, object_id) +> delete_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter) Delete a Settings for Workspace Data Filter @@ -424,10 +321,10 @@ Delete a Settings for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -436,37 +333,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Settings for Workspace Data Filter - api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->delete_entity_workspace_data_filter_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Settings for Workspace Data Filter api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->delete_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -481,7 +371,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -491,7 +380,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspace_data_filters** -> delete_entity_workspace_data_filters(workspace_id, object_id) +> delete_entity_workspace_data_filters(workspace_id, object_id, filter=filter) Delete a Workspace Data Filter @@ -499,10 +388,10 @@ Delete a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -511,37 +400,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Workspace Data Filter - api_instance.delete_entity_workspace_data_filters(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->delete_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Workspace Data Filter api_instance.delete_entity_workspace_data_filters(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->delete_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -556,7 +438,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -566,7 +447,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_user_data_filters** -> JsonApiUserDataFilterOutList get_all_entities_user_data_filters(workspace_id) +> JsonApiUserDataFilterOutList get_all_entities_user_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all User Data Filters @@ -574,11 +455,11 @@ Get all User Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -587,57 +468,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all User Data Filters - api_response = api_instance.get_all_entities_user_data_filters(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->get_all_entities_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all User Data Filters api_response = api_instance.get_all_entities_user_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of DataFiltersApi->get_all_entities_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->get_all_entities_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -652,7 +520,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -662,7 +529,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id) +> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Settings for Workspace Data Filters @@ -670,11 +537,11 @@ Get all Settings for Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -683,57 +550,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Settings for Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Settings for Workspace Data Filters api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of DataFiltersApi->get_all_entities_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -748,7 +602,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -758,7 +611,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id) +> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Workspace Data Filters @@ -766,11 +619,11 @@ Get all Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -779,57 +632,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->get_all_entities_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Workspace Data Filters api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of DataFiltersApi->get_all_entities_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->get_all_entities_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -844,7 +684,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -854,7 +693,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument get_entity_user_data_filters(workspace_id, object_id) +> JsonApiUserDataFilterOutDocument get_entity_user_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a User Data Filter @@ -862,11 +701,11 @@ Get a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -875,49 +714,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a User Data Filter - api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->get_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a User Data Filter api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of DataFiltersApi->get_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->get_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -932,7 +760,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -942,7 +769,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id) +> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Setting for Workspace Data Filter @@ -950,11 +777,11 @@ Get a Setting for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -963,49 +790,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Setting for Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->get_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Setting for Workspace Data Filter api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of DataFiltersApi->get_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->get_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1020,7 +836,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1030,7 +845,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id) +> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Workspace Data Filter @@ -1038,11 +853,11 @@ Get a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1051,49 +866,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->get_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Workspace Data Filter api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of DataFiltersApi->get_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->get_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1108,7 +912,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1128,11 +931,11 @@ Retrieve all workspaces and related workspace data filters (and their settings / ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1141,21 +944,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) + api_instance = gooddata_api_client.DataFiltersApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get workspace data filters for all workspaces api_response = api_instance.get_workspace_data_filters_layout() + print("The response of DataFiltersApi->get_workspace_data_filters_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->get_workspace_data_filters_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -1171,7 +976,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1181,7 +985,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document) +> JsonApiUserDataFilterOutDocument patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, filter=filter, include=include) Patch a User Data Filter @@ -1189,12 +993,12 @@ Patch a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1203,67 +1007,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_user_data_filter_patch_document = JsonApiUserDataFilterPatchDocument( - data=JsonApiUserDataFilterPatch( - attributes=JsonApiUserDataFilterPatchAttributes( - are_relations_valid=True, - description="description_example", - maql="maql_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", - ), - ) # JsonApiUserDataFilterPatchDocument | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a User Data Filter - api_response = api_instance.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->patch_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_user_data_filter_patch_document = gooddata_api_client.JsonApiUserDataFilterPatchDocument() # JsonApiUserDataFilterPatchDocument | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a User Data Filter api_response = api_instance.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, filter=filter, include=include) + print("The response of DataFiltersApi->patch_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->patch_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_user_data_filter_patch_document** | [**JsonApiUserDataFilterPatchDocument**](JsonApiUserDataFilterPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_user_data_filter_patch_document** | [**JsonApiUserDataFilterPatchDocument**](JsonApiUserDataFilterPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -1278,7 +1051,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1288,7 +1060,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document) +> JsonApiWorkspaceDataFilterSettingOutDocument patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, filter=filter, include=include) Patch a Settings for Workspace Data Filter @@ -1296,12 +1068,12 @@ Patch a Settings for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1310,62 +1082,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_setting_patch_document = JsonApiWorkspaceDataFilterSettingPatchDocument( - data=JsonApiWorkspaceDataFilterSettingPatch( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", - ), - ) # JsonApiWorkspaceDataFilterSettingPatchDocument | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Settings for Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->patch_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_setting_patch_document = gooddata_api_client.JsonApiWorkspaceDataFilterSettingPatchDocument() # JsonApiWorkspaceDataFilterSettingPatchDocument | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Settings for Workspace Data Filter api_response = api_instance.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, filter=filter, include=include) + print("The response of DataFiltersApi->patch_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->patch_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_setting_patch_document** | [**JsonApiWorkspaceDataFilterSettingPatchDocument**](JsonApiWorkspaceDataFilterSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_setting_patch_document** | [**JsonApiWorkspaceDataFilterSettingPatchDocument**](JsonApiWorkspaceDataFilterSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -1380,7 +1126,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1390,7 +1135,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) +> JsonApiWorkspaceDataFilterOutDocument patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, filter=filter, include=include) Patch a Workspace Data Filter @@ -1398,12 +1143,12 @@ Patch a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1412,65 +1157,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_patch_document = JsonApiWorkspaceDataFilterPatchDocument( - data=JsonApiWorkspaceDataFilterPatch( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), - ), - ), - type="workspaceDataFilter", - ), - ) # JsonApiWorkspaceDataFilterPatchDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->patch_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_patch_document = gooddata_api_client.JsonApiWorkspaceDataFilterPatchDocument() # JsonApiWorkspaceDataFilterPatchDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Workspace Data Filter api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, filter=filter, include=include) + print("The response of DataFiltersApi->patch_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->patch_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_patch_document** | [**JsonApiWorkspaceDataFilterPatchDocument**](JsonApiWorkspaceDataFilterPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_patch_document** | [**JsonApiWorkspaceDataFilterPatchDocument**](JsonApiWorkspaceDataFilterPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -1485,7 +1201,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1505,11 +1220,11 @@ Sets workspace data filters in all workspaces in entire organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1518,50 +1233,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - declarative_workspace_data_filters = DeclarativeWorkspaceDataFilters( - workspace_data_filters=[ - DeclarativeWorkspaceDataFilter( - column_name="country_id", - description="ID of country", - id="country_id", - title="Country ID", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - workspace_data_filter_settings=[ - DeclarativeWorkspaceDataFilterSetting( - description="ID of country setting", - filter_values=["US"], - id="country_id_setting", - title="Country ID setting", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - ), - ], - ), - ], - ) # DeclarativeWorkspaceDataFilters | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.DataFiltersApi(api_client) + declarative_workspace_data_filters = gooddata_api_client.DeclarativeWorkspaceDataFilters() # DeclarativeWorkspaceDataFilters | + try: # Set all workspace data filters api_instance.set_workspace_data_filters_layout(declarative_workspace_data_filters) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->set_workspace_data_filters_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_workspace_data_filters** | [**DeclarativeWorkspaceDataFilters**](DeclarativeWorkspaceDataFilters.md)| | + **declarative_workspace_data_filters** | [**DeclarativeWorkspaceDataFilters**](DeclarativeWorkspaceDataFilters.md)| | ### Return type @@ -1576,7 +1267,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1586,7 +1276,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document) +> JsonApiUserDataFilterOutDocument update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, filter=filter, include=include) Put a User Data Filter @@ -1594,12 +1284,12 @@ Put a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1608,67 +1298,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_user_data_filter_in_document = JsonApiUserDataFilterInDocument( - data=JsonApiUserDataFilterIn( - attributes=JsonApiUserDataFilterInAttributes( - are_relations_valid=True, - description="description_example", - maql="maql_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", - ), - ) # JsonApiUserDataFilterInDocument | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a User Data Filter - api_response = api_instance.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->update_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_user_data_filter_in_document = gooddata_api_client.JsonApiUserDataFilterInDocument() # JsonApiUserDataFilterInDocument | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a User Data Filter api_response = api_instance.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, filter=filter, include=include) + print("The response of DataFiltersApi->update_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->update_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_user_data_filter_in_document** | [**JsonApiUserDataFilterInDocument**](JsonApiUserDataFilterInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_user_data_filter_in_document** | [**JsonApiUserDataFilterInDocument**](JsonApiUserDataFilterInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -1683,7 +1342,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1693,7 +1351,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document) +> JsonApiWorkspaceDataFilterSettingOutDocument update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, filter=filter, include=include) Put a Settings for Workspace Data Filter @@ -1701,12 +1359,12 @@ Put a Settings for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1715,62 +1373,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( - data=JsonApiWorkspaceDataFilterSettingIn( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", - ), - ) # JsonApiWorkspaceDataFilterSettingInDocument | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Settings for Workspace Data Filter - api_response = api_instance.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->update_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_setting_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterSettingInDocument() # JsonApiWorkspaceDataFilterSettingInDocument | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Settings for Workspace Data Filter api_response = api_instance.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, filter=filter, include=include) + print("The response of DataFiltersApi->update_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->update_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -1785,7 +1417,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1795,7 +1426,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document) +> JsonApiWorkspaceDataFilterOutDocument update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, filter=filter, include=include) Put a Workspace Data Filter @@ -1803,12 +1434,12 @@ Put a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1817,65 +1448,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_filters_api.DataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( - data=JsonApiWorkspaceDataFilterIn( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), - ), - ), - type="workspaceDataFilter", - ), - ) # JsonApiWorkspaceDataFilterInDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Workspace Data Filter - api_response = api_instance.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataFiltersApi->update_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.DataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterInDocument() # JsonApiWorkspaceDataFilterInDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Workspace Data Filter api_response = api_instance.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, filter=filter, include=include) + print("The response of DataFiltersApi->update_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataFiltersApi->update_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -1890,7 +1492,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md b/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md index 831b3c167..93eb104aa 100644 --- a/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md @@ -19,11 +19,11 @@ Retrieve all data sources including related physical model. ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_source_declarative_apis_api -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -32,21 +32,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_source_declarative_apis_api.DataSourceDeclarativeAPIsApi(api_client) + api_instance = gooddata_api_client.DataSourceDeclarativeAPIsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all data sources api_response = api_instance.get_data_sources_layout() + print("The response of DataSourceDeclarativeAPIsApi->get_data_sources_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataSourceDeclarativeAPIsApi->get_data_sources_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -62,7 +64,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -82,11 +83,11 @@ Set all data sources including related physical model. ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_source_declarative_apis_api -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -95,65 +96,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_source_declarative_apis_api.DataSourceDeclarativeAPIsApi(api_client) - declarative_data_sources = DeclarativeDataSources( - data_sources=[ - DeclarativeDataSource( - authentication_type="USERNAME_PASSWORD", - cache_strategy="ALWAYS", - client_id="client1234", - client_secret="client_secret_example", - decoded_parameters=[ - Parameter( - name="name_example", - value="value_example", - ), - ], - id="pg_local_docker-demo", - name="postgres demo", - parameters=[ - Parameter( - name="name_example", - value="value_example", - ), - ], - password="*****", - permissions=[ - DeclarativeDataSourcePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="demo", - token="Bigquery service account JSON. Encode it using base64!", - type="POSTGRESQL", - url="jdbc:postgresql://postgres:5432/gooddata", - username="demo", - ), - ], - ) # DeclarativeDataSources | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.DataSourceDeclarativeAPIsApi(api_client) + declarative_data_sources = gooddata_api_client.DeclarativeDataSources() # DeclarativeDataSources | + try: # Put all data sources api_instance.put_data_sources_layout(declarative_data_sources) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataSourceDeclarativeAPIsApi->put_data_sources_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_data_sources** | [**DeclarativeDataSources**](DeclarativeDataSources.md)| | + **declarative_data_sources** | [**DeclarativeDataSources**](DeclarativeDataSources.md)| | ### Return type @@ -168,7 +130,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/DataSourceEntityAPIsApi.md b/gooddata-api-client/docs/DataSourceEntityAPIsApi.md index 6da19a0f0..bda54d33f 100644 --- a/gooddata-api-client/docs/DataSourceEntityAPIsApi.md +++ b/gooddata-api-client/docs/DataSourceEntityAPIsApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description # **create_entity_data_sources** -> JsonApiDataSourceOutDocument create_entity_data_sources(json_api_data_source_in_document) +> JsonApiDataSourceOutDocument create_entity_data_sources(json_api_data_source_in_document, meta_include=meta_include) Post Data Sources @@ -25,12 +25,12 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -39,64 +39,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client) - json_api_data_source_in_document = JsonApiDataSourceInDocument( - data=JsonApiDataSourceIn( - attributes=JsonApiDataSourceInAttributes( - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourceInDocument | - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Data Sources - api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataSourceEntityAPIsApi->create_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.DataSourceEntityAPIsApi(api_client) + json_api_data_source_in_document = gooddata_api_client.JsonApiDataSourceInDocument() # JsonApiDataSourceInDocument | + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Data Sources api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document, meta_include=meta_include) + print("The response of DataSourceEntityAPIsApi->create_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataSourceEntityAPIsApi->create_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] + **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -111,7 +77,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -121,7 +86,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_data_sources** -> delete_entity_data_sources(id) +> delete_entity_data_sources(id, filter=filter) Delete Data Source entity @@ -131,10 +96,10 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_source_entity_apis_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -143,35 +108,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.DataSourceEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Data Source entity - api_instance.delete_entity_data_sources(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataSourceEntityAPIsApi->delete_entity_data_sources: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Data Source entity api_instance.delete_entity_data_sources(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataSourceEntityAPIsApi->delete_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -186,7 +144,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -196,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_data_source_identifiers** -> JsonApiDataSourceIdentifierOutList get_all_entities_data_source_identifiers() +> JsonApiDataSourceIdentifierOutList get_all_entities_data_source_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Data Source Identifiers @@ -204,11 +161,11 @@ Get all Data Source Identifiers ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -217,39 +174,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client) - filter = "name==someString;schema==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=permissions,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.DataSourceEntityAPIsApi(api_client) + filter = 'name==someString;schema==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=permissions,page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Data Source Identifiers api_response = api_instance.get_all_entities_data_source_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of DataSourceEntityAPIsApi->get_all_entities_data_source_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataSourceEntityAPIsApi->get_all_entities_data_source_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -264,7 +218,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -274,7 +227,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_data_sources** -> JsonApiDataSourceOutList get_all_entities_data_sources() +> JsonApiDataSourceOutList get_all_entities_data_sources(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get Data Source entities @@ -284,11 +237,11 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -297,39 +250,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client) - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=permissions,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.DataSourceEntityAPIsApi(api_client) + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=permissions,page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Data Source entities api_response = api_instance.get_all_entities_data_sources(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of DataSourceEntityAPIsApi->get_all_entities_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataSourceEntityAPIsApi->get_all_entities_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -344,7 +294,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -354,7 +303,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_data_source_identifiers** -> JsonApiDataSourceIdentifierOutDocument get_entity_data_source_identifiers(id) +> JsonApiDataSourceIdentifierOutDocument get_entity_data_source_identifiers(id, filter=filter, meta_include=meta_include) Get Data Source Identifier @@ -362,11 +311,11 @@ Get Data Source Identifier ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -375,41 +324,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;schema==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Data Source Identifier - api_response = api_instance.get_entity_data_source_identifiers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataSourceEntityAPIsApi->get_entity_data_source_identifiers: %s\n" % e) + api_instance = gooddata_api_client.DataSourceEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;schema==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Data Source Identifier api_response = api_instance.get_entity_data_source_identifiers(id, filter=filter, meta_include=meta_include) + print("The response of DataSourceEntityAPIsApi->get_entity_data_source_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataSourceEntityAPIsApi->get_entity_data_source_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -424,7 +364,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -434,7 +373,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_data_sources** -> JsonApiDataSourceOutDocument get_entity_data_sources(id) +> JsonApiDataSourceOutDocument get_entity_data_sources(id, filter=filter, meta_include=meta_include) Get Data Source entity @@ -444,11 +383,11 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -457,41 +396,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Data Source entity - api_response = api_instance.get_entity_data_sources(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataSourceEntityAPIsApi->get_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.DataSourceEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Data Source entity api_response = api_instance.get_entity_data_sources(id, filter=filter, meta_include=meta_include) + print("The response of DataSourceEntityAPIsApi->get_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataSourceEntityAPIsApi->get_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -506,7 +436,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -516,7 +445,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_data_sources** -> JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document) +> JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document, filter=filter) Patch Data Source entity @@ -526,12 +455,12 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -540,64 +469,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_data_source_patch_document = JsonApiDataSourcePatchDocument( - data=JsonApiDataSourcePatch( - attributes=JsonApiDataSourcePatchAttributes( - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourcePatchDocument | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Data Source entity - api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataSourceEntityAPIsApi->patch_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.DataSourceEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_data_source_patch_document = gooddata_api_client.JsonApiDataSourcePatchDocument() # JsonApiDataSourcePatchDocument | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Data Source entity api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document, filter=filter) + print("The response of DataSourceEntityAPIsApi->patch_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataSourceEntityAPIsApi->patch_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_data_source_patch_document** | [**JsonApiDataSourcePatchDocument**](JsonApiDataSourcePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_data_source_patch_document** | [**JsonApiDataSourcePatchDocument**](JsonApiDataSourcePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -612,7 +509,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -622,7 +518,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_data_sources** -> JsonApiDataSourceOutDocument update_entity_data_sources(id, json_api_data_source_in_document) +> JsonApiDataSourceOutDocument update_entity_data_sources(id, json_api_data_source_in_document, filter=filter) Put Data Source entity @@ -632,12 +528,12 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -646,64 +542,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_data_source_in_document = JsonApiDataSourceInDocument( - data=JsonApiDataSourceIn( - attributes=JsonApiDataSourceInAttributes( - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourceInDocument | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Data Source entity - api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DataSourceEntityAPIsApi->update_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.DataSourceEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_data_source_in_document = gooddata_api_client.JsonApiDataSourceInDocument() # JsonApiDataSourceInDocument | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Data Source entity api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document, filter=filter) + print("The response of DataSourceEntityAPIsApi->update_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DataSourceEntityAPIsApi->update_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -718,7 +582,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/DataSourceParameter.md b/gooddata-api-client/docs/DataSourceParameter.md index 37a73f2aa..0ec529b48 100644 --- a/gooddata-api-client/docs/DataSourceParameter.md +++ b/gooddata-api-client/docs/DataSourceParameter.md @@ -3,12 +3,29 @@ A parameter for testing data source connection ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Parameter name. | **value** | **str** | Parameter value. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.data_source_parameter import DataSourceParameter + +# TODO update the JSON string below +json = "{}" +# create an instance of DataSourceParameter from a JSON string +data_source_parameter_instance = DataSourceParameter.from_json(json) +# print the JSON string representation of the object +print(DataSourceParameter.to_json()) + +# convert the object into a dict +data_source_parameter_dict = data_source_parameter_instance.to_dict() +# create an instance of DataSourceParameter from a dict +data_source_parameter_from_dict = DataSourceParameter.from_dict(data_source_parameter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DataSourcePermissionAssignment.md b/gooddata-api-client/docs/DataSourcePermissionAssignment.md index a9b79239c..1846da71b 100644 --- a/gooddata-api-client/docs/DataSourcePermissionAssignment.md +++ b/gooddata-api-client/docs/DataSourcePermissionAssignment.md @@ -3,12 +3,29 @@ Data source permission assignments ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | -**permissions** | **[str]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.data_source_permission_assignment import DataSourcePermissionAssignment + +# TODO update the JSON string below +json = "{}" +# create an instance of DataSourcePermissionAssignment from a JSON string +data_source_permission_assignment_instance = DataSourcePermissionAssignment.from_json(json) +# print the JSON string representation of the object +print(DataSourcePermissionAssignment.to_json()) +# convert the object into a dict +data_source_permission_assignment_dict = data_source_permission_assignment_instance.to_dict() +# create an instance of DataSourcePermissionAssignment from a dict +data_source_permission_assignment_from_dict = DataSourcePermissionAssignment.from_dict(data_source_permission_assignment_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DataSourceSchemata.md b/gooddata-api-client/docs/DataSourceSchemata.md index 0d6c8258f..f4ef57efb 100644 --- a/gooddata-api-client/docs/DataSourceSchemata.md +++ b/gooddata-api-client/docs/DataSourceSchemata.md @@ -3,11 +3,28 @@ Result of getSchemata. Contains list of available DB schema names. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**schema_names** | **[str]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**schema_names** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.data_source_schemata import DataSourceSchemata + +# TODO update the JSON string below +json = "{}" +# create an instance of DataSourceSchemata from a JSON string +data_source_schemata_instance = DataSourceSchemata.from_json(json) +# print the JSON string representation of the object +print(DataSourceSchemata.to_json()) +# convert the object into a dict +data_source_schemata_dict = data_source_schemata_instance.to_dict() +# create an instance of DataSourceSchemata from a dict +data_source_schemata_from_dict = DataSourceSchemata.from_dict(data_source_schemata_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DataSourceTableIdentifier.md b/gooddata-api-client/docs/DataSourceTableIdentifier.md index b866b5cae..bb6b0370c 100644 --- a/gooddata-api-client/docs/DataSourceTableIdentifier.md +++ b/gooddata-api-client/docs/DataSourceTableIdentifier.md @@ -3,14 +3,31 @@ An id of the table. Including ID of data source. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_source_id** | **str** | Data source ID. | **id** | **str** | ID of table. | -**type** | **str** | Data source entity type. | defaults to "dataSource" -**path** | **[str], none_type** | Path to table. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**path** | **List[str]** | Path to table. | [optional] +**type** | **str** | Data source entity type. | + +## Example + +```python +from gooddata_api_client.models.data_source_table_identifier import DataSourceTableIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of DataSourceTableIdentifier from a JSON string +data_source_table_identifier_instance = DataSourceTableIdentifier.from_json(json) +# print the JSON string representation of the object +print(DataSourceTableIdentifier.to_json()) +# convert the object into a dict +data_source_table_identifier_dict = data_source_table_identifier_instance.to_dict() +# create an instance of DataSourceTableIdentifier from a dict +data_source_table_identifier_from_dict = DataSourceTableIdentifier.from_dict(data_source_table_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DatasetGrain.md b/gooddata-api-client/docs/DatasetGrain.md index c87b55cae..5e5a4ce75 100644 --- a/gooddata-api-client/docs/DatasetGrain.md +++ b/gooddata-api-client/docs/DatasetGrain.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.dataset_grain import DatasetGrain + +# TODO update the JSON string below +json = "{}" +# create an instance of DatasetGrain from a JSON string +dataset_grain_instance = DatasetGrain.from_json(json) +# print the JSON string representation of the object +print(DatasetGrain.to_json()) + +# convert the object into a dict +dataset_grain_dict = dataset_grain_instance.to_dict() +# create an instance of DatasetGrain from a dict +dataset_grain_from_dict = DatasetGrain.from_dict(dataset_grain_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DatasetReferenceIdentifier.md b/gooddata-api-client/docs/DatasetReferenceIdentifier.md index a183544c3..ecf671e11 100644 --- a/gooddata-api-client/docs/DatasetReferenceIdentifier.md +++ b/gooddata-api-client/docs/DatasetReferenceIdentifier.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "dataset" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.dataset_reference_identifier import DatasetReferenceIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of DatasetReferenceIdentifier from a JSON string +dataset_reference_identifier_instance = DatasetReferenceIdentifier.from_json(json) +# print the JSON string representation of the object +print(DatasetReferenceIdentifier.to_json()) +# convert the object into a dict +dataset_reference_identifier_dict = dataset_reference_identifier_instance.to_dict() +# create an instance of DatasetReferenceIdentifier from a dict +dataset_reference_identifier_from_dict = DatasetReferenceIdentifier.from_dict(dataset_reference_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DatasetWorkspaceDataFilterIdentifier.md b/gooddata-api-client/docs/DatasetWorkspaceDataFilterIdentifier.md index 3098c7cd8..75b707706 100644 --- a/gooddata-api-client/docs/DatasetWorkspaceDataFilterIdentifier.md +++ b/gooddata-api-client/docs/DatasetWorkspaceDataFilterIdentifier.md @@ -3,12 +3,29 @@ Identifier of a workspace data filter. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Workspace Data Filters ID. | -**type** | **str** | Filter type. | defaults to "workspaceDataFilter" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Filter type. | + +## Example + +```python +from gooddata_api_client.models.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of DatasetWorkspaceDataFilterIdentifier from a JSON string +dataset_workspace_data_filter_identifier_instance = DatasetWorkspaceDataFilterIdentifier.from_json(json) +# print the JSON string representation of the object +print(DatasetWorkspaceDataFilterIdentifier.to_json()) +# convert the object into a dict +dataset_workspace_data_filter_identifier_dict = dataset_workspace_data_filter_identifier_instance.to_dict() +# create an instance of DatasetWorkspaceDataFilterIdentifier from a dict +dataset_workspace_data_filter_identifier_from_dict = DatasetWorkspaceDataFilterIdentifier.from_dict(dataset_workspace_data_filter_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DatasetsApi.md b/gooddata-api-client/docs/DatasetsApi.md index 28a665553..9e836a8b7 100644 --- a/gooddata-api-client/docs/DatasetsApi.md +++ b/gooddata-api-client/docs/DatasetsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **get_all_entities_datasets** -> JsonApiDatasetOutList get_all_entities_datasets(workspace_id) +> JsonApiDatasetOutList get_all_entities_datasets(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Datasets @@ -17,11 +17,11 @@ Get all Datasets ```python -import time import gooddata_api_client -from gooddata_api_client.api import datasets_api -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -30,57 +30,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = datasets_api.DatasetsApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Datasets - api_response = api_instance.get_all_entities_datasets(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DatasetsApi->get_all_entities_datasets: %s\n" % e) + api_instance = gooddata_api_client.DatasetsApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,facts,aggregatedFacts,references,workspaceDataFilters'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Datasets api_response = api_instance.get_all_entities_datasets(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of DatasetsApi->get_all_entities_datasets:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DatasetsApi->get_all_entities_datasets: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -95,7 +82,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -105,7 +91,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_datasets** -> JsonApiDatasetOutDocument get_entity_datasets(workspace_id, object_id) +> JsonApiDatasetOutDocument get_entity_datasets(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Dataset @@ -113,11 +99,11 @@ Get a Dataset ```python -import time import gooddata_api_client -from gooddata_api_client.api import datasets_api -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -126,49 +112,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = datasets_api.DatasetsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Dataset - api_response = api_instance.get_entity_datasets(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling DatasetsApi->get_entity_datasets: %s\n" % e) + api_instance = gooddata_api_client.DatasetsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,facts,aggregatedFacts,references,workspaceDataFilters'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Dataset api_response = api_instance.get_entity_datasets(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of DatasetsApi->get_entity_datasets:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DatasetsApi->get_entity_datasets: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -183,7 +158,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/DateAbsoluteFilter.md b/gooddata-api-client/docs/DateAbsoluteFilter.md index 1bf764f33..feb53fbf5 100644 --- a/gooddata-api-client/docs/DateAbsoluteFilter.md +++ b/gooddata-api-client/docs/DateAbsoluteFilter.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_from** | **str** | | +**var_from** | **str** | | **to** | **str** | | **using** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.date_absolute_filter import DateAbsoluteFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of DateAbsoluteFilter from a JSON string +date_absolute_filter_instance = DateAbsoluteFilter.from_json(json) +# print the JSON string representation of the object +print(DateAbsoluteFilter.to_json()) + +# convert the object into a dict +date_absolute_filter_dict = date_absolute_filter_instance.to_dict() +# create an instance of DateAbsoluteFilter from a dict +date_absolute_filter_from_dict = DateAbsoluteFilter.from_dict(date_absolute_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DateAbsoluteFilterAllOf.md b/gooddata-api-client/docs/DateAbsoluteFilterAllOf.md deleted file mode 100644 index 015445d70..000000000 --- a/gooddata-api-client/docs/DateAbsoluteFilterAllOf.md +++ /dev/null @@ -1,14 +0,0 @@ -# DateAbsoluteFilterAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_from** | **str** | | [optional] -**to** | **str** | | [optional] -**using** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DateFilter.md b/gooddata-api-client/docs/DateFilter.md index 7efd449c4..8a750e375 100644 --- a/gooddata-api-client/docs/DateFilter.md +++ b/gooddata-api-client/docs/DateFilter.md @@ -3,12 +3,29 @@ Abstract filter definition type for dates. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] -**relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | +**relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | + +## Example + +```python +from gooddata_api_client.models.date_filter import DateFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of DateFilter from a JSON string +date_filter_instance = DateFilter.from_json(json) +# print the JSON string representation of the object +print(DateFilter.to_json()) +# convert the object into a dict +date_filter_dict = date_filter_instance.to_dict() +# create an instance of DateFilter from a dict +date_filter_from_dict = DateFilter.from_dict(date_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DateRelativeFilter.md b/gooddata-api-client/docs/DateRelativeFilter.md index 651d60b2f..76865335e 100644 --- a/gooddata-api-client/docs/DateRelativeFilter.md +++ b/gooddata-api-client/docs/DateRelativeFilter.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_from** | **int** | | +**var_from** | **int** | | **granularity** | **str** | | **to** | **int** | | **using** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.date_relative_filter import DateRelativeFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of DateRelativeFilter from a JSON string +date_relative_filter_instance = DateRelativeFilter.from_json(json) +# print the JSON string representation of the object +print(DateRelativeFilter.to_json()) + +# convert the object into a dict +date_relative_filter_dict = date_relative_filter_instance.to_dict() +# create an instance of DateRelativeFilter from a dict +date_relative_filter_from_dict = DateRelativeFilter.from_dict(date_relative_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DateRelativeFilterAllOf.md b/gooddata-api-client/docs/DateRelativeFilterAllOf.md deleted file mode 100644 index 9697c791e..000000000 --- a/gooddata-api-client/docs/DateRelativeFilterAllOf.md +++ /dev/null @@ -1,15 +0,0 @@ -# DateRelativeFilterAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_from** | **int** | | [optional] -**granularity** | **str** | | [optional] -**to** | **int** | | [optional] -**using** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DateValue.md b/gooddata-api-client/docs/DateValue.md index 5bcb48647..e8957b517 100644 --- a/gooddata-api-client/docs/DateValue.md +++ b/gooddata-api-client/docs/DateValue.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.date_value import DateValue + +# TODO update the JSON string below +json = "{}" +# create an instance of DateValue from a JSON string +date_value_instance = DateValue.from_json(json) +# print the JSON string representation of the object +print(DateValue.to_json()) + +# convert the object into a dict +date_value_dict = date_value_instance.to_dict() +# create an instance of DateValue from a dict +date_value_from_dict = DateValue.from_dict(date_value_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAggregatedFact.md b/gooddata-api-client/docs/DeclarativeAggregatedFact.md index cb910a6d1..a73c3cd11 100644 --- a/gooddata-api-client/docs/DeclarativeAggregatedFact.md +++ b/gooddata-api-client/docs/DeclarativeAggregatedFact.md @@ -3,16 +3,33 @@ A dataset fact. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**description** | **str** | Fact description. | [optional] **id** | **str** | Fact ID. | **source_column** | **str** | A name of the source column in the table. | -**source_fact_reference** | [**DeclarativeSourceFactReference**](DeclarativeSourceFactReference.md) | | -**description** | **str** | Fact description. | [optional] **source_column_data_type** | **str** | A type of the source column | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**source_fact_reference** | [**DeclarativeSourceFactReference**](DeclarativeSourceFactReference.md) | | +**tags** | **List[str]** | A list of tags. | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_aggregated_fact import DeclarativeAggregatedFact + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAggregatedFact from a JSON string +declarative_aggregated_fact_instance = DeclarativeAggregatedFact.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAggregatedFact.to_json()) +# convert the object into a dict +declarative_aggregated_fact_dict = declarative_aggregated_fact_instance.to_dict() +# create an instance of DeclarativeAggregatedFact from a dict +declarative_aggregated_fact_from_dict = DeclarativeAggregatedFact.from_dict(declarative_aggregated_fact_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAnalyticalDashboard.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboard.md index 99e04ad12..09e61f682 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticalDashboard.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticalDashboard.md @@ -2,20 +2,37 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonNode**](JsonNode.md) | | -**id** | **str** | Analytical dashboard ID. | -**title** | **str** | Analytical dashboard title. | -**created_at** | **str, none_type** | Time of the entity creation. | [optional] +**content** | **object** | Free-form JSON object | +**created_at** | **str** | Time of the entity creation. | [optional] **created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **description** | **str** | Analytical dashboard description. | [optional] -**modified_at** | **str, none_type** | Time of the last entity modification. | [optional] +**id** | **str** | Analytical dashboard ID. | +**modified_at** | **str** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] -**permissions** | [**[DeclarativeAnalyticalDashboardPermissionsInner]**](DeclarativeAnalyticalDashboardPermissionsInner.md) | A list of permissions. | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | [**List[DeclarativeAnalyticalDashboardPermissionsInner]**](DeclarativeAnalyticalDashboardPermissionsInner.md) | A list of permissions. | [optional] +**tags** | **List[str]** | A list of tags. | [optional] +**title** | **str** | Analytical dashboard title. | + +## Example + +```python +from gooddata_api_client.models.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAnalyticalDashboard from a JSON string +declarative_analytical_dashboard_instance = DeclarativeAnalyticalDashboard.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAnalyticalDashboard.to_json()) +# convert the object into a dict +declarative_analytical_dashboard_dict = declarative_analytical_dashboard_instance.to_dict() +# create an instance of DeclarativeAnalyticalDashboard from a dict +declarative_analytical_dashboard_from_dict = DeclarativeAnalyticalDashboard.from_dict(declarative_analytical_dashboard_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardExtension.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardExtension.md index 4bca3a673..99d429612 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardExtension.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardExtension.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Analytical dashboard ID. | -**permissions** | [**[DeclarativeAnalyticalDashboardPermissionsInner]**](DeclarativeAnalyticalDashboardPermissionsInner.md) | A list of permissions. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | [**List[DeclarativeAnalyticalDashboardPermissionsInner]**](DeclarativeAnalyticalDashboardPermissionsInner.md) | A list of permissions. | + +## Example + +```python +from gooddata_api_client.models.declarative_analytical_dashboard_extension import DeclarativeAnalyticalDashboardExtension + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAnalyticalDashboardExtension from a JSON string +declarative_analytical_dashboard_extension_instance = DeclarativeAnalyticalDashboardExtension.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAnalyticalDashboardExtension.to_json()) +# convert the object into a dict +declarative_analytical_dashboard_extension_dict = declarative_analytical_dashboard_extension_instance.to_dict() +# create an instance of DeclarativeAnalyticalDashboardExtension from a dict +declarative_analytical_dashboard_extension_from_dict = DeclarativeAnalyticalDashboardExtension.from_dict(declarative_analytical_dashboard_extension_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardIdentifier.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardIdentifier.md index 2da17c9b5..c17cd779a 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardIdentifier.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardIdentifier.md @@ -3,12 +3,29 @@ An analytical dashboard identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Identifier of the analytical dashboard. | -**type** | **str** | A type. | defaults to "analyticalDashboard" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | A type. | + +## Example + +```python +from gooddata_api_client.models.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAnalyticalDashboardIdentifier from a JSON string +declarative_analytical_dashboard_identifier_instance = DeclarativeAnalyticalDashboardIdentifier.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAnalyticalDashboardIdentifier.to_json()) +# convert the object into a dict +declarative_analytical_dashboard_identifier_dict = declarative_analytical_dashboard_identifier_instance.to_dict() +# create an instance of DeclarativeAnalyticalDashboardIdentifier from a dict +declarative_analytical_dashboard_identifier_from_dict = DeclarativeAnalyticalDashboardIdentifier.from_dict(declarative_analytical_dashboard_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionAssignment.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionAssignment.md index 2f1d5871d..14c539108 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionAssignment.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionAssignment.md @@ -3,11 +3,28 @@ Analytical dashboard permission. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Permission name. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_analytical_dashboard_permission_assignment import DeclarativeAnalyticalDashboardPermissionAssignment + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAnalyticalDashboardPermissionAssignment from a JSON string +declarative_analytical_dashboard_permission_assignment_instance = DeclarativeAnalyticalDashboardPermissionAssignment.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAnalyticalDashboardPermissionAssignment.to_json()) + +# convert the object into a dict +declarative_analytical_dashboard_permission_assignment_dict = declarative_analytical_dashboard_permission_assignment_instance.to_dict() +# create an instance of DeclarativeAnalyticalDashboardPermissionAssignment from a dict +declarative_analytical_dashboard_permission_assignment_from_dict = DeclarativeAnalyticalDashboardPermissionAssignment.from_dict(declarative_analytical_dashboard_permission_assignment_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssignee.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssignee.md index ecd2a469e..81a5b04c7 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssignee.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssignee.md @@ -3,12 +3,29 @@ Analytical dashboard permission for an assignee. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Permission name. | **assignee** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_analytical_dashboard_permission_for_assignee import DeclarativeAnalyticalDashboardPermissionForAssignee + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAnalyticalDashboardPermissionForAssignee from a JSON string +declarative_analytical_dashboard_permission_for_assignee_instance = DeclarativeAnalyticalDashboardPermissionForAssignee.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAnalyticalDashboardPermissionForAssignee.to_json()) + +# convert the object into a dict +declarative_analytical_dashboard_permission_for_assignee_dict = declarative_analytical_dashboard_permission_for_assignee_instance.to_dict() +# create an instance of DeclarativeAnalyticalDashboardPermissionForAssignee from a dict +declarative_analytical_dashboard_permission_for_assignee_from_dict = DeclarativeAnalyticalDashboardPermissionForAssignee.from_dict(declarative_analytical_dashboard_permission_for_assignee_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf.md deleted file mode 100644 index aafa6dfb5..000000000 --- a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**assignee** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssigneeRule.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssigneeRule.md index a5141e985..feaccf1d3 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssigneeRule.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssigneeRule.md @@ -3,12 +3,29 @@ Analytical dashboard permission for a collection of assignees identified by a rule. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Permission name. | **assignee_rule** | [**AssigneeRule**](AssigneeRule.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_analytical_dashboard_permission_for_assignee_rule import DeclarativeAnalyticalDashboardPermissionForAssigneeRule + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAnalyticalDashboardPermissionForAssigneeRule from a JSON string +declarative_analytical_dashboard_permission_for_assignee_rule_instance = DeclarativeAnalyticalDashboardPermissionForAssigneeRule.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAnalyticalDashboardPermissionForAssigneeRule.to_json()) + +# convert the object into a dict +declarative_analytical_dashboard_permission_for_assignee_rule_dict = declarative_analytical_dashboard_permission_for_assignee_rule_instance.to_dict() +# create an instance of DeclarativeAnalyticalDashboardPermissionForAssigneeRule from a dict +declarative_analytical_dashboard_permission_for_assignee_rule_from_dict = DeclarativeAnalyticalDashboardPermissionForAssigneeRule.from_dict(declarative_analytical_dashboard_permission_for_assignee_rule_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf.md deleted file mode 100644 index 9bfd57762..000000000 --- a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**assignee_rule** | [**AssigneeRule**](AssigneeRule.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionsInner.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionsInner.md index b6153ad18..6dfe59661 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionsInner.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardPermissionsInner.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Permission name. | [optional] -**assignee** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | [optional] -**assignee_rule** | [**AssigneeRule**](AssigneeRule.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**name** | **str** | Permission name. | +**assignee** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | +**assignee_rule** | [**AssigneeRule**](AssigneeRule.md) | | + +## Example + +```python +from gooddata_api_client.models.declarative_analytical_dashboard_permissions_inner import DeclarativeAnalyticalDashboardPermissionsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAnalyticalDashboardPermissionsInner from a JSON string +declarative_analytical_dashboard_permissions_inner_instance = DeclarativeAnalyticalDashboardPermissionsInner.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAnalyticalDashboardPermissionsInner.to_json()) +# convert the object into a dict +declarative_analytical_dashboard_permissions_inner_dict = declarative_analytical_dashboard_permissions_inner_instance.to_dict() +# create an instance of DeclarativeAnalyticalDashboardPermissionsInner from a dict +declarative_analytical_dashboard_permissions_inner_from_dict = DeclarativeAnalyticalDashboardPermissionsInner.from_dict(declarative_analytical_dashboard_permissions_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAnalytics.md b/gooddata-api-client/docs/DeclarativeAnalytics.md index 8441e8d20..363642267 100644 --- a/gooddata-api-client/docs/DeclarativeAnalytics.md +++ b/gooddata-api-client/docs/DeclarativeAnalytics.md @@ -3,11 +3,28 @@ Entities describing users' view on data. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytics** | [**DeclarativeAnalyticsLayer**](DeclarativeAnalyticsLayer.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAnalytics from a JSON string +declarative_analytics_instance = DeclarativeAnalytics.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAnalytics.to_json()) + +# convert the object into a dict +declarative_analytics_dict = declarative_analytics_instance.to_dict() +# create an instance of DeclarativeAnalytics from a dict +declarative_analytics_from_dict = DeclarativeAnalytics.from_dict(declarative_analytics_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md b/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md index d187f9455..c2769df21 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md @@ -2,18 +2,35 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**analytical_dashboard_extensions** | [**[DeclarativeAnalyticalDashboardExtension]**](DeclarativeAnalyticalDashboardExtension.md) | A list of dashboard permissions assigned to a related dashboard. | [optional] -**analytical_dashboards** | [**[DeclarativeAnalyticalDashboard]**](DeclarativeAnalyticalDashboard.md) | A list of analytical dashboards available in the model. | [optional] -**attribute_hierarchies** | [**[DeclarativeAttributeHierarchy]**](DeclarativeAttributeHierarchy.md) | A list of attribute hierarchies. | [optional] -**dashboard_plugins** | [**[DeclarativeDashboardPlugin]**](DeclarativeDashboardPlugin.md) | A list of dashboard plugins available in the model. | [optional] -**export_definitions** | [**[DeclarativeExportDefinition]**](DeclarativeExportDefinition.md) | A list of export definitions. | [optional] -**filter_contexts** | [**[DeclarativeFilterContext]**](DeclarativeFilterContext.md) | A list of filter contexts available in the model. | [optional] -**metrics** | [**[DeclarativeMetric]**](DeclarativeMetric.md) | A list of metrics available in the model. | [optional] -**visualization_objects** | [**[DeclarativeVisualizationObject]**](DeclarativeVisualizationObject.md) | A list of visualization objects available in the model. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**analytical_dashboard_extensions** | [**List[DeclarativeAnalyticalDashboardExtension]**](DeclarativeAnalyticalDashboardExtension.md) | A list of dashboard permissions assigned to a related dashboard. | [optional] +**analytical_dashboards** | [**List[DeclarativeAnalyticalDashboard]**](DeclarativeAnalyticalDashboard.md) | A list of analytical dashboards available in the model. | [optional] +**attribute_hierarchies** | [**List[DeclarativeAttributeHierarchy]**](DeclarativeAttributeHierarchy.md) | A list of attribute hierarchies. | [optional] +**dashboard_plugins** | [**List[DeclarativeDashboardPlugin]**](DeclarativeDashboardPlugin.md) | A list of dashboard plugins available in the model. | [optional] +**export_definitions** | [**List[DeclarativeExportDefinition]**](DeclarativeExportDefinition.md) | A list of export definitions. | [optional] +**filter_contexts** | [**List[DeclarativeFilterContext]**](DeclarativeFilterContext.md) | A list of filter contexts available in the model. | [optional] +**metrics** | [**List[DeclarativeMetric]**](DeclarativeMetric.md) | A list of metrics available in the model. | [optional] +**visualization_objects** | [**List[DeclarativeVisualizationObject]**](DeclarativeVisualizationObject.md) | A list of visualization objects available in the model. | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_analytics_layer import DeclarativeAnalyticsLayer + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAnalyticsLayer from a JSON string +declarative_analytics_layer_instance = DeclarativeAnalyticsLayer.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAnalyticsLayer.to_json()) +# convert the object into a dict +declarative_analytics_layer_dict = declarative_analytics_layer_instance.to_dict() +# create an instance of DeclarativeAnalyticsLayer from a dict +declarative_analytics_layer_from_dict = DeclarativeAnalyticsLayer.from_dict(declarative_analytics_layer_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAttribute.md b/gooddata-api-client/docs/DeclarativeAttribute.md index 3e710f6fe..1c0aefd8f 100644 --- a/gooddata-api-client/docs/DeclarativeAttribute.md +++ b/gooddata-api-client/docs/DeclarativeAttribute.md @@ -3,21 +3,38 @@ A dataset attribute. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Attribute ID. | -**labels** | [**[DeclarativeLabel]**](DeclarativeLabel.md) | An array of attribute labels. | -**source_column** | **str** | A name of the source column that is the primary label | -**title** | **str** | Attribute title. | **default_view** | [**LabelIdentifier**](LabelIdentifier.md) | | [optional] **description** | **str** | Attribute description. | [optional] +**id** | **str** | Attribute ID. | **is_hidden** | **bool** | If true, this attribute is hidden from AI search results. | [optional] +**labels** | [**List[DeclarativeLabel]**](DeclarativeLabel.md) | An array of attribute labels. | **sort_column** | **str** | Attribute sort column. | [optional] **sort_direction** | **str** | Attribute sort direction. | [optional] +**source_column** | **str** | A name of the source column that is the primary label | **source_column_data_type** | **str** | A type of the source column | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tags** | **List[str]** | A list of tags. | [optional] +**title** | **str** | Attribute title. | + +## Example + +```python +from gooddata_api_client.models.declarative_attribute import DeclarativeAttribute + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAttribute from a JSON string +declarative_attribute_instance = DeclarativeAttribute.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAttribute.to_json()) +# convert the object into a dict +declarative_attribute_dict = declarative_attribute_instance.to_dict() +# create an instance of DeclarativeAttribute from a dict +declarative_attribute_from_dict = DeclarativeAttribute.from_dict(declarative_attribute_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAttributeHierarchy.md b/gooddata-api-client/docs/DeclarativeAttributeHierarchy.md index 923448717..d53bf436f 100644 --- a/gooddata-api-client/docs/DeclarativeAttributeHierarchy.md +++ b/gooddata-api-client/docs/DeclarativeAttributeHierarchy.md @@ -2,19 +2,36 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonNode**](JsonNode.md) | | -**id** | **str** | Attribute hierarchy object ID. | -**title** | **str** | Attribute hierarchy object title. | -**created_at** | **str, none_type** | Time of the entity creation. | [optional] +**content** | **object** | Free-form JSON object | +**created_at** | **str** | Time of the entity creation. | [optional] **created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **description** | **str** | Attribute hierarchy object description. | [optional] -**modified_at** | **str, none_type** | Time of the last entity modification. | [optional] +**id** | **str** | Attribute hierarchy object ID. | +**modified_at** | **str** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tags** | **List[str]** | A list of tags. | [optional] +**title** | **str** | Attribute hierarchy object title. | + +## Example + +```python +from gooddata_api_client.models.declarative_attribute_hierarchy import DeclarativeAttributeHierarchy + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAttributeHierarchy from a JSON string +declarative_attribute_hierarchy_instance = DeclarativeAttributeHierarchy.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAttributeHierarchy.to_json()) +# convert the object into a dict +declarative_attribute_hierarchy_dict = declarative_attribute_hierarchy_instance.to_dict() +# create an instance of DeclarativeAttributeHierarchy from a dict +declarative_attribute_hierarchy_from_dict = DeclarativeAttributeHierarchy.from_dict(declarative_attribute_hierarchy_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAutomation.md b/gooddata-api-client/docs/DeclarativeAutomation.md index 2b2b90f1b..edd41d983 100644 --- a/gooddata-api-client/docs/DeclarativeAutomation.md +++ b/gooddata-api-client/docs/DeclarativeAutomation.md @@ -2,35 +2,52 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | **alert** | [**AutomationAlert**](AutomationAlert.md) | | [optional] **analytical_dashboard** | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | | [optional] -**created_at** | **str, none_type** | Time of the entity creation. | [optional] +**created_at** | **str** | Time of the entity creation. | [optional] **created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] -**dashboard_tabular_exports** | [**[AutomationDashboardTabularExport]**](AutomationDashboardTabularExport.md) | | [optional] +**dashboard_tabular_exports** | [**List[AutomationDashboardTabularExport]**](AutomationDashboardTabularExport.md) | | [optional] **description** | **str** | | [optional] -**details** | **{str: (str,)}** | TODO | [optional] -**evaluation_mode** | **str** | Specify automation evaluation mode. | [optional] if omitted the server will use the default value of "PER_RECIPIENT" -**export_definitions** | [**[DeclarativeExportDefinitionIdentifier]**](DeclarativeExportDefinitionIdentifier.md) | | [optional] -**external_recipients** | [**[AutomationExternalRecipient]**](AutomationExternalRecipient.md) | External recipients of the automation action results. | [optional] -**image_exports** | [**[AutomationImageExport]**](AutomationImageExport.md) | | [optional] +**details** | **Dict[str, str]** | TODO | [optional] +**evaluation_mode** | **str** | Specify automation evaluation mode. | [optional] [default to 'PER_RECIPIENT'] +**export_definitions** | [**List[DeclarativeExportDefinitionIdentifier]**](DeclarativeExportDefinitionIdentifier.md) | | [optional] +**external_recipients** | [**List[AutomationExternalRecipient]**](AutomationExternalRecipient.md) | External recipients of the automation action results. | [optional] +**id** | **str** | | +**image_exports** | [**List[AutomationImageExport]**](AutomationImageExport.md) | | [optional] **metadata** | [**AutomationMetadata**](AutomationMetadata.md) | | [optional] -**modified_at** | **str, none_type** | Time of the last entity modification. | [optional] +**modified_at** | **str** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **notification_channel** | [**DeclarativeNotificationChannelIdentifier**](DeclarativeNotificationChannelIdentifier.md) | | [optional] -**raw_exports** | [**[AutomationRawExport]**](AutomationRawExport.md) | | [optional] -**recipients** | [**[DeclarativeUserIdentifier]**](DeclarativeUserIdentifier.md) | | [optional] +**raw_exports** | [**List[AutomationRawExport]**](AutomationRawExport.md) | | [optional] +**recipients** | [**List[DeclarativeUserIdentifier]**](DeclarativeUserIdentifier.md) | | [optional] **schedule** | [**AutomationSchedule**](AutomationSchedule.md) | | [optional] -**slides_exports** | [**[AutomationSlidesExport]**](AutomationSlidesExport.md) | | [optional] -**state** | **str** | Current state of the automation. | [optional] if omitted the server will use the default value of "ACTIVE" -**tabular_exports** | [**[AutomationTabularExport]**](AutomationTabularExport.md) | | [optional] -**tags** | **[str]** | | [optional] +**slides_exports** | [**List[AutomationSlidesExport]**](AutomationSlidesExport.md) | | [optional] +**state** | **str** | Current state of the automation. | [optional] [default to 'ACTIVE'] +**tabular_exports** | [**List[AutomationTabularExport]**](AutomationTabularExport.md) | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**visual_exports** | [**[AutomationVisualExport]**](AutomationVisualExport.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**visual_exports** | [**List[AutomationVisualExport]**](AutomationVisualExport.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_automation import DeclarativeAutomation + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeAutomation from a JSON string +declarative_automation_instance = DeclarativeAutomation.from_json(json) +# print the JSON string representation of the object +print(DeclarativeAutomation.to_json()) +# convert the object into a dict +declarative_automation_dict = declarative_automation_instance.to_dict() +# create an instance of DeclarativeAutomation from a dict +declarative_automation_from_dict = DeclarativeAutomation.from_dict(declarative_automation_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeColorPalette.md b/gooddata-api-client/docs/DeclarativeColorPalette.md index c5520c8b9..8c7c070f0 100644 --- a/gooddata-api-client/docs/DeclarativeColorPalette.md +++ b/gooddata-api-client/docs/DeclarativeColorPalette.md @@ -3,13 +3,30 @@ Color palette and its properties. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonNode**](JsonNode.md) | | +**content** | **object** | Free-form JSON object | **id** | **str** | | **name** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_color_palette import DeclarativeColorPalette + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeColorPalette from a JSON string +declarative_color_palette_instance = DeclarativeColorPalette.from_json(json) +# print the JSON string representation of the object +print(DeclarativeColorPalette.to_json()) + +# convert the object into a dict +declarative_color_palette_dict = declarative_color_palette_instance.to_dict() +# create an instance of DeclarativeColorPalette from a dict +declarative_color_palette_from_dict = DeclarativeColorPalette.from_dict(declarative_color_palette_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeColumn.md b/gooddata-api-client/docs/DeclarativeColumn.md index db447c8e6..8bc05417e 100644 --- a/gooddata-api-client/docs/DeclarativeColumn.md +++ b/gooddata-api-client/docs/DeclarativeColumn.md @@ -3,15 +3,32 @@ A table column. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_type** | **str** | Column type | -**name** | **str** | Column name | **is_primary_key** | **bool** | Is column part of primary key? | [optional] +**name** | **str** | Column name | **referenced_table_column** | **str** | Referenced table (Foreign key) | [optional] **referenced_table_id** | **str** | Referenced table (Foreign key) | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_column import DeclarativeColumn + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeColumn from a JSON string +declarative_column_instance = DeclarativeColumn.from_json(json) +# print the JSON string representation of the object +print(DeclarativeColumn.to_json()) + +# convert the object into a dict +declarative_column_dict = declarative_column_instance.to_dict() +# create an instance of DeclarativeColumn from a dict +declarative_column_from_dict = DeclarativeColumn.from_dict(declarative_column_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeCspDirective.md b/gooddata-api-client/docs/DeclarativeCspDirective.md index 4f8440376..0f14a3b3f 100644 --- a/gooddata-api-client/docs/DeclarativeCspDirective.md +++ b/gooddata-api-client/docs/DeclarativeCspDirective.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **directive** | **str** | | -**sources** | **[str]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**sources** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.declarative_csp_directive import DeclarativeCspDirective + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeCspDirective from a JSON string +declarative_csp_directive_instance = DeclarativeCspDirective.from_json(json) +# print the JSON string representation of the object +print(DeclarativeCspDirective.to_json()) +# convert the object into a dict +declarative_csp_directive_dict = declarative_csp_directive_instance.to_dict() +# create an instance of DeclarativeCspDirective from a dict +declarative_csp_directive_from_dict = DeclarativeCspDirective.from_dict(declarative_csp_directive_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeCustomApplicationSetting.md b/gooddata-api-client/docs/DeclarativeCustomApplicationSetting.md index 0e7628867..e4f3ba46f 100644 --- a/gooddata-api-client/docs/DeclarativeCustomApplicationSetting.md +++ b/gooddata-api-client/docs/DeclarativeCustomApplicationSetting.md @@ -3,13 +3,30 @@ Custom application setting and its value. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **application_name** | **str** | The application id | -**content** | [**JsonNode**](JsonNode.md) | | +**content** | **object** | Free-form JSON object | **id** | **str** | Custom Application Setting ID. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_custom_application_setting import DeclarativeCustomApplicationSetting + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeCustomApplicationSetting from a JSON string +declarative_custom_application_setting_instance = DeclarativeCustomApplicationSetting.from_json(json) +# print the JSON string representation of the object +print(DeclarativeCustomApplicationSetting.to_json()) + +# convert the object into a dict +declarative_custom_application_setting_dict = declarative_custom_application_setting_instance.to_dict() +# create an instance of DeclarativeCustomApplicationSetting from a dict +declarative_custom_application_setting_from_dict = DeclarativeCustomApplicationSetting.from_dict(declarative_custom_application_setting_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeDashboardPlugin.md b/gooddata-api-client/docs/DeclarativeDashboardPlugin.md index f2b2058fa..11eeb0b5a 100644 --- a/gooddata-api-client/docs/DeclarativeDashboardPlugin.md +++ b/gooddata-api-client/docs/DeclarativeDashboardPlugin.md @@ -2,19 +2,36 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonNode**](JsonNode.md) | | -**id** | **str** | Dashboard plugin object ID. | -**title** | **str** | Dashboard plugin object title. | -**created_at** | **str, none_type** | Time of the entity creation. | [optional] +**content** | **object** | Free-form JSON object | +**created_at** | **str** | Time of the entity creation. | [optional] **created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **description** | **str** | Dashboard plugin description. | [optional] -**modified_at** | **str, none_type** | Time of the last entity modification. | [optional] +**id** | **str** | Dashboard plugin object ID. | +**modified_at** | **str** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tags** | **List[str]** | A list of tags. | [optional] +**title** | **str** | Dashboard plugin object title. | + +## Example + +```python +from gooddata_api_client.models.declarative_dashboard_plugin import DeclarativeDashboardPlugin + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeDashboardPlugin from a JSON string +declarative_dashboard_plugin_instance = DeclarativeDashboardPlugin.from_json(json) +# print the JSON string representation of the object +print(DeclarativeDashboardPlugin.to_json()) +# convert the object into a dict +declarative_dashboard_plugin_dict = declarative_dashboard_plugin_instance.to_dict() +# create an instance of DeclarativeDashboardPlugin from a dict +declarative_dashboard_plugin_from_dict = DeclarativeDashboardPlugin.from_dict(declarative_dashboard_plugin_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeDataSource.md b/gooddata-api-client/docs/DeclarativeDataSource.md index 70914dfcc..7f10e1553 100644 --- a/gooddata-api-client/docs/DeclarativeDataSource.md +++ b/gooddata-api-client/docs/DeclarativeDataSource.md @@ -3,27 +3,44 @@ A data source and its properties. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Data source ID. | -**name** | **str** | Name of the data source. | -**schema** | **str** | A scheme/database with the data. | -**type** | **str** | Type of database. | -**authentication_type** | **str, none_type** | Type of authentication used to connect to the database. | [optional] +**authentication_type** | **str** | Type of authentication used to connect to the database. | [optional] **cache_strategy** | **str** | Determines how the results coming from a particular datasource should be cached. - ALWAYS: The results from the datasource should be cached normally (the default). - NEVER: The results from the datasource should never be cached. | [optional] **client_id** | **str** | Id of client with permission to connect to the data source. | [optional] **client_secret** | **str** | The client secret to use to connect to the database providing the data for the data source. | [optional] -**decoded_parameters** | [**[Parameter]**](Parameter.md) | | [optional] -**parameters** | [**[Parameter]**](Parameter.md) | | [optional] +**decoded_parameters** | [**List[Parameter]**](Parameter.md) | | [optional] +**id** | **str** | Data source ID. | +**name** | **str** | Name of the data source. | +**parameters** | [**List[Parameter]**](Parameter.md) | | [optional] **password** | **str** | Password for the data-source user, property is never returned back. | [optional] -**permissions** | [**[DeclarativeDataSourcePermission]**](DeclarativeDataSourcePermission.md) | | [optional] -**private_key** | **str, none_type** | The private key to use to connect to the database providing the data for the data source. | [optional] -**private_key_passphrase** | **str, none_type** | The passphrase used to encrypt the private key. | [optional] +**permissions** | [**List[DeclarativeDataSourcePermission]**](DeclarativeDataSourcePermission.md) | | [optional] +**private_key** | **str** | The private key to use to connect to the database providing the data for the data source. | [optional] +**private_key_passphrase** | **str** | The passphrase used to encrypt the private key. | [optional] +**var_schema** | **str** | A scheme/database with the data. | **token** | **str** | Token as an alternative to username and password. | [optional] +**type** | **str** | Type of database. | **url** | **str** | An connection string relevant to type of database. | [optional] **username** | **str** | User with permission connect the data source/database. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_data_source import DeclarativeDataSource + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeDataSource from a JSON string +declarative_data_source_instance = DeclarativeDataSource.from_json(json) +# print the JSON string representation of the object +print(DeclarativeDataSource.to_json()) + +# convert the object into a dict +declarative_data_source_dict = declarative_data_source_instance.to_dict() +# create an instance of DeclarativeDataSource from a dict +declarative_data_source_from_dict = DeclarativeDataSource.from_dict(declarative_data_source_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeDataSourcePermission.md b/gooddata-api-client/docs/DeclarativeDataSourcePermission.md index 54c77d54d..65e658aed 100644 --- a/gooddata-api-client/docs/DeclarativeDataSourcePermission.md +++ b/gooddata-api-client/docs/DeclarativeDataSourcePermission.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assignee** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | **name** | **str** | Permission name. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_data_source_permission import DeclarativeDataSourcePermission + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeDataSourcePermission from a JSON string +declarative_data_source_permission_instance = DeclarativeDataSourcePermission.from_json(json) +# print the JSON string representation of the object +print(DeclarativeDataSourcePermission.to_json()) + +# convert the object into a dict +declarative_data_source_permission_dict = declarative_data_source_permission_instance.to_dict() +# create an instance of DeclarativeDataSourcePermission from a dict +declarative_data_source_permission_from_dict = DeclarativeDataSourcePermission.from_dict(declarative_data_source_permission_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeDataSourcePermissions.md b/gooddata-api-client/docs/DeclarativeDataSourcePermissions.md index 594e471b1..b405cf36e 100644 --- a/gooddata-api-client/docs/DeclarativeDataSourcePermissions.md +++ b/gooddata-api-client/docs/DeclarativeDataSourcePermissions.md @@ -3,11 +3,28 @@ Data source permissions. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permissions** | [**[DeclarativeDataSourcePermission]**](DeclarativeDataSourcePermission.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | [**List[DeclarativeDataSourcePermission]**](DeclarativeDataSourcePermission.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_data_source_permissions import DeclarativeDataSourcePermissions + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeDataSourcePermissions from a JSON string +declarative_data_source_permissions_instance = DeclarativeDataSourcePermissions.from_json(json) +# print the JSON string representation of the object +print(DeclarativeDataSourcePermissions.to_json()) +# convert the object into a dict +declarative_data_source_permissions_dict = declarative_data_source_permissions_instance.to_dict() +# create an instance of DeclarativeDataSourcePermissions from a dict +declarative_data_source_permissions_from_dict = DeclarativeDataSourcePermissions.from_dict(declarative_data_source_permissions_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeDataSources.md b/gooddata-api-client/docs/DeclarativeDataSources.md index 5f2420837..c4b856e1c 100644 --- a/gooddata-api-client/docs/DeclarativeDataSources.md +++ b/gooddata-api-client/docs/DeclarativeDataSources.md @@ -3,11 +3,28 @@ A data source and its properties. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_sources** | [**[DeclarativeDataSource]**](DeclarativeDataSource.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data_sources** | [**List[DeclarativeDataSource]**](DeclarativeDataSource.md) | | + +## Example + +```python +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeDataSources from a JSON string +declarative_data_sources_instance = DeclarativeDataSources.from_json(json) +# print the JSON string representation of the object +print(DeclarativeDataSources.to_json()) +# convert the object into a dict +declarative_data_sources_dict = declarative_data_sources_instance.to_dict() +# create an instance of DeclarativeDataSources from a dict +declarative_data_sources_from_dict = DeclarativeDataSources.from_dict(declarative_data_sources_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeDataset.md b/gooddata-api-client/docs/DeclarativeDataset.md index 543475f1f..a5eadfa74 100644 --- a/gooddata-api-client/docs/DeclarativeDataset.md +++ b/gooddata-api-client/docs/DeclarativeDataset.md @@ -3,24 +3,41 @@ A dataset defined by its properties. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**grain** | [**[GrainIdentifier]**](GrainIdentifier.md) | An array of grain identifiers. | -**id** | **str** | The Dataset ID. This ID is further used to refer to this instance of dataset. | -**references** | [**[DeclarativeReference]**](DeclarativeReference.md) | An array of references. | -**title** | **str** | A dataset title. | -**aggregated_facts** | [**[DeclarativeAggregatedFact]**](DeclarativeAggregatedFact.md) | An array of aggregated facts. | [optional] -**attributes** | [**[DeclarativeAttribute]**](DeclarativeAttribute.md) | An array of attributes. | [optional] +**aggregated_facts** | [**List[DeclarativeAggregatedFact]**](DeclarativeAggregatedFact.md) | An array of aggregated facts. | [optional] +**attributes** | [**List[DeclarativeAttribute]**](DeclarativeAttribute.md) | An array of attributes. | [optional] **data_source_table_id** | [**DataSourceTableIdentifier**](DataSourceTableIdentifier.md) | | [optional] **description** | **str** | A dataset description. | [optional] -**facts** | [**[DeclarativeFact]**](DeclarativeFact.md) | An array of facts. | [optional] +**facts** | [**List[DeclarativeFact]**](DeclarativeFact.md) | An array of facts. | [optional] +**grain** | [**List[GrainIdentifier]**](GrainIdentifier.md) | An array of grain identifiers. | +**id** | **str** | The Dataset ID. This ID is further used to refer to this instance of dataset. | **precedence** | **int** | Precedence used in aggregate awareness. | [optional] +**references** | [**List[DeclarativeReference]**](DeclarativeReference.md) | An array of references. | **sql** | [**DeclarativeDatasetSql**](DeclarativeDatasetSql.md) | | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**workspace_data_filter_columns** | [**[DeclarativeWorkspaceDataFilterColumn]**](DeclarativeWorkspaceDataFilterColumn.md) | An array of columns which are available for match to implicit workspace data filters. | [optional] -**workspace_data_filter_references** | [**[DeclarativeWorkspaceDataFilterReferences]**](DeclarativeWorkspaceDataFilterReferences.md) | An array of explicit workspace data filters. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tags** | **List[str]** | A list of tags. | [optional] +**title** | **str** | A dataset title. | +**workspace_data_filter_columns** | [**List[DeclarativeWorkspaceDataFilterColumn]**](DeclarativeWorkspaceDataFilterColumn.md) | An array of columns which are available for match to implicit workspace data filters. | [optional] +**workspace_data_filter_references** | [**List[DeclarativeWorkspaceDataFilterReferences]**](DeclarativeWorkspaceDataFilterReferences.md) | An array of explicit workspace data filters. | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_dataset import DeclarativeDataset + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeDataset from a JSON string +declarative_dataset_instance = DeclarativeDataset.from_json(json) +# print the JSON string representation of the object +print(DeclarativeDataset.to_json()) +# convert the object into a dict +declarative_dataset_dict = declarative_dataset_instance.to_dict() +# create an instance of DeclarativeDataset from a dict +declarative_dataset_from_dict = DeclarativeDataset.from_dict(declarative_dataset_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeDatasetExtension.md b/gooddata-api-client/docs/DeclarativeDatasetExtension.md index af10af8a2..6fae9e1be 100644 --- a/gooddata-api-client/docs/DeclarativeDatasetExtension.md +++ b/gooddata-api-client/docs/DeclarativeDatasetExtension.md @@ -3,12 +3,29 @@ A dataset extension properties. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | The Dataset ID. This ID is further used to refer to this instance of dataset. | -**workspace_data_filter_references** | [**[DeclarativeWorkspaceDataFilterReferences]**](DeclarativeWorkspaceDataFilterReferences.md) | An array of explicit workspace data filters. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**workspace_data_filter_references** | [**List[DeclarativeWorkspaceDataFilterReferences]**](DeclarativeWorkspaceDataFilterReferences.md) | An array of explicit workspace data filters. | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_dataset_extension import DeclarativeDatasetExtension + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeDatasetExtension from a JSON string +declarative_dataset_extension_instance = DeclarativeDatasetExtension.from_json(json) +# print the JSON string representation of the object +print(DeclarativeDatasetExtension.to_json()) +# convert the object into a dict +declarative_dataset_extension_dict = declarative_dataset_extension_instance.to_dict() +# create an instance of DeclarativeDatasetExtension from a dict +declarative_dataset_extension_from_dict = DeclarativeDatasetExtension.from_dict(declarative_dataset_extension_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeDatasetSql.md b/gooddata-api-client/docs/DeclarativeDatasetSql.md index e5c1fd340..abf4f9fc3 100644 --- a/gooddata-api-client/docs/DeclarativeDatasetSql.md +++ b/gooddata-api-client/docs/DeclarativeDatasetSql.md @@ -3,12 +3,29 @@ SQL defining this dataset. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_source_id** | **str** | Data source ID. | **statement** | **str** | SQL statement. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_dataset_sql import DeclarativeDatasetSql + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeDatasetSql from a JSON string +declarative_dataset_sql_instance = DeclarativeDatasetSql.from_json(json) +# print the JSON string representation of the object +print(DeclarativeDatasetSql.to_json()) + +# convert the object into a dict +declarative_dataset_sql_dict = declarative_dataset_sql_instance.to_dict() +# create an instance of DeclarativeDatasetSql from a dict +declarative_dataset_sql_from_dict = DeclarativeDatasetSql.from_dict(declarative_dataset_sql_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeDateDataset.md b/gooddata-api-client/docs/DeclarativeDateDataset.md index 606945cc1..00a7f22cb 100644 --- a/gooddata-api-client/docs/DeclarativeDateDataset.md +++ b/gooddata-api-client/docs/DeclarativeDateDataset.md @@ -3,16 +3,33 @@ A date dataset. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**granularities** | **[str]** | An array of date granularities. All listed granularities will be available for date dataset. | +**description** | **str** | Date dataset description. | [optional] +**granularities** | **List[str]** | An array of date granularities. All listed granularities will be available for date dataset. | **granularities_formatting** | [**GranularitiesFormatting**](GranularitiesFormatting.md) | | **id** | **str** | Date dataset ID. | +**tags** | **List[str]** | A list of tags. | [optional] **title** | **str** | Date dataset title. | -**description** | **str** | Date dataset description. | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_date_dataset import DeclarativeDateDataset + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeDateDataset from a JSON string +declarative_date_dataset_instance = DeclarativeDateDataset.from_json(json) +# print the JSON string representation of the object +print(DeclarativeDateDataset.to_json()) + +# convert the object into a dict +declarative_date_dataset_dict = declarative_date_dataset_instance.to_dict() +# create an instance of DeclarativeDateDataset from a dict +declarative_date_dataset_from_dict = DeclarativeDateDataset.from_dict(declarative_date_dataset_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeExportDefinition.md b/gooddata-api-client/docs/DeclarativeExportDefinition.md index f7a32553c..b4932bb47 100644 --- a/gooddata-api-client/docs/DeclarativeExportDefinition.md +++ b/gooddata-api-client/docs/DeclarativeExportDefinition.md @@ -2,19 +2,36 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Export definition id. | -**title** | **str** | Export definition object title. | -**created_at** | **str, none_type** | Time of the entity creation. | [optional] +**created_at** | **str** | Time of the entity creation. | [optional] **created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **description** | **str** | Export definition object description. | [optional] -**modified_at** | **str, none_type** | Time of the last entity modification. | [optional] +**id** | **str** | Export definition id. | +**modified_at** | **str** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **request_payload** | [**DeclarativeExportDefinitionRequestPayload**](DeclarativeExportDefinitionRequestPayload.md) | | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tags** | **List[str]** | A list of tags. | [optional] +**title** | **str** | Export definition object title. | + +## Example + +```python +from gooddata_api_client.models.declarative_export_definition import DeclarativeExportDefinition + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeExportDefinition from a JSON string +declarative_export_definition_instance = DeclarativeExportDefinition.from_json(json) +# print the JSON string representation of the object +print(DeclarativeExportDefinition.to_json()) +# convert the object into a dict +declarative_export_definition_dict = declarative_export_definition_instance.to_dict() +# create an instance of DeclarativeExportDefinition from a dict +declarative_export_definition_from_dict = DeclarativeExportDefinition.from_dict(declarative_export_definition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeExportDefinitionIdentifier.md b/gooddata-api-client/docs/DeclarativeExportDefinitionIdentifier.md index 1844d4034..892ab41a9 100644 --- a/gooddata-api-client/docs/DeclarativeExportDefinitionIdentifier.md +++ b/gooddata-api-client/docs/DeclarativeExportDefinitionIdentifier.md @@ -3,12 +3,29 @@ An export definition identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Export definition identifier. | -**type** | **str** | A type. | defaults to "exportDefinition" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | A type. | + +## Example + +```python +from gooddata_api_client.models.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeExportDefinitionIdentifier from a JSON string +declarative_export_definition_identifier_instance = DeclarativeExportDefinitionIdentifier.from_json(json) +# print the JSON string representation of the object +print(DeclarativeExportDefinitionIdentifier.to_json()) +# convert the object into a dict +declarative_export_definition_identifier_dict = declarative_export_definition_identifier_instance.to_dict() +# create an instance of DeclarativeExportDefinitionIdentifier from a dict +declarative_export_definition_identifier_from_dict = DeclarativeExportDefinitionIdentifier.from_dict(declarative_export_definition_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeExportDefinitionRequestPayload.md b/gooddata-api-client/docs/DeclarativeExportDefinitionRequestPayload.md index 1ef446edb..dcd9a314e 100644 --- a/gooddata-api-client/docs/DeclarativeExportDefinitionRequestPayload.md +++ b/gooddata-api-client/docs/DeclarativeExportDefinitionRequestPayload.md @@ -2,20 +2,37 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] **execution_result** | **str** | Execution result identifier. | [optional] -**metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Metadata definition in free-form JSON format. | [optional] +**file_name** | **str** | File name to be used for retrieving the pdf document. | +**format** | **str** | Expected file format. | +**metadata** | **object** | Metadata definition in free-form JSON format. | [optional] **related_dashboard_id** | **str** | Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard. | [optional] **settings** | [**Settings**](Settings.md) | | [optional] **visualization_object** | **str** | Visualization object identifier. Alternative to executionResult property. | [optional] -**visualization_object_custom_filters** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] -**file_name** | **str** | File name to be used for retrieving the pdf document. | [optional] -**format** | **str** | Expected file format. | [optional] -**dashboard_id** | **str** | Dashboard identifier | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**visualization_object_custom_filters** | **List[object]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] +**dashboard_id** | **str** | Dashboard identifier | + +## Example + +```python +from gooddata_api_client.models.declarative_export_definition_request_payload import DeclarativeExportDefinitionRequestPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeExportDefinitionRequestPayload from a JSON string +declarative_export_definition_request_payload_instance = DeclarativeExportDefinitionRequestPayload.from_json(json) +# print the JSON string representation of the object +print(DeclarativeExportDefinitionRequestPayload.to_json()) +# convert the object into a dict +declarative_export_definition_request_payload_dict = declarative_export_definition_request_payload_instance.to_dict() +# create an instance of DeclarativeExportDefinitionRequestPayload from a dict +declarative_export_definition_request_payload_from_dict = DeclarativeExportDefinitionRequestPayload.from_dict(declarative_export_definition_request_payload_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeExportTemplate.md b/gooddata-api-client/docs/DeclarativeExportTemplate.md index 4d126327d..50a811c5f 100644 --- a/gooddata-api-client/docs/DeclarativeExportTemplate.md +++ b/gooddata-api-client/docs/DeclarativeExportTemplate.md @@ -3,14 +3,31 @@ A declarative form of a particular export template. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**dashboard_slides_template** | [**DashboardSlidesTemplate**](DashboardSlidesTemplate.md) | | [optional] **id** | **str** | Identifier of an export template | **name** | **str** | Name of an export template. | -**dashboard_slides_template** | [**DashboardSlidesTemplate**](DashboardSlidesTemplate.md) | | [optional] **widget_slides_template** | [**WidgetSlidesTemplate**](WidgetSlidesTemplate.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_export_template import DeclarativeExportTemplate + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeExportTemplate from a JSON string +declarative_export_template_instance = DeclarativeExportTemplate.from_json(json) +# print the JSON string representation of the object +print(DeclarativeExportTemplate.to_json()) + +# convert the object into a dict +declarative_export_template_dict = declarative_export_template_instance.to_dict() +# create an instance of DeclarativeExportTemplate from a dict +declarative_export_template_from_dict = DeclarativeExportTemplate.from_dict(declarative_export_template_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeExportTemplates.md b/gooddata-api-client/docs/DeclarativeExportTemplates.md index fe4338ea7..2c44b2ef6 100644 --- a/gooddata-api-client/docs/DeclarativeExportTemplates.md +++ b/gooddata-api-client/docs/DeclarativeExportTemplates.md @@ -3,11 +3,28 @@ Export templates. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**export_templates** | [**[DeclarativeExportTemplate]**](DeclarativeExportTemplate.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**export_templates** | [**List[DeclarativeExportTemplate]**](DeclarativeExportTemplate.md) | | + +## Example + +```python +from gooddata_api_client.models.declarative_export_templates import DeclarativeExportTemplates + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeExportTemplates from a JSON string +declarative_export_templates_instance = DeclarativeExportTemplates.from_json(json) +# print the JSON string representation of the object +print(DeclarativeExportTemplates.to_json()) +# convert the object into a dict +declarative_export_templates_dict = declarative_export_templates_instance.to_dict() +# create an instance of DeclarativeExportTemplates from a dict +declarative_export_templates_from_dict = DeclarativeExportTemplates.from_dict(declarative_export_templates_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeFact.md b/gooddata-api-client/docs/DeclarativeFact.md index d16c216fb..2d798758a 100644 --- a/gooddata-api-client/docs/DeclarativeFact.md +++ b/gooddata-api-client/docs/DeclarativeFact.md @@ -3,17 +3,34 @@ A dataset fact. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Fact ID. | -**source_column** | **str** | A name of the source column in the table. | -**title** | **str** | Fact title. | **description** | **str** | Fact description. | [optional] +**id** | **str** | Fact ID. | **is_hidden** | **bool** | If true, this fact is hidden from AI search results. | [optional] +**source_column** | **str** | A name of the source column in the table. | **source_column_data_type** | **str** | A type of the source column | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tags** | **List[str]** | A list of tags. | [optional] +**title** | **str** | Fact title. | + +## Example + +```python +from gooddata_api_client.models.declarative_fact import DeclarativeFact + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeFact from a JSON string +declarative_fact_instance = DeclarativeFact.from_json(json) +# print the JSON string representation of the object +print(DeclarativeFact.to_json()) +# convert the object into a dict +declarative_fact_dict = declarative_fact_instance.to_dict() +# create an instance of DeclarativeFact from a dict +declarative_fact_from_dict = DeclarativeFact.from_dict(declarative_fact_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeFilterContext.md b/gooddata-api-client/docs/DeclarativeFilterContext.md index e433ebffa..25dad813d 100644 --- a/gooddata-api-client/docs/DeclarativeFilterContext.md +++ b/gooddata-api-client/docs/DeclarativeFilterContext.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonNode**](JsonNode.md) | | +**content** | **object** | Free-form JSON object | +**description** | **str** | Filter Context description. | [optional] **id** | **str** | Filter Context ID. | +**tags** | **List[str]** | A list of tags. | [optional] **title** | **str** | Filter Context title. | -**description** | **str** | Filter Context description. | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_filter_context import DeclarativeFilterContext + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeFilterContext from a JSON string +declarative_filter_context_instance = DeclarativeFilterContext.from_json(json) +# print the JSON string representation of the object +print(DeclarativeFilterContext.to_json()) + +# convert the object into a dict +declarative_filter_context_dict = declarative_filter_context_instance.to_dict() +# create an instance of DeclarativeFilterContext from a dict +declarative_filter_context_from_dict = DeclarativeFilterContext.from_dict(declarative_filter_context_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeFilterView.md b/gooddata-api-client/docs/DeclarativeFilterView.md index 39d1163c1..dca4eb0ae 100644 --- a/gooddata-api-client/docs/DeclarativeFilterView.md +++ b/gooddata-api-client/docs/DeclarativeFilterView.md @@ -2,18 +2,35 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | FilterView object ID. | -**title** | **str** | | **analytical_dashboard** | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | | [optional] -**content** | [**JsonNode**](JsonNode.md) | | [optional] +**content** | **object** | Free-form JSON object | [optional] **description** | **str** | | [optional] +**id** | **str** | FilterView object ID. | **is_default** | **bool** | Indicator whether the filter view should by applied by default. | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] +**title** | **str** | | **user** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_filter_view import DeclarativeFilterView + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeFilterView from a JSON string +declarative_filter_view_instance = DeclarativeFilterView.from_json(json) +# print the JSON string representation of the object +print(DeclarativeFilterView.to_json()) + +# convert the object into a dict +declarative_filter_view_dict = declarative_filter_view_instance.to_dict() +# create an instance of DeclarativeFilterView from a dict +declarative_filter_view_from_dict = DeclarativeFilterView.from_dict(declarative_filter_view_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeIdentityProvider.md b/gooddata-api-client/docs/DeclarativeIdentityProvider.md index 917382884..ffd6f6e7d 100644 --- a/gooddata-api-client/docs/DeclarativeIdentityProvider.md +++ b/gooddata-api-client/docs/DeclarativeIdentityProvider.md @@ -3,22 +3,39 @@ Notification channels. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**custom_claim_mapping** | **Dict[str, str]** | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | [optional] **id** | **str** | FilterView object ID. | -**custom_claim_mapping** | **{str: (str,)}** | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | [optional] -**identifiers** | **[str]** | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | [optional] +**identifiers** | **List[str]** | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | [optional] **idp_type** | **str** | Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise. | [optional] **oauth_client_id** | **str** | The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] **oauth_client_secret** | **str** | The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] -**oauth_custom_auth_attributes** | **{str: (str,)}** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] -**oauth_custom_scopes** | **[str], none_type** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] +**oauth_custom_auth_attributes** | **Dict[str, str]** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] +**oauth_custom_scopes** | **List[str]** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] **oauth_issuer_id** | **str** | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] **oauth_issuer_location** | **str** | The location of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] **saml_metadata** | **str** | Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_identity_provider import DeclarativeIdentityProvider + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeIdentityProvider from a JSON string +declarative_identity_provider_instance = DeclarativeIdentityProvider.from_json(json) +# print the JSON string representation of the object +print(DeclarativeIdentityProvider.to_json()) + +# convert the object into a dict +declarative_identity_provider_dict = declarative_identity_provider_instance.to_dict() +# create an instance of DeclarativeIdentityProvider from a dict +declarative_identity_provider_from_dict = DeclarativeIdentityProvider.from_dict(declarative_identity_provider_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeIdentityProviderIdentifier.md b/gooddata-api-client/docs/DeclarativeIdentityProviderIdentifier.md index 421e6407e..cf4b58fd0 100644 --- a/gooddata-api-client/docs/DeclarativeIdentityProviderIdentifier.md +++ b/gooddata-api-client/docs/DeclarativeIdentityProviderIdentifier.md @@ -3,12 +3,29 @@ An Identity Provider identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Identifier of the identity provider. | -**type** | **str** | A type. | defaults to "identityProvider" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | A type. | + +## Example + +```python +from gooddata_api_client.models.declarative_identity_provider_identifier import DeclarativeIdentityProviderIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeIdentityProviderIdentifier from a JSON string +declarative_identity_provider_identifier_instance = DeclarativeIdentityProviderIdentifier.from_json(json) +# print the JSON string representation of the object +print(DeclarativeIdentityProviderIdentifier.to_json()) +# convert the object into a dict +declarative_identity_provider_identifier_dict = declarative_identity_provider_identifier_instance.to_dict() +# create an instance of DeclarativeIdentityProviderIdentifier from a dict +declarative_identity_provider_identifier_from_dict = DeclarativeIdentityProviderIdentifier.from_dict(declarative_identity_provider_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeJwk.md b/gooddata-api-client/docs/DeclarativeJwk.md index db0e20737..d892fedf8 100644 --- a/gooddata-api-client/docs/DeclarativeJwk.md +++ b/gooddata-api-client/docs/DeclarativeJwk.md @@ -3,12 +3,29 @@ A declarative form of the JWK. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | [**DeclarativeJwkSpecification**](DeclarativeJwkSpecification.md) | | **id** | **str** | JWK object ID. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_jwk import DeclarativeJwk + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeJwk from a JSON string +declarative_jwk_instance = DeclarativeJwk.from_json(json) +# print the JSON string representation of the object +print(DeclarativeJwk.to_json()) + +# convert the object into a dict +declarative_jwk_dict = declarative_jwk_instance.to_dict() +# create an instance of DeclarativeJwk from a dict +declarative_jwk_from_dict = DeclarativeJwk.from_dict(declarative_jwk_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeJwkSpecification.md b/gooddata-api-client/docs/DeclarativeJwkSpecification.md index c7d0c8417..f9af5bf8c 100644 --- a/gooddata-api-client/docs/DeclarativeJwkSpecification.md +++ b/gooddata-api-client/docs/DeclarativeJwkSpecification.md @@ -3,18 +3,35 @@ Declarative specification of the cryptographic key. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**x5c** | **[str]** | Parameter contains a chain of one or more PKIX certificates. | [optional] +**alg** | **str** | Algorithm intended for use with the key. | +**e** | **str** | parameter contains the exponent value for the RSA public key. | +**kid** | **str** | Parameter is used to match a specific key. | +**kty** | **str** | Key type parameter | +**n** | **str** | Parameter contains the modulus value for the RSA public key. | +**use** | **str** | Parameter identifies the intended use of the public key. | +**x5c** | **List[str]** | Parameter contains a chain of one or more PKIX certificates. | [optional] **x5t** | **str** | Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate. | [optional] -**alg** | **str** | Algorithm intended for use with the key. | [optional] -**e** | **str** | parameter contains the exponent value for the RSA public key. | [optional] -**kid** | **str** | Parameter is used to match a specific key. | [optional] -**kty** | **str** | Key type parameter | [optional] if omitted the server will use the default value of "RSA" -**n** | **str** | Parameter contains the modulus value for the RSA public key. | [optional] -**use** | **str** | Parameter identifies the intended use of the public key. | [optional] if omitted the server will use the default value of "sig" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_jwk_specification import DeclarativeJwkSpecification + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeJwkSpecification from a JSON string +declarative_jwk_specification_instance = DeclarativeJwkSpecification.from_json(json) +# print the JSON string representation of the object +print(DeclarativeJwkSpecification.to_json()) + +# convert the object into a dict +declarative_jwk_specification_dict = declarative_jwk_specification_instance.to_dict() +# create an instance of DeclarativeJwkSpecification from a dict +declarative_jwk_specification_from_dict = DeclarativeJwkSpecification.from_dict(declarative_jwk_specification_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeLabel.md b/gooddata-api-client/docs/DeclarativeLabel.md index 782c194ca..ad5184f2e 100644 --- a/gooddata-api-client/docs/DeclarativeLabel.md +++ b/gooddata-api-client/docs/DeclarativeLabel.md @@ -3,18 +3,35 @@ A attribute label. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Label ID. | -**source_column** | **str** | A name of the source column in the table. | -**title** | **str** | Label title. | **description** | **str** | Label description. | [optional] +**id** | **str** | Label ID. | **is_hidden** | **bool** | Determines if the label is hidden from AI features. | [optional] +**source_column** | **str** | A name of the source column in the table. | **source_column_data_type** | **str** | A type of the source column | [optional] -**tags** | **[str]** | A list of tags. | [optional] +**tags** | **List[str]** | A list of tags. | [optional] +**title** | **str** | Label title. | **value_type** | **str** | Specific type of label | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_label import DeclarativeLabel + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeLabel from a JSON string +declarative_label_instance = DeclarativeLabel.from_json(json) +# print the JSON string representation of the object +print(DeclarativeLabel.to_json()) + +# convert the object into a dict +declarative_label_dict = declarative_label_instance.to_dict() +# create an instance of DeclarativeLabel from a dict +declarative_label_from_dict = DeclarativeLabel.from_dict(declarative_label_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeLdm.md b/gooddata-api-client/docs/DeclarativeLdm.md index 46676f00e..f8f8a7371 100644 --- a/gooddata-api-client/docs/DeclarativeLdm.md +++ b/gooddata-api-client/docs/DeclarativeLdm.md @@ -3,13 +3,30 @@ A logical data model (LDM) representation. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dataset_extensions** | [**[DeclarativeDatasetExtension]**](DeclarativeDatasetExtension.md) | An array containing extensions for datasets defined in parent workspaces. | [optional] -**datasets** | [**[DeclarativeDataset]**](DeclarativeDataset.md) | An array containing datasets. | [optional] -**date_instances** | [**[DeclarativeDateDataset]**](DeclarativeDateDataset.md) | An array containing date-related datasets. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**dataset_extensions** | [**List[DeclarativeDatasetExtension]**](DeclarativeDatasetExtension.md) | An array containing extensions for datasets defined in parent workspaces. | [optional] +**datasets** | [**List[DeclarativeDataset]**](DeclarativeDataset.md) | An array containing datasets. | [optional] +**date_instances** | [**List[DeclarativeDateDataset]**](DeclarativeDateDataset.md) | An array containing date-related datasets. | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_ldm import DeclarativeLdm + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeLdm from a JSON string +declarative_ldm_instance = DeclarativeLdm.from_json(json) +# print the JSON string representation of the object +print(DeclarativeLdm.to_json()) +# convert the object into a dict +declarative_ldm_dict = declarative_ldm_instance.to_dict() +# create an instance of DeclarativeLdm from a dict +declarative_ldm_from_dict = DeclarativeLdm.from_dict(declarative_ldm_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeMetric.md b/gooddata-api-client/docs/DeclarativeMetric.md index da2af4087..24c6a2927 100644 --- a/gooddata-api-client/docs/DeclarativeMetric.md +++ b/gooddata-api-client/docs/DeclarativeMetric.md @@ -2,19 +2,36 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonNode**](JsonNode.md) | | -**id** | **str** | Metric ID. | -**title** | **str** | Metric title. | -**created_at** | **str, none_type** | Time of the entity creation. | [optional] +**content** | **object** | Free-form JSON object | +**created_at** | **str** | Time of the entity creation. | [optional] **created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **description** | **str** | Metric description. | [optional] -**modified_at** | **str, none_type** | Time of the last entity modification. | [optional] +**id** | **str** | Metric ID. | +**modified_at** | **str** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tags** | **List[str]** | A list of tags. | [optional] +**title** | **str** | Metric title. | + +## Example + +```python +from gooddata_api_client.models.declarative_metric import DeclarativeMetric + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeMetric from a JSON string +declarative_metric_instance = DeclarativeMetric.from_json(json) +# print the JSON string representation of the object +print(DeclarativeMetric.to_json()) +# convert the object into a dict +declarative_metric_dict = declarative_metric_instance.to_dict() +# create an instance of DeclarativeMetric from a dict +declarative_metric_from_dict = DeclarativeMetric.from_dict(declarative_metric_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeModel.md b/gooddata-api-client/docs/DeclarativeModel.md index b184f340b..9012217e2 100644 --- a/gooddata-api-client/docs/DeclarativeModel.md +++ b/gooddata-api-client/docs/DeclarativeModel.md @@ -3,11 +3,28 @@ A data model structured as a set of its attributes. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ldm** | [**DeclarativeLdm**](DeclarativeLdm.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_model import DeclarativeModel + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeModel from a JSON string +declarative_model_instance = DeclarativeModel.from_json(json) +# print the JSON string representation of the object +print(DeclarativeModel.to_json()) + +# convert the object into a dict +declarative_model_dict = declarative_model_instance.to_dict() +# create an instance of DeclarativeModel from a dict +declarative_model_from_dict = DeclarativeModel.from_dict(declarative_model_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeNotificationChannel.md b/gooddata-api-client/docs/DeclarativeNotificationChannel.md index 5193110f3..7576ce22b 100644 --- a/gooddata-api-client/docs/DeclarativeNotificationChannel.md +++ b/gooddata-api-client/docs/DeclarativeNotificationChannel.md @@ -3,20 +3,37 @@ A declarative form of a particular notification channel. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Identifier of a notification channel | -**allowed_recipients** | **str** | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization | [optional] if omitted the server will use the default value of "INTERNAL" +**allowed_recipients** | **str** | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization | [optional] [default to 'INTERNAL'] **custom_dashboard_url** | **str** | Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} | [optional] -**dashboard_link_visibility** | **str** | Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link | [optional] if omitted the server will use the default value of "INTERNAL_ONLY" +**dashboard_link_visibility** | **str** | Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link | [optional] [default to 'INTERNAL_ONLY'] **description** | **str** | Description of a notification channel. | [optional] **destination** | [**DeclarativeNotificationChannelDestination**](DeclarativeNotificationChannelDestination.md) | | [optional] -**destination_type** | **str, none_type** | | [optional] [readonly] -**in_platform_notification** | **str** | In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications | [optional] if omitted the server will use the default value of "DISABLED" +**destination_type** | **str** | | [optional] [readonly] +**id** | **str** | Identifier of a notification channel | +**in_platform_notification** | **str** | In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications | [optional] [default to 'DISABLED'] **name** | **str** | Name of a notification channel. | [optional] **notification_source** | **str** | Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_notification_channel import DeclarativeNotificationChannel + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeNotificationChannel from a JSON string +declarative_notification_channel_instance = DeclarativeNotificationChannel.from_json(json) +# print the JSON string representation of the object +print(DeclarativeNotificationChannel.to_json()) + +# convert the object into a dict +declarative_notification_channel_dict = declarative_notification_channel_instance.to_dict() +# create an instance of DeclarativeNotificationChannel from a dict +declarative_notification_channel_from_dict = DeclarativeNotificationChannel.from_dict(declarative_notification_channel_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeNotificationChannelDestination.md b/gooddata-api-client/docs/DeclarativeNotificationChannelDestination.md index d80954de8..d738a6528 100644 --- a/gooddata-api-client/docs/DeclarativeNotificationChannelDestination.md +++ b/gooddata-api-client/docs/DeclarativeNotificationChannelDestination.md @@ -2,20 +2,37 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**from_email** | **str** | E-mail address to send notifications from. | [optional] if omitted the server will use the default value of no-reply@gooddata.com -**from_email_name** | **str** | An optional e-mail name to send notifications from. | [optional] if omitted the server will use the default value of "GoodData" +**from_email** | **str** | E-mail address to send notifications from. | [optional] [default to 'no-reply@gooddata.com'] +**from_email_name** | **str** | An optional e-mail name to send notifications from. | [optional] [default to 'GoodData'] +**type** | **str** | The destination type. | **host** | **str** | The SMTP server address. | [optional] **password** | **str** | The SMTP server password. | [optional] **port** | **int** | The SMTP server port. | [optional] **username** | **str** | The SMTP server username. | [optional] -**has_token** | **bool, none_type** | Flag indicating if webhook has a token. | [optional] [readonly] -**token** | **str, none_type** | Bearer token for the webhook. | [optional] +**has_token** | **bool** | Flag indicating if webhook has a token. | [optional] [readonly] +**token** | **str** | Bearer token for the webhook. | [optional] **url** | **str** | The webhook URL. | [optional] -**type** | **str** | The destination type. | [optional] if omitted the server will use the default value of "WEBHOOK" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_notification_channel_destination import DeclarativeNotificationChannelDestination + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeNotificationChannelDestination from a JSON string +declarative_notification_channel_destination_instance = DeclarativeNotificationChannelDestination.from_json(json) +# print the JSON string representation of the object +print(DeclarativeNotificationChannelDestination.to_json()) + +# convert the object into a dict +declarative_notification_channel_destination_dict = declarative_notification_channel_destination_instance.to_dict() +# create an instance of DeclarativeNotificationChannelDestination from a dict +declarative_notification_channel_destination_from_dict = DeclarativeNotificationChannelDestination.from_dict(declarative_notification_channel_destination_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeNotificationChannelIdentifier.md b/gooddata-api-client/docs/DeclarativeNotificationChannelIdentifier.md index 4c7132a7d..2148dd75b 100644 --- a/gooddata-api-client/docs/DeclarativeNotificationChannelIdentifier.md +++ b/gooddata-api-client/docs/DeclarativeNotificationChannelIdentifier.md @@ -3,12 +3,29 @@ A notification channel identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Notification channel identifier. | -**type** | **str** | A type. | defaults to "notificationChannel" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | A type. | + +## Example + +```python +from gooddata_api_client.models.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeNotificationChannelIdentifier from a JSON string +declarative_notification_channel_identifier_instance = DeclarativeNotificationChannelIdentifier.from_json(json) +# print the JSON string representation of the object +print(DeclarativeNotificationChannelIdentifier.to_json()) +# convert the object into a dict +declarative_notification_channel_identifier_dict = declarative_notification_channel_identifier_instance.to_dict() +# create an instance of DeclarativeNotificationChannelIdentifier from a dict +declarative_notification_channel_identifier_from_dict = DeclarativeNotificationChannelIdentifier.from_dict(declarative_notification_channel_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeNotificationChannels.md b/gooddata-api-client/docs/DeclarativeNotificationChannels.md index afb9d1a97..68990dad0 100644 --- a/gooddata-api-client/docs/DeclarativeNotificationChannels.md +++ b/gooddata-api-client/docs/DeclarativeNotificationChannels.md @@ -3,11 +3,28 @@ Notification channels. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**notification_channels** | [**[DeclarativeNotificationChannel]**](DeclarativeNotificationChannel.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**notification_channels** | [**List[DeclarativeNotificationChannel]**](DeclarativeNotificationChannel.md) | | + +## Example + +```python +from gooddata_api_client.models.declarative_notification_channels import DeclarativeNotificationChannels + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeNotificationChannels from a JSON string +declarative_notification_channels_instance = DeclarativeNotificationChannels.from_json(json) +# print the JSON string representation of the object +print(DeclarativeNotificationChannels.to_json()) +# convert the object into a dict +declarative_notification_channels_dict = declarative_notification_channels_instance.to_dict() +# create an instance of DeclarativeNotificationChannels from a dict +declarative_notification_channels_from_dict = DeclarativeNotificationChannels.from_dict(declarative_notification_channels_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeOrganization.md b/gooddata-api-client/docs/DeclarativeOrganization.md index 4b3f63852..250f7cb30 100644 --- a/gooddata-api-client/docs/DeclarativeOrganization.md +++ b/gooddata-api-client/docs/DeclarativeOrganization.md @@ -3,20 +3,37 @@ Complete definition of an organization in a declarative form. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**data_sources** | [**List[DeclarativeDataSource]**](DeclarativeDataSource.md) | | [optional] +**export_templates** | [**List[DeclarativeExportTemplate]**](DeclarativeExportTemplate.md) | | [optional] +**identity_providers** | [**List[DeclarativeIdentityProvider]**](DeclarativeIdentityProvider.md) | | [optional] +**jwks** | [**List[DeclarativeJwk]**](DeclarativeJwk.md) | | [optional] +**notification_channels** | [**List[DeclarativeNotificationChannel]**](DeclarativeNotificationChannel.md) | | [optional] **organization** | [**DeclarativeOrganizationInfo**](DeclarativeOrganizationInfo.md) | | -**data_sources** | [**[DeclarativeDataSource]**](DeclarativeDataSource.md) | | [optional] -**export_templates** | [**[DeclarativeExportTemplate]**](DeclarativeExportTemplate.md) | | [optional] -**identity_providers** | [**[DeclarativeIdentityProvider]**](DeclarativeIdentityProvider.md) | | [optional] -**jwks** | [**[DeclarativeJwk]**](DeclarativeJwk.md) | | [optional] -**notification_channels** | [**[DeclarativeNotificationChannel]**](DeclarativeNotificationChannel.md) | | [optional] -**user_groups** | [**[DeclarativeUserGroup]**](DeclarativeUserGroup.md) | | [optional] -**users** | [**[DeclarativeUser]**](DeclarativeUser.md) | | [optional] -**workspace_data_filters** | [**[DeclarativeWorkspaceDataFilter]**](DeclarativeWorkspaceDataFilter.md) | | [optional] -**workspaces** | [**[DeclarativeWorkspace]**](DeclarativeWorkspace.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**user_groups** | [**List[DeclarativeUserGroup]**](DeclarativeUserGroup.md) | | [optional] +**users** | [**List[DeclarativeUser]**](DeclarativeUser.md) | | [optional] +**workspace_data_filters** | [**List[DeclarativeWorkspaceDataFilter]**](DeclarativeWorkspaceDataFilter.md) | | [optional] +**workspaces** | [**List[DeclarativeWorkspace]**](DeclarativeWorkspace.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeOrganization from a JSON string +declarative_organization_instance = DeclarativeOrganization.from_json(json) +# print the JSON string representation of the object +print(DeclarativeOrganization.to_json()) +# convert the object into a dict +declarative_organization_dict = declarative_organization_instance.to_dict() +# create an instance of DeclarativeOrganization from a dict +declarative_organization_from_dict = DeclarativeOrganization.from_dict(declarative_organization_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeOrganizationInfo.md b/gooddata-api-client/docs/DeclarativeOrganizationInfo.md index 1ff5ee1bd..5d47ea764 100644 --- a/gooddata-api-client/docs/DeclarativeOrganizationInfo.md +++ b/gooddata-api-client/docs/DeclarativeOrganizationInfo.md @@ -3,29 +3,46 @@ Information available about an organization. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**allowed_origins** | **List[str]** | | [optional] +**color_palettes** | [**List[DeclarativeColorPalette]**](DeclarativeColorPalette.md) | A list of color palettes. | [optional] +**csp_directives** | [**List[DeclarativeCspDirective]**](DeclarativeCspDirective.md) | A list of CSP directives. | [optional] +**early_access** | **str** | Early access defined on level Organization | [optional] +**early_access_values** | **List[str]** | Early access defined on level Organization | [optional] **hostname** | **str** | Formal hostname used in deployment. | **id** | **str** | Identifier of the organization. | -**name** | **str** | Formal name of the organization. | -**permissions** | [**[DeclarativeOrganizationPermission]**](DeclarativeOrganizationPermission.md) | | -**allowed_origins** | **[str]** | | [optional] -**color_palettes** | [**[DeclarativeColorPalette]**](DeclarativeColorPalette.md) | A list of color palettes. | [optional] -**csp_directives** | [**[DeclarativeCspDirective]**](DeclarativeCspDirective.md) | A list of CSP directives. | [optional] -**early_access** | **str** | Early access defined on level Organization | [optional] -**early_access_values** | **[str]** | Early access defined on level Organization | [optional] **identity_provider** | [**DeclarativeIdentityProviderIdentifier**](DeclarativeIdentityProviderIdentifier.md) | | [optional] +**name** | **str** | Formal name of the organization. | **oauth_client_id** | **str** | Identifier of the authentication provider | [optional] **oauth_client_secret** | **str** | Communication secret of the authentication provider (never returned back). | [optional] -**oauth_custom_auth_attributes** | **{str: (str,)}** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] -**oauth_custom_scopes** | **[str], none_type** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] +**oauth_custom_auth_attributes** | **Dict[str, str]** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] +**oauth_custom_scopes** | **List[str]** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] **oauth_issuer_id** | **str** | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] **oauth_issuer_location** | **str** | URI of the authentication provider. | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] -**settings** | [**[DeclarativeSetting]**](DeclarativeSetting.md) | A list of organization settings. | [optional] -**themes** | [**[DeclarativeTheme]**](DeclarativeTheme.md) | A list of themes. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | [**List[DeclarativeOrganizationPermission]**](DeclarativeOrganizationPermission.md) | | +**settings** | [**List[DeclarativeSetting]**](DeclarativeSetting.md) | A list of organization settings. | [optional] +**themes** | [**List[DeclarativeTheme]**](DeclarativeTheme.md) | A list of themes. | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_organization_info import DeclarativeOrganizationInfo + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeOrganizationInfo from a JSON string +declarative_organization_info_instance = DeclarativeOrganizationInfo.from_json(json) +# print the JSON string representation of the object +print(DeclarativeOrganizationInfo.to_json()) +# convert the object into a dict +declarative_organization_info_dict = declarative_organization_info_instance.to_dict() +# create an instance of DeclarativeOrganizationInfo from a dict +declarative_organization_info_from_dict = DeclarativeOrganizationInfo.from_dict(declarative_organization_info_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeOrganizationPermission.md b/gooddata-api-client/docs/DeclarativeOrganizationPermission.md index 07073b0ee..e9d9a23d7 100644 --- a/gooddata-api-client/docs/DeclarativeOrganizationPermission.md +++ b/gooddata-api-client/docs/DeclarativeOrganizationPermission.md @@ -3,12 +3,29 @@ Definition of an organization permission assigned to a user/user-group. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assignee** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | **name** | **str** | Permission name. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeOrganizationPermission from a JSON string +declarative_organization_permission_instance = DeclarativeOrganizationPermission.from_json(json) +# print the JSON string representation of the object +print(DeclarativeOrganizationPermission.to_json()) + +# convert the object into a dict +declarative_organization_permission_dict = declarative_organization_permission_instance.to_dict() +# create an instance of DeclarativeOrganizationPermission from a dict +declarative_organization_permission_from_dict = DeclarativeOrganizationPermission.from_dict(declarative_organization_permission_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeReference.md b/gooddata-api-client/docs/DeclarativeReference.md index 87ae2dc24..25b4927d4 100644 --- a/gooddata-api-client/docs/DeclarativeReference.md +++ b/gooddata-api-client/docs/DeclarativeReference.md @@ -3,15 +3,32 @@ A dataset reference. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identifier** | [**ReferenceIdentifier**](ReferenceIdentifier.md) | | **multivalue** | **bool** | The multi-value flag enables many-to-many cardinality for references. | -**source_column_data_types** | **[str]** | An array of source column data types for a given reference. Deprecated, use 'sources' instead. | [optional] -**source_columns** | **[str]** | An array of source column names for a given reference. Deprecated, use 'sources' instead. | [optional] -**sources** | [**[DeclarativeReferenceSource]**](DeclarativeReferenceSource.md) | An array of source columns for a given reference. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**source_column_data_types** | **List[str]** | An array of source column data types for a given reference. Deprecated, use 'sources' instead. | [optional] +**source_columns** | **List[str]** | An array of source column names for a given reference. Deprecated, use 'sources' instead. | [optional] +**sources** | [**List[DeclarativeReferenceSource]**](DeclarativeReferenceSource.md) | An array of source columns for a given reference. | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_reference import DeclarativeReference + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeReference from a JSON string +declarative_reference_instance = DeclarativeReference.from_json(json) +# print the JSON string representation of the object +print(DeclarativeReference.to_json()) +# convert the object into a dict +declarative_reference_dict = declarative_reference_instance.to_dict() +# create an instance of DeclarativeReference from a dict +declarative_reference_from_dict = DeclarativeReference.from_dict(declarative_reference_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeReferenceSource.md b/gooddata-api-client/docs/DeclarativeReferenceSource.md index 510e5307e..ce0dda20b 100644 --- a/gooddata-api-client/docs/DeclarativeReferenceSource.md +++ b/gooddata-api-client/docs/DeclarativeReferenceSource.md @@ -3,13 +3,30 @@ A dataset reference source column description. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **column** | **str** | A name of the source column in the table. | -**target** | [**GrainIdentifier**](GrainIdentifier.md) | | **data_type** | **str** | A type of the source column. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**target** | [**GrainIdentifier**](GrainIdentifier.md) | | + +## Example + +```python +from gooddata_api_client.models.declarative_reference_source import DeclarativeReferenceSource + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeReferenceSource from a JSON string +declarative_reference_source_instance = DeclarativeReferenceSource.from_json(json) +# print the JSON string representation of the object +print(DeclarativeReferenceSource.to_json()) +# convert the object into a dict +declarative_reference_source_dict = declarative_reference_source_instance.to_dict() +# create an instance of DeclarativeReferenceSource from a dict +declarative_reference_source_from_dict = DeclarativeReferenceSource.from_dict(declarative_reference_source_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeRsaSpecification.md b/gooddata-api-client/docs/DeclarativeRsaSpecification.md index a9ab45945..939fa599a 100644 --- a/gooddata-api-client/docs/DeclarativeRsaSpecification.md +++ b/gooddata-api-client/docs/DeclarativeRsaSpecification.md @@ -3,18 +3,35 @@ Declarative specification of the cryptographic key. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **alg** | **str** | Algorithm intended for use with the key. | **e** | **str** | parameter contains the exponent value for the RSA public key. | **kid** | **str** | Parameter is used to match a specific key. | +**kty** | **str** | Key type parameter | **n** | **str** | Parameter contains the modulus value for the RSA public key. | -**kty** | **str** | Key type parameter | defaults to "RSA" -**use** | **str** | Parameter identifies the intended use of the public key. | defaults to "sig" -**x5c** | **[str]** | Parameter contains a chain of one or more PKIX certificates. | [optional] +**use** | **str** | Parameter identifies the intended use of the public key. | +**x5c** | **List[str]** | Parameter contains a chain of one or more PKIX certificates. | [optional] **x5t** | **str** | Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_rsa_specification import DeclarativeRsaSpecification + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeRsaSpecification from a JSON string +declarative_rsa_specification_instance = DeclarativeRsaSpecification.from_json(json) +# print the JSON string representation of the object +print(DeclarativeRsaSpecification.to_json()) + +# convert the object into a dict +declarative_rsa_specification_dict = declarative_rsa_specification_instance.to_dict() +# create an instance of DeclarativeRsaSpecification from a dict +declarative_rsa_specification_from_dict = DeclarativeRsaSpecification.from_dict(declarative_rsa_specification_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeSetting.md b/gooddata-api-client/docs/DeclarativeSetting.md index ede395dbf..e0e8a68bc 100644 --- a/gooddata-api-client/docs/DeclarativeSetting.md +++ b/gooddata-api-client/docs/DeclarativeSetting.md @@ -3,13 +3,30 @@ Setting and its value. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**content** | **object** | Free-form JSON object | [optional] **id** | **str** | Setting ID. | -**content** | [**JsonNode**](JsonNode.md) | | [optional] **type** | **str** | Type of the setting. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_setting import DeclarativeSetting + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeSetting from a JSON string +declarative_setting_instance = DeclarativeSetting.from_json(json) +# print the JSON string representation of the object +print(DeclarativeSetting.to_json()) + +# convert the object into a dict +declarative_setting_dict = declarative_setting_instance.to_dict() +# create an instance of DeclarativeSetting from a dict +declarative_setting_from_dict = DeclarativeSetting.from_dict(declarative_setting_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeSingleWorkspacePermission.md b/gooddata-api-client/docs/DeclarativeSingleWorkspacePermission.md index 7e040edee..60de6e310 100644 --- a/gooddata-api-client/docs/DeclarativeSingleWorkspacePermission.md +++ b/gooddata-api-client/docs/DeclarativeSingleWorkspacePermission.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assignee** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | **name** | **str** | Permission name. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeSingleWorkspacePermission from a JSON string +declarative_single_workspace_permission_instance = DeclarativeSingleWorkspacePermission.from_json(json) +# print the JSON string representation of the object +print(DeclarativeSingleWorkspacePermission.to_json()) + +# convert the object into a dict +declarative_single_workspace_permission_dict = declarative_single_workspace_permission_instance.to_dict() +# create an instance of DeclarativeSingleWorkspacePermission from a dict +declarative_single_workspace_permission_from_dict = DeclarativeSingleWorkspacePermission.from_dict(declarative_single_workspace_permission_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeSourceFactReference.md b/gooddata-api-client/docs/DeclarativeSourceFactReference.md index 66a8dc4ca..2ca1abd96 100644 --- a/gooddata-api-client/docs/DeclarativeSourceFactReference.md +++ b/gooddata-api-client/docs/DeclarativeSourceFactReference.md @@ -3,12 +3,29 @@ Aggregated awareness source fact reference. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | **str** | Aggregation operation. | **reference** | [**FactIdentifier**](FactIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_source_fact_reference import DeclarativeSourceFactReference + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeSourceFactReference from a JSON string +declarative_source_fact_reference_instance = DeclarativeSourceFactReference.from_json(json) +# print the JSON string representation of the object +print(DeclarativeSourceFactReference.to_json()) + +# convert the object into a dict +declarative_source_fact_reference_dict = declarative_source_fact_reference_instance.to_dict() +# create an instance of DeclarativeSourceFactReference from a dict +declarative_source_fact_reference_from_dict = DeclarativeSourceFactReference.from_dict(declarative_source_fact_reference_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeTable.md b/gooddata-api-client/docs/DeclarativeTable.md index c8f725e84..8bc4e2a95 100644 --- a/gooddata-api-client/docs/DeclarativeTable.md +++ b/gooddata-api-client/docs/DeclarativeTable.md @@ -3,15 +3,32 @@ A database table. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**columns** | [**[DeclarativeColumn]**](DeclarativeColumn.md) | An array of physical columns | +**columns** | [**List[DeclarativeColumn]**](DeclarativeColumn.md) | An array of physical columns | **id** | **str** | Table id. | -**path** | **[str]** | Path to table. | -**type** | **str** | Table type: TABLE or VIEW. | **name_prefix** | **str** | Table or view name prefix used in scan. Will be stripped when generating LDM. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**path** | **List[str]** | Path to table. | +**type** | **str** | Table type: TABLE or VIEW. | + +## Example + +```python +from gooddata_api_client.models.declarative_table import DeclarativeTable + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeTable from a JSON string +declarative_table_instance = DeclarativeTable.from_json(json) +# print the JSON string representation of the object +print(DeclarativeTable.to_json()) +# convert the object into a dict +declarative_table_dict = declarative_table_instance.to_dict() +# create an instance of DeclarativeTable from a dict +declarative_table_from_dict = DeclarativeTable.from_dict(declarative_table_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeTables.md b/gooddata-api-client/docs/DeclarativeTables.md index 1e7db802b..79b3502d6 100644 --- a/gooddata-api-client/docs/DeclarativeTables.md +++ b/gooddata-api-client/docs/DeclarativeTables.md @@ -3,11 +3,28 @@ A physical data model (PDM) tables. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tables** | [**[DeclarativeTable]**](DeclarativeTable.md) | An array of physical database tables. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tables** | [**List[DeclarativeTable]**](DeclarativeTable.md) | An array of physical database tables. | + +## Example + +```python +from gooddata_api_client.models.declarative_tables import DeclarativeTables + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeTables from a JSON string +declarative_tables_instance = DeclarativeTables.from_json(json) +# print the JSON string representation of the object +print(DeclarativeTables.to_json()) +# convert the object into a dict +declarative_tables_dict = declarative_tables_instance.to_dict() +# create an instance of DeclarativeTables from a dict +declarative_tables_from_dict = DeclarativeTables.from_dict(declarative_tables_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeTheme.md b/gooddata-api-client/docs/DeclarativeTheme.md index 254bf4357..21817848d 100644 --- a/gooddata-api-client/docs/DeclarativeTheme.md +++ b/gooddata-api-client/docs/DeclarativeTheme.md @@ -3,13 +3,30 @@ Theme and its properties. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonNode**](JsonNode.md) | | +**content** | **object** | Free-form JSON object | **id** | **str** | | **name** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_theme import DeclarativeTheme + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeTheme from a JSON string +declarative_theme_instance = DeclarativeTheme.from_json(json) +# print the JSON string representation of the object +print(DeclarativeTheme.to_json()) + +# convert the object into a dict +declarative_theme_dict = declarative_theme_instance.to_dict() +# create an instance of DeclarativeTheme from a dict +declarative_theme_from_dict = DeclarativeTheme.from_dict(declarative_theme_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUser.md b/gooddata-api-client/docs/DeclarativeUser.md index 87bfd1fd9..7f51050a8 100644 --- a/gooddata-api-client/docs/DeclarativeUser.md +++ b/gooddata-api-client/docs/DeclarativeUser.md @@ -3,18 +3,35 @@ A user and its properties ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | User identifier. | **auth_id** | **str** | User identification in the authentication manager. | [optional] **email** | **str** | User email address | [optional] **firstname** | **str** | User first name | [optional] +**id** | **str** | User identifier. | **lastname** | **str** | User last name | [optional] -**permissions** | [**[DeclarativeUserPermission]**](DeclarativeUserPermission.md) | | [optional] -**settings** | [**[DeclarativeSetting]**](DeclarativeSetting.md) | A list of user settings. | [optional] -**user_groups** | [**[DeclarativeUserGroupIdentifier]**](DeclarativeUserGroupIdentifier.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | [**List[DeclarativeUserPermission]**](DeclarativeUserPermission.md) | | [optional] +**settings** | [**List[DeclarativeSetting]**](DeclarativeSetting.md) | A list of user settings. | [optional] +**user_groups** | [**List[DeclarativeUserGroupIdentifier]**](DeclarativeUserGroupIdentifier.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_user import DeclarativeUser + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUser from a JSON string +declarative_user_instance = DeclarativeUser.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUser.to_json()) +# convert the object into a dict +declarative_user_dict = declarative_user_instance.to_dict() +# create an instance of DeclarativeUser from a dict +declarative_user_from_dict = DeclarativeUser.from_dict(declarative_user_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUserDataFilter.md b/gooddata-api-client/docs/DeclarativeUserDataFilter.md index acbe15606..12e2c2c3d 100644 --- a/gooddata-api-client/docs/DeclarativeUserDataFilter.md +++ b/gooddata-api-client/docs/DeclarativeUserDataFilter.md @@ -3,17 +3,34 @@ User Data Filters serving the filtering of what data users can see in workspaces. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**description** | **str** | User Data Filters setting description. | [optional] **id** | **str** | User Data Filters ID. This ID is further used to refer to this instance. | **maql** | **str** | Expression in MAQL specifying the User Data Filter | +**tags** | **List[str]** | A list of tags. | [optional] **title** | **str** | User Data Filters setting title. | -**description** | **str** | User Data Filters setting description. | [optional] -**tags** | **[str]** | A list of tags. | [optional] **user** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **user_group** | [**DeclarativeUserGroupIdentifier**](DeclarativeUserGroupIdentifier.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_user_data_filter import DeclarativeUserDataFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUserDataFilter from a JSON string +declarative_user_data_filter_instance = DeclarativeUserDataFilter.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUserDataFilter.to_json()) + +# convert the object into a dict +declarative_user_data_filter_dict = declarative_user_data_filter_instance.to_dict() +# create an instance of DeclarativeUserDataFilter from a dict +declarative_user_data_filter_from_dict = DeclarativeUserDataFilter.from_dict(declarative_user_data_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUserDataFilters.md b/gooddata-api-client/docs/DeclarativeUserDataFilters.md index 34aef9157..54d296180 100644 --- a/gooddata-api-client/docs/DeclarativeUserDataFilters.md +++ b/gooddata-api-client/docs/DeclarativeUserDataFilters.md @@ -3,11 +3,28 @@ Declarative form of user data filters. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user_data_filters** | [**[DeclarativeUserDataFilter]**](DeclarativeUserDataFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**user_data_filters** | [**List[DeclarativeUserDataFilter]**](DeclarativeUserDataFilter.md) | | + +## Example + +```python +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUserDataFilters from a JSON string +declarative_user_data_filters_instance = DeclarativeUserDataFilters.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUserDataFilters.to_json()) +# convert the object into a dict +declarative_user_data_filters_dict = declarative_user_data_filters_instance.to_dict() +# create an instance of DeclarativeUserDataFilters from a dict +declarative_user_data_filters_from_dict = DeclarativeUserDataFilters.from_dict(declarative_user_data_filters_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUserGroup.md b/gooddata-api-client/docs/DeclarativeUserGroup.md index 0aab633cd..2095f6a19 100644 --- a/gooddata-api-client/docs/DeclarativeUserGroup.md +++ b/gooddata-api-client/docs/DeclarativeUserGroup.md @@ -3,14 +3,31 @@ A user-group and its properties ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | UserGroup identifier. | **name** | **str** | Name of UserGroup | [optional] -**parents** | [**[DeclarativeUserGroupIdentifier]**](DeclarativeUserGroupIdentifier.md) | | [optional] -**permissions** | [**[DeclarativeUserGroupPermission]**](DeclarativeUserGroupPermission.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**parents** | [**List[DeclarativeUserGroupIdentifier]**](DeclarativeUserGroupIdentifier.md) | | [optional] +**permissions** | [**List[DeclarativeUserGroupPermission]**](DeclarativeUserGroupPermission.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_user_group import DeclarativeUserGroup + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUserGroup from a JSON string +declarative_user_group_instance = DeclarativeUserGroup.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUserGroup.to_json()) +# convert the object into a dict +declarative_user_group_dict = declarative_user_group_instance.to_dict() +# create an instance of DeclarativeUserGroup from a dict +declarative_user_group_from_dict = DeclarativeUserGroup.from_dict(declarative_user_group_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUserGroupIdentifier.md b/gooddata-api-client/docs/DeclarativeUserGroupIdentifier.md index 974d3a68d..97315acb3 100644 --- a/gooddata-api-client/docs/DeclarativeUserGroupIdentifier.md +++ b/gooddata-api-client/docs/DeclarativeUserGroupIdentifier.md @@ -3,12 +3,29 @@ A user group identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Identifier of the user group. | -**type** | **str** | A type. | defaults to "userGroup" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | A type. | + +## Example + +```python +from gooddata_api_client.models.declarative_user_group_identifier import DeclarativeUserGroupIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUserGroupIdentifier from a JSON string +declarative_user_group_identifier_instance = DeclarativeUserGroupIdentifier.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUserGroupIdentifier.to_json()) +# convert the object into a dict +declarative_user_group_identifier_dict = declarative_user_group_identifier_instance.to_dict() +# create an instance of DeclarativeUserGroupIdentifier from a dict +declarative_user_group_identifier_from_dict = DeclarativeUserGroupIdentifier.from_dict(declarative_user_group_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUserGroupPermission.md b/gooddata-api-client/docs/DeclarativeUserGroupPermission.md index a1b7c224e..6d193c12c 100644 --- a/gooddata-api-client/docs/DeclarativeUserGroupPermission.md +++ b/gooddata-api-client/docs/DeclarativeUserGroupPermission.md @@ -3,12 +3,29 @@ Definition of a user-group permission assigned to a user/user-group. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assignee** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | -**name** | **str** | Permission name. | defaults to "SEE" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**name** | **str** | Permission name. | + +## Example + +```python +from gooddata_api_client.models.declarative_user_group_permission import DeclarativeUserGroupPermission + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUserGroupPermission from a JSON string +declarative_user_group_permission_instance = DeclarativeUserGroupPermission.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUserGroupPermission.to_json()) +# convert the object into a dict +declarative_user_group_permission_dict = declarative_user_group_permission_instance.to_dict() +# create an instance of DeclarativeUserGroupPermission from a dict +declarative_user_group_permission_from_dict = DeclarativeUserGroupPermission.from_dict(declarative_user_group_permission_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUserGroupPermissions.md b/gooddata-api-client/docs/DeclarativeUserGroupPermissions.md index 24f3f3a6d..b59c285ae 100644 --- a/gooddata-api-client/docs/DeclarativeUserGroupPermissions.md +++ b/gooddata-api-client/docs/DeclarativeUserGroupPermissions.md @@ -3,11 +3,28 @@ Definition of permissions associated with a user-group. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permissions** | [**[DeclarativeUserGroupPermission]**](DeclarativeUserGroupPermission.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | [**List[DeclarativeUserGroupPermission]**](DeclarativeUserGroupPermission.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUserGroupPermissions from a JSON string +declarative_user_group_permissions_instance = DeclarativeUserGroupPermissions.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUserGroupPermissions.to_json()) +# convert the object into a dict +declarative_user_group_permissions_dict = declarative_user_group_permissions_instance.to_dict() +# create an instance of DeclarativeUserGroupPermissions from a dict +declarative_user_group_permissions_from_dict = DeclarativeUserGroupPermissions.from_dict(declarative_user_group_permissions_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUserGroups.md b/gooddata-api-client/docs/DeclarativeUserGroups.md index 9cfcf01a6..8c27e9f30 100644 --- a/gooddata-api-client/docs/DeclarativeUserGroups.md +++ b/gooddata-api-client/docs/DeclarativeUserGroups.md @@ -3,11 +3,28 @@ Declarative form of userGroups and its properties. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user_groups** | [**[DeclarativeUserGroup]**](DeclarativeUserGroup.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**user_groups** | [**List[DeclarativeUserGroup]**](DeclarativeUserGroup.md) | | + +## Example + +```python +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUserGroups from a JSON string +declarative_user_groups_instance = DeclarativeUserGroups.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUserGroups.to_json()) +# convert the object into a dict +declarative_user_groups_dict = declarative_user_groups_instance.to_dict() +# create an instance of DeclarativeUserGroups from a dict +declarative_user_groups_from_dict = DeclarativeUserGroups.from_dict(declarative_user_groups_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUserIdentifier.md b/gooddata-api-client/docs/DeclarativeUserIdentifier.md index 193096681..bdb681af4 100644 --- a/gooddata-api-client/docs/DeclarativeUserIdentifier.md +++ b/gooddata-api-client/docs/DeclarativeUserIdentifier.md @@ -3,12 +3,29 @@ A user identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | User identifier. | -**type** | **str** | A type. | defaults to "user" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | A type. | + +## Example + +```python +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUserIdentifier from a JSON string +declarative_user_identifier_instance = DeclarativeUserIdentifier.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUserIdentifier.to_json()) +# convert the object into a dict +declarative_user_identifier_dict = declarative_user_identifier_instance.to_dict() +# create an instance of DeclarativeUserIdentifier from a dict +declarative_user_identifier_from_dict = DeclarativeUserIdentifier.from_dict(declarative_user_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUserPermission.md b/gooddata-api-client/docs/DeclarativeUserPermission.md index bb2dfdf54..be15492a1 100644 --- a/gooddata-api-client/docs/DeclarativeUserPermission.md +++ b/gooddata-api-client/docs/DeclarativeUserPermission.md @@ -3,12 +3,29 @@ Definition of a user permission assigned to a user/user-group. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assignee** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | -**name** | **str** | Permission name. | defaults to "SEE" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**name** | **str** | Permission name. | + +## Example + +```python +from gooddata_api_client.models.declarative_user_permission import DeclarativeUserPermission + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUserPermission from a JSON string +declarative_user_permission_instance = DeclarativeUserPermission.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUserPermission.to_json()) +# convert the object into a dict +declarative_user_permission_dict = declarative_user_permission_instance.to_dict() +# create an instance of DeclarativeUserPermission from a dict +declarative_user_permission_from_dict = DeclarativeUserPermission.from_dict(declarative_user_permission_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUserPermissions.md b/gooddata-api-client/docs/DeclarativeUserPermissions.md index 8f3f1a833..d70a492b8 100644 --- a/gooddata-api-client/docs/DeclarativeUserPermissions.md +++ b/gooddata-api-client/docs/DeclarativeUserPermissions.md @@ -3,11 +3,28 @@ Definition of permissions associated with a user. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permissions** | [**[DeclarativeUserPermission]**](DeclarativeUserPermission.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | [**List[DeclarativeUserPermission]**](DeclarativeUserPermission.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUserPermissions from a JSON string +declarative_user_permissions_instance = DeclarativeUserPermissions.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUserPermissions.to_json()) +# convert the object into a dict +declarative_user_permissions_dict = declarative_user_permissions_instance.to_dict() +# create an instance of DeclarativeUserPermissions from a dict +declarative_user_permissions_from_dict = DeclarativeUserPermissions.from_dict(declarative_user_permissions_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUsers.md b/gooddata-api-client/docs/DeclarativeUsers.md index ea5d50039..4f476e121 100644 --- a/gooddata-api-client/docs/DeclarativeUsers.md +++ b/gooddata-api-client/docs/DeclarativeUsers.md @@ -3,11 +3,28 @@ Declarative form of users and its properties. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**users** | [**[DeclarativeUser]**](DeclarativeUser.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**users** | [**List[DeclarativeUser]**](DeclarativeUser.md) | | + +## Example + +```python +from gooddata_api_client.models.declarative_users import DeclarativeUsers + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUsers from a JSON string +declarative_users_instance = DeclarativeUsers.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUsers.to_json()) +# convert the object into a dict +declarative_users_dict = declarative_users_instance.to_dict() +# create an instance of DeclarativeUsers from a dict +declarative_users_from_dict = DeclarativeUsers.from_dict(declarative_users_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeUsersUserGroups.md b/gooddata-api-client/docs/DeclarativeUsersUserGroups.md index e04a6910d..6e443ea07 100644 --- a/gooddata-api-client/docs/DeclarativeUsersUserGroups.md +++ b/gooddata-api-client/docs/DeclarativeUsersUserGroups.md @@ -3,12 +3,29 @@ Declarative form of both users and user groups and theirs properties. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user_groups** | [**[DeclarativeUserGroup]**](DeclarativeUserGroup.md) | | -**users** | [**[DeclarativeUser]**](DeclarativeUser.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**user_groups** | [**List[DeclarativeUserGroup]**](DeclarativeUserGroup.md) | | +**users** | [**List[DeclarativeUser]**](DeclarativeUser.md) | | + +## Example + +```python +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeUsersUserGroups from a JSON string +declarative_users_user_groups_instance = DeclarativeUsersUserGroups.from_json(json) +# print the JSON string representation of the object +print(DeclarativeUsersUserGroups.to_json()) +# convert the object into a dict +declarative_users_user_groups_dict = declarative_users_user_groups_instance.to_dict() +# create an instance of DeclarativeUsersUserGroups from a dict +declarative_users_user_groups_from_dict = DeclarativeUsersUserGroups.from_dict(declarative_users_user_groups_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeVisualizationObject.md b/gooddata-api-client/docs/DeclarativeVisualizationObject.md index b3e60dfc1..d3ded2979 100644 --- a/gooddata-api-client/docs/DeclarativeVisualizationObject.md +++ b/gooddata-api-client/docs/DeclarativeVisualizationObject.md @@ -2,20 +2,37 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonNode**](JsonNode.md) | | -**id** | **str** | Visualization object ID. | -**title** | **str** | Visualization object title. | -**created_at** | **str, none_type** | Time of the entity creation. | [optional] +**content** | **object** | Free-form JSON object | +**created_at** | **str** | Time of the entity creation. | [optional] **created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **description** | **str** | Visualization object description. | [optional] +**id** | **str** | Visualization object ID. | **is_hidden** | **bool** | If true, this visualization object is hidden from AI search results. | [optional] -**modified_at** | **str, none_type** | Time of the last entity modification. | [optional] +**modified_at** | **str** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] -**tags** | **[str]** | A list of tags. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tags** | **List[str]** | A list of tags. | [optional] +**title** | **str** | Visualization object title. | + +## Example + +```python +from gooddata_api_client.models.declarative_visualization_object import DeclarativeVisualizationObject + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeVisualizationObject from a JSON string +declarative_visualization_object_instance = DeclarativeVisualizationObject.from_json(json) +# print the JSON string representation of the object +print(DeclarativeVisualizationObject.to_json()) +# convert the object into a dict +declarative_visualization_object_dict = declarative_visualization_object_instance.to_dict() +# create an instance of DeclarativeVisualizationObject from a dict +declarative_visualization_object_from_dict = DeclarativeVisualizationObject.from_dict(declarative_visualization_object_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeWorkspace.md b/gooddata-api-client/docs/DeclarativeWorkspace.md index 91d84478c..592beede3 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspace.md +++ b/gooddata-api-client/docs/DeclarativeWorkspace.md @@ -3,27 +3,44 @@ A declarative form of a particular workspace. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Identifier of a workspace | -**name** | **str** | Name of a workspace to view. | -**automations** | [**[DeclarativeAutomation]**](DeclarativeAutomation.md) | | [optional] +**automations** | [**List[DeclarativeAutomation]**](DeclarativeAutomation.md) | | [optional] **cache_extra_limit** | **int** | Extra cache limit allocated to specific workspace. In case there is extra cache budget setup for organization, it can be split between multiple workspaces. | [optional] -**custom_application_settings** | [**[DeclarativeCustomApplicationSetting]**](DeclarativeCustomApplicationSetting.md) | A list of workspace custom settings. | [optional] +**custom_application_settings** | [**List[DeclarativeCustomApplicationSetting]**](DeclarativeCustomApplicationSetting.md) | A list of workspace custom settings. | [optional] **data_source** | [**WorkspaceDataSource**](WorkspaceDataSource.md) | | [optional] **description** | **str** | Description of the workspace | [optional] **early_access** | **str** | Early access defined on level Workspace | [optional] -**early_access_values** | **[str]** | Early access defined on level Workspace | [optional] -**filter_views** | [**[DeclarativeFilterView]**](DeclarativeFilterView.md) | | [optional] -**hierarchy_permissions** | [**[DeclarativeWorkspaceHierarchyPermission]**](DeclarativeWorkspaceHierarchyPermission.md) | | [optional] +**early_access_values** | **List[str]** | Early access defined on level Workspace | [optional] +**filter_views** | [**List[DeclarativeFilterView]**](DeclarativeFilterView.md) | | [optional] +**hierarchy_permissions** | [**List[DeclarativeWorkspaceHierarchyPermission]**](DeclarativeWorkspaceHierarchyPermission.md) | | [optional] +**id** | **str** | Identifier of a workspace | **model** | [**DeclarativeWorkspaceModel**](DeclarativeWorkspaceModel.md) | | [optional] +**name** | **str** | Name of a workspace to view. | **parent** | [**WorkspaceIdentifier**](WorkspaceIdentifier.md) | | [optional] -**permissions** | [**[DeclarativeSingleWorkspacePermission]**](DeclarativeSingleWorkspacePermission.md) | | [optional] +**permissions** | [**List[DeclarativeSingleWorkspacePermission]**](DeclarativeSingleWorkspacePermission.md) | | [optional] **prefix** | **str** | Custom prefix of entity identifiers in workspace | [optional] -**settings** | [**[DeclarativeSetting]**](DeclarativeSetting.md) | A list of workspace settings. | [optional] -**user_data_filters** | [**[DeclarativeUserDataFilter]**](DeclarativeUserDataFilter.md) | A list of workspace user data filters. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**settings** | [**List[DeclarativeSetting]**](DeclarativeSetting.md) | A list of workspace settings. | [optional] +**user_data_filters** | [**List[DeclarativeUserDataFilter]**](DeclarativeUserDataFilter.md) | A list of workspace user data filters. | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_workspace import DeclarativeWorkspace + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeWorkspace from a JSON string +declarative_workspace_instance = DeclarativeWorkspace.from_json(json) +# print the JSON string representation of the object +print(DeclarativeWorkspace.to_json()) +# convert the object into a dict +declarative_workspace_dict = declarative_workspace_instance.to_dict() +# create an instance of DeclarativeWorkspace from a dict +declarative_workspace_from_dict = DeclarativeWorkspace.from_dict(declarative_workspace_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeWorkspaceDataFilter.md b/gooddata-api-client/docs/DeclarativeWorkspaceDataFilter.md index dace32cdc..0ea607e42 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspaceDataFilter.md +++ b/gooddata-api-client/docs/DeclarativeWorkspaceDataFilter.md @@ -3,16 +3,33 @@ Workspace Data Filters serving the filtering of what data users can see in workspaces. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **column_name** | **str** | Workspace Data Filters column name. Data are filtered using this physical column. | +**description** | **str** | Workspace Data Filters description. | [optional] **id** | **str** | Workspace Data Filters ID. This ID is further used to refer to this instance. | **title** | **str** | Workspace Data Filters title. | **workspace** | [**WorkspaceIdentifier**](WorkspaceIdentifier.md) | | -**workspace_data_filter_settings** | [**[DeclarativeWorkspaceDataFilterSetting]**](DeclarativeWorkspaceDataFilterSetting.md) | Filter settings specifying values of filters valid for the workspace. | -**description** | **str** | Workspace Data Filters description. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**workspace_data_filter_settings** | [**List[DeclarativeWorkspaceDataFilterSetting]**](DeclarativeWorkspaceDataFilterSetting.md) | Filter settings specifying values of filters valid for the workspace. | + +## Example + +```python +from gooddata_api_client.models.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeWorkspaceDataFilter from a JSON string +declarative_workspace_data_filter_instance = DeclarativeWorkspaceDataFilter.from_json(json) +# print the JSON string representation of the object +print(DeclarativeWorkspaceDataFilter.to_json()) +# convert the object into a dict +declarative_workspace_data_filter_dict = declarative_workspace_data_filter_instance.to_dict() +# create an instance of DeclarativeWorkspaceDataFilter from a dict +declarative_workspace_data_filter_from_dict = DeclarativeWorkspaceDataFilter.from_dict(declarative_workspace_data_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterColumn.md b/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterColumn.md index bf4fff0fe..b741784c9 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterColumn.md +++ b/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterColumn.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_type** | **str** | Data type of the column | **name** | **str** | Name of the column | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeWorkspaceDataFilterColumn from a JSON string +declarative_workspace_data_filter_column_instance = DeclarativeWorkspaceDataFilterColumn.from_json(json) +# print the JSON string representation of the object +print(DeclarativeWorkspaceDataFilterColumn.to_json()) + +# convert the object into a dict +declarative_workspace_data_filter_column_dict = declarative_workspace_data_filter_column_instance.to_dict() +# create an instance of DeclarativeWorkspaceDataFilterColumn from a dict +declarative_workspace_data_filter_column_from_dict = DeclarativeWorkspaceDataFilterColumn.from_dict(declarative_workspace_data_filter_column_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterReferences.md b/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterReferences.md index 3bb5f11d8..bcfea67fd 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterReferences.md +++ b/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterReferences.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **filter_column** | **str** | Filter column name | **filter_column_data_type** | **str** | Filter column data type | **filter_id** | [**DatasetWorkspaceDataFilterIdentifier**](DatasetWorkspaceDataFilterIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_workspace_data_filter_references import DeclarativeWorkspaceDataFilterReferences + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeWorkspaceDataFilterReferences from a JSON string +declarative_workspace_data_filter_references_instance = DeclarativeWorkspaceDataFilterReferences.from_json(json) +# print the JSON string representation of the object +print(DeclarativeWorkspaceDataFilterReferences.to_json()) + +# convert the object into a dict +declarative_workspace_data_filter_references_dict = declarative_workspace_data_filter_references_instance.to_dict() +# create an instance of DeclarativeWorkspaceDataFilterReferences from a dict +declarative_workspace_data_filter_references_from_dict = DeclarativeWorkspaceDataFilterReferences.from_dict(declarative_workspace_data_filter_references_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterSetting.md b/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterSetting.md index 34256e5c6..92bf5932d 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterSetting.md +++ b/gooddata-api-client/docs/DeclarativeWorkspaceDataFilterSetting.md @@ -3,15 +3,32 @@ Workspace Data Filters serving the filtering of what data users can see in workspaces. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**filter_values** | **[str]** | Only those rows are returned, where columnName from filter matches those values. | +**description** | **str** | Workspace Data Filters setting description. | [optional] +**filter_values** | **List[str]** | Only those rows are returned, where columnName from filter matches those values. | **id** | **str** | Workspace Data Filters ID. This ID is further used to refer to this instance. | **title** | **str** | Workspace Data Filters setting title. | **workspace** | [**WorkspaceIdentifier**](WorkspaceIdentifier.md) | | -**description** | **str** | Workspace Data Filters setting description. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_workspace_data_filter_setting import DeclarativeWorkspaceDataFilterSetting + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeWorkspaceDataFilterSetting from a JSON string +declarative_workspace_data_filter_setting_instance = DeclarativeWorkspaceDataFilterSetting.from_json(json) +# print the JSON string representation of the object +print(DeclarativeWorkspaceDataFilterSetting.to_json()) + +# convert the object into a dict +declarative_workspace_data_filter_setting_dict = declarative_workspace_data_filter_setting_instance.to_dict() +# create an instance of DeclarativeWorkspaceDataFilterSetting from a dict +declarative_workspace_data_filter_setting_from_dict = DeclarativeWorkspaceDataFilterSetting.from_dict(declarative_workspace_data_filter_setting_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeWorkspaceDataFilters.md b/gooddata-api-client/docs/DeclarativeWorkspaceDataFilters.md index 255d63aa1..e64f13765 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspaceDataFilters.md +++ b/gooddata-api-client/docs/DeclarativeWorkspaceDataFilters.md @@ -3,11 +3,28 @@ Declarative form of data filters. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**workspace_data_filters** | [**[DeclarativeWorkspaceDataFilter]**](DeclarativeWorkspaceDataFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**workspace_data_filters** | [**List[DeclarativeWorkspaceDataFilter]**](DeclarativeWorkspaceDataFilter.md) | | + +## Example + +```python +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeWorkspaceDataFilters from a JSON string +declarative_workspace_data_filters_instance = DeclarativeWorkspaceDataFilters.from_json(json) +# print the JSON string representation of the object +print(DeclarativeWorkspaceDataFilters.to_json()) +# convert the object into a dict +declarative_workspace_data_filters_dict = declarative_workspace_data_filters_instance.to_dict() +# create an instance of DeclarativeWorkspaceDataFilters from a dict +declarative_workspace_data_filters_from_dict = DeclarativeWorkspaceDataFilters.from_dict(declarative_workspace_data_filters_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeWorkspaceHierarchyPermission.md b/gooddata-api-client/docs/DeclarativeWorkspaceHierarchyPermission.md index cae74fdb1..903a0f406 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspaceHierarchyPermission.md +++ b/gooddata-api-client/docs/DeclarativeWorkspaceHierarchyPermission.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assignee** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | **name** | **str** | Permission name. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeWorkspaceHierarchyPermission from a JSON string +declarative_workspace_hierarchy_permission_instance = DeclarativeWorkspaceHierarchyPermission.from_json(json) +# print the JSON string representation of the object +print(DeclarativeWorkspaceHierarchyPermission.to_json()) + +# convert the object into a dict +declarative_workspace_hierarchy_permission_dict = declarative_workspace_hierarchy_permission_instance.to_dict() +# create an instance of DeclarativeWorkspaceHierarchyPermission from a dict +declarative_workspace_hierarchy_permission_from_dict = DeclarativeWorkspaceHierarchyPermission.from_dict(declarative_workspace_hierarchy_permission_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeWorkspaceModel.md b/gooddata-api-client/docs/DeclarativeWorkspaceModel.md index 6566d3612..c46d18bb6 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspaceModel.md +++ b/gooddata-api-client/docs/DeclarativeWorkspaceModel.md @@ -3,12 +3,29 @@ A declarative form of a model and analytics for a workspace. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytics** | [**DeclarativeAnalyticsLayer**](DeclarativeAnalyticsLayer.md) | | [optional] **ldm** | [**DeclarativeLdm**](DeclarativeLdm.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeWorkspaceModel from a JSON string +declarative_workspace_model_instance = DeclarativeWorkspaceModel.from_json(json) +# print the JSON string representation of the object +print(DeclarativeWorkspaceModel.to_json()) + +# convert the object into a dict +declarative_workspace_model_dict = declarative_workspace_model_instance.to_dict() +# create an instance of DeclarativeWorkspaceModel from a dict +declarative_workspace_model_from_dict = DeclarativeWorkspaceModel.from_dict(declarative_workspace_model_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeWorkspacePermissions.md b/gooddata-api-client/docs/DeclarativeWorkspacePermissions.md index 0df396ef0..41f510523 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspacePermissions.md +++ b/gooddata-api-client/docs/DeclarativeWorkspacePermissions.md @@ -3,12 +3,29 @@ Definition of permissions associated with a workspace. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hierarchy_permissions** | [**[DeclarativeWorkspaceHierarchyPermission]**](DeclarativeWorkspaceHierarchyPermission.md) | | [optional] -**permissions** | [**[DeclarativeSingleWorkspacePermission]**](DeclarativeSingleWorkspacePermission.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**hierarchy_permissions** | [**List[DeclarativeWorkspaceHierarchyPermission]**](DeclarativeWorkspaceHierarchyPermission.md) | | [optional] +**permissions** | [**List[DeclarativeSingleWorkspacePermission]**](DeclarativeSingleWorkspacePermission.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeWorkspacePermissions from a JSON string +declarative_workspace_permissions_instance = DeclarativeWorkspacePermissions.from_json(json) +# print the JSON string representation of the object +print(DeclarativeWorkspacePermissions.to_json()) +# convert the object into a dict +declarative_workspace_permissions_dict = declarative_workspace_permissions_instance.to_dict() +# create an instance of DeclarativeWorkspacePermissions from a dict +declarative_workspace_permissions_from_dict = DeclarativeWorkspacePermissions.from_dict(declarative_workspace_permissions_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeWorkspaces.md b/gooddata-api-client/docs/DeclarativeWorkspaces.md index 1bf67d5cf..62cf2728b 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspaces.md +++ b/gooddata-api-client/docs/DeclarativeWorkspaces.md @@ -3,12 +3,29 @@ A declarative form of a all workspace layout. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**workspace_data_filters** | [**[DeclarativeWorkspaceDataFilter]**](DeclarativeWorkspaceDataFilter.md) | | -**workspaces** | [**[DeclarativeWorkspace]**](DeclarativeWorkspace.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**workspace_data_filters** | [**List[DeclarativeWorkspaceDataFilter]**](DeclarativeWorkspaceDataFilter.md) | | +**workspaces** | [**List[DeclarativeWorkspace]**](DeclarativeWorkspace.md) | | + +## Example + +```python +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces + +# TODO update the JSON string below +json = "{}" +# create an instance of DeclarativeWorkspaces from a JSON string +declarative_workspaces_instance = DeclarativeWorkspaces.from_json(json) +# print the JSON string representation of the object +print(DeclarativeWorkspaces.to_json()) +# convert the object into a dict +declarative_workspaces_dict = declarative_workspaces_instance.to_dict() +# create an instance of DeclarativeWorkspaces from a dict +declarative_workspaces_from_dict = DeclarativeWorkspaces.from_dict(declarative_workspaces_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DefaultSmtp.md b/gooddata-api-client/docs/DefaultSmtp.md index 336642add..de2278da8 100644 --- a/gooddata-api-client/docs/DefaultSmtp.md +++ b/gooddata-api-client/docs/DefaultSmtp.md @@ -3,13 +3,30 @@ Default SMTP destination for notifications. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | The destination type. | defaults to "DEFAULT_SMTP" -**from_email** | **str** | E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead. | [optional] if omitted the server will use the default value of no-reply@gooddata.com -**from_email_name** | **str** | An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead. | [optional] if omitted the server will use the default value of "GoodData" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**from_email** | **str** | E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead. | [optional] [default to 'no-reply@gooddata.com'] +**from_email_name** | **str** | An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead. | [optional] [default to 'GoodData'] +**type** | **str** | The destination type. | + +## Example + +```python +from gooddata_api_client.models.default_smtp import DefaultSmtp + +# TODO update the JSON string below +json = "{}" +# create an instance of DefaultSmtp from a JSON string +default_smtp_instance = DefaultSmtp.from_json(json) +# print the JSON string representation of the object +print(DefaultSmtp.to_json()) +# convert the object into a dict +default_smtp_dict = default_smtp_instance.to_dict() +# create an instance of DefaultSmtp from a dict +default_smtp_from_dict = DefaultSmtp.from_dict(default_smtp_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DefaultSmtpAllOf.md b/gooddata-api-client/docs/DefaultSmtpAllOf.md deleted file mode 100644 index 3eb86fe77..000000000 --- a/gooddata-api-client/docs/DefaultSmtpAllOf.md +++ /dev/null @@ -1,14 +0,0 @@ -# DefaultSmtpAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**from_email** | **str** | E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead. | [optional] if omitted the server will use the default value of no-reply@gooddata.com -**from_email_name** | **str** | An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead. | [optional] if omitted the server will use the default value of "GoodData" -**type** | **str** | The destination type. | [optional] if omitted the server will use the default value of "DEFAULT_SMTP" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DependencyGraphApi.md b/gooddata-api-client/docs/DependencyGraphApi.md index 31c38aec2..b8c3901c6 100644 --- a/gooddata-api-client/docs/DependencyGraphApi.md +++ b/gooddata-api-client/docs/DependencyGraphApi.md @@ -19,11 +19,11 @@ Computes the dependent entities graph ```python -import time import gooddata_api_client -from gooddata_api_client.api import dependency_graph_api -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -32,26 +32,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = dependency_graph_api.DependencyGraphApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.DependencyGraphApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Computes the dependent entities graph api_response = api_instance.get_dependent_entities_graph(workspace_id) + print("The response of DependencyGraphApi->get_dependent_entities_graph:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DependencyGraphApi->get_dependent_entities_graph: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type @@ -66,7 +68,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -86,12 +87,12 @@ Computes the dependent entities graph from given entry points ```python -import time import gooddata_api_client -from gooddata_api_client.api import dependency_graph_api -from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -100,35 +101,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = dependency_graph_api.DependencyGraphApi(api_client) - workspace_id = "workspaceId_example" # str | - dependent_entities_request = DependentEntitiesRequest( - identifiers=[ - EntityIdentifier( - id="/6bUUGjjNSwg0_bs", - type="metric", - ), - ], - ) # DependentEntitiesRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.DependencyGraphApi(api_client) + workspace_id = 'workspace_id_example' # str | + dependent_entities_request = gooddata_api_client.DependentEntitiesRequest() # DependentEntitiesRequest | + try: # Computes the dependent entities graph from given entry points api_response = api_instance.get_dependent_entities_graph_from_entry_points(workspace_id, dependent_entities_request) + print("The response of DependencyGraphApi->get_dependent_entities_graph_from_entry_points:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling DependencyGraphApi->get_dependent_entities_graph_from_entry_points: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **dependent_entities_request** | [**DependentEntitiesRequest**](DependentEntitiesRequest.md)| | + **workspace_id** | **str**| | + **dependent_entities_request** | [**DependentEntitiesRequest**](DependentEntitiesRequest.md)| | ### Return type @@ -143,7 +139,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/DependentEntitiesGraph.md b/gooddata-api-client/docs/DependentEntitiesGraph.md index b57440261..1391dd0d2 100644 --- a/gooddata-api-client/docs/DependentEntitiesGraph.md +++ b/gooddata-api-client/docs/DependentEntitiesGraph.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**edges** | [**[[EntityIdentifier]]**](EntityIdentifier.md) | | -**nodes** | [**[DependentEntitiesNode]**](DependentEntitiesNode.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**edges** | **List[List[EntityIdentifier]]** | | +**nodes** | [**List[DependentEntitiesNode]**](DependentEntitiesNode.md) | | + +## Example + +```python +from gooddata_api_client.models.dependent_entities_graph import DependentEntitiesGraph + +# TODO update the JSON string below +json = "{}" +# create an instance of DependentEntitiesGraph from a JSON string +dependent_entities_graph_instance = DependentEntitiesGraph.from_json(json) +# print the JSON string representation of the object +print(DependentEntitiesGraph.to_json()) +# convert the object into a dict +dependent_entities_graph_dict = dependent_entities_graph_instance.to_dict() +# create an instance of DependentEntitiesGraph from a dict +dependent_entities_graph_from_dict = DependentEntitiesGraph.from_dict(dependent_entities_graph_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DependentEntitiesNode.md b/gooddata-api-client/docs/DependentEntitiesNode.md index 7a5dacb25..911c7215b 100644 --- a/gooddata-api-client/docs/DependentEntitiesNode.md +++ b/gooddata-api-client/docs/DependentEntitiesNode.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.dependent_entities_node import DependentEntitiesNode + +# TODO update the JSON string below +json = "{}" +# create an instance of DependentEntitiesNode from a JSON string +dependent_entities_node_instance = DependentEntitiesNode.from_json(json) +# print the JSON string representation of the object +print(DependentEntitiesNode.to_json()) +# convert the object into a dict +dependent_entities_node_dict = dependent_entities_node_instance.to_dict() +# create an instance of DependentEntitiesNode from a dict +dependent_entities_node_from_dict = DependentEntitiesNode.from_dict(dependent_entities_node_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DependentEntitiesRequest.md b/gooddata-api-client/docs/DependentEntitiesRequest.md index 248fd5953..e0ca26edf 100644 --- a/gooddata-api-client/docs/DependentEntitiesRequest.md +++ b/gooddata-api-client/docs/DependentEntitiesRequest.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**identifiers** | [**[EntityIdentifier]**](EntityIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**identifiers** | [**List[EntityIdentifier]**](EntityIdentifier.md) | | + +## Example + +```python +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of DependentEntitiesRequest from a JSON string +dependent_entities_request_instance = DependentEntitiesRequest.from_json(json) +# print the JSON string representation of the object +print(DependentEntitiesRequest.to_json()) +# convert the object into a dict +dependent_entities_request_dict = dependent_entities_request_instance.to_dict() +# create an instance of DependentEntitiesRequest from a dict +dependent_entities_request_from_dict = DependentEntitiesRequest.from_dict(dependent_entities_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DependentEntitiesResponse.md b/gooddata-api-client/docs/DependentEntitiesResponse.md index b0a04bc5d..abd31be80 100644 --- a/gooddata-api-client/docs/DependentEntitiesResponse.md +++ b/gooddata-api-client/docs/DependentEntitiesResponse.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **graph** | [**DependentEntitiesGraph**](DependentEntitiesGraph.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of DependentEntitiesResponse from a JSON string +dependent_entities_response_instance = DependentEntitiesResponse.from_json(json) +# print the JSON string representation of the object +print(DependentEntitiesResponse.to_json()) + +# convert the object into a dict +dependent_entities_response_dict = dependent_entities_response_instance.to_dict() +# create an instance of DependentEntitiesResponse from a dict +dependent_entities_response_from_dict = DependentEntitiesResponse.from_dict(dependent_entities_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DependsOn.md b/gooddata-api-client/docs/DependsOn.md index fc63f0064..8058c3211 100644 --- a/gooddata-api-client/docs/DependsOn.md +++ b/gooddata-api-client/docs/DependsOn.md @@ -3,13 +3,30 @@ Filter definition type specified by label and values. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**complement_filter** | **bool** | Inverse filtering mode. | [optional] [default to False] **label** | **str** | Specifies on which label the filter depends on. | -**values** | **[str, none_type]** | Specifies values of the label for element filtering. | -**complement_filter** | **bool** | Inverse filtering mode. | [optional] if omitted the server will use the default value of False -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**values** | **List[Optional[str]]** | Specifies values of the label for element filtering. | + +## Example + +```python +from gooddata_api_client.models.depends_on import DependsOn + +# TODO update the JSON string below +json = "{}" +# create an instance of DependsOn from a JSON string +depends_on_instance = DependsOn.from_json(json) +# print the JSON string representation of the object +print(DependsOn.to_json()) +# convert the object into a dict +depends_on_dict = depends_on_instance.to_dict() +# create an instance of DependsOn from a dict +depends_on_from_dict = DependsOn.from_dict(depends_on_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DependsOnAllOf.md b/gooddata-api-client/docs/DependsOnAllOf.md deleted file mode 100644 index 71120ad8d..000000000 --- a/gooddata-api-client/docs/DependsOnAllOf.md +++ /dev/null @@ -1,14 +0,0 @@ -# DependsOnAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**complement_filter** | **bool** | Inverse filtering mode. | [optional] if omitted the server will use the default value of False -**label** | **str** | Specifies on which label the filter depends on. | [optional] -**values** | **[str, none_type]** | Specifies values of the label for element filtering. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DependsOnDateFilter.md b/gooddata-api-client/docs/DependsOnDateFilter.md index 520efd227..aabfa01bf 100644 --- a/gooddata-api-client/docs/DependsOnDateFilter.md +++ b/gooddata-api-client/docs/DependsOnDateFilter.md @@ -3,11 +3,28 @@ Filter definition type for dates. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **date_filter** | [**DateFilter**](DateFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.depends_on_date_filter import DependsOnDateFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of DependsOnDateFilter from a JSON string +depends_on_date_filter_instance = DependsOnDateFilter.from_json(json) +# print the JSON string representation of the object +print(DependsOnDateFilter.to_json()) + +# convert the object into a dict +depends_on_date_filter_dict = depends_on_date_filter_instance.to_dict() +# create an instance of DependsOnDateFilter from a dict +depends_on_date_filter_from_dict = DependsOnDateFilter.from_dict(depends_on_date_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DependsOnDateFilterAllOf.md b/gooddata-api-client/docs/DependsOnDateFilterAllOf.md deleted file mode 100644 index a6618b99b..000000000 --- a/gooddata-api-client/docs/DependsOnDateFilterAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# DependsOnDateFilterAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**date_filter** | [**DateFilter**](DateFilter.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DependsOnItem.md b/gooddata-api-client/docs/DependsOnItem.md deleted file mode 100644 index fe32ca3ec..000000000 --- a/gooddata-api-client/docs/DependsOnItem.md +++ /dev/null @@ -1,11 +0,0 @@ -# DependsOnItem - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DimAttribute.md b/gooddata-api-client/docs/DimAttribute.md index f080b11da..9b0c21211 100644 --- a/gooddata-api-client/docs/DimAttribute.md +++ b/gooddata-api-client/docs/DimAttribute.md @@ -3,13 +3,30 @@ List of attributes representing the dimensionality of the new visualization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | ID of the object | **title** | **str** | Title of attribute. | -**type** | **str** | Object type | defaults to "attribute" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.dim_attribute import DimAttribute + +# TODO update the JSON string below +json = "{}" +# create an instance of DimAttribute from a JSON string +dim_attribute_instance = DimAttribute.from_json(json) +# print the JSON string representation of the object +print(DimAttribute.to_json()) +# convert the object into a dict +dim_attribute_dict = dim_attribute_instance.to_dict() +# create an instance of DimAttribute from a dict +dim_attribute_from_dict = DimAttribute.from_dict(dim_attribute_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Dimension.md b/gooddata-api-client/docs/Dimension.md index 7dda3d452..f73ae763d 100644 --- a/gooddata-api-client/docs/Dimension.md +++ b/gooddata-api-client/docs/Dimension.md @@ -3,13 +3,30 @@ Single dimension description. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**item_identifiers** | **[str]** | List of items in current dimension. Can reference 'localIdentifier' from 'AttributeItem', or special pseudo attribute \"measureGroup\" representing list of metrics. | +**item_identifiers** | **List[str]** | List of items in current dimension. Can reference 'localIdentifier' from 'AttributeItem', or special pseudo attribute \"measureGroup\" representing list of metrics. | **local_identifier** | **str** | Dimension identification within requests. Other entities can reference this dimension by this value. | [optional] -**sorting** | [**[SortKey]**](SortKey.md) | List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal). | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**sorting** | [**List[SortKey]**](SortKey.md) | List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal). | [optional] + +## Example + +```python +from gooddata_api_client.models.dimension import Dimension + +# TODO update the JSON string below +json = "{}" +# create an instance of Dimension from a JSON string +dimension_instance = Dimension.from_json(json) +# print the JSON string representation of the object +print(Dimension.to_json()) +# convert the object into a dict +dimension_dict = dimension_instance.to_dict() +# create an instance of Dimension from a dict +dimension_from_dict = Dimension.from_dict(dimension_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DimensionHeader.md b/gooddata-api-client/docs/DimensionHeader.md index 03281794e..b00010052 100644 --- a/gooddata-api-client/docs/DimensionHeader.md +++ b/gooddata-api-client/docs/DimensionHeader.md @@ -3,11 +3,28 @@ Contains the dimension-specific header information. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**header_groups** | [**[HeaderGroup]**](HeaderGroup.md) | An array containing header groups. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**header_groups** | [**List[HeaderGroup]**](HeaderGroup.md) | An array containing header groups. | + +## Example + +```python +from gooddata_api_client.models.dimension_header import DimensionHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of DimensionHeader from a JSON string +dimension_header_instance = DimensionHeader.from_json(json) +# print the JSON string representation of the object +print(DimensionHeader.to_json()) +# convert the object into a dict +dimension_header_dict = dimension_header_instance.to_dict() +# create an instance of DimensionHeader from a dict +dimension_header_from_dict = DimensionHeader.from_dict(dimension_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Element.md b/gooddata-api-client/docs/Element.md index f33cd11b8..98f355061 100644 --- a/gooddata-api-client/docs/Element.md +++ b/gooddata-api-client/docs/Element.md @@ -3,12 +3,29 @@ List of returned elements. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **primary_title** | **str** | Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded | **title** | **str** | Title of requested label. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.element import Element + +# TODO update the JSON string below +json = "{}" +# create an instance of Element from a JSON string +element_instance = Element.from_json(json) +# print the JSON string representation of the object +print(Element.to_json()) + +# convert the object into a dict +element_dict = element_instance.to_dict() +# create an instance of Element from a dict +element_from_dict = Element.from_dict(element_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ElementsRequest.md b/gooddata-api-client/docs/ElementsRequest.md index 8d321bf1b..07c338454 100644 --- a/gooddata-api-client/docs/ElementsRequest.md +++ b/gooddata-api-client/docs/ElementsRequest.md @@ -2,21 +2,38 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**label** | **str** | Requested label. | **cache_id** | **str** | If specified, the element data will be taken from the result with the same cacheId if it is available. | [optional] -**complement_filter** | **bool** | Inverse filters: * ```false``` - return items matching ```patternFilter``` and ```exactFilter``` * ```true``` - return items not matching ```patternFilter``` and ```exactFilter``` | [optional] if omitted the server will use the default value of False -**data_sampling_percentage** | **float** | Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation. | [optional] if omitted the server will use the default value of 100.0 -**depends_on** | [**[ElementsRequestDependsOnInner]**](ElementsRequestDependsOnInner.md) | Return only items that are not filtered-out by the parent filters. | [optional] -**exact_filter** | **[str, none_type]** | Return only items, whose ```label``` title exactly matches one of ```filter```. | [optional] -**exclude_primary_label** | **bool** | Excludes items from the result that differ only by primary label * ```false``` - return items with distinct primary label * ```true``` - return items with distinct requested label | [optional] if omitted the server will use the default value of False +**complement_filter** | **bool** | Inverse filters: * ```false``` - return items matching ```patternFilter``` and ```exactFilter``` * ```true``` - return items not matching ```patternFilter``` and ```exactFilter``` | [optional] [default to False] +**data_sampling_percentage** | **float** | Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation. | [optional] [default to 100.0] +**depends_on** | [**List[ElementsRequestDependsOnInner]**](ElementsRequestDependsOnInner.md) | Return only items that are not filtered-out by the parent filters. | [optional] +**exact_filter** | **List[Optional[str]]** | Return only items, whose ```label``` title exactly matches one of ```filter```. | [optional] +**exclude_primary_label** | **bool** | Excludes items from the result that differ only by primary label * ```false``` - return items with distinct primary label * ```true``` - return items with distinct requested label | [optional] [default to False] **filter_by** | [**FilterBy**](FilterBy.md) | | [optional] +**label** | **str** | Requested label. | **pattern_filter** | **str** | Return only items, whose ```label``` title case insensitively contains ```filter``` as substring. | [optional] **sort_order** | **str** | Sort order of returned items. Items are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default | [optional] -**validate_by** | [**[ValidateByItem]**](ValidateByItem.md) | Return only items that are computable on metric. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**validate_by** | [**List[ValidateByItem]**](ValidateByItem.md) | Return only items that are computable on metric. | [optional] + +## Example + +```python +from gooddata_api_client.models.elements_request import ElementsRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ElementsRequest from a JSON string +elements_request_instance = ElementsRequest.from_json(json) +# print the JSON string representation of the object +print(ElementsRequest.to_json()) +# convert the object into a dict +elements_request_dict = elements_request_instance.to_dict() +# create an instance of ElementsRequest from a dict +elements_request_from_dict = ElementsRequest.from_dict(elements_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ElementsRequestDependsOnInner.md b/gooddata-api-client/docs/ElementsRequestDependsOnInner.md index 5345649c1..6347d232e 100644 --- a/gooddata-api-client/docs/ElementsRequestDependsOnInner.md +++ b/gooddata-api-client/docs/ElementsRequestDependsOnInner.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**complement_filter** | **bool** | Inverse filtering mode. | [optional] if omitted the server will use the default value of False -**label** | **str** | Specifies on which label the filter depends on. | [optional] -**values** | **[str, none_type]** | Specifies values of the label for element filtering. | [optional] -**date_filter** | [**DateFilter**](DateFilter.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**complement_filter** | **bool** | Inverse filtering mode. | [optional] [default to False] +**label** | **str** | Specifies on which label the filter depends on. | +**values** | **List[Optional[str]]** | Specifies values of the label for element filtering. | +**date_filter** | [**DateFilter**](DateFilter.md) | | + +## Example + +```python +from gooddata_api_client.models.elements_request_depends_on_inner import ElementsRequestDependsOnInner + +# TODO update the JSON string below +json = "{}" +# create an instance of ElementsRequestDependsOnInner from a JSON string +elements_request_depends_on_inner_instance = ElementsRequestDependsOnInner.from_json(json) +# print the JSON string representation of the object +print(ElementsRequestDependsOnInner.to_json()) +# convert the object into a dict +elements_request_depends_on_inner_dict = elements_request_depends_on_inner_instance.to_dict() +# create an instance of ElementsRequestDependsOnInner from a dict +elements_request_depends_on_inner_from_dict = ElementsRequestDependsOnInner.from_dict(elements_request_depends_on_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ElementsResponse.md b/gooddata-api-client/docs/ElementsResponse.md index aafc8bcdf..65bcb57e8 100644 --- a/gooddata-api-client/docs/ElementsResponse.md +++ b/gooddata-api-client/docs/ElementsResponse.md @@ -3,16 +3,33 @@ Entity holding list of sorted & filtered label elements, related primary label of attribute owning requested label and paging. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**elements** | [**[Element]**](Element.md) | List of returned elements. | -**paging** | [**Paging**](Paging.md) | | -**primary_label** | [**RestApiIdentifier**](RestApiIdentifier.md) | | **cache_id** | **str** | The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself. | [optional] +**elements** | [**List[Element]**](Element.md) | List of returned elements. | **format** | [**AttributeFormat**](AttributeFormat.md) | | [optional] **granularity** | **str** | Granularity of requested label in case of date attribute | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**paging** | [**Paging**](Paging.md) | | +**primary_label** | [**RestApiIdentifier**](RestApiIdentifier.md) | | + +## Example + +```python +from gooddata_api_client.models.elements_response import ElementsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ElementsResponse from a JSON string +elements_response_instance = ElementsResponse.from_json(json) +# print the JSON string representation of the object +print(ElementsResponse.to_json()) +# convert the object into a dict +elements_response_dict = elements_response_instance.to_dict() +# create an instance of ElementsResponse from a dict +elements_response_from_dict = ElementsResponse.from_dict(elements_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/EntitiesApi.md b/gooddata-api-client/docs/EntitiesApi.md index a46f233ee..55b5f5b31 100644 --- a/gooddata-api-client/docs/EntitiesApi.md +++ b/gooddata-api-client/docs/EntitiesApi.md @@ -206,7 +206,7 @@ Method | HTTP request | Description # **create_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document) +> JsonApiAnalyticalDashboardOutDocument create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, include=include, meta_include=meta_include) Post Dashboards @@ -214,12 +214,12 @@ Post Dashboards ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -228,59 +228,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_analytical_dashboard_post_optional_id_document = JsonApiAnalyticalDashboardPostOptionalIdDocument( - data=JsonApiAnalyticalDashboardPostOptionalId( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=permissions,origin,accessInfo,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Dashboards - api_response = api_instance.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_analytical_dashboard_post_optional_id_document = gooddata_api_client.JsonApiAnalyticalDashboardPostOptionalIdDocument() # JsonApiAnalyticalDashboardPostOptionalIdDocument | + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=permissions,origin,accessInfo,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Dashboards api_response = api_instance.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_analytical_dashboard_post_optional_id_document** | [**JsonApiAnalyticalDashboardPostOptionalIdDocument**](JsonApiAnalyticalDashboardPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_analytical_dashboard_post_optional_id_document** | [**JsonApiAnalyticalDashboardPostOptionalIdDocument**](JsonApiAnalyticalDashboardPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -295,7 +270,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -313,12 +287,12 @@ Post a new API token for the user ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -327,33 +301,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - user_id = "userId_example" # str | - json_api_api_token_in_document = JsonApiApiTokenInDocument( - data=JsonApiApiTokenIn( - id="id1", - type="apiToken", - ), - ) # JsonApiApiTokenInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitiesApi(api_client) + user_id = 'user_id_example' # str | + json_api_api_token_in_document = gooddata_api_client.JsonApiApiTokenInDocument() # JsonApiApiTokenInDocument | + try: # Post a new API token for the user api_response = api_instance.create_entity_api_tokens(user_id, json_api_api_token_in_document) + print("The response of EntitiesApi->create_entity_api_tokens:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **json_api_api_token_in_document** | [**JsonApiApiTokenInDocument**](JsonApiApiTokenInDocument.md)| | + **user_id** | **str**| | + **json_api_api_token_in_document** | [**JsonApiApiTokenInDocument**](JsonApiApiTokenInDocument.md)| | ### Return type @@ -368,7 +339,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -378,7 +348,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document) +> JsonApiAttributeHierarchyOutDocument create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, include=include, meta_include=meta_include) Post Attribute Hierarchies @@ -386,12 +356,12 @@ Post Attribute Hierarchies ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -400,59 +370,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_attribute_hierarchy_in_document = JsonApiAttributeHierarchyInDocument( - data=JsonApiAttributeHierarchyIn( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyInDocument | - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Attribute Hierarchies - api_response = api_instance.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_attribute_hierarchy_in_document = gooddata_api_client.JsonApiAttributeHierarchyInDocument() # JsonApiAttributeHierarchyInDocument | + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Attribute Hierarchies api_response = api_instance.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -467,7 +412,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -477,7 +421,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_automations** -> JsonApiAutomationOutDocument create_entity_automations(workspace_id, json_api_automation_in_document) +> JsonApiAutomationOutDocument create_entity_automations(workspace_id, json_api_automation_in_document, include=include, meta_include=meta_include) Post Automations @@ -485,12 +429,12 @@ Post Automations ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -499,301 +443,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_automation_in_document = JsonApiAutomationInDocument( - data=JsonApiAutomationIn( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationInDocument | - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Automations - api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_automation_in_document = gooddata_api_client.JsonApiAutomationInDocument() # JsonApiAutomationInDocument | + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Automations api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -808,7 +485,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -826,12 +502,12 @@ Post Color Pallettes ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -840,35 +516,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_color_palette_in_document = JsonApiColorPaletteInDocument( - data=JsonApiColorPaletteIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="colorPalette", - ), - ) # JsonApiColorPaletteInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_color_palette_in_document = gooddata_api_client.JsonApiColorPaletteInDocument() # JsonApiColorPaletteInDocument | + try: # Post Color Pallettes api_response = api_instance.create_entity_color_palettes(json_api_color_palette_in_document) + print("The response of EntitiesApi->create_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | + **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | ### Return type @@ -883,7 +552,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -903,12 +571,12 @@ Post CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -917,36 +585,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_csp_directive_in_document = JsonApiCspDirectiveInDocument( - data=JsonApiCspDirectiveIn( - attributes=JsonApiCspDirectiveInAttributes( - sources=[ - "sources_example", - ], - ), - id="id1", - type="cspDirective", - ), - ) # JsonApiCspDirectiveInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_csp_directive_in_document = gooddata_api_client.JsonApiCspDirectiveInDocument() # JsonApiCspDirectiveInDocument | + try: # Post CSP Directives api_response = api_instance.create_entity_csp_directives(json_api_csp_directive_in_document) + print("The response of EntitiesApi->create_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | + **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | ### Return type @@ -961,7 +621,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -971,7 +630,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document) +> JsonApiCustomApplicationSettingOutDocument create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, meta_include=meta_include) Post Custom Application Settings @@ -979,12 +638,12 @@ Post Custom Application Settings ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -993,50 +652,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_custom_application_setting_post_optional_id_document = JsonApiCustomApplicationSettingPostOptionalIdDocument( - data=JsonApiCustomApplicationSettingPostOptionalId( - attributes=JsonApiCustomApplicationSettingInAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingPostOptionalIdDocument | - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Custom Application Settings - api_response = api_instance.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_custom_application_setting_post_optional_id_document = gooddata_api_client.JsonApiCustomApplicationSettingPostOptionalIdDocument() # JsonApiCustomApplicationSettingPostOptionalIdDocument | + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Custom Application Settings api_response = api_instance.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_custom_application_setting_post_optional_id_document** | [**JsonApiCustomApplicationSettingPostOptionalIdDocument**](JsonApiCustomApplicationSettingPostOptionalIdDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_custom_application_setting_post_optional_id_document** | [**JsonApiCustomApplicationSettingPostOptionalIdDocument**](JsonApiCustomApplicationSettingPostOptionalIdDocument.md)| | + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1051,7 +692,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1061,7 +701,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document) +> JsonApiDashboardPluginOutDocument create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, include=include, meta_include=meta_include) Post Plugins @@ -1069,12 +709,12 @@ Post Plugins ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1083,59 +723,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_dashboard_plugin_post_optional_id_document = JsonApiDashboardPluginPostOptionalIdDocument( - data=JsonApiDashboardPluginPostOptionalId( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Plugins - api_response = api_instance.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_dashboard_plugin_post_optional_id_document = gooddata_api_client.JsonApiDashboardPluginPostOptionalIdDocument() # JsonApiDashboardPluginPostOptionalIdDocument | + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Plugins api_response = api_instance.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_dashboard_plugin_post_optional_id_document** | [**JsonApiDashboardPluginPostOptionalIdDocument**](JsonApiDashboardPluginPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_dashboard_plugin_post_optional_id_document** | [**JsonApiDashboardPluginPostOptionalIdDocument**](JsonApiDashboardPluginPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1150,7 +765,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1160,7 +774,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_data_sources** -> JsonApiDataSourceOutDocument create_entity_data_sources(json_api_data_source_in_document) +> JsonApiDataSourceOutDocument create_entity_data_sources(json_api_data_source_in_document, meta_include=meta_include) Post Data Sources @@ -1170,12 +784,12 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1184,64 +798,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_data_source_in_document = JsonApiDataSourceInDocument( - data=JsonApiDataSourceIn( - attributes=JsonApiDataSourceInAttributes( - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourceInDocument | - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Data Sources - api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_data_source_in_document = gooddata_api_client.JsonApiDataSourceInDocument() # JsonApiDataSourceInDocument | + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Data Sources api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] + **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1256,7 +836,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1266,7 +845,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_export_definitions** -> JsonApiExportDefinitionOutDocument create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document) +> JsonApiExportDefinitionOutDocument create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, include=include, meta_include=meta_include) Post Export Definitions @@ -1274,12 +853,12 @@ Post Export Definitions ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1288,67 +867,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_export_definition_post_optional_id_document = JsonApiExportDefinitionPostOptionalIdDocument( - data=JsonApiExportDefinitionPostOptionalId( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionPostOptionalIdDocument | - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Export Definitions - api_response = api_instance.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_export_definition_post_optional_id_document = gooddata_api_client.JsonApiExportDefinitionPostOptionalIdDocument() # JsonApiExportDefinitionPostOptionalIdDocument | + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Export Definitions api_response = api_instance.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_export_definition_post_optional_id_document** | [**JsonApiExportDefinitionPostOptionalIdDocument**](JsonApiExportDefinitionPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_export_definition_post_optional_id_document** | [**JsonApiExportDefinitionPostOptionalIdDocument**](JsonApiExportDefinitionPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1363,7 +909,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1381,12 +926,12 @@ Post Export Template entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1395,101 +940,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_export_template_post_optional_id_document = JsonApiExportTemplatePostOptionalIdDocument( - data=JsonApiExportTemplatePostOptionalId( - attributes=JsonApiExportTemplateInAttributes( - dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - name="name_example", - widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - id="id1", - type="exportTemplate", - ), - ) # JsonApiExportTemplatePostOptionalIdDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_export_template_post_optional_id_document = gooddata_api_client.JsonApiExportTemplatePostOptionalIdDocument() # JsonApiExportTemplatePostOptionalIdDocument | + try: # Post Export Template entities api_response = api_instance.create_entity_export_templates(json_api_export_template_post_optional_id_document) + print("The response of EntitiesApi->create_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_export_template_post_optional_id_document** | [**JsonApiExportTemplatePostOptionalIdDocument**](JsonApiExportTemplatePostOptionalIdDocument.md)| | + **json_api_export_template_post_optional_id_document** | [**JsonApiExportTemplatePostOptionalIdDocument**](JsonApiExportTemplatePostOptionalIdDocument.md)| | ### Return type @@ -1504,7 +976,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1514,7 +985,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_filter_contexts** -> JsonApiFilterContextOutDocument create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document) +> JsonApiFilterContextOutDocument create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, include=include, meta_include=meta_include) Post Context Filters @@ -1522,12 +993,12 @@ Post Context Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1536,59 +1007,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_filter_context_post_optional_id_document = JsonApiFilterContextPostOptionalIdDocument( - data=JsonApiFilterContextPostOptionalId( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextPostOptionalIdDocument | - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Context Filters - api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_filter_context_post_optional_id_document = gooddata_api_client.JsonApiFilterContextPostOptionalIdDocument() # JsonApiFilterContextPostOptionalIdDocument | + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Context Filters api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_filter_context_post_optional_id_document** | [**JsonApiFilterContextPostOptionalIdDocument**](JsonApiFilterContextPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_filter_context_post_optional_id_document** | [**JsonApiFilterContextPostOptionalIdDocument**](JsonApiFilterContextPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1603,7 +1049,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1613,7 +1058,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_filter_views** -> JsonApiFilterViewOutDocument create_entity_filter_views(workspace_id, json_api_filter_view_in_document) +> JsonApiFilterViewOutDocument create_entity_filter_views(workspace_id, json_api_filter_view_in_document, include=include) Post Filter views @@ -1621,12 +1066,12 @@ Post Filter views ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1635,64 +1080,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_filter_view_in_document = JsonApiFilterViewInDocument( - data=JsonApiFilterViewIn( - attributes=JsonApiFilterViewInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewInDocument | - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Filter views - api_response = api_instance.create_entity_filter_views(workspace_id, json_api_filter_view_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_filter_view_in_document = gooddata_api_client.JsonApiFilterViewInDocument() # JsonApiFilterViewInDocument | + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Filter views api_response = api_instance.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, include=include) + print("The response of EntitiesApi->create_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -1707,7 +1120,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1725,12 +1137,12 @@ Post Identity Providers ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1739,50 +1151,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_identity_provider_in_document = JsonApiIdentityProviderInDocument( - data=JsonApiIdentityProviderIn( - attributes=JsonApiIdentityProviderInAttributes( - custom_claim_mapping={ - "key": "key_example", - }, - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - id="id1", - type="identityProvider", - ), - ) # JsonApiIdentityProviderInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_identity_provider_in_document = gooddata_api_client.JsonApiIdentityProviderInDocument() # JsonApiIdentityProviderInDocument | + try: # Post Identity Providers api_response = api_instance.create_entity_identity_providers(json_api_identity_provider_in_document) + print("The response of EntitiesApi->create_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | + **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | ### Return type @@ -1797,7 +1187,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1817,12 +1206,12 @@ Creates JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1831,34 +1220,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_jwk_in_document = JsonApiJwkInDocument( - data=JsonApiJwkIn( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), - ), - id="id1", - type="jwk", - ), - ) # JsonApiJwkInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_jwk_in_document = gooddata_api_client.JsonApiJwkInDocument() # JsonApiJwkInDocument | + try: # Post Jwks api_response = api_instance.create_entity_jwks(json_api_jwk_in_document) + print("The response of EntitiesApi->create_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | + **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | ### Return type @@ -1873,7 +1256,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1891,12 +1273,12 @@ Post LLM endpoint entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1905,39 +1287,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_llm_endpoint_in_document = JsonApiLlmEndpointInDocument( - data=JsonApiLlmEndpointIn( - attributes=JsonApiLlmEndpointInAttributes( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="OPENAI", - title="title_example", - token="token_example", - ), - id="id1", - type="llmEndpoint", - ), - ) # JsonApiLlmEndpointInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_llm_endpoint_in_document = gooddata_api_client.JsonApiLlmEndpointInDocument() # JsonApiLlmEndpointInDocument | + try: # Post LLM endpoint entities api_response = api_instance.create_entity_llm_endpoints(json_api_llm_endpoint_in_document) + print("The response of EntitiesApi->create_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | + **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | ### Return type @@ -1952,7 +1323,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1962,7 +1332,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_metrics** -> JsonApiMetricOutDocument create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document) +> JsonApiMetricOutDocument create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, include=include, meta_include=meta_include) Post Metrics @@ -1970,12 +1340,12 @@ Post Metrics ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1984,63 +1354,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_metric_post_optional_id_document = JsonApiMetricPostOptionalIdDocument( - data=JsonApiMetricPostOptionalId( - attributes=JsonApiMetricInAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - ), - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="metric", - ), - ) # JsonApiMetricPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Metrics - api_response = api_instance.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_metric_post_optional_id_document = gooddata_api_client.JsonApiMetricPostOptionalIdDocument() # JsonApiMetricPostOptionalIdDocument | + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Metrics api_response = api_instance.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_metric_post_optional_id_document** | [**JsonApiMetricPostOptionalIdDocument**](JsonApiMetricPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_metric_post_optional_id_document** | [**JsonApiMetricPostOptionalIdDocument**](JsonApiMetricPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2055,7 +1396,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2073,12 +1413,12 @@ Post Notification Channel entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument -from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2087,41 +1427,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_notification_channel_post_optional_id_document = JsonApiNotificationChannelPostOptionalIdDocument( - data=JsonApiNotificationChannelPostOptionalId( - attributes=JsonApiNotificationChannelInAttributes( - allowed_recipients="CREATOR", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="HIDDEN", - description="description_example", - destination=JsonApiNotificationChannelInAttributesDestination(None), - in_platform_notification="DISABLED", - name="name_example", - notification_source="notification_source_example", - ), - id="id1", - type="notificationChannel", - ), - ) # JsonApiNotificationChannelPostOptionalIdDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_notification_channel_post_optional_id_document = gooddata_api_client.JsonApiNotificationChannelPostOptionalIdDocument() # JsonApiNotificationChannelPostOptionalIdDocument | + try: # Post Notification Channel entities api_response = api_instance.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document) + print("The response of EntitiesApi->create_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_notification_channel_post_optional_id_document** | [**JsonApiNotificationChannelPostOptionalIdDocument**](JsonApiNotificationChannelPostOptionalIdDocument.md)| | + **json_api_notification_channel_post_optional_id_document** | [**JsonApiNotificationChannelPostOptionalIdDocument**](JsonApiNotificationChannelPostOptionalIdDocument.md)| | ### Return type @@ -2136,7 +1463,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2154,12 +1480,12 @@ Post Organization Setting entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2168,35 +1494,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_organization_setting_in_document = JsonApiOrganizationSettingInDocument( - data=JsonApiOrganizationSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="organizationSetting", - ), - ) # JsonApiOrganizationSettingInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_organization_setting_in_document = gooddata_api_client.JsonApiOrganizationSettingInDocument() # JsonApiOrganizationSettingInDocument | + try: # Post Organization Setting entities api_response = api_instance.create_entity_organization_settings(json_api_organization_setting_in_document) + print("The response of EntitiesApi->create_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | + **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | ### Return type @@ -2211,7 +1530,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2229,12 +1547,12 @@ Post Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2243,35 +1561,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_theme_in_document = JsonApiThemeInDocument( - data=JsonApiThemeIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="theme", - ), - ) # JsonApiThemeInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_theme_in_document = gooddata_api_client.JsonApiThemeInDocument() # JsonApiThemeInDocument | + try: # Post Theming api_response = api_instance.create_entity_themes(json_api_theme_in_document) + print("The response of EntitiesApi->create_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | + **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | ### Return type @@ -2286,7 +1597,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2296,7 +1606,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) +> JsonApiUserDataFilterOutDocument create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, include=include, meta_include=meta_include) Post User Data Filters @@ -2304,12 +1614,12 @@ Post User Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2318,67 +1628,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_user_data_filter_post_optional_id_document = JsonApiUserDataFilterPostOptionalIdDocument( - data=JsonApiUserDataFilterPostOptionalId( - attributes=JsonApiUserDataFilterInAttributes( - are_relations_valid=True, - description="description_example", - maql="maql_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", - ), - ) # JsonApiUserDataFilterPostOptionalIdDocument | - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post User Data Filters - api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_user_data_filter_post_optional_id_document = gooddata_api_client.JsonApiUserDataFilterPostOptionalIdDocument() # JsonApiUserDataFilterPostOptionalIdDocument | + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post User Data Filters api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_user_data_filter_post_optional_id_document** | [**JsonApiUserDataFilterPostOptionalIdDocument**](JsonApiUserDataFilterPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_user_data_filter_post_optional_id_document** | [**JsonApiUserDataFilterPostOptionalIdDocument**](JsonApiUserDataFilterPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2393,7 +1670,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2403,7 +1679,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_user_groups** -> JsonApiUserGroupOutDocument create_entity_user_groups(json_api_user_group_in_document) +> JsonApiUserGroupOutDocument create_entity_user_groups(json_api_user_group_in_document, include=include) Post User Group entities @@ -2413,12 +1689,12 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2427,57 +1703,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_user_group_in_document = JsonApiUserGroupInDocument( - data=JsonApiUserGroupIn( - attributes=JsonApiUserGroupInAttributes( - name="name_example", - ), - id="id1", - relationships=JsonApiUserGroupInRelationships( - parents=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="userGroup", - ), - ) # JsonApiUserGroupInDocument | - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Post User Group entities - api_response = api_instance.create_entity_user_groups(json_api_user_group_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_user_group_in_document = gooddata_api_client.JsonApiUserGroupInDocument() # JsonApiUserGroupInDocument | + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post User Group entities api_response = api_instance.create_entity_user_groups(json_api_user_group_in_document, include=include) + print("The response of EntitiesApi->create_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -2492,7 +1741,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2510,12 +1758,12 @@ Post new user settings for the user ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2524,37 +1772,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - user_id = "userId_example" # str | - json_api_user_setting_in_document = JsonApiUserSettingInDocument( - data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="userSetting", - ), - ) # JsonApiUserSettingInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitiesApi(api_client) + user_id = 'user_id_example' # str | + json_api_user_setting_in_document = gooddata_api_client.JsonApiUserSettingInDocument() # JsonApiUserSettingInDocument | + try: # Post new user settings for the user api_response = api_instance.create_entity_user_settings(user_id, json_api_user_setting_in_document) + print("The response of EntitiesApi->create_entity_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | + **user_id** | **str**| | + **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | ### Return type @@ -2569,7 +1810,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2579,7 +1819,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_users** -> JsonApiUserOutDocument create_entity_users(json_api_user_in_document) +> JsonApiUserOutDocument create_entity_users(json_api_user_in_document, include=include) Post User entities @@ -2589,12 +1829,12 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2603,60 +1843,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_user_in_document = JsonApiUserInDocument( - data=JsonApiUserIn( - attributes=JsonApiUserInAttributes( - authentication_id="authentication_id_example", - email="email_example", - firstname="firstname_example", - lastname="lastname_example", - ), - id="id1", - relationships=JsonApiUserInRelationships( - user_groups=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="user", - ), - ) # JsonApiUserInDocument | - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Post User entities - api_response = api_instance.create_entity_users(json_api_user_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_users: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_user_in_document = gooddata_api_client.JsonApiUserInDocument() # JsonApiUserInDocument | + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post User entities api_response = api_instance.create_entity_users(json_api_user_in_document, include=include) + print("The response of EntitiesApi->create_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -2671,7 +1881,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2681,7 +1890,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) +> JsonApiVisualizationObjectOutDocument create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, include=include, meta_include=meta_include) Post Visualization Objects @@ -2689,12 +1898,12 @@ Post Visualization Objects ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2703,60 +1912,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_visualization_object_post_optional_id_document = JsonApiVisualizationObjectPostOptionalIdDocument( - data=JsonApiVisualizationObjectPostOptionalId( - attributes=JsonApiVisualizationObjectInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", - ), - ) # JsonApiVisualizationObjectPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Visualization Objects - api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_visualization_object_post_optional_id_document = gooddata_api_client.JsonApiVisualizationObjectPostOptionalIdDocument() # JsonApiVisualizationObjectPostOptionalIdDocument | + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Visualization Objects api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_visualization_object_post_optional_id_document** | [**JsonApiVisualizationObjectPostOptionalIdDocument**](JsonApiVisualizationObjectPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_visualization_object_post_optional_id_document** | [**JsonApiVisualizationObjectPostOptionalIdDocument**](JsonApiVisualizationObjectPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2771,7 +1954,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2781,7 +1963,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) +> JsonApiWorkspaceDataFilterSettingOutDocument create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, include=include, meta_include=meta_include) Post Settings for Workspace Data Filters @@ -2789,12 +1971,12 @@ Post Settings for Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2803,62 +1985,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( - data=JsonApiWorkspaceDataFilterSettingIn( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", - ), - ) # JsonApiWorkspaceDataFilterSettingInDocument | - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Settings for Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_workspace_data_filter_setting_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterSettingInDocument() # JsonApiWorkspaceDataFilterSettingInDocument | + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Settings for Workspace Data Filters api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2873,7 +2027,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2883,7 +2036,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) +> JsonApiWorkspaceDataFilterOutDocument create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, include=include, meta_include=meta_include) Post Workspace Data Filters @@ -2891,12 +2044,12 @@ Post Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2905,65 +2058,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( - data=JsonApiWorkspaceDataFilterIn( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), - ), - ), - type="workspaceDataFilter", - ), - ) # JsonApiWorkspaceDataFilterInDocument | - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_workspace_data_filter_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterInDocument() # JsonApiWorkspaceDataFilterInDocument | + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Workspace Data Filters api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2978,7 +2100,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2988,7 +2109,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) +> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, meta_include=meta_include) Post Settings for Workspaces @@ -2996,12 +2117,12 @@ Post Settings for Workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3010,50 +2131,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_setting_post_optional_id_document = JsonApiWorkspaceSettingPostOptionalIdDocument( - data=JsonApiWorkspaceSettingPostOptionalId( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="workspaceSetting", - ), - ) # JsonApiWorkspaceSettingPostOptionalIdDocument | - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Settings for Workspaces - api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_workspace_setting_post_optional_id_document = gooddata_api_client.JsonApiWorkspaceSettingPostOptionalIdDocument() # JsonApiWorkspaceSettingPostOptionalIdDocument | + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Settings for Workspaces api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_setting_post_optional_id_document** | [**JsonApiWorkspaceSettingPostOptionalIdDocument**](JsonApiWorkspaceSettingPostOptionalIdDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_workspace_setting_post_optional_id_document** | [**JsonApiWorkspaceSettingPostOptionalIdDocument**](JsonApiWorkspaceSettingPostOptionalIdDocument.md)| | + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3068,7 +2171,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3078,7 +2180,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_workspaces** -> JsonApiWorkspaceOutDocument create_entity_workspaces(json_api_workspace_in_document) +> JsonApiWorkspaceOutDocument create_entity_workspaces(json_api_workspace_in_document, include=include, meta_include=meta_include) Post Workspace entities @@ -3088,12 +2190,12 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3102,69 +2204,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - json_api_workspace_in_document = JsonApiWorkspaceInDocument( - data=JsonApiWorkspaceIn( - attributes=JsonApiWorkspaceInAttributes( - cache_extra_limit=1, - data_source=JsonApiWorkspaceInAttributesDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - name="name_example", - prefix="/6bUUGjjNSwg0_bs", - ), - id="id1", - relationships=JsonApiWorkspaceInRelationships( - parent=JsonApiWorkspaceAutomationOutRelationshipsWorkspace( - data=JsonApiWorkspaceToOneLinkage(None), - ), - ), - type="workspace", - ), - ) # JsonApiWorkspaceInDocument | - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Workspace entities - api_response = api_instance.create_entity_workspaces(json_api_workspace_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + json_api_workspace_in_document = gooddata_api_client.JsonApiWorkspaceInDocument() # JsonApiWorkspaceInDocument | + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=config,permissions,hierarchy,dataModelDatasets,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Workspace entities api_response = api_instance.create_entity_workspaces(json_api_workspace_in_document, include=include, meta_include=meta_include) + print("The response of EntitiesApi->create_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->create_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3179,7 +2244,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3189,7 +2253,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_analytical_dashboards** -> delete_entity_analytical_dashboards(workspace_id, object_id) +> delete_entity_analytical_dashboards(workspace_id, object_id, filter=filter) Delete a Dashboard @@ -3197,10 +2261,10 @@ Delete a Dashboard ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3209,37 +2273,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Dashboard - api_instance.delete_entity_analytical_dashboards(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_analytical_dashboards: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Dashboard api_instance.delete_entity_analytical_dashboards(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3254,7 +2311,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3264,7 +2320,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_api_tokens** -> delete_entity_api_tokens(user_id, id) +> delete_entity_api_tokens(user_id, id, filter=filter) Delete an API Token for a user @@ -3272,10 +2328,10 @@ Delete an API Token for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3284,37 +2340,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'bearerToken==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete an API Token for a user - api_instance.delete_entity_api_tokens(user_id, id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_api_tokens: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete an API Token for a user api_instance.delete_entity_api_tokens(user_id, id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3329,7 +2378,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3339,7 +2387,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_attribute_hierarchies** -> delete_entity_attribute_hierarchies(workspace_id, object_id) +> delete_entity_attribute_hierarchies(workspace_id, object_id, filter=filter) Delete an Attribute Hierarchy @@ -3347,10 +2395,10 @@ Delete an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3359,37 +2407,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete an Attribute Hierarchy - api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_attribute_hierarchies: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete an Attribute Hierarchy api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3404,7 +2445,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3414,7 +2454,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_automations** -> delete_entity_automations(workspace_id, object_id) +> delete_entity_automations(workspace_id, object_id, filter=filter) Delete an Automation @@ -3422,10 +2462,10 @@ Delete an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3434,37 +2474,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete an Automation - api_instance.delete_entity_automations(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_automations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete an Automation api_instance.delete_entity_automations(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3479,7 +2512,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3489,7 +2521,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_color_palettes** -> delete_entity_color_palettes(id) +> delete_entity_color_palettes(id, filter=filter) Delete a Color Pallette @@ -3497,10 +2529,10 @@ Delete a Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3509,35 +2541,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Color Pallette - api_instance.delete_entity_color_palettes(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_color_palettes: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Color Pallette api_instance.delete_entity_color_palettes(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3552,7 +2577,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3562,7 +2586,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_csp_directives** -> delete_entity_csp_directives(id) +> delete_entity_csp_directives(id, filter=filter) Delete CSP Directives @@ -3572,10 +2596,10 @@ Delete CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3584,35 +2608,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete CSP Directives - api_instance.delete_entity_csp_directives(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_csp_directives: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete CSP Directives api_instance.delete_entity_csp_directives(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3627,7 +2644,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3637,7 +2653,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_custom_application_settings** -> delete_entity_custom_application_settings(workspace_id, object_id) +> delete_entity_custom_application_settings(workspace_id, object_id, filter=filter) Delete a Custom Application Setting @@ -3645,10 +2661,10 @@ Delete a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3657,37 +2673,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Custom Application Setting - api_instance.delete_entity_custom_application_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_custom_application_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Custom Application Setting api_instance.delete_entity_custom_application_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3702,7 +2711,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3712,7 +2720,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_dashboard_plugins** -> delete_entity_dashboard_plugins(workspace_id, object_id) +> delete_entity_dashboard_plugins(workspace_id, object_id, filter=filter) Delete a Plugin @@ -3720,10 +2728,10 @@ Delete a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3732,37 +2740,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Plugin - api_instance.delete_entity_dashboard_plugins(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_dashboard_plugins: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Plugin api_instance.delete_entity_dashboard_plugins(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3777,7 +2778,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3787,7 +2787,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_data_sources** -> delete_entity_data_sources(id) +> delete_entity_data_sources(id, filter=filter) Delete Data Source entity @@ -3797,10 +2797,10 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3809,35 +2809,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Data Source entity - api_instance.delete_entity_data_sources(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_data_sources: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Data Source entity api_instance.delete_entity_data_sources(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3852,7 +2845,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3862,7 +2854,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_export_definitions** -> delete_entity_export_definitions(workspace_id, object_id) +> delete_entity_export_definitions(workspace_id, object_id, filter=filter) Delete an Export Definition @@ -3870,10 +2862,10 @@ Delete an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3882,37 +2874,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete an Export Definition - api_instance.delete_entity_export_definitions(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_export_definitions: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete an Export Definition api_instance.delete_entity_export_definitions(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3927,7 +2912,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3937,7 +2921,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_export_templates** -> delete_entity_export_templates(id) +> delete_entity_export_templates(id, filter=filter) Delete Export Template entity @@ -3945,10 +2929,10 @@ Delete Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3957,35 +2941,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Export Template entity - api_instance.delete_entity_export_templates(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_export_templates: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Export Template entity api_instance.delete_entity_export_templates(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4000,7 +2977,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4010,7 +2986,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_filter_contexts** -> delete_entity_filter_contexts(workspace_id, object_id) +> delete_entity_filter_contexts(workspace_id, object_id, filter=filter) Delete a Context Filter @@ -4018,10 +2994,10 @@ Delete a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4030,37 +3006,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Context Filter - api_instance.delete_entity_filter_contexts(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_filter_contexts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Context Filter api_instance.delete_entity_filter_contexts(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4075,7 +3044,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4085,7 +3053,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_filter_views** -> delete_entity_filter_views(workspace_id, object_id) +> delete_entity_filter_views(workspace_id, object_id, filter=filter) Delete Filter view @@ -4093,10 +3061,10 @@ Delete Filter view ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4105,37 +3073,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Filter view - api_instance.delete_entity_filter_views(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_filter_views: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Filter view api_instance.delete_entity_filter_views(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4150,7 +3111,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4160,7 +3120,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_identity_providers** -> delete_entity_identity_providers(id) +> delete_entity_identity_providers(id, filter=filter) Delete Identity Provider @@ -4168,10 +3128,10 @@ Delete Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4180,35 +3140,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Identity Provider - api_instance.delete_entity_identity_providers(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_identity_providers: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Identity Provider api_instance.delete_entity_identity_providers(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4223,7 +3176,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4233,7 +3185,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_jwks** -> delete_entity_jwks(id) +> delete_entity_jwks(id, filter=filter) Delete Jwk @@ -4243,10 +3195,10 @@ Deletes JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4255,35 +3207,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Jwk - api_instance.delete_entity_jwks(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_jwks: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Jwk api_instance.delete_entity_jwks(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4298,7 +3243,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4308,7 +3252,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_llm_endpoints** -> delete_entity_llm_endpoints(id) +> delete_entity_llm_endpoints(id, filter=filter) @@ -4316,10 +3260,10 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4328,33 +3272,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - api_instance.delete_entity_llm_endpoints(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_llm_endpoints: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: api_instance.delete_entity_llm_endpoints(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4369,7 +3307,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4379,7 +3316,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_metrics** -> delete_entity_metrics(workspace_id, object_id) +> delete_entity_metrics(workspace_id, object_id, filter=filter) Delete a Metric @@ -4387,10 +3324,10 @@ Delete a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4399,37 +3336,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Metric - api_instance.delete_entity_metrics(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Metric api_instance.delete_entity_metrics(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4444,7 +3374,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4454,7 +3383,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_notification_channels** -> delete_entity_notification_channels(id) +> delete_entity_notification_channels(id, filter=filter) Delete Notification Channel entity @@ -4462,10 +3391,10 @@ Delete Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4474,35 +3403,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Notification Channel entity - api_instance.delete_entity_notification_channels(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_notification_channels: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Notification Channel entity api_instance.delete_entity_notification_channels(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4517,7 +3439,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4527,7 +3448,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_organization_settings** -> delete_entity_organization_settings(id) +> delete_entity_organization_settings(id, filter=filter) Delete Organization entity @@ -4535,10 +3456,10 @@ Delete Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4547,35 +3468,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Organization entity - api_instance.delete_entity_organization_settings(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_organization_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Organization entity api_instance.delete_entity_organization_settings(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4590,7 +3504,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4600,7 +3513,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_themes** -> delete_entity_themes(id) +> delete_entity_themes(id, filter=filter) Delete Theming @@ -4608,10 +3521,10 @@ Delete Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4620,35 +3533,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Theming - api_instance.delete_entity_themes(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_themes: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Theming api_instance.delete_entity_themes(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4663,7 +3569,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4673,7 +3578,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_user_data_filters** -> delete_entity_user_data_filters(workspace_id, object_id) +> delete_entity_user_data_filters(workspace_id, object_id, filter=filter) Delete a User Data Filter @@ -4681,10 +3586,10 @@ Delete a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4693,37 +3598,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a User Data Filter - api_instance.delete_entity_user_data_filters(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a User Data Filter api_instance.delete_entity_user_data_filters(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4738,7 +3636,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4748,7 +3645,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_user_groups** -> delete_entity_user_groups(id) +> delete_entity_user_groups(id, filter=filter) Delete UserGroup entity @@ -4758,10 +3655,10 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4770,35 +3667,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete UserGroup entity - api_instance.delete_entity_user_groups(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete UserGroup entity api_instance.delete_entity_user_groups(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4813,7 +3703,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4823,7 +3712,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_user_settings** -> delete_entity_user_settings(user_id, id) +> delete_entity_user_settings(user_id, id, filter=filter) Delete a setting for a user @@ -4831,10 +3720,10 @@ Delete a setting for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4843,37 +3732,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a setting for a user - api_instance.delete_entity_user_settings(user_id, id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_user_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a setting for a user api_instance.delete_entity_user_settings(user_id, id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4888,7 +3770,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4898,7 +3779,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_users** -> delete_entity_users(id) +> delete_entity_users(id, filter=filter) Delete User entity @@ -4908,10 +3789,10 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4920,35 +3801,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete User entity - api_instance.delete_entity_users(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_users: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete User entity api_instance.delete_entity_users(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4963,7 +3837,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4973,7 +3846,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_visualization_objects** -> delete_entity_visualization_objects(workspace_id, object_id) +> delete_entity_visualization_objects(workspace_id, object_id, filter=filter) Delete a Visualization Object @@ -4981,10 +3854,10 @@ Delete a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4993,37 +3866,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Visualization Object - api_instance.delete_entity_visualization_objects(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Visualization Object api_instance.delete_entity_visualization_objects(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5038,7 +3904,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5048,7 +3913,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspace_data_filter_settings** -> delete_entity_workspace_data_filter_settings(workspace_id, object_id) +> delete_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter) Delete a Settings for Workspace Data Filter @@ -5056,10 +3921,10 @@ Delete a Settings for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5068,37 +3933,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Settings for Workspace Data Filter - api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Settings for Workspace Data Filter api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5113,7 +3971,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5123,7 +3980,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspace_data_filters** -> delete_entity_workspace_data_filters(workspace_id, object_id) +> delete_entity_workspace_data_filters(workspace_id, object_id, filter=filter) Delete a Workspace Data Filter @@ -5131,10 +3988,10 @@ Delete a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5143,37 +4000,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Workspace Data Filter - api_instance.delete_entity_workspace_data_filters(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Workspace Data Filter api_instance.delete_entity_workspace_data_filters(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5188,7 +4038,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5198,7 +4047,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspace_settings** -> delete_entity_workspace_settings(workspace_id, object_id) +> delete_entity_workspace_settings(workspace_id, object_id, filter=filter) Delete a Setting for Workspace @@ -5206,10 +4055,10 @@ Delete a Setting for Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5218,37 +4067,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Setting for Workspace - api_instance.delete_entity_workspace_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Setting for Workspace api_instance.delete_entity_workspace_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5263,7 +4105,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5273,7 +4114,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspaces** -> delete_entity_workspaces(id) +> delete_entity_workspaces(id, filter=filter) Delete Workspace entity @@ -5283,10 +4124,10 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5295,35 +4136,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Workspace entity - api_instance.delete_entity_workspaces(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Workspace entity api_instance.delete_entity_workspaces(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->delete_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5338,7 +4172,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -5348,7 +4181,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_automations_workspace_automations** -> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations() +> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get all Automations across all Workspaces @@ -5356,11 +4189,11 @@ Get all Automations across all Workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.models.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5369,43 +4202,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "title==someString;description==someString;workspace.id==321;notificationChannel.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'title==someString;description==someString;workspace.id==321;notificationChannel.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Automations across all Workspaces api_response = api_instance.get_all_automations_workspace_automations(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_automations_workspace_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_automations_workspace_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5420,7 +4248,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5430,7 +4257,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_aggregated_facts** -> JsonApiAggregatedFactOutList get_all_entities_aggregated_facts(workspace_id) +> JsonApiAggregatedFactOutList get_all_entities_aggregated_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) @@ -5438,11 +4265,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList +from gooddata_api_client.models.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5451,55 +4278,43 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,sourceFact", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_all_entities_aggregated_facts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_aggregated_facts: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset,sourceFact'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: api_response = api_instance.get_all_entities_aggregated_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_aggregated_facts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_aggregated_facts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5514,7 +4329,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5524,7 +4338,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_analytical_dashboards** -> JsonApiAnalyticalDashboardOutList get_all_entities_analytical_dashboards(workspace_id) +> JsonApiAnalyticalDashboardOutList get_all_entities_analytical_dashboards(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Dashboards @@ -5532,11 +4346,11 @@ Get all Dashboards ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5545,57 +4359,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=permissions,origin,accessInfo,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Dashboards - api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=permissions,origin,accessInfo,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Dashboards api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5610,7 +4411,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5620,7 +4420,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_api_tokens** -> JsonApiApiTokenOutList get_all_entities_api_tokens(user_id) +> JsonApiApiTokenOutList get_all_entities_api_tokens(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) List all api tokens for a user @@ -5628,11 +4428,11 @@ List all api tokens for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5641,49 +4441,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - user_id = "userId_example" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # List all api tokens for a user - api_response = api_instance.get_all_entities_api_tokens(user_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_api_tokens: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + user_id = 'user_id_example' # str | + filter = 'bearerToken==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # List all api tokens for a user api_response = api_instance.get_all_entities_api_tokens(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_api_tokens:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **user_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5698,7 +4487,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5708,7 +4496,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_attribute_hierarchies** -> JsonApiAttributeHierarchyOutList get_all_entities_attribute_hierarchies(workspace_id) +> JsonApiAttributeHierarchyOutList get_all_entities_attribute_hierarchies(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Attribute Hierarchies @@ -5716,11 +4504,11 @@ Get all Attribute Hierarchies ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.models.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5729,57 +4517,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Attribute Hierarchies - api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Attribute Hierarchies api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5794,7 +4569,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5804,7 +4578,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_attributes** -> JsonApiAttributeOutList get_all_entities_attributes(workspace_id) +> JsonApiAttributeOutList get_all_entities_attributes(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Attributes @@ -5812,11 +4586,11 @@ Get all Attributes ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5825,57 +4599,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,defaultView,labels,attributeHierarchies", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Attributes - api_response = api_instance.get_all_entities_attributes(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_attributes: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;dataset.id==321;defaultView.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset,defaultView,labels,attributeHierarchies'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Attributes api_response = api_instance.get_all_entities_attributes(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_attributes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_attributes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5890,7 +4651,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5900,7 +4660,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_automations** -> JsonApiAutomationOutList get_all_entities_automations(workspace_id) +> JsonApiAutomationOutList get_all_entities_automations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Automations @@ -5908,11 +4668,11 @@ Get all Automations ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.models.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5921,57 +4681,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Automations - api_response = api_instance.get_all_entities_automations(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_automations: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Automations api_response = api_instance.get_all_entities_automations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5986,7 +4733,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5996,7 +4742,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_color_palettes** -> JsonApiColorPaletteOutList get_all_entities_color_palettes() +> JsonApiColorPaletteOutList get_all_entities_color_palettes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Color Pallettes @@ -6004,11 +4750,11 @@ Get all Color Pallettes ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6017,39 +4763,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Color Pallettes api_response = api_instance.get_all_entities_color_palettes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6064,7 +4807,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6074,7 +4816,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_csp_directives** -> JsonApiCspDirectiveOutList get_all_entities_csp_directives() +> JsonApiCspDirectiveOutList get_all_entities_csp_directives(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get CSP Directives @@ -6084,11 +4826,11 @@ Get CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6097,39 +4839,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get CSP Directives api_response = api_instance.get_all_entities_csp_directives(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6144,7 +4883,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6154,7 +4892,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_custom_application_settings** -> JsonApiCustomApplicationSettingOutList get_all_entities_custom_application_settings(workspace_id) +> JsonApiCustomApplicationSettingOutList get_all_entities_custom_application_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Custom Application Settings @@ -6162,11 +4900,11 @@ Get all Custom Application Settings ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6175,53 +4913,42 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Custom Application Settings - api_response = api_instance.get_all_entities_custom_application_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Custom Application Settings api_response = api_instance.get_all_entities_custom_application_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6236,7 +4963,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6246,7 +4972,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_dashboard_plugins** -> JsonApiDashboardPluginOutList get_all_entities_dashboard_plugins(workspace_id) +> JsonApiDashboardPluginOutList get_all_entities_dashboard_plugins(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Plugins @@ -6254,11 +4980,11 @@ Get all Plugins ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6267,57 +4993,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Plugins - api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Plugins api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6332,7 +5045,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6342,7 +5054,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_data_source_identifiers** -> JsonApiDataSourceIdentifierOutList get_all_entities_data_source_identifiers() +> JsonApiDataSourceIdentifierOutList get_all_entities_data_source_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Data Source Identifiers @@ -6350,11 +5062,11 @@ Get all Data Source Identifiers ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6363,39 +5075,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;schema==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=permissions,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'name==someString;schema==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=permissions,page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Data Source Identifiers api_response = api_instance.get_all_entities_data_source_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_data_source_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_data_source_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6410,7 +5119,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6420,7 +5128,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_data_sources** -> JsonApiDataSourceOutList get_all_entities_data_sources() +> JsonApiDataSourceOutList get_all_entities_data_sources(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get Data Source entities @@ -6430,11 +5138,11 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6443,39 +5151,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=permissions,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=permissions,page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Data Source entities api_response = api_instance.get_all_entities_data_sources(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6490,7 +5195,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6500,7 +5204,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_datasets** -> JsonApiDatasetOutList get_all_entities_datasets(workspace_id) +> JsonApiDatasetOutList get_all_entities_datasets(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Datasets @@ -6508,11 +5212,11 @@ Get all Datasets ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6521,57 +5225,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Datasets - api_response = api_instance.get_all_entities_datasets(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_datasets: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,facts,aggregatedFacts,references,workspaceDataFilters'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Datasets api_response = api_instance.get_all_entities_datasets(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_datasets:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_datasets: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6586,7 +5277,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6596,7 +5286,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_entitlements** -> JsonApiEntitlementOutList get_all_entities_entitlements() +> JsonApiEntitlementOutList get_all_entities_entitlements(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get Entitlements @@ -6606,11 +5296,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6619,39 +5309,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'value==someString;expiry==LocalDateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Entitlements api_response = api_instance.get_all_entities_entitlements(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_entitlements:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_entitlements: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6666,7 +5353,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6676,7 +5362,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_export_definitions** -> JsonApiExportDefinitionOutList get_all_entities_export_definitions(workspace_id) +> JsonApiExportDefinitionOutList get_all_entities_export_definitions(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Export Definitions @@ -6684,11 +5370,11 @@ Get all Export Definitions ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.models.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6697,57 +5383,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Export Definitions - api_response = api_instance.get_all_entities_export_definitions(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Export Definitions api_response = api_instance.get_all_entities_export_definitions(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6762,7 +5435,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6772,7 +5444,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_export_templates** -> JsonApiExportTemplateOutList get_all_entities_export_templates() +> JsonApiExportTemplateOutList get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) GET all Export Template entities @@ -6780,11 +5452,11 @@ GET all Export Template entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.models.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6793,39 +5465,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # GET all Export Template entities api_response = api_instance.get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6840,7 +5509,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6850,7 +5518,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_facts** -> JsonApiFactOutList get_all_entities_facts(workspace_id) +> JsonApiFactOutList get_all_entities_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Facts @@ -6858,11 +5526,11 @@ Get all Facts ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6871,57 +5539,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Facts - api_response = api_instance.get_all_entities_facts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_facts: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;dataset.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Facts api_response = api_instance.get_all_entities_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_facts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_facts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6936,7 +5591,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6946,7 +5600,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_filter_contexts** -> JsonApiFilterContextOutList get_all_entities_filter_contexts(workspace_id) +> JsonApiFilterContextOutList get_all_entities_filter_contexts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Context Filters @@ -6954,11 +5608,11 @@ Get all Context Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6967,57 +5621,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Context Filters - api_response = api_instance.get_all_entities_filter_contexts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Context Filters api_response = api_instance.get_all_entities_filter_contexts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7032,7 +5673,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7042,7 +5682,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_filter_views** -> JsonApiFilterViewOutList get_all_entities_filter_views(workspace_id) +> JsonApiFilterViewOutList get_all_entities_filter_views(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Filter views @@ -7050,11 +5690,11 @@ Get all Filter views ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.models.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7063,57 +5703,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Filter views - api_response = api_instance.get_all_entities_filter_views(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_filter_views: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Filter views api_response = api_instance.get_all_entities_filter_views(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7128,7 +5755,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7138,7 +5764,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_identity_providers** -> JsonApiIdentityProviderOutList get_all_entities_identity_providers() +> JsonApiIdentityProviderOutList get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Identity Providers @@ -7146,11 +5772,11 @@ Get all Identity Providers ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.models.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7159,39 +5785,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Identity Providers api_response = api_instance.get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7206,7 +5829,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7216,7 +5838,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_jwks** -> JsonApiJwkOutList get_all_entities_jwks() +> JsonApiJwkOutList get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Jwks @@ -7226,11 +5848,11 @@ Returns all JSON web keys - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.models.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7239,39 +5861,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Jwks api_response = api_instance.get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7286,7 +5905,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7296,7 +5914,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_labels** -> JsonApiLabelOutList get_all_entities_labels(workspace_id) +> JsonApiLabelOutList get_all_entities_labels(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Labels @@ -7304,11 +5922,11 @@ Get all Labels ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7317,57 +5935,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Labels - api_response = api_instance.get_all_entities_labels(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_labels: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;attribute.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attribute'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Labels api_response = api_instance.get_all_entities_labels(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_labels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_labels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7382,7 +5987,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7392,7 +5996,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_llm_endpoints** -> JsonApiLlmEndpointOutList get_all_entities_llm_endpoints() +> JsonApiLlmEndpointOutList get_all_entities_llm_endpoints(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all LLM endpoint entities @@ -7400,11 +6004,11 @@ Get all LLM endpoint entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from gooddata_api_client.models.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7413,39 +6017,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all LLM endpoint entities api_response = api_instance.get_all_entities_llm_endpoints(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7460,7 +6061,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7470,7 +6070,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_metrics** -> JsonApiMetricOutList get_all_entities_metrics(workspace_id) +> JsonApiMetricOutList get_all_entities_metrics(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Metrics @@ -7478,11 +6078,11 @@ Get all Metrics ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7491,57 +6091,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Metrics - api_response = api_instance.get_all_entities_metrics(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_metrics: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Metrics api_response = api_instance.get_all_entities_metrics(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7556,7 +6143,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7566,7 +6152,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_notification_channel_identifiers** -> JsonApiNotificationChannelIdentifierOutList get_all_entities_notification_channel_identifiers() +> JsonApiNotificationChannelIdentifierOutList get_all_entities_notification_channel_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) @@ -7574,11 +6160,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.models.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7587,38 +6173,35 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: api_response = api_instance.get_all_entities_notification_channel_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_notification_channel_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_notification_channel_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7633,7 +6216,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7643,7 +6225,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_notification_channels** -> JsonApiNotificationChannelOutList get_all_entities_notification_channels() +> JsonApiNotificationChannelOutList get_all_entities_notification_channels(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Notification Channel entities @@ -7651,11 +6233,11 @@ Get all Notification Channel entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.models.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7664,39 +6246,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Notification Channel entities api_response = api_instance.get_all_entities_notification_channels(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7711,7 +6290,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7721,7 +6299,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_organization_settings** -> JsonApiOrganizationSettingOutList get_all_entities_organization_settings() +> JsonApiOrganizationSettingOutList get_all_entities_organization_settings(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get Organization entities @@ -7729,11 +6307,11 @@ Get Organization entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7742,39 +6320,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Organization entities api_response = api_instance.get_all_entities_organization_settings(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7789,7 +6364,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7799,7 +6373,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_themes** -> JsonApiThemeOutList get_all_entities_themes() +> JsonApiThemeOutList get_all_entities_themes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Theming entities @@ -7807,11 +6381,11 @@ Get all Theming entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7820,39 +6394,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Theming entities api_response = api_instance.get_all_entities_themes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7867,7 +6438,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7877,7 +6447,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_user_data_filters** -> JsonApiUserDataFilterOutList get_all_entities_user_data_filters(workspace_id) +> JsonApiUserDataFilterOutList get_all_entities_user_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all User Data Filters @@ -7885,11 +6455,11 @@ Get all User Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7898,57 +6468,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all User Data Filters - api_response = api_instance.get_all_entities_user_data_filters(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all User Data Filters api_response = api_instance.get_all_entities_user_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -7963,7 +6520,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7973,7 +6529,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_user_groups** -> JsonApiUserGroupOutList get_all_entities_user_groups() +> JsonApiUserGroupOutList get_all_entities_user_groups(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get UserGroup entities @@ -7983,11 +6539,11 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7996,43 +6552,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get UserGroup entities api_response = api_instance.get_all_entities_user_groups(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -8047,7 +6598,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8057,7 +6607,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_user_identifiers** -> JsonApiUserIdentifierOutList get_all_entities_user_identifiers() +> JsonApiUserIdentifierOutList get_all_entities_user_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get UserIdentifier entities @@ -8067,11 +6617,11 @@ UserIdentifier - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.models.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8080,39 +6630,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "firstname==someString;lastname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'firstname==someString;lastname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get UserIdentifier entities api_response = api_instance.get_all_entities_user_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_user_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_user_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -8127,7 +6674,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8137,7 +6683,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_user_settings** -> JsonApiUserSettingOutList get_all_entities_user_settings(user_id) +> JsonApiUserSettingOutList get_all_entities_user_settings(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) List all settings for a user @@ -8145,11 +6691,11 @@ List all settings for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8158,49 +6704,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - user_id = "userId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # List all settings for a user - api_response = api_instance.get_all_entities_user_settings(user_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_user_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + user_id = 'user_id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # List all settings for a user api_response = api_instance.get_all_entities_user_settings(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **user_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -8215,7 +6750,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8225,7 +6759,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_users** -> JsonApiUserOutList get_all_entities_users() +> JsonApiUserOutList get_all_entities_users(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get User entities @@ -8235,11 +6769,11 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8248,43 +6782,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get User entities api_response = api_instance.get_all_entities_users(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -8299,7 +6828,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8309,7 +6837,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_visualization_objects** -> JsonApiVisualizationObjectOutList get_all_entities_visualization_objects(workspace_id) +> JsonApiVisualizationObjectOutList get_all_entities_visualization_objects(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Visualization Objects @@ -8317,11 +6845,11 @@ Get all Visualization Objects ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8330,57 +6858,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Visualization Objects - api_response = api_instance.get_all_entities_visualization_objects(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Visualization Objects api_response = api_instance.get_all_entities_visualization_objects(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -8395,7 +6910,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8405,7 +6919,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id) +> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Settings for Workspace Data Filters @@ -8413,11 +6927,11 @@ Get all Settings for Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8426,57 +6940,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Settings for Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Settings for Workspace Data Filters api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -8491,7 +6992,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8501,7 +7001,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id) +> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Workspace Data Filters @@ -8509,11 +7009,11 @@ Get all Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8522,57 +7022,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Workspace Data Filters api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -8587,7 +7074,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8597,7 +7083,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspace_settings** -> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id) +> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Setting for Workspaces @@ -8605,11 +7091,11 @@ Get all Setting for Workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8618,53 +7104,42 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Setting for Workspaces - api_response = api_instance.get_all_entities_workspace_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Setting for Workspaces api_response = api_instance.get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -8679,7 +7154,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8689,7 +7163,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspaces** -> JsonApiWorkspaceOutList get_all_entities_workspaces() +> JsonApiWorkspaceOutList get_all_entities_workspaces(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get Workspace entities @@ -8699,11 +7173,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8712,43 +7186,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitiesApi(api_client) + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Workspace entities api_response = api_instance.get_all_entities_workspaces(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitiesApi->get_all_entities_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_entities_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -8763,7 +7232,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8773,7 +7241,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_options** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_options() +> object get_all_options() Links for all configuration options @@ -8783,10 +7251,10 @@ Retrieves links for all options for different configurations. ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8795,26 +7263,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) + api_instance = gooddata_api_client.EntitiesApi(api_client) - # example, this endpoint has no required or optional parameters try: # Links for all configuration options api_response = api_instance.get_all_options() + print("The response of EntitiesApi->get_all_options:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_all_options: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +**object** ### Authorization @@ -8825,7 +7295,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -8835,7 +7304,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_data_source_drivers** -> {str: (str,)} get_data_source_drivers() +> Dict[str, str] get_data_source_drivers() Get all available data source drivers @@ -8845,10 +7314,10 @@ Retrieves a list of all supported data sources along with information about the ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8857,26 +7326,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) + api_instance = gooddata_api_client.EntitiesApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all available data source drivers api_response = api_instance.get_data_source_drivers() + print("The response of EntitiesApi->get_data_source_drivers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_data_source_drivers: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -**{str: (str,)}** +**Dict[str, str]** ### Authorization @@ -8887,7 +7358,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -8897,7 +7367,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_aggregated_facts** -> JsonApiAggregatedFactOutDocument get_entity_aggregated_facts(workspace_id, object_id) +> JsonApiAggregatedFactOutDocument get_entity_aggregated_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) @@ -8905,11 +7375,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument +from gooddata_api_client.models.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8918,47 +7388,37 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,sourceFact", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_aggregated_facts: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset,sourceFact'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_aggregated_facts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_aggregated_facts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -8973,7 +7433,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8983,7 +7442,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id) +> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Dashboard @@ -8991,11 +7450,11 @@ Get a Dashboard ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9004,49 +7463,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=permissions,origin,accessInfo,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Dashboard - api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=permissions,origin,accessInfo,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Dashboard api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -9061,7 +7509,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9071,7 +7518,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_api_tokens** -> JsonApiApiTokenOutDocument get_entity_api_tokens(user_id, id) +> JsonApiApiTokenOutDocument get_entity_api_tokens(user_id, id, filter=filter) Get an API Token for a user @@ -9079,11 +7526,11 @@ Get an API Token for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9092,39 +7539,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get an API Token for a user - api_response = api_instance.get_entity_api_tokens(user_id, id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_api_tokens: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'bearerToken==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an API Token for a user api_response = api_instance.get_entity_api_tokens(user_id, id, filter=filter) + print("The response of EntitiesApi->get_entity_api_tokens:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -9139,7 +7579,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9149,7 +7588,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument get_entity_attribute_hierarchies(workspace_id, object_id) +> JsonApiAttributeHierarchyOutDocument get_entity_attribute_hierarchies(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Attribute Hierarchy @@ -9157,11 +7596,11 @@ Get an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9170,49 +7609,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Attribute Hierarchy - api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Attribute Hierarchy api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -9227,7 +7655,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9237,7 +7664,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_attributes** -> JsonApiAttributeOutDocument get_entity_attributes(workspace_id, object_id) +> JsonApiAttributeOutDocument get_entity_attributes(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Attribute @@ -9245,11 +7672,11 @@ Get an Attribute ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9258,49 +7685,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,defaultView,labels,attributeHierarchies", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Attribute - api_response = api_instance.get_entity_attributes(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_attributes: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;dataset.id==321;defaultView.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset,defaultView,labels,attributeHierarchies'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Attribute api_response = api_instance.get_entity_attributes(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_attributes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_attributes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -9315,7 +7731,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9325,7 +7740,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_automations** -> JsonApiAutomationOutDocument get_entity_automations(workspace_id, object_id) +> JsonApiAutomationOutDocument get_entity_automations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Automation @@ -9333,11 +7748,11 @@ Get an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9346,49 +7761,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Automation - api_response = api_instance.get_entity_automations(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Automation api_response = api_instance.get_entity_automations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -9403,7 +7807,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9413,7 +7816,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_color_palettes** -> JsonApiColorPaletteOutDocument get_entity_color_palettes(id) +> JsonApiColorPaletteOutDocument get_entity_color_palettes(id, filter=filter) Get Color Pallette @@ -9421,11 +7824,11 @@ Get Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9434,37 +7837,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Color Pallette - api_response = api_instance.get_entity_color_palettes(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_color_palettes: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Color Pallette api_response = api_instance.get_entity_color_palettes(id, filter=filter) + print("The response of EntitiesApi->get_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -9479,7 +7875,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9489,7 +7884,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument get_entity_cookie_security_configurations(id) +> JsonApiCookieSecurityConfigurationOutDocument get_entity_cookie_security_configurations(id, filter=filter) Get CookieSecurityConfiguration @@ -9497,11 +7892,11 @@ Get CookieSecurityConfiguration ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9510,37 +7905,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get CookieSecurityConfiguration - api_response = api_instance.get_entity_cookie_security_configurations(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_cookie_security_configurations: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'lastRotation==InstantValue;rotationInterval==DurationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get CookieSecurityConfiguration api_response = api_instance.get_entity_cookie_security_configurations(id, filter=filter) + print("The response of EntitiesApi->get_entity_cookie_security_configurations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_cookie_security_configurations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -9555,7 +7943,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9565,7 +7952,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_csp_directives** -> JsonApiCspDirectiveOutDocument get_entity_csp_directives(id) +> JsonApiCspDirectiveOutDocument get_entity_csp_directives(id, filter=filter) Get CSP Directives @@ -9575,11 +7962,11 @@ Get CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9588,37 +7975,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get CSP Directives - api_response = api_instance.get_entity_csp_directives(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_csp_directives: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get CSP Directives api_response = api_instance.get_entity_csp_directives(id, filter=filter) + print("The response of EntitiesApi->get_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -9633,7 +8013,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9643,7 +8022,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument get_entity_custom_application_settings(workspace_id, object_id) +> JsonApiCustomApplicationSettingOutDocument get_entity_custom_application_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Custom Application Setting @@ -9651,11 +8030,11 @@ Get a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9664,45 +8043,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Custom Application Setting - api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Custom Application Setting api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -9717,7 +8087,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9727,7 +8096,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument get_entity_dashboard_plugins(workspace_id, object_id) +> JsonApiDashboardPluginOutDocument get_entity_dashboard_plugins(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Plugin @@ -9735,11 +8104,11 @@ Get a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9748,49 +8117,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Plugin - api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Plugin api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -9805,7 +8163,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9815,7 +8172,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_data_source_identifiers** -> JsonApiDataSourceIdentifierOutDocument get_entity_data_source_identifiers(id) +> JsonApiDataSourceIdentifierOutDocument get_entity_data_source_identifiers(id, filter=filter, meta_include=meta_include) Get Data Source Identifier @@ -9823,11 +8180,11 @@ Get Data Source Identifier ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9836,41 +8193,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;schema==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Data Source Identifier - api_response = api_instance.get_entity_data_source_identifiers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_data_source_identifiers: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;schema==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Data Source Identifier api_response = api_instance.get_entity_data_source_identifiers(id, filter=filter, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_data_source_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_data_source_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -9885,7 +8233,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9895,7 +8242,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_data_sources** -> JsonApiDataSourceOutDocument get_entity_data_sources(id) +> JsonApiDataSourceOutDocument get_entity_data_sources(id, filter=filter, meta_include=meta_include) Get Data Source entity @@ -9905,11 +8252,11 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9918,41 +8265,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Data Source entity - api_response = api_instance.get_entity_data_sources(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Data Source entity api_response = api_instance.get_entity_data_sources(id, filter=filter, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -9967,7 +8305,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9977,7 +8314,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_datasets** -> JsonApiDatasetOutDocument get_entity_datasets(workspace_id, object_id) +> JsonApiDatasetOutDocument get_entity_datasets(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Dataset @@ -9985,11 +8322,11 @@ Get a Dataset ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9998,49 +8335,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Dataset - api_response = api_instance.get_entity_datasets(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_datasets: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,facts,aggregatedFacts,references,workspaceDataFilters'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Dataset api_response = api_instance.get_entity_datasets(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_datasets:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_datasets: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -10055,7 +8381,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10065,7 +8390,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_entitlements** -> JsonApiEntitlementOutDocument get_entity_entitlements(id) +> JsonApiEntitlementOutDocument get_entity_entitlements(id, filter=filter) Get Entitlement @@ -10075,11 +8400,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10088,37 +8413,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get Entitlement - api_response = api_instance.get_entity_entitlements(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_entitlements: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'value==someString;expiry==LocalDateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Entitlement api_response = api_instance.get_entity_entitlements(id, filter=filter) + print("The response of EntitiesApi->get_entity_entitlements:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_entitlements: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -10133,7 +8451,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10143,7 +8460,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_export_definitions** -> JsonApiExportDefinitionOutDocument get_entity_export_definitions(workspace_id, object_id) +> JsonApiExportDefinitionOutDocument get_entity_export_definitions(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Export Definition @@ -10151,11 +8468,11 @@ Get an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10164,49 +8481,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Export Definition - api_response = api_instance.get_entity_export_definitions(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Export Definition api_response = api_instance.get_entity_export_definitions(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -10221,7 +8527,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10231,7 +8536,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_export_templates** -> JsonApiExportTemplateOutDocument get_entity_export_templates(id) +> JsonApiExportTemplateOutDocument get_entity_export_templates(id, filter=filter) GET Export Template entity @@ -10239,11 +8544,11 @@ GET Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10252,37 +8557,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # GET Export Template entity - api_response = api_instance.get_entity_export_templates(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_export_templates: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # GET Export Template entity api_response = api_instance.get_entity_export_templates(id, filter=filter) + print("The response of EntitiesApi->get_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -10297,7 +8595,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10307,7 +8604,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_facts** -> JsonApiFactOutDocument get_entity_facts(workspace_id, object_id) +> JsonApiFactOutDocument get_entity_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Fact @@ -10315,11 +8612,11 @@ Get a Fact ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10328,49 +8625,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Fact - api_response = api_instance.get_entity_facts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_facts: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;dataset.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Fact api_response = api_instance.get_entity_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_facts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_facts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -10385,7 +8671,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10395,7 +8680,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_filter_contexts** -> JsonApiFilterContextOutDocument get_entity_filter_contexts(workspace_id, object_id) +> JsonApiFilterContextOutDocument get_entity_filter_contexts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Context Filter @@ -10403,11 +8688,11 @@ Get a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10416,49 +8701,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Context Filter - api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Context Filter api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -10473,7 +8747,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10483,7 +8756,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_filter_views** -> JsonApiFilterViewOutDocument get_entity_filter_views(workspace_id, object_id) +> JsonApiFilterViewOutDocument get_entity_filter_views(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations) Get Filter view @@ -10491,11 +8764,11 @@ Get Filter view ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10504,45 +8777,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Get Filter view - api_response = api_instance.get_entity_filter_views(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # Get Filter view api_response = api_instance.get_entity_filter_views(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations) + print("The response of EntitiesApi->get_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] ### Return type @@ -10557,7 +8821,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10567,7 +8830,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_identity_providers** -> JsonApiIdentityProviderOutDocument get_entity_identity_providers(id) +> JsonApiIdentityProviderOutDocument get_entity_identity_providers(id, filter=filter) Get Identity Provider @@ -10575,11 +8838,11 @@ Get Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10588,37 +8851,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get Identity Provider - api_response = api_instance.get_entity_identity_providers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_identity_providers: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Identity Provider api_response = api_instance.get_entity_identity_providers(id, filter=filter) + print("The response of EntitiesApi->get_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -10633,7 +8889,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10643,7 +8898,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_jwks** -> JsonApiJwkOutDocument get_entity_jwks(id) +> JsonApiJwkOutDocument get_entity_jwks(id, filter=filter) Get Jwk @@ -10653,11 +8908,11 @@ Returns JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10666,37 +8921,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get Jwk - api_response = api_instance.get_entity_jwks(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_jwks: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Jwk api_response = api_instance.get_entity_jwks(id, filter=filter) + print("The response of EntitiesApi->get_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -10711,7 +8959,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10721,7 +8968,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_labels** -> JsonApiLabelOutDocument get_entity_labels(workspace_id, object_id) +> JsonApiLabelOutDocument get_entity_labels(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Label @@ -10729,11 +8976,11 @@ Get a Label ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10742,49 +8989,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Label - api_response = api_instance.get_entity_labels(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_labels: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;attribute.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attribute'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Label api_response = api_instance.get_entity_labels(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_labels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_labels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -10799,7 +9035,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10809,7 +9044,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_llm_endpoints** -> JsonApiLlmEndpointOutDocument get_entity_llm_endpoints(id) +> JsonApiLlmEndpointOutDocument get_entity_llm_endpoints(id, filter=filter) Get LLM endpoint entity @@ -10817,11 +9052,11 @@ Get LLM endpoint entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10830,37 +9065,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get LLM endpoint entity - api_response = api_instance.get_entity_llm_endpoints(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_llm_endpoints: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get LLM endpoint entity api_response = api_instance.get_entity_llm_endpoints(id, filter=filter) + print("The response of EntitiesApi->get_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -10875,7 +9103,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10885,7 +9112,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_metrics** -> JsonApiMetricOutDocument get_entity_metrics(workspace_id, object_id) +> JsonApiMetricOutDocument get_entity_metrics(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Metric @@ -10893,11 +9120,11 @@ Get a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10906,49 +9133,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Metric - api_response = api_instance.get_entity_metrics(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Metric api_response = api_instance.get_entity_metrics(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -10963,7 +9179,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -10973,7 +9188,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_notification_channel_identifiers** -> JsonApiNotificationChannelIdentifierOutDocument get_entity_notification_channel_identifiers(id) +> JsonApiNotificationChannelIdentifierOutDocument get_entity_notification_channel_identifiers(id, filter=filter) @@ -10981,11 +9196,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -10994,35 +9209,29 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_entity_notification_channel_identifiers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_notification_channel_identifiers: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: api_response = api_instance.get_entity_notification_channel_identifiers(id, filter=filter) + print("The response of EntitiesApi->get_entity_notification_channel_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_notification_channel_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -11037,7 +9246,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11047,7 +9255,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_notification_channels** -> JsonApiNotificationChannelOutDocument get_entity_notification_channels(id) +> JsonApiNotificationChannelOutDocument get_entity_notification_channels(id, filter=filter) Get Notification Channel entity @@ -11055,11 +9263,11 @@ Get Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11068,37 +9276,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Notification Channel entity - api_response = api_instance.get_entity_notification_channels(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_notification_channels: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Notification Channel entity api_response = api_instance.get_entity_notification_channels(id, filter=filter) + print("The response of EntitiesApi->get_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -11113,7 +9314,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11123,7 +9323,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_organization_settings** -> JsonApiOrganizationSettingOutDocument get_entity_organization_settings(id) +> JsonApiOrganizationSettingOutDocument get_entity_organization_settings(id, filter=filter) Get Organization entity @@ -11131,11 +9331,11 @@ Get Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11144,37 +9344,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get Organization entity - api_response = api_instance.get_entity_organization_settings(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_organization_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Organization entity api_response = api_instance.get_entity_organization_settings(id, filter=filter) + print("The response of EntitiesApi->get_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -11189,7 +9382,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11199,7 +9391,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_organizations** -> JsonApiOrganizationOutDocument get_entity_organizations(id) +> JsonApiOrganizationOutDocument get_entity_organizations(id, filter=filter, include=include, meta_include=meta_include) Get Organizations @@ -11207,11 +9399,11 @@ Get Organizations ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11220,45 +9412,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "bootstrapUser,bootstrapUserGroup,identityProvider", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Organizations - api_response = api_instance.get_entity_organizations(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_organizations: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['bootstrapUser,bootstrapUserGroup,identityProvider'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Organizations api_response = api_instance.get_entity_organizations(id, filter=filter, include=include, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_organizations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_organizations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -11273,7 +9454,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11283,7 +9463,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_themes** -> JsonApiThemeOutDocument get_entity_themes(id) +> JsonApiThemeOutDocument get_entity_themes(id, filter=filter) Get Theming @@ -11291,11 +9471,11 @@ Get Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11304,37 +9484,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Theming - api_response = api_instance.get_entity_themes(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_themes: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Theming api_response = api_instance.get_entity_themes(id, filter=filter) + print("The response of EntitiesApi->get_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -11349,7 +9522,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11359,7 +9531,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument get_entity_user_data_filters(workspace_id, object_id) +> JsonApiUserDataFilterOutDocument get_entity_user_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a User Data Filter @@ -11367,11 +9539,11 @@ Get a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11380,49 +9552,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a User Data Filter - api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a User Data Filter api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -11437,7 +9598,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11447,7 +9607,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_groups** -> JsonApiUserGroupOutDocument get_entity_user_groups(id) +> JsonApiUserGroupOutDocument get_entity_user_groups(id, filter=filter, include=include) Get UserGroup entity @@ -11457,11 +9617,11 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11470,41 +9630,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Get UserGroup entity - api_response = api_instance.get_entity_user_groups(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get UserGroup entity api_response = api_instance.get_entity_user_groups(id, filter=filter, include=include) + print("The response of EntitiesApi->get_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -11519,7 +9670,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11529,7 +9679,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_identifiers** -> JsonApiUserIdentifierOutDocument get_entity_user_identifiers(id) +> JsonApiUserIdentifierOutDocument get_entity_user_identifiers(id, filter=filter) Get UserIdentifier entity @@ -11539,11 +9689,11 @@ UserIdentifier - represents basic information about entity interacting with plat ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.models.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11552,37 +9702,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "firstname==someString;lastname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'firstname==someString;lastname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get UserIdentifier entity - api_response = api_instance.get_entity_user_identifiers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_user_identifiers: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get UserIdentifier entity api_response = api_instance.get_entity_user_identifiers(id, filter=filter) + print("The response of EntitiesApi->get_entity_user_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_user_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -11597,7 +9740,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11607,7 +9749,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_settings** -> JsonApiUserSettingOutDocument get_entity_user_settings(user_id, id) +> JsonApiUserSettingOutDocument get_entity_user_settings(user_id, id, filter=filter) Get a setting for a user @@ -11615,11 +9757,11 @@ Get a setting for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11628,39 +9770,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get a setting for a user - api_response = api_instance.get_entity_user_settings(user_id, id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_user_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get a setting for a user api_response = api_instance.get_entity_user_settings(user_id, id, filter=filter) + print("The response of EntitiesApi->get_entity_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -11675,7 +9810,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11685,7 +9819,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_users** -> JsonApiUserOutDocument get_entity_users(id) +> JsonApiUserOutDocument get_entity_users(id, filter=filter, include=include) Get User entity @@ -11695,11 +9829,11 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11708,41 +9842,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Get User entity - api_response = api_instance.get_entity_users(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_users: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get User entity api_response = api_instance.get_entity_users(id, filter=filter, include=include) + print("The response of EntitiesApi->get_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -11757,7 +9882,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11767,7 +9891,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument get_entity_visualization_objects(workspace_id, object_id) +> JsonApiVisualizationObjectOutDocument get_entity_visualization_objects(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Visualization Object @@ -11775,11 +9899,11 @@ Get a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11788,49 +9912,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Visualization Object - api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Visualization Object api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -11845,7 +9958,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11855,7 +9967,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id) +> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Setting for Workspace Data Filter @@ -11863,11 +9975,11 @@ Get a Setting for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11876,49 +9988,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Setting for Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Setting for Workspace Data Filter api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -11933,7 +10034,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -11943,7 +10043,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id) +> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Workspace Data Filter @@ -11951,11 +10051,11 @@ Get a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -11964,49 +10064,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Workspace Data Filter api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -12021,7 +10110,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -12031,7 +10119,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id) +> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Setting for Workspace @@ -12039,11 +10127,11 @@ Get a Setting for Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -12052,45 +10140,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Setting for Workspace - api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Setting for Workspace api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -12105,7 +10184,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -12115,7 +10193,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspaces** -> JsonApiWorkspaceOutDocument get_entity_workspaces(id) +> JsonApiWorkspaceOutDocument get_entity_workspaces(id, filter=filter, include=include, meta_include=meta_include) Get Workspace entity @@ -12125,11 +10203,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -12138,45 +10216,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Workspace entity - api_response = api_instance.get_entity_workspaces(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=config,permissions,hierarchy,dataModelDatasets,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Workspace entity api_response = api_instance.get_entity_workspaces(id, filter=filter, include=include, meta_include=meta_include) + print("The response of EntitiesApi->get_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -12191,7 +10258,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -12201,7 +10267,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_organization** -> get_organization() +> get_organization(meta_include=meta_include) Get current organization info @@ -12211,10 +10277,10 @@ Gets a basic information about organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -12223,28 +10289,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - meta_include = [ - "metaInclude=permissions", - ] # [str] | Return list of permissions available to logged user. (optional) + api_instance = gooddata_api_client.EntitiesApi(api_client) + meta_include = ['metaInclude=permissions'] # List[str] | Return list of permissions available to logged user. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get current organization info api_instance.get_organization(meta_include=meta_include) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->get_organization: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **meta_include** | **[str]**| Return list of permissions available to logged user. | [optional] + **meta_include** | [**List[str]**](str.md)| Return list of permissions available to logged user. | [optional] ### Return type @@ -12259,7 +10323,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -12269,7 +10332,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) +> JsonApiAnalyticalDashboardOutDocument patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, filter=filter, include=include) Patch a Dashboard @@ -12277,12 +10340,12 @@ Patch a Dashboard ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -12291,59 +10354,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_analytical_dashboard_patch_document = JsonApiAnalyticalDashboardPatchDocument( - data=JsonApiAnalyticalDashboardPatch( - attributes=JsonApiAnalyticalDashboardPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Dashboard - api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_analytical_dashboard_patch_document = gooddata_api_client.JsonApiAnalyticalDashboardPatchDocument() # JsonApiAnalyticalDashboardPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Dashboard api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_analytical_dashboard_patch_document** | [**JsonApiAnalyticalDashboardPatchDocument**](JsonApiAnalyticalDashboardPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_analytical_dashboard_patch_document** | [**JsonApiAnalyticalDashboardPatchDocument**](JsonApiAnalyticalDashboardPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -12358,7 +10398,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -12368,7 +10407,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) +> JsonApiAttributeHierarchyOutDocument patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, filter=filter, include=include) Patch an Attribute Hierarchy @@ -12376,12 +10415,12 @@ Patch an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -12390,59 +10429,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_attribute_hierarchy_patch_document = JsonApiAttributeHierarchyPatchDocument( - data=JsonApiAttributeHierarchyPatch( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Attribute Hierarchy - api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_attribute_hierarchy_patch_document = gooddata_api_client.JsonApiAttributeHierarchyPatchDocument() # JsonApiAttributeHierarchyPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch an Attribute Hierarchy api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_attribute_hierarchy_patch_document** | [**JsonApiAttributeHierarchyPatchDocument**](JsonApiAttributeHierarchyPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_attribute_hierarchy_patch_document** | [**JsonApiAttributeHierarchyPatchDocument**](JsonApiAttributeHierarchyPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -12457,7 +10473,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -12467,7 +10482,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_automations** -> JsonApiAutomationOutDocument patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) +> JsonApiAutomationOutDocument patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, filter=filter, include=include) Patch an Automation @@ -12475,12 +10490,12 @@ Patch an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -12489,301 +10504,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_automation_patch_document = JsonApiAutomationPatchDocument( - data=JsonApiAutomationPatch( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationPatchDocument | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Automation - api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_automation_patch_document = gooddata_api_client.JsonApiAutomationPatchDocument() # JsonApiAutomationPatchDocument | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch an Automation api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_automation_patch_document** | [**JsonApiAutomationPatchDocument**](JsonApiAutomationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_automation_patch_document** | [**JsonApiAutomationPatchDocument**](JsonApiAutomationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -12798,7 +10548,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -12808,7 +10557,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_color_palettes** -> JsonApiColorPaletteOutDocument patch_entity_color_palettes(id, json_api_color_palette_patch_document) +> JsonApiColorPaletteOutDocument patch_entity_color_palettes(id, json_api_color_palette_patch_document, filter=filter) Patch Color Pallette @@ -12816,12 +10565,12 @@ Patch Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -12830,48 +10579,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_color_palette_patch_document = JsonApiColorPalettePatchDocument( - data=JsonApiColorPalettePatch( - attributes=JsonApiColorPalettePatchAttributes( - content={}, - name="name_example", - ), - id="id1", - type="colorPalette", - ), - ) # JsonApiColorPalettePatchDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Color Pallette - api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_color_palettes: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_color_palette_patch_document = gooddata_api_client.JsonApiColorPalettePatchDocument() # JsonApiColorPalettePatchDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Color Pallette api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_color_palette_patch_document** | [**JsonApiColorPalettePatchDocument**](JsonApiColorPalettePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_color_palette_patch_document** | [**JsonApiColorPalettePatchDocument**](JsonApiColorPalettePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -12886,7 +10619,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -12896,7 +10628,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) +> JsonApiCookieSecurityConfigurationOutDocument patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, filter=filter) Patch CookieSecurityConfiguration @@ -12904,12 +10636,12 @@ Patch CookieSecurityConfiguration ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -12918,48 +10650,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_cookie_security_configuration_patch_document = JsonApiCookieSecurityConfigurationPatchDocument( - data=JsonApiCookieSecurityConfigurationPatch( - attributes=JsonApiCookieSecurityConfigurationInAttributes( - last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), - rotation_interval="P30D", - ), - id="id1", - type="cookieSecurityConfiguration", - ), - ) # JsonApiCookieSecurityConfigurationPatchDocument | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch CookieSecurityConfiguration - api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_cookie_security_configurations: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_cookie_security_configuration_patch_document = gooddata_api_client.JsonApiCookieSecurityConfigurationPatchDocument() # JsonApiCookieSecurityConfigurationPatchDocument | + filter = 'lastRotation==InstantValue;rotationInterval==DurationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch CookieSecurityConfiguration api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_cookie_security_configurations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_cookie_security_configurations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_cookie_security_configuration_patch_document** | [**JsonApiCookieSecurityConfigurationPatchDocument**](JsonApiCookieSecurityConfigurationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_cookie_security_configuration_patch_document** | [**JsonApiCookieSecurityConfigurationPatchDocument**](JsonApiCookieSecurityConfigurationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -12974,7 +10690,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -12984,7 +10699,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_csp_directives** -> JsonApiCspDirectiveOutDocument patch_entity_csp_directives(id, json_api_csp_directive_patch_document) +> JsonApiCspDirectiveOutDocument patch_entity_csp_directives(id, json_api_csp_directive_patch_document, filter=filter) Patch CSP Directives @@ -12994,12 +10709,12 @@ Patch CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -13008,49 +10723,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_csp_directive_patch_document = JsonApiCspDirectivePatchDocument( - data=JsonApiCspDirectivePatch( - attributes=JsonApiCspDirectivePatchAttributes( - sources=[ - "sources_example", - ], - ), - id="id1", - type="cspDirective", - ), - ) # JsonApiCspDirectivePatchDocument | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch CSP Directives - api_response = api_instance.patch_entity_csp_directives(id, json_api_csp_directive_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_csp_directives: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_csp_directive_patch_document = gooddata_api_client.JsonApiCspDirectivePatchDocument() # JsonApiCspDirectivePatchDocument | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch CSP Directives api_response = api_instance.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_csp_directive_patch_document** | [**JsonApiCspDirectivePatchDocument**](JsonApiCspDirectivePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_csp_directive_patch_document** | [**JsonApiCspDirectivePatchDocument**](JsonApiCspDirectivePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -13065,7 +10763,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -13075,7 +10772,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) +> JsonApiCustomApplicationSettingOutDocument patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, filter=filter) Patch a Custom Application Setting @@ -13083,12 +10780,12 @@ Patch a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -13097,50 +10794,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_custom_application_setting_patch_document = JsonApiCustomApplicationSettingPatchDocument( - data=JsonApiCustomApplicationSettingPatch( - attributes=JsonApiCustomApplicationSettingPatchAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingPatchDocument | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Custom Application Setting - api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_custom_application_setting_patch_document = gooddata_api_client.JsonApiCustomApplicationSettingPatchDocument() # JsonApiCustomApplicationSettingPatchDocument | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Custom Application Setting api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_custom_application_setting_patch_document** | [**JsonApiCustomApplicationSettingPatchDocument**](JsonApiCustomApplicationSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_custom_application_setting_patch_document** | [**JsonApiCustomApplicationSettingPatchDocument**](JsonApiCustomApplicationSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -13155,7 +10836,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -13165,7 +10845,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) +> JsonApiDashboardPluginOutDocument patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, filter=filter, include=include) Patch a Plugin @@ -13173,12 +10853,12 @@ Patch a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -13187,59 +10867,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_dashboard_plugin_patch_document = JsonApiDashboardPluginPatchDocument( - data=JsonApiDashboardPluginPatch( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Plugin - api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_dashboard_plugin_patch_document = gooddata_api_client.JsonApiDashboardPluginPatchDocument() # JsonApiDashboardPluginPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Plugin api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_dashboard_plugin_patch_document** | [**JsonApiDashboardPluginPatchDocument**](JsonApiDashboardPluginPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_dashboard_plugin_patch_document** | [**JsonApiDashboardPluginPatchDocument**](JsonApiDashboardPluginPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -13254,7 +10911,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -13264,7 +10920,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_data_sources** -> JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document) +> JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document, filter=filter) Patch Data Source entity @@ -13274,12 +10930,12 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -13288,64 +10944,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_data_source_patch_document = JsonApiDataSourcePatchDocument( - data=JsonApiDataSourcePatch( - attributes=JsonApiDataSourcePatchAttributes( - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourcePatchDocument | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Data Source entity - api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_data_source_patch_document = gooddata_api_client.JsonApiDataSourcePatchDocument() # JsonApiDataSourcePatchDocument | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Data Source entity api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_data_source_patch_document** | [**JsonApiDataSourcePatchDocument**](JsonApiDataSourcePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_data_source_patch_document** | [**JsonApiDataSourcePatchDocument**](JsonApiDataSourcePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -13360,7 +10984,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -13370,7 +10993,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_export_definitions** -> JsonApiExportDefinitionOutDocument patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) +> JsonApiExportDefinitionOutDocument patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, filter=filter, include=include) Patch an Export Definition @@ -13378,12 +11001,12 @@ Patch an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -13392,67 +11015,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_export_definition_patch_document = JsonApiExportDefinitionPatchDocument( - data=JsonApiExportDefinitionPatch( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionPatchDocument | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Export Definition - api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_export_definition_patch_document = gooddata_api_client.JsonApiExportDefinitionPatchDocument() # JsonApiExportDefinitionPatchDocument | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch an Export Definition api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_export_definition_patch_document** | [**JsonApiExportDefinitionPatchDocument**](JsonApiExportDefinitionPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_export_definition_patch_document** | [**JsonApiExportDefinitionPatchDocument**](JsonApiExportDefinitionPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -13467,7 +11059,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -13477,7 +11068,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_export_templates** -> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document) +> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) Patch Export Template entity @@ -13485,12 +11076,12 @@ Patch Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument -from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -13499,114 +11090,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_export_template_patch_document = JsonApiExportTemplatePatchDocument( - data=JsonApiExportTemplatePatch( - attributes=JsonApiExportTemplatePatchAttributes( - dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - name="name_example", - widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - id="id1", - type="exportTemplate", - ), - ) # JsonApiExportTemplatePatchDocument | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Export Template entity - api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_export_templates: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_export_template_patch_document = gooddata_api_client.JsonApiExportTemplatePatchDocument() # JsonApiExportTemplatePatchDocument | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Export Template entity api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -13621,7 +11130,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -13631,7 +11139,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_filter_contexts** -> JsonApiFilterContextOutDocument patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) +> JsonApiFilterContextOutDocument patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, filter=filter, include=include) Patch a Context Filter @@ -13639,12 +11147,12 @@ Patch a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -13653,59 +11161,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_context_patch_document = JsonApiFilterContextPatchDocument( - data=JsonApiFilterContextPatch( - attributes=JsonApiAnalyticalDashboardPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextPatchDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Context Filter - api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_context_patch_document = gooddata_api_client.JsonApiFilterContextPatchDocument() # JsonApiFilterContextPatchDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Context Filter api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_context_patch_document** | [**JsonApiFilterContextPatchDocument**](JsonApiFilterContextPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_context_patch_document** | [**JsonApiFilterContextPatchDocument**](JsonApiFilterContextPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -13720,7 +11205,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -13730,7 +11214,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_filter_views** -> JsonApiFilterViewOutDocument patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) +> JsonApiFilterViewOutDocument patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, filter=filter, include=include) Patch Filter view @@ -13738,12 +11222,12 @@ Patch Filter view ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -13752,68 +11236,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_view_patch_document = JsonApiFilterViewPatchDocument( - data=JsonApiFilterViewPatch( - attributes=JsonApiFilterViewPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewPatchDocument | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Filter view - api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_view_patch_document = gooddata_api_client.JsonApiFilterViewPatchDocument() # JsonApiFilterViewPatchDocument | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Filter view api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_view_patch_document** | [**JsonApiFilterViewPatchDocument**](JsonApiFilterViewPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_view_patch_document** | [**JsonApiFilterViewPatchDocument**](JsonApiFilterViewPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -13828,7 +11280,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -13838,7 +11289,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_identity_providers** -> JsonApiIdentityProviderOutDocument patch_entity_identity_providers(id, json_api_identity_provider_patch_document) +> JsonApiIdentityProviderOutDocument patch_entity_identity_providers(id, json_api_identity_provider_patch_document, filter=filter) Patch Identity Provider @@ -13846,12 +11297,12 @@ Patch Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -13860,63 +11311,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_identity_provider_patch_document = JsonApiIdentityProviderPatchDocument( - data=JsonApiIdentityProviderPatch( - attributes=JsonApiIdentityProviderInAttributes( - custom_claim_mapping={ - "key": "key_example", - }, - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - id="id1", - type="identityProvider", - ), - ) # JsonApiIdentityProviderPatchDocument | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Identity Provider - api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_identity_providers: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_identity_provider_patch_document = gooddata_api_client.JsonApiIdentityProviderPatchDocument() # JsonApiIdentityProviderPatchDocument | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Identity Provider api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_identity_provider_patch_document** | [**JsonApiIdentityProviderPatchDocument**](JsonApiIdentityProviderPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_identity_provider_patch_document** | [**JsonApiIdentityProviderPatchDocument**](JsonApiIdentityProviderPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -13931,7 +11351,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -13941,7 +11360,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_jwks** -> JsonApiJwkOutDocument patch_entity_jwks(id, json_api_jwk_patch_document) +> JsonApiJwkOutDocument patch_entity_jwks(id, json_api_jwk_patch_document, filter=filter) Patch Jwk @@ -13951,12 +11370,12 @@ Patches JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -13965,47 +11384,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_jwk_patch_document = JsonApiJwkPatchDocument( - data=JsonApiJwkPatch( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), - ), - id="id1", - type="jwk", - ), - ) # JsonApiJwkPatchDocument | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Jwk - api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_jwks: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_jwk_patch_document = gooddata_api_client.JsonApiJwkPatchDocument() # JsonApiJwkPatchDocument | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Jwk api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_jwk_patch_document** | [**JsonApiJwkPatchDocument**](JsonApiJwkPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_jwk_patch_document** | [**JsonApiJwkPatchDocument**](JsonApiJwkPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -14020,7 +11424,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -14030,7 +11433,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_llm_endpoints** -> JsonApiLlmEndpointOutDocument patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document) +> JsonApiLlmEndpointOutDocument patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document, filter=filter) Patch LLM endpoint entity @@ -14038,12 +11441,12 @@ Patch LLM endpoint entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument -from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -14052,52 +11455,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_llm_endpoint_patch_document = JsonApiLlmEndpointPatchDocument( - data=JsonApiLlmEndpointPatch( - attributes=JsonApiLlmEndpointPatchAttributes( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="OPENAI", - title="title_example", - token="token_example", - ), - id="id1", - type="llmEndpoint", - ), - ) # JsonApiLlmEndpointPatchDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch LLM endpoint entity - api_response = api_instance.patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_llm_endpoints: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_llm_endpoint_patch_document = gooddata_api_client.JsonApiLlmEndpointPatchDocument() # JsonApiLlmEndpointPatchDocument | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch LLM endpoint entity api_response = api_instance.patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_llm_endpoint_patch_document** | [**JsonApiLlmEndpointPatchDocument**](JsonApiLlmEndpointPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_llm_endpoint_patch_document** | [**JsonApiLlmEndpointPatchDocument**](JsonApiLlmEndpointPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -14112,7 +11495,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -14122,7 +11504,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_metrics** -> JsonApiMetricOutDocument patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) +> JsonApiMetricOutDocument patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, filter=filter, include=include) Patch a Metric @@ -14130,12 +11512,12 @@ Patch a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -14144,63 +11526,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_metric_patch_document = JsonApiMetricPatchDocument( - data=JsonApiMetricPatch( - attributes=JsonApiMetricPatchAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - ), - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="metric", - ), - ) # JsonApiMetricPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Metric - api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_metric_patch_document = gooddata_api_client.JsonApiMetricPatchDocument() # JsonApiMetricPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Metric api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_metric_patch_document** | [**JsonApiMetricPatchDocument**](JsonApiMetricPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_metric_patch_document** | [**JsonApiMetricPatchDocument**](JsonApiMetricPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -14215,7 +11570,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -14225,7 +11579,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_notification_channels** -> JsonApiNotificationChannelOutDocument patch_entity_notification_channels(id, json_api_notification_channel_patch_document) +> JsonApiNotificationChannelOutDocument patch_entity_notification_channels(id, json_api_notification_channel_patch_document, filter=filter) Patch Notification Channel entity @@ -14233,12 +11587,12 @@ Patch Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument -from gooddata_api_client.model.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -14247,54 +11601,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_notification_channel_patch_document = JsonApiNotificationChannelPatchDocument( - data=JsonApiNotificationChannelPatch( - attributes=JsonApiNotificationChannelInAttributes( - allowed_recipients="CREATOR", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="HIDDEN", - description="description_example", - destination=JsonApiNotificationChannelInAttributesDestination(None), - in_platform_notification="DISABLED", - name="name_example", - notification_source="notification_source_example", - ), - id="id1", - type="notificationChannel", - ), - ) # JsonApiNotificationChannelPatchDocument | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Notification Channel entity - api_response = api_instance.patch_entity_notification_channels(id, json_api_notification_channel_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_notification_channels: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_notification_channel_patch_document = gooddata_api_client.JsonApiNotificationChannelPatchDocument() # JsonApiNotificationChannelPatchDocument | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Notification Channel entity api_response = api_instance.patch_entity_notification_channels(id, json_api_notification_channel_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_notification_channel_patch_document** | [**JsonApiNotificationChannelPatchDocument**](JsonApiNotificationChannelPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_notification_channel_patch_document** | [**JsonApiNotificationChannelPatchDocument**](JsonApiNotificationChannelPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -14309,7 +11641,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -14319,7 +11650,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_organization_settings** -> JsonApiOrganizationSettingOutDocument patch_entity_organization_settings(id, json_api_organization_setting_patch_document) +> JsonApiOrganizationSettingOutDocument patch_entity_organization_settings(id, json_api_organization_setting_patch_document, filter=filter) Patch Organization entity @@ -14327,12 +11658,12 @@ Patch Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -14341,48 +11672,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_setting_patch_document = JsonApiOrganizationSettingPatchDocument( - data=JsonApiOrganizationSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="organizationSetting", - ), - ) # JsonApiOrganizationSettingPatchDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Organization entity - api_response = api_instance.patch_entity_organization_settings(id, json_api_organization_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_organization_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_organization_setting_patch_document = gooddata_api_client.JsonApiOrganizationSettingPatchDocument() # JsonApiOrganizationSettingPatchDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Organization entity api_response = api_instance.patch_entity_organization_settings(id, json_api_organization_setting_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_setting_patch_document** | [**JsonApiOrganizationSettingPatchDocument**](JsonApiOrganizationSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_organization_setting_patch_document** | [**JsonApiOrganizationSettingPatchDocument**](JsonApiOrganizationSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -14397,7 +11712,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -14407,7 +11721,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_organizations** -> JsonApiOrganizationOutDocument patch_entity_organizations(id, json_api_organization_patch_document) +> JsonApiOrganizationOutDocument patch_entity_organizations(id, json_api_organization_patch_document, filter=filter, include=include) Patch Organization @@ -14415,12 +11729,12 @@ Patch Organization ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -14429,75 +11743,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_patch_document = JsonApiOrganizationPatchDocument( - data=JsonApiOrganizationPatch( - attributes=JsonApiOrganizationInAttributes( - allowed_origins=[ - "allowed_origins_example", - ], - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - hostname="hostname_example", - name="name_example", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - ), - id="id1", - relationships=JsonApiOrganizationInRelationships( - identity_provider=JsonApiOrganizationInRelationshipsIdentityProvider( - data=JsonApiIdentityProviderToOneLinkage(None), - ), - ), - type="organization", - ), - ) # JsonApiOrganizationPatchDocument | - filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "bootstrapUser,bootstrapUserGroup,identityProvider", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Organization - api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_organizations: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_organization_patch_document = gooddata_api_client.JsonApiOrganizationPatchDocument() # JsonApiOrganizationPatchDocument | + filter = 'name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['bootstrapUser,bootstrapUserGroup,identityProvider'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Organization api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_organizations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_organizations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_patch_document** | [**JsonApiOrganizationPatchDocument**](JsonApiOrganizationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_organization_patch_document** | [**JsonApiOrganizationPatchDocument**](JsonApiOrganizationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -14512,7 +11785,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -14522,7 +11794,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_themes** -> JsonApiThemeOutDocument patch_entity_themes(id, json_api_theme_patch_document) +> JsonApiThemeOutDocument patch_entity_themes(id, json_api_theme_patch_document, filter=filter) Patch Theming @@ -14530,12 +11802,12 @@ Patch Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -14544,48 +11816,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_theme_patch_document = JsonApiThemePatchDocument( - data=JsonApiThemePatch( - attributes=JsonApiColorPalettePatchAttributes( - content={}, - name="name_example", - ), - id="id1", - type="theme", - ), - ) # JsonApiThemePatchDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Theming - api_response = api_instance.patch_entity_themes(id, json_api_theme_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_themes: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_theme_patch_document = gooddata_api_client.JsonApiThemePatchDocument() # JsonApiThemePatchDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Theming api_response = api_instance.patch_entity_themes(id, json_api_theme_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_theme_patch_document** | [**JsonApiThemePatchDocument**](JsonApiThemePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_theme_patch_document** | [**JsonApiThemePatchDocument**](JsonApiThemePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -14600,7 +11856,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -14610,7 +11865,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document) +> JsonApiUserDataFilterOutDocument patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, filter=filter, include=include) Patch a User Data Filter @@ -14618,12 +11873,12 @@ Patch a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -14632,67 +11887,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_user_data_filter_patch_document = JsonApiUserDataFilterPatchDocument( - data=JsonApiUserDataFilterPatch( - attributes=JsonApiUserDataFilterPatchAttributes( - are_relations_valid=True, - description="description_example", - maql="maql_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", - ), - ) # JsonApiUserDataFilterPatchDocument | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a User Data Filter - api_response = api_instance.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_user_data_filter_patch_document = gooddata_api_client.JsonApiUserDataFilterPatchDocument() # JsonApiUserDataFilterPatchDocument | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a User Data Filter api_response = api_instance.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_user_data_filter_patch_document** | [**JsonApiUserDataFilterPatchDocument**](JsonApiUserDataFilterPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_user_data_filter_patch_document** | [**JsonApiUserDataFilterPatchDocument**](JsonApiUserDataFilterPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -14707,7 +11931,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -14717,7 +11940,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_user_groups** -> JsonApiUserGroupOutDocument patch_entity_user_groups(id, json_api_user_group_patch_document) +> JsonApiUserGroupOutDocument patch_entity_user_groups(id, json_api_user_group_patch_document, filter=filter, include=include) Patch UserGroup entity @@ -14727,12 +11950,12 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -14741,61 +11964,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_group_patch_document = JsonApiUserGroupPatchDocument( - data=JsonApiUserGroupPatch( - attributes=JsonApiUserGroupInAttributes( - name="name_example", - ), - id="id1", - relationships=JsonApiUserGroupInRelationships( - parents=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="userGroup", - ), - ) # JsonApiUserGroupPatchDocument | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch UserGroup entity - api_response = api_instance.patch_entity_user_groups(id, json_api_user_group_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_user_group_patch_document = gooddata_api_client.JsonApiUserGroupPatchDocument() # JsonApiUserGroupPatchDocument | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch UserGroup entity api_response = api_instance.patch_entity_user_groups(id, json_api_user_group_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_group_patch_document** | [**JsonApiUserGroupPatchDocument**](JsonApiUserGroupPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_group_patch_document** | [**JsonApiUserGroupPatchDocument**](JsonApiUserGroupPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -14810,7 +12006,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -14820,7 +12015,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_users** -> JsonApiUserOutDocument patch_entity_users(id, json_api_user_patch_document) +> JsonApiUserOutDocument patch_entity_users(id, json_api_user_patch_document, filter=filter, include=include) Patch User entity @@ -14830,12 +12025,12 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -14844,64 +12039,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_patch_document = JsonApiUserPatchDocument( - data=JsonApiUserPatch( - attributes=JsonApiUserInAttributes( - authentication_id="authentication_id_example", - email="email_example", - firstname="firstname_example", - lastname="lastname_example", - ), - id="id1", - relationships=JsonApiUserInRelationships( - user_groups=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="user", - ), - ) # JsonApiUserPatchDocument | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch User entity - api_response = api_instance.patch_entity_users(id, json_api_user_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_users: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_user_patch_document = gooddata_api_client.JsonApiUserPatchDocument() # JsonApiUserPatchDocument | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch User entity api_response = api_instance.patch_entity_users(id, json_api_user_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_patch_document** | [**JsonApiUserPatchDocument**](JsonApiUserPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_patch_document** | [**JsonApiUserPatchDocument**](JsonApiUserPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -14916,7 +12081,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -14926,7 +12090,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document) +> JsonApiVisualizationObjectOutDocument patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, filter=filter, include=include) Patch a Visualization Object @@ -14934,12 +12098,12 @@ Patch a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -14948,60 +12112,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_visualization_object_patch_document = JsonApiVisualizationObjectPatchDocument( - data=JsonApiVisualizationObjectPatch( - attributes=JsonApiVisualizationObjectPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", - ), - ) # JsonApiVisualizationObjectPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Visualization Object - api_response = api_instance.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_visualization_object_patch_document = gooddata_api_client.JsonApiVisualizationObjectPatchDocument() # JsonApiVisualizationObjectPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Visualization Object api_response = api_instance.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_visualization_object_patch_document** | [**JsonApiVisualizationObjectPatchDocument**](JsonApiVisualizationObjectPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_visualization_object_patch_document** | [**JsonApiVisualizationObjectPatchDocument**](JsonApiVisualizationObjectPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -15016,7 +12156,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -15026,7 +12165,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document) +> JsonApiWorkspaceDataFilterSettingOutDocument patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, filter=filter, include=include) Patch a Settings for Workspace Data Filter @@ -15034,12 +12173,12 @@ Patch a Settings for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -15048,62 +12187,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_setting_patch_document = JsonApiWorkspaceDataFilterSettingPatchDocument( - data=JsonApiWorkspaceDataFilterSettingPatch( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", - ), - ) # JsonApiWorkspaceDataFilterSettingPatchDocument | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Settings for Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_setting_patch_document = gooddata_api_client.JsonApiWorkspaceDataFilterSettingPatchDocument() # JsonApiWorkspaceDataFilterSettingPatchDocument | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Settings for Workspace Data Filter api_response = api_instance.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_setting_patch_document** | [**JsonApiWorkspaceDataFilterSettingPatchDocument**](JsonApiWorkspaceDataFilterSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_setting_patch_document** | [**JsonApiWorkspaceDataFilterSettingPatchDocument**](JsonApiWorkspaceDataFilterSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -15118,7 +12231,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -15128,7 +12240,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) +> JsonApiWorkspaceDataFilterOutDocument patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, filter=filter, include=include) Patch a Workspace Data Filter @@ -15136,12 +12248,12 @@ Patch a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -15150,65 +12262,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_patch_document = JsonApiWorkspaceDataFilterPatchDocument( - data=JsonApiWorkspaceDataFilterPatch( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), - ), - ), - type="workspaceDataFilter", - ), - ) # JsonApiWorkspaceDataFilterPatchDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_patch_document = gooddata_api_client.JsonApiWorkspaceDataFilterPatchDocument() # JsonApiWorkspaceDataFilterPatchDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Workspace Data Filter api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_patch_document** | [**JsonApiWorkspaceDataFilterPatchDocument**](JsonApiWorkspaceDataFilterPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_patch_document** | [**JsonApiWorkspaceDataFilterPatchDocument**](JsonApiWorkspaceDataFilterPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -15223,7 +12306,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -15233,7 +12315,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) +> JsonApiWorkspaceSettingOutDocument patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, filter=filter) Patch a Setting for Workspace @@ -15241,12 +12323,12 @@ Patch a Setting for Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -15255,50 +12337,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_setting_patch_document = JsonApiWorkspaceSettingPatchDocument( - data=JsonApiWorkspaceSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="workspaceSetting", - ), - ) # JsonApiWorkspaceSettingPatchDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Setting for Workspace - api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_setting_patch_document = gooddata_api_client.JsonApiWorkspaceSettingPatchDocument() # JsonApiWorkspaceSettingPatchDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Setting for Workspace api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, filter=filter) + print("The response of EntitiesApi->patch_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_setting_patch_document** | [**JsonApiWorkspaceSettingPatchDocument**](JsonApiWorkspaceSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_setting_patch_document** | [**JsonApiWorkspaceSettingPatchDocument**](JsonApiWorkspaceSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -15313,7 +12379,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -15323,7 +12388,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspaces** -> JsonApiWorkspaceOutDocument patch_entity_workspaces(id, json_api_workspace_patch_document) +> JsonApiWorkspaceOutDocument patch_entity_workspaces(id, json_api_workspace_patch_document, filter=filter, include=include) Patch Workspace entity @@ -15333,12 +12398,12 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -15347,69 +12412,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_workspace_patch_document = JsonApiWorkspacePatchDocument( - data=JsonApiWorkspacePatch( - attributes=JsonApiWorkspaceInAttributes( - cache_extra_limit=1, - data_source=JsonApiWorkspaceInAttributesDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - name="name_example", - prefix="/6bUUGjjNSwg0_bs", - ), - id="id1", - relationships=JsonApiWorkspaceInRelationships( - parent=JsonApiWorkspaceAutomationOutRelationshipsWorkspace( - data=JsonApiWorkspaceToOneLinkage(None), - ), - ), - type="workspace", - ), - ) # JsonApiWorkspacePatchDocument | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Workspace entity - api_response = api_instance.patch_entity_workspaces(id, json_api_workspace_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_workspace_patch_document = gooddata_api_client.JsonApiWorkspacePatchDocument() # JsonApiWorkspacePatchDocument | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Workspace entity api_response = api_instance.patch_entity_workspaces(id, json_api_workspace_patch_document, filter=filter, include=include) + print("The response of EntitiesApi->patch_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->patch_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_workspace_patch_document** | [**JsonApiWorkspacePatchDocument**](JsonApiWorkspacePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_workspace_patch_document** | [**JsonApiWorkspacePatchDocument**](JsonApiWorkspacePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -15424,7 +12454,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -15434,7 +12463,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document) +> JsonApiAnalyticalDashboardOutDocument update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, filter=filter, include=include) Put Dashboards @@ -15442,12 +12471,12 @@ Put Dashboards ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -15456,59 +12485,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_analytical_dashboard_in_document = JsonApiAnalyticalDashboardInDocument( - data=JsonApiAnalyticalDashboardIn( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Dashboards - api_response = api_instance.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_analytical_dashboard_in_document = gooddata_api_client.JsonApiAnalyticalDashboardInDocument() # JsonApiAnalyticalDashboardInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Dashboards api_response = api_instance.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_analytical_dashboard_in_document** | [**JsonApiAnalyticalDashboardInDocument**](JsonApiAnalyticalDashboardInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_analytical_dashboard_in_document** | [**JsonApiAnalyticalDashboardInDocument**](JsonApiAnalyticalDashboardInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -15523,7 +12529,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -15533,7 +12538,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document) +> JsonApiAttributeHierarchyOutDocument update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, filter=filter, include=include) Put an Attribute Hierarchy @@ -15541,12 +12546,12 @@ Put an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -15555,59 +12560,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_attribute_hierarchy_in_document = JsonApiAttributeHierarchyInDocument( - data=JsonApiAttributeHierarchyIn( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Attribute Hierarchy - api_response = api_instance.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_attribute_hierarchy_in_document = gooddata_api_client.JsonApiAttributeHierarchyInDocument() # JsonApiAttributeHierarchyInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put an Attribute Hierarchy api_response = api_instance.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -15622,7 +12604,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -15632,7 +12613,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_automations** -> JsonApiAutomationOutDocument update_entity_automations(workspace_id, object_id, json_api_automation_in_document) +> JsonApiAutomationOutDocument update_entity_automations(workspace_id, object_id, json_api_automation_in_document, filter=filter, include=include) Put an Automation @@ -15640,12 +12621,12 @@ Put an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -15654,301 +12635,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_automation_in_document = JsonApiAutomationInDocument( - data=JsonApiAutomationIn( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationInDocument | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Automation - api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_automation_in_document = gooddata_api_client.JsonApiAutomationInDocument() # JsonApiAutomationInDocument | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put an Automation api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -15963,7 +12679,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -15973,7 +12688,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_color_palettes** -> JsonApiColorPaletteOutDocument update_entity_color_palettes(id, json_api_color_palette_in_document) +> JsonApiColorPaletteOutDocument update_entity_color_palettes(id, json_api_color_palette_in_document, filter=filter) Put Color Pallette @@ -15981,12 +12696,12 @@ Put Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -15995,48 +12710,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_color_palette_in_document = JsonApiColorPaletteInDocument( - data=JsonApiColorPaletteIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="colorPalette", - ), - ) # JsonApiColorPaletteInDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Color Pallette - api_response = api_instance.update_entity_color_palettes(id, json_api_color_palette_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_color_palettes: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_color_palette_in_document = gooddata_api_client.JsonApiColorPaletteInDocument() # JsonApiColorPaletteInDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Color Pallette api_response = api_instance.update_entity_color_palettes(id, json_api_color_palette_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -16051,7 +12750,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -16061,7 +12759,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document) +> JsonApiCookieSecurityConfigurationOutDocument update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, filter=filter) Put CookieSecurityConfiguration @@ -16069,12 +12767,12 @@ Put CookieSecurityConfiguration ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -16083,48 +12781,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_cookie_security_configuration_in_document = JsonApiCookieSecurityConfigurationInDocument( - data=JsonApiCookieSecurityConfigurationIn( - attributes=JsonApiCookieSecurityConfigurationInAttributes( - last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), - rotation_interval="P30D", - ), - id="id1", - type="cookieSecurityConfiguration", - ), - ) # JsonApiCookieSecurityConfigurationInDocument | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put CookieSecurityConfiguration - api_response = api_instance.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_cookie_security_configurations: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_cookie_security_configuration_in_document = gooddata_api_client.JsonApiCookieSecurityConfigurationInDocument() # JsonApiCookieSecurityConfigurationInDocument | + filter = 'lastRotation==InstantValue;rotationInterval==DurationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put CookieSecurityConfiguration api_response = api_instance.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_cookie_security_configurations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_cookie_security_configurations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_cookie_security_configuration_in_document** | [**JsonApiCookieSecurityConfigurationInDocument**](JsonApiCookieSecurityConfigurationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_cookie_security_configuration_in_document** | [**JsonApiCookieSecurityConfigurationInDocument**](JsonApiCookieSecurityConfigurationInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -16139,7 +12821,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -16149,7 +12830,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_csp_directives** -> JsonApiCspDirectiveOutDocument update_entity_csp_directives(id, json_api_csp_directive_in_document) +> JsonApiCspDirectiveOutDocument update_entity_csp_directives(id, json_api_csp_directive_in_document, filter=filter) Put CSP Directives @@ -16159,12 +12840,12 @@ Put CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -16173,49 +12854,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_csp_directive_in_document = JsonApiCspDirectiveInDocument( - data=JsonApiCspDirectiveIn( - attributes=JsonApiCspDirectiveInAttributes( - sources=[ - "sources_example", - ], - ), - id="id1", - type="cspDirective", - ), - ) # JsonApiCspDirectiveInDocument | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put CSP Directives - api_response = api_instance.update_entity_csp_directives(id, json_api_csp_directive_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_csp_directives: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_csp_directive_in_document = gooddata_api_client.JsonApiCspDirectiveInDocument() # JsonApiCspDirectiveInDocument | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put CSP Directives api_response = api_instance.update_entity_csp_directives(id, json_api_csp_directive_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -16230,7 +12894,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -16240,7 +12903,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document) +> JsonApiCustomApplicationSettingOutDocument update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, filter=filter) Put a Custom Application Setting @@ -16248,12 +12911,12 @@ Put a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -16262,50 +12925,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_custom_application_setting_in_document = JsonApiCustomApplicationSettingInDocument( - data=JsonApiCustomApplicationSettingIn( - attributes=JsonApiCustomApplicationSettingInAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingInDocument | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Custom Application Setting - api_response = api_instance.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_custom_application_setting_in_document = gooddata_api_client.JsonApiCustomApplicationSettingInDocument() # JsonApiCustomApplicationSettingInDocument | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Custom Application Setting api_response = api_instance.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_custom_application_setting_in_document** | [**JsonApiCustomApplicationSettingInDocument**](JsonApiCustomApplicationSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_custom_application_setting_in_document** | [**JsonApiCustomApplicationSettingInDocument**](JsonApiCustomApplicationSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -16320,7 +12967,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -16330,7 +12976,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) +> JsonApiDashboardPluginOutDocument update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, filter=filter, include=include) Put a Plugin @@ -16338,12 +12984,12 @@ Put a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -16352,59 +12998,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_dashboard_plugin_in_document = JsonApiDashboardPluginInDocument( - data=JsonApiDashboardPluginIn( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Plugin - api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_dashboard_plugin_in_document = gooddata_api_client.JsonApiDashboardPluginInDocument() # JsonApiDashboardPluginInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Plugin api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_dashboard_plugin_in_document** | [**JsonApiDashboardPluginInDocument**](JsonApiDashboardPluginInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_dashboard_plugin_in_document** | [**JsonApiDashboardPluginInDocument**](JsonApiDashboardPluginInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -16419,7 +13042,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -16429,7 +13051,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_data_sources** -> JsonApiDataSourceOutDocument update_entity_data_sources(id, json_api_data_source_in_document) +> JsonApiDataSourceOutDocument update_entity_data_sources(id, json_api_data_source_in_document, filter=filter) Put Data Source entity @@ -16439,12 +13061,12 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -16453,64 +13075,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_data_source_in_document = JsonApiDataSourceInDocument( - data=JsonApiDataSourceIn( - attributes=JsonApiDataSourceInAttributes( - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourceInDocument | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Data Source entity - api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_data_source_in_document = gooddata_api_client.JsonApiDataSourceInDocument() # JsonApiDataSourceInDocument | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Data Source entity api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -16525,7 +13115,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -16535,7 +13124,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_export_definitions** -> JsonApiExportDefinitionOutDocument update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document) +> JsonApiExportDefinitionOutDocument update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, filter=filter, include=include) Put an Export Definition @@ -16543,12 +13132,12 @@ Put an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.models.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -16557,67 +13146,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_export_definition_in_document = JsonApiExportDefinitionInDocument( - data=JsonApiExportDefinitionIn( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionInDocument | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Export Definition - api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_export_definition_in_document = gooddata_api_client.JsonApiExportDefinitionInDocument() # JsonApiExportDefinitionInDocument | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put an Export Definition api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_export_definition_in_document** | [**JsonApiExportDefinitionInDocument**](JsonApiExportDefinitionInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_export_definition_in_document** | [**JsonApiExportDefinitionInDocument**](JsonApiExportDefinitionInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -16632,7 +13190,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -16642,7 +13199,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_export_templates** -> JsonApiExportTemplateOutDocument update_entity_export_templates(id, json_api_export_template_in_document) +> JsonApiExportTemplateOutDocument update_entity_export_templates(id, json_api_export_template_in_document, filter=filter) PUT Export Template entity @@ -16650,12 +13207,12 @@ PUT Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -16664,114 +13221,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_export_template_in_document = JsonApiExportTemplateInDocument( - data=JsonApiExportTemplateIn( - attributes=JsonApiExportTemplateInAttributes( - dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - name="name_example", - widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - id="id1", - type="exportTemplate", - ), - ) # JsonApiExportTemplateInDocument | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # PUT Export Template entity - api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_export_templates: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_export_template_in_document = gooddata_api_client.JsonApiExportTemplateInDocument() # JsonApiExportTemplateInDocument | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # PUT Export Template entity api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_export_template_in_document** | [**JsonApiExportTemplateInDocument**](JsonApiExportTemplateInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_export_template_in_document** | [**JsonApiExportTemplateInDocument**](JsonApiExportTemplateInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -16786,7 +13261,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -16796,7 +13270,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_filter_contexts** -> JsonApiFilterContextOutDocument update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document) +> JsonApiFilterContextOutDocument update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, filter=filter, include=include) Put a Context Filter @@ -16804,12 +13278,12 @@ Put a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -16818,59 +13292,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_context_in_document = JsonApiFilterContextInDocument( - data=JsonApiFilterContextIn( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextInDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Context Filter - api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_context_in_document = gooddata_api_client.JsonApiFilterContextInDocument() # JsonApiFilterContextInDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Context Filter api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_context_in_document** | [**JsonApiFilterContextInDocument**](JsonApiFilterContextInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_context_in_document** | [**JsonApiFilterContextInDocument**](JsonApiFilterContextInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -16885,7 +13336,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -16895,7 +13345,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_filter_views** -> JsonApiFilterViewOutDocument update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document) +> JsonApiFilterViewOutDocument update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, filter=filter, include=include) Put Filter views @@ -16903,12 +13353,12 @@ Put Filter views ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -16917,68 +13367,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_view_in_document = JsonApiFilterViewInDocument( - data=JsonApiFilterViewIn( - attributes=JsonApiFilterViewInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewInDocument | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Filter views - api_response = api_instance.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_view_in_document = gooddata_api_client.JsonApiFilterViewInDocument() # JsonApiFilterViewInDocument | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Filter views api_response = api_instance.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -16993,7 +13411,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -17003,7 +13420,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_identity_providers** -> JsonApiIdentityProviderOutDocument update_entity_identity_providers(id, json_api_identity_provider_in_document) +> JsonApiIdentityProviderOutDocument update_entity_identity_providers(id, json_api_identity_provider_in_document, filter=filter) Put Identity Provider @@ -17011,12 +13428,12 @@ Put Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -17025,63 +13442,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_identity_provider_in_document = JsonApiIdentityProviderInDocument( - data=JsonApiIdentityProviderIn( - attributes=JsonApiIdentityProviderInAttributes( - custom_claim_mapping={ - "key": "key_example", - }, - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - id="id1", - type="identityProvider", - ), - ) # JsonApiIdentityProviderInDocument | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Identity Provider - api_response = api_instance.update_entity_identity_providers(id, json_api_identity_provider_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_identity_providers: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_identity_provider_in_document = gooddata_api_client.JsonApiIdentityProviderInDocument() # JsonApiIdentityProviderInDocument | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Identity Provider api_response = api_instance.update_entity_identity_providers(id, json_api_identity_provider_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -17096,7 +13482,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -17106,7 +13491,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_jwks** -> JsonApiJwkOutDocument update_entity_jwks(id, json_api_jwk_in_document) +> JsonApiJwkOutDocument update_entity_jwks(id, json_api_jwk_in_document, filter=filter) Put Jwk @@ -17116,12 +13501,12 @@ Updates JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -17130,47 +13515,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_jwk_in_document = JsonApiJwkInDocument( - data=JsonApiJwkIn( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), - ), - id="id1", - type="jwk", - ), - ) # JsonApiJwkInDocument | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Jwk - api_response = api_instance.update_entity_jwks(id, json_api_jwk_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_jwks: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_jwk_in_document = gooddata_api_client.JsonApiJwkInDocument() # JsonApiJwkInDocument | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Jwk api_response = api_instance.update_entity_jwks(id, json_api_jwk_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -17185,7 +13555,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -17195,7 +13564,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_llm_endpoints** -> JsonApiLlmEndpointOutDocument update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document) +> JsonApiLlmEndpointOutDocument update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document, filter=filter) PUT LLM endpoint entity @@ -17203,12 +13572,12 @@ PUT LLM endpoint entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -17217,52 +13586,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_llm_endpoint_in_document = JsonApiLlmEndpointInDocument( - data=JsonApiLlmEndpointIn( - attributes=JsonApiLlmEndpointInAttributes( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="OPENAI", - title="title_example", - token="token_example", - ), - id="id1", - type="llmEndpoint", - ), - ) # JsonApiLlmEndpointInDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # PUT LLM endpoint entity - api_response = api_instance.update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_llm_endpoints: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_llm_endpoint_in_document = gooddata_api_client.JsonApiLlmEndpointInDocument() # JsonApiLlmEndpointInDocument | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # PUT LLM endpoint entity api_response = api_instance.update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -17277,7 +13626,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -17287,7 +13635,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_metrics** -> JsonApiMetricOutDocument update_entity_metrics(workspace_id, object_id, json_api_metric_in_document) +> JsonApiMetricOutDocument update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, filter=filter, include=include) Put a Metric @@ -17295,12 +13643,12 @@ Put a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -17309,63 +13657,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_metric_in_document = JsonApiMetricInDocument( - data=JsonApiMetricIn( - attributes=JsonApiMetricInAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - ), - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="metric", - ), - ) # JsonApiMetricInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Metric - api_response = api_instance.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_metric_in_document = gooddata_api_client.JsonApiMetricInDocument() # JsonApiMetricInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Metric api_response = api_instance.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_metric_in_document** | [**JsonApiMetricInDocument**](JsonApiMetricInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_metric_in_document** | [**JsonApiMetricInDocument**](JsonApiMetricInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -17380,7 +13701,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -17390,7 +13710,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_notification_channels** -> JsonApiNotificationChannelOutDocument update_entity_notification_channels(id, json_api_notification_channel_in_document) +> JsonApiNotificationChannelOutDocument update_entity_notification_channels(id, json_api_notification_channel_in_document, filter=filter) Put Notification Channel entity @@ -17398,12 +13718,12 @@ Put Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -17412,54 +13732,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_notification_channel_in_document = JsonApiNotificationChannelInDocument( - data=JsonApiNotificationChannelIn( - attributes=JsonApiNotificationChannelInAttributes( - allowed_recipients="CREATOR", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="HIDDEN", - description="description_example", - destination=JsonApiNotificationChannelInAttributesDestination(None), - in_platform_notification="DISABLED", - name="name_example", - notification_source="notification_source_example", - ), - id="id1", - type="notificationChannel", - ), - ) # JsonApiNotificationChannelInDocument | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Notification Channel entity - api_response = api_instance.update_entity_notification_channels(id, json_api_notification_channel_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_notification_channels: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_notification_channel_in_document = gooddata_api_client.JsonApiNotificationChannelInDocument() # JsonApiNotificationChannelInDocument | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Notification Channel entity api_response = api_instance.update_entity_notification_channels(id, json_api_notification_channel_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_notification_channel_in_document** | [**JsonApiNotificationChannelInDocument**](JsonApiNotificationChannelInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_notification_channel_in_document** | [**JsonApiNotificationChannelInDocument**](JsonApiNotificationChannelInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -17474,7 +13772,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -17484,7 +13781,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_organization_settings** -> JsonApiOrganizationSettingOutDocument update_entity_organization_settings(id, json_api_organization_setting_in_document) +> JsonApiOrganizationSettingOutDocument update_entity_organization_settings(id, json_api_organization_setting_in_document, filter=filter) Put Organization entity @@ -17492,12 +13789,12 @@ Put Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -17506,48 +13803,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_setting_in_document = JsonApiOrganizationSettingInDocument( - data=JsonApiOrganizationSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="organizationSetting", - ), - ) # JsonApiOrganizationSettingInDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Organization entity - api_response = api_instance.update_entity_organization_settings(id, json_api_organization_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_organization_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_organization_setting_in_document = gooddata_api_client.JsonApiOrganizationSettingInDocument() # JsonApiOrganizationSettingInDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Organization entity api_response = api_instance.update_entity_organization_settings(id, json_api_organization_setting_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -17562,7 +13843,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -17572,7 +13852,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_organizations** -> JsonApiOrganizationOutDocument update_entity_organizations(id, json_api_organization_in_document) +> JsonApiOrganizationOutDocument update_entity_organizations(id, json_api_organization_in_document, filter=filter, include=include) Put Organization @@ -17580,12 +13860,12 @@ Put Organization ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -17594,75 +13874,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_in_document = JsonApiOrganizationInDocument( - data=JsonApiOrganizationIn( - attributes=JsonApiOrganizationInAttributes( - allowed_origins=[ - "allowed_origins_example", - ], - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - hostname="hostname_example", - name="name_example", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - ), - id="id1", - relationships=JsonApiOrganizationInRelationships( - identity_provider=JsonApiOrganizationInRelationshipsIdentityProvider( - data=JsonApiIdentityProviderToOneLinkage(None), - ), - ), - type="organization", - ), - ) # JsonApiOrganizationInDocument | - filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "bootstrapUser,bootstrapUserGroup,identityProvider", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Organization - api_response = api_instance.update_entity_organizations(id, json_api_organization_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_organizations: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_organization_in_document = gooddata_api_client.JsonApiOrganizationInDocument() # JsonApiOrganizationInDocument | + filter = 'name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['bootstrapUser,bootstrapUserGroup,identityProvider'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Organization api_response = api_instance.update_entity_organizations(id, json_api_organization_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_organizations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_organizations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_in_document** | [**JsonApiOrganizationInDocument**](JsonApiOrganizationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_organization_in_document** | [**JsonApiOrganizationInDocument**](JsonApiOrganizationInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -17677,7 +13916,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -17687,7 +13925,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_themes** -> JsonApiThemeOutDocument update_entity_themes(id, json_api_theme_in_document) +> JsonApiThemeOutDocument update_entity_themes(id, json_api_theme_in_document, filter=filter) Put Theming @@ -17695,12 +13933,12 @@ Put Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -17709,48 +13947,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_theme_in_document = JsonApiThemeInDocument( - data=JsonApiThemeIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="theme", - ), - ) # JsonApiThemeInDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Theming - api_response = api_instance.update_entity_themes(id, json_api_theme_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_themes: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_theme_in_document = gooddata_api_client.JsonApiThemeInDocument() # JsonApiThemeInDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Theming api_response = api_instance.update_entity_themes(id, json_api_theme_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -17765,7 +13987,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -17775,7 +13996,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document) +> JsonApiUserDataFilterOutDocument update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, filter=filter, include=include) Put a User Data Filter @@ -17783,12 +14004,12 @@ Put a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -17797,67 +14018,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_user_data_filter_in_document = JsonApiUserDataFilterInDocument( - data=JsonApiUserDataFilterIn( - attributes=JsonApiUserDataFilterInAttributes( - are_relations_valid=True, - description="description_example", - maql="maql_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", - ), - ) # JsonApiUserDataFilterInDocument | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a User Data Filter - api_response = api_instance.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_user_data_filter_in_document = gooddata_api_client.JsonApiUserDataFilterInDocument() # JsonApiUserDataFilterInDocument | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a User Data Filter api_response = api_instance.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_user_data_filter_in_document** | [**JsonApiUserDataFilterInDocument**](JsonApiUserDataFilterInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_user_data_filter_in_document** | [**JsonApiUserDataFilterInDocument**](JsonApiUserDataFilterInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -17872,7 +14062,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -17882,7 +14071,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_user_groups** -> JsonApiUserGroupOutDocument update_entity_user_groups(id, json_api_user_group_in_document) +> JsonApiUserGroupOutDocument update_entity_user_groups(id, json_api_user_group_in_document, filter=filter, include=include) Put UserGroup entity @@ -17892,12 +14081,12 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -17906,61 +14095,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_group_in_document = JsonApiUserGroupInDocument( - data=JsonApiUserGroupIn( - attributes=JsonApiUserGroupInAttributes( - name="name_example", - ), - id="id1", - relationships=JsonApiUserGroupInRelationships( - parents=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="userGroup", - ), - ) # JsonApiUserGroupInDocument | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put UserGroup entity - api_response = api_instance.update_entity_user_groups(id, json_api_user_group_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_user_group_in_document = gooddata_api_client.JsonApiUserGroupInDocument() # JsonApiUserGroupInDocument | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put UserGroup entity api_response = api_instance.update_entity_user_groups(id, json_api_user_group_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -17975,7 +14137,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -17985,7 +14146,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_user_settings** -> JsonApiUserSettingOutDocument update_entity_user_settings(user_id, id, json_api_user_setting_in_document) +> JsonApiUserSettingOutDocument update_entity_user_settings(user_id, id, json_api_user_setting_in_document, filter=filter) Put new user settings for the user @@ -17993,12 +14154,12 @@ Put new user settings for the user ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -18007,50 +14168,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_setting_in_document = JsonApiUserSettingInDocument( - data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="userSetting", - ), - ) # JsonApiUserSettingInDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put new user settings for the user - api_response = api_instance.update_entity_user_settings(user_id, id, json_api_user_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_user_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + json_api_user_setting_in_document = gooddata_api_client.JsonApiUserSettingInDocument() # JsonApiUserSettingInDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put new user settings for the user api_response = api_instance.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -18065,7 +14210,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -18075,7 +14219,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_users** -> JsonApiUserOutDocument update_entity_users(id, json_api_user_in_document) +> JsonApiUserOutDocument update_entity_users(id, json_api_user_in_document, filter=filter, include=include) Put User entity @@ -18085,12 +14229,12 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -18099,64 +14243,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_in_document = JsonApiUserInDocument( - data=JsonApiUserIn( - attributes=JsonApiUserInAttributes( - authentication_id="authentication_id_example", - email="email_example", - firstname="firstname_example", - lastname="lastname_example", - ), - id="id1", - relationships=JsonApiUserInRelationships( - user_groups=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="user", - ), - ) # JsonApiUserInDocument | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put User entity - api_response = api_instance.update_entity_users(id, json_api_user_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_users: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_user_in_document = gooddata_api_client.JsonApiUserInDocument() # JsonApiUserInDocument | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put User entity api_response = api_instance.update_entity_users(id, json_api_user_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -18171,7 +14285,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -18181,7 +14294,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) +> JsonApiVisualizationObjectOutDocument update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, filter=filter, include=include) Put a Visualization Object @@ -18189,12 +14302,12 @@ Put a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -18203,60 +14316,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_visualization_object_in_document = JsonApiVisualizationObjectInDocument( - data=JsonApiVisualizationObjectIn( - attributes=JsonApiVisualizationObjectInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", - ), - ) # JsonApiVisualizationObjectInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Visualization Object - api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_visualization_object_in_document = gooddata_api_client.JsonApiVisualizationObjectInDocument() # JsonApiVisualizationObjectInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Visualization Object api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_visualization_object_in_document** | [**JsonApiVisualizationObjectInDocument**](JsonApiVisualizationObjectInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_visualization_object_in_document** | [**JsonApiVisualizationObjectInDocument**](JsonApiVisualizationObjectInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -18271,7 +14360,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -18281,7 +14369,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document) +> JsonApiWorkspaceDataFilterSettingOutDocument update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, filter=filter, include=include) Put a Settings for Workspace Data Filter @@ -18289,12 +14377,12 @@ Put a Settings for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -18303,62 +14391,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( - data=JsonApiWorkspaceDataFilterSettingIn( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", - ), - ) # JsonApiWorkspaceDataFilterSettingInDocument | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Settings for Workspace Data Filter - api_response = api_instance.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_setting_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterSettingInDocument() # JsonApiWorkspaceDataFilterSettingInDocument | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Settings for Workspace Data Filter api_response = api_instance.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -18373,7 +14435,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -18383,7 +14444,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document) +> JsonApiWorkspaceDataFilterOutDocument update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, filter=filter, include=include) Put a Workspace Data Filter @@ -18391,12 +14452,12 @@ Put a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -18405,65 +14466,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( - data=JsonApiWorkspaceDataFilterIn( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), - ), - ), - type="workspaceDataFilter", - ), - ) # JsonApiWorkspaceDataFilterInDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Workspace Data Filter - api_response = api_instance.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterInDocument() # JsonApiWorkspaceDataFilterInDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Workspace Data Filter api_response = api_instance.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -18478,7 +14510,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -18488,7 +14519,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document) +> JsonApiWorkspaceSettingOutDocument update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, filter=filter) Put a Setting for a Workspace @@ -18496,12 +14527,12 @@ Put a Setting for a Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -18510,50 +14541,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_setting_in_document = JsonApiWorkspaceSettingInDocument( - data=JsonApiWorkspaceSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="workspaceSetting", - ), - ) # JsonApiWorkspaceSettingInDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Setting for a Workspace - api_response = api_instance.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_setting_in_document = gooddata_api_client.JsonApiWorkspaceSettingInDocument() # JsonApiWorkspaceSettingInDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Setting for a Workspace api_response = api_instance.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, filter=filter) + print("The response of EntitiesApi->update_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_setting_in_document** | [**JsonApiWorkspaceSettingInDocument**](JsonApiWorkspaceSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_setting_in_document** | [**JsonApiWorkspaceSettingInDocument**](JsonApiWorkspaceSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -18568,7 +14583,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -18578,7 +14592,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspaces** -> JsonApiWorkspaceOutDocument update_entity_workspaces(id, json_api_workspace_in_document) +> JsonApiWorkspaceOutDocument update_entity_workspaces(id, json_api_workspace_in_document, filter=filter, include=include) Put Workspace entity @@ -18588,12 +14602,12 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -18602,69 +14616,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_workspace_in_document = JsonApiWorkspaceInDocument( - data=JsonApiWorkspaceIn( - attributes=JsonApiWorkspaceInAttributes( - cache_extra_limit=1, - data_source=JsonApiWorkspaceInAttributesDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - name="name_example", - prefix="/6bUUGjjNSwg0_bs", - ), - id="id1", - relationships=JsonApiWorkspaceInRelationships( - parent=JsonApiWorkspaceAutomationOutRelationshipsWorkspace( - data=JsonApiWorkspaceToOneLinkage(None), - ), - ), - type="workspace", - ), - ) # JsonApiWorkspaceInDocument | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Workspace entity - api_response = api_instance.update_entity_workspaces(id, json_api_workspace_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.EntitiesApi(api_client) + id = 'id_example' # str | + json_api_workspace_in_document = gooddata_api_client.JsonApiWorkspaceInDocument() # JsonApiWorkspaceInDocument | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Workspace entity api_response = api_instance.update_entity_workspaces(id, json_api_workspace_in_document, filter=filter, include=include) + print("The response of EntitiesApi->update_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitiesApi->update_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -18679,7 +14658,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/EntitlementApi.md b/gooddata-api-client/docs/EntitlementApi.md index 48a589137..270e95fb7 100644 --- a/gooddata-api-client/docs/EntitlementApi.md +++ b/gooddata-api-client/docs/EntitlementApi.md @@ -11,7 +11,7 @@ Method | HTTP request | Description # **get_all_entities_entitlements** -> JsonApiEntitlementOutList get_all_entities_entitlements() +> JsonApiEntitlementOutList get_all_entities_entitlements(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get Entitlements @@ -21,11 +21,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import entitlement_api -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -34,39 +34,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entitlement_api.EntitlementApi(api_client) - filter = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.EntitlementApi(api_client) + filter = 'value==someString;expiry==LocalDateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Entitlements api_response = api_instance.get_all_entities_entitlements(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of EntitlementApi->get_all_entities_entitlements:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitlementApi->get_all_entities_entitlements: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -81,7 +78,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -91,7 +87,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_entitlements** -> JsonApiEntitlementOutDocument get_entity_entitlements(id) +> JsonApiEntitlementOutDocument get_entity_entitlements(id, filter=filter) Get Entitlement @@ -101,11 +97,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import entitlement_api -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -114,37 +110,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entitlement_api.EntitlementApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.EntitlementApi(api_client) + id = 'id_example' # str | + filter = 'value==someString;expiry==LocalDateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Entitlement - api_response = api_instance.get_entity_entitlements(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitlementApi->get_entity_entitlements: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Entitlement api_response = api_instance.get_entity_entitlements(id, filter=filter) + print("The response of EntitlementApi->get_entity_entitlements:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitlementApi->get_entity_entitlements: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -159,7 +148,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -169,7 +157,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **resolve_all_entitlements** -> [ApiEntitlement] resolve_all_entitlements() +> List[ApiEntitlement] resolve_all_entitlements() Values for all public entitlements. @@ -179,11 +167,11 @@ Resolves values of available entitlements for the organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import entitlement_api -from gooddata_api_client.model.api_entitlement import ApiEntitlement +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -192,26 +180,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entitlement_api.EntitlementApi(api_client) + api_instance = gooddata_api_client.EntitlementApi(api_client) - # example, this endpoint has no required or optional parameters try: # Values for all public entitlements. api_response = api_instance.resolve_all_entitlements() + print("The response of EntitlementApi->resolve_all_entitlements:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitlementApi->resolve_all_entitlements: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -[**[ApiEntitlement]**](ApiEntitlement.md) +[**List[ApiEntitlement]**](ApiEntitlement.md) ### Authorization @@ -222,7 +212,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -232,7 +221,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **resolve_requested_entitlements** -> [ApiEntitlement] resolve_requested_entitlements(entitlements_request) +> List[ApiEntitlement] resolve_requested_entitlements(entitlements_request) Values for requested public entitlements. @@ -242,12 +231,12 @@ Resolves values for requested entitlements in the organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import entitlement_api -from gooddata_api_client.model.api_entitlement import ApiEntitlement -from gooddata_api_client.model.entitlements_request import EntitlementsRequest +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.models.entitlements_request import EntitlementsRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -256,34 +245,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = entitlement_api.EntitlementApi(api_client) - entitlements_request = EntitlementsRequest( - entitlements_name=[ - "CacheStrategy", - ], - ) # EntitlementsRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.EntitlementApi(api_client) + entitlements_request = gooddata_api_client.EntitlementsRequest() # EntitlementsRequest | + try: # Values for requested public entitlements. api_response = api_instance.resolve_requested_entitlements(entitlements_request) + print("The response of EntitlementApi->resolve_requested_entitlements:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling EntitlementApi->resolve_requested_entitlements: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **entitlements_request** | [**EntitlementsRequest**](EntitlementsRequest.md)| | + **entitlements_request** | [**EntitlementsRequest**](EntitlementsRequest.md)| | ### Return type -[**[ApiEntitlement]**](ApiEntitlement.md) +[**List[ApiEntitlement]**](ApiEntitlement.md) ### Authorization @@ -294,7 +281,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/EntitlementsRequest.md b/gooddata-api-client/docs/EntitlementsRequest.md index c942987fb..3f98e35b5 100644 --- a/gooddata-api-client/docs/EntitlementsRequest.md +++ b/gooddata-api-client/docs/EntitlementsRequest.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**entitlements_name** | **[str]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**entitlements_name** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.entitlements_request import EntitlementsRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of EntitlementsRequest from a JSON string +entitlements_request_instance = EntitlementsRequest.from_json(json) +# print the JSON string representation of the object +print(EntitlementsRequest.to_json()) +# convert the object into a dict +entitlements_request_dict = entitlements_request_instance.to_dict() +# create an instance of EntitlementsRequest from a dict +entitlements_request_from_dict = EntitlementsRequest.from_dict(entitlements_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/EntityIdentifier.md b/gooddata-api-client/docs/EntityIdentifier.md index 661dd5b5c..9324faa4f 100644 --- a/gooddata-api-client/docs/EntityIdentifier.md +++ b/gooddata-api-client/docs/EntityIdentifier.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Object identifier. | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.entity_identifier import EntityIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of EntityIdentifier from a JSON string +entity_identifier_instance = EntityIdentifier.from_json(json) +# print the JSON string representation of the object +print(EntityIdentifier.to_json()) + +# convert the object into a dict +entity_identifier_dict = entity_identifier_instance.to_dict() +# create an instance of EntityIdentifier from a dict +entity_identifier_from_dict = EntityIdentifier.from_dict(entity_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExecutionLinks.md b/gooddata-api-client/docs/ExecutionLinks.md index 5754b5a19..b6d1fdff8 100644 --- a/gooddata-api-client/docs/ExecutionLinks.md +++ b/gooddata-api-client/docs/ExecutionLinks.md @@ -3,11 +3,28 @@ Links to the execution result. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_result** | **str** | Link to the result data. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.execution_links import ExecutionLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of ExecutionLinks from a JSON string +execution_links_instance = ExecutionLinks.from_json(json) +# print the JSON string representation of the object +print(ExecutionLinks.to_json()) + +# convert the object into a dict +execution_links_dict = execution_links_instance.to_dict() +# create an instance of ExecutionLinks from a dict +execution_links_from_dict = ExecutionLinks.from_dict(execution_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExecutionResponse.md b/gooddata-api-client/docs/ExecutionResponse.md index 575b7cd22..213789c7a 100644 --- a/gooddata-api-client/docs/ExecutionResponse.md +++ b/gooddata-api-client/docs/ExecutionResponse.md @@ -3,12 +3,29 @@ Response to AFM execution request body ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dimensions** | [**[ResultDimension]**](ResultDimension.md) | Dimensions of the result | +**dimensions** | [**List[ResultDimension]**](ResultDimension.md) | Dimensions of the result | **links** | [**ExecutionLinks**](ExecutionLinks.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.execution_response import ExecutionResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ExecutionResponse from a JSON string +execution_response_instance = ExecutionResponse.from_json(json) +# print the JSON string representation of the object +print(ExecutionResponse.to_json()) + +# convert the object into a dict +execution_response_dict = execution_response_instance.to_dict() +# create an instance of ExecutionResponse from a dict +execution_response_from_dict = ExecutionResponse.from_dict(execution_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExecutionResult.md b/gooddata-api-client/docs/ExecutionResult.md index 3e743f9d9..fec447b83 100644 --- a/gooddata-api-client/docs/ExecutionResult.md +++ b/gooddata-api-client/docs/ExecutionResult.md @@ -3,15 +3,32 @@ Contains the result of an AFM execution. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values. | -**dimension_headers** | [**[DimensionHeader]**](DimensionHeader.md) | An array containing dimension headers. The size of the array corresponds to the number of dimensions. Their order corresponds to the dimension order in the execution result spec. | -**grand_totals** | [**[ExecutionResultGrandTotal]**](ExecutionResultGrandTotal.md) | | +**data** | **List[object]** | A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values. | +**dimension_headers** | [**List[DimensionHeader]**](DimensionHeader.md) | An array containing dimension headers. The size of the array corresponds to the number of dimensions. Their order corresponds to the dimension order in the execution result spec. | +**grand_totals** | [**List[ExecutionResultGrandTotal]**](ExecutionResultGrandTotal.md) | | **metadata** | [**ExecutionResultMetadata**](ExecutionResultMetadata.md) | | **paging** | [**ExecutionResultPaging**](ExecutionResultPaging.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.execution_result import ExecutionResult + +# TODO update the JSON string below +json = "{}" +# create an instance of ExecutionResult from a JSON string +execution_result_instance = ExecutionResult.from_json(json) +# print the JSON string representation of the object +print(ExecutionResult.to_json()) + +# convert the object into a dict +execution_result_dict = execution_result_instance.to_dict() +# create an instance of ExecutionResult from a dict +execution_result_from_dict = ExecutionResult.from_dict(execution_result_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExecutionResultDataSourceMessage.md b/gooddata-api-client/docs/ExecutionResultDataSourceMessage.md index 96eec784f..1fdaa7b0d 100644 --- a/gooddata-api-client/docs/ExecutionResultDataSourceMessage.md +++ b/gooddata-api-client/docs/ExecutionResultDataSourceMessage.md @@ -3,14 +3,31 @@ A piece of extra information related to the results (e.g. debug information, warnings, etc.). ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **correlation_id** | **str** | Id correlating different pieces of supplementary info together. | +**data** | **object** | Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type. | [optional] **source** | **str** | Information about what part of the system created this piece of supplementary info. | **type** | **str** | Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future. | -**data** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.execution_result_data_source_message import ExecutionResultDataSourceMessage + +# TODO update the JSON string below +json = "{}" +# create an instance of ExecutionResultDataSourceMessage from a JSON string +execution_result_data_source_message_instance = ExecutionResultDataSourceMessage.from_json(json) +# print the JSON string representation of the object +print(ExecutionResultDataSourceMessage.to_json()) + +# convert the object into a dict +execution_result_data_source_message_dict = execution_result_data_source_message_instance.to_dict() +# create an instance of ExecutionResultDataSourceMessage from a dict +execution_result_data_source_message_from_dict = ExecutionResultDataSourceMessage.from_dict(execution_result_data_source_message_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExecutionResultGrandTotal.md b/gooddata-api-client/docs/ExecutionResultGrandTotal.md index 2024789f6..2090688ad 100644 --- a/gooddata-api-client/docs/ExecutionResultGrandTotal.md +++ b/gooddata-api-client/docs/ExecutionResultGrandTotal.md @@ -3,13 +3,30 @@ Contains the data of grand totals with the same dimensions. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values. | -**dimension_headers** | [**[DimensionHeader]**](DimensionHeader.md) | Contains headers for a subset of `totalDimensions` in which the totals are grand totals. | -**total_dimensions** | **[str]** | Dimensions of the grand totals. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | **List[object]** | A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values. | +**dimension_headers** | [**List[DimensionHeader]**](DimensionHeader.md) | Contains headers for a subset of `totalDimensions` in which the totals are grand totals. | +**total_dimensions** | **List[str]** | Dimensions of the grand totals. | + +## Example + +```python +from gooddata_api_client.models.execution_result_grand_total import ExecutionResultGrandTotal + +# TODO update the JSON string below +json = "{}" +# create an instance of ExecutionResultGrandTotal from a JSON string +execution_result_grand_total_instance = ExecutionResultGrandTotal.from_json(json) +# print the JSON string representation of the object +print(ExecutionResultGrandTotal.to_json()) +# convert the object into a dict +execution_result_grand_total_dict = execution_result_grand_total_instance.to_dict() +# create an instance of ExecutionResultGrandTotal from a dict +execution_result_grand_total_from_dict = ExecutionResultGrandTotal.from_dict(execution_result_grand_total_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExecutionResultHeader.md b/gooddata-api-client/docs/ExecutionResultHeader.md index e743aa147..e6582a689 100644 --- a/gooddata-api-client/docs/ExecutionResultHeader.md +++ b/gooddata-api-client/docs/ExecutionResultHeader.md @@ -3,13 +3,30 @@ Abstract execution result header ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attribute_header** | [**AttributeResultHeader**](AttributeResultHeader.md) | | [optional] -**measure_header** | [**MeasureResultHeader**](MeasureResultHeader.md) | | [optional] -**total_header** | [**TotalResultHeader**](TotalResultHeader.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**attribute_header** | [**AttributeResultHeader**](AttributeResultHeader.md) | | +**measure_header** | [**MeasureResultHeader**](MeasureResultHeader.md) | | +**total_header** | [**TotalResultHeader**](TotalResultHeader.md) | | + +## Example + +```python +from gooddata_api_client.models.execution_result_header import ExecutionResultHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of ExecutionResultHeader from a JSON string +execution_result_header_instance = ExecutionResultHeader.from_json(json) +# print the JSON string representation of the object +print(ExecutionResultHeader.to_json()) +# convert the object into a dict +execution_result_header_dict = execution_result_header_instance.to_dict() +# create an instance of ExecutionResultHeader from a dict +execution_result_header_from_dict = ExecutionResultHeader.from_dict(execution_result_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExecutionResultMetadata.md b/gooddata-api-client/docs/ExecutionResultMetadata.md index feef9ca88..00225ac07 100644 --- a/gooddata-api-client/docs/ExecutionResultMetadata.md +++ b/gooddata-api-client/docs/ExecutionResultMetadata.md @@ -3,11 +3,28 @@ Additional metadata for the particular execution result. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_source_messages** | [**[ExecutionResultDataSourceMessage]**](ExecutionResultDataSourceMessage.md) | Additional information sent by the underlying data source. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data_source_messages** | [**List[ExecutionResultDataSourceMessage]**](ExecutionResultDataSourceMessage.md) | Additional information sent by the underlying data source. | + +## Example + +```python +from gooddata_api_client.models.execution_result_metadata import ExecutionResultMetadata + +# TODO update the JSON string below +json = "{}" +# create an instance of ExecutionResultMetadata from a JSON string +execution_result_metadata_instance = ExecutionResultMetadata.from_json(json) +# print the JSON string representation of the object +print(ExecutionResultMetadata.to_json()) +# convert the object into a dict +execution_result_metadata_dict = execution_result_metadata_instance.to_dict() +# create an instance of ExecutionResultMetadata from a dict +execution_result_metadata_from_dict = ExecutionResultMetadata.from_dict(execution_result_metadata_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExecutionResultPaging.md b/gooddata-api-client/docs/ExecutionResultPaging.md index 6e9746b7d..88f3ab177 100644 --- a/gooddata-api-client/docs/ExecutionResultPaging.md +++ b/gooddata-api-client/docs/ExecutionResultPaging.md @@ -3,13 +3,30 @@ A paging information related to the data presented in the execution result. These paging information are multi-dimensional. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**count** | **[int]** | A count of the returned results in every dimension. | -**offset** | **[int]** | The offset of the results returned in every dimension. | -**total** | **[int]** | A total count of the results in every dimension. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**count** | **List[int]** | A count of the returned results in every dimension. | +**offset** | **List[int]** | The offset of the results returned in every dimension. | +**total** | **List[int]** | A total count of the results in every dimension. | + +## Example + +```python +from gooddata_api_client.models.execution_result_paging import ExecutionResultPaging + +# TODO update the JSON string below +json = "{}" +# create an instance of ExecutionResultPaging from a JSON string +execution_result_paging_instance = ExecutionResultPaging.from_json(json) +# print the JSON string representation of the object +print(ExecutionResultPaging.to_json()) +# convert the object into a dict +execution_result_paging_dict = execution_result_paging_instance.to_dict() +# create an instance of ExecutionResultPaging from a dict +execution_result_paging_from_dict = ExecutionResultPaging.from_dict(execution_result_paging_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExecutionSettings.md b/gooddata-api-client/docs/ExecutionSettings.md index e31c1f582..01c9343f3 100644 --- a/gooddata-api-client/docs/ExecutionSettings.md +++ b/gooddata-api-client/docs/ExecutionSettings.md @@ -3,12 +3,29 @@ Various settings affecting the process of AFM execution or its result ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_sampling_percentage** | **float** | Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views. | [optional] **timestamp** | **datetime** | Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.execution_settings import ExecutionSettings + +# TODO update the JSON string below +json = "{}" +# create an instance of ExecutionSettings from a JSON string +execution_settings_instance = ExecutionSettings.from_json(json) +# print the JSON string representation of the object +print(ExecutionSettings.to_json()) + +# convert the object into a dict +execution_settings_dict = execution_settings_instance.to_dict() +# create an instance of ExecutionSettings from a dict +execution_settings_from_dict = ExecutionSettings.from_dict(execution_settings_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExportDefinitionsApi.md b/gooddata-api-client/docs/ExportDefinitionsApi.md index fe3f45ac5..dbbdb63ea 100644 --- a/gooddata-api-client/docs/ExportDefinitionsApi.md +++ b/gooddata-api-client/docs/ExportDefinitionsApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **create_entity_export_definitions** -> JsonApiExportDefinitionOutDocument create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document) +> JsonApiExportDefinitionOutDocument create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, include=include, meta_include=meta_include) Post Export Definitions @@ -21,12 +21,12 @@ Post Export Definitions ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_definitions_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -35,67 +35,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_definitions_api.ExportDefinitionsApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_export_definition_post_optional_id_document = JsonApiExportDefinitionPostOptionalIdDocument( - data=JsonApiExportDefinitionPostOptionalId( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionPostOptionalIdDocument | - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Export Definitions - api_response = api_instance.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ExportDefinitionsApi->create_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.ExportDefinitionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_export_definition_post_optional_id_document = gooddata_api_client.JsonApiExportDefinitionPostOptionalIdDocument() # JsonApiExportDefinitionPostOptionalIdDocument | + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Export Definitions api_response = api_instance.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of ExportDefinitionsApi->create_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportDefinitionsApi->create_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_export_definition_post_optional_id_document** | [**JsonApiExportDefinitionPostOptionalIdDocument**](JsonApiExportDefinitionPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_export_definition_post_optional_id_document** | [**JsonApiExportDefinitionPostOptionalIdDocument**](JsonApiExportDefinitionPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -110,7 +77,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -120,7 +86,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_export_definitions** -> delete_entity_export_definitions(workspace_id, object_id) +> delete_entity_export_definitions(workspace_id, object_id, filter=filter) Delete an Export Definition @@ -128,10 +94,10 @@ Delete an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_definitions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -140,37 +106,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_definitions_api.ExportDefinitionsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete an Export Definition - api_instance.delete_entity_export_definitions(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling ExportDefinitionsApi->delete_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.ExportDefinitionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete an Export Definition api_instance.delete_entity_export_definitions(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportDefinitionsApi->delete_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -185,7 +144,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -195,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_export_definitions** -> JsonApiExportDefinitionOutList get_all_entities_export_definitions(workspace_id) +> JsonApiExportDefinitionOutList get_all_entities_export_definitions(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Export Definitions @@ -203,11 +161,11 @@ Get all Export Definitions ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_definitions_api -from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.models.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -216,57 +174,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_definitions_api.ExportDefinitionsApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Export Definitions - api_response = api_instance.get_all_entities_export_definitions(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ExportDefinitionsApi->get_all_entities_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.ExportDefinitionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Export Definitions api_response = api_instance.get_all_entities_export_definitions(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of ExportDefinitionsApi->get_all_entities_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportDefinitionsApi->get_all_entities_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -281,7 +226,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -291,7 +235,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_export_definitions** -> JsonApiExportDefinitionOutDocument get_entity_export_definitions(workspace_id, object_id) +> JsonApiExportDefinitionOutDocument get_entity_export_definitions(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Export Definition @@ -299,11 +243,11 @@ Get an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_definitions_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -312,49 +256,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_definitions_api.ExportDefinitionsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Export Definition - api_response = api_instance.get_entity_export_definitions(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ExportDefinitionsApi->get_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.ExportDefinitionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Export Definition api_response = api_instance.get_entity_export_definitions(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of ExportDefinitionsApi->get_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportDefinitionsApi->get_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -369,7 +302,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -379,7 +311,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_export_definitions** -> JsonApiExportDefinitionOutDocument patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) +> JsonApiExportDefinitionOutDocument patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, filter=filter, include=include) Patch an Export Definition @@ -387,12 +319,12 @@ Patch an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_definitions_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -401,67 +333,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_definitions_api.ExportDefinitionsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_export_definition_patch_document = JsonApiExportDefinitionPatchDocument( - data=JsonApiExportDefinitionPatch( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionPatchDocument | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Export Definition - api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ExportDefinitionsApi->patch_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.ExportDefinitionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_export_definition_patch_document = gooddata_api_client.JsonApiExportDefinitionPatchDocument() # JsonApiExportDefinitionPatchDocument | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch an Export Definition api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, filter=filter, include=include) + print("The response of ExportDefinitionsApi->patch_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportDefinitionsApi->patch_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_export_definition_patch_document** | [**JsonApiExportDefinitionPatchDocument**](JsonApiExportDefinitionPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_export_definition_patch_document** | [**JsonApiExportDefinitionPatchDocument**](JsonApiExportDefinitionPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -476,7 +377,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -486,7 +386,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_export_definitions** -> JsonApiExportDefinitionOutDocument update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document) +> JsonApiExportDefinitionOutDocument update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, filter=filter, include=include) Put an Export Definition @@ -494,12 +394,12 @@ Put an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_definitions_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.models.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -508,67 +408,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_definitions_api.ExportDefinitionsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_export_definition_in_document = JsonApiExportDefinitionInDocument( - data=JsonApiExportDefinitionIn( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionInDocument | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Export Definition - api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ExportDefinitionsApi->update_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.ExportDefinitionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_export_definition_in_document = gooddata_api_client.JsonApiExportDefinitionInDocument() # JsonApiExportDefinitionInDocument | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put an Export Definition api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, filter=filter, include=include) + print("The response of ExportDefinitionsApi->update_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportDefinitionsApi->update_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_export_definition_in_document** | [**JsonApiExportDefinitionInDocument**](JsonApiExportDefinitionInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_export_definition_in_document** | [**JsonApiExportDefinitionInDocument**](JsonApiExportDefinitionInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -583,7 +452,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ExportRequest.md b/gooddata-api-client/docs/ExportRequest.md index 3e7569b35..a95edde63 100644 --- a/gooddata-api-client/docs/ExportRequest.md +++ b/gooddata-api-client/docs/ExportRequest.md @@ -3,20 +3,37 @@ JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**metadata** | [**JsonNode**](JsonNode.md) | | [optional] +**dashboard_id** | **str** | Dashboard identifier | +**file_name** | **str** | Filename of downloaded file without extension. | +**metadata** | **object** | Free-form JSON object | [optional] **custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] **execution_result** | **str** | Execution result identifier. | [optional] +**format** | **str** | Expected file format. | **related_dashboard_id** | **str** | Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard. | [optional] **settings** | [**Settings**](Settings.md) | | [optional] **visualization_object** | **str** | Visualization object identifier. Alternative to executionResult property. | [optional] -**visualization_object_custom_filters** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] -**dashboard_id** | **str** | Dashboard identifier | [optional] -**file_name** | **str** | Filename of downloaded file without extension. | [optional] -**format** | **str** | Expected file format. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**visualization_object_custom_filters** | **List[object]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] + +## Example + +```python +from gooddata_api_client.models.export_request import ExportRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExportRequest from a JSON string +export_request_instance = ExportRequest.from_json(json) +# print the JSON string representation of the object +print(ExportRequest.to_json()) +# convert the object into a dict +export_request_dict = export_request_instance.to_dict() +# create an instance of ExportRequest from a dict +export_request_from_dict = ExportRequest.from_dict(export_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExportResponse.md b/gooddata-api-client/docs/ExportResponse.md index 6965e5335..037941dc7 100644 --- a/gooddata-api-client/docs/ExportResponse.md +++ b/gooddata-api-client/docs/ExportResponse.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **export_result** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.export_response import ExportResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ExportResponse from a JSON string +export_response_instance = ExportResponse.from_json(json) +# print the JSON string representation of the object +print(ExportResponse.to_json()) + +# convert the object into a dict +export_response_dict = export_response_instance.to_dict() +# create an instance of ExportResponse from a dict +export_response_from_dict = ExportResponse.from_dict(export_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExportResult.md b/gooddata-api-client/docs/ExportResult.md index 50c54490a..5e7333b9d 100644 --- a/gooddata-api-client/docs/ExportResult.md +++ b/gooddata-api-client/docs/ExportResult.md @@ -2,19 +2,36 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**export_id** | **str** | | -**file_name** | **str** | | -**status** | **str** | | **error_message** | **str** | | [optional] **expires_at** | **datetime** | | [optional] +**export_id** | **str** | | +**file_name** | **str** | | **file_size** | **int** | | [optional] **file_uri** | **str** | | [optional] +**status** | **str** | | **trace_id** | **str** | | [optional] **triggered_at** | **datetime** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.export_result import ExportResult + +# TODO update the JSON string below +json = "{}" +# create an instance of ExportResult from a JSON string +export_result_instance = ExportResult.from_json(json) +# print the JSON string representation of the object +print(ExportResult.to_json()) + +# convert the object into a dict +export_result_dict = export_result_instance.to_dict() +# create an instance of ExportResult from a dict +export_result_from_dict = ExportResult.from_dict(export_result_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ExportTemplatesApi.md b/gooddata-api-client/docs/ExportTemplatesApi.md index ccbc823e7..15d28157c 100644 --- a/gooddata-api-client/docs/ExportTemplatesApi.md +++ b/gooddata-api-client/docs/ExportTemplatesApi.md @@ -21,12 +21,12 @@ Post Export Template entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_templates_api -from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -35,101 +35,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_templates_api.ExportTemplatesApi(api_client) - json_api_export_template_post_optional_id_document = JsonApiExportTemplatePostOptionalIdDocument( - data=JsonApiExportTemplatePostOptionalId( - attributes=JsonApiExportTemplateInAttributes( - dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - name="name_example", - widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - id="id1", - type="exportTemplate", - ), - ) # JsonApiExportTemplatePostOptionalIdDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ExportTemplatesApi(api_client) + json_api_export_template_post_optional_id_document = gooddata_api_client.JsonApiExportTemplatePostOptionalIdDocument() # JsonApiExportTemplatePostOptionalIdDocument | + try: # Post Export Template entities api_response = api_instance.create_entity_export_templates(json_api_export_template_post_optional_id_document) + print("The response of ExportTemplatesApi->create_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportTemplatesApi->create_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_export_template_post_optional_id_document** | [**JsonApiExportTemplatePostOptionalIdDocument**](JsonApiExportTemplatePostOptionalIdDocument.md)| | + **json_api_export_template_post_optional_id_document** | [**JsonApiExportTemplatePostOptionalIdDocument**](JsonApiExportTemplatePostOptionalIdDocument.md)| | ### Return type @@ -144,7 +71,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -154,7 +80,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_export_templates** -> delete_entity_export_templates(id) +> delete_entity_export_templates(id, filter=filter) Delete Export Template entity @@ -162,10 +88,10 @@ Delete Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_templates_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -174,35 +100,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_templates_api.ExportTemplatesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.ExportTemplatesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Export Template entity - api_instance.delete_entity_export_templates(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling ExportTemplatesApi->delete_entity_export_templates: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Export Template entity api_instance.delete_entity_export_templates(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportTemplatesApi->delete_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -217,7 +136,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -227,7 +145,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_export_templates** -> JsonApiExportTemplateOutList get_all_entities_export_templates() +> JsonApiExportTemplateOutList get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) GET all Export Template entities @@ -235,11 +153,11 @@ GET all Export Template entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_templates_api -from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.models.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -248,39 +166,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_templates_api.ExportTemplatesApi(api_client) - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.ExportTemplatesApi(api_client) + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # GET all Export Template entities api_response = api_instance.get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of ExportTemplatesApi->get_all_entities_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportTemplatesApi->get_all_entities_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -295,7 +210,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -305,7 +219,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_export_templates** -> JsonApiExportTemplateOutDocument get_entity_export_templates(id) +> JsonApiExportTemplateOutDocument get_entity_export_templates(id, filter=filter) GET Export Template entity @@ -313,11 +227,11 @@ GET Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_templates_api -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -326,37 +240,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_templates_api.ExportTemplatesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.ExportTemplatesApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # GET Export Template entity - api_response = api_instance.get_entity_export_templates(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ExportTemplatesApi->get_entity_export_templates: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # GET Export Template entity api_response = api_instance.get_entity_export_templates(id, filter=filter) + print("The response of ExportTemplatesApi->get_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportTemplatesApi->get_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -371,7 +278,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -381,7 +287,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_export_templates** -> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document) +> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) Patch Export Template entity @@ -389,12 +295,12 @@ Patch Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_templates_api -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument -from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -403,114 +309,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_templates_api.ExportTemplatesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_export_template_patch_document = JsonApiExportTemplatePatchDocument( - data=JsonApiExportTemplatePatch( - attributes=JsonApiExportTemplatePatchAttributes( - dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - name="name_example", - widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - id="id1", - type="exportTemplate", - ), - ) # JsonApiExportTemplatePatchDocument | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Export Template entity - api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ExportTemplatesApi->patch_entity_export_templates: %s\n" % e) + api_instance = gooddata_api_client.ExportTemplatesApi(api_client) + id = 'id_example' # str | + json_api_export_template_patch_document = gooddata_api_client.JsonApiExportTemplatePatchDocument() # JsonApiExportTemplatePatchDocument | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Export Template entity api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) + print("The response of ExportTemplatesApi->patch_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportTemplatesApi->patch_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -525,7 +349,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -535,7 +358,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_export_templates** -> JsonApiExportTemplateOutDocument update_entity_export_templates(id, json_api_export_template_in_document) +> JsonApiExportTemplateOutDocument update_entity_export_templates(id, json_api_export_template_in_document, filter=filter) PUT Export Template entity @@ -543,12 +366,12 @@ PUT Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import export_templates_api -from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -557,114 +380,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = export_templates_api.ExportTemplatesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_export_template_in_document = JsonApiExportTemplateInDocument( - data=JsonApiExportTemplateIn( - attributes=JsonApiExportTemplateInAttributes( - dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - name="name_example", - widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - id="id1", - type="exportTemplate", - ), - ) # JsonApiExportTemplateInDocument | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # PUT Export Template entity - api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ExportTemplatesApi->update_entity_export_templates: %s\n" % e) + api_instance = gooddata_api_client.ExportTemplatesApi(api_client) + id = 'id_example' # str | + json_api_export_template_in_document = gooddata_api_client.JsonApiExportTemplateInDocument() # JsonApiExportTemplateInDocument | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # PUT Export Template entity api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document, filter=filter) + print("The response of ExportTemplatesApi->update_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ExportTemplatesApi->update_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_export_template_in_document** | [**JsonApiExportTemplateInDocument**](JsonApiExportTemplateInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_export_template_in_document** | [**JsonApiExportTemplateInDocument**](JsonApiExportTemplateInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -679,7 +420,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/FactIdentifier.md b/gooddata-api-client/docs/FactIdentifier.md index 2c485acd3..a54068ab7 100644 --- a/gooddata-api-client/docs/FactIdentifier.md +++ b/gooddata-api-client/docs/FactIdentifier.md @@ -3,12 +3,29 @@ A fact identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Fact ID. | -**type** | **str** | A type of the fact. | defaults to "fact" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | A type of the fact. | + +## Example + +```python +from gooddata_api_client.models.fact_identifier import FactIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of FactIdentifier from a JSON string +fact_identifier_instance = FactIdentifier.from_json(json) +# print the JSON string representation of the object +print(FactIdentifier.to_json()) +# convert the object into a dict +fact_identifier_dict = fact_identifier_instance.to_dict() +# create an instance of FactIdentifier from a dict +fact_identifier_from_dict = FactIdentifier.from_dict(fact_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/FactsApi.md b/gooddata-api-client/docs/FactsApi.md index ced3daefe..d1321fa96 100644 --- a/gooddata-api-client/docs/FactsApi.md +++ b/gooddata-api-client/docs/FactsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **get_all_entities_facts** -> JsonApiFactOutList get_all_entities_facts(workspace_id) +> JsonApiFactOutList get_all_entities_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Facts @@ -17,11 +17,11 @@ Get all Facts ```python -import time import gooddata_api_client -from gooddata_api_client.api import facts_api -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -30,57 +30,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = facts_api.FactsApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Facts - api_response = api_instance.get_all_entities_facts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling FactsApi->get_all_entities_facts: %s\n" % e) + api_instance = gooddata_api_client.FactsApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;dataset.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Facts api_response = api_instance.get_all_entities_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of FactsApi->get_all_entities_facts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling FactsApi->get_all_entities_facts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -95,7 +82,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -105,7 +91,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_facts** -> JsonApiFactOutDocument get_entity_facts(workspace_id, object_id) +> JsonApiFactOutDocument get_entity_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Fact @@ -113,11 +99,11 @@ Get a Fact ```python -import time import gooddata_api_client -from gooddata_api_client.api import facts_api -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -126,49 +112,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = facts_api.FactsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Fact - api_response = api_instance.get_entity_facts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling FactsApi->get_entity_facts: %s\n" % e) + api_instance = gooddata_api_client.FactsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;dataset.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Fact api_response = api_instance.get_entity_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of FactsApi->get_entity_facts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling FactsApi->get_entity_facts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -183,7 +158,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/File.md b/gooddata-api-client/docs/File.md index 5b371a25d..801d9f731 100644 --- a/gooddata-api-client/docs/File.md +++ b/gooddata-api-client/docs/File.md @@ -2,22 +2,39 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**any** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional] +**any** | **List[object]** | | [optional] **can_resegment** | **str** | | [optional] **id** | **str** | | [optional] **notes** | [**Notes**](Notes.md) | | [optional] **original** | **str** | | [optional] -**other_attributes** | **{str: (str,)}** | | [optional] +**other_attributes** | **Dict[str, str]** | | [optional] **skeleton** | [**Skeleton**](Skeleton.md) | | [optional] **space** | **str** | | [optional] **src_dir** | **str** | | [optional] **translate** | **str** | | [optional] **trg_dir** | **str** | | [optional] -**unit_or_group** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**unit_or_group** | **List[object]** | | [optional] + +## Example + +```python +from gooddata_api_client.models.file import File + +# TODO update the JSON string below +json = "{}" +# create an instance of File from a JSON string +file_instance = File.from_json(json) +# print the JSON string representation of the object +print(File.to_json()) +# convert the object into a dict +file_dict = file_instance.to_dict() +# create an instance of File from a dict +file_from_dict = File.from_dict(file_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Filter.md b/gooddata-api-client/docs/Filter.md deleted file mode 100644 index 736cbd494..000000000 --- a/gooddata-api-client/docs/Filter.md +++ /dev/null @@ -1,12 +0,0 @@ -# Filter - -List of filters to be applied to the new visualization - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/FilterBy.md b/gooddata-api-client/docs/FilterBy.md index 1191f84c4..a80af99d5 100644 --- a/gooddata-api-client/docs/FilterBy.md +++ b/gooddata-api-client/docs/FilterBy.md @@ -3,11 +3,28 @@ Specifies what is used for filtering. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**label_type** | **str** | Specifies which label is used for filtering - primary or requested. | [optional] if omitted the server will use the default value of "REQUESTED" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**label_type** | **str** | Specifies which label is used for filtering - primary or requested. | [optional] [default to 'REQUESTED'] + +## Example + +```python +from gooddata_api_client.models.filter_by import FilterBy + +# TODO update the JSON string below +json = "{}" +# create an instance of FilterBy from a JSON string +filter_by_instance = FilterBy.from_json(json) +# print the JSON string representation of the object +print(FilterBy.to_json()) +# convert the object into a dict +filter_by_dict = filter_by_instance.to_dict() +# create an instance of FilterBy from a dict +filter_by_from_dict = FilterBy.from_dict(filter_by_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/FilterDefinition.md b/gooddata-api-client/docs/FilterDefinition.md index 492aa972e..8fe0e23c8 100644 --- a/gooddata-api-client/docs/FilterDefinition.md +++ b/gooddata-api-client/docs/FilterDefinition.md @@ -3,18 +3,35 @@ Abstract filter definition type ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**inline** | [**InlineFilterDefinitionInline**](InlineFilterDefinitionInline.md) | | [optional] -**ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | [optional] -**comparison_measure_value_filter** | [**ComparisonMeasureValueFilterComparisonMeasureValueFilter**](ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) | | [optional] -**range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | [optional] -**absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] -**relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] -**negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] -**positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**inline** | [**InlineFilterDefinitionInline**](InlineFilterDefinitionInline.md) | | +**ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | +**comparison_measure_value_filter** | [**ComparisonMeasureValueFilterComparisonMeasureValueFilter**](ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) | | +**range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | +**absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | +**relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | +**negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | +**positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | + +## Example + +```python +from gooddata_api_client.models.filter_definition import FilterDefinition + +# TODO update the JSON string below +json = "{}" +# create an instance of FilterDefinition from a JSON string +filter_definition_instance = FilterDefinition.from_json(json) +# print the JSON string representation of the object +print(FilterDefinition.to_json()) +# convert the object into a dict +filter_definition_dict = filter_definition_instance.to_dict() +# create an instance of FilterDefinition from a dict +filter_definition_from_dict = FilterDefinition.from_dict(filter_definition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md b/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md index aac42513a..c84fdb19b 100644 --- a/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md +++ b/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md @@ -3,14 +3,31 @@ Abstract filter definition type for simple metric. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] -**relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] -**negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] -**positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | +**relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | +**negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | +**positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | + +## Example + +```python +from gooddata_api_client.models.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure + +# TODO update the JSON string below +json = "{}" +# create an instance of FilterDefinitionForSimpleMeasure from a JSON string +filter_definition_for_simple_measure_instance = FilterDefinitionForSimpleMeasure.from_json(json) +# print the JSON string representation of the object +print(FilterDefinitionForSimpleMeasure.to_json()) +# convert the object into a dict +filter_definition_for_simple_measure_dict = filter_definition_for_simple_measure_instance.to_dict() +# create an instance of FilterDefinitionForSimpleMeasure from a dict +filter_definition_for_simple_measure_from_dict = FilterDefinitionForSimpleMeasure.from_dict(filter_definition_for_simple_measure_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/FilterViewsApi.md b/gooddata-api-client/docs/FilterViewsApi.md index 99be8ee28..80864477b 100644 --- a/gooddata-api-client/docs/FilterViewsApi.md +++ b/gooddata-api-client/docs/FilterViewsApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description # **create_entity_filter_views** -> JsonApiFilterViewOutDocument create_entity_filter_views(workspace_id, json_api_filter_view_in_document) +> JsonApiFilterViewOutDocument create_entity_filter_views(workspace_id, json_api_filter_view_in_document, include=include) Post Filter views @@ -23,12 +23,12 @@ Post Filter views ```python -import time import gooddata_api_client -from gooddata_api_client.api import filter_views_api -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -37,64 +37,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = filter_views_api.FilterViewsApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_filter_view_in_document = JsonApiFilterViewInDocument( - data=JsonApiFilterViewIn( - attributes=JsonApiFilterViewInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewInDocument | - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Filter views - api_response = api_instance.create_entity_filter_views(workspace_id, json_api_filter_view_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling FilterViewsApi->create_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.FilterViewsApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_filter_view_in_document = gooddata_api_client.JsonApiFilterViewInDocument() # JsonApiFilterViewInDocument | + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Filter views api_response = api_instance.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, include=include) + print("The response of FilterViewsApi->create_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling FilterViewsApi->create_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -109,7 +77,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -119,7 +86,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_filter_views** -> delete_entity_filter_views(workspace_id, object_id) +> delete_entity_filter_views(workspace_id, object_id, filter=filter) Delete Filter view @@ -127,10 +94,10 @@ Delete Filter view ```python -import time import gooddata_api_client -from gooddata_api_client.api import filter_views_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -139,37 +106,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = filter_views_api.FilterViewsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Filter view - api_instance.delete_entity_filter_views(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling FilterViewsApi->delete_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.FilterViewsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Filter view api_instance.delete_entity_filter_views(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling FilterViewsApi->delete_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -184,7 +144,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -194,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_filter_views** -> JsonApiFilterViewOutList get_all_entities_filter_views(workspace_id) +> JsonApiFilterViewOutList get_all_entities_filter_views(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Filter views @@ -202,11 +161,11 @@ Get all Filter views ```python -import time import gooddata_api_client -from gooddata_api_client.api import filter_views_api -from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.models.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -215,57 +174,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = filter_views_api.FilterViewsApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Filter views - api_response = api_instance.get_all_entities_filter_views(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling FilterViewsApi->get_all_entities_filter_views: %s\n" % e) + api_instance = gooddata_api_client.FilterViewsApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Filter views api_response = api_instance.get_all_entities_filter_views(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of FilterViewsApi->get_all_entities_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling FilterViewsApi->get_all_entities_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -280,7 +226,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -290,7 +235,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_filter_views** -> JsonApiFilterViewOutDocument get_entity_filter_views(workspace_id, object_id) +> JsonApiFilterViewOutDocument get_entity_filter_views(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations) Get Filter view @@ -298,11 +243,11 @@ Get Filter view ```python -import time import gooddata_api_client -from gooddata_api_client.api import filter_views_api -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -311,45 +256,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = filter_views_api.FilterViewsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Get Filter view - api_response = api_instance.get_entity_filter_views(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling FilterViewsApi->get_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.FilterViewsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # Get Filter view api_response = api_instance.get_entity_filter_views(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations) + print("The response of FilterViewsApi->get_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling FilterViewsApi->get_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] ### Return type @@ -364,7 +300,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -374,7 +309,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_filter_views** -> [DeclarativeFilterView] get_filter_views(workspace_id) +> List[DeclarativeFilterView] get_filter_views(workspace_id, exclude=exclude) Get filter views @@ -384,11 +319,11 @@ Retrieve filter views for the specific workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import filter_views_api -from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.models.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -397,43 +332,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = filter_views_api.FilterViewsApi(api_client) - workspace_id = "workspaceId_example" # str | - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) - - # example passing only required values which don't have defaults set - try: - # Get filter views - api_response = api_instance.get_filter_views(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling FilterViewsApi->get_filter_views: %s\n" % e) + api_instance = gooddata_api_client.FilterViewsApi(api_client) + workspace_id = 'workspace_id_example' # str | + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get filter views api_response = api_instance.get_filter_views(workspace_id, exclude=exclude) + print("The response of FilterViewsApi->get_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling FilterViewsApi->get_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **exclude** | **[str]**| | [optional] + **workspace_id** | **str**| | + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type -[**[DeclarativeFilterView]**](DeclarativeFilterView.md) +[**List[DeclarativeFilterView]**](DeclarativeFilterView.md) ### Authorization @@ -444,7 +370,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -454,7 +379,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_filter_views** -> JsonApiFilterViewOutDocument patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) +> JsonApiFilterViewOutDocument patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, filter=filter, include=include) Patch Filter view @@ -462,12 +387,12 @@ Patch Filter view ```python -import time import gooddata_api_client -from gooddata_api_client.api import filter_views_api -from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -476,68 +401,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = filter_views_api.FilterViewsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_view_patch_document = JsonApiFilterViewPatchDocument( - data=JsonApiFilterViewPatch( - attributes=JsonApiFilterViewPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewPatchDocument | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Filter view - api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling FilterViewsApi->patch_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.FilterViewsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_view_patch_document = gooddata_api_client.JsonApiFilterViewPatchDocument() # JsonApiFilterViewPatchDocument | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Filter view api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, filter=filter, include=include) + print("The response of FilterViewsApi->patch_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling FilterViewsApi->patch_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_view_patch_document** | [**JsonApiFilterViewPatchDocument**](JsonApiFilterViewPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_view_patch_document** | [**JsonApiFilterViewPatchDocument**](JsonApiFilterViewPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -552,7 +445,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -572,11 +464,11 @@ Set filter views for the specific workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import filter_views_api -from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.models.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -585,46 +477,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = filter_views_api.FilterViewsApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_filter_view = [ - DeclarativeFilterView( - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - content=JsonNode(), - description="description_example", - id="filterView-1", - is_default=True, - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ), - ] # [DeclarativeFilterView] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.FilterViewsApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_filter_view = [gooddata_api_client.DeclarativeFilterView()] # List[DeclarativeFilterView] | + try: # Set filter views api_instance.set_filter_views(workspace_id, declarative_filter_view) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling FilterViewsApi->set_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_filter_view** | [**[DeclarativeFilterView]**](DeclarativeFilterView.md)| | + **workspace_id** | **str**| | + **declarative_filter_view** | [**List[DeclarativeFilterView]**](DeclarativeFilterView.md)| | ### Return type @@ -639,7 +513,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -649,7 +522,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_filter_views** -> JsonApiFilterViewOutDocument update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document) +> JsonApiFilterViewOutDocument update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, filter=filter, include=include) Put Filter views @@ -657,12 +530,12 @@ Put Filter views ```python -import time import gooddata_api_client -from gooddata_api_client.api import filter_views_api -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -671,68 +544,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = filter_views_api.FilterViewsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_view_in_document = JsonApiFilterViewInDocument( - data=JsonApiFilterViewIn( - attributes=JsonApiFilterViewInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewInDocument | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Filter views - api_response = api_instance.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling FilterViewsApi->update_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.FilterViewsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_view_in_document = gooddata_api_client.JsonApiFilterViewInDocument() # JsonApiFilterViewInDocument | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Filter views api_response = api_instance.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, filter=filter, include=include) + print("The response of FilterViewsApi->update_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling FilterViewsApi->update_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -747,7 +588,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ForecastRequest.md b/gooddata-api-client/docs/ForecastRequest.md index cdf759f54..a4bad14c7 100644 --- a/gooddata-api-client/docs/ForecastRequest.md +++ b/gooddata-api-client/docs/ForecastRequest.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**confidence_level** | **float** | Confidence interval boundary value. | [optional] [default to 0.95] **forecast_period** | **int** | Number of future periods that should be forecasted | -**confidence_level** | **float** | Confidence interval boundary value. | [optional] if omitted the server will use the default value of 0.95 -**seasonal** | **bool** | Whether the input data is seasonal | [optional] if omitted the server will use the default value of False -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**seasonal** | **bool** | Whether the input data is seasonal | [optional] [default to False] + +## Example + +```python +from gooddata_api_client.models.forecast_request import ForecastRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ForecastRequest from a JSON string +forecast_request_instance = ForecastRequest.from_json(json) +# print the JSON string representation of the object +print(ForecastRequest.to_json()) +# convert the object into a dict +forecast_request_dict = forecast_request_instance.to_dict() +# create an instance of ForecastRequest from a dict +forecast_request_from_dict = ForecastRequest.from_dict(forecast_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ForecastResult.md b/gooddata-api-client/docs/ForecastResult.md index 026431cf0..54f4c90c9 100644 --- a/gooddata-api-client/docs/ForecastResult.md +++ b/gooddata-api-client/docs/ForecastResult.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attribute** | **[str]** | | -**lower_bound** | **[float, none_type]** | | -**origin** | **[float, none_type]** | | -**prediction** | **[float, none_type]** | | -**upper_bound** | **[float, none_type]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**attribute** | **List[str]** | | +**lower_bound** | **List[Optional[float]]** | | +**origin** | **List[Optional[float]]** | | +**prediction** | **List[Optional[float]]** | | +**upper_bound** | **List[Optional[float]]** | | + +## Example + +```python +from gooddata_api_client.models.forecast_result import ForecastResult + +# TODO update the JSON string below +json = "{}" +# create an instance of ForecastResult from a JSON string +forecast_result_instance = ForecastResult.from_json(json) +# print the JSON string representation of the object +print(ForecastResult.to_json()) +# convert the object into a dict +forecast_result_dict = forecast_result_instance.to_dict() +# create an instance of ForecastResult from a dict +forecast_result_from_dict = ForecastResult.from_dict(forecast_result_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/FoundObjects.md b/gooddata-api-client/docs/FoundObjects.md index b442f0d40..42e419c73 100644 --- a/gooddata-api-client/docs/FoundObjects.md +++ b/gooddata-api-client/docs/FoundObjects.md @@ -3,12 +3,29 @@ List of objects found by similarity search and post-processed by LLM. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**objects** | [**[SearchResultObject]**](SearchResultObject.md) | List of objects found with a similarity search. | +**objects** | [**List[SearchResultObject]**](SearchResultObject.md) | List of objects found with a similarity search. | **reasoning** | **str** | Reasoning from LLM. Description of how and why the answer was generated. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.found_objects import FoundObjects + +# TODO update the JSON string below +json = "{}" +# create an instance of FoundObjects from a JSON string +found_objects_instance = FoundObjects.from_json(json) +# print the JSON string representation of the object +print(FoundObjects.to_json()) + +# convert the object into a dict +found_objects_dict = found_objects_instance.to_dict() +# create an instance of FoundObjects from a dict +found_objects_from_dict = FoundObjects.from_dict(found_objects_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Frequency.md b/gooddata-api-client/docs/Frequency.md index 06cbe3784..67435c5f0 100644 --- a/gooddata-api-client/docs/Frequency.md +++ b/gooddata-api-client/docs/Frequency.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**buckets** | [**[FrequencyBucket]**](FrequencyBucket.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**buckets** | [**List[FrequencyBucket]**](FrequencyBucket.md) | | + +## Example + +```python +from gooddata_api_client.models.frequency import Frequency + +# TODO update the JSON string below +json = "{}" +# create an instance of Frequency from a JSON string +frequency_instance = Frequency.from_json(json) +# print the JSON string representation of the object +print(Frequency.to_json()) +# convert the object into a dict +frequency_dict = frequency_instance.to_dict() +# create an instance of Frequency from a dict +frequency_from_dict = Frequency.from_dict(frequency_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/FrequencyBucket.md b/gooddata-api-client/docs/FrequencyBucket.md index 024bf4ce0..414bfa2c7 100644 --- a/gooddata-api-client/docs/FrequencyBucket.md +++ b/gooddata-api-client/docs/FrequencyBucket.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **int** | | **value** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.frequency_bucket import FrequencyBucket + +# TODO update the JSON string below +json = "{}" +# create an instance of FrequencyBucket from a JSON string +frequency_bucket_instance = FrequencyBucket.from_json(json) +# print the JSON string representation of the object +print(FrequencyBucket.to_json()) + +# convert the object into a dict +frequency_bucket_dict = frequency_bucket_instance.to_dict() +# create an instance of FrequencyBucket from a dict +frequency_bucket_from_dict = FrequencyBucket.from_dict(frequency_bucket_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/FrequencyProperties.md b/gooddata-api-client/docs/FrequencyProperties.md index a00bb1a26..38be25505 100644 --- a/gooddata-api-client/docs/FrequencyProperties.md +++ b/gooddata-api-client/docs/FrequencyProperties.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value_limit** | **int** | The maximum number of distinct values to return. | [optional] if omitted the server will use the default value of 10 -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**value_limit** | **int** | The maximum number of distinct values to return. | [optional] [default to 10] + +## Example + +```python +from gooddata_api_client.models.frequency_properties import FrequencyProperties + +# TODO update the JSON string below +json = "{}" +# create an instance of FrequencyProperties from a JSON string +frequency_properties_instance = FrequencyProperties.from_json(json) +# print the JSON string representation of the object +print(FrequencyProperties.to_json()) +# convert the object into a dict +frequency_properties_dict = frequency_properties_instance.to_dict() +# create an instance of FrequencyProperties from a dict +frequency_properties_from_dict = FrequencyProperties.from_dict(frequency_properties_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/GenerateLdmRequest.md b/gooddata-api-client/docs/GenerateLdmRequest.md index 7a310a40c..b11b72815 100644 --- a/gooddata-api-client/docs/GenerateLdmRequest.md +++ b/gooddata-api-client/docs/GenerateLdmRequest.md @@ -3,13 +3,14 @@ A request containing all information needed for generation of logical model. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **aggregated_fact_prefix** | **str** | Columns starting with this prefix will be considered as aggregated facts. The prefix is then followed by the value of `separator` parameter. Given the aggregated fact prefix is `aggr` and separator is `__`, the columns with name like `aggr__sum__product__sold` will be considered as aggregated sold fact in the product table with SUM aggregate function. | [optional] **date_granularities** | **str** | Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is `all` which enables all available date granularities, including time granularities (like hours, minutes). | [optional] **denorm_prefix** | **str** | Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of `separator` parameter. Given the denormalization reference prefix is `dr` and separator is `__`, the columns with name like `dr__customer_name` will be considered as denormalization references. | [optional] **fact_prefix** | **str** | Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of `separator` parameter. Given the fact prefix is `f` and separator is `__`, the columns with name like `f__sold` will be considered as facts. | [optional] -**generate_long_ids** | **bool** | A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `<table>.<column>` is used. If the flag is set to true, then all ids will be generated in the long form. | [optional] if omitted the server will use the default value of False +**generate_long_ids** | **bool** | A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `<table>.<column>` is used. If the flag is set to true, then all ids will be generated in the long form. | [optional] [default to False] **grain_multivalue_reference_prefix** | **str** | Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `grmr` and separator is `__`, the columns with name like `grmr__customer__customer_id` will be considered as grain multivalue references to customer_id in customer table. | [optional] **grain_prefix** | **str** | Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of `separator` parameter. Given the grain prefix is `gr` and separator is `__`, the columns with name like `gr__name` will be considered as grains. | [optional] **grain_reference_prefix** | **str** | Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `grr` and separator is `__`, the columns with name like `grr__customer__customer_id` will be considered as grain references to customer_id in customer table. | [optional] @@ -18,13 +19,29 @@ Name | Type | Description | Notes **primary_label_prefix** | **str** | Columns starting with this prefix will be considered as primary labels. The prefix is then followed by the value of `separator` parameter. Given the primary label prefix is `pl` and separator is `__`, the columns with name like `pl__country_id` will be considered as primary labels. | [optional] **reference_prefix** | **str** | Columns starting with this prefix will be considered as references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `r` and separator is `__`, the columns with name like `r__customer__customer_id` will be considered as references to customer_id in customer table. | [optional] **secondary_label_prefix** | **str** | Columns starting with this prefix will be considered as secondary labels. The prefix is then followed by the value of `separator` parameter. Given the secondary label prefix is `ls` and separator is `__`, the columns with name like `ls__country_id__country_name` will be considered as secondary labels. | [optional] -**separator** | **str** | A separator between prefixes and the names. Default is \"__\". | [optional] if omitted the server will use the default value of "__" +**separator** | **str** | A separator between prefixes and the names. Default is \"__\". | [optional] [default to '__'] **table_prefix** | **str** | Tables starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned. | [optional] **view_prefix** | **str** | Views starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned. | [optional] -**wdf_prefix** | **str** | Column serving as workspace data filter. No labels are auto generated for such columns. | [optional] if omitted the server will use the default value of "wdf" +**wdf_prefix** | **str** | Column serving as workspace data filter. No labels are auto generated for such columns. | [optional] [default to 'wdf'] **workspace_id** | **str** | Optional workspace id. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of GenerateLdmRequest from a JSON string +generate_ldm_request_instance = GenerateLdmRequest.from_json(json) +# print the JSON string representation of the object +print(GenerateLdmRequest.to_json()) + +# convert the object into a dict +generate_ldm_request_dict = generate_ldm_request_instance.to_dict() +# create an instance of GenerateLdmRequest from a dict +generate_ldm_request_from_dict = GenerateLdmRequest.from_dict(generate_ldm_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/GenerateLogicalDataModelApi.md b/gooddata-api-client/docs/GenerateLogicalDataModelApi.md index 40d54ff5c..9a0234e54 100644 --- a/gooddata-api-client/docs/GenerateLogicalDataModelApi.md +++ b/gooddata-api-client/docs/GenerateLogicalDataModelApi.md @@ -18,12 +18,12 @@ Generate logical data model (LDM) from physical data model (PDM) stored in data ```python -import time import gooddata_api_client -from gooddata_api_client.api import generate_logical_data_model_api -from gooddata_api_client.model.declarative_model import DeclarativeModel -from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -32,90 +32,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = generate_logical_data_model_api.GenerateLogicalDataModelApi(api_client) - data_source_id = "dataSourceId_example" # str | - generate_ldm_request = GenerateLdmRequest( - aggregated_fact_prefix="aggr", - date_granularities="all", - denorm_prefix="dr", - fact_prefix="f", - generate_long_ids=False, - grain_multivalue_reference_prefix="grmr", - grain_prefix="gr", - grain_reference_prefix="grr", - multivalue_reference_prefix="mr", - pdm=PdmLdmRequest( - sqls=[ - PdmSql( - columns=[ - SqlColumn( - data_type="INT", - name="customer_id", - ), - ], - statement="select * from abc", - title="My special dataset", - ), - ], - table_overrides=[ - TableOverride( - columns=[ - ColumnOverride( - label_target_column="users", - label_type="HYPERLINK", - ldm_type_override="FACT", - name="column_name", - ), - ], - path=["schema","table_name"], - ), - ], - tables=[ - DeclarativeTable( - columns=[ - DeclarativeColumn( - data_type="INT", - is_primary_key=True, - name="customer_id", - referenced_table_column="customer_id", - referenced_table_id="customers", - ), - ], - id="customers", - name_prefix="out_gooddata", - path=["table_schema","table_name"], - type="TABLE", - ), - ], - ), - primary_label_prefix="pl", - reference_prefix="r", - secondary_label_prefix="ls", - separator="__", - table_prefix="out_table", - view_prefix="out_view", - wdf_prefix="wdf", - workspace_id="workspace_id_example", - ) # GenerateLdmRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.GenerateLogicalDataModelApi(api_client) + data_source_id = 'data_source_id_example' # str | + generate_ldm_request = gooddata_api_client.GenerateLdmRequest() # GenerateLdmRequest | + try: # Generate logical data model (LDM) from physical data model (PDM) api_response = api_instance.generate_logical_model(data_source_id, generate_ldm_request) + print("The response of GenerateLogicalDataModelApi->generate_logical_model:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling GenerateLogicalDataModelApi->generate_logical_model: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | - **generate_ldm_request** | [**GenerateLdmRequest**](GenerateLdmRequest.md)| | + **data_source_id** | **str**| | + **generate_ldm_request** | [**GenerateLdmRequest**](GenerateLdmRequest.md)| | ### Return type @@ -130,7 +70,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/GetImageExport202ResponseInner.md b/gooddata-api-client/docs/GetImageExport202ResponseInner.md index 8a1164698..81bd0b2de 100644 --- a/gooddata-api-client/docs/GetImageExport202ResponseInner.md +++ b/gooddata-api-client/docs/GetImageExport202ResponseInner.md @@ -2,18 +2,35 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **char** | **str** | | [optional] **direct** | **bool** | | [optional] **double** | **float** | | [optional] -**float** | **float** | | [optional] +**var_float** | **float** | | [optional] **int** | **int** | | [optional] **long** | **int** | | [optional] **read_only** | **bool** | | [optional] **short** | **int** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.get_image_export202_response_inner import GetImageExport202ResponseInner + +# TODO update the JSON string below +json = "{}" +# create an instance of GetImageExport202ResponseInner from a JSON string +get_image_export202_response_inner_instance = GetImageExport202ResponseInner.from_json(json) +# print the JSON string representation of the object +print(GetImageExport202ResponseInner.to_json()) + +# convert the object into a dict +get_image_export202_response_inner_dict = get_image_export202_response_inner_instance.to_dict() +# create an instance of GetImageExport202ResponseInner from a dict +get_image_export202_response_inner_from_dict = GetImageExport202ResponseInner.from_dict(get_image_export202_response_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/GetQualityIssuesResponse.md b/gooddata-api-client/docs/GetQualityIssuesResponse.md index 1f68b81b7..8ad8273a7 100644 --- a/gooddata-api-client/docs/GetQualityIssuesResponse.md +++ b/gooddata-api-client/docs/GetQualityIssuesResponse.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**issues** | [**[QualityIssue]**](QualityIssue.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**issues** | [**List[QualityIssue]**](QualityIssue.md) | | + +## Example + +```python +from gooddata_api_client.models.get_quality_issues_response import GetQualityIssuesResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of GetQualityIssuesResponse from a JSON string +get_quality_issues_response_instance = GetQualityIssuesResponse.from_json(json) +# print the JSON string representation of the object +print(GetQualityIssuesResponse.to_json()) +# convert the object into a dict +get_quality_issues_response_dict = get_quality_issues_response_instance.to_dict() +# create an instance of GetQualityIssuesResponse from a dict +get_quality_issues_response_from_dict = GetQualityIssuesResponse.from_dict(get_quality_issues_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/GrainIdentifier.md b/gooddata-api-client/docs/GrainIdentifier.md index 6de7aff78..cb1e8502e 100644 --- a/gooddata-api-client/docs/GrainIdentifier.md +++ b/gooddata-api-client/docs/GrainIdentifier.md @@ -3,12 +3,29 @@ A grain identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Grain ID. | **type** | **str** | A type of the grain. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.grain_identifier import GrainIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of GrainIdentifier from a JSON string +grain_identifier_instance = GrainIdentifier.from_json(json) +# print the JSON string representation of the object +print(GrainIdentifier.to_json()) + +# convert the object into a dict +grain_identifier_dict = grain_identifier_instance.to_dict() +# create an instance of GrainIdentifier from a dict +grain_identifier_from_dict = GrainIdentifier.from_dict(grain_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/GrantedPermission.md b/gooddata-api-client/docs/GrantedPermission.md index 617a3d443..86b7b0f69 100644 --- a/gooddata-api-client/docs/GrantedPermission.md +++ b/gooddata-api-client/docs/GrantedPermission.md @@ -3,12 +3,29 @@ Permissions granted to the user group ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **level** | **str** | Level of permission | **source** | **str** | Source of permission | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.granted_permission import GrantedPermission + +# TODO update the JSON string below +json = "{}" +# create an instance of GrantedPermission from a JSON string +granted_permission_instance = GrantedPermission.from_json(json) +# print the JSON string representation of the object +print(GrantedPermission.to_json()) + +# convert the object into a dict +granted_permission_dict = granted_permission_instance.to_dict() +# create an instance of GrantedPermission from a dict +granted_permission_from_dict = GrantedPermission.from_dict(granted_permission_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/GranularitiesFormatting.md b/gooddata-api-client/docs/GranularitiesFormatting.md index cd5d087b6..c99ba3d75 100644 --- a/gooddata-api-client/docs/GranularitiesFormatting.md +++ b/gooddata-api-client/docs/GranularitiesFormatting.md @@ -3,12 +3,29 @@ A date dataset granularities title formatting rules. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title_base** | **str** | Title base is used as a token in title pattern. If left empty, it is replaced by date dataset title. | **title_pattern** | **str** | This pattern is used to generate the title of attributes and labels that result from the granularities. There are two tokens available: * `%titleBase` - represents shared part by all titles, or title of Date Dataset if left empty * `%granularityTitle` - represents `DateGranularity` built-in title | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.granularities_formatting import GranularitiesFormatting + +# TODO update the JSON string below +json = "{}" +# create an instance of GranularitiesFormatting from a JSON string +granularities_formatting_instance = GranularitiesFormatting.from_json(json) +# print the JSON string representation of the object +print(GranularitiesFormatting.to_json()) + +# convert the object into a dict +granularities_formatting_dict = granularities_formatting_instance.to_dict() +# create an instance of GranularitiesFormatting from a dict +granularities_formatting_from_dict = GranularitiesFormatting.from_dict(granularities_formatting_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/HeaderGroup.md b/gooddata-api-client/docs/HeaderGroup.md index 045d2cf27..b6ed95a74 100644 --- a/gooddata-api-client/docs/HeaderGroup.md +++ b/gooddata-api-client/docs/HeaderGroup.md @@ -3,11 +3,28 @@ Contains the information specific for a group of headers. These groups correlate to attributes and metric groups. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**headers** | [**[ExecutionResultHeader]**](ExecutionResultHeader.md) | An array containing headers. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**headers** | [**List[ExecutionResultHeader]**](ExecutionResultHeader.md) | An array containing headers. | + +## Example + +```python +from gooddata_api_client.models.header_group import HeaderGroup + +# TODO update the JSON string below +json = "{}" +# create an instance of HeaderGroup from a JSON string +header_group_instance = HeaderGroup.from_json(json) +# print the JSON string representation of the object +print(HeaderGroup.to_json()) +# convert the object into a dict +header_group_dict = header_group_instance.to_dict() +# create an instance of HeaderGroup from a dict +header_group_from_dict = HeaderGroup.from_dict(header_group_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/HierarchyApi.md b/gooddata-api-client/docs/HierarchyApi.md index 5a0a3ab98..b733b312e 100644 --- a/gooddata-api-client/docs/HierarchyApi.md +++ b/gooddata-api-client/docs/HierarchyApi.md @@ -11,7 +11,7 @@ Method | HTTP request | Description # **check_entity_overrides** -> [IdentifierDuplications] check_entity_overrides(workspace_id, hierarchy_object_identification) +> List[IdentifierDuplications] check_entity_overrides(workspace_id, hierarchy_object_identification) Finds entities with given ID in hierarchy. @@ -21,12 +21,12 @@ Finds entities with given ID in hierarchy (e.g. to check possible future conflic ```python -import time import gooddata_api_client -from gooddata_api_client.api import hierarchy_api -from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.hierarchy_object_identification import HierarchyObjectIdentification +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -35,37 +35,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = hierarchy_api.HierarchyApi(api_client) - workspace_id = "workspaceId_example" # str | - hierarchy_object_identification = [ - HierarchyObjectIdentification( - id="id_example", - type="metric", - ), - ] # [HierarchyObjectIdentification] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.HierarchyApi(api_client) + workspace_id = 'workspace_id_example' # str | + hierarchy_object_identification = [gooddata_api_client.HierarchyObjectIdentification()] # List[HierarchyObjectIdentification] | + try: # Finds entities with given ID in hierarchy. api_response = api_instance.check_entity_overrides(workspace_id, hierarchy_object_identification) + print("The response of HierarchyApi->check_entity_overrides:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling HierarchyApi->check_entity_overrides: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **hierarchy_object_identification** | [**[HierarchyObjectIdentification]**](HierarchyObjectIdentification.md)| | + **workspace_id** | **str**| | + **hierarchy_object_identification** | [**List[HierarchyObjectIdentification]**](HierarchyObjectIdentification.md)| | ### Return type -[**[IdentifierDuplications]**](IdentifierDuplications.md) +[**List[IdentifierDuplications]**](IdentifierDuplications.md) ### Authorization @@ -76,7 +73,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -86,7 +82,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **inherited_entity_conflicts** -> [IdentifierDuplications] inherited_entity_conflicts(workspace_id) +> List[IdentifierDuplications] inherited_entity_conflicts(workspace_id) Finds identifier conflicts in workspace hierarchy. @@ -96,11 +92,11 @@ Finds API identifier conflicts in given workspace hierarchy. ```python -import time import gooddata_api_client -from gooddata_api_client.api import hierarchy_api -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -109,30 +105,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = hierarchy_api.HierarchyApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.HierarchyApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Finds identifier conflicts in workspace hierarchy. api_response = api_instance.inherited_entity_conflicts(workspace_id) + print("The response of HierarchyApi->inherited_entity_conflicts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling HierarchyApi->inherited_entity_conflicts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type -[**[IdentifierDuplications]**](IdentifierDuplications.md) +[**List[IdentifierDuplications]**](IdentifierDuplications.md) ### Authorization @@ -143,7 +141,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -153,7 +150,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **inherited_entity_prefixes** -> [str] inherited_entity_prefixes(workspace_id) +> List[str] inherited_entity_prefixes(workspace_id) Get used entity prefixes in hierarchy @@ -163,10 +160,10 @@ Get used entity prefixes in hierarchy of parent workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import hierarchy_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -175,30 +172,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = hierarchy_api.HierarchyApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.HierarchyApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Get used entity prefixes in hierarchy api_response = api_instance.inherited_entity_prefixes(workspace_id) + print("The response of HierarchyApi->inherited_entity_prefixes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling HierarchyApi->inherited_entity_prefixes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type -**[str]** +**List[str]** ### Authorization @@ -209,7 +208,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -219,7 +217,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **overridden_child_entities** -> [IdentifierDuplications] overridden_child_entities(workspace_id) +> List[IdentifierDuplications] overridden_child_entities(workspace_id) Finds identifier overrides in workspace hierarchy. @@ -229,11 +227,11 @@ Finds API identifier overrides in given workspace hierarchy. ```python -import time import gooddata_api_client -from gooddata_api_client.api import hierarchy_api -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -242,30 +240,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = hierarchy_api.HierarchyApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.HierarchyApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Finds identifier overrides in workspace hierarchy. api_response = api_instance.overridden_child_entities(workspace_id) + print("The response of HierarchyApi->overridden_child_entities:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling HierarchyApi->overridden_child_entities: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type -[**[IdentifierDuplications]**](IdentifierDuplications.md) +[**List[IdentifierDuplications]**](IdentifierDuplications.md) ### Authorization @@ -276,7 +276,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/HierarchyObjectIdentification.md b/gooddata-api-client/docs/HierarchyObjectIdentification.md index 7aa04fa8d..8e04c8be0 100644 --- a/gooddata-api-client/docs/HierarchyObjectIdentification.md +++ b/gooddata-api-client/docs/HierarchyObjectIdentification.md @@ -3,12 +3,29 @@ Represents objects with given ID and type in workspace hierarchy (more than one can exists in different workspaces). ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.hierarchy_object_identification import HierarchyObjectIdentification + +# TODO update the JSON string below +json = "{}" +# create an instance of HierarchyObjectIdentification from a JSON string +hierarchy_object_identification_instance = HierarchyObjectIdentification.from_json(json) +# print the JSON string representation of the object +print(HierarchyObjectIdentification.to_json()) + +# convert the object into a dict +hierarchy_object_identification_dict = hierarchy_object_identification_instance.to_dict() +# create an instance of HierarchyObjectIdentification from a dict +hierarchy_object_identification_from_dict = HierarchyObjectIdentification.from_dict(hierarchy_object_identification_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Histogram.md b/gooddata-api-client/docs/Histogram.md index 3420fe0a4..a190eef84 100644 --- a/gooddata-api-client/docs/Histogram.md +++ b/gooddata-api-client/docs/Histogram.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**buckets** | [**[HistogramBucket]**](HistogramBucket.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**buckets** | [**List[HistogramBucket]**](HistogramBucket.md) | | + +## Example + +```python +from gooddata_api_client.models.histogram import Histogram + +# TODO update the JSON string below +json = "{}" +# create an instance of Histogram from a JSON string +histogram_instance = Histogram.from_json(json) +# print the JSON string representation of the object +print(Histogram.to_json()) +# convert the object into a dict +histogram_dict = histogram_instance.to_dict() +# create an instance of Histogram from a dict +histogram_from_dict = Histogram.from_dict(histogram_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/HistogramBucket.md b/gooddata-api-client/docs/HistogramBucket.md index a762d01b3..06293ba48 100644 --- a/gooddata-api-client/docs/HistogramBucket.md +++ b/gooddata-api-client/docs/HistogramBucket.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **int** | | **lower_bound** | **float** | | **upper_bound** | **float** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.histogram_bucket import HistogramBucket + +# TODO update the JSON string below +json = "{}" +# create an instance of HistogramBucket from a JSON string +histogram_bucket_instance = HistogramBucket.from_json(json) +# print the JSON string representation of the object +print(HistogramBucket.to_json()) + +# convert the object into a dict +histogram_bucket_dict = histogram_bucket_instance.to_dict() +# create an instance of HistogramBucket from a dict +histogram_bucket_from_dict = HistogramBucket.from_dict(histogram_bucket_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/HistogramProperties.md b/gooddata-api-client/docs/HistogramProperties.md index a28570409..a2bb1cfc9 100644 --- a/gooddata-api-client/docs/HistogramProperties.md +++ b/gooddata-api-client/docs/HistogramProperties.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bucket_count** | **int** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.histogram_properties import HistogramProperties + +# TODO update the JSON string below +json = "{}" +# create an instance of HistogramProperties from a JSON string +histogram_properties_instance = HistogramProperties.from_json(json) +# print the JSON string representation of the object +print(HistogramProperties.to_json()) + +# convert the object into a dict +histogram_properties_dict = histogram_properties_instance.to_dict() +# create an instance of HistogramProperties from a dict +histogram_properties_from_dict = HistogramProperties.from_dict(histogram_properties_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/IdentifierDuplications.md b/gooddata-api-client/docs/IdentifierDuplications.md index f90009afa..9d49c3cd1 100644 --- a/gooddata-api-client/docs/IdentifierDuplications.md +++ b/gooddata-api-client/docs/IdentifierDuplications.md @@ -3,13 +3,30 @@ Contains information about conflicting IDs in workspace hierarchy ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**origins** | **[str]** | | +**origins** | **List[str]** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications + +# TODO update the JSON string below +json = "{}" +# create an instance of IdentifierDuplications from a JSON string +identifier_duplications_instance = IdentifierDuplications.from_json(json) +# print the JSON string representation of the object +print(IdentifierDuplications.to_json()) + +# convert the object into a dict +identifier_duplications_dict = identifier_duplications_instance.to_dict() +# create an instance of IdentifierDuplications from a dict +identifier_duplications_from_dict = IdentifierDuplications.from_dict(identifier_duplications_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/IdentifierRef.md b/gooddata-api-client/docs/IdentifierRef.md index 31879332c..d2c9e5a1f 100644 --- a/gooddata-api-client/docs/IdentifierRef.md +++ b/gooddata-api-client/docs/IdentifierRef.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identifier** | [**IdentifierRefIdentifier**](IdentifierRefIdentifier.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.identifier_ref import IdentifierRef + +# TODO update the JSON string below +json = "{}" +# create an instance of IdentifierRef from a JSON string +identifier_ref_instance = IdentifierRef.from_json(json) +# print the JSON string representation of the object +print(IdentifierRef.to_json()) + +# convert the object into a dict +identifier_ref_dict = identifier_ref_instance.to_dict() +# create an instance of IdentifierRef from a dict +identifier_ref_from_dict = IdentifierRef.from_dict(identifier_ref_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/IdentifierRefIdentifier.md b/gooddata-api-client/docs/IdentifierRefIdentifier.md index 9909e947d..3e341c786 100644 --- a/gooddata-api-client/docs/IdentifierRefIdentifier.md +++ b/gooddata-api-client/docs/IdentifierRefIdentifier.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.identifier_ref_identifier import IdentifierRefIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of IdentifierRefIdentifier from a JSON string +identifier_ref_identifier_instance = IdentifierRefIdentifier.from_json(json) +# print the JSON string representation of the object +print(IdentifierRefIdentifier.to_json()) + +# convert the object into a dict +identifier_ref_identifier_dict = identifier_ref_identifier_instance.to_dict() +# create an instance of IdentifierRefIdentifier from a dict +identifier_ref_identifier_from_dict = IdentifierRefIdentifier.from_dict(identifier_ref_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/IdentityProvidersApi.md b/gooddata-api-client/docs/IdentityProvidersApi.md index d0712c4aa..9d6252bf8 100644 --- a/gooddata-api-client/docs/IdentityProvidersApi.md +++ b/gooddata-api-client/docs/IdentityProvidersApi.md @@ -23,12 +23,12 @@ Post Identity Providers ```python -import time import gooddata_api_client -from gooddata_api_client.api import identity_providers_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -37,50 +37,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = identity_providers_api.IdentityProvidersApi(api_client) - json_api_identity_provider_in_document = JsonApiIdentityProviderInDocument( - data=JsonApiIdentityProviderIn( - attributes=JsonApiIdentityProviderInAttributes( - custom_claim_mapping={ - "key": "key_example", - }, - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - id="id1", - type="identityProvider", - ), - ) # JsonApiIdentityProviderInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.IdentityProvidersApi(api_client) + json_api_identity_provider_in_document = gooddata_api_client.JsonApiIdentityProviderInDocument() # JsonApiIdentityProviderInDocument | + try: # Post Identity Providers api_response = api_instance.create_entity_identity_providers(json_api_identity_provider_in_document) + print("The response of IdentityProvidersApi->create_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling IdentityProvidersApi->create_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | + **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | ### Return type @@ -95,7 +73,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -105,7 +82,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_identity_providers** -> delete_entity_identity_providers(id) +> delete_entity_identity_providers(id, filter=filter) Delete Identity Provider @@ -113,10 +90,10 @@ Delete Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import identity_providers_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -125,35 +102,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = identity_providers_api.IdentityProvidersApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.IdentityProvidersApi(api_client) + id = 'id_example' # str | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Identity Provider - api_instance.delete_entity_identity_providers(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling IdentityProvidersApi->delete_entity_identity_providers: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Identity Provider api_instance.delete_entity_identity_providers(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling IdentityProvidersApi->delete_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -168,7 +138,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -178,7 +147,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_identity_providers** -> JsonApiIdentityProviderOutList get_all_entities_identity_providers() +> JsonApiIdentityProviderOutList get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Identity Providers @@ -186,11 +155,11 @@ Get all Identity Providers ```python -import time import gooddata_api_client -from gooddata_api_client.api import identity_providers_api -from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.models.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -199,39 +168,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = identity_providers_api.IdentityProvidersApi(api_client) - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.IdentityProvidersApi(api_client) + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Identity Providers api_response = api_instance.get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of IdentityProvidersApi->get_all_entities_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling IdentityProvidersApi->get_all_entities_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -246,7 +212,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -256,7 +221,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_identity_providers** -> JsonApiIdentityProviderOutDocument get_entity_identity_providers(id) +> JsonApiIdentityProviderOutDocument get_entity_identity_providers(id, filter=filter) Get Identity Provider @@ -264,11 +229,11 @@ Get Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import identity_providers_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -277,37 +242,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = identity_providers_api.IdentityProvidersApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.IdentityProvidersApi(api_client) + id = 'id_example' # str | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Identity Provider - api_response = api_instance.get_entity_identity_providers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling IdentityProvidersApi->get_entity_identity_providers: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Identity Provider api_response = api_instance.get_entity_identity_providers(id, filter=filter) + print("The response of IdentityProvidersApi->get_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling IdentityProvidersApi->get_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -322,7 +280,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -332,7 +289,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_identity_providers_layout** -> [DeclarativeIdentityProvider] get_identity_providers_layout() +> List[DeclarativeIdentityProvider] get_identity_providers_layout() Get all identity providers layout @@ -342,11 +299,11 @@ Gets complete layout of identity providers. ```python -import time import gooddata_api_client -from gooddata_api_client.api import identity_providers_api -from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.models.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -355,26 +312,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = identity_providers_api.IdentityProvidersApi(api_client) + api_instance = gooddata_api_client.IdentityProvidersApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all identity providers layout api_response = api_instance.get_identity_providers_layout() + print("The response of IdentityProvidersApi->get_identity_providers_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling IdentityProvidersApi->get_identity_providers_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -[**[DeclarativeIdentityProvider]**](DeclarativeIdentityProvider.md) +[**List[DeclarativeIdentityProvider]**](DeclarativeIdentityProvider.md) ### Authorization @@ -385,7 +344,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -395,7 +353,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_identity_providers** -> JsonApiIdentityProviderOutDocument patch_entity_identity_providers(id, json_api_identity_provider_patch_document) +> JsonApiIdentityProviderOutDocument patch_entity_identity_providers(id, json_api_identity_provider_patch_document, filter=filter) Patch Identity Provider @@ -403,12 +361,12 @@ Patch Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import identity_providers_api -from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -417,63 +375,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = identity_providers_api.IdentityProvidersApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_identity_provider_patch_document = JsonApiIdentityProviderPatchDocument( - data=JsonApiIdentityProviderPatch( - attributes=JsonApiIdentityProviderInAttributes( - custom_claim_mapping={ - "key": "key_example", - }, - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - id="id1", - type="identityProvider", - ), - ) # JsonApiIdentityProviderPatchDocument | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Identity Provider - api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling IdentityProvidersApi->patch_entity_identity_providers: %s\n" % e) + api_instance = gooddata_api_client.IdentityProvidersApi(api_client) + id = 'id_example' # str | + json_api_identity_provider_patch_document = gooddata_api_client.JsonApiIdentityProviderPatchDocument() # JsonApiIdentityProviderPatchDocument | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Identity Provider api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, filter=filter) + print("The response of IdentityProvidersApi->patch_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling IdentityProvidersApi->patch_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_identity_provider_patch_document** | [**JsonApiIdentityProviderPatchDocument**](JsonApiIdentityProviderPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_identity_provider_patch_document** | [**JsonApiIdentityProviderPatchDocument**](JsonApiIdentityProviderPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -488,7 +415,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -508,11 +434,11 @@ Sets identity providers in organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import identity_providers_api -from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.models.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -521,46 +447,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = identity_providers_api.IdentityProvidersApi(api_client) - declarative_identity_provider = [ - DeclarativeIdentityProvider( - custom_claim_mapping={ - "key": "key_example", - }, - id="filterView-1", - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - ] # [DeclarativeIdentityProvider] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.IdentityProvidersApi(api_client) + declarative_identity_provider = [gooddata_api_client.DeclarativeIdentityProvider()] # List[DeclarativeIdentityProvider] | + try: # Set all identity providers api_instance.set_identity_providers(declarative_identity_provider) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling IdentityProvidersApi->set_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_identity_provider** | [**[DeclarativeIdentityProvider]**](DeclarativeIdentityProvider.md)| | + **declarative_identity_provider** | [**List[DeclarativeIdentityProvider]**](DeclarativeIdentityProvider.md)| | ### Return type @@ -575,7 +481,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -585,7 +490,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_identity_providers** -> JsonApiIdentityProviderOutDocument update_entity_identity_providers(id, json_api_identity_provider_in_document) +> JsonApiIdentityProviderOutDocument update_entity_identity_providers(id, json_api_identity_provider_in_document, filter=filter) Put Identity Provider @@ -593,12 +498,12 @@ Put Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import identity_providers_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -607,63 +512,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = identity_providers_api.IdentityProvidersApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_identity_provider_in_document = JsonApiIdentityProviderInDocument( - data=JsonApiIdentityProviderIn( - attributes=JsonApiIdentityProviderInAttributes( - custom_claim_mapping={ - "key": "key_example", - }, - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - id="id1", - type="identityProvider", - ), - ) # JsonApiIdentityProviderInDocument | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Identity Provider - api_response = api_instance.update_entity_identity_providers(id, json_api_identity_provider_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling IdentityProvidersApi->update_entity_identity_providers: %s\n" % e) + api_instance = gooddata_api_client.IdentityProvidersApi(api_client) + id = 'id_example' # str | + json_api_identity_provider_in_document = gooddata_api_client.JsonApiIdentityProviderInDocument() # JsonApiIdentityProviderInDocument | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Identity Provider api_response = api_instance.update_entity_identity_providers(id, json_api_identity_provider_in_document, filter=filter) + print("The response of IdentityProvidersApi->update_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling IdentityProvidersApi->update_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -678,7 +552,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ImageExportApi.md b/gooddata-api-client/docs/ImageExportApi.md index 52aa305f1..b690d7470 100644 --- a/gooddata-api-client/docs/ImageExportApi.md +++ b/gooddata-api-client/docs/ImageExportApi.md @@ -20,12 +20,12 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import image_export_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.image_export_request import ImageExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.image_export_request import ImageExportRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -34,36 +34,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = image_export_api.ImageExportApi(api_client) - workspace_id = "workspaceId_example" # str | - image_export_request = ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ) # ImageExportRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ImageExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + image_export_request = gooddata_api_client.ImageExportRequest() # ImageExportRequest | + try: # (EXPERIMENTAL) Create image export request api_response = api_instance.create_image_export(workspace_id, image_export_request) + print("The response of ImageExportApi->create_image_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ImageExportApi->create_image_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **image_export_request** | [**ImageExportRequest**](ImageExportRequest.md)| | + **workspace_id** | **str**| | + **image_export_request** | [**ImageExportRequest**](ImageExportRequest.md)| | ### Return type @@ -78,7 +72,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -88,7 +81,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_image_export** -> file_type get_image_export(workspace_id, export_id) +> bytearray get_image_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -98,11 +91,10 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import image_export_api -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -111,32 +103,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = image_export_api.ImageExportApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.ImageExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files api_response = api_instance.get_image_export(workspace_id, export_id) + print("The response of ImageExportApi->get_image_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ImageExportApi->get_image_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -**file_type** +**bytearray** ### Authorization @@ -147,7 +141,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: image/png - ### HTTP response details | Status code | Description | Response headers | @@ -168,10 +161,10 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import image_export_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -180,27 +173,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = image_export_api.ImageExportApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.ImageExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve metadata context api_instance.get_image_export_metadata(workspace_id, export_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ImageExportApi->get_image_export_metadata: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type @@ -215,7 +209,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ImageExportRequest.md b/gooddata-api-client/docs/ImageExportRequest.md index 13a9a99ff..8c44b06a9 100644 --- a/gooddata-api-client/docs/ImageExportRequest.md +++ b/gooddata-api-client/docs/ImageExportRequest.md @@ -3,15 +3,32 @@ Export request object describing the export properties and metadata for image exports. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dashboard_id** | **str** | Dashboard identifier | **file_name** | **str** | File name to be used for retrieving the image document. | -**widget_ids** | **[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | -**format** | **str** | Requested resulting file type. | defaults to "PNG" -**metadata** | [**JsonNode**](JsonNode.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**format** | **str** | Requested resulting file type. | +**metadata** | **object** | Free-form JSON object | [optional] +**widget_ids** | **List[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | + +## Example + +```python +from gooddata_api_client.models.image_export_request import ImageExportRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ImageExportRequest from a JSON string +image_export_request_instance = ImageExportRequest.from_json(json) +# print the JSON string representation of the object +print(ImageExportRequest.to_json()) +# convert the object into a dict +image_export_request_dict = image_export_request_instance.to_dict() +# create an instance of ImageExportRequest from a dict +image_export_request_from_dict = ImageExportRequest.from_dict(image_export_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/InPlatform.md b/gooddata-api-client/docs/InPlatform.md index 8c505bc23..e55694689 100644 --- a/gooddata-api-client/docs/InPlatform.md +++ b/gooddata-api-client/docs/InPlatform.md @@ -3,11 +3,28 @@ In-platform destination for notifications. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | The destination type. | defaults to "IN_PLATFORM" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | The destination type. | + +## Example + +```python +from gooddata_api_client.models.in_platform import InPlatform + +# TODO update the JSON string below +json = "{}" +# create an instance of InPlatform from a JSON string +in_platform_instance = InPlatform.from_json(json) +# print the JSON string representation of the object +print(InPlatform.to_json()) +# convert the object into a dict +in_platform_dict = in_platform_instance.to_dict() +# create an instance of InPlatform from a dict +in_platform_from_dict = InPlatform.from_dict(in_platform_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/InPlatformAllOf.md b/gooddata-api-client/docs/InPlatformAllOf.md deleted file mode 100644 index c92d7a952..000000000 --- a/gooddata-api-client/docs/InPlatformAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# InPlatformAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | The destination type. | [optional] if omitted the server will use the default value of "IN_PLATFORM" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/InlineFilterDefinition.md b/gooddata-api-client/docs/InlineFilterDefinition.md index 239096975..269c3cf78 100644 --- a/gooddata-api-client/docs/InlineFilterDefinition.md +++ b/gooddata-api-client/docs/InlineFilterDefinition.md @@ -3,11 +3,28 @@ Filter in form of direct MAQL query. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **inline** | [**InlineFilterDefinitionInline**](InlineFilterDefinitionInline.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.inline_filter_definition import InlineFilterDefinition + +# TODO update the JSON string below +json = "{}" +# create an instance of InlineFilterDefinition from a JSON string +inline_filter_definition_instance = InlineFilterDefinition.from_json(json) +# print the JSON string representation of the object +print(InlineFilterDefinition.to_json()) + +# convert the object into a dict +inline_filter_definition_dict = inline_filter_definition_instance.to_dict() +# create an instance of InlineFilterDefinition from a dict +inline_filter_definition_from_dict = InlineFilterDefinition.from_dict(inline_filter_definition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/InlineFilterDefinitionInline.md b/gooddata-api-client/docs/InlineFilterDefinitionInline.md index 49adb1ef7..952d73ad7 100644 --- a/gooddata-api-client/docs/InlineFilterDefinitionInline.md +++ b/gooddata-api-client/docs/InlineFilterDefinitionInline.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**filter** | **str** | MAQL query representing the filter. | **apply_on_result** | **bool** | | [optional] +**filter** | **str** | MAQL query representing the filter. | **local_identifier** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.inline_filter_definition_inline import InlineFilterDefinitionInline + +# TODO update the JSON string below +json = "{}" +# create an instance of InlineFilterDefinitionInline from a JSON string +inline_filter_definition_inline_instance = InlineFilterDefinitionInline.from_json(json) +# print the JSON string representation of the object +print(InlineFilterDefinitionInline.to_json()) + +# convert the object into a dict +inline_filter_definition_inline_dict = inline_filter_definition_inline_instance.to_dict() +# create an instance of InlineFilterDefinitionInline from a dict +inline_filter_definition_inline_from_dict = InlineFilterDefinitionInline.from_dict(inline_filter_definition_inline_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/InlineMeasureDefinition.md b/gooddata-api-client/docs/InlineMeasureDefinition.md index fde0c6a47..d34d8b4e5 100644 --- a/gooddata-api-client/docs/InlineMeasureDefinition.md +++ b/gooddata-api-client/docs/InlineMeasureDefinition.md @@ -3,11 +3,28 @@ Metric defined by the raw MAQL query. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **inline** | [**InlineMeasureDefinitionInline**](InlineMeasureDefinitionInline.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.inline_measure_definition import InlineMeasureDefinition + +# TODO update the JSON string below +json = "{}" +# create an instance of InlineMeasureDefinition from a JSON string +inline_measure_definition_instance = InlineMeasureDefinition.from_json(json) +# print the JSON string representation of the object +print(InlineMeasureDefinition.to_json()) + +# convert the object into a dict +inline_measure_definition_dict = inline_measure_definition_instance.to_dict() +# create an instance of InlineMeasureDefinition from a dict +inline_measure_definition_from_dict = InlineMeasureDefinition.from_dict(inline_measure_definition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/InlineMeasureDefinitionInline.md b/gooddata-api-client/docs/InlineMeasureDefinitionInline.md index c7755b785..13acc9564 100644 --- a/gooddata-api-client/docs/InlineMeasureDefinitionInline.md +++ b/gooddata-api-client/docs/InlineMeasureDefinitionInline.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **maql** | **str** | MAQL query defining the metric. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.inline_measure_definition_inline import InlineMeasureDefinitionInline + +# TODO update the JSON string below +json = "{}" +# create an instance of InlineMeasureDefinitionInline from a JSON string +inline_measure_definition_inline_instance = InlineMeasureDefinitionInline.from_json(json) +# print the JSON string representation of the object +print(InlineMeasureDefinitionInline.to_json()) + +# convert the object into a dict +inline_measure_definition_inline_dict = inline_measure_definition_inline_instance.to_dict() +# create an instance of InlineMeasureDefinitionInline from a dict +inline_measure_definition_inline_from_dict = InlineMeasureDefinitionInline.from_dict(inline_measure_definition_inline_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/IntroSlideTemplate.md b/gooddata-api-client/docs/IntroSlideTemplate.md index b9c75a666..e68e4b8f7 100644 --- a/gooddata-api-client/docs/IntroSlideTemplate.md +++ b/gooddata-api-client/docs/IntroSlideTemplate.md @@ -3,15 +3,32 @@ Settings for intro slide. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**background_image** | **bool** | Show background image on the slide. | [optional] if omitted the server will use the default value of True -**description_field** | **str, none_type** | | [optional] +**background_image** | **bool** | Show background image on the slide. | [optional] [default to True] +**description_field** | **str** | | [optional] **footer** | [**RunningSection**](RunningSection.md) | | [optional] **header** | [**RunningSection**](RunningSection.md) | | [optional] -**title_field** | **str, none_type** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**title_field** | **str** | | [optional] + +## Example + +```python +from gooddata_api_client.models.intro_slide_template import IntroSlideTemplate + +# TODO update the JSON string below +json = "{}" +# create an instance of IntroSlideTemplate from a JSON string +intro_slide_template_instance = IntroSlideTemplate.from_json(json) +# print the JSON string representation of the object +print(IntroSlideTemplate.to_json()) +# convert the object into a dict +intro_slide_template_dict = intro_slide_template_instance.to_dict() +# create an instance of IntroSlideTemplate from a dict +intro_slide_template_from_dict = IntroSlideTemplate.from_dict(intro_slide_template_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/InvalidateCacheApi.md b/gooddata-api-client/docs/InvalidateCacheApi.md index 3c740aafe..ee1ba7d24 100644 --- a/gooddata-api-client/docs/InvalidateCacheApi.md +++ b/gooddata-api-client/docs/InvalidateCacheApi.md @@ -18,10 +18,10 @@ Notification sets up all reports to be computed again with new data. ```python -import time import gooddata_api_client -from gooddata_api_client.api import invalidate_cache_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -30,25 +30,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = invalidate_cache_api.InvalidateCacheApi(api_client) - data_source_id = "dataSourceId_example" # str | + api_instance = gooddata_api_client.InvalidateCacheApi(api_client) + data_source_id = 'data_source_id_example' # str | - # example passing only required values which don't have defaults set try: # Register an upload notification api_instance.register_upload_notification(data_source_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling InvalidateCacheApi->register_upload_notification: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | + **data_source_id** | **str**| | ### Return type @@ -63,7 +64,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/JWKSApi.md b/gooddata-api-client/docs/JWKSApi.md index 1aec164d6..58e785b9c 100644 --- a/gooddata-api-client/docs/JWKSApi.md +++ b/gooddata-api-client/docs/JWKSApi.md @@ -23,12 +23,12 @@ Creates JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import jwks_api -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -37,34 +37,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = jwks_api.JWKSApi(api_client) - json_api_jwk_in_document = JsonApiJwkInDocument( - data=JsonApiJwkIn( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), - ), - id="id1", - type="jwk", - ), - ) # JsonApiJwkInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.JWKSApi(api_client) + json_api_jwk_in_document = gooddata_api_client.JsonApiJwkInDocument() # JsonApiJwkInDocument | + try: # Post Jwks api_response = api_instance.create_entity_jwks(json_api_jwk_in_document) + print("The response of JWKSApi->create_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling JWKSApi->create_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | + **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | ### Return type @@ -79,7 +73,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -89,7 +82,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_jwks** -> delete_entity_jwks(id) +> delete_entity_jwks(id, filter=filter) Delete Jwk @@ -99,10 +92,10 @@ Deletes JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import jwks_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -111,35 +104,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = jwks_api.JWKSApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.JWKSApi(api_client) + id = 'id_example' # str | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Jwk - api_instance.delete_entity_jwks(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling JWKSApi->delete_entity_jwks: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Jwk api_instance.delete_entity_jwks(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling JWKSApi->delete_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -154,7 +140,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -164,7 +149,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_jwks** -> JsonApiJwkOutList get_all_entities_jwks() +> JsonApiJwkOutList get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Jwks @@ -174,11 +159,11 @@ Returns all JSON web keys - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import jwks_api -from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.models.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -187,39 +172,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = jwks_api.JWKSApi(api_client) - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.JWKSApi(api_client) + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Jwks api_response = api_instance.get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of JWKSApi->get_all_entities_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling JWKSApi->get_all_entities_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -234,7 +216,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -244,7 +225,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_jwks** -> JsonApiJwkOutDocument get_entity_jwks(id) +> JsonApiJwkOutDocument get_entity_jwks(id, filter=filter) Get Jwk @@ -254,11 +235,11 @@ Returns JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import jwks_api -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -267,37 +248,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = jwks_api.JWKSApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.JWKSApi(api_client) + id = 'id_example' # str | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Jwk - api_response = api_instance.get_entity_jwks(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling JWKSApi->get_entity_jwks: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Jwk api_response = api_instance.get_entity_jwks(id, filter=filter) + print("The response of JWKSApi->get_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling JWKSApi->get_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -312,7 +286,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -322,7 +295,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_jwks** -> JsonApiJwkOutDocument patch_entity_jwks(id, json_api_jwk_patch_document) +> JsonApiJwkOutDocument patch_entity_jwks(id, json_api_jwk_patch_document, filter=filter) Patch Jwk @@ -332,12 +305,12 @@ Patches JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import jwks_api -from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -346,47 +319,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = jwks_api.JWKSApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_jwk_patch_document = JsonApiJwkPatchDocument( - data=JsonApiJwkPatch( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), - ), - id="id1", - type="jwk", - ), - ) # JsonApiJwkPatchDocument | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Jwk - api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling JWKSApi->patch_entity_jwks: %s\n" % e) + api_instance = gooddata_api_client.JWKSApi(api_client) + id = 'id_example' # str | + json_api_jwk_patch_document = gooddata_api_client.JsonApiJwkPatchDocument() # JsonApiJwkPatchDocument | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Jwk api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document, filter=filter) + print("The response of JWKSApi->patch_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling JWKSApi->patch_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_jwk_patch_document** | [**JsonApiJwkPatchDocument**](JsonApiJwkPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_jwk_patch_document** | [**JsonApiJwkPatchDocument**](JsonApiJwkPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -401,7 +359,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -411,7 +368,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_jwks** -> JsonApiJwkOutDocument update_entity_jwks(id, json_api_jwk_in_document) +> JsonApiJwkOutDocument update_entity_jwks(id, json_api_jwk_in_document, filter=filter) Put Jwk @@ -421,12 +378,12 @@ Updates JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import jwks_api -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -435,47 +392,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = jwks_api.JWKSApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_jwk_in_document = JsonApiJwkInDocument( - data=JsonApiJwkIn( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), - ), - id="id1", - type="jwk", - ), - ) # JsonApiJwkInDocument | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Jwk - api_response = api_instance.update_entity_jwks(id, json_api_jwk_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling JWKSApi->update_entity_jwks: %s\n" % e) + api_instance = gooddata_api_client.JWKSApi(api_client) + id = 'id_example' # str | + json_api_jwk_in_document = gooddata_api_client.JsonApiJwkInDocument() # JsonApiJwkInDocument | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Jwk api_response = api_instance.update_entity_jwks(id, json_api_jwk_in_document, filter=filter) + print("The response of JWKSApi->update_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling JWKSApi->update_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -490,7 +432,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactLinkage.md b/gooddata-api-client/docs/JsonApiAggregatedFactLinkage.md index a52a0c15c..8f611b836 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactLinkage.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "aggregatedFact" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_linkage import JsonApiAggregatedFactLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactLinkage from a JSON string +json_api_aggregated_fact_linkage_instance = JsonApiAggregatedFactLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactLinkage.to_json()) +# convert the object into a dict +json_api_aggregated_fact_linkage_dict = json_api_aggregated_fact_linkage_instance.to_dict() +# create an instance of JsonApiAggregatedFactLinkage from a dict +json_api_aggregated_fact_linkage_from_dict = JsonApiAggregatedFactLinkage.from_dict(json_api_aggregated_fact_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOut.md b/gooddata-api-client/docs/JsonApiAggregatedFactOut.md index 38f82c677..2dc4b7010 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOut.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOut.md @@ -3,15 +3,32 @@ JSON:API representation of aggregatedFact entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAggregatedFactOutAttributes**](JsonApiAggregatedFactOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "aggregatedFact" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAggregatedFactOutRelationships**](JsonApiAggregatedFactOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out import JsonApiAggregatedFactOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOut from a JSON string +json_api_aggregated_fact_out_instance = JsonApiAggregatedFactOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOut.to_json()) +# convert the object into a dict +json_api_aggregated_fact_out_dict = json_api_aggregated_fact_out_instance.to_dict() +# create an instance of JsonApiAggregatedFactOut from a dict +json_api_aggregated_fact_out_from_dict = JsonApiAggregatedFactOut.from_dict(json_api_aggregated_fact_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOutAttributes.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutAttributes.md index 630fe92c7..b0f778f3b 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutAttributes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**operation** | **str** | | **are_relations_valid** | **bool** | | [optional] **description** | **str** | | [optional] +**operation** | **str** | | **source_column** | **str** | | [optional] **source_column_data_type** | **str** | | [optional] -**tags** | **[str]** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tags** | **List[str]** | | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out_attributes import JsonApiAggregatedFactOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOutAttributes from a JSON string +json_api_aggregated_fact_out_attributes_instance = JsonApiAggregatedFactOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOutAttributes.to_json()) +# convert the object into a dict +json_api_aggregated_fact_out_attributes_dict = json_api_aggregated_fact_out_attributes_instance.to_dict() +# create an instance of JsonApiAggregatedFactOutAttributes from a dict +json_api_aggregated_fact_out_attributes_from_dict = JsonApiAggregatedFactOutAttributes.from_dict(json_api_aggregated_fact_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOutDocument.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutDocument.md index c5efadc34..51a3bb573 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutDocument.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAggregatedFactOut**](JsonApiAggregatedFactOut.md) | | -**included** | [**[JsonApiAggregatedFactOutIncludes]**](JsonApiAggregatedFactOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiAggregatedFactOutIncludes]**](JsonApiAggregatedFactOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOutDocument from a JSON string +json_api_aggregated_fact_out_document_instance = JsonApiAggregatedFactOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOutDocument.to_json()) + +# convert the object into a dict +json_api_aggregated_fact_out_document_dict = json_api_aggregated_fact_out_document_instance.to_dict() +# create an instance of JsonApiAggregatedFactOutDocument from a dict +json_api_aggregated_fact_out_document_from_dict = JsonApiAggregatedFactOutDocument.from_dict(json_api_aggregated_fact_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOutIncludes.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutIncludes.md index 616ec982a..2ba3ba4a4 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiFactOutAttributes**](JsonApiFactOutAttributes.md) | | +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiFactOutRelationships**](JsonApiFactOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**attributes** | [**JsonApiFactOutAttributes**](JsonApiFactOutAttributes.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "fact" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out_includes import JsonApiAggregatedFactOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOutIncludes from a JSON string +json_api_aggregated_fact_out_includes_instance = JsonApiAggregatedFactOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOutIncludes.to_json()) + +# convert the object into a dict +json_api_aggregated_fact_out_includes_dict = json_api_aggregated_fact_out_includes_instance.to_dict() +# create an instance of JsonApiAggregatedFactOutIncludes from a dict +json_api_aggregated_fact_out_includes_from_dict = JsonApiAggregatedFactOutIncludes.from_dict(json_api_aggregated_fact_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOutList.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutList.md index 44a25f7d0..ce32a40aa 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutList.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiAggregatedFactOutWithLinks]**](JsonApiAggregatedFactOutWithLinks.md) | | -**included** | [**[JsonApiAggregatedFactOutIncludes]**](JsonApiAggregatedFactOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiAggregatedFactOutWithLinks]**](JsonApiAggregatedFactOutWithLinks.md) | | +**included** | [**List[JsonApiAggregatedFactOutIncludes]**](JsonApiAggregatedFactOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOutList from a JSON string +json_api_aggregated_fact_out_list_instance = JsonApiAggregatedFactOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOutList.to_json()) + +# convert the object into a dict +json_api_aggregated_fact_out_list_dict = json_api_aggregated_fact_out_list_instance.to_dict() +# create an instance of JsonApiAggregatedFactOutList from a dict +json_api_aggregated_fact_out_list_from_dict = JsonApiAggregatedFactOutList.from_dict(json_api_aggregated_fact_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOutListMeta.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutListMeta.md index a2fb0ab00..17aefbc51 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutListMeta.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutListMeta.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **page** | [**PageMetadata**](PageMetadata.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOutListMeta from a JSON string +json_api_aggregated_fact_out_list_meta_instance = JsonApiAggregatedFactOutListMeta.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOutListMeta.to_json()) + +# convert the object into a dict +json_api_aggregated_fact_out_list_meta_dict = json_api_aggregated_fact_out_list_meta_instance.to_dict() +# create an instance of JsonApiAggregatedFactOutListMeta from a dict +json_api_aggregated_fact_out_list_meta_from_dict = JsonApiAggregatedFactOutListMeta.from_dict(json_api_aggregated_fact_out_list_meta_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOutMeta.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutMeta.md index 965daf5d1..74e2b534e 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutMeta.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutMeta.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **origin** | [**JsonApiAggregatedFactOutMetaOrigin**](JsonApiAggregatedFactOutMetaOrigin.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOutMeta from a JSON string +json_api_aggregated_fact_out_meta_instance = JsonApiAggregatedFactOutMeta.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOutMeta.to_json()) + +# convert the object into a dict +json_api_aggregated_fact_out_meta_dict = json_api_aggregated_fact_out_meta_instance.to_dict() +# create an instance of JsonApiAggregatedFactOutMeta from a dict +json_api_aggregated_fact_out_meta_from_dict = JsonApiAggregatedFactOutMeta.from_dict(json_api_aggregated_fact_out_meta_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOutMetaOrigin.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutMetaOrigin.md index 0cae36a1e..ff0ce4f6b 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutMetaOrigin.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutMetaOrigin.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **origin_id** | **str** | defines id of the workspace where the entity comes from | **origin_type** | **str** | defines type of the origin of the entity | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out_meta_origin import JsonApiAggregatedFactOutMetaOrigin + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOutMetaOrigin from a JSON string +json_api_aggregated_fact_out_meta_origin_instance = JsonApiAggregatedFactOutMetaOrigin.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOutMetaOrigin.to_json()) + +# convert the object into a dict +json_api_aggregated_fact_out_meta_origin_dict = json_api_aggregated_fact_out_meta_origin_instance.to_dict() +# create an instance of JsonApiAggregatedFactOutMetaOrigin from a dict +json_api_aggregated_fact_out_meta_origin_from_dict = JsonApiAggregatedFactOutMetaOrigin.from_dict(json_api_aggregated_fact_out_meta_origin_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationships.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationships.md index c0bfe61eb..4cc438665 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationships.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dataset** | [**JsonApiAggregatedFactOutRelationshipsDataset**](JsonApiAggregatedFactOutRelationshipsDataset.md) | | [optional] **source_fact** | [**JsonApiAggregatedFactOutRelationshipsSourceFact**](JsonApiAggregatedFactOutRelationshipsSourceFact.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships import JsonApiAggregatedFactOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOutRelationships from a JSON string +json_api_aggregated_fact_out_relationships_instance = JsonApiAggregatedFactOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOutRelationships.to_json()) + +# convert the object into a dict +json_api_aggregated_fact_out_relationships_dict = json_api_aggregated_fact_out_relationships_instance.to_dict() +# create an instance of JsonApiAggregatedFactOutRelationships from a dict +json_api_aggregated_fact_out_relationships_from_dict = JsonApiAggregatedFactOutRelationships.from_dict(json_api_aggregated_fact_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationshipsDataset.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationshipsDataset.md index 89706dc48..1262f84ff 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationshipsDataset.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationshipsDataset.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiDatasetToOneLinkage**](JsonApiDatasetToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships_dataset import JsonApiAggregatedFactOutRelationshipsDataset + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOutRelationshipsDataset from a JSON string +json_api_aggregated_fact_out_relationships_dataset_instance = JsonApiAggregatedFactOutRelationshipsDataset.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOutRelationshipsDataset.to_json()) + +# convert the object into a dict +json_api_aggregated_fact_out_relationships_dataset_dict = json_api_aggregated_fact_out_relationships_dataset_instance.to_dict() +# create an instance of JsonApiAggregatedFactOutRelationshipsDataset from a dict +json_api_aggregated_fact_out_relationships_dataset_from_dict = JsonApiAggregatedFactOutRelationshipsDataset.from_dict(json_api_aggregated_fact_out_relationships_dataset_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationshipsSourceFact.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationshipsSourceFact.md index 6270a1a52..d3cbaf74f 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationshipsSourceFact.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutRelationshipsSourceFact.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiFactToOneLinkage**](JsonApiFactToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships_source_fact import JsonApiAggregatedFactOutRelationshipsSourceFact + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOutRelationshipsSourceFact from a JSON string +json_api_aggregated_fact_out_relationships_source_fact_instance = JsonApiAggregatedFactOutRelationshipsSourceFact.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOutRelationshipsSourceFact.to_json()) + +# convert the object into a dict +json_api_aggregated_fact_out_relationships_source_fact_dict = json_api_aggregated_fact_out_relationships_source_fact_instance.to_dict() +# create an instance of JsonApiAggregatedFactOutRelationshipsSourceFact from a dict +json_api_aggregated_fact_out_relationships_source_fact_from_dict = JsonApiAggregatedFactOutRelationshipsSourceFact.from_dict(json_api_aggregated_fact_out_relationships_source_fact_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactOutWithLinks.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutWithLinks.md index d435fc3b5..02024525f 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAggregatedFactOutAttributes**](JsonApiAggregatedFactOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "aggregatedFact" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAggregatedFactOutRelationships**](JsonApiAggregatedFactOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_aggregated_fact_out_with_links import JsonApiAggregatedFactOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAggregatedFactOutWithLinks from a JSON string +json_api_aggregated_fact_out_with_links_instance = JsonApiAggregatedFactOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiAggregatedFactOutWithLinks.to_json()) + +# convert the object into a dict +json_api_aggregated_fact_out_with_links_dict = json_api_aggregated_fact_out_with_links_instance.to_dict() +# create an instance of JsonApiAggregatedFactOutWithLinks from a dict +json_api_aggregated_fact_out_with_links_from_dict = JsonApiAggregatedFactOutWithLinks.from_dict(json_api_aggregated_fact_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAggregatedFactToManyLinkage.md b/gooddata-api-client/docs/JsonApiAggregatedFactToManyLinkage.md deleted file mode 100644 index 3f8d4c0aa..000000000 --- a/gooddata-api-client/docs/JsonApiAggregatedFactToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiAggregatedFactToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiAggregatedFactLinkage]**](JsonApiAggregatedFactLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardIn.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardIn.md index e210fb564..6cb813f15 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardIn.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardIn.md @@ -3,13 +3,30 @@ JSON:API representation of analyticalDashboard entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAnalyticalDashboardInAttributes**](JsonApiAnalyticalDashboardInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "analyticalDashboard" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_in import JsonApiAnalyticalDashboardIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardIn from a JSON string +json_api_analytical_dashboard_in_instance = JsonApiAnalyticalDashboardIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardIn.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_in_dict = json_api_analytical_dashboard_in_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardIn from a dict +json_api_analytical_dashboard_in_from_dict = JsonApiAnalyticalDashboardIn.from_dict(json_api_analytical_dashboard_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardInAttributes.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardInAttributes.md index 77c0ba7de..544712780 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardInAttributes.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardInAttributes.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | **are_relations_valid** | **bool** | | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 250000 characters. | **description** | **str** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardInAttributes from a JSON string +json_api_analytical_dashboard_in_attributes_instance = JsonApiAnalyticalDashboardInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardInAttributes.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_in_attributes_dict = json_api_analytical_dashboard_in_attributes_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardInAttributes from a dict +json_api_analytical_dashboard_in_attributes_from_dict = JsonApiAnalyticalDashboardInAttributes.from_dict(json_api_analytical_dashboard_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardInDocument.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardInDocument.md index ea34f887a..0fc529d4d 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardInDocument.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAnalyticalDashboardIn**](JsonApiAnalyticalDashboardIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardInDocument from a JSON string +json_api_analytical_dashboard_in_document_instance = JsonApiAnalyticalDashboardInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardInDocument.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_in_document_dict = json_api_analytical_dashboard_in_document_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardInDocument from a dict +json_api_analytical_dashboard_in_document_from_dict = JsonApiAnalyticalDashboardInDocument.from_dict(json_api_analytical_dashboard_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardLinkage.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardLinkage.md index c6e962241..4e22d05fc 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardLinkage.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "analyticalDashboard" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_linkage import JsonApiAnalyticalDashboardLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardLinkage from a JSON string +json_api_analytical_dashboard_linkage_instance = JsonApiAnalyticalDashboardLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardLinkage.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_linkage_dict = json_api_analytical_dashboard_linkage_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardLinkage from a dict +json_api_analytical_dashboard_linkage_from_dict = JsonApiAnalyticalDashboardLinkage.from_dict(json_api_analytical_dashboard_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOut.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOut.md index b17936ee9..c80c6ee65 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOut.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOut.md @@ -3,15 +3,32 @@ JSON:API representation of analyticalDashboard entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAnalyticalDashboardOutAttributes**](JsonApiAnalyticalDashboardOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "analyticalDashboard" **meta** | [**JsonApiAnalyticalDashboardOutMeta**](JsonApiAnalyticalDashboardOutMeta.md) | | [optional] **relationships** | [**JsonApiAnalyticalDashboardOutRelationships**](JsonApiAnalyticalDashboardOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOut from a JSON string +json_api_analytical_dashboard_out_instance = JsonApiAnalyticalDashboardOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOut.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_out_dict = json_api_analytical_dashboard_out_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOut from a dict +json_api_analytical_dashboard_out_from_dict = JsonApiAnalyticalDashboardOut.from_dict(json_api_analytical_dashboard_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutAttributes.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutAttributes.md index df6cbde62..7be34746e 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutAttributes.md @@ -2,17 +2,34 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | **are_relations_valid** | **bool** | | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 250000 characters. | **created_at** | **datetime** | | [optional] **description** | **str** | | [optional] **modified_at** | **datetime** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_attributes import JsonApiAnalyticalDashboardOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutAttributes from a JSON string +json_api_analytical_dashboard_out_attributes_instance = JsonApiAnalyticalDashboardOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutAttributes.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_out_attributes_dict = json_api_analytical_dashboard_out_attributes_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutAttributes from a dict +json_api_analytical_dashboard_out_attributes_from_dict = JsonApiAnalyticalDashboardOutAttributes.from_dict(json_api_analytical_dashboard_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutDocument.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutDocument.md index c4d31f1e7..fccf9e60e 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutDocument.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAnalyticalDashboardOut**](JsonApiAnalyticalDashboardOut.md) | | -**included** | [**[JsonApiAnalyticalDashboardOutIncludes]**](JsonApiAnalyticalDashboardOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiAnalyticalDashboardOutIncludes]**](JsonApiAnalyticalDashboardOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutDocument from a JSON string +json_api_analytical_dashboard_out_document_instance = JsonApiAnalyticalDashboardOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutDocument.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_out_document_dict = json_api_analytical_dashboard_out_document_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutDocument from a dict +json_api_analytical_dashboard_out_document_from_dict = JsonApiAnalyticalDashboardOutDocument.from_dict(json_api_analytical_dashboard_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutIncludes.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutIncludes.md index b7ac3f3be..b42fb2984 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiDashboardPluginOutAttributes**](JsonApiDashboardPluginOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiDashboardPluginOutRelationships**](JsonApiDashboardPluginOutRelationships.md) | | [optional] -**attributes** | [**JsonApiDashboardPluginOutAttributes**](JsonApiDashboardPluginOutAttributes.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "dashboardPlugin" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutIncludes from a JSON string +json_api_analytical_dashboard_out_includes_instance = JsonApiAnalyticalDashboardOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutIncludes.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_out_includes_dict = json_api_analytical_dashboard_out_includes_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutIncludes from a dict +json_api_analytical_dashboard_out_includes_from_dict = JsonApiAnalyticalDashboardOutIncludes.from_dict(json_api_analytical_dashboard_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutList.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutList.md index beb5c8272..e1220ff64 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutList.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiAnalyticalDashboardOutWithLinks]**](JsonApiAnalyticalDashboardOutWithLinks.md) | | -**included** | [**[JsonApiAnalyticalDashboardOutIncludes]**](JsonApiAnalyticalDashboardOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiAnalyticalDashboardOutWithLinks]**](JsonApiAnalyticalDashboardOutWithLinks.md) | | +**included** | [**List[JsonApiAnalyticalDashboardOutIncludes]**](JsonApiAnalyticalDashboardOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutList from a JSON string +json_api_analytical_dashboard_out_list_instance = JsonApiAnalyticalDashboardOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutList.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_out_list_dict = json_api_analytical_dashboard_out_list_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutList from a dict +json_api_analytical_dashboard_out_list_from_dict = JsonApiAnalyticalDashboardOutList.from_dict(json_api_analytical_dashboard_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutMeta.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutMeta.md index c69d3e8a7..ac4921fa8 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutMeta.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutMeta.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **access_info** | [**JsonApiAnalyticalDashboardOutMetaAccessInfo**](JsonApiAnalyticalDashboardOutMetaAccessInfo.md) | | [optional] **origin** | [**JsonApiAggregatedFactOutMetaOrigin**](JsonApiAggregatedFactOutMetaOrigin.md) | | [optional] -**permissions** | **[str]** | List of valid permissions for a logged-in user. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | **List[str]** | List of valid permissions for a logged-in user. | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_meta import JsonApiAnalyticalDashboardOutMeta + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutMeta from a JSON string +json_api_analytical_dashboard_out_meta_instance = JsonApiAnalyticalDashboardOutMeta.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutMeta.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_out_meta_dict = json_api_analytical_dashboard_out_meta_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutMeta from a dict +json_api_analytical_dashboard_out_meta_from_dict = JsonApiAnalyticalDashboardOutMeta.from_dict(json_api_analytical_dashboard_out_meta_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutMetaAccessInfo.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutMetaAccessInfo.md index d881b598a..8ece0e9eb 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutMetaAccessInfo.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutMetaAccessInfo.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **private** | **bool** | is the entity private to the currently logged-in user | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_meta_access_info import JsonApiAnalyticalDashboardOutMetaAccessInfo + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutMetaAccessInfo from a JSON string +json_api_analytical_dashboard_out_meta_access_info_instance = JsonApiAnalyticalDashboardOutMetaAccessInfo.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutMetaAccessInfo.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_out_meta_access_info_dict = json_api_analytical_dashboard_out_meta_access_info_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutMetaAccessInfo from a dict +json_api_analytical_dashboard_out_meta_access_info_from_dict = JsonApiAnalyticalDashboardOutMetaAccessInfo.from_dict(json_api_analytical_dashboard_out_meta_access_info_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md index 268c5c89d..58cd2f71e 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboards** | [**JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards**](JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md) | | [optional] @@ -13,8 +14,24 @@ Name | Type | Description | Notes **metrics** | [**JsonApiAnalyticalDashboardOutRelationshipsMetrics**](JsonApiAnalyticalDashboardOutRelationshipsMetrics.md) | | [optional] **modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] **visualization_objects** | [**JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects**](JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships import JsonApiAnalyticalDashboardOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutRelationships from a JSON string +json_api_analytical_dashboard_out_relationships_instance = JsonApiAnalyticalDashboardOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutRelationships.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_out_relationships_dict = json_api_analytical_dashboard_out_relationships_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutRelationships from a dict +json_api_analytical_dashboard_out_relationships_from_dict = JsonApiAnalyticalDashboardOutRelationships.from_dict(json_api_analytical_dashboard_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md index 4053ef673..9a5614f56 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiAnalyticalDashboardToManyLinkage**](JsonApiAnalyticalDashboardToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiAnalyticalDashboardLinkage]**](JsonApiAnalyticalDashboardLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_analytical_dashboards import JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards from a JSON string +json_api_analytical_dashboard_out_relationships_analytical_dashboards_instance = JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_out_relationships_analytical_dashboards_dict = json_api_analytical_dashboard_out_relationships_analytical_dashboards_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards from a dict +json_api_analytical_dashboard_out_relationships_analytical_dashboards_from_dict = JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.from_dict(json_api_analytical_dashboard_out_relationships_analytical_dashboards_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md index 93256df3f..0a67008f9 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsCreatedBy from a JSON string +json_api_analytical_dashboard_out_relationships_created_by_instance = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_out_relationships_created_by_dict = json_api_analytical_dashboard_out_relationships_created_by_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsCreatedBy from a dict +json_api_analytical_dashboard_out_relationships_created_by_from_dict = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(json_api_analytical_dashboard_out_relationships_created_by_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.md index d6ee48d3e..05e8fa39b 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiDashboardPluginToManyLinkage**](JsonApiDashboardPluginToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiDashboardPluginLinkage]**](JsonApiDashboardPluginLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_dashboard_plugins import JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins from a JSON string +json_api_analytical_dashboard_out_relationships_dashboard_plugins_instance = JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_out_relationships_dashboard_plugins_dict = json_api_analytical_dashboard_out_relationships_dashboard_plugins_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins from a dict +json_api_analytical_dashboard_out_relationships_dashboard_plugins_from_dict = JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.from_dict(json_api_analytical_dashboard_out_relationships_dashboard_plugins_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsDatasets.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsDatasets.md index f497dca3e..385099ddb 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsDatasets.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsDatasets.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiDatasetToManyLinkage**](JsonApiDatasetToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiDatasetLinkage]**](JsonApiDatasetLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsDatasets from a JSON string +json_api_analytical_dashboard_out_relationships_datasets_instance = JsonApiAnalyticalDashboardOutRelationshipsDatasets.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutRelationshipsDatasets.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_out_relationships_datasets_dict = json_api_analytical_dashboard_out_relationships_datasets_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsDatasets from a dict +json_api_analytical_dashboard_out_relationships_datasets_from_dict = JsonApiAnalyticalDashboardOutRelationshipsDatasets.from_dict(json_api_analytical_dashboard_out_relationships_datasets_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.md index 15c8f5235..5fa0978d7 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiFilterContextToManyLinkage**](JsonApiFilterContextToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiFilterContextLinkage]**](JsonApiFilterContextLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_filter_contexts import JsonApiAnalyticalDashboardOutRelationshipsFilterContexts + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsFilterContexts from a JSON string +json_api_analytical_dashboard_out_relationships_filter_contexts_instance = JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_out_relationships_filter_contexts_dict = json_api_analytical_dashboard_out_relationships_filter_contexts_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsFilterContexts from a dict +json_api_analytical_dashboard_out_relationships_filter_contexts_from_dict = JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.from_dict(json_api_analytical_dashboard_out_relationships_filter_contexts_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsLabels.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsLabels.md index 7f9eaa4e0..eb6d0ee13 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsLabels.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsLabels.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiLabelToManyLinkage**](JsonApiLabelToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiLabelLinkage]**](JsonApiLabelLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsLabels from a JSON string +json_api_analytical_dashboard_out_relationships_labels_instance = JsonApiAnalyticalDashboardOutRelationshipsLabels.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutRelationshipsLabels.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_out_relationships_labels_dict = json_api_analytical_dashboard_out_relationships_labels_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsLabels from a dict +json_api_analytical_dashboard_out_relationships_labels_from_dict = JsonApiAnalyticalDashboardOutRelationshipsLabels.from_dict(json_api_analytical_dashboard_out_relationships_labels_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsMetrics.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsMetrics.md index ff3a92c67..2adb8b403 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsMetrics.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsMetrics.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiMetricToManyLinkage**](JsonApiMetricToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiMetricLinkage]**](JsonApiMetricLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsMetrics from a JSON string +json_api_analytical_dashboard_out_relationships_metrics_instance = JsonApiAnalyticalDashboardOutRelationshipsMetrics.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutRelationshipsMetrics.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_out_relationships_metrics_dict = json_api_analytical_dashboard_out_relationships_metrics_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsMetrics from a dict +json_api_analytical_dashboard_out_relationships_metrics_from_dict = JsonApiAnalyticalDashboardOutRelationshipsMetrics.from_dict(json_api_analytical_dashboard_out_relationships_metrics_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.md index 567653504..b42f937ad 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiVisualizationObjectToManyLinkage**](JsonApiVisualizationObjectToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiVisualizationObjectLinkage]**](JsonApiVisualizationObjectLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_visualization_objects import JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects from a JSON string +json_api_analytical_dashboard_out_relationships_visualization_objects_instance = JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_out_relationships_visualization_objects_dict = json_api_analytical_dashboard_out_relationships_visualization_objects_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects from a dict +json_api_analytical_dashboard_out_relationships_visualization_objects_from_dict = JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.from_dict(json_api_analytical_dashboard_out_relationships_visualization_objects_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutWithLinks.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutWithLinks.md index 12816b621..b87852ad8 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAnalyticalDashboardOutAttributes**](JsonApiAnalyticalDashboardOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "analyticalDashboard" **meta** | [**JsonApiAnalyticalDashboardOutMeta**](JsonApiAnalyticalDashboardOutMeta.md) | | [optional] **relationships** | [**JsonApiAnalyticalDashboardOutRelationships**](JsonApiAnalyticalDashboardOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardOutWithLinks from a JSON string +json_api_analytical_dashboard_out_with_links_instance = JsonApiAnalyticalDashboardOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardOutWithLinks.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_out_with_links_dict = json_api_analytical_dashboard_out_with_links_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardOutWithLinks from a dict +json_api_analytical_dashboard_out_with_links_from_dict = JsonApiAnalyticalDashboardOutWithLinks.from_dict(json_api_analytical_dashboard_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatch.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatch.md index d3f7962b7..0ee517bb3 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatch.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching analyticalDashboard entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAnalyticalDashboardPatchAttributes**](JsonApiAnalyticalDashboardPatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "analyticalDashboard" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_patch import JsonApiAnalyticalDashboardPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardPatch from a JSON string +json_api_analytical_dashboard_patch_instance = JsonApiAnalyticalDashboardPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardPatch.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_patch_dict = json_api_analytical_dashboard_patch_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardPatch from a dict +json_api_analytical_dashboard_patch_from_dict = JsonApiAnalyticalDashboardPatch.from_dict(json_api_analytical_dashboard_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatchAttributes.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatchAttributes.md index d7b4b8d05..3017f6e4b 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatchAttributes.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 250000 characters. | [optional] **description** | **str** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_patch_attributes import JsonApiAnalyticalDashboardPatchAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardPatchAttributes from a JSON string +json_api_analytical_dashboard_patch_attributes_instance = JsonApiAnalyticalDashboardPatchAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardPatchAttributes.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_patch_attributes_dict = json_api_analytical_dashboard_patch_attributes_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardPatchAttributes from a dict +json_api_analytical_dashboard_patch_attributes_from_dict = JsonApiAnalyticalDashboardPatchAttributes.from_dict(json_api_analytical_dashboard_patch_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatchDocument.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatchDocument.md index 524787815..dfac2c1f9 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAnalyticalDashboardPatch**](JsonApiAnalyticalDashboardPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardPatchDocument from a JSON string +json_api_analytical_dashboard_patch_document_instance = JsonApiAnalyticalDashboardPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardPatchDocument.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_patch_document_dict = json_api_analytical_dashboard_patch_document_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardPatchDocument from a dict +json_api_analytical_dashboard_patch_document_from_dict = JsonApiAnalyticalDashboardPatchDocument.from_dict(json_api_analytical_dashboard_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardPostOptionalId.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardPostOptionalId.md index d3286dc7b..af6c2ee50 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardPostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardPostOptionalId.md @@ -3,13 +3,30 @@ JSON:API representation of analyticalDashboard entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAnalyticalDashboardInAttributes**](JsonApiAnalyticalDashboardInAttributes.md) | | -**type** | **str** | Object type | defaults to "analyticalDashboard" **id** | **str** | API identifier of an object | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id import JsonApiAnalyticalDashboardPostOptionalId + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardPostOptionalId from a JSON string +json_api_analytical_dashboard_post_optional_id_instance = JsonApiAnalyticalDashboardPostOptionalId.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardPostOptionalId.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_post_optional_id_dict = json_api_analytical_dashboard_post_optional_id_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardPostOptionalId from a dict +json_api_analytical_dashboard_post_optional_id_from_dict = JsonApiAnalyticalDashboardPostOptionalId.from_dict(json_api_analytical_dashboard_post_optional_id_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardPostOptionalIdDocument.md index e2438254a..dcdc35dd6 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardPostOptionalIdDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAnalyticalDashboardPostOptionalId**](JsonApiAnalyticalDashboardPostOptionalId.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardPostOptionalIdDocument from a JSON string +json_api_analytical_dashboard_post_optional_id_document_instance = JsonApiAnalyticalDashboardPostOptionalIdDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardPostOptionalIdDocument.to_json()) + +# convert the object into a dict +json_api_analytical_dashboard_post_optional_id_document_dict = json_api_analytical_dashboard_post_optional_id_document_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardPostOptionalIdDocument from a dict +json_api_analytical_dashboard_post_optional_id_document_from_dict = JsonApiAnalyticalDashboardPostOptionalIdDocument.from_dict(json_api_analytical_dashboard_post_optional_id_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardToManyLinkage.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardToManyLinkage.md deleted file mode 100644 index d7b056ecd..000000000 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiAnalyticalDashboardToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiAnalyticalDashboardLinkage]**](JsonApiAnalyticalDashboardLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardToOneLinkage.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardToOneLinkage.md index 0bbac50ec..9b407ba28 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "analyticalDashboard" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAnalyticalDashboardToOneLinkage from a JSON string +json_api_analytical_dashboard_to_one_linkage_instance = JsonApiAnalyticalDashboardToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiAnalyticalDashboardToOneLinkage.to_json()) +# convert the object into a dict +json_api_analytical_dashboard_to_one_linkage_dict = json_api_analytical_dashboard_to_one_linkage_instance.to_dict() +# create an instance of JsonApiAnalyticalDashboardToOneLinkage from a dict +json_api_analytical_dashboard_to_one_linkage_from_dict = JsonApiAnalyticalDashboardToOneLinkage.from_dict(json_api_analytical_dashboard_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiApiTokenIn.md b/gooddata-api-client/docs/JsonApiApiTokenIn.md index 01318a344..6f69d2c3f 100644 --- a/gooddata-api-client/docs/JsonApiApiTokenIn.md +++ b/gooddata-api-client/docs/JsonApiApiTokenIn.md @@ -3,12 +3,29 @@ JSON:API representation of apiToken entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "apiToken" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_api_token_in import JsonApiApiTokenIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiApiTokenIn from a JSON string +json_api_api_token_in_instance = JsonApiApiTokenIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiApiTokenIn.to_json()) +# convert the object into a dict +json_api_api_token_in_dict = json_api_api_token_in_instance.to_dict() +# create an instance of JsonApiApiTokenIn from a dict +json_api_api_token_in_from_dict = JsonApiApiTokenIn.from_dict(json_api_api_token_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiApiTokenInDocument.md b/gooddata-api-client/docs/JsonApiApiTokenInDocument.md index 6f2dae18e..f59ba8bb2 100644 --- a/gooddata-api-client/docs/JsonApiApiTokenInDocument.md +++ b/gooddata-api-client/docs/JsonApiApiTokenInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiApiTokenIn**](JsonApiApiTokenIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiApiTokenInDocument from a JSON string +json_api_api_token_in_document_instance = JsonApiApiTokenInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiApiTokenInDocument.to_json()) + +# convert the object into a dict +json_api_api_token_in_document_dict = json_api_api_token_in_document_instance.to_dict() +# create an instance of JsonApiApiTokenInDocument from a dict +json_api_api_token_in_document_from_dict = JsonApiApiTokenInDocument.from_dict(json_api_api_token_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiApiTokenOut.md b/gooddata-api-client/docs/JsonApiApiTokenOut.md index 9973ab211..600fa20f5 100644 --- a/gooddata-api-client/docs/JsonApiApiTokenOut.md +++ b/gooddata-api-client/docs/JsonApiApiTokenOut.md @@ -3,13 +3,30 @@ JSON:API representation of apiToken entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "apiToken" **attributes** | [**JsonApiApiTokenOutAttributes**](JsonApiApiTokenOutAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_api_token_out import JsonApiApiTokenOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiApiTokenOut from a JSON string +json_api_api_token_out_instance = JsonApiApiTokenOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiApiTokenOut.to_json()) +# convert the object into a dict +json_api_api_token_out_dict = json_api_api_token_out_instance.to_dict() +# create an instance of JsonApiApiTokenOut from a dict +json_api_api_token_out_from_dict = JsonApiApiTokenOut.from_dict(json_api_api_token_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiApiTokenOutAttributes.md b/gooddata-api-client/docs/JsonApiApiTokenOutAttributes.md index 8c4ac5bc7..8ccbe5239 100644 --- a/gooddata-api-client/docs/JsonApiApiTokenOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiApiTokenOutAttributes.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bearer_token** | **str** | The value of the Bearer token. It is only returned when the API token is created. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_api_token_out_attributes import JsonApiApiTokenOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiApiTokenOutAttributes from a JSON string +json_api_api_token_out_attributes_instance = JsonApiApiTokenOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiApiTokenOutAttributes.to_json()) + +# convert the object into a dict +json_api_api_token_out_attributes_dict = json_api_api_token_out_attributes_instance.to_dict() +# create an instance of JsonApiApiTokenOutAttributes from a dict +json_api_api_token_out_attributes_from_dict = JsonApiApiTokenOutAttributes.from_dict(json_api_api_token_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiApiTokenOutDocument.md b/gooddata-api-client/docs/JsonApiApiTokenOutDocument.md index 0f8d0c67e..3315c2e19 100644 --- a/gooddata-api-client/docs/JsonApiApiTokenOutDocument.md +++ b/gooddata-api-client/docs/JsonApiApiTokenOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiApiTokenOut**](JsonApiApiTokenOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiApiTokenOutDocument from a JSON string +json_api_api_token_out_document_instance = JsonApiApiTokenOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiApiTokenOutDocument.to_json()) + +# convert the object into a dict +json_api_api_token_out_document_dict = json_api_api_token_out_document_instance.to_dict() +# create an instance of JsonApiApiTokenOutDocument from a dict +json_api_api_token_out_document_from_dict = JsonApiApiTokenOutDocument.from_dict(json_api_api_token_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiApiTokenOutList.md b/gooddata-api-client/docs/JsonApiApiTokenOutList.md index 748879296..364896188 100644 --- a/gooddata-api-client/docs/JsonApiApiTokenOutList.md +++ b/gooddata-api-client/docs/JsonApiApiTokenOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiApiTokenOutWithLinks]**](JsonApiApiTokenOutWithLinks.md) | | +**data** | [**List[JsonApiApiTokenOutWithLinks]**](JsonApiApiTokenOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiApiTokenOutList from a JSON string +json_api_api_token_out_list_instance = JsonApiApiTokenOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiApiTokenOutList.to_json()) + +# convert the object into a dict +json_api_api_token_out_list_dict = json_api_api_token_out_list_instance.to_dict() +# create an instance of JsonApiApiTokenOutList from a dict +json_api_api_token_out_list_from_dict = JsonApiApiTokenOutList.from_dict(json_api_api_token_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiApiTokenOutWithLinks.md b/gooddata-api-client/docs/JsonApiApiTokenOutWithLinks.md index 21723e0bd..2d6ef98ee 100644 --- a/gooddata-api-client/docs/JsonApiApiTokenOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiApiTokenOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "apiToken" **attributes** | [**JsonApiApiTokenOutAttributes**](JsonApiApiTokenOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_api_token_out_with_links import JsonApiApiTokenOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiApiTokenOutWithLinks from a JSON string +json_api_api_token_out_with_links_instance = JsonApiApiTokenOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiApiTokenOutWithLinks.to_json()) + +# convert the object into a dict +json_api_api_token_out_with_links_dict = json_api_api_token_out_with_links_instance.to_dict() +# create an instance of JsonApiApiTokenOutWithLinks from a dict +json_api_api_token_out_with_links_from_dict = JsonApiApiTokenOutWithLinks.from_dict(json_api_api_token_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyIn.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyIn.md index 92b2f4a13..e6bf6d7fe 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyIn.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyIn.md @@ -3,13 +3,30 @@ JSON:API representation of attributeHierarchy entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "attributeHierarchy" **attributes** | [**JsonApiAttributeHierarchyInAttributes**](JsonApiAttributeHierarchyInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_in import JsonApiAttributeHierarchyIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyIn from a JSON string +json_api_attribute_hierarchy_in_instance = JsonApiAttributeHierarchyIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyIn.to_json()) +# convert the object into a dict +json_api_attribute_hierarchy_in_dict = json_api_attribute_hierarchy_in_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyIn from a dict +json_api_attribute_hierarchy_in_from_dict = JsonApiAttributeHierarchyIn.from_dict(json_api_attribute_hierarchy_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyInAttributes.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyInAttributes.md index 3849b70aa..5641ef58f 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyInAttributes.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyInAttributes.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] **description** | **str** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_in_attributes import JsonApiAttributeHierarchyInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyInAttributes from a JSON string +json_api_attribute_hierarchy_in_attributes_instance = JsonApiAttributeHierarchyInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyInAttributes.to_json()) + +# convert the object into a dict +json_api_attribute_hierarchy_in_attributes_dict = json_api_attribute_hierarchy_in_attributes_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyInAttributes from a dict +json_api_attribute_hierarchy_in_attributes_from_dict = JsonApiAttributeHierarchyInAttributes.from_dict(json_api_attribute_hierarchy_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyInDocument.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyInDocument.md index 136f3ef43..b5df2c870 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyInDocument.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAttributeHierarchyIn**](JsonApiAttributeHierarchyIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyInDocument from a JSON string +json_api_attribute_hierarchy_in_document_instance = JsonApiAttributeHierarchyInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyInDocument.to_json()) + +# convert the object into a dict +json_api_attribute_hierarchy_in_document_dict = json_api_attribute_hierarchy_in_document_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyInDocument from a dict +json_api_attribute_hierarchy_in_document_from_dict = JsonApiAttributeHierarchyInDocument.from_dict(json_api_attribute_hierarchy_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyLinkage.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyLinkage.md index 2f32b42e3..c13a898ca 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyLinkage.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "attributeHierarchy" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_linkage import JsonApiAttributeHierarchyLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyLinkage from a JSON string +json_api_attribute_hierarchy_linkage_instance = JsonApiAttributeHierarchyLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyLinkage.to_json()) +# convert the object into a dict +json_api_attribute_hierarchy_linkage_dict = json_api_attribute_hierarchy_linkage_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyLinkage from a dict +json_api_attribute_hierarchy_linkage_from_dict = JsonApiAttributeHierarchyLinkage.from_dict(json_api_attribute_hierarchy_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyOut.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOut.md index 0619bb4a8..62593f351 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOut.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOut.md @@ -3,15 +3,32 @@ JSON:API representation of attributeHierarchy entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "attributeHierarchy" **attributes** | [**JsonApiAttributeHierarchyOutAttributes**](JsonApiAttributeHierarchyOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAttributeHierarchyOutRelationships**](JsonApiAttributeHierarchyOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_out import JsonApiAttributeHierarchyOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyOut from a JSON string +json_api_attribute_hierarchy_out_instance = JsonApiAttributeHierarchyOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyOut.to_json()) +# convert the object into a dict +json_api_attribute_hierarchy_out_dict = json_api_attribute_hierarchy_out_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyOut from a dict +json_api_attribute_hierarchy_out_from_dict = JsonApiAttributeHierarchyOut.from_dict(json_api_attribute_hierarchy_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutAttributes.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutAttributes.md index 268682ff7..7ae08ad19 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutAttributes.md @@ -2,17 +2,34 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] **created_at** | **datetime** | | [optional] **description** | **str** | | [optional] **modified_at** | **datetime** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_out_attributes import JsonApiAttributeHierarchyOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyOutAttributes from a JSON string +json_api_attribute_hierarchy_out_attributes_instance = JsonApiAttributeHierarchyOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyOutAttributes.to_json()) + +# convert the object into a dict +json_api_attribute_hierarchy_out_attributes_dict = json_api_attribute_hierarchy_out_attributes_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyOutAttributes from a dict +json_api_attribute_hierarchy_out_attributes_from_dict = JsonApiAttributeHierarchyOutAttributes.from_dict(json_api_attribute_hierarchy_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutDocument.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutDocument.md index 51deaf3bd..7ee15b48b 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutDocument.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAttributeHierarchyOut**](JsonApiAttributeHierarchyOut.md) | | -**included** | [**[JsonApiAttributeHierarchyOutIncludes]**](JsonApiAttributeHierarchyOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiAttributeHierarchyOutIncludes]**](JsonApiAttributeHierarchyOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyOutDocument from a JSON string +json_api_attribute_hierarchy_out_document_instance = JsonApiAttributeHierarchyOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyOutDocument.to_json()) + +# convert the object into a dict +json_api_attribute_hierarchy_out_document_dict = json_api_attribute_hierarchy_out_document_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyOutDocument from a dict +json_api_attribute_hierarchy_out_document_from_dict = JsonApiAttributeHierarchyOutDocument.from_dict(json_api_attribute_hierarchy_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutIncludes.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutIncludes.md index a580f5c23..e5f21b81c 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAttributeOutAttributes**](JsonApiAttributeOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAttributeOutRelationships**](JsonApiAttributeOutRelationships.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "attribute" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_out_includes import JsonApiAttributeHierarchyOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyOutIncludes from a JSON string +json_api_attribute_hierarchy_out_includes_instance = JsonApiAttributeHierarchyOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyOutIncludes.to_json()) + +# convert the object into a dict +json_api_attribute_hierarchy_out_includes_dict = json_api_attribute_hierarchy_out_includes_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyOutIncludes from a dict +json_api_attribute_hierarchy_out_includes_from_dict = JsonApiAttributeHierarchyOutIncludes.from_dict(json_api_attribute_hierarchy_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutList.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutList.md index e141af846..6365d07cc 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutList.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiAttributeHierarchyOutWithLinks]**](JsonApiAttributeHierarchyOutWithLinks.md) | | -**included** | [**[JsonApiAttributeHierarchyOutIncludes]**](JsonApiAttributeHierarchyOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiAttributeHierarchyOutWithLinks]**](JsonApiAttributeHierarchyOutWithLinks.md) | | +**included** | [**List[JsonApiAttributeHierarchyOutIncludes]**](JsonApiAttributeHierarchyOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyOutList from a JSON string +json_api_attribute_hierarchy_out_list_instance = JsonApiAttributeHierarchyOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyOutList.to_json()) + +# convert the object into a dict +json_api_attribute_hierarchy_out_list_dict = json_api_attribute_hierarchy_out_list_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyOutList from a dict +json_api_attribute_hierarchy_out_list_from_dict = JsonApiAttributeHierarchyOutList.from_dict(json_api_attribute_hierarchy_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationships.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationships.md index 4da316af7..1a206bb10 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationships.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAttributeHierarchyOutRelationshipsAttributes**](JsonApiAttributeHierarchyOutRelationshipsAttributes.md) | | [optional] **created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] **modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships import JsonApiAttributeHierarchyOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyOutRelationships from a JSON string +json_api_attribute_hierarchy_out_relationships_instance = JsonApiAttributeHierarchyOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyOutRelationships.to_json()) + +# convert the object into a dict +json_api_attribute_hierarchy_out_relationships_dict = json_api_attribute_hierarchy_out_relationships_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyOutRelationships from a dict +json_api_attribute_hierarchy_out_relationships_from_dict = JsonApiAttributeHierarchyOutRelationships.from_dict(json_api_attribute_hierarchy_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationshipsAttributes.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationshipsAttributes.md index e50b53a1f..0e0d1b2e9 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationshipsAttributes.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationshipsAttributes.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiAttributeToManyLinkage**](JsonApiAttributeToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiAttributeLinkage]**](JsonApiAttributeLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyOutRelationshipsAttributes from a JSON string +json_api_attribute_hierarchy_out_relationships_attributes_instance = JsonApiAttributeHierarchyOutRelationshipsAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyOutRelationshipsAttributes.to_json()) +# convert the object into a dict +json_api_attribute_hierarchy_out_relationships_attributes_dict = json_api_attribute_hierarchy_out_relationships_attributes_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyOutRelationshipsAttributes from a dict +json_api_attribute_hierarchy_out_relationships_attributes_from_dict = JsonApiAttributeHierarchyOutRelationshipsAttributes.from_dict(json_api_attribute_hierarchy_out_relationships_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutWithLinks.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutWithLinks.md index 13067f122..072adfeaf 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "attributeHierarchy" **attributes** | [**JsonApiAttributeHierarchyOutAttributes**](JsonApiAttributeHierarchyOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAttributeHierarchyOutRelationships**](JsonApiAttributeHierarchyOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_out_with_links import JsonApiAttributeHierarchyOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyOutWithLinks from a JSON string +json_api_attribute_hierarchy_out_with_links_instance = JsonApiAttributeHierarchyOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyOutWithLinks.to_json()) + +# convert the object into a dict +json_api_attribute_hierarchy_out_with_links_dict = json_api_attribute_hierarchy_out_with_links_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyOutWithLinks from a dict +json_api_attribute_hierarchy_out_with_links_from_dict = JsonApiAttributeHierarchyOutWithLinks.from_dict(json_api_attribute_hierarchy_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyPatch.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyPatch.md index 08dc59ef2..0d1cf8a17 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyPatch.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching attributeHierarchy entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "attributeHierarchy" **attributes** | [**JsonApiAttributeHierarchyInAttributes**](JsonApiAttributeHierarchyInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_patch import JsonApiAttributeHierarchyPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyPatch from a JSON string +json_api_attribute_hierarchy_patch_instance = JsonApiAttributeHierarchyPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyPatch.to_json()) +# convert the object into a dict +json_api_attribute_hierarchy_patch_dict = json_api_attribute_hierarchy_patch_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyPatch from a dict +json_api_attribute_hierarchy_patch_from_dict = JsonApiAttributeHierarchyPatch.from_dict(json_api_attribute_hierarchy_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyPatchDocument.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyPatchDocument.md index af3036218..bfd5b0464 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAttributeHierarchyPatch**](JsonApiAttributeHierarchyPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeHierarchyPatchDocument from a JSON string +json_api_attribute_hierarchy_patch_document_instance = JsonApiAttributeHierarchyPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeHierarchyPatchDocument.to_json()) + +# convert the object into a dict +json_api_attribute_hierarchy_patch_document_dict = json_api_attribute_hierarchy_patch_document_instance.to_dict() +# create an instance of JsonApiAttributeHierarchyPatchDocument from a dict +json_api_attribute_hierarchy_patch_document_from_dict = JsonApiAttributeHierarchyPatchDocument.from_dict(json_api_attribute_hierarchy_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyToManyLinkage.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyToManyLinkage.md deleted file mode 100644 index 4287d758d..000000000 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiAttributeHierarchyToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiAttributeHierarchyLinkage]**](JsonApiAttributeHierarchyLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiAttributeLinkage.md b/gooddata-api-client/docs/JsonApiAttributeLinkage.md index 02d7b79b0..3a3bf94c2 100644 --- a/gooddata-api-client/docs/JsonApiAttributeLinkage.md +++ b/gooddata-api-client/docs/JsonApiAttributeLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "attribute" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_attribute_linkage import JsonApiAttributeLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeLinkage from a JSON string +json_api_attribute_linkage_instance = JsonApiAttributeLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeLinkage.to_json()) +# convert the object into a dict +json_api_attribute_linkage_dict = json_api_attribute_linkage_instance.to_dict() +# create an instance of JsonApiAttributeLinkage from a dict +json_api_attribute_linkage_from_dict = JsonApiAttributeLinkage.from_dict(json_api_attribute_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeOut.md b/gooddata-api-client/docs/JsonApiAttributeOut.md index d767330b4..c35140982 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOut.md +++ b/gooddata-api-client/docs/JsonApiAttributeOut.md @@ -3,15 +3,32 @@ JSON:API representation of attribute entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "attribute" **attributes** | [**JsonApiAttributeOutAttributes**](JsonApiAttributeOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAttributeOutRelationships**](JsonApiAttributeOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_attribute_out import JsonApiAttributeOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeOut from a JSON string +json_api_attribute_out_instance = JsonApiAttributeOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeOut.to_json()) +# convert the object into a dict +json_api_attribute_out_dict = json_api_attribute_out_instance.to_dict() +# create an instance of JsonApiAttributeOut from a dict +json_api_attribute_out_from_dict = JsonApiAttributeOut.from_dict(json_api_attribute_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeOutAttributes.md b/gooddata-api-client/docs/JsonApiAttributeOutAttributes.md index 6311276b4..ec1ae60b7 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutAttributes.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] @@ -12,10 +13,26 @@ Name | Type | Description | Notes **sort_direction** | **str** | | [optional] **source_column** | **str** | | [optional] **source_column_data_type** | **str** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeOutAttributes from a JSON string +json_api_attribute_out_attributes_instance = JsonApiAttributeOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeOutAttributes.to_json()) + +# convert the object into a dict +json_api_attribute_out_attributes_dict = json_api_attribute_out_attributes_instance.to_dict() +# create an instance of JsonApiAttributeOutAttributes from a dict +json_api_attribute_out_attributes_from_dict = JsonApiAttributeOutAttributes.from_dict(json_api_attribute_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeOutDocument.md b/gooddata-api-client/docs/JsonApiAttributeOutDocument.md index 5b16433f1..f07d3a515 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutDocument.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAttributeOut**](JsonApiAttributeOut.md) | | -**included** | [**[JsonApiAttributeOutIncludes]**](JsonApiAttributeOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiAttributeOutIncludes]**](JsonApiAttributeOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeOutDocument from a JSON string +json_api_attribute_out_document_instance = JsonApiAttributeOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeOutDocument.to_json()) + +# convert the object into a dict +json_api_attribute_out_document_dict = json_api_attribute_out_document_instance.to_dict() +# create an instance of JsonApiAttributeOutDocument from a dict +json_api_attribute_out_document_from_dict = JsonApiAttributeOutDocument.from_dict(json_api_attribute_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeOutIncludes.md b/gooddata-api-client/docs/JsonApiAttributeOutIncludes.md index 41ca94e17..6495b8670 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiAttributeHierarchyOutAttributes**](JsonApiAttributeHierarchyOutAttributes.md) | | +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAttributeHierarchyOutRelationships**](JsonApiAttributeHierarchyOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**attributes** | [**JsonApiAttributeHierarchyOutAttributes**](JsonApiAttributeHierarchyOutAttributes.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "attributeHierarchy" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_out_includes import JsonApiAttributeOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeOutIncludes from a JSON string +json_api_attribute_out_includes_instance = JsonApiAttributeOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeOutIncludes.to_json()) + +# convert the object into a dict +json_api_attribute_out_includes_dict = json_api_attribute_out_includes_instance.to_dict() +# create an instance of JsonApiAttributeOutIncludes from a dict +json_api_attribute_out_includes_from_dict = JsonApiAttributeOutIncludes.from_dict(json_api_attribute_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeOutList.md b/gooddata-api-client/docs/JsonApiAttributeOutList.md index 5e498c98b..79f21cde7 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutList.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiAttributeOutWithLinks]**](JsonApiAttributeOutWithLinks.md) | | -**included** | [**[JsonApiAttributeOutIncludes]**](JsonApiAttributeOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiAttributeOutWithLinks]**](JsonApiAttributeOutWithLinks.md) | | +**included** | [**List[JsonApiAttributeOutIncludes]**](JsonApiAttributeOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeOutList from a JSON string +json_api_attribute_out_list_instance = JsonApiAttributeOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeOutList.to_json()) + +# convert the object into a dict +json_api_attribute_out_list_dict = json_api_attribute_out_list_instance.to_dict() +# create an instance of JsonApiAttributeOutList from a dict +json_api_attribute_out_list_from_dict = JsonApiAttributeOutList.from_dict(json_api_attribute_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeOutRelationships.md b/gooddata-api-client/docs/JsonApiAttributeOutRelationships.md index 2da7f19ea..d0b33d574 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutRelationships.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute_hierarchies** | [**JsonApiAttributeOutRelationshipsAttributeHierarchies**](JsonApiAttributeOutRelationshipsAttributeHierarchies.md) | | [optional] **dataset** | [**JsonApiAggregatedFactOutRelationshipsDataset**](JsonApiAggregatedFactOutRelationshipsDataset.md) | | [optional] **default_view** | [**JsonApiAttributeOutRelationshipsDefaultView**](JsonApiAttributeOutRelationshipsDefaultView.md) | | [optional] **labels** | [**JsonApiAnalyticalDashboardOutRelationshipsLabels**](JsonApiAnalyticalDashboardOutRelationshipsLabels.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeOutRelationships from a JSON string +json_api_attribute_out_relationships_instance = JsonApiAttributeOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeOutRelationships.to_json()) + +# convert the object into a dict +json_api_attribute_out_relationships_dict = json_api_attribute_out_relationships_instance.to_dict() +# create an instance of JsonApiAttributeOutRelationships from a dict +json_api_attribute_out_relationships_from_dict = JsonApiAttributeOutRelationships.from_dict(json_api_attribute_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeOutRelationshipsAttributeHierarchies.md b/gooddata-api-client/docs/JsonApiAttributeOutRelationshipsAttributeHierarchies.md index dbe63275d..9c8ca3c42 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutRelationshipsAttributeHierarchies.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutRelationshipsAttributeHierarchies.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiAttributeHierarchyToManyLinkage**](JsonApiAttributeHierarchyToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiAttributeHierarchyLinkage]**](JsonApiAttributeHierarchyLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_attribute_out_relationships_attribute_hierarchies import JsonApiAttributeOutRelationshipsAttributeHierarchies + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeOutRelationshipsAttributeHierarchies from a JSON string +json_api_attribute_out_relationships_attribute_hierarchies_instance = JsonApiAttributeOutRelationshipsAttributeHierarchies.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeOutRelationshipsAttributeHierarchies.to_json()) +# convert the object into a dict +json_api_attribute_out_relationships_attribute_hierarchies_dict = json_api_attribute_out_relationships_attribute_hierarchies_instance.to_dict() +# create an instance of JsonApiAttributeOutRelationshipsAttributeHierarchies from a dict +json_api_attribute_out_relationships_attribute_hierarchies_from_dict = JsonApiAttributeOutRelationshipsAttributeHierarchies.from_dict(json_api_attribute_out_relationships_attribute_hierarchies_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeOutRelationshipsDefaultView.md b/gooddata-api-client/docs/JsonApiAttributeOutRelationshipsDefaultView.md index 83530e046..6404ec1b1 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutRelationshipsDefaultView.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutRelationshipsDefaultView.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiLabelToOneLinkage**](JsonApiLabelToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_out_relationships_default_view import JsonApiAttributeOutRelationshipsDefaultView + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeOutRelationshipsDefaultView from a JSON string +json_api_attribute_out_relationships_default_view_instance = JsonApiAttributeOutRelationshipsDefaultView.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeOutRelationshipsDefaultView.to_json()) + +# convert the object into a dict +json_api_attribute_out_relationships_default_view_dict = json_api_attribute_out_relationships_default_view_instance.to_dict() +# create an instance of JsonApiAttributeOutRelationshipsDefaultView from a dict +json_api_attribute_out_relationships_default_view_from_dict = JsonApiAttributeOutRelationshipsDefaultView.from_dict(json_api_attribute_out_relationships_default_view_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeOutWithLinks.md b/gooddata-api-client/docs/JsonApiAttributeOutWithLinks.md index 3ee930c71..b887672dd 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "attribute" **attributes** | [**JsonApiAttributeOutAttributes**](JsonApiAttributeOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAttributeOutRelationships**](JsonApiAttributeOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeOutWithLinks from a JSON string +json_api_attribute_out_with_links_instance = JsonApiAttributeOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeOutWithLinks.to_json()) + +# convert the object into a dict +json_api_attribute_out_with_links_dict = json_api_attribute_out_with_links_instance.to_dict() +# create an instance of JsonApiAttributeOutWithLinks from a dict +json_api_attribute_out_with_links_from_dict = JsonApiAttributeOutWithLinks.from_dict(json_api_attribute_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAttributeToManyLinkage.md b/gooddata-api-client/docs/JsonApiAttributeToManyLinkage.md deleted file mode 100644 index cc91abf31..000000000 --- a/gooddata-api-client/docs/JsonApiAttributeToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiAttributeToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiAttributeLinkage]**](JsonApiAttributeLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiAttributeToOneLinkage.md b/gooddata-api-client/docs/JsonApiAttributeToOneLinkage.md index bb0b4a7ca..65a48cbb4 100644 --- a/gooddata-api-client/docs/JsonApiAttributeToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiAttributeToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "attribute" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_attribute_to_one_linkage import JsonApiAttributeToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAttributeToOneLinkage from a JSON string +json_api_attribute_to_one_linkage_instance = JsonApiAttributeToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiAttributeToOneLinkage.to_json()) +# convert the object into a dict +json_api_attribute_to_one_linkage_dict = json_api_attribute_to_one_linkage_instance.to_dict() +# create an instance of JsonApiAttributeToOneLinkage from a dict +json_api_attribute_to_one_linkage_from_dict = JsonApiAttributeToOneLinkage.from_dict(json_api_attribute_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationIn.md b/gooddata-api-client/docs/JsonApiAutomationIn.md index b5f7901f3..cf56fc97c 100644 --- a/gooddata-api-client/docs/JsonApiAutomationIn.md +++ b/gooddata-api-client/docs/JsonApiAutomationIn.md @@ -3,14 +3,31 @@ JSON:API representation of automation entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "automation" **attributes** | [**JsonApiAutomationInAttributes**](JsonApiAutomationInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiAutomationInRelationships**](JsonApiAutomationInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_automation_in import JsonApiAutomationIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationIn from a JSON string +json_api_automation_in_instance = JsonApiAutomationIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationIn.to_json()) +# convert the object into a dict +json_api_automation_in_dict = json_api_automation_in_instance.to_dict() +# create an instance of JsonApiAutomationIn from a dict +json_api_automation_in_from_dict = JsonApiAutomationIn.from_dict(json_api_automation_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributes.md b/gooddata-api-client/docs/JsonApiAutomationInAttributes.md index 92ffb6826..5801545c2 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributes.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributes.md @@ -2,27 +2,44 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **alert** | [**JsonApiAutomationInAttributesAlert**](JsonApiAutomationInAttributesAlert.md) | | [optional] **are_relations_valid** | **bool** | | [optional] -**dashboard_tabular_exports** | [**[JsonApiAutomationInAttributesDashboardTabularExportsInner]**](JsonApiAutomationInAttributesDashboardTabularExportsInner.md) | | [optional] +**dashboard_tabular_exports** | [**List[JsonApiAutomationInAttributesDashboardTabularExportsInner]**](JsonApiAutomationInAttributesDashboardTabularExportsInner.md) | | [optional] **description** | **str** | | [optional] -**details** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Additional details to be included in the automated message. | [optional] +**details** | **object** | Additional details to be included in the automated message. | [optional] **evaluation_mode** | **str** | Specify automation evaluation mode. | [optional] -**external_recipients** | [**[JsonApiAutomationInAttributesExternalRecipientsInner]**](JsonApiAutomationInAttributesExternalRecipientsInner.md) | External recipients of the automation action results. | [optional] -**image_exports** | [**[JsonApiAutomationInAttributesImageExportsInner]**](JsonApiAutomationInAttributesImageExportsInner.md) | | [optional] +**external_recipients** | [**List[JsonApiAutomationInAttributesExternalRecipientsInner]**](JsonApiAutomationInAttributesExternalRecipientsInner.md) | External recipients of the automation action results. | [optional] +**image_exports** | [**List[JsonApiAutomationInAttributesImageExportsInner]**](JsonApiAutomationInAttributesImageExportsInner.md) | | [optional] **metadata** | [**JsonApiAutomationInAttributesMetadata**](JsonApiAutomationInAttributesMetadata.md) | | [optional] -**raw_exports** | [**[JsonApiAutomationInAttributesRawExportsInner]**](JsonApiAutomationInAttributesRawExportsInner.md) | | [optional] +**raw_exports** | [**List[JsonApiAutomationInAttributesRawExportsInner]**](JsonApiAutomationInAttributesRawExportsInner.md) | | [optional] **schedule** | [**JsonApiAutomationInAttributesSchedule**](JsonApiAutomationInAttributesSchedule.md) | | [optional] -**slides_exports** | [**[JsonApiAutomationInAttributesSlidesExportsInner]**](JsonApiAutomationInAttributesSlidesExportsInner.md) | | [optional] +**slides_exports** | [**List[JsonApiAutomationInAttributesSlidesExportsInner]**](JsonApiAutomationInAttributesSlidesExportsInner.md) | | [optional] **state** | **str** | Current state of the automation. | [optional] -**tabular_exports** | [**[JsonApiAutomationInAttributesTabularExportsInner]**](JsonApiAutomationInAttributesTabularExportsInner.md) | | [optional] -**tags** | **[str]** | | [optional] +**tabular_exports** | [**List[JsonApiAutomationInAttributesTabularExportsInner]**](JsonApiAutomationInAttributesTabularExportsInner.md) | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**visual_exports** | [**[JsonApiAutomationInAttributesVisualExportsInner]**](JsonApiAutomationInAttributesVisualExportsInner.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**visual_exports** | [**List[JsonApiAutomationInAttributesVisualExportsInner]**](JsonApiAutomationInAttributesVisualExportsInner.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_attributes import JsonApiAutomationInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInAttributes from a JSON string +json_api_automation_in_attributes_instance = JsonApiAutomationInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInAttributes.to_json()) +# convert the object into a dict +json_api_automation_in_attributes_dict = json_api_automation_in_attributes_instance.to_dict() +# create an instance of JsonApiAutomationInAttributes from a dict +json_api_automation_in_attributes_from_dict = JsonApiAutomationInAttributes.from_dict(json_api_automation_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesAlert.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesAlert.md index 4e60a9baa..963e673c2 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesAlert.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesAlert.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **condition** | [**AlertCondition**](AlertCondition.md) | | **execution** | [**AlertAfm**](AlertAfm.md) | | -**trigger** | **str** | Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. | [optional] if omitted the server will use the default value of "ALWAYS" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**trigger** | **str** | Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. | [optional] [default to 'ALWAYS'] + +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInAttributesAlert from a JSON string +json_api_automation_in_attributes_alert_instance = JsonApiAutomationInAttributesAlert.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInAttributesAlert.to_json()) +# convert the object into a dict +json_api_automation_in_attributes_alert_dict = json_api_automation_in_attributes_alert_instance.to_dict() +# create an instance of JsonApiAutomationInAttributesAlert from a dict +json_api_automation_in_attributes_alert_from_dict = JsonApiAutomationInAttributesAlert.from_dict(json_api_automation_in_attributes_alert_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesDashboardTabularExportsInner.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesDashboardTabularExportsInner.md index 9b1aa1d18..df5730604 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesDashboardTabularExportsInner.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesDashboardTabularExportsInner.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_attributes_dashboard_tabular_exports_inner import JsonApiAutomationInAttributesDashboardTabularExportsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInAttributesDashboardTabularExportsInner from a JSON string +json_api_automation_in_attributes_dashboard_tabular_exports_inner_instance = JsonApiAutomationInAttributesDashboardTabularExportsInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInAttributesDashboardTabularExportsInner.to_json()) + +# convert the object into a dict +json_api_automation_in_attributes_dashboard_tabular_exports_inner_dict = json_api_automation_in_attributes_dashboard_tabular_exports_inner_instance.to_dict() +# create an instance of JsonApiAutomationInAttributesDashboardTabularExportsInner from a dict +json_api_automation_in_attributes_dashboard_tabular_exports_inner_from_dict = JsonApiAutomationInAttributesDashboardTabularExportsInner.from_dict(json_api_automation_in_attributes_dashboard_tabular_exports_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesExternalRecipientsInner.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesExternalRecipientsInner.md index 5b1dc780f..7155a5d67 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesExternalRecipientsInner.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesExternalRecipientsInner.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **str** | E-mail address to send notifications from. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInAttributesExternalRecipientsInner from a JSON string +json_api_automation_in_attributes_external_recipients_inner_instance = JsonApiAutomationInAttributesExternalRecipientsInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInAttributesExternalRecipientsInner.to_json()) + +# convert the object into a dict +json_api_automation_in_attributes_external_recipients_inner_dict = json_api_automation_in_attributes_external_recipients_inner_instance.to_dict() +# create an instance of JsonApiAutomationInAttributesExternalRecipientsInner from a dict +json_api_automation_in_attributes_external_recipients_inner_from_dict = JsonApiAutomationInAttributesExternalRecipientsInner.from_dict(json_api_automation_in_attributes_external_recipients_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesImageExportsInner.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesImageExportsInner.md index fd6e6bc18..340c81fb4 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesImageExportsInner.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesImageExportsInner.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**ImageExportRequest**](ImageExportRequest.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_attributes_image_exports_inner import JsonApiAutomationInAttributesImageExportsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInAttributesImageExportsInner from a JSON string +json_api_automation_in_attributes_image_exports_inner_instance = JsonApiAutomationInAttributesImageExportsInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInAttributesImageExportsInner.to_json()) + +# convert the object into a dict +json_api_automation_in_attributes_image_exports_inner_dict = json_api_automation_in_attributes_image_exports_inner_instance.to_dict() +# create an instance of JsonApiAutomationInAttributesImageExportsInner from a dict +json_api_automation_in_attributes_image_exports_inner_from_dict = JsonApiAutomationInAttributesImageExportsInner.from_dict(json_api_automation_in_attributes_image_exports_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesMetadata.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesMetadata.md index 07d7f983a..37db8d3e3 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesMetadata.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesMetadata.md @@ -3,12 +3,29 @@ Additional information for the automation. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**visible_filters** | [**[VisibleFilter]**](VisibleFilter.md) | | [optional] +**visible_filters** | [**List[VisibleFilter]**](VisibleFilter.md) | | [optional] **widget** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInAttributesMetadata from a JSON string +json_api_automation_in_attributes_metadata_instance = JsonApiAutomationInAttributesMetadata.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInAttributesMetadata.to_json()) + +# convert the object into a dict +json_api_automation_in_attributes_metadata_dict = json_api_automation_in_attributes_metadata_instance.to_dict() +# create an instance of JsonApiAutomationInAttributesMetadata from a dict +json_api_automation_in_attributes_metadata_from_dict = JsonApiAutomationInAttributesMetadata.from_dict(json_api_automation_in_attributes_metadata_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesRawExportsInner.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesRawExportsInner.md index 3c9000fe2..ef88ec95b 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesRawExportsInner.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesRawExportsInner.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_attributes_raw_exports_inner import JsonApiAutomationInAttributesRawExportsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInAttributesRawExportsInner from a JSON string +json_api_automation_in_attributes_raw_exports_inner_instance = JsonApiAutomationInAttributesRawExportsInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInAttributesRawExportsInner.to_json()) + +# convert the object into a dict +json_api_automation_in_attributes_raw_exports_inner_dict = json_api_automation_in_attributes_raw_exports_inner_instance.to_dict() +# create an instance of JsonApiAutomationInAttributesRawExportsInner from a dict +json_api_automation_in_attributes_raw_exports_inner_from_dict = JsonApiAutomationInAttributesRawExportsInner.from_dict(json_api_automation_in_attributes_raw_exports_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesSchedule.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesSchedule.md index a4a998524..b97b07bc4 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesSchedule.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesSchedule.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **cron** | **str** | Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays. | -**timezone** | **str** | Timezone in which the schedule is defined. | **cron_description** | **str** | Human-readable description of the cron expression. | [optional] [readonly] **first_run** | **datetime** | Timestamp of the first scheduled action. If not provided default to the next scheduled time. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**timezone** | **str** | Timezone in which the schedule is defined. | + +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInAttributesSchedule from a JSON string +json_api_automation_in_attributes_schedule_instance = JsonApiAutomationInAttributesSchedule.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInAttributesSchedule.to_json()) +# convert the object into a dict +json_api_automation_in_attributes_schedule_dict = json_api_automation_in_attributes_schedule_instance.to_dict() +# create an instance of JsonApiAutomationInAttributesSchedule from a dict +json_api_automation_in_attributes_schedule_from_dict = JsonApiAutomationInAttributesSchedule.from_dict(json_api_automation_in_attributes_schedule_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesSlidesExportsInner.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesSlidesExportsInner.md index 5d4a0e1ae..8205e7852 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesSlidesExportsInner.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesSlidesExportsInner.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**SlidesExportRequest**](SlidesExportRequest.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_attributes_slides_exports_inner import JsonApiAutomationInAttributesSlidesExportsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInAttributesSlidesExportsInner from a JSON string +json_api_automation_in_attributes_slides_exports_inner_instance = JsonApiAutomationInAttributesSlidesExportsInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInAttributesSlidesExportsInner.to_json()) + +# convert the object into a dict +json_api_automation_in_attributes_slides_exports_inner_dict = json_api_automation_in_attributes_slides_exports_inner_instance.to_dict() +# create an instance of JsonApiAutomationInAttributesSlidesExportsInner from a dict +json_api_automation_in_attributes_slides_exports_inner_from_dict = JsonApiAutomationInAttributesSlidesExportsInner.from_dict(json_api_automation_in_attributes_slides_exports_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesTabularExportsInner.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesTabularExportsInner.md index c0ea782fa..4eabf19c1 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesTabularExportsInner.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesTabularExportsInner.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**TabularExportRequest**](TabularExportRequest.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInAttributesTabularExportsInner from a JSON string +json_api_automation_in_attributes_tabular_exports_inner_instance = JsonApiAutomationInAttributesTabularExportsInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInAttributesTabularExportsInner.to_json()) + +# convert the object into a dict +json_api_automation_in_attributes_tabular_exports_inner_dict = json_api_automation_in_attributes_tabular_exports_inner_instance.to_dict() +# create an instance of JsonApiAutomationInAttributesTabularExportsInner from a dict +json_api_automation_in_attributes_tabular_exports_inner_from_dict = JsonApiAutomationInAttributesTabularExportsInner.from_dict(json_api_automation_in_attributes_tabular_exports_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesVisualExportsInner.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesVisualExportsInner.md index 87a90a48b..1d11ba43a 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesVisualExportsInner.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesVisualExportsInner.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_payload** | [**VisualExportRequest**](VisualExportRequest.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInAttributesVisualExportsInner from a JSON string +json_api_automation_in_attributes_visual_exports_inner_instance = JsonApiAutomationInAttributesVisualExportsInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInAttributesVisualExportsInner.to_json()) + +# convert the object into a dict +json_api_automation_in_attributes_visual_exports_inner_dict = json_api_automation_in_attributes_visual_exports_inner_instance.to_dict() +# create an instance of JsonApiAutomationInAttributesVisualExportsInner from a dict +json_api_automation_in_attributes_visual_exports_inner_from_dict = JsonApiAutomationInAttributesVisualExportsInner.from_dict(json_api_automation_in_attributes_visual_exports_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInDocument.md b/gooddata-api-client/docs/JsonApiAutomationInDocument.md index c8646a72a..725cbf1f3 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInDocument.md +++ b/gooddata-api-client/docs/JsonApiAutomationInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAutomationIn**](JsonApiAutomationIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInDocument from a JSON string +json_api_automation_in_document_instance = JsonApiAutomationInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInDocument.to_json()) + +# convert the object into a dict +json_api_automation_in_document_dict = json_api_automation_in_document_instance.to_dict() +# create an instance of JsonApiAutomationInDocument from a dict +json_api_automation_in_document_from_dict = JsonApiAutomationInDocument.from_dict(json_api_automation_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInRelationships.md b/gooddata-api-client/docs/JsonApiAutomationInRelationships.md index 91d9e94ce..8cdef3633 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInRelationships.md +++ b/gooddata-api-client/docs/JsonApiAutomationInRelationships.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboard** | [**JsonApiAutomationInRelationshipsAnalyticalDashboard**](JsonApiAutomationInRelationshipsAnalyticalDashboard.md) | | [optional] **export_definitions** | [**JsonApiAutomationInRelationshipsExportDefinitions**](JsonApiAutomationInRelationshipsExportDefinitions.md) | | [optional] **notification_channel** | [**JsonApiAutomationInRelationshipsNotificationChannel**](JsonApiAutomationInRelationshipsNotificationChannel.md) | | [optional] **recipients** | [**JsonApiAutomationInRelationshipsRecipients**](JsonApiAutomationInRelationshipsRecipients.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_relationships import JsonApiAutomationInRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInRelationships from a JSON string +json_api_automation_in_relationships_instance = JsonApiAutomationInRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInRelationships.to_json()) + +# convert the object into a dict +json_api_automation_in_relationships_dict = json_api_automation_in_relationships_instance.to_dict() +# create an instance of JsonApiAutomationInRelationships from a dict +json_api_automation_in_relationships_from_dict = JsonApiAutomationInRelationships.from_dict(json_api_automation_in_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInRelationshipsAnalyticalDashboard.md b/gooddata-api-client/docs/JsonApiAutomationInRelationshipsAnalyticalDashboard.md index ad6b396fc..57eea0552 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInRelationshipsAnalyticalDashboard.md +++ b/gooddata-api-client/docs/JsonApiAutomationInRelationshipsAnalyticalDashboard.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInRelationshipsAnalyticalDashboard from a JSON string +json_api_automation_in_relationships_analytical_dashboard_instance = JsonApiAutomationInRelationshipsAnalyticalDashboard.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInRelationshipsAnalyticalDashboard.to_json()) + +# convert the object into a dict +json_api_automation_in_relationships_analytical_dashboard_dict = json_api_automation_in_relationships_analytical_dashboard_instance.to_dict() +# create an instance of JsonApiAutomationInRelationshipsAnalyticalDashboard from a dict +json_api_automation_in_relationships_analytical_dashboard_from_dict = JsonApiAutomationInRelationshipsAnalyticalDashboard.from_dict(json_api_automation_in_relationships_analytical_dashboard_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInRelationshipsExportDefinitions.md b/gooddata-api-client/docs/JsonApiAutomationInRelationshipsExportDefinitions.md index aed592470..4726edf6e 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInRelationshipsExportDefinitions.md +++ b/gooddata-api-client/docs/JsonApiAutomationInRelationshipsExportDefinitions.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiExportDefinitionToManyLinkage**](JsonApiExportDefinitionToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiExportDefinitionLinkage]**](JsonApiExportDefinitionLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInRelationshipsExportDefinitions from a JSON string +json_api_automation_in_relationships_export_definitions_instance = JsonApiAutomationInRelationshipsExportDefinitions.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInRelationshipsExportDefinitions.to_json()) +# convert the object into a dict +json_api_automation_in_relationships_export_definitions_dict = json_api_automation_in_relationships_export_definitions_instance.to_dict() +# create an instance of JsonApiAutomationInRelationshipsExportDefinitions from a dict +json_api_automation_in_relationships_export_definitions_from_dict = JsonApiAutomationInRelationshipsExportDefinitions.from_dict(json_api_automation_in_relationships_export_definitions_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInRelationshipsNotificationChannel.md b/gooddata-api-client/docs/JsonApiAutomationInRelationshipsNotificationChannel.md index 5ed5b5365..96e0f6010 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInRelationshipsNotificationChannel.md +++ b/gooddata-api-client/docs/JsonApiAutomationInRelationshipsNotificationChannel.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiNotificationChannelToOneLinkage**](JsonApiNotificationChannelToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInRelationshipsNotificationChannel from a JSON string +json_api_automation_in_relationships_notification_channel_instance = JsonApiAutomationInRelationshipsNotificationChannel.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInRelationshipsNotificationChannel.to_json()) + +# convert the object into a dict +json_api_automation_in_relationships_notification_channel_dict = json_api_automation_in_relationships_notification_channel_instance.to_dict() +# create an instance of JsonApiAutomationInRelationshipsNotificationChannel from a dict +json_api_automation_in_relationships_notification_channel_from_dict = JsonApiAutomationInRelationshipsNotificationChannel.from_dict(json_api_automation_in_relationships_notification_channel_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationInRelationshipsRecipients.md b/gooddata-api-client/docs/JsonApiAutomationInRelationshipsRecipients.md index 353f1d785..ec1e55c38 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInRelationshipsRecipients.md +++ b/gooddata-api-client/docs/JsonApiAutomationInRelationshipsRecipients.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiUserToManyLinkage**](JsonApiUserToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiUserLinkage]**](JsonApiUserLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationInRelationshipsRecipients from a JSON string +json_api_automation_in_relationships_recipients_instance = JsonApiAutomationInRelationshipsRecipients.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationInRelationshipsRecipients.to_json()) +# convert the object into a dict +json_api_automation_in_relationships_recipients_dict = json_api_automation_in_relationships_recipients_instance.to_dict() +# create an instance of JsonApiAutomationInRelationshipsRecipients from a dict +json_api_automation_in_relationships_recipients_from_dict = JsonApiAutomationInRelationshipsRecipients.from_dict(json_api_automation_in_relationships_recipients_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationLinkage.md b/gooddata-api-client/docs/JsonApiAutomationLinkage.md index a38d932cd..24d2c6da7 100644 --- a/gooddata-api-client/docs/JsonApiAutomationLinkage.md +++ b/gooddata-api-client/docs/JsonApiAutomationLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "automation" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_automation_linkage import JsonApiAutomationLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationLinkage from a JSON string +json_api_automation_linkage_instance = JsonApiAutomationLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationLinkage.to_json()) +# convert the object into a dict +json_api_automation_linkage_dict = json_api_automation_linkage_instance.to_dict() +# create an instance of JsonApiAutomationLinkage from a dict +json_api_automation_linkage_from_dict = JsonApiAutomationLinkage.from_dict(json_api_automation_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationOut.md b/gooddata-api-client/docs/JsonApiAutomationOut.md index 664a91d2c..7ef1b00ac 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOut.md +++ b/gooddata-api-client/docs/JsonApiAutomationOut.md @@ -3,15 +3,32 @@ JSON:API representation of automation entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "automation" **attributes** | [**JsonApiAutomationOutAttributes**](JsonApiAutomationOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAutomationOutRelationships**](JsonApiAutomationOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_automation_out import JsonApiAutomationOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationOut from a JSON string +json_api_automation_out_instance = JsonApiAutomationOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationOut.to_json()) +# convert the object into a dict +json_api_automation_out_dict = json_api_automation_out_instance.to_dict() +# create an instance of JsonApiAutomationOut from a dict +json_api_automation_out_from_dict = JsonApiAutomationOut.from_dict(json_api_automation_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md b/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md index 557272afe..3d54b205c 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md @@ -2,29 +2,46 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **alert** | [**JsonApiAutomationInAttributesAlert**](JsonApiAutomationInAttributesAlert.md) | | [optional] **are_relations_valid** | **bool** | | [optional] **created_at** | **datetime** | | [optional] -**dashboard_tabular_exports** | [**[JsonApiAutomationInAttributesDashboardTabularExportsInner]**](JsonApiAutomationInAttributesDashboardTabularExportsInner.md) | | [optional] +**dashboard_tabular_exports** | [**List[JsonApiAutomationInAttributesDashboardTabularExportsInner]**](JsonApiAutomationInAttributesDashboardTabularExportsInner.md) | | [optional] **description** | **str** | | [optional] -**details** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Additional details to be included in the automated message. | [optional] +**details** | **object** | Additional details to be included in the automated message. | [optional] **evaluation_mode** | **str** | Specify automation evaluation mode. | [optional] -**external_recipients** | [**[JsonApiAutomationInAttributesExternalRecipientsInner]**](JsonApiAutomationInAttributesExternalRecipientsInner.md) | External recipients of the automation action results. | [optional] -**image_exports** | [**[JsonApiAutomationInAttributesImageExportsInner]**](JsonApiAutomationInAttributesImageExportsInner.md) | | [optional] +**external_recipients** | [**List[JsonApiAutomationInAttributesExternalRecipientsInner]**](JsonApiAutomationInAttributesExternalRecipientsInner.md) | External recipients of the automation action results. | [optional] +**image_exports** | [**List[JsonApiAutomationInAttributesImageExportsInner]**](JsonApiAutomationInAttributesImageExportsInner.md) | | [optional] **metadata** | [**JsonApiAutomationInAttributesMetadata**](JsonApiAutomationInAttributesMetadata.md) | | [optional] **modified_at** | **datetime** | | [optional] -**raw_exports** | [**[JsonApiAutomationInAttributesRawExportsInner]**](JsonApiAutomationInAttributesRawExportsInner.md) | | [optional] +**raw_exports** | [**List[JsonApiAutomationInAttributesRawExportsInner]**](JsonApiAutomationInAttributesRawExportsInner.md) | | [optional] **schedule** | [**JsonApiAutomationInAttributesSchedule**](JsonApiAutomationInAttributesSchedule.md) | | [optional] -**slides_exports** | [**[JsonApiAutomationInAttributesSlidesExportsInner]**](JsonApiAutomationInAttributesSlidesExportsInner.md) | | [optional] +**slides_exports** | [**List[JsonApiAutomationInAttributesSlidesExportsInner]**](JsonApiAutomationInAttributesSlidesExportsInner.md) | | [optional] **state** | **str** | Current state of the automation. | [optional] -**tabular_exports** | [**[JsonApiAutomationInAttributesTabularExportsInner]**](JsonApiAutomationInAttributesTabularExportsInner.md) | | [optional] -**tags** | **[str]** | | [optional] +**tabular_exports** | [**List[JsonApiAutomationInAttributesTabularExportsInner]**](JsonApiAutomationInAttributesTabularExportsInner.md) | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**visual_exports** | [**[JsonApiAutomationInAttributesVisualExportsInner]**](JsonApiAutomationInAttributesVisualExportsInner.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**visual_exports** | [**List[JsonApiAutomationInAttributesVisualExportsInner]**](JsonApiAutomationInAttributesVisualExportsInner.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_automation_out_attributes import JsonApiAutomationOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationOutAttributes from a JSON string +json_api_automation_out_attributes_instance = JsonApiAutomationOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationOutAttributes.to_json()) +# convert the object into a dict +json_api_automation_out_attributes_dict = json_api_automation_out_attributes_instance.to_dict() +# create an instance of JsonApiAutomationOutAttributes from a dict +json_api_automation_out_attributes_from_dict = JsonApiAutomationOutAttributes.from_dict(json_api_automation_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationOutDocument.md b/gooddata-api-client/docs/JsonApiAutomationOutDocument.md index 080adccd4..1d7d6cda4 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutDocument.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAutomationOut**](JsonApiAutomationOut.md) | | -**included** | [**[JsonApiAutomationOutIncludes]**](JsonApiAutomationOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiAutomationOutIncludes]**](JsonApiAutomationOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationOutDocument from a JSON string +json_api_automation_out_document_instance = JsonApiAutomationOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationOutDocument.to_json()) + +# convert the object into a dict +json_api_automation_out_document_dict = json_api_automation_out_document_instance.to_dict() +# create an instance of JsonApiAutomationOutDocument from a dict +json_api_automation_out_document_from_dict = JsonApiAutomationOutDocument.from_dict(json_api_automation_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationOutIncludes.md b/gooddata-api-client/docs/JsonApiAutomationOutIncludes.md index ce66b1eed..eb832c5e2 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiAutomationResultOutAttributes**](JsonApiAutomationResultOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAutomationResultOutRelationships**](JsonApiAutomationResultOutRelationships.md) | | [optional] -**attributes** | [**JsonApiAutomationResultOutAttributes**](JsonApiAutomationResultOutAttributes.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "automationResult" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_out_includes import JsonApiAutomationOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationOutIncludes from a JSON string +json_api_automation_out_includes_instance = JsonApiAutomationOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationOutIncludes.to_json()) + +# convert the object into a dict +json_api_automation_out_includes_dict = json_api_automation_out_includes_instance.to_dict() +# create an instance of JsonApiAutomationOutIncludes from a dict +json_api_automation_out_includes_from_dict = JsonApiAutomationOutIncludes.from_dict(json_api_automation_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationOutList.md b/gooddata-api-client/docs/JsonApiAutomationOutList.md index fd9a5f0ab..ec68dd4e0 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutList.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiAutomationOutWithLinks]**](JsonApiAutomationOutWithLinks.md) | | -**included** | [**[JsonApiAutomationOutIncludes]**](JsonApiAutomationOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiAutomationOutWithLinks]**](JsonApiAutomationOutWithLinks.md) | | +**included** | [**List[JsonApiAutomationOutIncludes]**](JsonApiAutomationOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_out_list import JsonApiAutomationOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationOutList from a JSON string +json_api_automation_out_list_instance = JsonApiAutomationOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationOutList.to_json()) + +# convert the object into a dict +json_api_automation_out_list_dict = json_api_automation_out_list_instance.to_dict() +# create an instance of JsonApiAutomationOutList from a dict +json_api_automation_out_list_from_dict = JsonApiAutomationOutList.from_dict(json_api_automation_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md b/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md index faec77979..42c641226 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboard** | [**JsonApiAutomationInRelationshipsAnalyticalDashboard**](JsonApiAutomationInRelationshipsAnalyticalDashboard.md) | | [optional] @@ -11,8 +12,24 @@ Name | Type | Description | Notes **modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] **notification_channel** | [**JsonApiAutomationInRelationshipsNotificationChannel**](JsonApiAutomationInRelationshipsNotificationChannel.md) | | [optional] **recipients** | [**JsonApiAutomationInRelationshipsRecipients**](JsonApiAutomationInRelationshipsRecipients.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_out_relationships import JsonApiAutomationOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationOutRelationships from a JSON string +json_api_automation_out_relationships_instance = JsonApiAutomationOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationOutRelationships.to_json()) + +# convert the object into a dict +json_api_automation_out_relationships_dict = json_api_automation_out_relationships_instance.to_dict() +# create an instance of JsonApiAutomationOutRelationships from a dict +json_api_automation_out_relationships_from_dict = JsonApiAutomationOutRelationships.from_dict(json_api_automation_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationOutRelationshipsAutomationResults.md b/gooddata-api-client/docs/JsonApiAutomationOutRelationshipsAutomationResults.md index a8743e1f1..bf74eb11f 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutRelationshipsAutomationResults.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutRelationshipsAutomationResults.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiAutomationResultToManyLinkage**](JsonApiAutomationResultToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiAutomationResultLinkage]**](JsonApiAutomationResultLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationOutRelationshipsAutomationResults from a JSON string +json_api_automation_out_relationships_automation_results_instance = JsonApiAutomationOutRelationshipsAutomationResults.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationOutRelationshipsAutomationResults.to_json()) +# convert the object into a dict +json_api_automation_out_relationships_automation_results_dict = json_api_automation_out_relationships_automation_results_instance.to_dict() +# create an instance of JsonApiAutomationOutRelationshipsAutomationResults from a dict +json_api_automation_out_relationships_automation_results_from_dict = JsonApiAutomationOutRelationshipsAutomationResults.from_dict(json_api_automation_out_relationships_automation_results_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationOutWithLinks.md b/gooddata-api-client/docs/JsonApiAutomationOutWithLinks.md index fcb26dc8e..32422230a 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "automation" **attributes** | [**JsonApiAutomationOutAttributes**](JsonApiAutomationOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAutomationOutRelationships**](JsonApiAutomationOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationOutWithLinks from a JSON string +json_api_automation_out_with_links_instance = JsonApiAutomationOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationOutWithLinks.to_json()) + +# convert the object into a dict +json_api_automation_out_with_links_dict = json_api_automation_out_with_links_instance.to_dict() +# create an instance of JsonApiAutomationOutWithLinks from a dict +json_api_automation_out_with_links_from_dict = JsonApiAutomationOutWithLinks.from_dict(json_api_automation_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationPatch.md b/gooddata-api-client/docs/JsonApiAutomationPatch.md index 2cd5c6cb2..a199daead 100644 --- a/gooddata-api-client/docs/JsonApiAutomationPatch.md +++ b/gooddata-api-client/docs/JsonApiAutomationPatch.md @@ -3,14 +3,31 @@ JSON:API representation of patching automation entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "automation" **attributes** | [**JsonApiAutomationInAttributes**](JsonApiAutomationInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiAutomationInRelationships**](JsonApiAutomationInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_automation_patch import JsonApiAutomationPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationPatch from a JSON string +json_api_automation_patch_instance = JsonApiAutomationPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationPatch.to_json()) +# convert the object into a dict +json_api_automation_patch_dict = json_api_automation_patch_instance.to_dict() +# create an instance of JsonApiAutomationPatch from a dict +json_api_automation_patch_from_dict = JsonApiAutomationPatch.from_dict(json_api_automation_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationPatchDocument.md b/gooddata-api-client/docs/JsonApiAutomationPatchDocument.md index 84ac559cd..2ab63c567 100644 --- a/gooddata-api-client/docs/JsonApiAutomationPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiAutomationPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAutomationPatch**](JsonApiAutomationPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_patch_document import JsonApiAutomationPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationPatchDocument from a JSON string +json_api_automation_patch_document_instance = JsonApiAutomationPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationPatchDocument.to_json()) + +# convert the object into a dict +json_api_automation_patch_document_dict = json_api_automation_patch_document_instance.to_dict() +# create an instance of JsonApiAutomationPatchDocument from a dict +json_api_automation_patch_document_from_dict = JsonApiAutomationPatchDocument.from_dict(json_api_automation_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationResultLinkage.md b/gooddata-api-client/docs/JsonApiAutomationResultLinkage.md index 859e76a03..c2f0d239b 100644 --- a/gooddata-api-client/docs/JsonApiAutomationResultLinkage.md +++ b/gooddata-api-client/docs/JsonApiAutomationResultLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "automationResult" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_automation_result_linkage import JsonApiAutomationResultLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationResultLinkage from a JSON string +json_api_automation_result_linkage_instance = JsonApiAutomationResultLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationResultLinkage.to_json()) +# convert the object into a dict +json_api_automation_result_linkage_dict = json_api_automation_result_linkage_instance.to_dict() +# create an instance of JsonApiAutomationResultLinkage from a dict +json_api_automation_result_linkage_from_dict = JsonApiAutomationResultLinkage.from_dict(json_api_automation_result_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationResultOut.md b/gooddata-api-client/docs/JsonApiAutomationResultOut.md index 583cc5e9f..3c99a21bb 100644 --- a/gooddata-api-client/docs/JsonApiAutomationResultOut.md +++ b/gooddata-api-client/docs/JsonApiAutomationResultOut.md @@ -3,14 +3,31 @@ JSON:API representation of automationResult entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAutomationResultOutAttributes**](JsonApiAutomationResultOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "automationResult" **relationships** | [**JsonApiAutomationResultOutRelationships**](JsonApiAutomationResultOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_automation_result_out import JsonApiAutomationResultOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationResultOut from a JSON string +json_api_automation_result_out_instance = JsonApiAutomationResultOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationResultOut.to_json()) +# convert the object into a dict +json_api_automation_result_out_dict = json_api_automation_result_out_instance.to_dict() +# create an instance of JsonApiAutomationResultOut from a dict +json_api_automation_result_out_from_dict = JsonApiAutomationResultOut.from_dict(json_api_automation_result_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationResultOutAttributes.md b/gooddata-api-client/docs/JsonApiAutomationResultOutAttributes.md index 925e91d99..b0cb7ffe0 100644 --- a/gooddata-api-client/docs/JsonApiAutomationResultOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAutomationResultOutAttributes.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**error_message** | **str** | | [optional] **executed_at** | **datetime** | Timestamp of the last automation run. | **status** | **str** | Status of the last automation run. | -**error_message** | **str** | | [optional] **trace_id** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_result_out_attributes import JsonApiAutomationResultOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationResultOutAttributes from a JSON string +json_api_automation_result_out_attributes_instance = JsonApiAutomationResultOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationResultOutAttributes.to_json()) + +# convert the object into a dict +json_api_automation_result_out_attributes_dict = json_api_automation_result_out_attributes_instance.to_dict() +# create an instance of JsonApiAutomationResultOutAttributes from a dict +json_api_automation_result_out_attributes_from_dict = JsonApiAutomationResultOutAttributes.from_dict(json_api_automation_result_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationResultOutRelationships.md b/gooddata-api-client/docs/JsonApiAutomationResultOutRelationships.md index 1f0077765..a0d41ea67 100644 --- a/gooddata-api-client/docs/JsonApiAutomationResultOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAutomationResultOutRelationships.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **automation** | [**JsonApiAutomationResultOutRelationshipsAutomation**](JsonApiAutomationResultOutRelationshipsAutomation.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_result_out_relationships import JsonApiAutomationResultOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationResultOutRelationships from a JSON string +json_api_automation_result_out_relationships_instance = JsonApiAutomationResultOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationResultOutRelationships.to_json()) + +# convert the object into a dict +json_api_automation_result_out_relationships_dict = json_api_automation_result_out_relationships_instance.to_dict() +# create an instance of JsonApiAutomationResultOutRelationships from a dict +json_api_automation_result_out_relationships_from_dict = JsonApiAutomationResultOutRelationships.from_dict(json_api_automation_result_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationResultOutRelationshipsAutomation.md b/gooddata-api-client/docs/JsonApiAutomationResultOutRelationshipsAutomation.md index 7702653e8..4f5b0ecba 100644 --- a/gooddata-api-client/docs/JsonApiAutomationResultOutRelationshipsAutomation.md +++ b/gooddata-api-client/docs/JsonApiAutomationResultOutRelationshipsAutomation.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAutomationToOneLinkage**](JsonApiAutomationToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_result_out_relationships_automation import JsonApiAutomationResultOutRelationshipsAutomation + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationResultOutRelationshipsAutomation from a JSON string +json_api_automation_result_out_relationships_automation_instance = JsonApiAutomationResultOutRelationshipsAutomation.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationResultOutRelationshipsAutomation.to_json()) + +# convert the object into a dict +json_api_automation_result_out_relationships_automation_dict = json_api_automation_result_out_relationships_automation_instance.to_dict() +# create an instance of JsonApiAutomationResultOutRelationshipsAutomation from a dict +json_api_automation_result_out_relationships_automation_from_dict = JsonApiAutomationResultOutRelationshipsAutomation.from_dict(json_api_automation_result_out_relationships_automation_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationResultOutWithLinks.md b/gooddata-api-client/docs/JsonApiAutomationResultOutWithLinks.md index c2fa94aa5..7f2fc9073 100644 --- a/gooddata-api-client/docs/JsonApiAutomationResultOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiAutomationResultOutWithLinks.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAutomationResultOutAttributes**](JsonApiAutomationResultOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "automationResult" **relationships** | [**JsonApiAutomationResultOutRelationships**](JsonApiAutomationResultOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationResultOutWithLinks from a JSON string +json_api_automation_result_out_with_links_instance = JsonApiAutomationResultOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationResultOutWithLinks.to_json()) + +# convert the object into a dict +json_api_automation_result_out_with_links_dict = json_api_automation_result_out_with_links_instance.to_dict() +# create an instance of JsonApiAutomationResultOutWithLinks from a dict +json_api_automation_result_out_with_links_from_dict = JsonApiAutomationResultOutWithLinks.from_dict(json_api_automation_result_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationResultToManyLinkage.md b/gooddata-api-client/docs/JsonApiAutomationResultToManyLinkage.md deleted file mode 100644 index 8d130eec2..000000000 --- a/gooddata-api-client/docs/JsonApiAutomationResultToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiAutomationResultToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiAutomationResultLinkage]**](JsonApiAutomationResultLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiAutomationToOneLinkage.md b/gooddata-api-client/docs/JsonApiAutomationToOneLinkage.md index c7631d2b3..5641c3bdc 100644 --- a/gooddata-api-client/docs/JsonApiAutomationToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiAutomationToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "automation" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_automation_to_one_linkage import JsonApiAutomationToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiAutomationToOneLinkage from a JSON string +json_api_automation_to_one_linkage_instance = JsonApiAutomationToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiAutomationToOneLinkage.to_json()) +# convert the object into a dict +json_api_automation_to_one_linkage_dict = json_api_automation_to_one_linkage_instance.to_dict() +# create an instance of JsonApiAutomationToOneLinkage from a dict +json_api_automation_to_one_linkage_from_dict = JsonApiAutomationToOneLinkage.from_dict(json_api_automation_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiColorPaletteIn.md b/gooddata-api-client/docs/JsonApiColorPaletteIn.md index 55f22319c..5026543fa 100644 --- a/gooddata-api-client/docs/JsonApiColorPaletteIn.md +++ b/gooddata-api-client/docs/JsonApiColorPaletteIn.md @@ -3,13 +3,30 @@ JSON:API representation of colorPalette entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "colorPalette" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_color_palette_in import JsonApiColorPaletteIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiColorPaletteIn from a JSON string +json_api_color_palette_in_instance = JsonApiColorPaletteIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiColorPaletteIn.to_json()) +# convert the object into a dict +json_api_color_palette_in_dict = json_api_color_palette_in_instance.to_dict() +# create an instance of JsonApiColorPaletteIn from a dict +json_api_color_palette_in_from_dict = JsonApiColorPaletteIn.from_dict(json_api_color_palette_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiColorPaletteInAttributes.md b/gooddata-api-client/docs/JsonApiColorPaletteInAttributes.md index 42b9fef6d..cb3e8cba0 100644 --- a/gooddata-api-client/docs/JsonApiColorPaletteInAttributes.md +++ b/gooddata-api-client/docs/JsonApiColorPaletteInAttributes.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 15000 characters. | +**content** | **object** | Free-form JSON content. Maximum supported length is 15000 characters. | **name** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiColorPaletteInAttributes from a JSON string +json_api_color_palette_in_attributes_instance = JsonApiColorPaletteInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiColorPaletteInAttributes.to_json()) + +# convert the object into a dict +json_api_color_palette_in_attributes_dict = json_api_color_palette_in_attributes_instance.to_dict() +# create an instance of JsonApiColorPaletteInAttributes from a dict +json_api_color_palette_in_attributes_from_dict = JsonApiColorPaletteInAttributes.from_dict(json_api_color_palette_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiColorPaletteInDocument.md b/gooddata-api-client/docs/JsonApiColorPaletteInDocument.md index 675ed62fb..a5ae340a7 100644 --- a/gooddata-api-client/docs/JsonApiColorPaletteInDocument.md +++ b/gooddata-api-client/docs/JsonApiColorPaletteInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiColorPaletteIn**](JsonApiColorPaletteIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiColorPaletteInDocument from a JSON string +json_api_color_palette_in_document_instance = JsonApiColorPaletteInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiColorPaletteInDocument.to_json()) + +# convert the object into a dict +json_api_color_palette_in_document_dict = json_api_color_palette_in_document_instance.to_dict() +# create an instance of JsonApiColorPaletteInDocument from a dict +json_api_color_palette_in_document_from_dict = JsonApiColorPaletteInDocument.from_dict(json_api_color_palette_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiColorPaletteOut.md b/gooddata-api-client/docs/JsonApiColorPaletteOut.md index 674f11653..933a6cede 100644 --- a/gooddata-api-client/docs/JsonApiColorPaletteOut.md +++ b/gooddata-api-client/docs/JsonApiColorPaletteOut.md @@ -3,13 +3,30 @@ JSON:API representation of colorPalette entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "colorPalette" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_color_palette_out import JsonApiColorPaletteOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiColorPaletteOut from a JSON string +json_api_color_palette_out_instance = JsonApiColorPaletteOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiColorPaletteOut.to_json()) +# convert the object into a dict +json_api_color_palette_out_dict = json_api_color_palette_out_instance.to_dict() +# create an instance of JsonApiColorPaletteOut from a dict +json_api_color_palette_out_from_dict = JsonApiColorPaletteOut.from_dict(json_api_color_palette_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiColorPaletteOutDocument.md b/gooddata-api-client/docs/JsonApiColorPaletteOutDocument.md index 43bb1ac80..c4f4e5ed0 100644 --- a/gooddata-api-client/docs/JsonApiColorPaletteOutDocument.md +++ b/gooddata-api-client/docs/JsonApiColorPaletteOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiColorPaletteOut**](JsonApiColorPaletteOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiColorPaletteOutDocument from a JSON string +json_api_color_palette_out_document_instance = JsonApiColorPaletteOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiColorPaletteOutDocument.to_json()) + +# convert the object into a dict +json_api_color_palette_out_document_dict = json_api_color_palette_out_document_instance.to_dict() +# create an instance of JsonApiColorPaletteOutDocument from a dict +json_api_color_palette_out_document_from_dict = JsonApiColorPaletteOutDocument.from_dict(json_api_color_palette_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiColorPaletteOutList.md b/gooddata-api-client/docs/JsonApiColorPaletteOutList.md index 12636ae95..b11b3e331 100644 --- a/gooddata-api-client/docs/JsonApiColorPaletteOutList.md +++ b/gooddata-api-client/docs/JsonApiColorPaletteOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiColorPaletteOutWithLinks]**](JsonApiColorPaletteOutWithLinks.md) | | +**data** | [**List[JsonApiColorPaletteOutWithLinks]**](JsonApiColorPaletteOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiColorPaletteOutList from a JSON string +json_api_color_palette_out_list_instance = JsonApiColorPaletteOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiColorPaletteOutList.to_json()) + +# convert the object into a dict +json_api_color_palette_out_list_dict = json_api_color_palette_out_list_instance.to_dict() +# create an instance of JsonApiColorPaletteOutList from a dict +json_api_color_palette_out_list_from_dict = JsonApiColorPaletteOutList.from_dict(json_api_color_palette_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiColorPaletteOutWithLinks.md b/gooddata-api-client/docs/JsonApiColorPaletteOutWithLinks.md index c752040ef..08ff17e4e 100644 --- a/gooddata-api-client/docs/JsonApiColorPaletteOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiColorPaletteOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "colorPalette" +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_color_palette_out_with_links import JsonApiColorPaletteOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiColorPaletteOutWithLinks from a JSON string +json_api_color_palette_out_with_links_instance = JsonApiColorPaletteOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiColorPaletteOutWithLinks.to_json()) + +# convert the object into a dict +json_api_color_palette_out_with_links_dict = json_api_color_palette_out_with_links_instance.to_dict() +# create an instance of JsonApiColorPaletteOutWithLinks from a dict +json_api_color_palette_out_with_links_from_dict = JsonApiColorPaletteOutWithLinks.from_dict(json_api_color_palette_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiColorPalettePatch.md b/gooddata-api-client/docs/JsonApiColorPalettePatch.md index 902e33bb1..95721a86a 100644 --- a/gooddata-api-client/docs/JsonApiColorPalettePatch.md +++ b/gooddata-api-client/docs/JsonApiColorPalettePatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching colorPalette entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiColorPalettePatchAttributes**](JsonApiColorPalettePatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "colorPalette" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_color_palette_patch import JsonApiColorPalettePatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiColorPalettePatch from a JSON string +json_api_color_palette_patch_instance = JsonApiColorPalettePatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiColorPalettePatch.to_json()) +# convert the object into a dict +json_api_color_palette_patch_dict = json_api_color_palette_patch_instance.to_dict() +# create an instance of JsonApiColorPalettePatch from a dict +json_api_color_palette_patch_from_dict = JsonApiColorPalettePatch.from_dict(json_api_color_palette_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiColorPalettePatchAttributes.md b/gooddata-api-client/docs/JsonApiColorPalettePatchAttributes.md index 113a71a1d..54c64cf96 100644 --- a/gooddata-api-client/docs/JsonApiColorPalettePatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiColorPalettePatchAttributes.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] **name** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_color_palette_patch_attributes import JsonApiColorPalettePatchAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiColorPalettePatchAttributes from a JSON string +json_api_color_palette_patch_attributes_instance = JsonApiColorPalettePatchAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiColorPalettePatchAttributes.to_json()) + +# convert the object into a dict +json_api_color_palette_patch_attributes_dict = json_api_color_palette_patch_attributes_instance.to_dict() +# create an instance of JsonApiColorPalettePatchAttributes from a dict +json_api_color_palette_patch_attributes_from_dict = JsonApiColorPalettePatchAttributes.from_dict(json_api_color_palette_patch_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiColorPalettePatchDocument.md b/gooddata-api-client/docs/JsonApiColorPalettePatchDocument.md index e3d97aac5..f3db25944 100644 --- a/gooddata-api-client/docs/JsonApiColorPalettePatchDocument.md +++ b/gooddata-api-client/docs/JsonApiColorPalettePatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiColorPalettePatch**](JsonApiColorPalettePatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiColorPalettePatchDocument from a JSON string +json_api_color_palette_patch_document_instance = JsonApiColorPalettePatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiColorPalettePatchDocument.to_json()) + +# convert the object into a dict +json_api_color_palette_patch_document_dict = json_api_color_palette_patch_document_instance.to_dict() +# create an instance of JsonApiColorPalettePatchDocument from a dict +json_api_color_palette_patch_document_from_dict = JsonApiColorPalettePatchDocument.from_dict(json_api_color_palette_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationIn.md b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationIn.md index c27002e51..13a3d6f81 100644 --- a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationIn.md +++ b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationIn.md @@ -3,13 +3,30 @@ JSON:API representation of cookieSecurityConfiguration entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "cookieSecurityConfiguration" **attributes** | [**JsonApiCookieSecurityConfigurationInAttributes**](JsonApiCookieSecurityConfigurationInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_cookie_security_configuration_in import JsonApiCookieSecurityConfigurationIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCookieSecurityConfigurationIn from a JSON string +json_api_cookie_security_configuration_in_instance = JsonApiCookieSecurityConfigurationIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiCookieSecurityConfigurationIn.to_json()) +# convert the object into a dict +json_api_cookie_security_configuration_in_dict = json_api_cookie_security_configuration_in_instance.to_dict() +# create an instance of JsonApiCookieSecurityConfigurationIn from a dict +json_api_cookie_security_configuration_in_from_dict = JsonApiCookieSecurityConfigurationIn.from_dict(json_api_cookie_security_configuration_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationInAttributes.md b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationInAttributes.md index e3a35122f..975e81c2d 100644 --- a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationInAttributes.md +++ b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationInAttributes.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **last_rotation** | **datetime** | | [optional] **rotation_interval** | **str** | Length of interval between automatic rotations expressed in format of ISO 8601 duration | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_cookie_security_configuration_in_attributes import JsonApiCookieSecurityConfigurationInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCookieSecurityConfigurationInAttributes from a JSON string +json_api_cookie_security_configuration_in_attributes_instance = JsonApiCookieSecurityConfigurationInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiCookieSecurityConfigurationInAttributes.to_json()) + +# convert the object into a dict +json_api_cookie_security_configuration_in_attributes_dict = json_api_cookie_security_configuration_in_attributes_instance.to_dict() +# create an instance of JsonApiCookieSecurityConfigurationInAttributes from a dict +json_api_cookie_security_configuration_in_attributes_from_dict = JsonApiCookieSecurityConfigurationInAttributes.from_dict(json_api_cookie_security_configuration_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationInDocument.md b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationInDocument.md index b474d3e41..f566c6a2f 100644 --- a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationInDocument.md +++ b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiCookieSecurityConfigurationIn**](JsonApiCookieSecurityConfigurationIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCookieSecurityConfigurationInDocument from a JSON string +json_api_cookie_security_configuration_in_document_instance = JsonApiCookieSecurityConfigurationInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiCookieSecurityConfigurationInDocument.to_json()) + +# convert the object into a dict +json_api_cookie_security_configuration_in_document_dict = json_api_cookie_security_configuration_in_document_instance.to_dict() +# create an instance of JsonApiCookieSecurityConfigurationInDocument from a dict +json_api_cookie_security_configuration_in_document_from_dict = JsonApiCookieSecurityConfigurationInDocument.from_dict(json_api_cookie_security_configuration_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationOut.md b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationOut.md index 5a9aaad86..2c678a9db 100644 --- a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationOut.md +++ b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationOut.md @@ -3,13 +3,30 @@ JSON:API representation of cookieSecurityConfiguration entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "cookieSecurityConfiguration" **attributes** | [**JsonApiCookieSecurityConfigurationInAttributes**](JsonApiCookieSecurityConfigurationInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_cookie_security_configuration_out import JsonApiCookieSecurityConfigurationOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCookieSecurityConfigurationOut from a JSON string +json_api_cookie_security_configuration_out_instance = JsonApiCookieSecurityConfigurationOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiCookieSecurityConfigurationOut.to_json()) +# convert the object into a dict +json_api_cookie_security_configuration_out_dict = json_api_cookie_security_configuration_out_instance.to_dict() +# create an instance of JsonApiCookieSecurityConfigurationOut from a dict +json_api_cookie_security_configuration_out_from_dict = JsonApiCookieSecurityConfigurationOut.from_dict(json_api_cookie_security_configuration_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationOutDocument.md b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationOutDocument.md index 51c0fd836..587065b36 100644 --- a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationOutDocument.md +++ b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiCookieSecurityConfigurationOut**](JsonApiCookieSecurityConfigurationOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCookieSecurityConfigurationOutDocument from a JSON string +json_api_cookie_security_configuration_out_document_instance = JsonApiCookieSecurityConfigurationOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiCookieSecurityConfigurationOutDocument.to_json()) + +# convert the object into a dict +json_api_cookie_security_configuration_out_document_dict = json_api_cookie_security_configuration_out_document_instance.to_dict() +# create an instance of JsonApiCookieSecurityConfigurationOutDocument from a dict +json_api_cookie_security_configuration_out_document_from_dict = JsonApiCookieSecurityConfigurationOutDocument.from_dict(json_api_cookie_security_configuration_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationPatch.md b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationPatch.md index 6bae98a06..4904beca0 100644 --- a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationPatch.md +++ b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching cookieSecurityConfiguration entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "cookieSecurityConfiguration" **attributes** | [**JsonApiCookieSecurityConfigurationInAttributes**](JsonApiCookieSecurityConfigurationInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_cookie_security_configuration_patch import JsonApiCookieSecurityConfigurationPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCookieSecurityConfigurationPatch from a JSON string +json_api_cookie_security_configuration_patch_instance = JsonApiCookieSecurityConfigurationPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiCookieSecurityConfigurationPatch.to_json()) +# convert the object into a dict +json_api_cookie_security_configuration_patch_dict = json_api_cookie_security_configuration_patch_instance.to_dict() +# create an instance of JsonApiCookieSecurityConfigurationPatch from a dict +json_api_cookie_security_configuration_patch_from_dict = JsonApiCookieSecurityConfigurationPatch.from_dict(json_api_cookie_security_configuration_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationPatchDocument.md b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationPatchDocument.md index 02cc00d58..c0689dd8c 100644 --- a/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiCookieSecurityConfigurationPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiCookieSecurityConfigurationPatch**](JsonApiCookieSecurityConfigurationPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCookieSecurityConfigurationPatchDocument from a JSON string +json_api_cookie_security_configuration_patch_document_instance = JsonApiCookieSecurityConfigurationPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiCookieSecurityConfigurationPatchDocument.to_json()) + +# convert the object into a dict +json_api_cookie_security_configuration_patch_document_dict = json_api_cookie_security_configuration_patch_document_instance.to_dict() +# create an instance of JsonApiCookieSecurityConfigurationPatchDocument from a dict +json_api_cookie_security_configuration_patch_document_from_dict = JsonApiCookieSecurityConfigurationPatchDocument.from_dict(json_api_cookie_security_configuration_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCspDirectiveIn.md b/gooddata-api-client/docs/JsonApiCspDirectiveIn.md index f84bbac17..24e1832af 100644 --- a/gooddata-api-client/docs/JsonApiCspDirectiveIn.md +++ b/gooddata-api-client/docs/JsonApiCspDirectiveIn.md @@ -3,13 +3,30 @@ JSON:API representation of cspDirective entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiCspDirectiveInAttributes**](JsonApiCspDirectiveInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "cspDirective" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_csp_directive_in import JsonApiCspDirectiveIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCspDirectiveIn from a JSON string +json_api_csp_directive_in_instance = JsonApiCspDirectiveIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiCspDirectiveIn.to_json()) +# convert the object into a dict +json_api_csp_directive_in_dict = json_api_csp_directive_in_instance.to_dict() +# create an instance of JsonApiCspDirectiveIn from a dict +json_api_csp_directive_in_from_dict = JsonApiCspDirectiveIn.from_dict(json_api_csp_directive_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCspDirectiveInAttributes.md b/gooddata-api-client/docs/JsonApiCspDirectiveInAttributes.md index 50ba70105..9849756a6 100644 --- a/gooddata-api-client/docs/JsonApiCspDirectiveInAttributes.md +++ b/gooddata-api-client/docs/JsonApiCspDirectiveInAttributes.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sources** | **[str]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**sources** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCspDirectiveInAttributes from a JSON string +json_api_csp_directive_in_attributes_instance = JsonApiCspDirectiveInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiCspDirectiveInAttributes.to_json()) +# convert the object into a dict +json_api_csp_directive_in_attributes_dict = json_api_csp_directive_in_attributes_instance.to_dict() +# create an instance of JsonApiCspDirectiveInAttributes from a dict +json_api_csp_directive_in_attributes_from_dict = JsonApiCspDirectiveInAttributes.from_dict(json_api_csp_directive_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCspDirectiveInDocument.md b/gooddata-api-client/docs/JsonApiCspDirectiveInDocument.md index 892e9cd6d..d96ef63e6 100644 --- a/gooddata-api-client/docs/JsonApiCspDirectiveInDocument.md +++ b/gooddata-api-client/docs/JsonApiCspDirectiveInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiCspDirectiveIn**](JsonApiCspDirectiveIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCspDirectiveInDocument from a JSON string +json_api_csp_directive_in_document_instance = JsonApiCspDirectiveInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiCspDirectiveInDocument.to_json()) + +# convert the object into a dict +json_api_csp_directive_in_document_dict = json_api_csp_directive_in_document_instance.to_dict() +# create an instance of JsonApiCspDirectiveInDocument from a dict +json_api_csp_directive_in_document_from_dict = JsonApiCspDirectiveInDocument.from_dict(json_api_csp_directive_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCspDirectiveOut.md b/gooddata-api-client/docs/JsonApiCspDirectiveOut.md index c32d67948..2892a3f79 100644 --- a/gooddata-api-client/docs/JsonApiCspDirectiveOut.md +++ b/gooddata-api-client/docs/JsonApiCspDirectiveOut.md @@ -3,13 +3,30 @@ JSON:API representation of cspDirective entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiCspDirectiveInAttributes**](JsonApiCspDirectiveInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "cspDirective" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_csp_directive_out import JsonApiCspDirectiveOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCspDirectiveOut from a JSON string +json_api_csp_directive_out_instance = JsonApiCspDirectiveOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiCspDirectiveOut.to_json()) +# convert the object into a dict +json_api_csp_directive_out_dict = json_api_csp_directive_out_instance.to_dict() +# create an instance of JsonApiCspDirectiveOut from a dict +json_api_csp_directive_out_from_dict = JsonApiCspDirectiveOut.from_dict(json_api_csp_directive_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCspDirectiveOutDocument.md b/gooddata-api-client/docs/JsonApiCspDirectiveOutDocument.md index 9cdaa1df6..bd93fe08e 100644 --- a/gooddata-api-client/docs/JsonApiCspDirectiveOutDocument.md +++ b/gooddata-api-client/docs/JsonApiCspDirectiveOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiCspDirectiveOut**](JsonApiCspDirectiveOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCspDirectiveOutDocument from a JSON string +json_api_csp_directive_out_document_instance = JsonApiCspDirectiveOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiCspDirectiveOutDocument.to_json()) + +# convert the object into a dict +json_api_csp_directive_out_document_dict = json_api_csp_directive_out_document_instance.to_dict() +# create an instance of JsonApiCspDirectiveOutDocument from a dict +json_api_csp_directive_out_document_from_dict = JsonApiCspDirectiveOutDocument.from_dict(json_api_csp_directive_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCspDirectiveOutList.md b/gooddata-api-client/docs/JsonApiCspDirectiveOutList.md index 93870cdca..555e1568f 100644 --- a/gooddata-api-client/docs/JsonApiCspDirectiveOutList.md +++ b/gooddata-api-client/docs/JsonApiCspDirectiveOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiCspDirectiveOutWithLinks]**](JsonApiCspDirectiveOutWithLinks.md) | | +**data** | [**List[JsonApiCspDirectiveOutWithLinks]**](JsonApiCspDirectiveOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCspDirectiveOutList from a JSON string +json_api_csp_directive_out_list_instance = JsonApiCspDirectiveOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiCspDirectiveOutList.to_json()) + +# convert the object into a dict +json_api_csp_directive_out_list_dict = json_api_csp_directive_out_list_instance.to_dict() +# create an instance of JsonApiCspDirectiveOutList from a dict +json_api_csp_directive_out_list_from_dict = JsonApiCspDirectiveOutList.from_dict(json_api_csp_directive_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCspDirectiveOutWithLinks.md b/gooddata-api-client/docs/JsonApiCspDirectiveOutWithLinks.md index 79f10a257..ee463064f 100644 --- a/gooddata-api-client/docs/JsonApiCspDirectiveOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiCspDirectiveOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiCspDirectiveInAttributes**](JsonApiCspDirectiveInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "cspDirective" +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_csp_directive_out_with_links import JsonApiCspDirectiveOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCspDirectiveOutWithLinks from a JSON string +json_api_csp_directive_out_with_links_instance = JsonApiCspDirectiveOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiCspDirectiveOutWithLinks.to_json()) + +# convert the object into a dict +json_api_csp_directive_out_with_links_dict = json_api_csp_directive_out_with_links_instance.to_dict() +# create an instance of JsonApiCspDirectiveOutWithLinks from a dict +json_api_csp_directive_out_with_links_from_dict = JsonApiCspDirectiveOutWithLinks.from_dict(json_api_csp_directive_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCspDirectivePatch.md b/gooddata-api-client/docs/JsonApiCspDirectivePatch.md index 8b9076ff4..a4c6fcaa2 100644 --- a/gooddata-api-client/docs/JsonApiCspDirectivePatch.md +++ b/gooddata-api-client/docs/JsonApiCspDirectivePatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching cspDirective entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiCspDirectivePatchAttributes**](JsonApiCspDirectivePatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "cspDirective" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_csp_directive_patch import JsonApiCspDirectivePatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCspDirectivePatch from a JSON string +json_api_csp_directive_patch_instance = JsonApiCspDirectivePatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiCspDirectivePatch.to_json()) +# convert the object into a dict +json_api_csp_directive_patch_dict = json_api_csp_directive_patch_instance.to_dict() +# create an instance of JsonApiCspDirectivePatch from a dict +json_api_csp_directive_patch_from_dict = JsonApiCspDirectivePatch.from_dict(json_api_csp_directive_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCspDirectivePatchAttributes.md b/gooddata-api-client/docs/JsonApiCspDirectivePatchAttributes.md index fa3a1fdd5..2b7bdfa70 100644 --- a/gooddata-api-client/docs/JsonApiCspDirectivePatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiCspDirectivePatchAttributes.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sources** | **[str]** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**sources** | **List[str]** | | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_csp_directive_patch_attributes import JsonApiCspDirectivePatchAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCspDirectivePatchAttributes from a JSON string +json_api_csp_directive_patch_attributes_instance = JsonApiCspDirectivePatchAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiCspDirectivePatchAttributes.to_json()) +# convert the object into a dict +json_api_csp_directive_patch_attributes_dict = json_api_csp_directive_patch_attributes_instance.to_dict() +# create an instance of JsonApiCspDirectivePatchAttributes from a dict +json_api_csp_directive_patch_attributes_from_dict = JsonApiCspDirectivePatchAttributes.from_dict(json_api_csp_directive_patch_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCspDirectivePatchDocument.md b/gooddata-api-client/docs/JsonApiCspDirectivePatchDocument.md index 0f3bf0969..980c54afe 100644 --- a/gooddata-api-client/docs/JsonApiCspDirectivePatchDocument.md +++ b/gooddata-api-client/docs/JsonApiCspDirectivePatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiCspDirectivePatch**](JsonApiCspDirectivePatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCspDirectivePatchDocument from a JSON string +json_api_csp_directive_patch_document_instance = JsonApiCspDirectivePatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiCspDirectivePatchDocument.to_json()) + +# convert the object into a dict +json_api_csp_directive_patch_document_dict = json_api_csp_directive_patch_document_instance.to_dict() +# create an instance of JsonApiCspDirectivePatchDocument from a dict +json_api_csp_directive_patch_document_from_dict = JsonApiCspDirectivePatchDocument.from_dict(json_api_csp_directive_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingIn.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingIn.md index 0c15ae76f..5716ef286 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingIn.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingIn.md @@ -3,13 +3,30 @@ JSON:API representation of customApplicationSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiCustomApplicationSettingInAttributes**](JsonApiCustomApplicationSettingInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "customApplicationSetting" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_in import JsonApiCustomApplicationSettingIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingIn from a JSON string +json_api_custom_application_setting_in_instance = JsonApiCustomApplicationSettingIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingIn.to_json()) +# convert the object into a dict +json_api_custom_application_setting_in_dict = json_api_custom_application_setting_in_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingIn from a dict +json_api_custom_application_setting_in_from_dict = JsonApiCustomApplicationSettingIn.from_dict(json_api_custom_application_setting_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingInAttributes.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingInAttributes.md index 8b2a58d90..1ce0898cb 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingInAttributes.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingInAttributes.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **application_name** | **str** | | -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 15000 characters. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 15000 characters. | + +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingInAttributes from a JSON string +json_api_custom_application_setting_in_attributes_instance = JsonApiCustomApplicationSettingInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingInAttributes.to_json()) +# convert the object into a dict +json_api_custom_application_setting_in_attributes_dict = json_api_custom_application_setting_in_attributes_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingInAttributes from a dict +json_api_custom_application_setting_in_attributes_from_dict = JsonApiCustomApplicationSettingInAttributes.from_dict(json_api_custom_application_setting_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingInDocument.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingInDocument.md index ec0e067fc..b0025ffca 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingInDocument.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiCustomApplicationSettingIn**](JsonApiCustomApplicationSettingIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingInDocument from a JSON string +json_api_custom_application_setting_in_document_instance = JsonApiCustomApplicationSettingInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingInDocument.to_json()) + +# convert the object into a dict +json_api_custom_application_setting_in_document_dict = json_api_custom_application_setting_in_document_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingInDocument from a dict +json_api_custom_application_setting_in_document_from_dict = JsonApiCustomApplicationSettingInDocument.from_dict(json_api_custom_application_setting_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingOut.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingOut.md index 24116b2ed..931564cac 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingOut.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingOut.md @@ -3,14 +3,31 @@ JSON:API representation of customApplicationSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiCustomApplicationSettingInAttributes**](JsonApiCustomApplicationSettingInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "customApplicationSetting" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_out import JsonApiCustomApplicationSettingOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingOut from a JSON string +json_api_custom_application_setting_out_instance = JsonApiCustomApplicationSettingOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingOut.to_json()) +# convert the object into a dict +json_api_custom_application_setting_out_dict = json_api_custom_application_setting_out_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingOut from a dict +json_api_custom_application_setting_out_from_dict = JsonApiCustomApplicationSettingOut.from_dict(json_api_custom_application_setting_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutDocument.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutDocument.md index a51f909a3..05132dd97 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutDocument.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiCustomApplicationSettingOut**](JsonApiCustomApplicationSettingOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingOutDocument from a JSON string +json_api_custom_application_setting_out_document_instance = JsonApiCustomApplicationSettingOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingOutDocument.to_json()) + +# convert the object into a dict +json_api_custom_application_setting_out_document_dict = json_api_custom_application_setting_out_document_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingOutDocument from a dict +json_api_custom_application_setting_out_document_from_dict = JsonApiCustomApplicationSettingOutDocument.from_dict(json_api_custom_application_setting_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutList.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutList.md index 770762183..b02443b43 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutList.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiCustomApplicationSettingOutWithLinks]**](JsonApiCustomApplicationSettingOutWithLinks.md) | | +**data** | [**List[JsonApiCustomApplicationSettingOutWithLinks]**](JsonApiCustomApplicationSettingOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingOutList from a JSON string +json_api_custom_application_setting_out_list_instance = JsonApiCustomApplicationSettingOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingOutList.to_json()) + +# convert the object into a dict +json_api_custom_application_setting_out_list_dict = json_api_custom_application_setting_out_list_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingOutList from a dict +json_api_custom_application_setting_out_list_from_dict = JsonApiCustomApplicationSettingOutList.from_dict(json_api_custom_application_setting_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutWithLinks.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutWithLinks.md index a4c9087dd..72c2a0d4e 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutWithLinks.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiCustomApplicationSettingInAttributes**](JsonApiCustomApplicationSettingInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "customApplicationSetting" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_out_with_links import JsonApiCustomApplicationSettingOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingOutWithLinks from a JSON string +json_api_custom_application_setting_out_with_links_instance = JsonApiCustomApplicationSettingOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingOutWithLinks.to_json()) + +# convert the object into a dict +json_api_custom_application_setting_out_with_links_dict = json_api_custom_application_setting_out_with_links_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingOutWithLinks from a dict +json_api_custom_application_setting_out_with_links_from_dict = JsonApiCustomApplicationSettingOutWithLinks.from_dict(json_api_custom_application_setting_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatch.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatch.md index c11aa56c1..6bd5060d6 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatch.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching customApplicationSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiCustomApplicationSettingPatchAttributes**](JsonApiCustomApplicationSettingPatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "customApplicationSetting" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_patch import JsonApiCustomApplicationSettingPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingPatch from a JSON string +json_api_custom_application_setting_patch_instance = JsonApiCustomApplicationSettingPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingPatch.to_json()) +# convert the object into a dict +json_api_custom_application_setting_patch_dict = json_api_custom_application_setting_patch_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingPatch from a dict +json_api_custom_application_setting_patch_from_dict = JsonApiCustomApplicationSettingPatch.from_dict(json_api_custom_application_setting_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatchAttributes.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatchAttributes.md index 729304b8a..4756431f7 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatchAttributes.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **application_name** | **str** | | [optional] -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_patch_attributes import JsonApiCustomApplicationSettingPatchAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingPatchAttributes from a JSON string +json_api_custom_application_setting_patch_attributes_instance = JsonApiCustomApplicationSettingPatchAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingPatchAttributes.to_json()) +# convert the object into a dict +json_api_custom_application_setting_patch_attributes_dict = json_api_custom_application_setting_patch_attributes_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingPatchAttributes from a dict +json_api_custom_application_setting_patch_attributes_from_dict = JsonApiCustomApplicationSettingPatchAttributes.from_dict(json_api_custom_application_setting_patch_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatchDocument.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatchDocument.md index 1f667d3a3..2b374759b 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiCustomApplicationSettingPatch**](JsonApiCustomApplicationSettingPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingPatchDocument from a JSON string +json_api_custom_application_setting_patch_document_instance = JsonApiCustomApplicationSettingPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingPatchDocument.to_json()) + +# convert the object into a dict +json_api_custom_application_setting_patch_document_dict = json_api_custom_application_setting_patch_document_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingPatchDocument from a dict +json_api_custom_application_setting_patch_document_from_dict = JsonApiCustomApplicationSettingPatchDocument.from_dict(json_api_custom_application_setting_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingPostOptionalId.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPostOptionalId.md index e91628b54..d465188d3 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingPostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPostOptionalId.md @@ -3,13 +3,30 @@ JSON:API representation of customApplicationSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiCustomApplicationSettingInAttributes**](JsonApiCustomApplicationSettingInAttributes.md) | | -**type** | **str** | Object type | defaults to "customApplicationSetting" **id** | **str** | API identifier of an object | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id import JsonApiCustomApplicationSettingPostOptionalId + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingPostOptionalId from a JSON string +json_api_custom_application_setting_post_optional_id_instance = JsonApiCustomApplicationSettingPostOptionalId.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingPostOptionalId.to_json()) +# convert the object into a dict +json_api_custom_application_setting_post_optional_id_dict = json_api_custom_application_setting_post_optional_id_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingPostOptionalId from a dict +json_api_custom_application_setting_post_optional_id_from_dict = JsonApiCustomApplicationSettingPostOptionalId.from_dict(json_api_custom_application_setting_post_optional_id_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPostOptionalIdDocument.md index 50ac403dd..e9e544dc3 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPostOptionalIdDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiCustomApplicationSettingPostOptionalId**](JsonApiCustomApplicationSettingPostOptionalId.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiCustomApplicationSettingPostOptionalIdDocument from a JSON string +json_api_custom_application_setting_post_optional_id_document_instance = JsonApiCustomApplicationSettingPostOptionalIdDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiCustomApplicationSettingPostOptionalIdDocument.to_json()) + +# convert the object into a dict +json_api_custom_application_setting_post_optional_id_document_dict = json_api_custom_application_setting_post_optional_id_document_instance.to_dict() +# create an instance of JsonApiCustomApplicationSettingPostOptionalIdDocument from a dict +json_api_custom_application_setting_post_optional_id_document_from_dict = JsonApiCustomApplicationSettingPostOptionalIdDocument.from_dict(json_api_custom_application_setting_post_optional_id_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginIn.md b/gooddata-api-client/docs/JsonApiDashboardPluginIn.md index f99e292e9..9763ce9b9 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginIn.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginIn.md @@ -3,13 +3,30 @@ JSON:API representation of dashboardPlugin entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dashboardPlugin" **attributes** | [**JsonApiDashboardPluginInAttributes**](JsonApiDashboardPluginInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_in import JsonApiDashboardPluginIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginIn from a JSON string +json_api_dashboard_plugin_in_instance = JsonApiDashboardPluginIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginIn.to_json()) +# convert the object into a dict +json_api_dashboard_plugin_in_dict = json_api_dashboard_plugin_in_instance.to_dict() +# create an instance of JsonApiDashboardPluginIn from a dict +json_api_dashboard_plugin_in_from_dict = JsonApiDashboardPluginIn.from_dict(json_api_dashboard_plugin_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginInAttributes.md b/gooddata-api-client/docs/JsonApiDashboardPluginInAttributes.md index 5d4b3aad9..359c02809 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginInAttributes.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginInAttributes.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 250000 characters. | [optional] **description** | **str** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_in_attributes import JsonApiDashboardPluginInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginInAttributes from a JSON string +json_api_dashboard_plugin_in_attributes_instance = JsonApiDashboardPluginInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginInAttributes.to_json()) + +# convert the object into a dict +json_api_dashboard_plugin_in_attributes_dict = json_api_dashboard_plugin_in_attributes_instance.to_dict() +# create an instance of JsonApiDashboardPluginInAttributes from a dict +json_api_dashboard_plugin_in_attributes_from_dict = JsonApiDashboardPluginInAttributes.from_dict(json_api_dashboard_plugin_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginInDocument.md b/gooddata-api-client/docs/JsonApiDashboardPluginInDocument.md index ae638e90e..d90a37f4f 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginInDocument.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiDashboardPluginIn**](JsonApiDashboardPluginIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginInDocument from a JSON string +json_api_dashboard_plugin_in_document_instance = JsonApiDashboardPluginInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginInDocument.to_json()) + +# convert the object into a dict +json_api_dashboard_plugin_in_document_dict = json_api_dashboard_plugin_in_document_instance.to_dict() +# create an instance of JsonApiDashboardPluginInDocument from a dict +json_api_dashboard_plugin_in_document_from_dict = JsonApiDashboardPluginInDocument.from_dict(json_api_dashboard_plugin_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginLinkage.md b/gooddata-api-client/docs/JsonApiDashboardPluginLinkage.md index 779fc4eaa..dc08b4bc5 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginLinkage.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "dashboardPlugin" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_linkage import JsonApiDashboardPluginLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginLinkage from a JSON string +json_api_dashboard_plugin_linkage_instance = JsonApiDashboardPluginLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginLinkage.to_json()) +# convert the object into a dict +json_api_dashboard_plugin_linkage_dict = json_api_dashboard_plugin_linkage_instance.to_dict() +# create an instance of JsonApiDashboardPluginLinkage from a dict +json_api_dashboard_plugin_linkage_from_dict = JsonApiDashboardPluginLinkage.from_dict(json_api_dashboard_plugin_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginOut.md b/gooddata-api-client/docs/JsonApiDashboardPluginOut.md index a100dec14..857f0bdfd 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginOut.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginOut.md @@ -3,15 +3,32 @@ JSON:API representation of dashboardPlugin entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dashboardPlugin" **attributes** | [**JsonApiDashboardPluginOutAttributes**](JsonApiDashboardPluginOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiDashboardPluginOutRelationships**](JsonApiDashboardPluginOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginOut from a JSON string +json_api_dashboard_plugin_out_instance = JsonApiDashboardPluginOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginOut.to_json()) +# convert the object into a dict +json_api_dashboard_plugin_out_dict = json_api_dashboard_plugin_out_instance.to_dict() +# create an instance of JsonApiDashboardPluginOut from a dict +json_api_dashboard_plugin_out_from_dict = JsonApiDashboardPluginOut.from_dict(json_api_dashboard_plugin_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginOutAttributes.md b/gooddata-api-client/docs/JsonApiDashboardPluginOutAttributes.md index 7c298a0b9..70c2a90f4 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginOutAttributes.md @@ -2,17 +2,34 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 250000 characters. | [optional] **created_at** | **datetime** | | [optional] **description** | **str** | | [optional] **modified_at** | **datetime** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_out_attributes import JsonApiDashboardPluginOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginOutAttributes from a JSON string +json_api_dashboard_plugin_out_attributes_instance = JsonApiDashboardPluginOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginOutAttributes.to_json()) + +# convert the object into a dict +json_api_dashboard_plugin_out_attributes_dict = json_api_dashboard_plugin_out_attributes_instance.to_dict() +# create an instance of JsonApiDashboardPluginOutAttributes from a dict +json_api_dashboard_plugin_out_attributes_from_dict = JsonApiDashboardPluginOutAttributes.from_dict(json_api_dashboard_plugin_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginOutDocument.md b/gooddata-api-client/docs/JsonApiDashboardPluginOutDocument.md index 3f8a0f5d8..107ee2729 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginOutDocument.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiDashboardPluginOut**](JsonApiDashboardPluginOut.md) | | -**included** | [**[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | Included resources | [optional] +**included** | [**List[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginOutDocument from a JSON string +json_api_dashboard_plugin_out_document_instance = JsonApiDashboardPluginOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginOutDocument.to_json()) + +# convert the object into a dict +json_api_dashboard_plugin_out_document_dict = json_api_dashboard_plugin_out_document_instance.to_dict() +# create an instance of JsonApiDashboardPluginOutDocument from a dict +json_api_dashboard_plugin_out_document_from_dict = JsonApiDashboardPluginOutDocument.from_dict(json_api_dashboard_plugin_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginOutList.md b/gooddata-api-client/docs/JsonApiDashboardPluginOutList.md index 4a1c9213d..5a2624f2e 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginOutList.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiDashboardPluginOutWithLinks]**](JsonApiDashboardPluginOutWithLinks.md) | | -**included** | [**[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | Included resources | [optional] +**data** | [**List[JsonApiDashboardPluginOutWithLinks]**](JsonApiDashboardPluginOutWithLinks.md) | | +**included** | [**List[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginOutList from a JSON string +json_api_dashboard_plugin_out_list_instance = JsonApiDashboardPluginOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginOutList.to_json()) + +# convert the object into a dict +json_api_dashboard_plugin_out_list_dict = json_api_dashboard_plugin_out_list_instance.to_dict() +# create an instance of JsonApiDashboardPluginOutList from a dict +json_api_dashboard_plugin_out_list_from_dict = JsonApiDashboardPluginOutList.from_dict(json_api_dashboard_plugin_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginOutRelationships.md b/gooddata-api-client/docs/JsonApiDashboardPluginOutRelationships.md index 95ca9ce8b..2c36f3faa 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginOutRelationships.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] **modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginOutRelationships from a JSON string +json_api_dashboard_plugin_out_relationships_instance = JsonApiDashboardPluginOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginOutRelationships.to_json()) + +# convert the object into a dict +json_api_dashboard_plugin_out_relationships_dict = json_api_dashboard_plugin_out_relationships_instance.to_dict() +# create an instance of JsonApiDashboardPluginOutRelationships from a dict +json_api_dashboard_plugin_out_relationships_from_dict = JsonApiDashboardPluginOutRelationships.from_dict(json_api_dashboard_plugin_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginOutWithLinks.md b/gooddata-api-client/docs/JsonApiDashboardPluginOutWithLinks.md index a4fd8cdcb..af6e16fb4 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dashboardPlugin" **attributes** | [**JsonApiDashboardPluginOutAttributes**](JsonApiDashboardPluginOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiDashboardPluginOutRelationships**](JsonApiDashboardPluginOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginOutWithLinks from a JSON string +json_api_dashboard_plugin_out_with_links_instance = JsonApiDashboardPluginOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginOutWithLinks.to_json()) + +# convert the object into a dict +json_api_dashboard_plugin_out_with_links_dict = json_api_dashboard_plugin_out_with_links_instance.to_dict() +# create an instance of JsonApiDashboardPluginOutWithLinks from a dict +json_api_dashboard_plugin_out_with_links_from_dict = JsonApiDashboardPluginOutWithLinks.from_dict(json_api_dashboard_plugin_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginPatch.md b/gooddata-api-client/docs/JsonApiDashboardPluginPatch.md index d43917b84..19436b3e0 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginPatch.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching dashboardPlugin entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dashboardPlugin" **attributes** | [**JsonApiDashboardPluginInAttributes**](JsonApiDashboardPluginInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_patch import JsonApiDashboardPluginPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginPatch from a JSON string +json_api_dashboard_plugin_patch_instance = JsonApiDashboardPluginPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginPatch.to_json()) +# convert the object into a dict +json_api_dashboard_plugin_patch_dict = json_api_dashboard_plugin_patch_instance.to_dict() +# create an instance of JsonApiDashboardPluginPatch from a dict +json_api_dashboard_plugin_patch_from_dict = JsonApiDashboardPluginPatch.from_dict(json_api_dashboard_plugin_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginPatchDocument.md b/gooddata-api-client/docs/JsonApiDashboardPluginPatchDocument.md index 573bbcd53..3ed7ff59a 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiDashboardPluginPatch**](JsonApiDashboardPluginPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginPatchDocument from a JSON string +json_api_dashboard_plugin_patch_document_instance = JsonApiDashboardPluginPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginPatchDocument.to_json()) + +# convert the object into a dict +json_api_dashboard_plugin_patch_document_dict = json_api_dashboard_plugin_patch_document_instance.to_dict() +# create an instance of JsonApiDashboardPluginPatchDocument from a dict +json_api_dashboard_plugin_patch_document_from_dict = JsonApiDashboardPluginPatchDocument.from_dict(json_api_dashboard_plugin_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginPostOptionalId.md b/gooddata-api-client/docs/JsonApiDashboardPluginPostOptionalId.md index 5ef9ef874..7239d6334 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginPostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginPostOptionalId.md @@ -3,13 +3,30 @@ JSON:API representation of dashboardPlugin entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | Object type | defaults to "dashboardPlugin" **attributes** | [**JsonApiDashboardPluginInAttributes**](JsonApiDashboardPluginInAttributes.md) | | [optional] **id** | **str** | API identifier of an object | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id import JsonApiDashboardPluginPostOptionalId + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginPostOptionalId from a JSON string +json_api_dashboard_plugin_post_optional_id_instance = JsonApiDashboardPluginPostOptionalId.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginPostOptionalId.to_json()) +# convert the object into a dict +json_api_dashboard_plugin_post_optional_id_dict = json_api_dashboard_plugin_post_optional_id_instance.to_dict() +# create an instance of JsonApiDashboardPluginPostOptionalId from a dict +json_api_dashboard_plugin_post_optional_id_from_dict = JsonApiDashboardPluginPostOptionalId.from_dict(json_api_dashboard_plugin_post_optional_id_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiDashboardPluginPostOptionalIdDocument.md index 74385c7a6..82825a4a4 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginPostOptionalIdDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiDashboardPluginPostOptionalId**](JsonApiDashboardPluginPostOptionalId.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDashboardPluginPostOptionalIdDocument from a JSON string +json_api_dashboard_plugin_post_optional_id_document_instance = JsonApiDashboardPluginPostOptionalIdDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiDashboardPluginPostOptionalIdDocument.to_json()) + +# convert the object into a dict +json_api_dashboard_plugin_post_optional_id_document_dict = json_api_dashboard_plugin_post_optional_id_document_instance.to_dict() +# create an instance of JsonApiDashboardPluginPostOptionalIdDocument from a dict +json_api_dashboard_plugin_post_optional_id_document_from_dict = JsonApiDashboardPluginPostOptionalIdDocument.from_dict(json_api_dashboard_plugin_post_optional_id_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDashboardPluginToManyLinkage.md b/gooddata-api-client/docs/JsonApiDashboardPluginToManyLinkage.md deleted file mode 100644 index ba28e0e97..000000000 --- a/gooddata-api-client/docs/JsonApiDashboardPluginToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiDashboardPluginToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiDashboardPluginLinkage]**](JsonApiDashboardPluginLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOut.md b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOut.md index ee39744c2..6812107db 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOut.md +++ b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOut.md @@ -3,14 +3,31 @@ JSON:API representation of dataSourceIdentifier entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiDataSourceIdentifierOutAttributes**](JsonApiDataSourceIdentifierOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dataSourceIdentifier" **meta** | [**JsonApiDataSourceIdentifierOutMeta**](JsonApiDataSourceIdentifierOutMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_data_source_identifier_out import JsonApiDataSourceIdentifierOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceIdentifierOut from a JSON string +json_api_data_source_identifier_out_instance = JsonApiDataSourceIdentifierOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceIdentifierOut.to_json()) +# convert the object into a dict +json_api_data_source_identifier_out_dict = json_api_data_source_identifier_out_instance.to_dict() +# create an instance of JsonApiDataSourceIdentifierOut from a dict +json_api_data_source_identifier_out_from_dict = JsonApiDataSourceIdentifierOut.from_dict(json_api_data_source_identifier_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutAttributes.md b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutAttributes.md index 6636d682e..f2882ad55 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutAttributes.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | | -**schema** | **str** | | +**var_schema** | **str** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_data_source_identifier_out_attributes import JsonApiDataSourceIdentifierOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceIdentifierOutAttributes from a JSON string +json_api_data_source_identifier_out_attributes_instance = JsonApiDataSourceIdentifierOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceIdentifierOutAttributes.to_json()) + +# convert the object into a dict +json_api_data_source_identifier_out_attributes_dict = json_api_data_source_identifier_out_attributes_instance.to_dict() +# create an instance of JsonApiDataSourceIdentifierOutAttributes from a dict +json_api_data_source_identifier_out_attributes_from_dict = JsonApiDataSourceIdentifierOutAttributes.from_dict(json_api_data_source_identifier_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutDocument.md b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutDocument.md index 66090dc9f..eac809dc9 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutDocument.md +++ b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiDataSourceIdentifierOut**](JsonApiDataSourceIdentifierOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceIdentifierOutDocument from a JSON string +json_api_data_source_identifier_out_document_instance = JsonApiDataSourceIdentifierOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceIdentifierOutDocument.to_json()) + +# convert the object into a dict +json_api_data_source_identifier_out_document_dict = json_api_data_source_identifier_out_document_instance.to_dict() +# create an instance of JsonApiDataSourceIdentifierOutDocument from a dict +json_api_data_source_identifier_out_document_from_dict = JsonApiDataSourceIdentifierOutDocument.from_dict(json_api_data_source_identifier_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutList.md b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutList.md index 93721b00f..4724e57e8 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutList.md +++ b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiDataSourceIdentifierOutWithLinks]**](JsonApiDataSourceIdentifierOutWithLinks.md) | | +**data** | [**List[JsonApiDataSourceIdentifierOutWithLinks]**](JsonApiDataSourceIdentifierOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceIdentifierOutList from a JSON string +json_api_data_source_identifier_out_list_instance = JsonApiDataSourceIdentifierOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceIdentifierOutList.to_json()) + +# convert the object into a dict +json_api_data_source_identifier_out_list_dict = json_api_data_source_identifier_out_list_instance.to_dict() +# create an instance of JsonApiDataSourceIdentifierOutList from a dict +json_api_data_source_identifier_out_list_from_dict = JsonApiDataSourceIdentifierOutList.from_dict(json_api_data_source_identifier_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutMeta.md b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutMeta.md index 8bb8ef1d4..3f679b0aa 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutMeta.md +++ b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutMeta.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permissions** | **[str]** | List of valid permissions for a logged-in user. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | **List[str]** | List of valid permissions for a logged-in user. | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceIdentifierOutMeta from a JSON string +json_api_data_source_identifier_out_meta_instance = JsonApiDataSourceIdentifierOutMeta.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceIdentifierOutMeta.to_json()) +# convert the object into a dict +json_api_data_source_identifier_out_meta_dict = json_api_data_source_identifier_out_meta_instance.to_dict() +# create an instance of JsonApiDataSourceIdentifierOutMeta from a dict +json_api_data_source_identifier_out_meta_from_dict = JsonApiDataSourceIdentifierOutMeta.from_dict(json_api_data_source_identifier_out_meta_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutWithLinks.md b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutWithLinks.md index 3bb1f890d..3ba033545 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutWithLinks.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiDataSourceIdentifierOutAttributes**](JsonApiDataSourceIdentifierOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dataSourceIdentifier" **meta** | [**JsonApiDataSourceIdentifierOutMeta**](JsonApiDataSourceIdentifierOutMeta.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_data_source_identifier_out_with_links import JsonApiDataSourceIdentifierOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceIdentifierOutWithLinks from a JSON string +json_api_data_source_identifier_out_with_links_instance = JsonApiDataSourceIdentifierOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceIdentifierOutWithLinks.to_json()) + +# convert the object into a dict +json_api_data_source_identifier_out_with_links_dict = json_api_data_source_identifier_out_with_links_instance.to_dict() +# create an instance of JsonApiDataSourceIdentifierOutWithLinks from a dict +json_api_data_source_identifier_out_with_links_from_dict = JsonApiDataSourceIdentifierOutWithLinks.from_dict(json_api_data_source_identifier_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceIn.md b/gooddata-api-client/docs/JsonApiDataSourceIn.md index 0d397872b..0cb3cdcf2 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceIn.md +++ b/gooddata-api-client/docs/JsonApiDataSourceIn.md @@ -3,13 +3,30 @@ JSON:API representation of dataSource entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiDataSourceInAttributes**](JsonApiDataSourceInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dataSource" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_data_source_in import JsonApiDataSourceIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceIn from a JSON string +json_api_data_source_in_instance = JsonApiDataSourceIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceIn.to_json()) +# convert the object into a dict +json_api_data_source_in_dict = json_api_data_source_in_instance.to_dict() +# create an instance of JsonApiDataSourceIn from a dict +json_api_data_source_in_from_dict = JsonApiDataSourceIn.from_dict(json_api_data_source_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md b/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md index e93c33f5c..97c216eab 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md @@ -2,23 +2,40 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**cache_strategy** | **str** | Determines how the results coming from a particular datasource should be cached. | [optional] +**client_id** | **str** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] +**client_secret** | **str** | The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] **name** | **str** | User-facing name of the data source. | -**schema** | **str** | The schema to use as the root of the data for the data source. | +**parameters** | [**List[JsonApiDataSourceInAttributesParametersInner]**](JsonApiDataSourceInAttributesParametersInner.md) | Additional parameters to be used when connecting to the database providing the data for the data source. | [optional] +**password** | **str** | The password to use to connect to the database providing the data for the data source. | [optional] +**private_key** | **str** | The private key to use to connect to the database providing the data for the data source. | [optional] +**private_key_passphrase** | **str** | The passphrase used to encrypt the private key. | [optional] +**var_schema** | **str** | The schema to use as the root of the data for the data source. | +**token** | **str** | The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account). | [optional] **type** | **str** | Type of the database providing the data for the data source. | -**cache_strategy** | **str, none_type** | Determines how the results coming from a particular datasource should be cached. | [optional] -**client_id** | **str, none_type** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] -**client_secret** | **str, none_type** | The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] -**parameters** | [**[JsonApiDataSourceInAttributesParametersInner], none_type**](JsonApiDataSourceInAttributesParametersInner.md) | Additional parameters to be used when connecting to the database providing the data for the data source. | [optional] -**password** | **str, none_type** | The password to use to connect to the database providing the data for the data source. | [optional] -**private_key** | **str, none_type** | The private key to use to connect to the database providing the data for the data source. | [optional] -**private_key_passphrase** | **str, none_type** | The passphrase used to encrypt the private key. | [optional] -**token** | **str, none_type** | The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account). | [optional] -**url** | **str, none_type** | The URL of the database providing the data for the data source. | [optional] -**username** | **str, none_type** | The username to use to connect to the database providing the data for the data source. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**url** | **str** | The URL of the database providing the data for the data source. | [optional] +**username** | **str** | The username to use to connect to the database providing the data for the data source. | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_data_source_in_attributes import JsonApiDataSourceInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceInAttributes from a JSON string +json_api_data_source_in_attributes_instance = JsonApiDataSourceInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceInAttributes.to_json()) +# convert the object into a dict +json_api_data_source_in_attributes_dict = json_api_data_source_in_attributes_instance.to_dict() +# create an instance of JsonApiDataSourceInAttributes from a dict +json_api_data_source_in_attributes_from_dict = JsonApiDataSourceInAttributes.from_dict(json_api_data_source_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceInAttributesParametersInner.md b/gooddata-api-client/docs/JsonApiDataSourceInAttributesParametersInner.md index cfafc7e30..63b05161a 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceInAttributesParametersInner.md +++ b/gooddata-api-client/docs/JsonApiDataSourceInAttributesParametersInner.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | | **value** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceInAttributesParametersInner from a JSON string +json_api_data_source_in_attributes_parameters_inner_instance = JsonApiDataSourceInAttributesParametersInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceInAttributesParametersInner.to_json()) + +# convert the object into a dict +json_api_data_source_in_attributes_parameters_inner_dict = json_api_data_source_in_attributes_parameters_inner_instance.to_dict() +# create an instance of JsonApiDataSourceInAttributesParametersInner from a dict +json_api_data_source_in_attributes_parameters_inner_from_dict = JsonApiDataSourceInAttributesParametersInner.from_dict(json_api_data_source_in_attributes_parameters_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceInDocument.md b/gooddata-api-client/docs/JsonApiDataSourceInDocument.md index 4c377574c..75cae5ba7 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceInDocument.md +++ b/gooddata-api-client/docs/JsonApiDataSourceInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiDataSourceIn**](JsonApiDataSourceIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceInDocument from a JSON string +json_api_data_source_in_document_instance = JsonApiDataSourceInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceInDocument.to_json()) + +# convert the object into a dict +json_api_data_source_in_document_dict = json_api_data_source_in_document_instance.to_dict() +# create an instance of JsonApiDataSourceInDocument from a dict +json_api_data_source_in_document_from_dict = JsonApiDataSourceInDocument.from_dict(json_api_data_source_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceOut.md b/gooddata-api-client/docs/JsonApiDataSourceOut.md index 073b0479f..62681cc83 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceOut.md +++ b/gooddata-api-client/docs/JsonApiDataSourceOut.md @@ -3,14 +3,31 @@ JSON:API representation of dataSource entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiDataSourceOutAttributes**](JsonApiDataSourceOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dataSource" **meta** | [**JsonApiDataSourceIdentifierOutMeta**](JsonApiDataSourceIdentifierOutMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_data_source_out import JsonApiDataSourceOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceOut from a JSON string +json_api_data_source_out_instance = JsonApiDataSourceOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceOut.to_json()) +# convert the object into a dict +json_api_data_source_out_dict = json_api_data_source_out_instance.to_dict() +# create an instance of JsonApiDataSourceOut from a dict +json_api_data_source_out_from_dict = JsonApiDataSourceOut.from_dict(json_api_data_source_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md b/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md index 9c3cc73cb..c199e2c63 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md @@ -2,20 +2,37 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**authentication_type** | **str** | Type of authentication used to connect to the database. | [optional] +**cache_strategy** | **str** | Determines how the results coming from a particular datasource should be cached. | [optional] +**client_id** | **str** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] +**decoded_parameters** | [**List[JsonApiDataSourceInAttributesParametersInner]**](JsonApiDataSourceInAttributesParametersInner.md) | Decoded parameters to be used when connecting to the database providing the data for the data source. | [optional] **name** | **str** | User-facing name of the data source. | -**schema** | **str** | The schema to use as the root of the data for the data source. | +**parameters** | [**List[JsonApiDataSourceInAttributesParametersInner]**](JsonApiDataSourceInAttributesParametersInner.md) | Additional parameters to be used when connecting to the database providing the data for the data source. | [optional] +**var_schema** | **str** | The schema to use as the root of the data for the data source. | **type** | **str** | Type of the database providing the data for the data source. | -**authentication_type** | **str, none_type** | Type of authentication used to connect to the database. | [optional] -**cache_strategy** | **str, none_type** | Determines how the results coming from a particular datasource should be cached. | [optional] -**client_id** | **str, none_type** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] -**decoded_parameters** | [**[JsonApiDataSourceInAttributesParametersInner], none_type**](JsonApiDataSourceInAttributesParametersInner.md) | Decoded parameters to be used when connecting to the database providing the data for the data source. | [optional] -**parameters** | [**[JsonApiDataSourceInAttributesParametersInner], none_type**](JsonApiDataSourceInAttributesParametersInner.md) | Additional parameters to be used when connecting to the database providing the data for the data source. | [optional] -**url** | **str, none_type** | The URL of the database providing the data for the data source. | [optional] -**username** | **str, none_type** | The username to use to connect to the database providing the data for the data source. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**url** | **str** | The URL of the database providing the data for the data source. | [optional] +**username** | **str** | The username to use to connect to the database providing the data for the data source. | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_data_source_out_attributes import JsonApiDataSourceOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceOutAttributes from a JSON string +json_api_data_source_out_attributes_instance = JsonApiDataSourceOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceOutAttributes.to_json()) +# convert the object into a dict +json_api_data_source_out_attributes_dict = json_api_data_source_out_attributes_instance.to_dict() +# create an instance of JsonApiDataSourceOutAttributes from a dict +json_api_data_source_out_attributes_from_dict = JsonApiDataSourceOutAttributes.from_dict(json_api_data_source_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceOutDocument.md b/gooddata-api-client/docs/JsonApiDataSourceOutDocument.md index 7db5a8db5..2b4785de7 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceOutDocument.md +++ b/gooddata-api-client/docs/JsonApiDataSourceOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiDataSourceOut**](JsonApiDataSourceOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceOutDocument from a JSON string +json_api_data_source_out_document_instance = JsonApiDataSourceOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceOutDocument.to_json()) + +# convert the object into a dict +json_api_data_source_out_document_dict = json_api_data_source_out_document_instance.to_dict() +# create an instance of JsonApiDataSourceOutDocument from a dict +json_api_data_source_out_document_from_dict = JsonApiDataSourceOutDocument.from_dict(json_api_data_source_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceOutList.md b/gooddata-api-client/docs/JsonApiDataSourceOutList.md index b7ddbd424..7c3624a12 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceOutList.md +++ b/gooddata-api-client/docs/JsonApiDataSourceOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiDataSourceOutWithLinks]**](JsonApiDataSourceOutWithLinks.md) | | +**data** | [**List[JsonApiDataSourceOutWithLinks]**](JsonApiDataSourceOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceOutList from a JSON string +json_api_data_source_out_list_instance = JsonApiDataSourceOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceOutList.to_json()) + +# convert the object into a dict +json_api_data_source_out_list_dict = json_api_data_source_out_list_instance.to_dict() +# create an instance of JsonApiDataSourceOutList from a dict +json_api_data_source_out_list_from_dict = JsonApiDataSourceOutList.from_dict(json_api_data_source_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourceOutWithLinks.md b/gooddata-api-client/docs/JsonApiDataSourceOutWithLinks.md index ef998c7f1..7b49ae0d4 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiDataSourceOutWithLinks.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiDataSourceOutAttributes**](JsonApiDataSourceOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dataSource" **meta** | [**JsonApiDataSourceIdentifierOutMeta**](JsonApiDataSourceIdentifierOutMeta.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_data_source_out_with_links import JsonApiDataSourceOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourceOutWithLinks from a JSON string +json_api_data_source_out_with_links_instance = JsonApiDataSourceOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourceOutWithLinks.to_json()) + +# convert the object into a dict +json_api_data_source_out_with_links_dict = json_api_data_source_out_with_links_instance.to_dict() +# create an instance of JsonApiDataSourceOutWithLinks from a dict +json_api_data_source_out_with_links_from_dict = JsonApiDataSourceOutWithLinks.from_dict(json_api_data_source_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourcePatch.md b/gooddata-api-client/docs/JsonApiDataSourcePatch.md index d2107d635..b4ecc92e1 100644 --- a/gooddata-api-client/docs/JsonApiDataSourcePatch.md +++ b/gooddata-api-client/docs/JsonApiDataSourcePatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching dataSource entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiDataSourcePatchAttributes**](JsonApiDataSourcePatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dataSource" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_data_source_patch import JsonApiDataSourcePatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourcePatch from a JSON string +json_api_data_source_patch_instance = JsonApiDataSourcePatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourcePatch.to_json()) +# convert the object into a dict +json_api_data_source_patch_dict = json_api_data_source_patch_instance.to_dict() +# create an instance of JsonApiDataSourcePatch from a dict +json_api_data_source_patch_from_dict = JsonApiDataSourcePatch.from_dict(json_api_data_source_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md b/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md index 0ea1eb5f7..e67408f2e 100644 --- a/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md @@ -2,23 +2,40 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cache_strategy** | **str, none_type** | Determines how the results coming from a particular datasource should be cached. | [optional] -**client_id** | **str, none_type** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] -**client_secret** | **str, none_type** | The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] +**cache_strategy** | **str** | Determines how the results coming from a particular datasource should be cached. | [optional] +**client_id** | **str** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] +**client_secret** | **str** | The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] **name** | **str** | User-facing name of the data source. | [optional] -**parameters** | [**[JsonApiDataSourceInAttributesParametersInner], none_type**](JsonApiDataSourceInAttributesParametersInner.md) | Additional parameters to be used when connecting to the database providing the data for the data source. | [optional] -**password** | **str, none_type** | The password to use to connect to the database providing the data for the data source. | [optional] -**private_key** | **str, none_type** | The private key to use to connect to the database providing the data for the data source. | [optional] -**private_key_passphrase** | **str, none_type** | The passphrase used to encrypt the private key. | [optional] -**schema** | **str** | The schema to use as the root of the data for the data source. | [optional] -**token** | **str, none_type** | The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account). | [optional] +**parameters** | [**List[JsonApiDataSourceInAttributesParametersInner]**](JsonApiDataSourceInAttributesParametersInner.md) | Additional parameters to be used when connecting to the database providing the data for the data source. | [optional] +**password** | **str** | The password to use to connect to the database providing the data for the data source. | [optional] +**private_key** | **str** | The private key to use to connect to the database providing the data for the data source. | [optional] +**private_key_passphrase** | **str** | The passphrase used to encrypt the private key. | [optional] +**var_schema** | **str** | The schema to use as the root of the data for the data source. | [optional] +**token** | **str** | The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account). | [optional] **type** | **str** | Type of the database providing the data for the data source. | [optional] -**url** | **str, none_type** | The URL of the database providing the data for the data source. | [optional] -**username** | **str, none_type** | The username to use to connect to the database providing the data for the data source. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**url** | **str** | The URL of the database providing the data for the data source. | [optional] +**username** | **str** | The username to use to connect to the database providing the data for the data source. | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_data_source_patch_attributes import JsonApiDataSourcePatchAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourcePatchAttributes from a JSON string +json_api_data_source_patch_attributes_instance = JsonApiDataSourcePatchAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourcePatchAttributes.to_json()) +# convert the object into a dict +json_api_data_source_patch_attributes_dict = json_api_data_source_patch_attributes_instance.to_dict() +# create an instance of JsonApiDataSourcePatchAttributes from a dict +json_api_data_source_patch_attributes_from_dict = JsonApiDataSourcePatchAttributes.from_dict(json_api_data_source_patch_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDataSourcePatchDocument.md b/gooddata-api-client/docs/JsonApiDataSourcePatchDocument.md index 21ac42572..4352baa15 100644 --- a/gooddata-api-client/docs/JsonApiDataSourcePatchDocument.md +++ b/gooddata-api-client/docs/JsonApiDataSourcePatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiDataSourcePatch**](JsonApiDataSourcePatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDataSourcePatchDocument from a JSON string +json_api_data_source_patch_document_instance = JsonApiDataSourcePatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiDataSourcePatchDocument.to_json()) + +# convert the object into a dict +json_api_data_source_patch_document_dict = json_api_data_source_patch_document_instance.to_dict() +# create an instance of JsonApiDataSourcePatchDocument from a dict +json_api_data_source_patch_document_from_dict = JsonApiDataSourcePatchDocument.from_dict(json_api_data_source_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetLinkage.md b/gooddata-api-client/docs/JsonApiDatasetLinkage.md index 450c9791d..dc16a9ff7 100644 --- a/gooddata-api-client/docs/JsonApiDatasetLinkage.md +++ b/gooddata-api-client/docs/JsonApiDatasetLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "dataset" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_dataset_linkage import JsonApiDatasetLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetLinkage from a JSON string +json_api_dataset_linkage_instance = JsonApiDatasetLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetLinkage.to_json()) +# convert the object into a dict +json_api_dataset_linkage_dict = json_api_dataset_linkage_instance.to_dict() +# create an instance of JsonApiDatasetLinkage from a dict +json_api_dataset_linkage_from_dict = JsonApiDatasetLinkage.from_dict(json_api_dataset_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOut.md b/gooddata-api-client/docs/JsonApiDatasetOut.md index 90e96d308..af168cb69 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOut.md +++ b/gooddata-api-client/docs/JsonApiDatasetOut.md @@ -3,15 +3,32 @@ JSON:API representation of dataset entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiDatasetOutAttributes**](JsonApiDatasetOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dataset" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiDatasetOutRelationships**](JsonApiDatasetOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out import JsonApiDatasetOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOut from a JSON string +json_api_dataset_out_instance = JsonApiDatasetOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOut.to_json()) +# convert the object into a dict +json_api_dataset_out_dict = json_api_dataset_out_instance.to_dict() +# create an instance of JsonApiDatasetOut from a dict +json_api_dataset_out_from_dict = JsonApiDatasetOut.from_dict(json_api_dataset_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutAttributes.md b/gooddata-api-client/docs/JsonApiDatasetOutAttributes.md index a570c1907..ceb5a8bd5 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutAttributes.md @@ -2,23 +2,40 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | | **are_relations_valid** | **bool** | | [optional] **data_source_table_id** | **str** | | [optional] -**data_source_table_path** | **[str]** | Path to database table. | [optional] +**data_source_table_path** | **List[str]** | Path to database table. | [optional] **description** | **str** | | [optional] -**grain** | [**[JsonApiDatasetOutAttributesGrainInner]**](JsonApiDatasetOutAttributesGrainInner.md) | | [optional] +**grain** | [**List[JsonApiDatasetOutAttributesGrainInner]**](JsonApiDatasetOutAttributesGrainInner.md) | | [optional] **precedence** | **int** | | [optional] -**reference_properties** | [**[JsonApiDatasetOutAttributesReferencePropertiesInner]**](JsonApiDatasetOutAttributesReferencePropertiesInner.md) | | [optional] +**reference_properties** | [**List[JsonApiDatasetOutAttributesReferencePropertiesInner]**](JsonApiDatasetOutAttributesReferencePropertiesInner.md) | | [optional] **sql** | [**JsonApiDatasetOutAttributesSql**](JsonApiDatasetOutAttributesSql.md) | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**workspace_data_filter_columns** | [**[JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner]**](JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner.md) | | [optional] -**workspace_data_filter_references** | [**[JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner]**](JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | +**workspace_data_filter_columns** | [**List[JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner]**](JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner.md) | | [optional] +**workspace_data_filter_references** | [**List[JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner]**](JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_attributes import JsonApiDatasetOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutAttributes from a JSON string +json_api_dataset_out_attributes_instance = JsonApiDatasetOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutAttributes.to_json()) +# convert the object into a dict +json_api_dataset_out_attributes_dict = json_api_dataset_out_attributes_instance.to_dict() +# create an instance of JsonApiDatasetOutAttributes from a dict +json_api_dataset_out_attributes_from_dict = JsonApiDatasetOutAttributes.from_dict(json_api_dataset_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutAttributesGrainInner.md b/gooddata-api-client/docs/JsonApiDatasetOutAttributesGrainInner.md index b8208d171..ff1f2ba5c 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutAttributesGrainInner.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutAttributesGrainInner.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_attributes_grain_inner import JsonApiDatasetOutAttributesGrainInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutAttributesGrainInner from a JSON string +json_api_dataset_out_attributes_grain_inner_instance = JsonApiDatasetOutAttributesGrainInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutAttributesGrainInner.to_json()) + +# convert the object into a dict +json_api_dataset_out_attributes_grain_inner_dict = json_api_dataset_out_attributes_grain_inner_instance.to_dict() +# create an instance of JsonApiDatasetOutAttributesGrainInner from a dict +json_api_dataset_out_attributes_grain_inner_from_dict = JsonApiDatasetOutAttributesGrainInner.from_dict(json_api_dataset_out_attributes_grain_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutAttributesReferencePropertiesInner.md b/gooddata-api-client/docs/JsonApiDatasetOutAttributesReferencePropertiesInner.md index 2d48d224f..dc602dc63 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutAttributesReferencePropertiesInner.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutAttributesReferencePropertiesInner.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identifier** | [**DatasetReferenceIdentifier**](DatasetReferenceIdentifier.md) | | **multivalue** | **bool** | | -**source_column_data_types** | **[str]** | | [optional] -**source_columns** | **[str]** | | [optional] -**sources** | [**[ReferenceSourceColumn]**](ReferenceSourceColumn.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**source_column_data_types** | **List[str]** | | [optional] +**source_columns** | **List[str]** | | [optional] +**sources** | [**List[ReferenceSourceColumn]**](ReferenceSourceColumn.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_attributes_reference_properties_inner import JsonApiDatasetOutAttributesReferencePropertiesInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutAttributesReferencePropertiesInner from a JSON string +json_api_dataset_out_attributes_reference_properties_inner_instance = JsonApiDatasetOutAttributesReferencePropertiesInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutAttributesReferencePropertiesInner.to_json()) +# convert the object into a dict +json_api_dataset_out_attributes_reference_properties_inner_dict = json_api_dataset_out_attributes_reference_properties_inner_instance.to_dict() +# create an instance of JsonApiDatasetOutAttributesReferencePropertiesInner from a dict +json_api_dataset_out_attributes_reference_properties_inner_from_dict = JsonApiDatasetOutAttributesReferencePropertiesInner.from_dict(json_api_dataset_out_attributes_reference_properties_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutAttributesSql.md b/gooddata-api-client/docs/JsonApiDatasetOutAttributesSql.md index 6ca1cc2e9..187143385 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutAttributesSql.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutAttributesSql.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_source_id** | **str** | | **statement** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_attributes_sql import JsonApiDatasetOutAttributesSql + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutAttributesSql from a JSON string +json_api_dataset_out_attributes_sql_instance = JsonApiDatasetOutAttributesSql.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutAttributesSql.to_json()) + +# convert the object into a dict +json_api_dataset_out_attributes_sql_dict = json_api_dataset_out_attributes_sql_instance.to_dict() +# create an instance of JsonApiDatasetOutAttributesSql from a dict +json_api_dataset_out_attributes_sql_from_dict = JsonApiDatasetOutAttributesSql.from_dict(json_api_dataset_out_attributes_sql_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner.md b/gooddata-api-client/docs/JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner.md index ecdce41e4..4f5cc9ede 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_type** | **str** | | **name** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_attributes_workspace_data_filter_columns_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner from a JSON string +json_api_dataset_out_attributes_workspace_data_filter_columns_inner_instance = JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner.to_json()) + +# convert the object into a dict +json_api_dataset_out_attributes_workspace_data_filter_columns_inner_dict = json_api_dataset_out_attributes_workspace_data_filter_columns_inner_instance.to_dict() +# create an instance of JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner from a dict +json_api_dataset_out_attributes_workspace_data_filter_columns_inner_from_dict = JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner.from_dict(json_api_dataset_out_attributes_workspace_data_filter_columns_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner.md b/gooddata-api-client/docs/JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner.md index 7bd71f6bc..9759926be 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner.md @@ -3,13 +3,30 @@ Workspace data filter reference. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **filter_column** | **str** | | **filter_column_data_type** | **str** | | **filter_id** | [**DatasetWorkspaceDataFilterIdentifier**](DatasetWorkspaceDataFilterIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_attributes_workspace_data_filter_references_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner from a JSON string +json_api_dataset_out_attributes_workspace_data_filter_references_inner_instance = JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner.to_json()) + +# convert the object into a dict +json_api_dataset_out_attributes_workspace_data_filter_references_inner_dict = json_api_dataset_out_attributes_workspace_data_filter_references_inner_instance.to_dict() +# create an instance of JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner from a dict +json_api_dataset_out_attributes_workspace_data_filter_references_inner_from_dict = JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner.from_dict(json_api_dataset_out_attributes_workspace_data_filter_references_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutDocument.md b/gooddata-api-client/docs/JsonApiDatasetOutDocument.md index ede30b1c5..be4546447 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutDocument.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiDatasetOut**](JsonApiDatasetOut.md) | | -**included** | [**[JsonApiDatasetOutIncludes]**](JsonApiDatasetOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiDatasetOutIncludes]**](JsonApiDatasetOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutDocument from a JSON string +json_api_dataset_out_document_instance = JsonApiDatasetOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutDocument.to_json()) + +# convert the object into a dict +json_api_dataset_out_document_dict = json_api_dataset_out_document_instance.to_dict() +# create an instance of JsonApiDatasetOutDocument from a dict +json_api_dataset_out_document_from_dict = JsonApiDatasetOutDocument.from_dict(json_api_dataset_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutIncludes.md b/gooddata-api-client/docs/JsonApiDatasetOutIncludes.md index 87d70a8d1..10724224a 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiWorkspaceDataFilterInAttributes**](JsonApiWorkspaceDataFilterInAttributes.md) | | +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiWorkspaceDataFilterInRelationships**](JsonApiWorkspaceDataFilterInRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**attributes** | [**JsonApiWorkspaceDataFilterInAttributes**](JsonApiWorkspaceDataFilterInAttributes.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "workspaceDataFilter" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_includes import JsonApiDatasetOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutIncludes from a JSON string +json_api_dataset_out_includes_instance = JsonApiDatasetOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutIncludes.to_json()) + +# convert the object into a dict +json_api_dataset_out_includes_dict = json_api_dataset_out_includes_instance.to_dict() +# create an instance of JsonApiDatasetOutIncludes from a dict +json_api_dataset_out_includes_from_dict = JsonApiDatasetOutIncludes.from_dict(json_api_dataset_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutList.md b/gooddata-api-client/docs/JsonApiDatasetOutList.md index a6edfdfa3..e6c538f81 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutList.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiDatasetOutWithLinks]**](JsonApiDatasetOutWithLinks.md) | | -**included** | [**[JsonApiDatasetOutIncludes]**](JsonApiDatasetOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiDatasetOutWithLinks]**](JsonApiDatasetOutWithLinks.md) | | +**included** | [**List[JsonApiDatasetOutIncludes]**](JsonApiDatasetOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutList from a JSON string +json_api_dataset_out_list_instance = JsonApiDatasetOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutList.to_json()) + +# convert the object into a dict +json_api_dataset_out_list_dict = json_api_dataset_out_list_instance.to_dict() +# create an instance of JsonApiDatasetOutList from a dict +json_api_dataset_out_list_from_dict = JsonApiDatasetOutList.from_dict(json_api_dataset_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutRelationships.md b/gooddata-api-client/docs/JsonApiDatasetOutRelationships.md index f88ecb21e..e042c4306 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutRelationships.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **aggregated_facts** | [**JsonApiDatasetOutRelationshipsAggregatedFacts**](JsonApiDatasetOutRelationshipsAggregatedFacts.md) | | [optional] @@ -9,8 +10,24 @@ Name | Type | Description | Notes **facts** | [**JsonApiDatasetOutRelationshipsFacts**](JsonApiDatasetOutRelationshipsFacts.md) | | [optional] **references** | [**JsonApiAnalyticalDashboardOutRelationshipsDatasets**](JsonApiAnalyticalDashboardOutRelationshipsDatasets.md) | | [optional] **workspace_data_filters** | [**JsonApiDatasetOutRelationshipsWorkspaceDataFilters**](JsonApiDatasetOutRelationshipsWorkspaceDataFilters.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_relationships import JsonApiDatasetOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutRelationships from a JSON string +json_api_dataset_out_relationships_instance = JsonApiDatasetOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutRelationships.to_json()) + +# convert the object into a dict +json_api_dataset_out_relationships_dict = json_api_dataset_out_relationships_instance.to_dict() +# create an instance of JsonApiDatasetOutRelationships from a dict +json_api_dataset_out_relationships_from_dict = JsonApiDatasetOutRelationships.from_dict(json_api_dataset_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsAggregatedFacts.md b/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsAggregatedFacts.md index 7dcefcab8..d1e6f8f87 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsAggregatedFacts.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsAggregatedFacts.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiAggregatedFactToManyLinkage**](JsonApiAggregatedFactToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiAggregatedFactLinkage]**](JsonApiAggregatedFactLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_relationships_aggregated_facts import JsonApiDatasetOutRelationshipsAggregatedFacts + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutRelationshipsAggregatedFacts from a JSON string +json_api_dataset_out_relationships_aggregated_facts_instance = JsonApiDatasetOutRelationshipsAggregatedFacts.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutRelationshipsAggregatedFacts.to_json()) +# convert the object into a dict +json_api_dataset_out_relationships_aggregated_facts_dict = json_api_dataset_out_relationships_aggregated_facts_instance.to_dict() +# create an instance of JsonApiDatasetOutRelationshipsAggregatedFacts from a dict +json_api_dataset_out_relationships_aggregated_facts_from_dict = JsonApiDatasetOutRelationshipsAggregatedFacts.from_dict(json_api_dataset_out_relationships_aggregated_facts_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsFacts.md b/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsFacts.md index 3393fb6f5..cc3cd0e0f 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsFacts.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsFacts.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiFactToManyLinkage**](JsonApiFactToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiFactLinkage]**](JsonApiFactLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutRelationshipsFacts from a JSON string +json_api_dataset_out_relationships_facts_instance = JsonApiDatasetOutRelationshipsFacts.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutRelationshipsFacts.to_json()) +# convert the object into a dict +json_api_dataset_out_relationships_facts_dict = json_api_dataset_out_relationships_facts_instance.to_dict() +# create an instance of JsonApiDatasetOutRelationshipsFacts from a dict +json_api_dataset_out_relationships_facts_from_dict = JsonApiDatasetOutRelationshipsFacts.from_dict(json_api_dataset_out_relationships_facts_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsWorkspaceDataFilters.md b/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsWorkspaceDataFilters.md index 865d5aeaf..b61999549 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsWorkspaceDataFilters.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsWorkspaceDataFilters.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiWorkspaceDataFilterToManyLinkage**](JsonApiWorkspaceDataFilterToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiWorkspaceDataFilterLinkage]**](JsonApiWorkspaceDataFilterLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_relationships_workspace_data_filters import JsonApiDatasetOutRelationshipsWorkspaceDataFilters + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutRelationshipsWorkspaceDataFilters from a JSON string +json_api_dataset_out_relationships_workspace_data_filters_instance = JsonApiDatasetOutRelationshipsWorkspaceDataFilters.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutRelationshipsWorkspaceDataFilters.to_json()) +# convert the object into a dict +json_api_dataset_out_relationships_workspace_data_filters_dict = json_api_dataset_out_relationships_workspace_data_filters_instance.to_dict() +# create an instance of JsonApiDatasetOutRelationshipsWorkspaceDataFilters from a dict +json_api_dataset_out_relationships_workspace_data_filters_from_dict = JsonApiDatasetOutRelationshipsWorkspaceDataFilters.from_dict(json_api_dataset_out_relationships_workspace_data_filters_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetOutWithLinks.md b/gooddata-api-client/docs/JsonApiDatasetOutWithLinks.md index 913bb00a4..a6a04e0a1 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiDatasetOutAttributes**](JsonApiDatasetOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "dataset" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiDatasetOutRelationships**](JsonApiDatasetOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetOutWithLinks from a JSON string +json_api_dataset_out_with_links_instance = JsonApiDatasetOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetOutWithLinks.to_json()) + +# convert the object into a dict +json_api_dataset_out_with_links_dict = json_api_dataset_out_with_links_instance.to_dict() +# create an instance of JsonApiDatasetOutWithLinks from a dict +json_api_dataset_out_with_links_from_dict = JsonApiDatasetOutWithLinks.from_dict(json_api_dataset_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiDatasetToManyLinkage.md b/gooddata-api-client/docs/JsonApiDatasetToManyLinkage.md deleted file mode 100644 index c05fae7e9..000000000 --- a/gooddata-api-client/docs/JsonApiDatasetToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiDatasetToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiDatasetLinkage]**](JsonApiDatasetLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiDatasetToOneLinkage.md b/gooddata-api-client/docs/JsonApiDatasetToOneLinkage.md index 4b61452f2..7c62de914 100644 --- a/gooddata-api-client/docs/JsonApiDatasetToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiDatasetToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "dataset" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiDatasetToOneLinkage from a JSON string +json_api_dataset_to_one_linkage_instance = JsonApiDatasetToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiDatasetToOneLinkage.to_json()) +# convert the object into a dict +json_api_dataset_to_one_linkage_dict = json_api_dataset_to_one_linkage_instance.to_dict() +# create an instance of JsonApiDatasetToOneLinkage from a dict +json_api_dataset_to_one_linkage_from_dict = JsonApiDatasetToOneLinkage.from_dict(json_api_dataset_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiEntitlementOut.md b/gooddata-api-client/docs/JsonApiEntitlementOut.md index 8f70260cd..64c4ff5e2 100644 --- a/gooddata-api-client/docs/JsonApiEntitlementOut.md +++ b/gooddata-api-client/docs/JsonApiEntitlementOut.md @@ -3,13 +3,30 @@ JSON:API representation of entitlement entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "entitlement" **attributes** | [**JsonApiEntitlementOutAttributes**](JsonApiEntitlementOutAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_entitlement_out import JsonApiEntitlementOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiEntitlementOut from a JSON string +json_api_entitlement_out_instance = JsonApiEntitlementOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiEntitlementOut.to_json()) +# convert the object into a dict +json_api_entitlement_out_dict = json_api_entitlement_out_instance.to_dict() +# create an instance of JsonApiEntitlementOut from a dict +json_api_entitlement_out_from_dict = JsonApiEntitlementOut.from_dict(json_api_entitlement_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiEntitlementOutAttributes.md b/gooddata-api-client/docs/JsonApiEntitlementOutAttributes.md index ccb0744bd..7f791fdfe 100644 --- a/gooddata-api-client/docs/JsonApiEntitlementOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiEntitlementOutAttributes.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **expiry** | **date** | | [optional] **value** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_entitlement_out_attributes import JsonApiEntitlementOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiEntitlementOutAttributes from a JSON string +json_api_entitlement_out_attributes_instance = JsonApiEntitlementOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiEntitlementOutAttributes.to_json()) + +# convert the object into a dict +json_api_entitlement_out_attributes_dict = json_api_entitlement_out_attributes_instance.to_dict() +# create an instance of JsonApiEntitlementOutAttributes from a dict +json_api_entitlement_out_attributes_from_dict = JsonApiEntitlementOutAttributes.from_dict(json_api_entitlement_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiEntitlementOutDocument.md b/gooddata-api-client/docs/JsonApiEntitlementOutDocument.md index 7854da19d..180bdaaeb 100644 --- a/gooddata-api-client/docs/JsonApiEntitlementOutDocument.md +++ b/gooddata-api-client/docs/JsonApiEntitlementOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiEntitlementOut**](JsonApiEntitlementOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiEntitlementOutDocument from a JSON string +json_api_entitlement_out_document_instance = JsonApiEntitlementOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiEntitlementOutDocument.to_json()) + +# convert the object into a dict +json_api_entitlement_out_document_dict = json_api_entitlement_out_document_instance.to_dict() +# create an instance of JsonApiEntitlementOutDocument from a dict +json_api_entitlement_out_document_from_dict = JsonApiEntitlementOutDocument.from_dict(json_api_entitlement_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiEntitlementOutList.md b/gooddata-api-client/docs/JsonApiEntitlementOutList.md index 88b53ae65..fdb99caa7 100644 --- a/gooddata-api-client/docs/JsonApiEntitlementOutList.md +++ b/gooddata-api-client/docs/JsonApiEntitlementOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiEntitlementOutWithLinks]**](JsonApiEntitlementOutWithLinks.md) | | +**data** | [**List[JsonApiEntitlementOutWithLinks]**](JsonApiEntitlementOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiEntitlementOutList from a JSON string +json_api_entitlement_out_list_instance = JsonApiEntitlementOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiEntitlementOutList.to_json()) + +# convert the object into a dict +json_api_entitlement_out_list_dict = json_api_entitlement_out_list_instance.to_dict() +# create an instance of JsonApiEntitlementOutList from a dict +json_api_entitlement_out_list_from_dict = JsonApiEntitlementOutList.from_dict(json_api_entitlement_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiEntitlementOutWithLinks.md b/gooddata-api-client/docs/JsonApiEntitlementOutWithLinks.md index 5f45d44dd..2f4f76304 100644 --- a/gooddata-api-client/docs/JsonApiEntitlementOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiEntitlementOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "entitlement" **attributes** | [**JsonApiEntitlementOutAttributes**](JsonApiEntitlementOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_entitlement_out_with_links import JsonApiEntitlementOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiEntitlementOutWithLinks from a JSON string +json_api_entitlement_out_with_links_instance = JsonApiEntitlementOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiEntitlementOutWithLinks.to_json()) + +# convert the object into a dict +json_api_entitlement_out_with_links_dict = json_api_entitlement_out_with_links_instance.to_dict() +# create an instance of JsonApiEntitlementOutWithLinks from a dict +json_api_entitlement_out_with_links_from_dict = JsonApiEntitlementOutWithLinks.from_dict(json_api_entitlement_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionIn.md b/gooddata-api-client/docs/JsonApiExportDefinitionIn.md index e921ceba9..302d6abac 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionIn.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionIn.md @@ -3,14 +3,31 @@ JSON:API representation of exportDefinition entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "exportDefinition" **attributes** | [**JsonApiExportDefinitionInAttributes**](JsonApiExportDefinitionInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiExportDefinitionInRelationships**](JsonApiExportDefinitionInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_in import JsonApiExportDefinitionIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionIn from a JSON string +json_api_export_definition_in_instance = JsonApiExportDefinitionIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionIn.to_json()) +# convert the object into a dict +json_api_export_definition_in_dict = json_api_export_definition_in_instance.to_dict() +# create an instance of JsonApiExportDefinitionIn from a dict +json_api_export_definition_in_from_dict = JsonApiExportDefinitionIn.from_dict(json_api_export_definition_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionInAttributes.md b/gooddata-api-client/docs/JsonApiExportDefinitionInAttributes.md index 314070239..b4cc4c6d5 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionInAttributes.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionInAttributes.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] **description** | **str** | | [optional] **request_payload** | [**JsonApiExportDefinitionInAttributesRequestPayload**](JsonApiExportDefinitionInAttributesRequestPayload.md) | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_in_attributes import JsonApiExportDefinitionInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionInAttributes from a JSON string +json_api_export_definition_in_attributes_instance = JsonApiExportDefinitionInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionInAttributes.to_json()) + +# convert the object into a dict +json_api_export_definition_in_attributes_dict = json_api_export_definition_in_attributes_instance.to_dict() +# create an instance of JsonApiExportDefinitionInAttributes from a dict +json_api_export_definition_in_attributes_from_dict = JsonApiExportDefinitionInAttributes.from_dict(json_api_export_definition_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionInAttributesRequestPayload.md b/gooddata-api-client/docs/JsonApiExportDefinitionInAttributesRequestPayload.md index 98f7a0841..6b153d9b8 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionInAttributesRequestPayload.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionInAttributesRequestPayload.md @@ -3,20 +3,37 @@ JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**metadata** | [**JsonNode**](JsonNode.md) | | [optional] +**dashboard_id** | **str** | Dashboard identifier | +**file_name** | **str** | Filename of downloaded file without extension. | +**metadata** | **object** | Free-form JSON object | [optional] **custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] **execution_result** | **str** | Execution result identifier. | [optional] +**format** | **str** | Expected file format. | **related_dashboard_id** | **str** | Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard. | [optional] **settings** | [**Settings**](Settings.md) | | [optional] **visualization_object** | **str** | Visualization object identifier. Alternative to executionResult property. | [optional] -**visualization_object_custom_filters** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] -**dashboard_id** | **str** | Dashboard identifier | [optional] -**file_name** | **str** | Filename of downloaded file without extension. | [optional] -**format** | **str** | Expected file format. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**visualization_object_custom_filters** | **List[object]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_in_attributes_request_payload import JsonApiExportDefinitionInAttributesRequestPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionInAttributesRequestPayload from a JSON string +json_api_export_definition_in_attributes_request_payload_instance = JsonApiExportDefinitionInAttributesRequestPayload.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionInAttributesRequestPayload.to_json()) +# convert the object into a dict +json_api_export_definition_in_attributes_request_payload_dict = json_api_export_definition_in_attributes_request_payload_instance.to_dict() +# create an instance of JsonApiExportDefinitionInAttributesRequestPayload from a dict +json_api_export_definition_in_attributes_request_payload_from_dict = JsonApiExportDefinitionInAttributesRequestPayload.from_dict(json_api_export_definition_in_attributes_request_payload_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionInDocument.md b/gooddata-api-client/docs/JsonApiExportDefinitionInDocument.md index 943294fd5..5199974bc 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionInDocument.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiExportDefinitionIn**](JsonApiExportDefinitionIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionInDocument from a JSON string +json_api_export_definition_in_document_instance = JsonApiExportDefinitionInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionInDocument.to_json()) + +# convert the object into a dict +json_api_export_definition_in_document_dict = json_api_export_definition_in_document_instance.to_dict() +# create an instance of JsonApiExportDefinitionInDocument from a dict +json_api_export_definition_in_document_from_dict = JsonApiExportDefinitionInDocument.from_dict(json_api_export_definition_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionInRelationships.md b/gooddata-api-client/docs/JsonApiExportDefinitionInRelationships.md index dbd3b075e..aa92038c8 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionInRelationships.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionInRelationships.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboard** | [**JsonApiAutomationInRelationshipsAnalyticalDashboard**](JsonApiAutomationInRelationshipsAnalyticalDashboard.md) | | [optional] **visualization_object** | [**JsonApiExportDefinitionInRelationshipsVisualizationObject**](JsonApiExportDefinitionInRelationshipsVisualizationObject.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_in_relationships import JsonApiExportDefinitionInRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionInRelationships from a JSON string +json_api_export_definition_in_relationships_instance = JsonApiExportDefinitionInRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionInRelationships.to_json()) + +# convert the object into a dict +json_api_export_definition_in_relationships_dict = json_api_export_definition_in_relationships_instance.to_dict() +# create an instance of JsonApiExportDefinitionInRelationships from a dict +json_api_export_definition_in_relationships_from_dict = JsonApiExportDefinitionInRelationships.from_dict(json_api_export_definition_in_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionInRelationshipsVisualizationObject.md b/gooddata-api-client/docs/JsonApiExportDefinitionInRelationshipsVisualizationObject.md index b4ada3cd5..53e0aec78 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionInRelationshipsVisualizationObject.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionInRelationshipsVisualizationObject.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiVisualizationObjectToOneLinkage**](JsonApiVisualizationObjectToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_in_relationships_visualization_object import JsonApiExportDefinitionInRelationshipsVisualizationObject + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionInRelationshipsVisualizationObject from a JSON string +json_api_export_definition_in_relationships_visualization_object_instance = JsonApiExportDefinitionInRelationshipsVisualizationObject.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionInRelationshipsVisualizationObject.to_json()) + +# convert the object into a dict +json_api_export_definition_in_relationships_visualization_object_dict = json_api_export_definition_in_relationships_visualization_object_instance.to_dict() +# create an instance of JsonApiExportDefinitionInRelationshipsVisualizationObject from a dict +json_api_export_definition_in_relationships_visualization_object_from_dict = JsonApiExportDefinitionInRelationshipsVisualizationObject.from_dict(json_api_export_definition_in_relationships_visualization_object_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionLinkage.md b/gooddata-api-client/docs/JsonApiExportDefinitionLinkage.md index 1c196e983..2ae5a58b1 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionLinkage.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "exportDefinition" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_linkage import JsonApiExportDefinitionLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionLinkage from a JSON string +json_api_export_definition_linkage_instance = JsonApiExportDefinitionLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionLinkage.to_json()) +# convert the object into a dict +json_api_export_definition_linkage_dict = json_api_export_definition_linkage_instance.to_dict() +# create an instance of JsonApiExportDefinitionLinkage from a dict +json_api_export_definition_linkage_from_dict = JsonApiExportDefinitionLinkage.from_dict(json_api_export_definition_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionOut.md b/gooddata-api-client/docs/JsonApiExportDefinitionOut.md index 412f6b0be..ddddebfef 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionOut.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionOut.md @@ -3,15 +3,32 @@ JSON:API representation of exportDefinition entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "exportDefinition" **attributes** | [**JsonApiExportDefinitionOutAttributes**](JsonApiExportDefinitionOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiExportDefinitionOutRelationships**](JsonApiExportDefinitionOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_out import JsonApiExportDefinitionOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionOut from a JSON string +json_api_export_definition_out_instance = JsonApiExportDefinitionOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionOut.to_json()) +# convert the object into a dict +json_api_export_definition_out_dict = json_api_export_definition_out_instance.to_dict() +# create an instance of JsonApiExportDefinitionOut from a dict +json_api_export_definition_out_from_dict = JsonApiExportDefinitionOut.from_dict(json_api_export_definition_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionOutAttributes.md b/gooddata-api-client/docs/JsonApiExportDefinitionOutAttributes.md index 025f96d45..58205e88d 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionOutAttributes.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] @@ -9,10 +10,26 @@ Name | Type | Description | Notes **description** | **str** | | [optional] **modified_at** | **datetime** | | [optional] **request_payload** | [**JsonApiExportDefinitionInAttributesRequestPayload**](JsonApiExportDefinitionInAttributesRequestPayload.md) | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_out_attributes import JsonApiExportDefinitionOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionOutAttributes from a JSON string +json_api_export_definition_out_attributes_instance = JsonApiExportDefinitionOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionOutAttributes.to_json()) + +# convert the object into a dict +json_api_export_definition_out_attributes_dict = json_api_export_definition_out_attributes_instance.to_dict() +# create an instance of JsonApiExportDefinitionOutAttributes from a dict +json_api_export_definition_out_attributes_from_dict = JsonApiExportDefinitionOutAttributes.from_dict(json_api_export_definition_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionOutDocument.md b/gooddata-api-client/docs/JsonApiExportDefinitionOutDocument.md index 5110ebbc7..854caf163 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionOutDocument.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiExportDefinitionOut**](JsonApiExportDefinitionOut.md) | | -**included** | [**[JsonApiExportDefinitionOutIncludes]**](JsonApiExportDefinitionOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiExportDefinitionOutIncludes]**](JsonApiExportDefinitionOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionOutDocument from a JSON string +json_api_export_definition_out_document_instance = JsonApiExportDefinitionOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionOutDocument.to_json()) + +# convert the object into a dict +json_api_export_definition_out_document_dict = json_api_export_definition_out_document_instance.to_dict() +# create an instance of JsonApiExportDefinitionOutDocument from a dict +json_api_export_definition_out_document_from_dict = JsonApiExportDefinitionOutDocument.from_dict(json_api_export_definition_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionOutIncludes.md b/gooddata-api-client/docs/JsonApiExportDefinitionOutIncludes.md index 227da8aeb..36de45c69 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiUserIdentifierOutAttributes**](JsonApiUserIdentifierOutAttributes.md) | | +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAutomationOutRelationships**](JsonApiAutomationOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**attributes** | [**JsonApiUserIdentifierOutAttributes**](JsonApiUserIdentifierOutAttributes.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "userIdentifier" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_out_includes import JsonApiExportDefinitionOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionOutIncludes from a JSON string +json_api_export_definition_out_includes_instance = JsonApiExportDefinitionOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionOutIncludes.to_json()) + +# convert the object into a dict +json_api_export_definition_out_includes_dict = json_api_export_definition_out_includes_instance.to_dict() +# create an instance of JsonApiExportDefinitionOutIncludes from a dict +json_api_export_definition_out_includes_from_dict = JsonApiExportDefinitionOutIncludes.from_dict(json_api_export_definition_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionOutList.md b/gooddata-api-client/docs/JsonApiExportDefinitionOutList.md index c35fb1d6d..d1af188af 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionOutList.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiExportDefinitionOutWithLinks]**](JsonApiExportDefinitionOutWithLinks.md) | | -**included** | [**[JsonApiExportDefinitionOutIncludes]**](JsonApiExportDefinitionOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiExportDefinitionOutWithLinks]**](JsonApiExportDefinitionOutWithLinks.md) | | +**included** | [**List[JsonApiExportDefinitionOutIncludes]**](JsonApiExportDefinitionOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_out_list import JsonApiExportDefinitionOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionOutList from a JSON string +json_api_export_definition_out_list_instance = JsonApiExportDefinitionOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionOutList.to_json()) + +# convert the object into a dict +json_api_export_definition_out_list_dict = json_api_export_definition_out_list_instance.to_dict() +# create an instance of JsonApiExportDefinitionOutList from a dict +json_api_export_definition_out_list_from_dict = JsonApiExportDefinitionOutList.from_dict(json_api_export_definition_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionOutRelationships.md b/gooddata-api-client/docs/JsonApiExportDefinitionOutRelationships.md index 602cbb550..8fbed764d 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionOutRelationships.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboard** | [**JsonApiAutomationInRelationshipsAnalyticalDashboard**](JsonApiAutomationInRelationshipsAnalyticalDashboard.md) | | [optional] @@ -9,8 +10,24 @@ Name | Type | Description | Notes **created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] **modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] **visualization_object** | [**JsonApiExportDefinitionInRelationshipsVisualizationObject**](JsonApiExportDefinitionInRelationshipsVisualizationObject.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_out_relationships import JsonApiExportDefinitionOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionOutRelationships from a JSON string +json_api_export_definition_out_relationships_instance = JsonApiExportDefinitionOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionOutRelationships.to_json()) + +# convert the object into a dict +json_api_export_definition_out_relationships_dict = json_api_export_definition_out_relationships_instance.to_dict() +# create an instance of JsonApiExportDefinitionOutRelationships from a dict +json_api_export_definition_out_relationships_from_dict = JsonApiExportDefinitionOutRelationships.from_dict(json_api_export_definition_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionOutWithLinks.md b/gooddata-api-client/docs/JsonApiExportDefinitionOutWithLinks.md index 7b272f90f..f2e47ebeb 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "exportDefinition" **attributes** | [**JsonApiExportDefinitionOutAttributes**](JsonApiExportDefinitionOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiExportDefinitionOutRelationships**](JsonApiExportDefinitionOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionOutWithLinks from a JSON string +json_api_export_definition_out_with_links_instance = JsonApiExportDefinitionOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionOutWithLinks.to_json()) + +# convert the object into a dict +json_api_export_definition_out_with_links_dict = json_api_export_definition_out_with_links_instance.to_dict() +# create an instance of JsonApiExportDefinitionOutWithLinks from a dict +json_api_export_definition_out_with_links_from_dict = JsonApiExportDefinitionOutWithLinks.from_dict(json_api_export_definition_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionPatch.md b/gooddata-api-client/docs/JsonApiExportDefinitionPatch.md index f7d190da9..c217c2596 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionPatch.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionPatch.md @@ -3,14 +3,31 @@ JSON:API representation of patching exportDefinition entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "exportDefinition" **attributes** | [**JsonApiExportDefinitionInAttributes**](JsonApiExportDefinitionInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiExportDefinitionInRelationships**](JsonApiExportDefinitionInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_patch import JsonApiExportDefinitionPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionPatch from a JSON string +json_api_export_definition_patch_instance = JsonApiExportDefinitionPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionPatch.to_json()) +# convert the object into a dict +json_api_export_definition_patch_dict = json_api_export_definition_patch_instance.to_dict() +# create an instance of JsonApiExportDefinitionPatch from a dict +json_api_export_definition_patch_from_dict = JsonApiExportDefinitionPatch.from_dict(json_api_export_definition_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionPatchDocument.md b/gooddata-api-client/docs/JsonApiExportDefinitionPatchDocument.md index 508d34b1e..29ce12537 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiExportDefinitionPatch**](JsonApiExportDefinitionPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionPatchDocument from a JSON string +json_api_export_definition_patch_document_instance = JsonApiExportDefinitionPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionPatchDocument.to_json()) + +# convert the object into a dict +json_api_export_definition_patch_document_dict = json_api_export_definition_patch_document_instance.to_dict() +# create an instance of JsonApiExportDefinitionPatchDocument from a dict +json_api_export_definition_patch_document_from_dict = JsonApiExportDefinitionPatchDocument.from_dict(json_api_export_definition_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionPostOptionalId.md b/gooddata-api-client/docs/JsonApiExportDefinitionPostOptionalId.md index 8893c3bd3..af4f57b1f 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionPostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionPostOptionalId.md @@ -3,14 +3,31 @@ JSON:API representation of exportDefinition entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | Object type | defaults to "exportDefinition" **attributes** | [**JsonApiExportDefinitionInAttributes**](JsonApiExportDefinitionInAttributes.md) | | [optional] **id** | **str** | API identifier of an object | [optional] **relationships** | [**JsonApiExportDefinitionInRelationships**](JsonApiExportDefinitionInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_post_optional_id import JsonApiExportDefinitionPostOptionalId + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionPostOptionalId from a JSON string +json_api_export_definition_post_optional_id_instance = JsonApiExportDefinitionPostOptionalId.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionPostOptionalId.to_json()) +# convert the object into a dict +json_api_export_definition_post_optional_id_dict = json_api_export_definition_post_optional_id_instance.to_dict() +# create an instance of JsonApiExportDefinitionPostOptionalId from a dict +json_api_export_definition_post_optional_id_from_dict = JsonApiExportDefinitionPostOptionalId.from_dict(json_api_export_definition_post_optional_id_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiExportDefinitionPostOptionalIdDocument.md index bd14b8f55..1fbd2e966 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionPostOptionalIdDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiExportDefinitionPostOptionalId**](JsonApiExportDefinitionPostOptionalId.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportDefinitionPostOptionalIdDocument from a JSON string +json_api_export_definition_post_optional_id_document_instance = JsonApiExportDefinitionPostOptionalIdDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportDefinitionPostOptionalIdDocument.to_json()) + +# convert the object into a dict +json_api_export_definition_post_optional_id_document_dict = json_api_export_definition_post_optional_id_document_instance.to_dict() +# create an instance of JsonApiExportDefinitionPostOptionalIdDocument from a dict +json_api_export_definition_post_optional_id_document_from_dict = JsonApiExportDefinitionPostOptionalIdDocument.from_dict(json_api_export_definition_post_optional_id_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionToManyLinkage.md b/gooddata-api-client/docs/JsonApiExportDefinitionToManyLinkage.md deleted file mode 100644 index bf9974eae..000000000 --- a/gooddata-api-client/docs/JsonApiExportDefinitionToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiExportDefinitionToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiExportDefinitionLinkage]**](JsonApiExportDefinitionLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiExportTemplateIn.md b/gooddata-api-client/docs/JsonApiExportTemplateIn.md index e34ef1ee1..0c734e4cf 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplateIn.md +++ b/gooddata-api-client/docs/JsonApiExportTemplateIn.md @@ -3,13 +3,30 @@ JSON:API representation of exportTemplate entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiExportTemplateInAttributes**](JsonApiExportTemplateInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "exportTemplate" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_export_template_in import JsonApiExportTemplateIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplateIn from a JSON string +json_api_export_template_in_instance = JsonApiExportTemplateIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplateIn.to_json()) +# convert the object into a dict +json_api_export_template_in_dict = json_api_export_template_in_instance.to_dict() +# create an instance of JsonApiExportTemplateIn from a dict +json_api_export_template_in_from_dict = JsonApiExportTemplateIn.from_dict(json_api_export_template_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplateInAttributes.md b/gooddata-api-client/docs/JsonApiExportTemplateInAttributes.md index 636076248..8dcffd1be 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplateInAttributes.md +++ b/gooddata-api-client/docs/JsonApiExportTemplateInAttributes.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | User-facing name of the Slides template. | **dashboard_slides_template** | [**JsonApiExportTemplateInAttributesDashboardSlidesTemplate**](JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md) | | [optional] +**name** | **str** | User-facing name of the Slides template. | **widget_slides_template** | [**JsonApiExportTemplateInAttributesWidgetSlidesTemplate**](JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplateInAttributes from a JSON string +json_api_export_template_in_attributes_instance = JsonApiExportTemplateInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplateInAttributes.to_json()) + +# convert the object into a dict +json_api_export_template_in_attributes_dict = json_api_export_template_in_attributes_instance.to_dict() +# create an instance of JsonApiExportTemplateInAttributes from a dict +json_api_export_template_in_attributes_from_dict = JsonApiExportTemplateInAttributes.from_dict(json_api_export_template_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md b/gooddata-api-client/docs/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md index 3a45ee9b9..98b754bc1 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md +++ b/gooddata-api-client/docs/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md @@ -3,15 +3,32 @@ Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**applied_on** | **[str]** | Export types this template applies to. | +**applied_on** | **List[str]** | Export types this template applies to. | **content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] **cover_slide** | [**CoverSlideTemplate**](CoverSlideTemplate.md) | | [optional] **intro_slide** | [**IntroSlideTemplate**](IntroSlideTemplate.md) | | [optional] **section_slide** | [**SectionSlideTemplate**](SectionSlideTemplate.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_template_in_attributes_dashboard_slides_template import JsonApiExportTemplateInAttributesDashboardSlidesTemplate + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplateInAttributesDashboardSlidesTemplate from a JSON string +json_api_export_template_in_attributes_dashboard_slides_template_instance = JsonApiExportTemplateInAttributesDashboardSlidesTemplate.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplateInAttributesDashboardSlidesTemplate.to_json()) + +# convert the object into a dict +json_api_export_template_in_attributes_dashboard_slides_template_dict = json_api_export_template_in_attributes_dashboard_slides_template_instance.to_dict() +# create an instance of JsonApiExportTemplateInAttributesDashboardSlidesTemplate from a dict +json_api_export_template_in_attributes_dashboard_slides_template_from_dict = JsonApiExportTemplateInAttributesDashboardSlidesTemplate.from_dict(json_api_export_template_in_attributes_dashboard_slides_template_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md b/gooddata-api-client/docs/JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md index 17c03ec4a..dbd352d93 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md +++ b/gooddata-api-client/docs/JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md @@ -3,12 +3,29 @@ Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**applied_on** | **[str]** | Export types this template applies to. | +**applied_on** | **List[str]** | Export types this template applies to. | **content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_template_in_attributes_widget_slides_template import JsonApiExportTemplateInAttributesWidgetSlidesTemplate + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplateInAttributesWidgetSlidesTemplate from a JSON string +json_api_export_template_in_attributes_widget_slides_template_instance = JsonApiExportTemplateInAttributesWidgetSlidesTemplate.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplateInAttributesWidgetSlidesTemplate.to_json()) + +# convert the object into a dict +json_api_export_template_in_attributes_widget_slides_template_dict = json_api_export_template_in_attributes_widget_slides_template_instance.to_dict() +# create an instance of JsonApiExportTemplateInAttributesWidgetSlidesTemplate from a dict +json_api_export_template_in_attributes_widget_slides_template_from_dict = JsonApiExportTemplateInAttributesWidgetSlidesTemplate.from_dict(json_api_export_template_in_attributes_widget_slides_template_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplateInDocument.md b/gooddata-api-client/docs/JsonApiExportTemplateInDocument.md index cbfb968c2..701276ba7 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplateInDocument.md +++ b/gooddata-api-client/docs/JsonApiExportTemplateInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiExportTemplateIn**](JsonApiExportTemplateIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_template_in_document import JsonApiExportTemplateInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplateInDocument from a JSON string +json_api_export_template_in_document_instance = JsonApiExportTemplateInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplateInDocument.to_json()) + +# convert the object into a dict +json_api_export_template_in_document_dict = json_api_export_template_in_document_instance.to_dict() +# create an instance of JsonApiExportTemplateInDocument from a dict +json_api_export_template_in_document_from_dict = JsonApiExportTemplateInDocument.from_dict(json_api_export_template_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplateOut.md b/gooddata-api-client/docs/JsonApiExportTemplateOut.md index 034f2558e..2556d2879 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplateOut.md +++ b/gooddata-api-client/docs/JsonApiExportTemplateOut.md @@ -3,13 +3,30 @@ JSON:API representation of exportTemplate entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiExportTemplateInAttributes**](JsonApiExportTemplateInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "exportTemplate" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_export_template_out import JsonApiExportTemplateOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplateOut from a JSON string +json_api_export_template_out_instance = JsonApiExportTemplateOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplateOut.to_json()) +# convert the object into a dict +json_api_export_template_out_dict = json_api_export_template_out_instance.to_dict() +# create an instance of JsonApiExportTemplateOut from a dict +json_api_export_template_out_from_dict = JsonApiExportTemplateOut.from_dict(json_api_export_template_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplateOutDocument.md b/gooddata-api-client/docs/JsonApiExportTemplateOutDocument.md index 474e4e402..2fc89e4a2 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplateOutDocument.md +++ b/gooddata-api-client/docs/JsonApiExportTemplateOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiExportTemplateOut**](JsonApiExportTemplateOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplateOutDocument from a JSON string +json_api_export_template_out_document_instance = JsonApiExportTemplateOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplateOutDocument.to_json()) + +# convert the object into a dict +json_api_export_template_out_document_dict = json_api_export_template_out_document_instance.to_dict() +# create an instance of JsonApiExportTemplateOutDocument from a dict +json_api_export_template_out_document_from_dict = JsonApiExportTemplateOutDocument.from_dict(json_api_export_template_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplateOutList.md b/gooddata-api-client/docs/JsonApiExportTemplateOutList.md index e557e78b1..36056ca38 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplateOutList.md +++ b/gooddata-api-client/docs/JsonApiExportTemplateOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiExportTemplateOutWithLinks]**](JsonApiExportTemplateOutWithLinks.md) | | +**data** | [**List[JsonApiExportTemplateOutWithLinks]**](JsonApiExportTemplateOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_template_out_list import JsonApiExportTemplateOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplateOutList from a JSON string +json_api_export_template_out_list_instance = JsonApiExportTemplateOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplateOutList.to_json()) + +# convert the object into a dict +json_api_export_template_out_list_dict = json_api_export_template_out_list_instance.to_dict() +# create an instance of JsonApiExportTemplateOutList from a dict +json_api_export_template_out_list_from_dict = JsonApiExportTemplateOutList.from_dict(json_api_export_template_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplateOutWithLinks.md b/gooddata-api-client/docs/JsonApiExportTemplateOutWithLinks.md index 5192d97c5..b6df96215 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplateOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiExportTemplateOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiExportTemplateInAttributes**](JsonApiExportTemplateInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "exportTemplate" +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_template_out_with_links import JsonApiExportTemplateOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplateOutWithLinks from a JSON string +json_api_export_template_out_with_links_instance = JsonApiExportTemplateOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplateOutWithLinks.to_json()) + +# convert the object into a dict +json_api_export_template_out_with_links_dict = json_api_export_template_out_with_links_instance.to_dict() +# create an instance of JsonApiExportTemplateOutWithLinks from a dict +json_api_export_template_out_with_links_from_dict = JsonApiExportTemplateOutWithLinks.from_dict(json_api_export_template_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplatePatch.md b/gooddata-api-client/docs/JsonApiExportTemplatePatch.md index 2c7ac4dd3..1584514ca 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplatePatch.md +++ b/gooddata-api-client/docs/JsonApiExportTemplatePatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching exportTemplate entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiExportTemplatePatchAttributes**](JsonApiExportTemplatePatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "exportTemplate" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_export_template_patch import JsonApiExportTemplatePatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplatePatch from a JSON string +json_api_export_template_patch_instance = JsonApiExportTemplatePatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplatePatch.to_json()) +# convert the object into a dict +json_api_export_template_patch_dict = json_api_export_template_patch_instance.to_dict() +# create an instance of JsonApiExportTemplatePatch from a dict +json_api_export_template_patch_from_dict = JsonApiExportTemplatePatch.from_dict(json_api_export_template_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplatePatchAttributes.md b/gooddata-api-client/docs/JsonApiExportTemplatePatchAttributes.md index c2dc46e4a..31f964055 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplatePatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiExportTemplatePatchAttributes.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dashboard_slides_template** | [**JsonApiExportTemplateInAttributesDashboardSlidesTemplate**](JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md) | | [optional] **name** | **str** | User-facing name of the Slides template. | [optional] **widget_slides_template** | [**JsonApiExportTemplateInAttributesWidgetSlidesTemplate**](JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_template_patch_attributes import JsonApiExportTemplatePatchAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplatePatchAttributes from a JSON string +json_api_export_template_patch_attributes_instance = JsonApiExportTemplatePatchAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplatePatchAttributes.to_json()) + +# convert the object into a dict +json_api_export_template_patch_attributes_dict = json_api_export_template_patch_attributes_instance.to_dict() +# create an instance of JsonApiExportTemplatePatchAttributes from a dict +json_api_export_template_patch_attributes_from_dict = JsonApiExportTemplatePatchAttributes.from_dict(json_api_export_template_patch_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplatePatchDocument.md b/gooddata-api-client/docs/JsonApiExportTemplatePatchDocument.md index d63641e16..ca9f54a5e 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplatePatchDocument.md +++ b/gooddata-api-client/docs/JsonApiExportTemplatePatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiExportTemplatePatch**](JsonApiExportTemplatePatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplatePatchDocument from a JSON string +json_api_export_template_patch_document_instance = JsonApiExportTemplatePatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplatePatchDocument.to_json()) + +# convert the object into a dict +json_api_export_template_patch_document_dict = json_api_export_template_patch_document_instance.to_dict() +# create an instance of JsonApiExportTemplatePatchDocument from a dict +json_api_export_template_patch_document_from_dict = JsonApiExportTemplatePatchDocument.from_dict(json_api_export_template_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalId.md b/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalId.md index 9b083ddbc..5f7c852ec 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalId.md @@ -3,13 +3,30 @@ JSON:API representation of exportTemplate entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiExportTemplateInAttributes**](JsonApiExportTemplateInAttributes.md) | | -**type** | **str** | Object type | defaults to "exportTemplate" **id** | **str** | API identifier of an object | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplatePostOptionalId from a JSON string +json_api_export_template_post_optional_id_instance = JsonApiExportTemplatePostOptionalId.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplatePostOptionalId.to_json()) +# convert the object into a dict +json_api_export_template_post_optional_id_dict = json_api_export_template_post_optional_id_instance.to_dict() +# create an instance of JsonApiExportTemplatePostOptionalId from a dict +json_api_export_template_post_optional_id_from_dict = JsonApiExportTemplatePostOptionalId.from_dict(json_api_export_template_post_optional_id_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalIdDocument.md index bbae07f4c..0c441cf1c 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalIdDocument.md +++ b/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalIdDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiExportTemplatePostOptionalId**](JsonApiExportTemplatePostOptionalId.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiExportTemplatePostOptionalIdDocument from a JSON string +json_api_export_template_post_optional_id_document_instance = JsonApiExportTemplatePostOptionalIdDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiExportTemplatePostOptionalIdDocument.to_json()) + +# convert the object into a dict +json_api_export_template_post_optional_id_document_dict = json_api_export_template_post_optional_id_document_instance.to_dict() +# create an instance of JsonApiExportTemplatePostOptionalIdDocument from a dict +json_api_export_template_post_optional_id_document_from_dict = JsonApiExportTemplatePostOptionalIdDocument.from_dict(json_api_export_template_post_optional_id_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFactLinkage.md b/gooddata-api-client/docs/JsonApiFactLinkage.md index db4e12ec3..f7f2cdc68 100644 --- a/gooddata-api-client/docs/JsonApiFactLinkage.md +++ b/gooddata-api-client/docs/JsonApiFactLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "fact" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_fact_linkage import JsonApiFactLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFactLinkage from a JSON string +json_api_fact_linkage_instance = JsonApiFactLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiFactLinkage.to_json()) +# convert the object into a dict +json_api_fact_linkage_dict = json_api_fact_linkage_instance.to_dict() +# create an instance of JsonApiFactLinkage from a dict +json_api_fact_linkage_from_dict = JsonApiFactLinkage.from_dict(json_api_fact_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFactOut.md b/gooddata-api-client/docs/JsonApiFactOut.md index d2a72e499..05f26b2c1 100644 --- a/gooddata-api-client/docs/JsonApiFactOut.md +++ b/gooddata-api-client/docs/JsonApiFactOut.md @@ -3,15 +3,32 @@ JSON:API representation of fact entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "fact" **attributes** | [**JsonApiFactOutAttributes**](JsonApiFactOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiFactOutRelationships**](JsonApiFactOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_fact_out import JsonApiFactOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFactOut from a JSON string +json_api_fact_out_instance = JsonApiFactOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiFactOut.to_json()) +# convert the object into a dict +json_api_fact_out_dict = json_api_fact_out_instance.to_dict() +# create an instance of JsonApiFactOut from a dict +json_api_fact_out_from_dict = JsonApiFactOut.from_dict(json_api_fact_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFactOutAttributes.md b/gooddata-api-client/docs/JsonApiFactOutAttributes.md index f9832346a..ecc85f2d0 100644 --- a/gooddata-api-client/docs/JsonApiFactOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiFactOutAttributes.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] @@ -9,10 +10,26 @@ Name | Type | Description | Notes **is_hidden** | **bool** | | [optional] **source_column** | **str** | | [optional] **source_column_data_type** | **str** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_fact_out_attributes import JsonApiFactOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFactOutAttributes from a JSON string +json_api_fact_out_attributes_instance = JsonApiFactOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiFactOutAttributes.to_json()) + +# convert the object into a dict +json_api_fact_out_attributes_dict = json_api_fact_out_attributes_instance.to_dict() +# create an instance of JsonApiFactOutAttributes from a dict +json_api_fact_out_attributes_from_dict = JsonApiFactOutAttributes.from_dict(json_api_fact_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFactOutDocument.md b/gooddata-api-client/docs/JsonApiFactOutDocument.md index 72447c2f6..33280af25 100644 --- a/gooddata-api-client/docs/JsonApiFactOutDocument.md +++ b/gooddata-api-client/docs/JsonApiFactOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiFactOut**](JsonApiFactOut.md) | | -**included** | [**[JsonApiDatasetOutWithLinks]**](JsonApiDatasetOutWithLinks.md) | Included resources | [optional] +**included** | [**List[JsonApiDatasetOutWithLinks]**](JsonApiDatasetOutWithLinks.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFactOutDocument from a JSON string +json_api_fact_out_document_instance = JsonApiFactOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiFactOutDocument.to_json()) + +# convert the object into a dict +json_api_fact_out_document_dict = json_api_fact_out_document_instance.to_dict() +# create an instance of JsonApiFactOutDocument from a dict +json_api_fact_out_document_from_dict = JsonApiFactOutDocument.from_dict(json_api_fact_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFactOutList.md b/gooddata-api-client/docs/JsonApiFactOutList.md index 14094b17d..53f8b7c09 100644 --- a/gooddata-api-client/docs/JsonApiFactOutList.md +++ b/gooddata-api-client/docs/JsonApiFactOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiFactOutWithLinks]**](JsonApiFactOutWithLinks.md) | | -**included** | [**[JsonApiDatasetOutWithLinks]**](JsonApiDatasetOutWithLinks.md) | Included resources | [optional] +**data** | [**List[JsonApiFactOutWithLinks]**](JsonApiFactOutWithLinks.md) | | +**included** | [**List[JsonApiDatasetOutWithLinks]**](JsonApiDatasetOutWithLinks.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFactOutList from a JSON string +json_api_fact_out_list_instance = JsonApiFactOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiFactOutList.to_json()) + +# convert the object into a dict +json_api_fact_out_list_dict = json_api_fact_out_list_instance.to_dict() +# create an instance of JsonApiFactOutList from a dict +json_api_fact_out_list_from_dict = JsonApiFactOutList.from_dict(json_api_fact_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFactOutRelationships.md b/gooddata-api-client/docs/JsonApiFactOutRelationships.md index 3eccb0920..90f259d27 100644 --- a/gooddata-api-client/docs/JsonApiFactOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiFactOutRelationships.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dataset** | [**JsonApiAggregatedFactOutRelationshipsDataset**](JsonApiAggregatedFactOutRelationshipsDataset.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_fact_out_relationships import JsonApiFactOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFactOutRelationships from a JSON string +json_api_fact_out_relationships_instance = JsonApiFactOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiFactOutRelationships.to_json()) + +# convert the object into a dict +json_api_fact_out_relationships_dict = json_api_fact_out_relationships_instance.to_dict() +# create an instance of JsonApiFactOutRelationships from a dict +json_api_fact_out_relationships_from_dict = JsonApiFactOutRelationships.from_dict(json_api_fact_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFactOutWithLinks.md b/gooddata-api-client/docs/JsonApiFactOutWithLinks.md index 7d0c00e9b..da3587ff4 100644 --- a/gooddata-api-client/docs/JsonApiFactOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiFactOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "fact" **attributes** | [**JsonApiFactOutAttributes**](JsonApiFactOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiFactOutRelationships**](JsonApiFactOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFactOutWithLinks from a JSON string +json_api_fact_out_with_links_instance = JsonApiFactOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiFactOutWithLinks.to_json()) + +# convert the object into a dict +json_api_fact_out_with_links_dict = json_api_fact_out_with_links_instance.to_dict() +# create an instance of JsonApiFactOutWithLinks from a dict +json_api_fact_out_with_links_from_dict = JsonApiFactOutWithLinks.from_dict(json_api_fact_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFactToManyLinkage.md b/gooddata-api-client/docs/JsonApiFactToManyLinkage.md deleted file mode 100644 index d5b36facb..000000000 --- a/gooddata-api-client/docs/JsonApiFactToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiFactToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiFactLinkage]**](JsonApiFactLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiFactToOneLinkage.md b/gooddata-api-client/docs/JsonApiFactToOneLinkage.md index 7c2dfeb88..28ae21a5b 100644 --- a/gooddata-api-client/docs/JsonApiFactToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiFactToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "fact" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_fact_to_one_linkage import JsonApiFactToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFactToOneLinkage from a JSON string +json_api_fact_to_one_linkage_instance = JsonApiFactToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiFactToOneLinkage.to_json()) +# convert the object into a dict +json_api_fact_to_one_linkage_dict = json_api_fact_to_one_linkage_instance.to_dict() +# create an instance of JsonApiFactToOneLinkage from a dict +json_api_fact_to_one_linkage_from_dict = JsonApiFactToOneLinkage.from_dict(json_api_fact_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextIn.md b/gooddata-api-client/docs/JsonApiFilterContextIn.md index b9f06a684..cbeaeef0d 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextIn.md +++ b/gooddata-api-client/docs/JsonApiFilterContextIn.md @@ -3,13 +3,30 @@ JSON:API representation of filterContext entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAnalyticalDashboardInAttributes**](JsonApiAnalyticalDashboardInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "filterContext" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_in import JsonApiFilterContextIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextIn from a JSON string +json_api_filter_context_in_instance = JsonApiFilterContextIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextIn.to_json()) +# convert the object into a dict +json_api_filter_context_in_dict = json_api_filter_context_in_instance.to_dict() +# create an instance of JsonApiFilterContextIn from a dict +json_api_filter_context_in_from_dict = JsonApiFilterContextIn.from_dict(json_api_filter_context_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextInDocument.md b/gooddata-api-client/docs/JsonApiFilterContextInDocument.md index 27dba1382..00b847b95 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextInDocument.md +++ b/gooddata-api-client/docs/JsonApiFilterContextInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiFilterContextIn**](JsonApiFilterContextIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextInDocument from a JSON string +json_api_filter_context_in_document_instance = JsonApiFilterContextInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextInDocument.to_json()) + +# convert the object into a dict +json_api_filter_context_in_document_dict = json_api_filter_context_in_document_instance.to_dict() +# create an instance of JsonApiFilterContextInDocument from a dict +json_api_filter_context_in_document_from_dict = JsonApiFilterContextInDocument.from_dict(json_api_filter_context_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextLinkage.md b/gooddata-api-client/docs/JsonApiFilterContextLinkage.md index 49adbd48e..f2b2684bb 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextLinkage.md +++ b/gooddata-api-client/docs/JsonApiFilterContextLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "filterContext" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_linkage import JsonApiFilterContextLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextLinkage from a JSON string +json_api_filter_context_linkage_instance = JsonApiFilterContextLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextLinkage.to_json()) +# convert the object into a dict +json_api_filter_context_linkage_dict = json_api_filter_context_linkage_instance.to_dict() +# create an instance of JsonApiFilterContextLinkage from a dict +json_api_filter_context_linkage_from_dict = JsonApiFilterContextLinkage.from_dict(json_api_filter_context_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextOut.md b/gooddata-api-client/docs/JsonApiFilterContextOut.md index 41f126972..5e2408dcc 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextOut.md +++ b/gooddata-api-client/docs/JsonApiFilterContextOut.md @@ -3,15 +3,32 @@ JSON:API representation of filterContext entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAnalyticalDashboardInAttributes**](JsonApiAnalyticalDashboardInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "filterContext" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiFilterContextOutRelationships**](JsonApiFilterContextOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_out import JsonApiFilterContextOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextOut from a JSON string +json_api_filter_context_out_instance = JsonApiFilterContextOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextOut.to_json()) +# convert the object into a dict +json_api_filter_context_out_dict = json_api_filter_context_out_instance.to_dict() +# create an instance of JsonApiFilterContextOut from a dict +json_api_filter_context_out_from_dict = JsonApiFilterContextOut.from_dict(json_api_filter_context_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextOutDocument.md b/gooddata-api-client/docs/JsonApiFilterContextOutDocument.md index f1dbb76cc..3707bc8ad 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextOutDocument.md +++ b/gooddata-api-client/docs/JsonApiFilterContextOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiFilterContextOut**](JsonApiFilterContextOut.md) | | -**included** | [**[JsonApiFilterContextOutIncludes]**](JsonApiFilterContextOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiFilterContextOutIncludes]**](JsonApiFilterContextOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextOutDocument from a JSON string +json_api_filter_context_out_document_instance = JsonApiFilterContextOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextOutDocument.to_json()) + +# convert the object into a dict +json_api_filter_context_out_document_dict = json_api_filter_context_out_document_instance.to_dict() +# create an instance of JsonApiFilterContextOutDocument from a dict +json_api_filter_context_out_document_from_dict = JsonApiFilterContextOutDocument.from_dict(json_api_filter_context_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextOutIncludes.md b/gooddata-api-client/docs/JsonApiFilterContextOutIncludes.md index a88d58f2d..6c397fdb5 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiFilterContextOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiLabelOutAttributes**](JsonApiLabelOutAttributes.md) | | +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiLabelOutRelationships**](JsonApiLabelOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**attributes** | [**JsonApiLabelOutAttributes**](JsonApiLabelOutAttributes.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "label" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextOutIncludes from a JSON string +json_api_filter_context_out_includes_instance = JsonApiFilterContextOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextOutIncludes.to_json()) + +# convert the object into a dict +json_api_filter_context_out_includes_dict = json_api_filter_context_out_includes_instance.to_dict() +# create an instance of JsonApiFilterContextOutIncludes from a dict +json_api_filter_context_out_includes_from_dict = JsonApiFilterContextOutIncludes.from_dict(json_api_filter_context_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextOutList.md b/gooddata-api-client/docs/JsonApiFilterContextOutList.md index a9da77ce1..89f6b6319 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextOutList.md +++ b/gooddata-api-client/docs/JsonApiFilterContextOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiFilterContextOutWithLinks]**](JsonApiFilterContextOutWithLinks.md) | | -**included** | [**[JsonApiFilterContextOutIncludes]**](JsonApiFilterContextOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiFilterContextOutWithLinks]**](JsonApiFilterContextOutWithLinks.md) | | +**included** | [**List[JsonApiFilterContextOutIncludes]**](JsonApiFilterContextOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextOutList from a JSON string +json_api_filter_context_out_list_instance = JsonApiFilterContextOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextOutList.to_json()) + +# convert the object into a dict +json_api_filter_context_out_list_dict = json_api_filter_context_out_list_instance.to_dict() +# create an instance of JsonApiFilterContextOutList from a dict +json_api_filter_context_out_list_from_dict = JsonApiFilterContextOutList.from_dict(json_api_filter_context_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextOutRelationships.md b/gooddata-api-client/docs/JsonApiFilterContextOutRelationships.md index a241f25c2..fa2faaf60 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiFilterContextOutRelationships.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAttributeHierarchyOutRelationshipsAttributes**](JsonApiAttributeHierarchyOutRelationshipsAttributes.md) | | [optional] **datasets** | [**JsonApiAnalyticalDashboardOutRelationshipsDatasets**](JsonApiAnalyticalDashboardOutRelationshipsDatasets.md) | | [optional] **labels** | [**JsonApiAnalyticalDashboardOutRelationshipsLabels**](JsonApiAnalyticalDashboardOutRelationshipsLabels.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_out_relationships import JsonApiFilterContextOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextOutRelationships from a JSON string +json_api_filter_context_out_relationships_instance = JsonApiFilterContextOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextOutRelationships.to_json()) + +# convert the object into a dict +json_api_filter_context_out_relationships_dict = json_api_filter_context_out_relationships_instance.to_dict() +# create an instance of JsonApiFilterContextOutRelationships from a dict +json_api_filter_context_out_relationships_from_dict = JsonApiFilterContextOutRelationships.from_dict(json_api_filter_context_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextOutWithLinks.md b/gooddata-api-client/docs/JsonApiFilterContextOutWithLinks.md index f3caae48e..2e09b95dd 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiFilterContextOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAnalyticalDashboardInAttributes**](JsonApiAnalyticalDashboardInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "filterContext" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiFilterContextOutRelationships**](JsonApiFilterContextOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextOutWithLinks from a JSON string +json_api_filter_context_out_with_links_instance = JsonApiFilterContextOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextOutWithLinks.to_json()) + +# convert the object into a dict +json_api_filter_context_out_with_links_dict = json_api_filter_context_out_with_links_instance.to_dict() +# create an instance of JsonApiFilterContextOutWithLinks from a dict +json_api_filter_context_out_with_links_from_dict = JsonApiFilterContextOutWithLinks.from_dict(json_api_filter_context_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextPatch.md b/gooddata-api-client/docs/JsonApiFilterContextPatch.md index 45f291951..cbc39d721 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextPatch.md +++ b/gooddata-api-client/docs/JsonApiFilterContextPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching filterContext entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAnalyticalDashboardPatchAttributes**](JsonApiAnalyticalDashboardPatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "filterContext" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_patch import JsonApiFilterContextPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextPatch from a JSON string +json_api_filter_context_patch_instance = JsonApiFilterContextPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextPatch.to_json()) +# convert the object into a dict +json_api_filter_context_patch_dict = json_api_filter_context_patch_instance.to_dict() +# create an instance of JsonApiFilterContextPatch from a dict +json_api_filter_context_patch_from_dict = JsonApiFilterContextPatch.from_dict(json_api_filter_context_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextPatchDocument.md b/gooddata-api-client/docs/JsonApiFilterContextPatchDocument.md index 8509ddaf8..918b6c23c 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiFilterContextPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiFilterContextPatch**](JsonApiFilterContextPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextPatchDocument from a JSON string +json_api_filter_context_patch_document_instance = JsonApiFilterContextPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextPatchDocument.to_json()) + +# convert the object into a dict +json_api_filter_context_patch_document_dict = json_api_filter_context_patch_document_instance.to_dict() +# create an instance of JsonApiFilterContextPatchDocument from a dict +json_api_filter_context_patch_document_from_dict = JsonApiFilterContextPatchDocument.from_dict(json_api_filter_context_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextPostOptionalId.md b/gooddata-api-client/docs/JsonApiFilterContextPostOptionalId.md index 5b1b720ef..b8d6c88e3 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextPostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiFilterContextPostOptionalId.md @@ -3,13 +3,30 @@ JSON:API representation of filterContext entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAnalyticalDashboardInAttributes**](JsonApiAnalyticalDashboardInAttributes.md) | | -**type** | **str** | Object type | defaults to "filterContext" **id** | **str** | API identifier of an object | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_post_optional_id import JsonApiFilterContextPostOptionalId + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextPostOptionalId from a JSON string +json_api_filter_context_post_optional_id_instance = JsonApiFilterContextPostOptionalId.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextPostOptionalId.to_json()) +# convert the object into a dict +json_api_filter_context_post_optional_id_dict = json_api_filter_context_post_optional_id_instance.to_dict() +# create an instance of JsonApiFilterContextPostOptionalId from a dict +json_api_filter_context_post_optional_id_from_dict = JsonApiFilterContextPostOptionalId.from_dict(json_api_filter_context_post_optional_id_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiFilterContextPostOptionalIdDocument.md index c8874b7d2..4e6dc9396 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/JsonApiFilterContextPostOptionalIdDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiFilterContextPostOptionalId**](JsonApiFilterContextPostOptionalId.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterContextPostOptionalIdDocument from a JSON string +json_api_filter_context_post_optional_id_document_instance = JsonApiFilterContextPostOptionalIdDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterContextPostOptionalIdDocument.to_json()) + +# convert the object into a dict +json_api_filter_context_post_optional_id_document_dict = json_api_filter_context_post_optional_id_document_instance.to_dict() +# create an instance of JsonApiFilterContextPostOptionalIdDocument from a dict +json_api_filter_context_post_optional_id_document_from_dict = JsonApiFilterContextPostOptionalIdDocument.from_dict(json_api_filter_context_post_optional_id_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextToManyLinkage.md b/gooddata-api-client/docs/JsonApiFilterContextToManyLinkage.md deleted file mode 100644 index b2712baa1..000000000 --- a/gooddata-api-client/docs/JsonApiFilterContextToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiFilterContextToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiFilterContextLinkage]**](JsonApiFilterContextLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiFilterViewIn.md b/gooddata-api-client/docs/JsonApiFilterViewIn.md index b9faee61a..2bc07896a 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewIn.md +++ b/gooddata-api-client/docs/JsonApiFilterViewIn.md @@ -3,14 +3,31 @@ JSON:API representation of filterView entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiFilterViewInAttributes**](JsonApiFilterViewInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "filterView" **relationships** | [**JsonApiFilterViewInRelationships**](JsonApiFilterViewInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_in import JsonApiFilterViewIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewIn from a JSON string +json_api_filter_view_in_instance = JsonApiFilterViewIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewIn.to_json()) +# convert the object into a dict +json_api_filter_view_in_dict = json_api_filter_view_in_instance.to_dict() +# create an instance of JsonApiFilterViewIn from a dict +json_api_filter_view_in_from_dict = JsonApiFilterViewIn.from_dict(json_api_filter_view_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewInAttributes.md b/gooddata-api-client/docs/JsonApiFilterViewInAttributes.md index 80cbfe69e..676145b59 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewInAttributes.md +++ b/gooddata-api-client/docs/JsonApiFilterViewInAttributes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | The respective filter context. | -**title** | **str** | | **are_relations_valid** | **bool** | | [optional] +**content** | **object** | The respective filter context. | **description** | **str** | | [optional] **is_default** | **bool** | Indicator whether the filter view should by applied by default. | [optional] -**tags** | **[str]** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**tags** | **List[str]** | | [optional] +**title** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewInAttributes from a JSON string +json_api_filter_view_in_attributes_instance = JsonApiFilterViewInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewInAttributes.to_json()) +# convert the object into a dict +json_api_filter_view_in_attributes_dict = json_api_filter_view_in_attributes_instance.to_dict() +# create an instance of JsonApiFilterViewInAttributes from a dict +json_api_filter_view_in_attributes_from_dict = JsonApiFilterViewInAttributes.from_dict(json_api_filter_view_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewInDocument.md b/gooddata-api-client/docs/JsonApiFilterViewInDocument.md index 2abbd2c0c..3b125117e 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewInDocument.md +++ b/gooddata-api-client/docs/JsonApiFilterViewInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiFilterViewIn**](JsonApiFilterViewIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewInDocument from a JSON string +json_api_filter_view_in_document_instance = JsonApiFilterViewInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewInDocument.to_json()) + +# convert the object into a dict +json_api_filter_view_in_document_dict = json_api_filter_view_in_document_instance.to_dict() +# create an instance of JsonApiFilterViewInDocument from a dict +json_api_filter_view_in_document_from_dict = JsonApiFilterViewInDocument.from_dict(json_api_filter_view_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewInRelationships.md b/gooddata-api-client/docs/JsonApiFilterViewInRelationships.md index 564c72722..6e2d1a9f2 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewInRelationships.md +++ b/gooddata-api-client/docs/JsonApiFilterViewInRelationships.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboard** | [**JsonApiAutomationInRelationshipsAnalyticalDashboard**](JsonApiAutomationInRelationshipsAnalyticalDashboard.md) | | [optional] **user** | [**JsonApiFilterViewInRelationshipsUser**](JsonApiFilterViewInRelationshipsUser.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewInRelationships from a JSON string +json_api_filter_view_in_relationships_instance = JsonApiFilterViewInRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewInRelationships.to_json()) + +# convert the object into a dict +json_api_filter_view_in_relationships_dict = json_api_filter_view_in_relationships_instance.to_dict() +# create an instance of JsonApiFilterViewInRelationships from a dict +json_api_filter_view_in_relationships_from_dict = JsonApiFilterViewInRelationships.from_dict(json_api_filter_view_in_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewInRelationshipsUser.md b/gooddata-api-client/docs/JsonApiFilterViewInRelationshipsUser.md index 8857b492e..d3e1e1b4e 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewInRelationshipsUser.md +++ b/gooddata-api-client/docs/JsonApiFilterViewInRelationshipsUser.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserToOneLinkage**](JsonApiUserToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewInRelationshipsUser from a JSON string +json_api_filter_view_in_relationships_user_instance = JsonApiFilterViewInRelationshipsUser.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewInRelationshipsUser.to_json()) + +# convert the object into a dict +json_api_filter_view_in_relationships_user_dict = json_api_filter_view_in_relationships_user_instance.to_dict() +# create an instance of JsonApiFilterViewInRelationshipsUser from a dict +json_api_filter_view_in_relationships_user_from_dict = JsonApiFilterViewInRelationshipsUser.from_dict(json_api_filter_view_in_relationships_user_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewOut.md b/gooddata-api-client/docs/JsonApiFilterViewOut.md index 83f887096..32f3c90ec 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewOut.md +++ b/gooddata-api-client/docs/JsonApiFilterViewOut.md @@ -3,14 +3,31 @@ JSON:API representation of filterView entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiFilterViewInAttributes**](JsonApiFilterViewInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "filterView" **relationships** | [**JsonApiFilterViewInRelationships**](JsonApiFilterViewInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_out import JsonApiFilterViewOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewOut from a JSON string +json_api_filter_view_out_instance = JsonApiFilterViewOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewOut.to_json()) +# convert the object into a dict +json_api_filter_view_out_dict = json_api_filter_view_out_instance.to_dict() +# create an instance of JsonApiFilterViewOut from a dict +json_api_filter_view_out_from_dict = JsonApiFilterViewOut.from_dict(json_api_filter_view_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewOutDocument.md b/gooddata-api-client/docs/JsonApiFilterViewOutDocument.md index db60b2251..828d4bc15 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewOutDocument.md +++ b/gooddata-api-client/docs/JsonApiFilterViewOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiFilterViewOut**](JsonApiFilterViewOut.md) | | -**included** | [**[JsonApiFilterViewOutIncludes]**](JsonApiFilterViewOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiFilterViewOutIncludes]**](JsonApiFilterViewOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewOutDocument from a JSON string +json_api_filter_view_out_document_instance = JsonApiFilterViewOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewOutDocument.to_json()) + +# convert the object into a dict +json_api_filter_view_out_document_dict = json_api_filter_view_out_document_instance.to_dict() +# create an instance of JsonApiFilterViewOutDocument from a dict +json_api_filter_view_out_document_from_dict = JsonApiFilterViewOutDocument.from_dict(json_api_filter_view_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewOutIncludes.md b/gooddata-api-client/docs/JsonApiFilterViewOutIncludes.md index dfdfbee9a..5bbf5347a 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiFilterViewOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiUserInAttributes**](JsonApiUserInAttributes.md) | | +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAnalyticalDashboardOutMeta**](JsonApiAnalyticalDashboardOutMeta.md) | | [optional] **relationships** | [**JsonApiUserInRelationships**](JsonApiUserInRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**attributes** | [**JsonApiUserInAttributes**](JsonApiUserInAttributes.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "user" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_out_includes import JsonApiFilterViewOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewOutIncludes from a JSON string +json_api_filter_view_out_includes_instance = JsonApiFilterViewOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewOutIncludes.to_json()) + +# convert the object into a dict +json_api_filter_view_out_includes_dict = json_api_filter_view_out_includes_instance.to_dict() +# create an instance of JsonApiFilterViewOutIncludes from a dict +json_api_filter_view_out_includes_from_dict = JsonApiFilterViewOutIncludes.from_dict(json_api_filter_view_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewOutList.md b/gooddata-api-client/docs/JsonApiFilterViewOutList.md index ab5714400..89dc95fc4 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewOutList.md +++ b/gooddata-api-client/docs/JsonApiFilterViewOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiFilterViewOutWithLinks]**](JsonApiFilterViewOutWithLinks.md) | | -**included** | [**[JsonApiFilterViewOutIncludes]**](JsonApiFilterViewOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiFilterViewOutWithLinks]**](JsonApiFilterViewOutWithLinks.md) | | +**included** | [**List[JsonApiFilterViewOutIncludes]**](JsonApiFilterViewOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_out_list import JsonApiFilterViewOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewOutList from a JSON string +json_api_filter_view_out_list_instance = JsonApiFilterViewOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewOutList.to_json()) + +# convert the object into a dict +json_api_filter_view_out_list_dict = json_api_filter_view_out_list_instance.to_dict() +# create an instance of JsonApiFilterViewOutList from a dict +json_api_filter_view_out_list_from_dict = JsonApiFilterViewOutList.from_dict(json_api_filter_view_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewOutWithLinks.md b/gooddata-api-client/docs/JsonApiFilterViewOutWithLinks.md index c95ee780f..2d36aa157 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiFilterViewOutWithLinks.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiFilterViewInAttributes**](JsonApiFilterViewInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "filterView" **relationships** | [**JsonApiFilterViewInRelationships**](JsonApiFilterViewInRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_out_with_links import JsonApiFilterViewOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewOutWithLinks from a JSON string +json_api_filter_view_out_with_links_instance = JsonApiFilterViewOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewOutWithLinks.to_json()) + +# convert the object into a dict +json_api_filter_view_out_with_links_dict = json_api_filter_view_out_with_links_instance.to_dict() +# create an instance of JsonApiFilterViewOutWithLinks from a dict +json_api_filter_view_out_with_links_from_dict = JsonApiFilterViewOutWithLinks.from_dict(json_api_filter_view_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewPatch.md b/gooddata-api-client/docs/JsonApiFilterViewPatch.md index ba121fa3d..01aa65cbc 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewPatch.md +++ b/gooddata-api-client/docs/JsonApiFilterViewPatch.md @@ -3,14 +3,31 @@ JSON:API representation of patching filterView entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiFilterViewPatchAttributes**](JsonApiFilterViewPatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "filterView" **relationships** | [**JsonApiFilterViewInRelationships**](JsonApiFilterViewInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_patch import JsonApiFilterViewPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewPatch from a JSON string +json_api_filter_view_patch_instance = JsonApiFilterViewPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewPatch.to_json()) +# convert the object into a dict +json_api_filter_view_patch_dict = json_api_filter_view_patch_instance.to_dict() +# create an instance of JsonApiFilterViewPatch from a dict +json_api_filter_view_patch_from_dict = JsonApiFilterViewPatch.from_dict(json_api_filter_view_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewPatchAttributes.md b/gooddata-api-client/docs/JsonApiFilterViewPatchAttributes.md index 017769086..36fd64218 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewPatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiFilterViewPatchAttributes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | The respective filter context. | [optional] +**content** | **object** | The respective filter context. | [optional] **description** | **str** | | [optional] **is_default** | **bool** | Indicator whether the filter view should by applied by default. | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_patch_attributes import JsonApiFilterViewPatchAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewPatchAttributes from a JSON string +json_api_filter_view_patch_attributes_instance = JsonApiFilterViewPatchAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewPatchAttributes.to_json()) + +# convert the object into a dict +json_api_filter_view_patch_attributes_dict = json_api_filter_view_patch_attributes_instance.to_dict() +# create an instance of JsonApiFilterViewPatchAttributes from a dict +json_api_filter_view_patch_attributes_from_dict = JsonApiFilterViewPatchAttributes.from_dict(json_api_filter_view_patch_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterViewPatchDocument.md b/gooddata-api-client/docs/JsonApiFilterViewPatchDocument.md index 671830268..e425351aa 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiFilterViewPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiFilterViewPatch**](JsonApiFilterViewPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiFilterViewPatchDocument from a JSON string +json_api_filter_view_patch_document_instance = JsonApiFilterViewPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiFilterViewPatchDocument.to_json()) + +# convert the object into a dict +json_api_filter_view_patch_document_dict = json_api_filter_view_patch_document_instance.to_dict() +# create an instance of JsonApiFilterViewPatchDocument from a dict +json_api_filter_view_patch_document_from_dict = JsonApiFilterViewPatchDocument.from_dict(json_api_filter_view_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderIn.md b/gooddata-api-client/docs/JsonApiIdentityProviderIn.md index 93a68e92c..d8a9ea3ac 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderIn.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderIn.md @@ -3,13 +3,30 @@ JSON:API representation of identityProvider entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "identityProvider" **attributes** | [**JsonApiIdentityProviderInAttributes**](JsonApiIdentityProviderInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_in import JsonApiIdentityProviderIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderIn from a JSON string +json_api_identity_provider_in_instance = JsonApiIdentityProviderIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderIn.to_json()) +# convert the object into a dict +json_api_identity_provider_in_dict = json_api_identity_provider_in_instance.to_dict() +# create an instance of JsonApiIdentityProviderIn from a dict +json_api_identity_provider_in_from_dict = JsonApiIdentityProviderIn.from_dict(json_api_identity_provider_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderInAttributes.md b/gooddata-api-client/docs/JsonApiIdentityProviderInAttributes.md index 690c0ad54..53d9246ae 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderInAttributes.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderInAttributes.md @@ -2,21 +2,38 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**custom_claim_mapping** | **{str: (str,)}** | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | [optional] -**identifiers** | **[str]** | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | [optional] +**custom_claim_mapping** | **Dict[str, str]** | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | [optional] +**identifiers** | **List[str]** | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | [optional] **idp_type** | **str** | Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise. | [optional] **oauth_client_id** | **str** | The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] **oauth_client_secret** | **str** | The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] -**oauth_custom_auth_attributes** | **{str: (str,)}** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] -**oauth_custom_scopes** | **[str], none_type** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] +**oauth_custom_auth_attributes** | **Dict[str, str]** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] +**oauth_custom_scopes** | **List[str]** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] **oauth_issuer_id** | **str** | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] **oauth_issuer_location** | **str** | The location of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] **saml_metadata** | **str** | Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderInAttributes from a JSON string +json_api_identity_provider_in_attributes_instance = JsonApiIdentityProviderInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderInAttributes.to_json()) + +# convert the object into a dict +json_api_identity_provider_in_attributes_dict = json_api_identity_provider_in_attributes_instance.to_dict() +# create an instance of JsonApiIdentityProviderInAttributes from a dict +json_api_identity_provider_in_attributes_from_dict = JsonApiIdentityProviderInAttributes.from_dict(json_api_identity_provider_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderInDocument.md b/gooddata-api-client/docs/JsonApiIdentityProviderInDocument.md index 98a3633d8..3cb3d0886 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderInDocument.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiIdentityProviderIn**](JsonApiIdentityProviderIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderInDocument from a JSON string +json_api_identity_provider_in_document_instance = JsonApiIdentityProviderInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderInDocument.to_json()) + +# convert the object into a dict +json_api_identity_provider_in_document_dict = json_api_identity_provider_in_document_instance.to_dict() +# create an instance of JsonApiIdentityProviderInDocument from a dict +json_api_identity_provider_in_document_from_dict = JsonApiIdentityProviderInDocument.from_dict(json_api_identity_provider_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderLinkage.md b/gooddata-api-client/docs/JsonApiIdentityProviderLinkage.md index 84f44d4c2..acf3115ea 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderLinkage.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "identityProvider" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_linkage import JsonApiIdentityProviderLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderLinkage from a JSON string +json_api_identity_provider_linkage_instance = JsonApiIdentityProviderLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderLinkage.to_json()) +# convert the object into a dict +json_api_identity_provider_linkage_dict = json_api_identity_provider_linkage_instance.to_dict() +# create an instance of JsonApiIdentityProviderLinkage from a dict +json_api_identity_provider_linkage_from_dict = JsonApiIdentityProviderLinkage.from_dict(json_api_identity_provider_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderOut.md b/gooddata-api-client/docs/JsonApiIdentityProviderOut.md index f473f8b7a..c737f6cf4 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderOut.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderOut.md @@ -3,13 +3,30 @@ JSON:API representation of identityProvider entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "identityProvider" **attributes** | [**JsonApiIdentityProviderOutAttributes**](JsonApiIdentityProviderOutAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_out import JsonApiIdentityProviderOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderOut from a JSON string +json_api_identity_provider_out_instance = JsonApiIdentityProviderOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderOut.to_json()) +# convert the object into a dict +json_api_identity_provider_out_dict = json_api_identity_provider_out_instance.to_dict() +# create an instance of JsonApiIdentityProviderOut from a dict +json_api_identity_provider_out_from_dict = JsonApiIdentityProviderOut.from_dict(json_api_identity_provider_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderOutAttributes.md b/gooddata-api-client/docs/JsonApiIdentityProviderOutAttributes.md index b4a3c1d72..76ffa610c 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderOutAttributes.md @@ -2,19 +2,36 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**custom_claim_mapping** | **{str: (str,)}** | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | [optional] -**identifiers** | **[str]** | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | [optional] +**custom_claim_mapping** | **Dict[str, str]** | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | [optional] +**identifiers** | **List[str]** | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | [optional] **idp_type** | **str** | Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise. | [optional] **oauth_client_id** | **str** | The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] -**oauth_custom_auth_attributes** | **{str: (str,)}** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] -**oauth_custom_scopes** | **[str], none_type** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] +**oauth_custom_auth_attributes** | **Dict[str, str]** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] +**oauth_custom_scopes** | **List[str]** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] **oauth_issuer_id** | **str** | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] **oauth_issuer_location** | **str** | The location of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_out_attributes import JsonApiIdentityProviderOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderOutAttributes from a JSON string +json_api_identity_provider_out_attributes_instance = JsonApiIdentityProviderOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderOutAttributes.to_json()) + +# convert the object into a dict +json_api_identity_provider_out_attributes_dict = json_api_identity_provider_out_attributes_instance.to_dict() +# create an instance of JsonApiIdentityProviderOutAttributes from a dict +json_api_identity_provider_out_attributes_from_dict = JsonApiIdentityProviderOutAttributes.from_dict(json_api_identity_provider_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderOutDocument.md b/gooddata-api-client/docs/JsonApiIdentityProviderOutDocument.md index 2fe176211..891045632 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderOutDocument.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiIdentityProviderOut**](JsonApiIdentityProviderOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderOutDocument from a JSON string +json_api_identity_provider_out_document_instance = JsonApiIdentityProviderOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderOutDocument.to_json()) + +# convert the object into a dict +json_api_identity_provider_out_document_dict = json_api_identity_provider_out_document_instance.to_dict() +# create an instance of JsonApiIdentityProviderOutDocument from a dict +json_api_identity_provider_out_document_from_dict = JsonApiIdentityProviderOutDocument.from_dict(json_api_identity_provider_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderOutList.md b/gooddata-api-client/docs/JsonApiIdentityProviderOutList.md index 885c9e625..ec7be556b 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderOutList.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiIdentityProviderOutWithLinks]**](JsonApiIdentityProviderOutWithLinks.md) | | +**data** | [**List[JsonApiIdentityProviderOutWithLinks]**](JsonApiIdentityProviderOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderOutList from a JSON string +json_api_identity_provider_out_list_instance = JsonApiIdentityProviderOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderOutList.to_json()) + +# convert the object into a dict +json_api_identity_provider_out_list_dict = json_api_identity_provider_out_list_instance.to_dict() +# create an instance of JsonApiIdentityProviderOutList from a dict +json_api_identity_provider_out_list_from_dict = JsonApiIdentityProviderOutList.from_dict(json_api_identity_provider_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderOutWithLinks.md b/gooddata-api-client/docs/JsonApiIdentityProviderOutWithLinks.md index 8b0d1468c..9d6c79b18 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "identityProvider" **attributes** | [**JsonApiIdentityProviderOutAttributes**](JsonApiIdentityProviderOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_out_with_links import JsonApiIdentityProviderOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderOutWithLinks from a JSON string +json_api_identity_provider_out_with_links_instance = JsonApiIdentityProviderOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderOutWithLinks.to_json()) + +# convert the object into a dict +json_api_identity_provider_out_with_links_dict = json_api_identity_provider_out_with_links_instance.to_dict() +# create an instance of JsonApiIdentityProviderOutWithLinks from a dict +json_api_identity_provider_out_with_links_from_dict = JsonApiIdentityProviderOutWithLinks.from_dict(json_api_identity_provider_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderPatch.md b/gooddata-api-client/docs/JsonApiIdentityProviderPatch.md index eb78ac3da..d102fd8b7 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderPatch.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching identityProvider entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "identityProvider" **attributes** | [**JsonApiIdentityProviderInAttributes**](JsonApiIdentityProviderInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_patch import JsonApiIdentityProviderPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderPatch from a JSON string +json_api_identity_provider_patch_instance = JsonApiIdentityProviderPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderPatch.to_json()) +# convert the object into a dict +json_api_identity_provider_patch_dict = json_api_identity_provider_patch_instance.to_dict() +# create an instance of JsonApiIdentityProviderPatch from a dict +json_api_identity_provider_patch_from_dict = JsonApiIdentityProviderPatch.from_dict(json_api_identity_provider_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderPatchDocument.md b/gooddata-api-client/docs/JsonApiIdentityProviderPatchDocument.md index 4810ecc80..313aa1ba2 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiIdentityProviderPatch**](JsonApiIdentityProviderPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderPatchDocument from a JSON string +json_api_identity_provider_patch_document_instance = JsonApiIdentityProviderPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderPatchDocument.to_json()) + +# convert the object into a dict +json_api_identity_provider_patch_document_dict = json_api_identity_provider_patch_document_instance.to_dict() +# create an instance of JsonApiIdentityProviderPatchDocument from a dict +json_api_identity_provider_patch_document_from_dict = JsonApiIdentityProviderPatchDocument.from_dict(json_api_identity_provider_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiIdentityProviderToOneLinkage.md b/gooddata-api-client/docs/JsonApiIdentityProviderToOneLinkage.md index 6ac6346ab..ae4d2fabd 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "identityProvider" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_identity_provider_to_one_linkage import JsonApiIdentityProviderToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiIdentityProviderToOneLinkage from a JSON string +json_api_identity_provider_to_one_linkage_instance = JsonApiIdentityProviderToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiIdentityProviderToOneLinkage.to_json()) +# convert the object into a dict +json_api_identity_provider_to_one_linkage_dict = json_api_identity_provider_to_one_linkage_instance.to_dict() +# create an instance of JsonApiIdentityProviderToOneLinkage from a dict +json_api_identity_provider_to_one_linkage_from_dict = JsonApiIdentityProviderToOneLinkage.from_dict(json_api_identity_provider_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiJwkIn.md b/gooddata-api-client/docs/JsonApiJwkIn.md index 5e32f1cb2..ad0b993c0 100644 --- a/gooddata-api-client/docs/JsonApiJwkIn.md +++ b/gooddata-api-client/docs/JsonApiJwkIn.md @@ -3,13 +3,30 @@ JSON:API representation of jwk entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "jwk" **attributes** | [**JsonApiJwkInAttributes**](JsonApiJwkInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_jwk_in import JsonApiJwkIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiJwkIn from a JSON string +json_api_jwk_in_instance = JsonApiJwkIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiJwkIn.to_json()) +# convert the object into a dict +json_api_jwk_in_dict = json_api_jwk_in_instance.to_dict() +# create an instance of JsonApiJwkIn from a dict +json_api_jwk_in_from_dict = JsonApiJwkIn.from_dict(json_api_jwk_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiJwkInAttributes.md b/gooddata-api-client/docs/JsonApiJwkInAttributes.md index 994f881df..bbaf66aad 100644 --- a/gooddata-api-client/docs/JsonApiJwkInAttributes.md +++ b/gooddata-api-client/docs/JsonApiJwkInAttributes.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | [**JsonApiJwkInAttributesContent**](JsonApiJwkInAttributesContent.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_jwk_in_attributes import JsonApiJwkInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiJwkInAttributes from a JSON string +json_api_jwk_in_attributes_instance = JsonApiJwkInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiJwkInAttributes.to_json()) + +# convert the object into a dict +json_api_jwk_in_attributes_dict = json_api_jwk_in_attributes_instance.to_dict() +# create an instance of JsonApiJwkInAttributes from a dict +json_api_jwk_in_attributes_from_dict = JsonApiJwkInAttributes.from_dict(json_api_jwk_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiJwkInAttributesContent.md b/gooddata-api-client/docs/JsonApiJwkInAttributesContent.md index 1709ebb5c..ee1210506 100644 --- a/gooddata-api-client/docs/JsonApiJwkInAttributesContent.md +++ b/gooddata-api-client/docs/JsonApiJwkInAttributesContent.md @@ -3,18 +3,35 @@ Specification of the cryptographic key ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**x5c** | **[str]** | | [optional] +**alg** | **str** | | +**e** | **str** | | +**kid** | **str** | | +**kty** | **str** | | +**n** | **str** | | +**use** | **str** | | +**x5c** | **List[str]** | | [optional] **x5t** | **str** | | [optional] -**alg** | **str** | | [optional] -**e** | **str** | | [optional] -**kid** | **str** | | [optional] -**kty** | **str** | | [optional] if omitted the server will use the default value of "RSA" -**n** | **str** | | [optional] -**use** | **str** | | [optional] if omitted the server will use the default value of "sig" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_jwk_in_attributes_content import JsonApiJwkInAttributesContent + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiJwkInAttributesContent from a JSON string +json_api_jwk_in_attributes_content_instance = JsonApiJwkInAttributesContent.from_json(json) +# print the JSON string representation of the object +print(JsonApiJwkInAttributesContent.to_json()) + +# convert the object into a dict +json_api_jwk_in_attributes_content_dict = json_api_jwk_in_attributes_content_instance.to_dict() +# create an instance of JsonApiJwkInAttributesContent from a dict +json_api_jwk_in_attributes_content_from_dict = JsonApiJwkInAttributesContent.from_dict(json_api_jwk_in_attributes_content_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiJwkInDocument.md b/gooddata-api-client/docs/JsonApiJwkInDocument.md index 1d36df7a7..451568590 100644 --- a/gooddata-api-client/docs/JsonApiJwkInDocument.md +++ b/gooddata-api-client/docs/JsonApiJwkInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiJwkIn**](JsonApiJwkIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiJwkInDocument from a JSON string +json_api_jwk_in_document_instance = JsonApiJwkInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiJwkInDocument.to_json()) + +# convert the object into a dict +json_api_jwk_in_document_dict = json_api_jwk_in_document_instance.to_dict() +# create an instance of JsonApiJwkInDocument from a dict +json_api_jwk_in_document_from_dict = JsonApiJwkInDocument.from_dict(json_api_jwk_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiJwkOut.md b/gooddata-api-client/docs/JsonApiJwkOut.md index e78d328df..978405421 100644 --- a/gooddata-api-client/docs/JsonApiJwkOut.md +++ b/gooddata-api-client/docs/JsonApiJwkOut.md @@ -3,13 +3,30 @@ JSON:API representation of jwk entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "jwk" **attributes** | [**JsonApiJwkInAttributes**](JsonApiJwkInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_jwk_out import JsonApiJwkOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiJwkOut from a JSON string +json_api_jwk_out_instance = JsonApiJwkOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiJwkOut.to_json()) +# convert the object into a dict +json_api_jwk_out_dict = json_api_jwk_out_instance.to_dict() +# create an instance of JsonApiJwkOut from a dict +json_api_jwk_out_from_dict = JsonApiJwkOut.from_dict(json_api_jwk_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiJwkOutDocument.md b/gooddata-api-client/docs/JsonApiJwkOutDocument.md index 869054fc3..842d46118 100644 --- a/gooddata-api-client/docs/JsonApiJwkOutDocument.md +++ b/gooddata-api-client/docs/JsonApiJwkOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiJwkOut**](JsonApiJwkOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiJwkOutDocument from a JSON string +json_api_jwk_out_document_instance = JsonApiJwkOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiJwkOutDocument.to_json()) + +# convert the object into a dict +json_api_jwk_out_document_dict = json_api_jwk_out_document_instance.to_dict() +# create an instance of JsonApiJwkOutDocument from a dict +json_api_jwk_out_document_from_dict = JsonApiJwkOutDocument.from_dict(json_api_jwk_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiJwkOutList.md b/gooddata-api-client/docs/JsonApiJwkOutList.md index 0a1887356..5a3841c9d 100644 --- a/gooddata-api-client/docs/JsonApiJwkOutList.md +++ b/gooddata-api-client/docs/JsonApiJwkOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiJwkOutWithLinks]**](JsonApiJwkOutWithLinks.md) | | +**data** | [**List[JsonApiJwkOutWithLinks]**](JsonApiJwkOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_jwk_out_list import JsonApiJwkOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiJwkOutList from a JSON string +json_api_jwk_out_list_instance = JsonApiJwkOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiJwkOutList.to_json()) + +# convert the object into a dict +json_api_jwk_out_list_dict = json_api_jwk_out_list_instance.to_dict() +# create an instance of JsonApiJwkOutList from a dict +json_api_jwk_out_list_from_dict = JsonApiJwkOutList.from_dict(json_api_jwk_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiJwkOutWithLinks.md b/gooddata-api-client/docs/JsonApiJwkOutWithLinks.md index 96c71d0e0..cd654eda3 100644 --- a/gooddata-api-client/docs/JsonApiJwkOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiJwkOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "jwk" **attributes** | [**JsonApiJwkInAttributes**](JsonApiJwkInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_jwk_out_with_links import JsonApiJwkOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiJwkOutWithLinks from a JSON string +json_api_jwk_out_with_links_instance = JsonApiJwkOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiJwkOutWithLinks.to_json()) + +# convert the object into a dict +json_api_jwk_out_with_links_dict = json_api_jwk_out_with_links_instance.to_dict() +# create an instance of JsonApiJwkOutWithLinks from a dict +json_api_jwk_out_with_links_from_dict = JsonApiJwkOutWithLinks.from_dict(json_api_jwk_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiJwkPatch.md b/gooddata-api-client/docs/JsonApiJwkPatch.md index 739784338..9bf203616 100644 --- a/gooddata-api-client/docs/JsonApiJwkPatch.md +++ b/gooddata-api-client/docs/JsonApiJwkPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching jwk entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "jwk" **attributes** | [**JsonApiJwkInAttributes**](JsonApiJwkInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_jwk_patch import JsonApiJwkPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiJwkPatch from a JSON string +json_api_jwk_patch_instance = JsonApiJwkPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiJwkPatch.to_json()) +# convert the object into a dict +json_api_jwk_patch_dict = json_api_jwk_patch_instance.to_dict() +# create an instance of JsonApiJwkPatch from a dict +json_api_jwk_patch_from_dict = JsonApiJwkPatch.from_dict(json_api_jwk_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiJwkPatchDocument.md b/gooddata-api-client/docs/JsonApiJwkPatchDocument.md index 855391feb..fe8c5a771 100644 --- a/gooddata-api-client/docs/JsonApiJwkPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiJwkPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiJwkPatch**](JsonApiJwkPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_jwk_patch_document import JsonApiJwkPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiJwkPatchDocument from a JSON string +json_api_jwk_patch_document_instance = JsonApiJwkPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiJwkPatchDocument.to_json()) + +# convert the object into a dict +json_api_jwk_patch_document_dict = json_api_jwk_patch_document_instance.to_dict() +# create an instance of JsonApiJwkPatchDocument from a dict +json_api_jwk_patch_document_from_dict = JsonApiJwkPatchDocument.from_dict(json_api_jwk_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLabelLinkage.md b/gooddata-api-client/docs/JsonApiLabelLinkage.md index e96bb852c..0db7628bb 100644 --- a/gooddata-api-client/docs/JsonApiLabelLinkage.md +++ b/gooddata-api-client/docs/JsonApiLabelLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "label" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_label_linkage import JsonApiLabelLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLabelLinkage from a JSON string +json_api_label_linkage_instance = JsonApiLabelLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiLabelLinkage.to_json()) +# convert the object into a dict +json_api_label_linkage_dict = json_api_label_linkage_instance.to_dict() +# create an instance of JsonApiLabelLinkage from a dict +json_api_label_linkage_from_dict = JsonApiLabelLinkage.from_dict(json_api_label_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLabelOut.md b/gooddata-api-client/docs/JsonApiLabelOut.md index edf3a5754..1d966d08f 100644 --- a/gooddata-api-client/docs/JsonApiLabelOut.md +++ b/gooddata-api-client/docs/JsonApiLabelOut.md @@ -3,15 +3,32 @@ JSON:API representation of label entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "label" **attributes** | [**JsonApiLabelOutAttributes**](JsonApiLabelOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiLabelOutRelationships**](JsonApiLabelOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_label_out import JsonApiLabelOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLabelOut from a JSON string +json_api_label_out_instance = JsonApiLabelOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiLabelOut.to_json()) +# convert the object into a dict +json_api_label_out_dict = json_api_label_out_instance.to_dict() +# create an instance of JsonApiLabelOut from a dict +json_api_label_out_from_dict = JsonApiLabelOut.from_dict(json_api_label_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLabelOutAttributes.md b/gooddata-api-client/docs/JsonApiLabelOutAttributes.md index da840088f..2d674446b 100644 --- a/gooddata-api-client/docs/JsonApiLabelOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiLabelOutAttributes.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] @@ -10,11 +11,27 @@ Name | Type | Description | Notes **primary** | **bool** | | [optional] **source_column** | **str** | | [optional] **source_column_data_type** | **str** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] **value_type** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_label_out_attributes import JsonApiLabelOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLabelOutAttributes from a JSON string +json_api_label_out_attributes_instance = JsonApiLabelOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiLabelOutAttributes.to_json()) + +# convert the object into a dict +json_api_label_out_attributes_dict = json_api_label_out_attributes_instance.to_dict() +# create an instance of JsonApiLabelOutAttributes from a dict +json_api_label_out_attributes_from_dict = JsonApiLabelOutAttributes.from_dict(json_api_label_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLabelOutDocument.md b/gooddata-api-client/docs/JsonApiLabelOutDocument.md index 4ec6bb577..b4f9a9821 100644 --- a/gooddata-api-client/docs/JsonApiLabelOutDocument.md +++ b/gooddata-api-client/docs/JsonApiLabelOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiLabelOut**](JsonApiLabelOut.md) | | -**included** | [**[JsonApiAttributeOutWithLinks]**](JsonApiAttributeOutWithLinks.md) | Included resources | [optional] +**included** | [**List[JsonApiAttributeOutWithLinks]**](JsonApiAttributeOutWithLinks.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLabelOutDocument from a JSON string +json_api_label_out_document_instance = JsonApiLabelOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiLabelOutDocument.to_json()) + +# convert the object into a dict +json_api_label_out_document_dict = json_api_label_out_document_instance.to_dict() +# create an instance of JsonApiLabelOutDocument from a dict +json_api_label_out_document_from_dict = JsonApiLabelOutDocument.from_dict(json_api_label_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLabelOutList.md b/gooddata-api-client/docs/JsonApiLabelOutList.md index 8694334c0..16751ae8c 100644 --- a/gooddata-api-client/docs/JsonApiLabelOutList.md +++ b/gooddata-api-client/docs/JsonApiLabelOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiLabelOutWithLinks]**](JsonApiLabelOutWithLinks.md) | | -**included** | [**[JsonApiAttributeOutWithLinks]**](JsonApiAttributeOutWithLinks.md) | Included resources | [optional] +**data** | [**List[JsonApiLabelOutWithLinks]**](JsonApiLabelOutWithLinks.md) | | +**included** | [**List[JsonApiAttributeOutWithLinks]**](JsonApiAttributeOutWithLinks.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLabelOutList from a JSON string +json_api_label_out_list_instance = JsonApiLabelOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiLabelOutList.to_json()) + +# convert the object into a dict +json_api_label_out_list_dict = json_api_label_out_list_instance.to_dict() +# create an instance of JsonApiLabelOutList from a dict +json_api_label_out_list_from_dict = JsonApiLabelOutList.from_dict(json_api_label_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLabelOutRelationships.md b/gooddata-api-client/docs/JsonApiLabelOutRelationships.md index 3108e5571..b9eb85768 100644 --- a/gooddata-api-client/docs/JsonApiLabelOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiLabelOutRelationships.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute** | [**JsonApiLabelOutRelationshipsAttribute**](JsonApiLabelOutRelationshipsAttribute.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_label_out_relationships import JsonApiLabelOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLabelOutRelationships from a JSON string +json_api_label_out_relationships_instance = JsonApiLabelOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiLabelOutRelationships.to_json()) + +# convert the object into a dict +json_api_label_out_relationships_dict = json_api_label_out_relationships_instance.to_dict() +# create an instance of JsonApiLabelOutRelationships from a dict +json_api_label_out_relationships_from_dict = JsonApiLabelOutRelationships.from_dict(json_api_label_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLabelOutRelationshipsAttribute.md b/gooddata-api-client/docs/JsonApiLabelOutRelationshipsAttribute.md index 566d1ac64..2df1d3665 100644 --- a/gooddata-api-client/docs/JsonApiLabelOutRelationshipsAttribute.md +++ b/gooddata-api-client/docs/JsonApiLabelOutRelationshipsAttribute.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiAttributeToOneLinkage**](JsonApiAttributeToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_label_out_relationships_attribute import JsonApiLabelOutRelationshipsAttribute + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLabelOutRelationshipsAttribute from a JSON string +json_api_label_out_relationships_attribute_instance = JsonApiLabelOutRelationshipsAttribute.from_json(json) +# print the JSON string representation of the object +print(JsonApiLabelOutRelationshipsAttribute.to_json()) + +# convert the object into a dict +json_api_label_out_relationships_attribute_dict = json_api_label_out_relationships_attribute_instance.to_dict() +# create an instance of JsonApiLabelOutRelationshipsAttribute from a dict +json_api_label_out_relationships_attribute_from_dict = JsonApiLabelOutRelationshipsAttribute.from_dict(json_api_label_out_relationships_attribute_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLabelOutWithLinks.md b/gooddata-api-client/docs/JsonApiLabelOutWithLinks.md index 2ae685a53..f7bc57a75 100644 --- a/gooddata-api-client/docs/JsonApiLabelOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiLabelOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "label" **attributes** | [**JsonApiLabelOutAttributes**](JsonApiLabelOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiLabelOutRelationships**](JsonApiLabelOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLabelOutWithLinks from a JSON string +json_api_label_out_with_links_instance = JsonApiLabelOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiLabelOutWithLinks.to_json()) + +# convert the object into a dict +json_api_label_out_with_links_dict = json_api_label_out_with_links_instance.to_dict() +# create an instance of JsonApiLabelOutWithLinks from a dict +json_api_label_out_with_links_from_dict = JsonApiLabelOutWithLinks.from_dict(json_api_label_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLabelToManyLinkage.md b/gooddata-api-client/docs/JsonApiLabelToManyLinkage.md deleted file mode 100644 index 26efa66ea..000000000 --- a/gooddata-api-client/docs/JsonApiLabelToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiLabelToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiLabelLinkage]**](JsonApiLabelLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiLabelToOneLinkage.md b/gooddata-api-client/docs/JsonApiLabelToOneLinkage.md index 191010a6e..ef40769cc 100644 --- a/gooddata-api-client/docs/JsonApiLabelToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiLabelToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "label" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_label_to_one_linkage import JsonApiLabelToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLabelToOneLinkage from a JSON string +json_api_label_to_one_linkage_instance = JsonApiLabelToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiLabelToOneLinkage.to_json()) +# convert the object into a dict +json_api_label_to_one_linkage_dict = json_api_label_to_one_linkage_instance.to_dict() +# create an instance of JsonApiLabelToOneLinkage from a dict +json_api_label_to_one_linkage_from_dict = JsonApiLabelToOneLinkage.from_dict(json_api_label_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmEndpointIn.md b/gooddata-api-client/docs/JsonApiLlmEndpointIn.md index 4f48db219..08a2da90c 100644 --- a/gooddata-api-client/docs/JsonApiLlmEndpointIn.md +++ b/gooddata-api-client/docs/JsonApiLlmEndpointIn.md @@ -3,13 +3,30 @@ JSON:API representation of llmEndpoint entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiLlmEndpointInAttributes**](JsonApiLlmEndpointInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "llmEndpoint" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_llm_endpoint_in import JsonApiLlmEndpointIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLlmEndpointIn from a JSON string +json_api_llm_endpoint_in_instance = JsonApiLlmEndpointIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiLlmEndpointIn.to_json()) +# convert the object into a dict +json_api_llm_endpoint_in_dict = json_api_llm_endpoint_in_instance.to_dict() +# create an instance of JsonApiLlmEndpointIn from a dict +json_api_llm_endpoint_in_from_dict = JsonApiLlmEndpointIn.from_dict(json_api_llm_endpoint_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmEndpointInAttributes.md b/gooddata-api-client/docs/JsonApiLlmEndpointInAttributes.md index d2a0dd9f3..8eae05564 100644 --- a/gooddata-api-client/docs/JsonApiLlmEndpointInAttributes.md +++ b/gooddata-api-client/docs/JsonApiLlmEndpointInAttributes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**title** | **str** | User-facing title of the LLM Provider. | -**token** | **str** | The token to use to connect to the LLM provider. | -**base_url** | **str, none_type** | Custom LLM endpoint. | [optional] +**base_url** | **str** | Custom LLM endpoint. | [optional] **llm_model** | **str** | LLM Model. We provide a default model for each provider, but you can override it here. | [optional] -**llm_organization** | **str, none_type** | Organization in LLM provider. | [optional] +**llm_organization** | **str** | Organization in LLM provider. | [optional] **provider** | **str** | LLM Provider. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**title** | **str** | User-facing title of the LLM Provider. | +**token** | **str** | The token to use to connect to the LLM provider. | + +## Example + +```python +from gooddata_api_client.models.json_api_llm_endpoint_in_attributes import JsonApiLlmEndpointInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLlmEndpointInAttributes from a JSON string +json_api_llm_endpoint_in_attributes_instance = JsonApiLlmEndpointInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiLlmEndpointInAttributes.to_json()) +# convert the object into a dict +json_api_llm_endpoint_in_attributes_dict = json_api_llm_endpoint_in_attributes_instance.to_dict() +# create an instance of JsonApiLlmEndpointInAttributes from a dict +json_api_llm_endpoint_in_attributes_from_dict = JsonApiLlmEndpointInAttributes.from_dict(json_api_llm_endpoint_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmEndpointInDocument.md b/gooddata-api-client/docs/JsonApiLlmEndpointInDocument.md index 926ffde18..786a6d0bb 100644 --- a/gooddata-api-client/docs/JsonApiLlmEndpointInDocument.md +++ b/gooddata-api-client/docs/JsonApiLlmEndpointInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiLlmEndpointIn**](JsonApiLlmEndpointIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLlmEndpointInDocument from a JSON string +json_api_llm_endpoint_in_document_instance = JsonApiLlmEndpointInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiLlmEndpointInDocument.to_json()) + +# convert the object into a dict +json_api_llm_endpoint_in_document_dict = json_api_llm_endpoint_in_document_instance.to_dict() +# create an instance of JsonApiLlmEndpointInDocument from a dict +json_api_llm_endpoint_in_document_from_dict = JsonApiLlmEndpointInDocument.from_dict(json_api_llm_endpoint_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmEndpointOut.md b/gooddata-api-client/docs/JsonApiLlmEndpointOut.md index 0911e7fc9..e78933aa7 100644 --- a/gooddata-api-client/docs/JsonApiLlmEndpointOut.md +++ b/gooddata-api-client/docs/JsonApiLlmEndpointOut.md @@ -3,13 +3,30 @@ JSON:API representation of llmEndpoint entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiLlmEndpointOutAttributes**](JsonApiLlmEndpointOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "llmEndpoint" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_llm_endpoint_out import JsonApiLlmEndpointOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLlmEndpointOut from a JSON string +json_api_llm_endpoint_out_instance = JsonApiLlmEndpointOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiLlmEndpointOut.to_json()) +# convert the object into a dict +json_api_llm_endpoint_out_dict = json_api_llm_endpoint_out_instance.to_dict() +# create an instance of JsonApiLlmEndpointOut from a dict +json_api_llm_endpoint_out_from_dict = JsonApiLlmEndpointOut.from_dict(json_api_llm_endpoint_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmEndpointOutAttributes.md b/gooddata-api-client/docs/JsonApiLlmEndpointOutAttributes.md index d2f81eaa6..5e6655cc9 100644 --- a/gooddata-api-client/docs/JsonApiLlmEndpointOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiLlmEndpointOutAttributes.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**title** | **str** | User-facing title of the LLM Provider. | -**base_url** | **str, none_type** | Custom LLM endpoint. | [optional] +**base_url** | **str** | Custom LLM endpoint. | [optional] **llm_model** | **str** | LLM Model. We provide a default model for each provider, but you can override it here. | [optional] -**llm_organization** | **str, none_type** | Organization in LLM provider. | [optional] +**llm_organization** | **str** | Organization in LLM provider. | [optional] **provider** | **str** | LLM Provider. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**title** | **str** | User-facing title of the LLM Provider. | + +## Example + +```python +from gooddata_api_client.models.json_api_llm_endpoint_out_attributes import JsonApiLlmEndpointOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLlmEndpointOutAttributes from a JSON string +json_api_llm_endpoint_out_attributes_instance = JsonApiLlmEndpointOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiLlmEndpointOutAttributes.to_json()) +# convert the object into a dict +json_api_llm_endpoint_out_attributes_dict = json_api_llm_endpoint_out_attributes_instance.to_dict() +# create an instance of JsonApiLlmEndpointOutAttributes from a dict +json_api_llm_endpoint_out_attributes_from_dict = JsonApiLlmEndpointOutAttributes.from_dict(json_api_llm_endpoint_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmEndpointOutDocument.md b/gooddata-api-client/docs/JsonApiLlmEndpointOutDocument.md index a9b7aea19..8e49e2ace 100644 --- a/gooddata-api-client/docs/JsonApiLlmEndpointOutDocument.md +++ b/gooddata-api-client/docs/JsonApiLlmEndpointOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiLlmEndpointOut**](JsonApiLlmEndpointOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLlmEndpointOutDocument from a JSON string +json_api_llm_endpoint_out_document_instance = JsonApiLlmEndpointOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiLlmEndpointOutDocument.to_json()) + +# convert the object into a dict +json_api_llm_endpoint_out_document_dict = json_api_llm_endpoint_out_document_instance.to_dict() +# create an instance of JsonApiLlmEndpointOutDocument from a dict +json_api_llm_endpoint_out_document_from_dict = JsonApiLlmEndpointOutDocument.from_dict(json_api_llm_endpoint_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmEndpointOutList.md b/gooddata-api-client/docs/JsonApiLlmEndpointOutList.md index 5953fc0fb..9f9f25baa 100644 --- a/gooddata-api-client/docs/JsonApiLlmEndpointOutList.md +++ b/gooddata-api-client/docs/JsonApiLlmEndpointOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiLlmEndpointOutWithLinks]**](JsonApiLlmEndpointOutWithLinks.md) | | +**data** | [**List[JsonApiLlmEndpointOutWithLinks]**](JsonApiLlmEndpointOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLlmEndpointOutList from a JSON string +json_api_llm_endpoint_out_list_instance = JsonApiLlmEndpointOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiLlmEndpointOutList.to_json()) + +# convert the object into a dict +json_api_llm_endpoint_out_list_dict = json_api_llm_endpoint_out_list_instance.to_dict() +# create an instance of JsonApiLlmEndpointOutList from a dict +json_api_llm_endpoint_out_list_from_dict = JsonApiLlmEndpointOutList.from_dict(json_api_llm_endpoint_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmEndpointOutWithLinks.md b/gooddata-api-client/docs/JsonApiLlmEndpointOutWithLinks.md index 8dbd65202..3b892216a 100644 --- a/gooddata-api-client/docs/JsonApiLlmEndpointOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiLlmEndpointOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiLlmEndpointOutAttributes**](JsonApiLlmEndpointOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "llmEndpoint" +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_llm_endpoint_out_with_links import JsonApiLlmEndpointOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLlmEndpointOutWithLinks from a JSON string +json_api_llm_endpoint_out_with_links_instance = JsonApiLlmEndpointOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiLlmEndpointOutWithLinks.to_json()) + +# convert the object into a dict +json_api_llm_endpoint_out_with_links_dict = json_api_llm_endpoint_out_with_links_instance.to_dict() +# create an instance of JsonApiLlmEndpointOutWithLinks from a dict +json_api_llm_endpoint_out_with_links_from_dict = JsonApiLlmEndpointOutWithLinks.from_dict(json_api_llm_endpoint_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmEndpointPatch.md b/gooddata-api-client/docs/JsonApiLlmEndpointPatch.md index 3ec8d0815..adc552cd5 100644 --- a/gooddata-api-client/docs/JsonApiLlmEndpointPatch.md +++ b/gooddata-api-client/docs/JsonApiLlmEndpointPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching llmEndpoint entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiLlmEndpointPatchAttributes**](JsonApiLlmEndpointPatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "llmEndpoint" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_llm_endpoint_patch import JsonApiLlmEndpointPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLlmEndpointPatch from a JSON string +json_api_llm_endpoint_patch_instance = JsonApiLlmEndpointPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiLlmEndpointPatch.to_json()) +# convert the object into a dict +json_api_llm_endpoint_patch_dict = json_api_llm_endpoint_patch_instance.to_dict() +# create an instance of JsonApiLlmEndpointPatch from a dict +json_api_llm_endpoint_patch_from_dict = JsonApiLlmEndpointPatch.from_dict(json_api_llm_endpoint_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmEndpointPatchAttributes.md b/gooddata-api-client/docs/JsonApiLlmEndpointPatchAttributes.md index e08b20742..af1d66f7e 100644 --- a/gooddata-api-client/docs/JsonApiLlmEndpointPatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiLlmEndpointPatchAttributes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**base_url** | **str, none_type** | Custom LLM endpoint. | [optional] +**base_url** | **str** | Custom LLM endpoint. | [optional] **llm_model** | **str** | LLM Model. We provide a default model for each provider, but you can override it here. | [optional] -**llm_organization** | **str, none_type** | Organization in LLM provider. | [optional] +**llm_organization** | **str** | Organization in LLM provider. | [optional] **provider** | **str** | LLM Provider. | [optional] **title** | **str** | User-facing title of the LLM Provider. | [optional] **token** | **str** | The token to use to connect to the LLM provider. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_llm_endpoint_patch_attributes import JsonApiLlmEndpointPatchAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLlmEndpointPatchAttributes from a JSON string +json_api_llm_endpoint_patch_attributes_instance = JsonApiLlmEndpointPatchAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiLlmEndpointPatchAttributes.to_json()) + +# convert the object into a dict +json_api_llm_endpoint_patch_attributes_dict = json_api_llm_endpoint_patch_attributes_instance.to_dict() +# create an instance of JsonApiLlmEndpointPatchAttributes from a dict +json_api_llm_endpoint_patch_attributes_from_dict = JsonApiLlmEndpointPatchAttributes.from_dict(json_api_llm_endpoint_patch_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmEndpointPatchDocument.md b/gooddata-api-client/docs/JsonApiLlmEndpointPatchDocument.md index 8712dada6..29b7dc8d5 100644 --- a/gooddata-api-client/docs/JsonApiLlmEndpointPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiLlmEndpointPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiLlmEndpointPatch**](JsonApiLlmEndpointPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiLlmEndpointPatchDocument from a JSON string +json_api_llm_endpoint_patch_document_instance = JsonApiLlmEndpointPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiLlmEndpointPatchDocument.to_json()) + +# convert the object into a dict +json_api_llm_endpoint_patch_document_dict = json_api_llm_endpoint_patch_document_instance.to_dict() +# create an instance of JsonApiLlmEndpointPatchDocument from a dict +json_api_llm_endpoint_patch_document_from_dict = JsonApiLlmEndpointPatchDocument.from_dict(json_api_llm_endpoint_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricIn.md b/gooddata-api-client/docs/JsonApiMetricIn.md index 4f99c9126..110fee05d 100644 --- a/gooddata-api-client/docs/JsonApiMetricIn.md +++ b/gooddata-api-client/docs/JsonApiMetricIn.md @@ -3,13 +3,30 @@ JSON:API representation of metric entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiMetricInAttributes**](JsonApiMetricInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "metric" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_metric_in import JsonApiMetricIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricIn from a JSON string +json_api_metric_in_instance = JsonApiMetricIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricIn.to_json()) +# convert the object into a dict +json_api_metric_in_dict = json_api_metric_in_instance.to_dict() +# create an instance of JsonApiMetricIn from a dict +json_api_metric_in_from_dict = JsonApiMetricIn.from_dict(json_api_metric_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricInAttributes.md b/gooddata-api-client/docs/JsonApiMetricInAttributes.md index e02daf95b..3b89599b2 100644 --- a/gooddata-api-client/docs/JsonApiMetricInAttributes.md +++ b/gooddata-api-client/docs/JsonApiMetricInAttributes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonApiMetricInAttributesContent**](JsonApiMetricInAttributesContent.md) | | **are_relations_valid** | **bool** | | [optional] +**content** | [**JsonApiMetricInAttributesContent**](JsonApiMetricInAttributesContent.md) | | **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_metric_in_attributes import JsonApiMetricInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricInAttributes from a JSON string +json_api_metric_in_attributes_instance = JsonApiMetricInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricInAttributes.to_json()) + +# convert the object into a dict +json_api_metric_in_attributes_dict = json_api_metric_in_attributes_instance.to_dict() +# create an instance of JsonApiMetricInAttributes from a dict +json_api_metric_in_attributes_from_dict = JsonApiMetricInAttributes.from_dict(json_api_metric_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricInAttributesContent.md b/gooddata-api-client/docs/JsonApiMetricInAttributesContent.md index 2f967be5f..967b9dc60 100644 --- a/gooddata-api-client/docs/JsonApiMetricInAttributesContent.md +++ b/gooddata-api-client/docs/JsonApiMetricInAttributesContent.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**maql** | **str** | | **format** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**maql** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricInAttributesContent from a JSON string +json_api_metric_in_attributes_content_instance = JsonApiMetricInAttributesContent.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricInAttributesContent.to_json()) +# convert the object into a dict +json_api_metric_in_attributes_content_dict = json_api_metric_in_attributes_content_instance.to_dict() +# create an instance of JsonApiMetricInAttributesContent from a dict +json_api_metric_in_attributes_content_from_dict = JsonApiMetricInAttributesContent.from_dict(json_api_metric_in_attributes_content_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricInDocument.md b/gooddata-api-client/docs/JsonApiMetricInDocument.md index 5fc892cc9..d080df0b9 100644 --- a/gooddata-api-client/docs/JsonApiMetricInDocument.md +++ b/gooddata-api-client/docs/JsonApiMetricInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiMetricIn**](JsonApiMetricIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricInDocument from a JSON string +json_api_metric_in_document_instance = JsonApiMetricInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricInDocument.to_json()) + +# convert the object into a dict +json_api_metric_in_document_dict = json_api_metric_in_document_instance.to_dict() +# create an instance of JsonApiMetricInDocument from a dict +json_api_metric_in_document_from_dict = JsonApiMetricInDocument.from_dict(json_api_metric_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricLinkage.md b/gooddata-api-client/docs/JsonApiMetricLinkage.md index c9c03fc47..9909bbe0b 100644 --- a/gooddata-api-client/docs/JsonApiMetricLinkage.md +++ b/gooddata-api-client/docs/JsonApiMetricLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "metric" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_metric_linkage import JsonApiMetricLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricLinkage from a JSON string +json_api_metric_linkage_instance = JsonApiMetricLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricLinkage.to_json()) +# convert the object into a dict +json_api_metric_linkage_dict = json_api_metric_linkage_instance.to_dict() +# create an instance of JsonApiMetricLinkage from a dict +json_api_metric_linkage_from_dict = JsonApiMetricLinkage.from_dict(json_api_metric_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricOut.md b/gooddata-api-client/docs/JsonApiMetricOut.md index 15de82d14..3f8e2c303 100644 --- a/gooddata-api-client/docs/JsonApiMetricOut.md +++ b/gooddata-api-client/docs/JsonApiMetricOut.md @@ -3,15 +3,32 @@ JSON:API representation of metric entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiMetricOutAttributes**](JsonApiMetricOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "metric" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiMetricOutRelationships**](JsonApiMetricOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_metric_out import JsonApiMetricOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricOut from a JSON string +json_api_metric_out_instance = JsonApiMetricOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricOut.to_json()) +# convert the object into a dict +json_api_metric_out_dict = json_api_metric_out_instance.to_dict() +# create an instance of JsonApiMetricOut from a dict +json_api_metric_out_from_dict = JsonApiMetricOut.from_dict(json_api_metric_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricOutAttributes.md b/gooddata-api-client/docs/JsonApiMetricOutAttributes.md index 3489b6ff9..2edd17c40 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiMetricOutAttributes.md @@ -2,18 +2,35 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonApiMetricInAttributesContent**](JsonApiMetricInAttributesContent.md) | | **are_relations_valid** | **bool** | | [optional] +**content** | [**JsonApiMetricInAttributesContent**](JsonApiMetricInAttributesContent.md) | | **created_at** | **datetime** | | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] **modified_at** | **datetime** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_metric_out_attributes import JsonApiMetricOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricOutAttributes from a JSON string +json_api_metric_out_attributes_instance = JsonApiMetricOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricOutAttributes.to_json()) + +# convert the object into a dict +json_api_metric_out_attributes_dict = json_api_metric_out_attributes_instance.to_dict() +# create an instance of JsonApiMetricOutAttributes from a dict +json_api_metric_out_attributes_from_dict = JsonApiMetricOutAttributes.from_dict(json_api_metric_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricOutDocument.md b/gooddata-api-client/docs/JsonApiMetricOutDocument.md index 85d95f58b..d5b6c0491 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutDocument.md +++ b/gooddata-api-client/docs/JsonApiMetricOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiMetricOut**](JsonApiMetricOut.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricOutDocument from a JSON string +json_api_metric_out_document_instance = JsonApiMetricOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricOutDocument.to_json()) + +# convert the object into a dict +json_api_metric_out_document_dict = json_api_metric_out_document_instance.to_dict() +# create an instance of JsonApiMetricOutDocument from a dict +json_api_metric_out_document_from_dict = JsonApiMetricOutDocument.from_dict(json_api_metric_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricOutIncludes.md b/gooddata-api-client/docs/JsonApiMetricOutIncludes.md index c447da947..9151f178e 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiMetricOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiDatasetOutAttributes**](JsonApiDatasetOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiDatasetOutRelationships**](JsonApiDatasetOutRelationships.md) | | [optional] -**attributes** | [**JsonApiDatasetOutAttributes**](JsonApiDatasetOutAttributes.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "dataset" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_metric_out_includes import JsonApiMetricOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricOutIncludes from a JSON string +json_api_metric_out_includes_instance = JsonApiMetricOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricOutIncludes.to_json()) + +# convert the object into a dict +json_api_metric_out_includes_dict = json_api_metric_out_includes_instance.to_dict() +# create an instance of JsonApiMetricOutIncludes from a dict +json_api_metric_out_includes_from_dict = JsonApiMetricOutIncludes.from_dict(json_api_metric_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricOutList.md b/gooddata-api-client/docs/JsonApiMetricOutList.md index 834a4b6ba..284b62738 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutList.md +++ b/gooddata-api-client/docs/JsonApiMetricOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiMetricOutWithLinks]**](JsonApiMetricOutWithLinks.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiMetricOutWithLinks]**](JsonApiMetricOutWithLinks.md) | | +**included** | [**List[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricOutList from a JSON string +json_api_metric_out_list_instance = JsonApiMetricOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricOutList.to_json()) + +# convert the object into a dict +json_api_metric_out_list_dict = json_api_metric_out_list_instance.to_dict() +# create an instance of JsonApiMetricOutList from a dict +json_api_metric_out_list_from_dict = JsonApiMetricOutList.from_dict(json_api_metric_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricOutRelationships.md b/gooddata-api-client/docs/JsonApiMetricOutRelationships.md index 995bc4892..92f48023f 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiMetricOutRelationships.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAttributeHierarchyOutRelationshipsAttributes**](JsonApiAttributeHierarchyOutRelationshipsAttributes.md) | | [optional] @@ -11,8 +12,24 @@ Name | Type | Description | Notes **labels** | [**JsonApiAnalyticalDashboardOutRelationshipsLabels**](JsonApiAnalyticalDashboardOutRelationshipsLabels.md) | | [optional] **metrics** | [**JsonApiAnalyticalDashboardOutRelationshipsMetrics**](JsonApiAnalyticalDashboardOutRelationshipsMetrics.md) | | [optional] **modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_metric_out_relationships import JsonApiMetricOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricOutRelationships from a JSON string +json_api_metric_out_relationships_instance = JsonApiMetricOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricOutRelationships.to_json()) + +# convert the object into a dict +json_api_metric_out_relationships_dict = json_api_metric_out_relationships_instance.to_dict() +# create an instance of JsonApiMetricOutRelationships from a dict +json_api_metric_out_relationships_from_dict = JsonApiMetricOutRelationships.from_dict(json_api_metric_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricOutWithLinks.md b/gooddata-api-client/docs/JsonApiMetricOutWithLinks.md index 9e5f39acd..b669b2885 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiMetricOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiMetricOutAttributes**](JsonApiMetricOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "metric" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiMetricOutRelationships**](JsonApiMetricOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_metric_out_with_links import JsonApiMetricOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricOutWithLinks from a JSON string +json_api_metric_out_with_links_instance = JsonApiMetricOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricOutWithLinks.to_json()) + +# convert the object into a dict +json_api_metric_out_with_links_dict = json_api_metric_out_with_links_instance.to_dict() +# create an instance of JsonApiMetricOutWithLinks from a dict +json_api_metric_out_with_links_from_dict = JsonApiMetricOutWithLinks.from_dict(json_api_metric_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricPatch.md b/gooddata-api-client/docs/JsonApiMetricPatch.md index 3ca89ffec..1302b1645 100644 --- a/gooddata-api-client/docs/JsonApiMetricPatch.md +++ b/gooddata-api-client/docs/JsonApiMetricPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching metric entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiMetricPatchAttributes**](JsonApiMetricPatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "metric" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_metric_patch import JsonApiMetricPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricPatch from a JSON string +json_api_metric_patch_instance = JsonApiMetricPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricPatch.to_json()) +# convert the object into a dict +json_api_metric_patch_dict = json_api_metric_patch_instance.to_dict() +# create an instance of JsonApiMetricPatch from a dict +json_api_metric_patch_from_dict = JsonApiMetricPatch.from_dict(json_api_metric_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricPatchAttributes.md b/gooddata-api-client/docs/JsonApiMetricPatchAttributes.md index e25ed1b95..135c69de6 100644 --- a/gooddata-api-client/docs/JsonApiMetricPatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiMetricPatchAttributes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] **content** | [**JsonApiMetricInAttributesContent**](JsonApiMetricInAttributesContent.md) | | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_metric_patch_attributes import JsonApiMetricPatchAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricPatchAttributes from a JSON string +json_api_metric_patch_attributes_instance = JsonApiMetricPatchAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricPatchAttributes.to_json()) + +# convert the object into a dict +json_api_metric_patch_attributes_dict = json_api_metric_patch_attributes_instance.to_dict() +# create an instance of JsonApiMetricPatchAttributes from a dict +json_api_metric_patch_attributes_from_dict = JsonApiMetricPatchAttributes.from_dict(json_api_metric_patch_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricPatchDocument.md b/gooddata-api-client/docs/JsonApiMetricPatchDocument.md index 893cb8fbd..3cb435fcf 100644 --- a/gooddata-api-client/docs/JsonApiMetricPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiMetricPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiMetricPatch**](JsonApiMetricPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricPatchDocument from a JSON string +json_api_metric_patch_document_instance = JsonApiMetricPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricPatchDocument.to_json()) + +# convert the object into a dict +json_api_metric_patch_document_dict = json_api_metric_patch_document_instance.to_dict() +# create an instance of JsonApiMetricPatchDocument from a dict +json_api_metric_patch_document_from_dict = JsonApiMetricPatchDocument.from_dict(json_api_metric_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricPostOptionalId.md b/gooddata-api-client/docs/JsonApiMetricPostOptionalId.md index b92a0cb28..72a7f38b2 100644 --- a/gooddata-api-client/docs/JsonApiMetricPostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiMetricPostOptionalId.md @@ -3,13 +3,30 @@ JSON:API representation of metric entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiMetricInAttributes**](JsonApiMetricInAttributes.md) | | -**type** | **str** | Object type | defaults to "metric" **id** | **str** | API identifier of an object | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_metric_post_optional_id import JsonApiMetricPostOptionalId + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricPostOptionalId from a JSON string +json_api_metric_post_optional_id_instance = JsonApiMetricPostOptionalId.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricPostOptionalId.to_json()) +# convert the object into a dict +json_api_metric_post_optional_id_dict = json_api_metric_post_optional_id_instance.to_dict() +# create an instance of JsonApiMetricPostOptionalId from a dict +json_api_metric_post_optional_id_from_dict = JsonApiMetricPostOptionalId.from_dict(json_api_metric_post_optional_id_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiMetricPostOptionalIdDocument.md index 995b53088..68622f8d1 100644 --- a/gooddata-api-client/docs/JsonApiMetricPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/JsonApiMetricPostOptionalIdDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiMetricPostOptionalId**](JsonApiMetricPostOptionalId.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiMetricPostOptionalIdDocument from a JSON string +json_api_metric_post_optional_id_document_instance = JsonApiMetricPostOptionalIdDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiMetricPostOptionalIdDocument.to_json()) + +# convert the object into a dict +json_api_metric_post_optional_id_document_dict = json_api_metric_post_optional_id_document_instance.to_dict() +# create an instance of JsonApiMetricPostOptionalIdDocument from a dict +json_api_metric_post_optional_id_document_from_dict = JsonApiMetricPostOptionalIdDocument.from_dict(json_api_metric_post_optional_id_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiMetricToManyLinkage.md b/gooddata-api-client/docs/JsonApiMetricToManyLinkage.md deleted file mode 100644 index 82af64e9b..000000000 --- a/gooddata-api-client/docs/JsonApiMetricToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiMetricToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiMetricLinkage]**](JsonApiMetricLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOut.md b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOut.md index 77175b45c..549a1728e 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOut.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOut.md @@ -3,13 +3,30 @@ JSON:API representation of notificationChannelIdentifier entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "notificationChannelIdentifier" **attributes** | [**JsonApiNotificationChannelIdentifierOutAttributes**](JsonApiNotificationChannelIdentifierOutAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_identifier_out import JsonApiNotificationChannelIdentifierOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelIdentifierOut from a JSON string +json_api_notification_channel_identifier_out_instance = JsonApiNotificationChannelIdentifierOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelIdentifierOut.to_json()) +# convert the object into a dict +json_api_notification_channel_identifier_out_dict = json_api_notification_channel_identifier_out_instance.to_dict() +# create an instance of JsonApiNotificationChannelIdentifierOut from a dict +json_api_notification_channel_identifier_out_from_dict = JsonApiNotificationChannelIdentifierOut.from_dict(json_api_notification_channel_identifier_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutAttributes.md b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutAttributes.md index 6de452938..7786270d3 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutAttributes.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **allowed_recipients** | **str** | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization | [optional] -**description** | **str, none_type** | | [optional] +**description** | **str** | | [optional] **destination_type** | **str** | | [optional] -**name** | **str, none_type** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**name** | **str** | | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_identifier_out_attributes import JsonApiNotificationChannelIdentifierOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelIdentifierOutAttributes from a JSON string +json_api_notification_channel_identifier_out_attributes_instance = JsonApiNotificationChannelIdentifierOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelIdentifierOutAttributes.to_json()) +# convert the object into a dict +json_api_notification_channel_identifier_out_attributes_dict = json_api_notification_channel_identifier_out_attributes_instance.to_dict() +# create an instance of JsonApiNotificationChannelIdentifierOutAttributes from a dict +json_api_notification_channel_identifier_out_attributes_from_dict = JsonApiNotificationChannelIdentifierOutAttributes.from_dict(json_api_notification_channel_identifier_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutDocument.md b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutDocument.md index 6b56fa718..6b931cb42 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutDocument.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiNotificationChannelIdentifierOut**](JsonApiNotificationChannelIdentifierOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelIdentifierOutDocument from a JSON string +json_api_notification_channel_identifier_out_document_instance = JsonApiNotificationChannelIdentifierOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelIdentifierOutDocument.to_json()) + +# convert the object into a dict +json_api_notification_channel_identifier_out_document_dict = json_api_notification_channel_identifier_out_document_instance.to_dict() +# create an instance of JsonApiNotificationChannelIdentifierOutDocument from a dict +json_api_notification_channel_identifier_out_document_from_dict = JsonApiNotificationChannelIdentifierOutDocument.from_dict(json_api_notification_channel_identifier_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutList.md b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutList.md index 3ea6ad618..747abb773 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutList.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiNotificationChannelIdentifierOutWithLinks]**](JsonApiNotificationChannelIdentifierOutWithLinks.md) | | +**data** | [**List[JsonApiNotificationChannelIdentifierOutWithLinks]**](JsonApiNotificationChannelIdentifierOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelIdentifierOutList from a JSON string +json_api_notification_channel_identifier_out_list_instance = JsonApiNotificationChannelIdentifierOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelIdentifierOutList.to_json()) + +# convert the object into a dict +json_api_notification_channel_identifier_out_list_dict = json_api_notification_channel_identifier_out_list_instance.to_dict() +# create an instance of JsonApiNotificationChannelIdentifierOutList from a dict +json_api_notification_channel_identifier_out_list_from_dict = JsonApiNotificationChannelIdentifierOutList.from_dict(json_api_notification_channel_identifier_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutWithLinks.md b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutWithLinks.md index 2f551b9cd..87450786a 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "notificationChannelIdentifier" **attributes** | [**JsonApiNotificationChannelIdentifierOutAttributes**](JsonApiNotificationChannelIdentifierOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_identifier_out_with_links import JsonApiNotificationChannelIdentifierOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelIdentifierOutWithLinks from a JSON string +json_api_notification_channel_identifier_out_with_links_instance = JsonApiNotificationChannelIdentifierOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelIdentifierOutWithLinks.to_json()) + +# convert the object into a dict +json_api_notification_channel_identifier_out_with_links_dict = json_api_notification_channel_identifier_out_with_links_instance.to_dict() +# create an instance of JsonApiNotificationChannelIdentifierOutWithLinks from a dict +json_api_notification_channel_identifier_out_with_links_from_dict = JsonApiNotificationChannelIdentifierOutWithLinks.from_dict(json_api_notification_channel_identifier_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelIn.md b/gooddata-api-client/docs/JsonApiNotificationChannelIn.md index 79846933d..d84f98f76 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelIn.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelIn.md @@ -3,13 +3,30 @@ JSON:API representation of notificationChannel entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "notificationChannel" **attributes** | [**JsonApiNotificationChannelInAttributes**](JsonApiNotificationChannelInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_in import JsonApiNotificationChannelIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelIn from a JSON string +json_api_notification_channel_in_instance = JsonApiNotificationChannelIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelIn.to_json()) +# convert the object into a dict +json_api_notification_channel_in_dict = json_api_notification_channel_in_instance.to_dict() +# create an instance of JsonApiNotificationChannelIn from a dict +json_api_notification_channel_in_from_dict = JsonApiNotificationChannelIn.from_dict(json_api_notification_channel_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelInAttributes.md b/gooddata-api-client/docs/JsonApiNotificationChannelInAttributes.md index 6a0726098..ed89656a2 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelInAttributes.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelInAttributes.md @@ -2,18 +2,35 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **allowed_recipients** | **str** | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization | [optional] **custom_dashboard_url** | **str** | Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} | [optional] **dashboard_link_visibility** | **str** | Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link | [optional] -**description** | **str, none_type** | | [optional] +**description** | **str** | | [optional] **destination** | [**JsonApiNotificationChannelInAttributesDestination**](JsonApiNotificationChannelInAttributesDestination.md) | | [optional] **in_platform_notification** | **str** | In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications | [optional] -**name** | **str, none_type** | | [optional] +**name** | **str** | | [optional] **notification_source** | **str** | Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_in_attributes import JsonApiNotificationChannelInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelInAttributes from a JSON string +json_api_notification_channel_in_attributes_instance = JsonApiNotificationChannelInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelInAttributes.to_json()) + +# convert the object into a dict +json_api_notification_channel_in_attributes_dict = json_api_notification_channel_in_attributes_instance.to_dict() +# create an instance of JsonApiNotificationChannelInAttributes from a dict +json_api_notification_channel_in_attributes_from_dict = JsonApiNotificationChannelInAttributes.from_dict(json_api_notification_channel_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelInAttributesDestination.md b/gooddata-api-client/docs/JsonApiNotificationChannelInAttributesDestination.md index a80927804..cde1c3ce4 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelInAttributesDestination.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelInAttributesDestination.md @@ -3,20 +3,37 @@ The destination where the notifications are to be sent. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**from_email** | **str** | E-mail address to send notifications from. | [optional] if omitted the server will use the default value of no-reply@gooddata.com -**from_email_name** | **str** | An optional e-mail name to send notifications from. | [optional] if omitted the server will use the default value of "GoodData" +**from_email** | **str** | E-mail address to send notifications from. | [optional] [default to 'no-reply@gooddata.com'] +**from_email_name** | **str** | An optional e-mail name to send notifications from. | [optional] [default to 'GoodData'] +**type** | **str** | The destination type. | **host** | **str** | The SMTP server address. | [optional] **password** | **str** | The SMTP server password. | [optional] **port** | **int** | The SMTP server port. | [optional] **username** | **str** | The SMTP server username. | [optional] -**has_token** | **bool, none_type** | Flag indicating if webhook has a token. | [optional] [readonly] -**token** | **str, none_type** | Bearer token for the webhook. | [optional] +**has_token** | **bool** | Flag indicating if webhook has a token. | [optional] [readonly] +**token** | **str** | Bearer token for the webhook. | [optional] **url** | **str** | The webhook URL. | [optional] -**type** | **str** | The destination type. | [optional] if omitted the server will use the default value of "WEBHOOK" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_in_attributes_destination import JsonApiNotificationChannelInAttributesDestination + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelInAttributesDestination from a JSON string +json_api_notification_channel_in_attributes_destination_instance = JsonApiNotificationChannelInAttributesDestination.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelInAttributesDestination.to_json()) + +# convert the object into a dict +json_api_notification_channel_in_attributes_destination_dict = json_api_notification_channel_in_attributes_destination_instance.to_dict() +# create an instance of JsonApiNotificationChannelInAttributesDestination from a dict +json_api_notification_channel_in_attributes_destination_from_dict = JsonApiNotificationChannelInAttributesDestination.from_dict(json_api_notification_channel_in_attributes_destination_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelInDocument.md b/gooddata-api-client/docs/JsonApiNotificationChannelInDocument.md index a8b571982..34ab3dc80 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelInDocument.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiNotificationChannelIn**](JsonApiNotificationChannelIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelInDocument from a JSON string +json_api_notification_channel_in_document_instance = JsonApiNotificationChannelInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelInDocument.to_json()) + +# convert the object into a dict +json_api_notification_channel_in_document_dict = json_api_notification_channel_in_document_instance.to_dict() +# create an instance of JsonApiNotificationChannelInDocument from a dict +json_api_notification_channel_in_document_from_dict = JsonApiNotificationChannelInDocument.from_dict(json_api_notification_channel_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelLinkage.md b/gooddata-api-client/docs/JsonApiNotificationChannelLinkage.md index 090e2b25a..a60ec6a66 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelLinkage.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "notificationChannel" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_linkage import JsonApiNotificationChannelLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelLinkage from a JSON string +json_api_notification_channel_linkage_instance = JsonApiNotificationChannelLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelLinkage.to_json()) +# convert the object into a dict +json_api_notification_channel_linkage_dict = json_api_notification_channel_linkage_instance.to_dict() +# create an instance of JsonApiNotificationChannelLinkage from a dict +json_api_notification_channel_linkage_from_dict = JsonApiNotificationChannelLinkage.from_dict(json_api_notification_channel_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelOut.md b/gooddata-api-client/docs/JsonApiNotificationChannelOut.md index edb97d0bc..b61c4edc6 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelOut.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelOut.md @@ -3,13 +3,30 @@ JSON:API representation of notificationChannel entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "notificationChannel" **attributes** | [**JsonApiNotificationChannelOutAttributes**](JsonApiNotificationChannelOutAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_out import JsonApiNotificationChannelOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelOut from a JSON string +json_api_notification_channel_out_instance = JsonApiNotificationChannelOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelOut.to_json()) +# convert the object into a dict +json_api_notification_channel_out_dict = json_api_notification_channel_out_instance.to_dict() +# create an instance of JsonApiNotificationChannelOut from a dict +json_api_notification_channel_out_from_dict = JsonApiNotificationChannelOut.from_dict(json_api_notification_channel_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelOutAttributes.md b/gooddata-api-client/docs/JsonApiNotificationChannelOutAttributes.md index 5646c49cc..74c86d776 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelOutAttributes.md @@ -2,19 +2,36 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **allowed_recipients** | **str** | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization | [optional] **custom_dashboard_url** | **str** | Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} | [optional] **dashboard_link_visibility** | **str** | Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link | [optional] -**description** | **str, none_type** | | [optional] +**description** | **str** | | [optional] **destination** | [**JsonApiNotificationChannelInAttributesDestination**](JsonApiNotificationChannelInAttributesDestination.md) | | [optional] -**destination_type** | **str, none_type** | | [optional] +**destination_type** | **str** | | [optional] **in_platform_notification** | **str** | In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications | [optional] -**name** | **str, none_type** | | [optional] +**name** | **str** | | [optional] **notification_source** | **str** | Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_out_attributes import JsonApiNotificationChannelOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelOutAttributes from a JSON string +json_api_notification_channel_out_attributes_instance = JsonApiNotificationChannelOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelOutAttributes.to_json()) + +# convert the object into a dict +json_api_notification_channel_out_attributes_dict = json_api_notification_channel_out_attributes_instance.to_dict() +# create an instance of JsonApiNotificationChannelOutAttributes from a dict +json_api_notification_channel_out_attributes_from_dict = JsonApiNotificationChannelOutAttributes.from_dict(json_api_notification_channel_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelOutDocument.md b/gooddata-api-client/docs/JsonApiNotificationChannelOutDocument.md index cdaf58ff6..b796259f8 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelOutDocument.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiNotificationChannelOut**](JsonApiNotificationChannelOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelOutDocument from a JSON string +json_api_notification_channel_out_document_instance = JsonApiNotificationChannelOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelOutDocument.to_json()) + +# convert the object into a dict +json_api_notification_channel_out_document_dict = json_api_notification_channel_out_document_instance.to_dict() +# create an instance of JsonApiNotificationChannelOutDocument from a dict +json_api_notification_channel_out_document_from_dict = JsonApiNotificationChannelOutDocument.from_dict(json_api_notification_channel_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelOutList.md b/gooddata-api-client/docs/JsonApiNotificationChannelOutList.md index 7731e91d2..979387ca0 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelOutList.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiNotificationChannelOutWithLinks]**](JsonApiNotificationChannelOutWithLinks.md) | | +**data** | [**List[JsonApiNotificationChannelOutWithLinks]**](JsonApiNotificationChannelOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelOutList from a JSON string +json_api_notification_channel_out_list_instance = JsonApiNotificationChannelOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelOutList.to_json()) + +# convert the object into a dict +json_api_notification_channel_out_list_dict = json_api_notification_channel_out_list_instance.to_dict() +# create an instance of JsonApiNotificationChannelOutList from a dict +json_api_notification_channel_out_list_from_dict = JsonApiNotificationChannelOutList.from_dict(json_api_notification_channel_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelOutWithLinks.md b/gooddata-api-client/docs/JsonApiNotificationChannelOutWithLinks.md index c1d1bb8ce..8f7fe698f 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "notificationChannel" **attributes** | [**JsonApiNotificationChannelOutAttributes**](JsonApiNotificationChannelOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelOutWithLinks from a JSON string +json_api_notification_channel_out_with_links_instance = JsonApiNotificationChannelOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelOutWithLinks.to_json()) + +# convert the object into a dict +json_api_notification_channel_out_with_links_dict = json_api_notification_channel_out_with_links_instance.to_dict() +# create an instance of JsonApiNotificationChannelOutWithLinks from a dict +json_api_notification_channel_out_with_links_from_dict = JsonApiNotificationChannelOutWithLinks.from_dict(json_api_notification_channel_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelPatch.md b/gooddata-api-client/docs/JsonApiNotificationChannelPatch.md index dc0c36b60..4b8969745 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelPatch.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching notificationChannel entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "notificationChannel" **attributes** | [**JsonApiNotificationChannelInAttributes**](JsonApiNotificationChannelInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_patch import JsonApiNotificationChannelPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelPatch from a JSON string +json_api_notification_channel_patch_instance = JsonApiNotificationChannelPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelPatch.to_json()) +# convert the object into a dict +json_api_notification_channel_patch_dict = json_api_notification_channel_patch_instance.to_dict() +# create an instance of JsonApiNotificationChannelPatch from a dict +json_api_notification_channel_patch_from_dict = JsonApiNotificationChannelPatch.from_dict(json_api_notification_channel_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelPatchDocument.md b/gooddata-api-client/docs/JsonApiNotificationChannelPatchDocument.md index 0cb94be4e..beb3b71e4 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiNotificationChannelPatch**](JsonApiNotificationChannelPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelPatchDocument from a JSON string +json_api_notification_channel_patch_document_instance = JsonApiNotificationChannelPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelPatchDocument.to_json()) + +# convert the object into a dict +json_api_notification_channel_patch_document_dict = json_api_notification_channel_patch_document_instance.to_dict() +# create an instance of JsonApiNotificationChannelPatchDocument from a dict +json_api_notification_channel_patch_document_from_dict = JsonApiNotificationChannelPatchDocument.from_dict(json_api_notification_channel_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelPostOptionalId.md b/gooddata-api-client/docs/JsonApiNotificationChannelPostOptionalId.md index d70e65de9..4dd9001d5 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelPostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelPostOptionalId.md @@ -3,13 +3,30 @@ JSON:API representation of notificationChannel entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | Object type | defaults to "notificationChannel" **attributes** | [**JsonApiNotificationChannelInAttributes**](JsonApiNotificationChannelInAttributes.md) | | [optional] **id** | **str** | API identifier of an object | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_post_optional_id import JsonApiNotificationChannelPostOptionalId + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelPostOptionalId from a JSON string +json_api_notification_channel_post_optional_id_instance = JsonApiNotificationChannelPostOptionalId.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelPostOptionalId.to_json()) +# convert the object into a dict +json_api_notification_channel_post_optional_id_dict = json_api_notification_channel_post_optional_id_instance.to_dict() +# create an instance of JsonApiNotificationChannelPostOptionalId from a dict +json_api_notification_channel_post_optional_id_from_dict = JsonApiNotificationChannelPostOptionalId.from_dict(json_api_notification_channel_post_optional_id_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiNotificationChannelPostOptionalIdDocument.md index f09b9bbbf..de6759de3 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelPostOptionalIdDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiNotificationChannelPostOptionalId**](JsonApiNotificationChannelPostOptionalId.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelPostOptionalIdDocument from a JSON string +json_api_notification_channel_post_optional_id_document_instance = JsonApiNotificationChannelPostOptionalIdDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelPostOptionalIdDocument.to_json()) + +# convert the object into a dict +json_api_notification_channel_post_optional_id_document_dict = json_api_notification_channel_post_optional_id_document_instance.to_dict() +# create an instance of JsonApiNotificationChannelPostOptionalIdDocument from a dict +json_api_notification_channel_post_optional_id_document_from_dict = JsonApiNotificationChannelPostOptionalIdDocument.from_dict(json_api_notification_channel_post_optional_id_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelToOneLinkage.md b/gooddata-api-client/docs/JsonApiNotificationChannelToOneLinkage.md index 6a37955da..519491ce4 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "notificationChannel" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_notification_channel_to_one_linkage import JsonApiNotificationChannelToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiNotificationChannelToOneLinkage from a JSON string +json_api_notification_channel_to_one_linkage_instance = JsonApiNotificationChannelToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiNotificationChannelToOneLinkage.to_json()) +# convert the object into a dict +json_api_notification_channel_to_one_linkage_dict = json_api_notification_channel_to_one_linkage_instance.to_dict() +# create an instance of JsonApiNotificationChannelToOneLinkage from a dict +json_api_notification_channel_to_one_linkage_from_dict = JsonApiNotificationChannelToOneLinkage.from_dict(json_api_notification_channel_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationIn.md b/gooddata-api-client/docs/JsonApiOrganizationIn.md index 6240b9172..f0709756f 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationIn.md +++ b/gooddata-api-client/docs/JsonApiOrganizationIn.md @@ -3,14 +3,31 @@ JSON:API representation of organization entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "organization" **attributes** | [**JsonApiOrganizationInAttributes**](JsonApiOrganizationInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiOrganizationInRelationships**](JsonApiOrganizationInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_organization_in import JsonApiOrganizationIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationIn from a JSON string +json_api_organization_in_instance = JsonApiOrganizationIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationIn.to_json()) +# convert the object into a dict +json_api_organization_in_dict = json_api_organization_in_instance.to_dict() +# create an instance of JsonApiOrganizationIn from a dict +json_api_organization_in_from_dict = JsonApiOrganizationIn.from_dict(json_api_organization_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationInAttributes.md b/gooddata-api-client/docs/JsonApiOrganizationInAttributes.md index f493c7bc2..47b76968e 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationInAttributes.md +++ b/gooddata-api-client/docs/JsonApiOrganizationInAttributes.md @@ -2,22 +2,39 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**allowed_origins** | **[str]** | | [optional] -**early_access** | **str, none_type** | The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues. | [optional] -**early_access_values** | **[str], none_type** | The early access feature identifiers. They are used to enable experimental features. | [optional] +**allowed_origins** | **List[str]** | | [optional] +**early_access** | **str** | The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues. | [optional] +**early_access_values** | **List[str]** | The early access feature identifiers. They are used to enable experimental features. | [optional] **hostname** | **str** | | [optional] -**name** | **str, none_type** | | [optional] +**name** | **str** | | [optional] **oauth_client_id** | **str** | | [optional] **oauth_client_secret** | **str** | | [optional] -**oauth_custom_auth_attributes** | **{str: (str,)}** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] -**oauth_custom_scopes** | **[str], none_type** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] +**oauth_custom_auth_attributes** | **Dict[str, str]** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] +**oauth_custom_scopes** | **List[str]** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] **oauth_issuer_id** | **str** | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] **oauth_issuer_location** | **str** | | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_in_attributes import JsonApiOrganizationInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationInAttributes from a JSON string +json_api_organization_in_attributes_instance = JsonApiOrganizationInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationInAttributes.to_json()) + +# convert the object into a dict +json_api_organization_in_attributes_dict = json_api_organization_in_attributes_instance.to_dict() +# create an instance of JsonApiOrganizationInAttributes from a dict +json_api_organization_in_attributes_from_dict = JsonApiOrganizationInAttributes.from_dict(json_api_organization_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationInDocument.md b/gooddata-api-client/docs/JsonApiOrganizationInDocument.md index 29c61fbf0..c93284f51 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationInDocument.md +++ b/gooddata-api-client/docs/JsonApiOrganizationInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiOrganizationIn**](JsonApiOrganizationIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationInDocument from a JSON string +json_api_organization_in_document_instance = JsonApiOrganizationInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationInDocument.to_json()) + +# convert the object into a dict +json_api_organization_in_document_dict = json_api_organization_in_document_instance.to_dict() +# create an instance of JsonApiOrganizationInDocument from a dict +json_api_organization_in_document_from_dict = JsonApiOrganizationInDocument.from_dict(json_api_organization_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationInRelationships.md b/gooddata-api-client/docs/JsonApiOrganizationInRelationships.md index b7d37bca7..c458c8756 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationInRelationships.md +++ b/gooddata-api-client/docs/JsonApiOrganizationInRelationships.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identity_provider** | [**JsonApiOrganizationInRelationshipsIdentityProvider**](JsonApiOrganizationInRelationshipsIdentityProvider.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_in_relationships import JsonApiOrganizationInRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationInRelationships from a JSON string +json_api_organization_in_relationships_instance = JsonApiOrganizationInRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationInRelationships.to_json()) + +# convert the object into a dict +json_api_organization_in_relationships_dict = json_api_organization_in_relationships_instance.to_dict() +# create an instance of JsonApiOrganizationInRelationships from a dict +json_api_organization_in_relationships_from_dict = JsonApiOrganizationInRelationships.from_dict(json_api_organization_in_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationInRelationshipsIdentityProvider.md b/gooddata-api-client/docs/JsonApiOrganizationInRelationshipsIdentityProvider.md index 4398dca3b..2787c711e 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationInRelationshipsIdentityProvider.md +++ b/gooddata-api-client/docs/JsonApiOrganizationInRelationshipsIdentityProvider.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiIdentityProviderToOneLinkage**](JsonApiIdentityProviderToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_in_relationships_identity_provider import JsonApiOrganizationInRelationshipsIdentityProvider + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationInRelationshipsIdentityProvider from a JSON string +json_api_organization_in_relationships_identity_provider_instance = JsonApiOrganizationInRelationshipsIdentityProvider.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationInRelationshipsIdentityProvider.to_json()) + +# convert the object into a dict +json_api_organization_in_relationships_identity_provider_dict = json_api_organization_in_relationships_identity_provider_instance.to_dict() +# create an instance of JsonApiOrganizationInRelationshipsIdentityProvider from a dict +json_api_organization_in_relationships_identity_provider_from_dict = JsonApiOrganizationInRelationshipsIdentityProvider.from_dict(json_api_organization_in_relationships_identity_provider_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationOut.md b/gooddata-api-client/docs/JsonApiOrganizationOut.md index 70162f0f6..60e167529 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationOut.md +++ b/gooddata-api-client/docs/JsonApiOrganizationOut.md @@ -3,15 +3,32 @@ JSON:API representation of organization entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "organization" **attributes** | [**JsonApiOrganizationOutAttributes**](JsonApiOrganizationOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiOrganizationOutMeta**](JsonApiOrganizationOutMeta.md) | | [optional] **relationships** | [**JsonApiOrganizationOutRelationships**](JsonApiOrganizationOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_organization_out import JsonApiOrganizationOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationOut from a JSON string +json_api_organization_out_instance = JsonApiOrganizationOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationOut.to_json()) +# convert the object into a dict +json_api_organization_out_dict = json_api_organization_out_instance.to_dict() +# create an instance of JsonApiOrganizationOut from a dict +json_api_organization_out_from_dict = JsonApiOrganizationOut.from_dict(json_api_organization_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md b/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md index ec416ad3e..1fd5e377c 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md @@ -2,22 +2,39 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**allowed_origins** | **[str]** | | [optional] +**allowed_origins** | **List[str]** | | [optional] **cache_settings** | [**JsonApiOrganizationOutAttributesCacheSettings**](JsonApiOrganizationOutAttributesCacheSettings.md) | | [optional] -**early_access** | **str, none_type** | The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues. | [optional] -**early_access_values** | **[str], none_type** | The early access feature identifiers. They are used to enable experimental features. | [optional] +**early_access** | **str** | The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues. | [optional] +**early_access_values** | **List[str]** | The early access feature identifiers. They are used to enable experimental features. | [optional] **hostname** | **str** | | [optional] -**name** | **str, none_type** | | [optional] +**name** | **str** | | [optional] **oauth_client_id** | **str** | | [optional] -**oauth_custom_auth_attributes** | **{str: (str,)}** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] -**oauth_custom_scopes** | **[str], none_type** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] +**oauth_custom_auth_attributes** | **Dict[str, str]** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] +**oauth_custom_scopes** | **List[str]** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] **oauth_issuer_id** | **str** | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] **oauth_issuer_location** | **str** | | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_out_attributes import JsonApiOrganizationOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationOutAttributes from a JSON string +json_api_organization_out_attributes_instance = JsonApiOrganizationOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationOutAttributes.to_json()) + +# convert the object into a dict +json_api_organization_out_attributes_dict = json_api_organization_out_attributes_instance.to_dict() +# create an instance of JsonApiOrganizationOutAttributes from a dict +json_api_organization_out_attributes_from_dict = JsonApiOrganizationOutAttributes.from_dict(json_api_organization_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationOutAttributesCacheSettings.md b/gooddata-api-client/docs/JsonApiOrganizationOutAttributesCacheSettings.md index 169b1e882..00373548f 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationOutAttributesCacheSettings.md +++ b/gooddata-api-client/docs/JsonApiOrganizationOutAttributesCacheSettings.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **cache_strategy** | **str** | | [optional] **extra_cache_budget** | **int** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_out_attributes_cache_settings import JsonApiOrganizationOutAttributesCacheSettings + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationOutAttributesCacheSettings from a JSON string +json_api_organization_out_attributes_cache_settings_instance = JsonApiOrganizationOutAttributesCacheSettings.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationOutAttributesCacheSettings.to_json()) + +# convert the object into a dict +json_api_organization_out_attributes_cache_settings_dict = json_api_organization_out_attributes_cache_settings_instance.to_dict() +# create an instance of JsonApiOrganizationOutAttributesCacheSettings from a dict +json_api_organization_out_attributes_cache_settings_from_dict = JsonApiOrganizationOutAttributesCacheSettings.from_dict(json_api_organization_out_attributes_cache_settings_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationOutDocument.md b/gooddata-api-client/docs/JsonApiOrganizationOutDocument.md index a37fd7f87..953c52a62 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationOutDocument.md +++ b/gooddata-api-client/docs/JsonApiOrganizationOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiOrganizationOut**](JsonApiOrganizationOut.md) | | -**included** | [**[JsonApiOrganizationOutIncludes]**](JsonApiOrganizationOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiOrganizationOutIncludes]**](JsonApiOrganizationOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationOutDocument from a JSON string +json_api_organization_out_document_instance = JsonApiOrganizationOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationOutDocument.to_json()) + +# convert the object into a dict +json_api_organization_out_document_dict = json_api_organization_out_document_instance.to_dict() +# create an instance of JsonApiOrganizationOutDocument from a dict +json_api_organization_out_document_from_dict = JsonApiOrganizationOutDocument.from_dict(json_api_organization_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationOutIncludes.md b/gooddata-api-client/docs/JsonApiOrganizationOutIncludes.md index e6a140838..b5445317b 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiOrganizationOutIncludes.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiIdentityProviderOutAttributes**](JsonApiIdentityProviderOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiUserGroupInRelationships**](JsonApiUserGroupInRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "identityProvider" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_out_includes import JsonApiOrganizationOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationOutIncludes from a JSON string +json_api_organization_out_includes_instance = JsonApiOrganizationOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationOutIncludes.to_json()) + +# convert the object into a dict +json_api_organization_out_includes_dict = json_api_organization_out_includes_instance.to_dict() +# create an instance of JsonApiOrganizationOutIncludes from a dict +json_api_organization_out_includes_from_dict = JsonApiOrganizationOutIncludes.from_dict(json_api_organization_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationOutMeta.md b/gooddata-api-client/docs/JsonApiOrganizationOutMeta.md index 1b2245eb7..f14575888 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationOutMeta.md +++ b/gooddata-api-client/docs/JsonApiOrganizationOutMeta.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permissions** | **[str]** | List of valid permissions for a logged-in user. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | **List[str]** | List of valid permissions for a logged-in user. | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_organization_out_meta import JsonApiOrganizationOutMeta + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationOutMeta from a JSON string +json_api_organization_out_meta_instance = JsonApiOrganizationOutMeta.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationOutMeta.to_json()) +# convert the object into a dict +json_api_organization_out_meta_dict = json_api_organization_out_meta_instance.to_dict() +# create an instance of JsonApiOrganizationOutMeta from a dict +json_api_organization_out_meta_from_dict = JsonApiOrganizationOutMeta.from_dict(json_api_organization_out_meta_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationOutRelationships.md b/gooddata-api-client/docs/JsonApiOrganizationOutRelationships.md index 1a4ce9d5b..1a12c46e2 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiOrganizationOutRelationships.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bootstrap_user** | [**JsonApiFilterViewInRelationshipsUser**](JsonApiFilterViewInRelationshipsUser.md) | | [optional] **bootstrap_user_group** | [**JsonApiOrganizationOutRelationshipsBootstrapUserGroup**](JsonApiOrganizationOutRelationshipsBootstrapUserGroup.md) | | [optional] **identity_provider** | [**JsonApiOrganizationInRelationshipsIdentityProvider**](JsonApiOrganizationInRelationshipsIdentityProvider.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_out_relationships import JsonApiOrganizationOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationOutRelationships from a JSON string +json_api_organization_out_relationships_instance = JsonApiOrganizationOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationOutRelationships.to_json()) + +# convert the object into a dict +json_api_organization_out_relationships_dict = json_api_organization_out_relationships_instance.to_dict() +# create an instance of JsonApiOrganizationOutRelationships from a dict +json_api_organization_out_relationships_from_dict = JsonApiOrganizationOutRelationships.from_dict(json_api_organization_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationOutRelationshipsBootstrapUserGroup.md b/gooddata-api-client/docs/JsonApiOrganizationOutRelationshipsBootstrapUserGroup.md index 8855a203b..6246f4da4 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationOutRelationshipsBootstrapUserGroup.md +++ b/gooddata-api-client/docs/JsonApiOrganizationOutRelationshipsBootstrapUserGroup.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserGroupToOneLinkage**](JsonApiUserGroupToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_out_relationships_bootstrap_user_group import JsonApiOrganizationOutRelationshipsBootstrapUserGroup + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationOutRelationshipsBootstrapUserGroup from a JSON string +json_api_organization_out_relationships_bootstrap_user_group_instance = JsonApiOrganizationOutRelationshipsBootstrapUserGroup.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationOutRelationshipsBootstrapUserGroup.to_json()) + +# convert the object into a dict +json_api_organization_out_relationships_bootstrap_user_group_dict = json_api_organization_out_relationships_bootstrap_user_group_instance.to_dict() +# create an instance of JsonApiOrganizationOutRelationshipsBootstrapUserGroup from a dict +json_api_organization_out_relationships_bootstrap_user_group_from_dict = JsonApiOrganizationOutRelationshipsBootstrapUserGroup.from_dict(json_api_organization_out_relationships_bootstrap_user_group_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationPatch.md b/gooddata-api-client/docs/JsonApiOrganizationPatch.md index 8d4d7ce20..5f8219287 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationPatch.md +++ b/gooddata-api-client/docs/JsonApiOrganizationPatch.md @@ -3,14 +3,31 @@ JSON:API representation of patching organization entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "organization" **attributes** | [**JsonApiOrganizationInAttributes**](JsonApiOrganizationInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiOrganizationInRelationships**](JsonApiOrganizationInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_organization_patch import JsonApiOrganizationPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationPatch from a JSON string +json_api_organization_patch_instance = JsonApiOrganizationPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationPatch.to_json()) +# convert the object into a dict +json_api_organization_patch_dict = json_api_organization_patch_instance.to_dict() +# create an instance of JsonApiOrganizationPatch from a dict +json_api_organization_patch_from_dict = JsonApiOrganizationPatch.from_dict(json_api_organization_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationPatchDocument.md b/gooddata-api-client/docs/JsonApiOrganizationPatchDocument.md index 9b76a7db5..aa35d968f 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiOrganizationPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiOrganizationPatch**](JsonApiOrganizationPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationPatchDocument from a JSON string +json_api_organization_patch_document_instance = JsonApiOrganizationPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationPatchDocument.to_json()) + +# convert the object into a dict +json_api_organization_patch_document_dict = json_api_organization_patch_document_instance.to_dict() +# create an instance of JsonApiOrganizationPatchDocument from a dict +json_api_organization_patch_document_from_dict = JsonApiOrganizationPatchDocument.from_dict(json_api_organization_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationSettingIn.md b/gooddata-api-client/docs/JsonApiOrganizationSettingIn.md index 6d45f8a5b..aa40b4796 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationSettingIn.md +++ b/gooddata-api-client/docs/JsonApiOrganizationSettingIn.md @@ -3,13 +3,30 @@ JSON:API representation of organizationSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "organizationSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_organization_setting_in import JsonApiOrganizationSettingIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationSettingIn from a JSON string +json_api_organization_setting_in_instance = JsonApiOrganizationSettingIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationSettingIn.to_json()) +# convert the object into a dict +json_api_organization_setting_in_dict = json_api_organization_setting_in_instance.to_dict() +# create an instance of JsonApiOrganizationSettingIn from a dict +json_api_organization_setting_in_from_dict = JsonApiOrganizationSettingIn.from_dict(json_api_organization_setting_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationSettingInAttributes.md b/gooddata-api-client/docs/JsonApiOrganizationSettingInAttributes.md index 412759fa6..6d500601c 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationSettingInAttributes.md +++ b/gooddata-api-client/docs/JsonApiOrganizationSettingInAttributes.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] **type** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationSettingInAttributes from a JSON string +json_api_organization_setting_in_attributes_instance = JsonApiOrganizationSettingInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationSettingInAttributes.to_json()) + +# convert the object into a dict +json_api_organization_setting_in_attributes_dict = json_api_organization_setting_in_attributes_instance.to_dict() +# create an instance of JsonApiOrganizationSettingInAttributes from a dict +json_api_organization_setting_in_attributes_from_dict = JsonApiOrganizationSettingInAttributes.from_dict(json_api_organization_setting_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationSettingInDocument.md b/gooddata-api-client/docs/JsonApiOrganizationSettingInDocument.md index 06e974ff0..44114a54f 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationSettingInDocument.md +++ b/gooddata-api-client/docs/JsonApiOrganizationSettingInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiOrganizationSettingIn**](JsonApiOrganizationSettingIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationSettingInDocument from a JSON string +json_api_organization_setting_in_document_instance = JsonApiOrganizationSettingInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationSettingInDocument.to_json()) + +# convert the object into a dict +json_api_organization_setting_in_document_dict = json_api_organization_setting_in_document_instance.to_dict() +# create an instance of JsonApiOrganizationSettingInDocument from a dict +json_api_organization_setting_in_document_from_dict = JsonApiOrganizationSettingInDocument.from_dict(json_api_organization_setting_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationSettingOut.md b/gooddata-api-client/docs/JsonApiOrganizationSettingOut.md index d0493d859..38980c547 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationSettingOut.md +++ b/gooddata-api-client/docs/JsonApiOrganizationSettingOut.md @@ -3,13 +3,30 @@ JSON:API representation of organizationSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "organizationSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_organization_setting_out import JsonApiOrganizationSettingOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationSettingOut from a JSON string +json_api_organization_setting_out_instance = JsonApiOrganizationSettingOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationSettingOut.to_json()) +# convert the object into a dict +json_api_organization_setting_out_dict = json_api_organization_setting_out_instance.to_dict() +# create an instance of JsonApiOrganizationSettingOut from a dict +json_api_organization_setting_out_from_dict = JsonApiOrganizationSettingOut.from_dict(json_api_organization_setting_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationSettingOutDocument.md b/gooddata-api-client/docs/JsonApiOrganizationSettingOutDocument.md index 90c9e3026..12d93e660 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationSettingOutDocument.md +++ b/gooddata-api-client/docs/JsonApiOrganizationSettingOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiOrganizationSettingOut**](JsonApiOrganizationSettingOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationSettingOutDocument from a JSON string +json_api_organization_setting_out_document_instance = JsonApiOrganizationSettingOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationSettingOutDocument.to_json()) + +# convert the object into a dict +json_api_organization_setting_out_document_dict = json_api_organization_setting_out_document_instance.to_dict() +# create an instance of JsonApiOrganizationSettingOutDocument from a dict +json_api_organization_setting_out_document_from_dict = JsonApiOrganizationSettingOutDocument.from_dict(json_api_organization_setting_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationSettingOutList.md b/gooddata-api-client/docs/JsonApiOrganizationSettingOutList.md index 5e8c7b9c2..cd95cc1c6 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationSettingOutList.md +++ b/gooddata-api-client/docs/JsonApiOrganizationSettingOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiOrganizationSettingOutWithLinks]**](JsonApiOrganizationSettingOutWithLinks.md) | | +**data** | [**List[JsonApiOrganizationSettingOutWithLinks]**](JsonApiOrganizationSettingOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationSettingOutList from a JSON string +json_api_organization_setting_out_list_instance = JsonApiOrganizationSettingOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationSettingOutList.to_json()) + +# convert the object into a dict +json_api_organization_setting_out_list_dict = json_api_organization_setting_out_list_instance.to_dict() +# create an instance of JsonApiOrganizationSettingOutList from a dict +json_api_organization_setting_out_list_from_dict = JsonApiOrganizationSettingOutList.from_dict(json_api_organization_setting_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationSettingOutWithLinks.md b/gooddata-api-client/docs/JsonApiOrganizationSettingOutWithLinks.md index d2ba2f3fe..d40f63af9 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationSettingOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiOrganizationSettingOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "organizationSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_setting_out_with_links import JsonApiOrganizationSettingOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationSettingOutWithLinks from a JSON string +json_api_organization_setting_out_with_links_instance = JsonApiOrganizationSettingOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationSettingOutWithLinks.to_json()) + +# convert the object into a dict +json_api_organization_setting_out_with_links_dict = json_api_organization_setting_out_with_links_instance.to_dict() +# create an instance of JsonApiOrganizationSettingOutWithLinks from a dict +json_api_organization_setting_out_with_links_from_dict = JsonApiOrganizationSettingOutWithLinks.from_dict(json_api_organization_setting_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationSettingPatch.md b/gooddata-api-client/docs/JsonApiOrganizationSettingPatch.md index 18b0eba2f..dde8fee2a 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationSettingPatch.md +++ b/gooddata-api-client/docs/JsonApiOrganizationSettingPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching organizationSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "organizationSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_organization_setting_patch import JsonApiOrganizationSettingPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationSettingPatch from a JSON string +json_api_organization_setting_patch_instance = JsonApiOrganizationSettingPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationSettingPatch.to_json()) +# convert the object into a dict +json_api_organization_setting_patch_dict = json_api_organization_setting_patch_instance.to_dict() +# create an instance of JsonApiOrganizationSettingPatch from a dict +json_api_organization_setting_patch_from_dict = JsonApiOrganizationSettingPatch.from_dict(json_api_organization_setting_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiOrganizationSettingPatchDocument.md b/gooddata-api-client/docs/JsonApiOrganizationSettingPatchDocument.md index 8c120f31a..c92cd41f7 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationSettingPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiOrganizationSettingPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiOrganizationSettingPatch**](JsonApiOrganizationSettingPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiOrganizationSettingPatchDocument from a JSON string +json_api_organization_setting_patch_document_instance = JsonApiOrganizationSettingPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiOrganizationSettingPatchDocument.to_json()) + +# convert the object into a dict +json_api_organization_setting_patch_document_dict = json_api_organization_setting_patch_document_instance.to_dict() +# create an instance of JsonApiOrganizationSettingPatchDocument from a dict +json_api_organization_setting_patch_document_from_dict = JsonApiOrganizationSettingPatchDocument.from_dict(json_api_organization_setting_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiThemeIn.md b/gooddata-api-client/docs/JsonApiThemeIn.md index 31cd70cc6..660f181bb 100644 --- a/gooddata-api-client/docs/JsonApiThemeIn.md +++ b/gooddata-api-client/docs/JsonApiThemeIn.md @@ -3,13 +3,30 @@ JSON:API representation of theme entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "theme" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_theme_in import JsonApiThemeIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiThemeIn from a JSON string +json_api_theme_in_instance = JsonApiThemeIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiThemeIn.to_json()) +# convert the object into a dict +json_api_theme_in_dict = json_api_theme_in_instance.to_dict() +# create an instance of JsonApiThemeIn from a dict +json_api_theme_in_from_dict = JsonApiThemeIn.from_dict(json_api_theme_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiThemeInDocument.md b/gooddata-api-client/docs/JsonApiThemeInDocument.md index 9e2395a65..bc0de9a52 100644 --- a/gooddata-api-client/docs/JsonApiThemeInDocument.md +++ b/gooddata-api-client/docs/JsonApiThemeInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiThemeIn**](JsonApiThemeIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiThemeInDocument from a JSON string +json_api_theme_in_document_instance = JsonApiThemeInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiThemeInDocument.to_json()) + +# convert the object into a dict +json_api_theme_in_document_dict = json_api_theme_in_document_instance.to_dict() +# create an instance of JsonApiThemeInDocument from a dict +json_api_theme_in_document_from_dict = JsonApiThemeInDocument.from_dict(json_api_theme_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiThemeOut.md b/gooddata-api-client/docs/JsonApiThemeOut.md index c240339ab..80cf1b133 100644 --- a/gooddata-api-client/docs/JsonApiThemeOut.md +++ b/gooddata-api-client/docs/JsonApiThemeOut.md @@ -3,13 +3,30 @@ JSON:API representation of theme entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "theme" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_theme_out import JsonApiThemeOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiThemeOut from a JSON string +json_api_theme_out_instance = JsonApiThemeOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiThemeOut.to_json()) +# convert the object into a dict +json_api_theme_out_dict = json_api_theme_out_instance.to_dict() +# create an instance of JsonApiThemeOut from a dict +json_api_theme_out_from_dict = JsonApiThemeOut.from_dict(json_api_theme_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiThemeOutDocument.md b/gooddata-api-client/docs/JsonApiThemeOutDocument.md index 4f5c178df..187b05910 100644 --- a/gooddata-api-client/docs/JsonApiThemeOutDocument.md +++ b/gooddata-api-client/docs/JsonApiThemeOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiThemeOut**](JsonApiThemeOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiThemeOutDocument from a JSON string +json_api_theme_out_document_instance = JsonApiThemeOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiThemeOutDocument.to_json()) + +# convert the object into a dict +json_api_theme_out_document_dict = json_api_theme_out_document_instance.to_dict() +# create an instance of JsonApiThemeOutDocument from a dict +json_api_theme_out_document_from_dict = JsonApiThemeOutDocument.from_dict(json_api_theme_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiThemeOutList.md b/gooddata-api-client/docs/JsonApiThemeOutList.md index ded1087dd..9c1067e1b 100644 --- a/gooddata-api-client/docs/JsonApiThemeOutList.md +++ b/gooddata-api-client/docs/JsonApiThemeOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiThemeOutWithLinks]**](JsonApiThemeOutWithLinks.md) | | +**data** | [**List[JsonApiThemeOutWithLinks]**](JsonApiThemeOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiThemeOutList from a JSON string +json_api_theme_out_list_instance = JsonApiThemeOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiThemeOutList.to_json()) + +# convert the object into a dict +json_api_theme_out_list_dict = json_api_theme_out_list_instance.to_dict() +# create an instance of JsonApiThemeOutList from a dict +json_api_theme_out_list_from_dict = JsonApiThemeOutList.from_dict(json_api_theme_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiThemeOutWithLinks.md b/gooddata-api-client/docs/JsonApiThemeOutWithLinks.md index 0181293e0..b70bc0bd5 100644 --- a/gooddata-api-client/docs/JsonApiThemeOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiThemeOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "theme" +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_theme_out_with_links import JsonApiThemeOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiThemeOutWithLinks from a JSON string +json_api_theme_out_with_links_instance = JsonApiThemeOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiThemeOutWithLinks.to_json()) + +# convert the object into a dict +json_api_theme_out_with_links_dict = json_api_theme_out_with_links_instance.to_dict() +# create an instance of JsonApiThemeOutWithLinks from a dict +json_api_theme_out_with_links_from_dict = JsonApiThemeOutWithLinks.from_dict(json_api_theme_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiThemePatch.md b/gooddata-api-client/docs/JsonApiThemePatch.md index ccfbce3a3..0051e438a 100644 --- a/gooddata-api-client/docs/JsonApiThemePatch.md +++ b/gooddata-api-client/docs/JsonApiThemePatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching theme entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiColorPalettePatchAttributes**](JsonApiColorPalettePatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "theme" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_theme_patch import JsonApiThemePatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiThemePatch from a JSON string +json_api_theme_patch_instance = JsonApiThemePatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiThemePatch.to_json()) +# convert the object into a dict +json_api_theme_patch_dict = json_api_theme_patch_instance.to_dict() +# create an instance of JsonApiThemePatch from a dict +json_api_theme_patch_from_dict = JsonApiThemePatch.from_dict(json_api_theme_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiThemePatchDocument.md b/gooddata-api-client/docs/JsonApiThemePatchDocument.md index 14352fd8f..0a8f4b7aa 100644 --- a/gooddata-api-client/docs/JsonApiThemePatchDocument.md +++ b/gooddata-api-client/docs/JsonApiThemePatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiThemePatch**](JsonApiThemePatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiThemePatchDocument from a JSON string +json_api_theme_patch_document_instance = JsonApiThemePatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiThemePatchDocument.to_json()) + +# convert the object into a dict +json_api_theme_patch_document_dict = json_api_theme_patch_document_instance.to_dict() +# create an instance of JsonApiThemePatchDocument from a dict +json_api_theme_patch_document_from_dict = JsonApiThemePatchDocument.from_dict(json_api_theme_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterIn.md b/gooddata-api-client/docs/JsonApiUserDataFilterIn.md index c68e6f933..e0fb53265 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterIn.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterIn.md @@ -3,14 +3,31 @@ JSON:API representation of userDataFilter entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiUserDataFilterInAttributes**](JsonApiUserDataFilterInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userDataFilter" **relationships** | [**JsonApiUserDataFilterInRelationships**](JsonApiUserDataFilterInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_in import JsonApiUserDataFilterIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterIn from a JSON string +json_api_user_data_filter_in_instance = JsonApiUserDataFilterIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterIn.to_json()) +# convert the object into a dict +json_api_user_data_filter_in_dict = json_api_user_data_filter_in_instance.to_dict() +# create an instance of JsonApiUserDataFilterIn from a dict +json_api_user_data_filter_in_from_dict = JsonApiUserDataFilterIn.from_dict(json_api_user_data_filter_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterInAttributes.md b/gooddata-api-client/docs/JsonApiUserDataFilterInAttributes.md index e57c8d07f..1f271c965 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterInAttributes.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterInAttributes.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**maql** | **str** | | **are_relations_valid** | **bool** | | [optional] **description** | **str** | | [optional] -**tags** | **[str]** | | [optional] +**maql** | **str** | | +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterInAttributes from a JSON string +json_api_user_data_filter_in_attributes_instance = JsonApiUserDataFilterInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterInAttributes.to_json()) + +# convert the object into a dict +json_api_user_data_filter_in_attributes_dict = json_api_user_data_filter_in_attributes_instance.to_dict() +# create an instance of JsonApiUserDataFilterInAttributes from a dict +json_api_user_data_filter_in_attributes_from_dict = JsonApiUserDataFilterInAttributes.from_dict(json_api_user_data_filter_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterInDocument.md b/gooddata-api-client/docs/JsonApiUserDataFilterInDocument.md index 5969ba575..b944c3c4c 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterInDocument.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserDataFilterIn**](JsonApiUserDataFilterIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterInDocument from a JSON string +json_api_user_data_filter_in_document_instance = JsonApiUserDataFilterInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterInDocument.to_json()) + +# convert the object into a dict +json_api_user_data_filter_in_document_dict = json_api_user_data_filter_in_document_instance.to_dict() +# create an instance of JsonApiUserDataFilterInDocument from a dict +json_api_user_data_filter_in_document_from_dict = JsonApiUserDataFilterInDocument.from_dict(json_api_user_data_filter_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterInRelationships.md b/gooddata-api-client/docs/JsonApiUserDataFilterInRelationships.md index fda96c238..8382f193f 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterInRelationships.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterInRelationships.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **user** | [**JsonApiFilterViewInRelationshipsUser**](JsonApiFilterViewInRelationshipsUser.md) | | [optional] **user_group** | [**JsonApiOrganizationOutRelationshipsBootstrapUserGroup**](JsonApiOrganizationOutRelationshipsBootstrapUserGroup.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterInRelationships from a JSON string +json_api_user_data_filter_in_relationships_instance = JsonApiUserDataFilterInRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterInRelationships.to_json()) + +# convert the object into a dict +json_api_user_data_filter_in_relationships_dict = json_api_user_data_filter_in_relationships_instance.to_dict() +# create an instance of JsonApiUserDataFilterInRelationships from a dict +json_api_user_data_filter_in_relationships_from_dict = JsonApiUserDataFilterInRelationships.from_dict(json_api_user_data_filter_in_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterOut.md b/gooddata-api-client/docs/JsonApiUserDataFilterOut.md index e1224d4ae..c7f52b816 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterOut.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterOut.md @@ -3,15 +3,32 @@ JSON:API representation of userDataFilter entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiUserDataFilterInAttributes**](JsonApiUserDataFilterInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userDataFilter" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiUserDataFilterOutRelationships**](JsonApiUserDataFilterOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_out import JsonApiUserDataFilterOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterOut from a JSON string +json_api_user_data_filter_out_instance = JsonApiUserDataFilterOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterOut.to_json()) +# convert the object into a dict +json_api_user_data_filter_out_dict = json_api_user_data_filter_out_instance.to_dict() +# create an instance of JsonApiUserDataFilterOut from a dict +json_api_user_data_filter_out_from_dict = JsonApiUserDataFilterOut.from_dict(json_api_user_data_filter_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterOutDocument.md b/gooddata-api-client/docs/JsonApiUserDataFilterOutDocument.md index 2d18a32a6..970515845 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterOutDocument.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserDataFilterOut**](JsonApiUserDataFilterOut.md) | | -**included** | [**[JsonApiUserDataFilterOutIncludes]**](JsonApiUserDataFilterOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiUserDataFilterOutIncludes]**](JsonApiUserDataFilterOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterOutDocument from a JSON string +json_api_user_data_filter_out_document_instance = JsonApiUserDataFilterOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterOutDocument.to_json()) + +# convert the object into a dict +json_api_user_data_filter_out_document_dict = json_api_user_data_filter_out_document_instance.to_dict() +# create an instance of JsonApiUserDataFilterOutDocument from a dict +json_api_user_data_filter_out_document_from_dict = JsonApiUserDataFilterOutDocument.from_dict(json_api_user_data_filter_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterOutIncludes.md b/gooddata-api-client/docs/JsonApiUserDataFilterOutIncludes.md index d86a704e0..7e93c85fa 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiDatasetOutAttributes**](JsonApiDatasetOutAttributes.md) | | +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiDatasetOutRelationships**](JsonApiDatasetOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**attributes** | [**JsonApiDatasetOutAttributes**](JsonApiDatasetOutAttributes.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "dataset" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterOutIncludes from a JSON string +json_api_user_data_filter_out_includes_instance = JsonApiUserDataFilterOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterOutIncludes.to_json()) + +# convert the object into a dict +json_api_user_data_filter_out_includes_dict = json_api_user_data_filter_out_includes_instance.to_dict() +# create an instance of JsonApiUserDataFilterOutIncludes from a dict +json_api_user_data_filter_out_includes_from_dict = JsonApiUserDataFilterOutIncludes.from_dict(json_api_user_data_filter_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterOutList.md b/gooddata-api-client/docs/JsonApiUserDataFilterOutList.md index 55f26c1f3..26c36696c 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterOutList.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiUserDataFilterOutWithLinks]**](JsonApiUserDataFilterOutWithLinks.md) | | -**included** | [**[JsonApiUserDataFilterOutIncludes]**](JsonApiUserDataFilterOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiUserDataFilterOutWithLinks]**](JsonApiUserDataFilterOutWithLinks.md) | | +**included** | [**List[JsonApiUserDataFilterOutIncludes]**](JsonApiUserDataFilterOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterOutList from a JSON string +json_api_user_data_filter_out_list_instance = JsonApiUserDataFilterOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterOutList.to_json()) + +# convert the object into a dict +json_api_user_data_filter_out_list_dict = json_api_user_data_filter_out_list_instance.to_dict() +# create an instance of JsonApiUserDataFilterOutList from a dict +json_api_user_data_filter_out_list_from_dict = JsonApiUserDataFilterOutList.from_dict(json_api_user_data_filter_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterOutRelationships.md b/gooddata-api-client/docs/JsonApiUserDataFilterOutRelationships.md index 9ca9927ac..8a401539c 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterOutRelationships.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAttributeHierarchyOutRelationshipsAttributes**](JsonApiAttributeHierarchyOutRelationshipsAttributes.md) | | [optional] @@ -11,8 +12,24 @@ Name | Type | Description | Notes **metrics** | [**JsonApiAnalyticalDashboardOutRelationshipsMetrics**](JsonApiAnalyticalDashboardOutRelationshipsMetrics.md) | | [optional] **user** | [**JsonApiFilterViewInRelationshipsUser**](JsonApiFilterViewInRelationshipsUser.md) | | [optional] **user_group** | [**JsonApiOrganizationOutRelationshipsBootstrapUserGroup**](JsonApiOrganizationOutRelationshipsBootstrapUserGroup.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_out_relationships import JsonApiUserDataFilterOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterOutRelationships from a JSON string +json_api_user_data_filter_out_relationships_instance = JsonApiUserDataFilterOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterOutRelationships.to_json()) + +# convert the object into a dict +json_api_user_data_filter_out_relationships_dict = json_api_user_data_filter_out_relationships_instance.to_dict() +# create an instance of JsonApiUserDataFilterOutRelationships from a dict +json_api_user_data_filter_out_relationships_from_dict = JsonApiUserDataFilterOutRelationships.from_dict(json_api_user_data_filter_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterOutWithLinks.md b/gooddata-api-client/docs/JsonApiUserDataFilterOutWithLinks.md index 02ba1c104..7cd663af8 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiUserDataFilterInAttributes**](JsonApiUserDataFilterInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userDataFilter" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiUserDataFilterOutRelationships**](JsonApiUserDataFilterOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_out_with_links import JsonApiUserDataFilterOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterOutWithLinks from a JSON string +json_api_user_data_filter_out_with_links_instance = JsonApiUserDataFilterOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterOutWithLinks.to_json()) + +# convert the object into a dict +json_api_user_data_filter_out_with_links_dict = json_api_user_data_filter_out_with_links_instance.to_dict() +# create an instance of JsonApiUserDataFilterOutWithLinks from a dict +json_api_user_data_filter_out_with_links_from_dict = JsonApiUserDataFilterOutWithLinks.from_dict(json_api_user_data_filter_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterPatch.md b/gooddata-api-client/docs/JsonApiUserDataFilterPatch.md index 83eb20a39..7f56558bd 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterPatch.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterPatch.md @@ -3,14 +3,31 @@ JSON:API representation of patching userDataFilter entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiUserDataFilterPatchAttributes**](JsonApiUserDataFilterPatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userDataFilter" **relationships** | [**JsonApiUserDataFilterInRelationships**](JsonApiUserDataFilterInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_patch import JsonApiUserDataFilterPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterPatch from a JSON string +json_api_user_data_filter_patch_instance = JsonApiUserDataFilterPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterPatch.to_json()) +# convert the object into a dict +json_api_user_data_filter_patch_dict = json_api_user_data_filter_patch_instance.to_dict() +# create an instance of JsonApiUserDataFilterPatch from a dict +json_api_user_data_filter_patch_from_dict = JsonApiUserDataFilterPatch.from_dict(json_api_user_data_filter_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterPatchAttributes.md b/gooddata-api-client/docs/JsonApiUserDataFilterPatchAttributes.md index 1bedbfb5e..7e6b1b105 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterPatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterPatchAttributes.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] **description** | **str** | | [optional] **maql** | **str** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_patch_attributes import JsonApiUserDataFilterPatchAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterPatchAttributes from a JSON string +json_api_user_data_filter_patch_attributes_instance = JsonApiUserDataFilterPatchAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterPatchAttributes.to_json()) + +# convert the object into a dict +json_api_user_data_filter_patch_attributes_dict = json_api_user_data_filter_patch_attributes_instance.to_dict() +# create an instance of JsonApiUserDataFilterPatchAttributes from a dict +json_api_user_data_filter_patch_attributes_from_dict = JsonApiUserDataFilterPatchAttributes.from_dict(json_api_user_data_filter_patch_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterPatchDocument.md b/gooddata-api-client/docs/JsonApiUserDataFilterPatchDocument.md index 202ed1d72..1a4b0a99b 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserDataFilterPatch**](JsonApiUserDataFilterPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterPatchDocument from a JSON string +json_api_user_data_filter_patch_document_instance = JsonApiUserDataFilterPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterPatchDocument.to_json()) + +# convert the object into a dict +json_api_user_data_filter_patch_document_dict = json_api_user_data_filter_patch_document_instance.to_dict() +# create an instance of JsonApiUserDataFilterPatchDocument from a dict +json_api_user_data_filter_patch_document_from_dict = JsonApiUserDataFilterPatchDocument.from_dict(json_api_user_data_filter_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterPostOptionalId.md b/gooddata-api-client/docs/JsonApiUserDataFilterPostOptionalId.md index caf9dcb08..c7f16694c 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterPostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterPostOptionalId.md @@ -3,14 +3,31 @@ JSON:API representation of userDataFilter entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiUserDataFilterInAttributes**](JsonApiUserDataFilterInAttributes.md) | | -**type** | **str** | Object type | defaults to "userDataFilter" **id** | **str** | API identifier of an object | [optional] **relationships** | [**JsonApiUserDataFilterInRelationships**](JsonApiUserDataFilterInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id import JsonApiUserDataFilterPostOptionalId + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterPostOptionalId from a JSON string +json_api_user_data_filter_post_optional_id_instance = JsonApiUserDataFilterPostOptionalId.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterPostOptionalId.to_json()) +# convert the object into a dict +json_api_user_data_filter_post_optional_id_dict = json_api_user_data_filter_post_optional_id_instance.to_dict() +# create an instance of JsonApiUserDataFilterPostOptionalId from a dict +json_api_user_data_filter_post_optional_id_from_dict = JsonApiUserDataFilterPostOptionalId.from_dict(json_api_user_data_filter_post_optional_id_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserDataFilterPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiUserDataFilterPostOptionalIdDocument.md index 8a294fab4..c104c7a58 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterPostOptionalIdDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserDataFilterPostOptionalId**](JsonApiUserDataFilterPostOptionalId.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserDataFilterPostOptionalIdDocument from a JSON string +json_api_user_data_filter_post_optional_id_document_instance = JsonApiUserDataFilterPostOptionalIdDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserDataFilterPostOptionalIdDocument.to_json()) + +# convert the object into a dict +json_api_user_data_filter_post_optional_id_document_dict = json_api_user_data_filter_post_optional_id_document_instance.to_dict() +# create an instance of JsonApiUserDataFilterPostOptionalIdDocument from a dict +json_api_user_data_filter_post_optional_id_document_from_dict = JsonApiUserDataFilterPostOptionalIdDocument.from_dict(json_api_user_data_filter_post_optional_id_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupIn.md b/gooddata-api-client/docs/JsonApiUserGroupIn.md index f020c6d1f..6b77d2588 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupIn.md +++ b/gooddata-api-client/docs/JsonApiUserGroupIn.md @@ -3,14 +3,31 @@ JSON:API representation of userGroup entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userGroup" **attributes** | [**JsonApiUserGroupInAttributes**](JsonApiUserGroupInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiUserGroupInRelationships**](JsonApiUserGroupInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_group_in import JsonApiUserGroupIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupIn from a JSON string +json_api_user_group_in_instance = JsonApiUserGroupIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupIn.to_json()) +# convert the object into a dict +json_api_user_group_in_dict = json_api_user_group_in_instance.to_dict() +# create an instance of JsonApiUserGroupIn from a dict +json_api_user_group_in_from_dict = JsonApiUserGroupIn.from_dict(json_api_user_group_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupInAttributes.md b/gooddata-api-client/docs/JsonApiUserGroupInAttributes.md index 341c00abb..d939b9d1f 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupInAttributes.md +++ b/gooddata-api-client/docs/JsonApiUserGroupInAttributes.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupInAttributes from a JSON string +json_api_user_group_in_attributes_instance = JsonApiUserGroupInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupInAttributes.to_json()) + +# convert the object into a dict +json_api_user_group_in_attributes_dict = json_api_user_group_in_attributes_instance.to_dict() +# create an instance of JsonApiUserGroupInAttributes from a dict +json_api_user_group_in_attributes_from_dict = JsonApiUserGroupInAttributes.from_dict(json_api_user_group_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupInDocument.md b/gooddata-api-client/docs/JsonApiUserGroupInDocument.md index 3b2d3c722..24d5460c1 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupInDocument.md +++ b/gooddata-api-client/docs/JsonApiUserGroupInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserGroupIn**](JsonApiUserGroupIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupInDocument from a JSON string +json_api_user_group_in_document_instance = JsonApiUserGroupInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupInDocument.to_json()) + +# convert the object into a dict +json_api_user_group_in_document_dict = json_api_user_group_in_document_instance.to_dict() +# create an instance of JsonApiUserGroupInDocument from a dict +json_api_user_group_in_document_from_dict = JsonApiUserGroupInDocument.from_dict(json_api_user_group_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupInRelationships.md b/gooddata-api-client/docs/JsonApiUserGroupInRelationships.md index 36443afbf..c6fe89aa1 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupInRelationships.md +++ b/gooddata-api-client/docs/JsonApiUserGroupInRelationships.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **parents** | [**JsonApiUserGroupInRelationshipsParents**](JsonApiUserGroupInRelationshipsParents.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupInRelationships from a JSON string +json_api_user_group_in_relationships_instance = JsonApiUserGroupInRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupInRelationships.to_json()) + +# convert the object into a dict +json_api_user_group_in_relationships_dict = json_api_user_group_in_relationships_instance.to_dict() +# create an instance of JsonApiUserGroupInRelationships from a dict +json_api_user_group_in_relationships_from_dict = JsonApiUserGroupInRelationships.from_dict(json_api_user_group_in_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupInRelationshipsParents.md b/gooddata-api-client/docs/JsonApiUserGroupInRelationshipsParents.md index c2eb56df2..bb2f8327f 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupInRelationshipsParents.md +++ b/gooddata-api-client/docs/JsonApiUserGroupInRelationshipsParents.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiUserGroupToManyLinkage**](JsonApiUserGroupToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiUserGroupLinkage]**](JsonApiUserGroupLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_user_group_in_relationships_parents import JsonApiUserGroupInRelationshipsParents + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupInRelationshipsParents from a JSON string +json_api_user_group_in_relationships_parents_instance = JsonApiUserGroupInRelationshipsParents.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupInRelationshipsParents.to_json()) +# convert the object into a dict +json_api_user_group_in_relationships_parents_dict = json_api_user_group_in_relationships_parents_instance.to_dict() +# create an instance of JsonApiUserGroupInRelationshipsParents from a dict +json_api_user_group_in_relationships_parents_from_dict = JsonApiUserGroupInRelationshipsParents.from_dict(json_api_user_group_in_relationships_parents_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupLinkage.md b/gooddata-api-client/docs/JsonApiUserGroupLinkage.md index 9eceb7a82..a4cf65ba5 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupLinkage.md +++ b/gooddata-api-client/docs/JsonApiUserGroupLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "userGroup" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_user_group_linkage import JsonApiUserGroupLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupLinkage from a JSON string +json_api_user_group_linkage_instance = JsonApiUserGroupLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupLinkage.to_json()) +# convert the object into a dict +json_api_user_group_linkage_dict = json_api_user_group_linkage_instance.to_dict() +# create an instance of JsonApiUserGroupLinkage from a dict +json_api_user_group_linkage_from_dict = JsonApiUserGroupLinkage.from_dict(json_api_user_group_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupOut.md b/gooddata-api-client/docs/JsonApiUserGroupOut.md index 139f2c82d..67ca95a3b 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupOut.md +++ b/gooddata-api-client/docs/JsonApiUserGroupOut.md @@ -3,14 +3,31 @@ JSON:API representation of userGroup entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userGroup" **attributes** | [**JsonApiUserGroupInAttributes**](JsonApiUserGroupInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiUserGroupInRelationships**](JsonApiUserGroupInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_group_out import JsonApiUserGroupOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupOut from a JSON string +json_api_user_group_out_instance = JsonApiUserGroupOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupOut.to_json()) +# convert the object into a dict +json_api_user_group_out_dict = json_api_user_group_out_instance.to_dict() +# create an instance of JsonApiUserGroupOut from a dict +json_api_user_group_out_from_dict = JsonApiUserGroupOut.from_dict(json_api_user_group_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupOutDocument.md b/gooddata-api-client/docs/JsonApiUserGroupOutDocument.md index 518e9512d..f37647a7c 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupOutDocument.md +++ b/gooddata-api-client/docs/JsonApiUserGroupOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserGroupOut**](JsonApiUserGroupOut.md) | | -**included** | [**[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.md) | Included resources | [optional] +**included** | [**List[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupOutDocument from a JSON string +json_api_user_group_out_document_instance = JsonApiUserGroupOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupOutDocument.to_json()) + +# convert the object into a dict +json_api_user_group_out_document_dict = json_api_user_group_out_document_instance.to_dict() +# create an instance of JsonApiUserGroupOutDocument from a dict +json_api_user_group_out_document_from_dict = JsonApiUserGroupOutDocument.from_dict(json_api_user_group_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupOutList.md b/gooddata-api-client/docs/JsonApiUserGroupOutList.md index cd23cb0f4..d9626ef39 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupOutList.md +++ b/gooddata-api-client/docs/JsonApiUserGroupOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.md) | | -**included** | [**[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.md) | Included resources | [optional] +**data** | [**List[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.md) | | +**included** | [**List[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupOutList from a JSON string +json_api_user_group_out_list_instance = JsonApiUserGroupOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupOutList.to_json()) + +# convert the object into a dict +json_api_user_group_out_list_dict = json_api_user_group_out_list_instance.to_dict() +# create an instance of JsonApiUserGroupOutList from a dict +json_api_user_group_out_list_from_dict = JsonApiUserGroupOutList.from_dict(json_api_user_group_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupOutWithLinks.md b/gooddata-api-client/docs/JsonApiUserGroupOutWithLinks.md index 01712db56..c0b8be92d 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiUserGroupOutWithLinks.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userGroup" **attributes** | [**JsonApiUserGroupInAttributes**](JsonApiUserGroupInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiUserGroupInRelationships**](JsonApiUserGroupInRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupOutWithLinks from a JSON string +json_api_user_group_out_with_links_instance = JsonApiUserGroupOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupOutWithLinks.to_json()) + +# convert the object into a dict +json_api_user_group_out_with_links_dict = json_api_user_group_out_with_links_instance.to_dict() +# create an instance of JsonApiUserGroupOutWithLinks from a dict +json_api_user_group_out_with_links_from_dict = JsonApiUserGroupOutWithLinks.from_dict(json_api_user_group_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupPatch.md b/gooddata-api-client/docs/JsonApiUserGroupPatch.md index 2a4197201..80ac6588c 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupPatch.md +++ b/gooddata-api-client/docs/JsonApiUserGroupPatch.md @@ -3,14 +3,31 @@ JSON:API representation of patching userGroup entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userGroup" **attributes** | [**JsonApiUserGroupInAttributes**](JsonApiUserGroupInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiUserGroupInRelationships**](JsonApiUserGroupInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_group_patch import JsonApiUserGroupPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupPatch from a JSON string +json_api_user_group_patch_instance = JsonApiUserGroupPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupPatch.to_json()) +# convert the object into a dict +json_api_user_group_patch_dict = json_api_user_group_patch_instance.to_dict() +# create an instance of JsonApiUserGroupPatch from a dict +json_api_user_group_patch_from_dict = JsonApiUserGroupPatch.from_dict(json_api_user_group_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupPatchDocument.md b/gooddata-api-client/docs/JsonApiUserGroupPatchDocument.md index 3bb540156..ff4f32827 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiUserGroupPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserGroupPatch**](JsonApiUserGroupPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupPatchDocument from a JSON string +json_api_user_group_patch_document_instance = JsonApiUserGroupPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupPatchDocument.to_json()) + +# convert the object into a dict +json_api_user_group_patch_document_dict = json_api_user_group_patch_document_instance.to_dict() +# create an instance of JsonApiUserGroupPatchDocument from a dict +json_api_user_group_patch_document_from_dict = JsonApiUserGroupPatchDocument.from_dict(json_api_user_group_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserGroupToManyLinkage.md b/gooddata-api-client/docs/JsonApiUserGroupToManyLinkage.md deleted file mode 100644 index a6f455569..000000000 --- a/gooddata-api-client/docs/JsonApiUserGroupToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiUserGroupToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiUserGroupLinkage]**](JsonApiUserGroupLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiUserGroupToOneLinkage.md b/gooddata-api-client/docs/JsonApiUserGroupToOneLinkage.md index 2853e1d8e..d56cc5c30 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiUserGroupToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "userGroup" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserGroupToOneLinkage from a JSON string +json_api_user_group_to_one_linkage_instance = JsonApiUserGroupToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserGroupToOneLinkage.to_json()) +# convert the object into a dict +json_api_user_group_to_one_linkage_dict = json_api_user_group_to_one_linkage_instance.to_dict() +# create an instance of JsonApiUserGroupToOneLinkage from a dict +json_api_user_group_to_one_linkage_from_dict = JsonApiUserGroupToOneLinkage.from_dict(json_api_user_group_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserIdentifierLinkage.md b/gooddata-api-client/docs/JsonApiUserIdentifierLinkage.md index 6c1c689f1..5b499501d 100644 --- a/gooddata-api-client/docs/JsonApiUserIdentifierLinkage.md +++ b/gooddata-api-client/docs/JsonApiUserIdentifierLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "userIdentifier" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_user_identifier_linkage import JsonApiUserIdentifierLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserIdentifierLinkage from a JSON string +json_api_user_identifier_linkage_instance = JsonApiUserIdentifierLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserIdentifierLinkage.to_json()) +# convert the object into a dict +json_api_user_identifier_linkage_dict = json_api_user_identifier_linkage_instance.to_dict() +# create an instance of JsonApiUserIdentifierLinkage from a dict +json_api_user_identifier_linkage_from_dict = JsonApiUserIdentifierLinkage.from_dict(json_api_user_identifier_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserIdentifierOut.md b/gooddata-api-client/docs/JsonApiUserIdentifierOut.md index ba261c2b0..b8e3e9627 100644 --- a/gooddata-api-client/docs/JsonApiUserIdentifierOut.md +++ b/gooddata-api-client/docs/JsonApiUserIdentifierOut.md @@ -3,13 +3,30 @@ JSON:API representation of userIdentifier entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userIdentifier" **attributes** | [**JsonApiUserIdentifierOutAttributes**](JsonApiUserIdentifierOutAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_identifier_out import JsonApiUserIdentifierOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserIdentifierOut from a JSON string +json_api_user_identifier_out_instance = JsonApiUserIdentifierOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserIdentifierOut.to_json()) +# convert the object into a dict +json_api_user_identifier_out_dict = json_api_user_identifier_out_instance.to_dict() +# create an instance of JsonApiUserIdentifierOut from a dict +json_api_user_identifier_out_from_dict = JsonApiUserIdentifierOut.from_dict(json_api_user_identifier_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserIdentifierOutAttributes.md b/gooddata-api-client/docs/JsonApiUserIdentifierOutAttributes.md index 6922c13d9..efc2e2130 100644 --- a/gooddata-api-client/docs/JsonApiUserIdentifierOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiUserIdentifierOutAttributes.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **str** | | [optional] **firstname** | **str** | | [optional] **lastname** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_identifier_out_attributes import JsonApiUserIdentifierOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserIdentifierOutAttributes from a JSON string +json_api_user_identifier_out_attributes_instance = JsonApiUserIdentifierOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserIdentifierOutAttributes.to_json()) + +# convert the object into a dict +json_api_user_identifier_out_attributes_dict = json_api_user_identifier_out_attributes_instance.to_dict() +# create an instance of JsonApiUserIdentifierOutAttributes from a dict +json_api_user_identifier_out_attributes_from_dict = JsonApiUserIdentifierOutAttributes.from_dict(json_api_user_identifier_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserIdentifierOutDocument.md b/gooddata-api-client/docs/JsonApiUserIdentifierOutDocument.md index 98ae5db89..6cbfc0160 100644 --- a/gooddata-api-client/docs/JsonApiUserIdentifierOutDocument.md +++ b/gooddata-api-client/docs/JsonApiUserIdentifierOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserIdentifierOut**](JsonApiUserIdentifierOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserIdentifierOutDocument from a JSON string +json_api_user_identifier_out_document_instance = JsonApiUserIdentifierOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserIdentifierOutDocument.to_json()) + +# convert the object into a dict +json_api_user_identifier_out_document_dict = json_api_user_identifier_out_document_instance.to_dict() +# create an instance of JsonApiUserIdentifierOutDocument from a dict +json_api_user_identifier_out_document_from_dict = JsonApiUserIdentifierOutDocument.from_dict(json_api_user_identifier_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserIdentifierOutList.md b/gooddata-api-client/docs/JsonApiUserIdentifierOutList.md index a18a3207e..51727f82f 100644 --- a/gooddata-api-client/docs/JsonApiUserIdentifierOutList.md +++ b/gooddata-api-client/docs/JsonApiUserIdentifierOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | | +**data** | [**List[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserIdentifierOutList from a JSON string +json_api_user_identifier_out_list_instance = JsonApiUserIdentifierOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserIdentifierOutList.to_json()) + +# convert the object into a dict +json_api_user_identifier_out_list_dict = json_api_user_identifier_out_list_instance.to_dict() +# create an instance of JsonApiUserIdentifierOutList from a dict +json_api_user_identifier_out_list_from_dict = JsonApiUserIdentifierOutList.from_dict(json_api_user_identifier_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserIdentifierOutWithLinks.md b/gooddata-api-client/docs/JsonApiUserIdentifierOutWithLinks.md index 67f07da1a..0f2b624e2 100644 --- a/gooddata-api-client/docs/JsonApiUserIdentifierOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiUserIdentifierOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userIdentifier" **attributes** | [**JsonApiUserIdentifierOutAttributes**](JsonApiUserIdentifierOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserIdentifierOutWithLinks from a JSON string +json_api_user_identifier_out_with_links_instance = JsonApiUserIdentifierOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserIdentifierOutWithLinks.to_json()) + +# convert the object into a dict +json_api_user_identifier_out_with_links_dict = json_api_user_identifier_out_with_links_instance.to_dict() +# create an instance of JsonApiUserIdentifierOutWithLinks from a dict +json_api_user_identifier_out_with_links_from_dict = JsonApiUserIdentifierOutWithLinks.from_dict(json_api_user_identifier_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserIdentifierToOneLinkage.md b/gooddata-api-client/docs/JsonApiUserIdentifierToOneLinkage.md index 2c0cd4ec8..66c66994b 100644 --- a/gooddata-api-client/docs/JsonApiUserIdentifierToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiUserIdentifierToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "userIdentifier" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_user_identifier_to_one_linkage import JsonApiUserIdentifierToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserIdentifierToOneLinkage from a JSON string +json_api_user_identifier_to_one_linkage_instance = JsonApiUserIdentifierToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserIdentifierToOneLinkage.to_json()) +# convert the object into a dict +json_api_user_identifier_to_one_linkage_dict = json_api_user_identifier_to_one_linkage_instance.to_dict() +# create an instance of JsonApiUserIdentifierToOneLinkage from a dict +json_api_user_identifier_to_one_linkage_from_dict = JsonApiUserIdentifierToOneLinkage.from_dict(json_api_user_identifier_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserIn.md b/gooddata-api-client/docs/JsonApiUserIn.md index 77be251bf..c51e894af 100644 --- a/gooddata-api-client/docs/JsonApiUserIn.md +++ b/gooddata-api-client/docs/JsonApiUserIn.md @@ -3,14 +3,31 @@ JSON:API representation of user entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "user" **attributes** | [**JsonApiUserInAttributes**](JsonApiUserInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiUserInRelationships**](JsonApiUserInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_in import JsonApiUserIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserIn from a JSON string +json_api_user_in_instance = JsonApiUserIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserIn.to_json()) +# convert the object into a dict +json_api_user_in_dict = json_api_user_in_instance.to_dict() +# create an instance of JsonApiUserIn from a dict +json_api_user_in_from_dict = JsonApiUserIn.from_dict(json_api_user_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserInAttributes.md b/gooddata-api-client/docs/JsonApiUserInAttributes.md index c69d9120a..21c40cf81 100644 --- a/gooddata-api-client/docs/JsonApiUserInAttributes.md +++ b/gooddata-api-client/docs/JsonApiUserInAttributes.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **authentication_id** | **str** | | [optional] **email** | **str** | | [optional] **firstname** | **str** | | [optional] **lastname** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_in_attributes import JsonApiUserInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserInAttributes from a JSON string +json_api_user_in_attributes_instance = JsonApiUserInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserInAttributes.to_json()) + +# convert the object into a dict +json_api_user_in_attributes_dict = json_api_user_in_attributes_instance.to_dict() +# create an instance of JsonApiUserInAttributes from a dict +json_api_user_in_attributes_from_dict = JsonApiUserInAttributes.from_dict(json_api_user_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserInDocument.md b/gooddata-api-client/docs/JsonApiUserInDocument.md index c86097568..f22b40c75 100644 --- a/gooddata-api-client/docs/JsonApiUserInDocument.md +++ b/gooddata-api-client/docs/JsonApiUserInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserIn**](JsonApiUserIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserInDocument from a JSON string +json_api_user_in_document_instance = JsonApiUserInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserInDocument.to_json()) + +# convert the object into a dict +json_api_user_in_document_dict = json_api_user_in_document_instance.to_dict() +# create an instance of JsonApiUserInDocument from a dict +json_api_user_in_document_from_dict = JsonApiUserInDocument.from_dict(json_api_user_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserInRelationships.md b/gooddata-api-client/docs/JsonApiUserInRelationships.md index 95f4260f8..d5df3fe04 100644 --- a/gooddata-api-client/docs/JsonApiUserInRelationships.md +++ b/gooddata-api-client/docs/JsonApiUserInRelationships.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **user_groups** | [**JsonApiUserGroupInRelationshipsParents**](JsonApiUserGroupInRelationshipsParents.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_in_relationships import JsonApiUserInRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserInRelationships from a JSON string +json_api_user_in_relationships_instance = JsonApiUserInRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserInRelationships.to_json()) + +# convert the object into a dict +json_api_user_in_relationships_dict = json_api_user_in_relationships_instance.to_dict() +# create an instance of JsonApiUserInRelationships from a dict +json_api_user_in_relationships_from_dict = JsonApiUserInRelationships.from_dict(json_api_user_in_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserLinkage.md b/gooddata-api-client/docs/JsonApiUserLinkage.md index c47b16b12..8a6cc1170 100644 --- a/gooddata-api-client/docs/JsonApiUserLinkage.md +++ b/gooddata-api-client/docs/JsonApiUserLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "user" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_user_linkage import JsonApiUserLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserLinkage from a JSON string +json_api_user_linkage_instance = JsonApiUserLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserLinkage.to_json()) +# convert the object into a dict +json_api_user_linkage_dict = json_api_user_linkage_instance.to_dict() +# create an instance of JsonApiUserLinkage from a dict +json_api_user_linkage_from_dict = JsonApiUserLinkage.from_dict(json_api_user_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserOut.md b/gooddata-api-client/docs/JsonApiUserOut.md index 019363982..4d3dbc743 100644 --- a/gooddata-api-client/docs/JsonApiUserOut.md +++ b/gooddata-api-client/docs/JsonApiUserOut.md @@ -3,14 +3,31 @@ JSON:API representation of user entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "user" **attributes** | [**JsonApiUserInAttributes**](JsonApiUserInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiUserInRelationships**](JsonApiUserInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_out import JsonApiUserOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserOut from a JSON string +json_api_user_out_instance = JsonApiUserOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserOut.to_json()) +# convert the object into a dict +json_api_user_out_dict = json_api_user_out_instance.to_dict() +# create an instance of JsonApiUserOut from a dict +json_api_user_out_from_dict = JsonApiUserOut.from_dict(json_api_user_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserOutDocument.md b/gooddata-api-client/docs/JsonApiUserOutDocument.md index 06fb1020a..76dff9e92 100644 --- a/gooddata-api-client/docs/JsonApiUserOutDocument.md +++ b/gooddata-api-client/docs/JsonApiUserOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserOut**](JsonApiUserOut.md) | | -**included** | [**[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.md) | Included resources | [optional] +**included** | [**List[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserOutDocument from a JSON string +json_api_user_out_document_instance = JsonApiUserOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserOutDocument.to_json()) + +# convert the object into a dict +json_api_user_out_document_dict = json_api_user_out_document_instance.to_dict() +# create an instance of JsonApiUserOutDocument from a dict +json_api_user_out_document_from_dict = JsonApiUserOutDocument.from_dict(json_api_user_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserOutList.md b/gooddata-api-client/docs/JsonApiUserOutList.md index b2ea1ba43..aca7fd0ff 100644 --- a/gooddata-api-client/docs/JsonApiUserOutList.md +++ b/gooddata-api-client/docs/JsonApiUserOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiUserOutWithLinks]**](JsonApiUserOutWithLinks.md) | | -**included** | [**[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.md) | Included resources | [optional] +**data** | [**List[JsonApiUserOutWithLinks]**](JsonApiUserOutWithLinks.md) | | +**included** | [**List[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserOutList from a JSON string +json_api_user_out_list_instance = JsonApiUserOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserOutList.to_json()) + +# convert the object into a dict +json_api_user_out_list_dict = json_api_user_out_list_instance.to_dict() +# create an instance of JsonApiUserOutList from a dict +json_api_user_out_list_from_dict = JsonApiUserOutList.from_dict(json_api_user_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserOutWithLinks.md b/gooddata-api-client/docs/JsonApiUserOutWithLinks.md index 54321189d..b3c7a65c3 100644 --- a/gooddata-api-client/docs/JsonApiUserOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiUserOutWithLinks.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "user" **attributes** | [**JsonApiUserInAttributes**](JsonApiUserInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiUserInRelationships**](JsonApiUserInRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserOutWithLinks from a JSON string +json_api_user_out_with_links_instance = JsonApiUserOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserOutWithLinks.to_json()) + +# convert the object into a dict +json_api_user_out_with_links_dict = json_api_user_out_with_links_instance.to_dict() +# create an instance of JsonApiUserOutWithLinks from a dict +json_api_user_out_with_links_from_dict = JsonApiUserOutWithLinks.from_dict(json_api_user_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserPatch.md b/gooddata-api-client/docs/JsonApiUserPatch.md index ab5e8c250..e8f00a5e6 100644 --- a/gooddata-api-client/docs/JsonApiUserPatch.md +++ b/gooddata-api-client/docs/JsonApiUserPatch.md @@ -3,14 +3,31 @@ JSON:API representation of patching user entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "user" **attributes** | [**JsonApiUserInAttributes**](JsonApiUserInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiUserInRelationships**](JsonApiUserInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_patch import JsonApiUserPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserPatch from a JSON string +json_api_user_patch_instance = JsonApiUserPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserPatch.to_json()) +# convert the object into a dict +json_api_user_patch_dict = json_api_user_patch_instance.to_dict() +# create an instance of JsonApiUserPatch from a dict +json_api_user_patch_from_dict = JsonApiUserPatch.from_dict(json_api_user_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserPatchDocument.md b/gooddata-api-client/docs/JsonApiUserPatchDocument.md index eb6096f8f..d5f3e57d8 100644 --- a/gooddata-api-client/docs/JsonApiUserPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiUserPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserPatch**](JsonApiUserPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserPatchDocument from a JSON string +json_api_user_patch_document_instance = JsonApiUserPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserPatchDocument.to_json()) + +# convert the object into a dict +json_api_user_patch_document_dict = json_api_user_patch_document_instance.to_dict() +# create an instance of JsonApiUserPatchDocument from a dict +json_api_user_patch_document_from_dict = JsonApiUserPatchDocument.from_dict(json_api_user_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserSettingIn.md b/gooddata-api-client/docs/JsonApiUserSettingIn.md index 1fe5520e6..732dd4807 100644 --- a/gooddata-api-client/docs/JsonApiUserSettingIn.md +++ b/gooddata-api-client/docs/JsonApiUserSettingIn.md @@ -3,13 +3,30 @@ JSON:API representation of userSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_setting_in import JsonApiUserSettingIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserSettingIn from a JSON string +json_api_user_setting_in_instance = JsonApiUserSettingIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserSettingIn.to_json()) +# convert the object into a dict +json_api_user_setting_in_dict = json_api_user_setting_in_instance.to_dict() +# create an instance of JsonApiUserSettingIn from a dict +json_api_user_setting_in_from_dict = JsonApiUserSettingIn.from_dict(json_api_user_setting_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserSettingInDocument.md b/gooddata-api-client/docs/JsonApiUserSettingInDocument.md index 2da793711..0d28670a0 100644 --- a/gooddata-api-client/docs/JsonApiUserSettingInDocument.md +++ b/gooddata-api-client/docs/JsonApiUserSettingInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserSettingIn**](JsonApiUserSettingIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserSettingInDocument from a JSON string +json_api_user_setting_in_document_instance = JsonApiUserSettingInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserSettingInDocument.to_json()) + +# convert the object into a dict +json_api_user_setting_in_document_dict = json_api_user_setting_in_document_instance.to_dict() +# create an instance of JsonApiUserSettingInDocument from a dict +json_api_user_setting_in_document_from_dict = JsonApiUserSettingInDocument.from_dict(json_api_user_setting_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserSettingOut.md b/gooddata-api-client/docs/JsonApiUserSettingOut.md index cfe7b3dd9..d646c8689 100644 --- a/gooddata-api-client/docs/JsonApiUserSettingOut.md +++ b/gooddata-api-client/docs/JsonApiUserSettingOut.md @@ -3,13 +3,30 @@ JSON:API representation of userSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_user_setting_out import JsonApiUserSettingOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserSettingOut from a JSON string +json_api_user_setting_out_instance = JsonApiUserSettingOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserSettingOut.to_json()) +# convert the object into a dict +json_api_user_setting_out_dict = json_api_user_setting_out_instance.to_dict() +# create an instance of JsonApiUserSettingOut from a dict +json_api_user_setting_out_from_dict = JsonApiUserSettingOut.from_dict(json_api_user_setting_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserSettingOutDocument.md b/gooddata-api-client/docs/JsonApiUserSettingOutDocument.md index 7268bf83c..4da73ac93 100644 --- a/gooddata-api-client/docs/JsonApiUserSettingOutDocument.md +++ b/gooddata-api-client/docs/JsonApiUserSettingOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiUserSettingOut**](JsonApiUserSettingOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserSettingOutDocument from a JSON string +json_api_user_setting_out_document_instance = JsonApiUserSettingOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserSettingOutDocument.to_json()) + +# convert the object into a dict +json_api_user_setting_out_document_dict = json_api_user_setting_out_document_instance.to_dict() +# create an instance of JsonApiUserSettingOutDocument from a dict +json_api_user_setting_out_document_from_dict = JsonApiUserSettingOutDocument.from_dict(json_api_user_setting_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserSettingOutList.md b/gooddata-api-client/docs/JsonApiUserSettingOutList.md index 8e6634d51..61c521d2c 100644 --- a/gooddata-api-client/docs/JsonApiUserSettingOutList.md +++ b/gooddata-api-client/docs/JsonApiUserSettingOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiUserSettingOutWithLinks]**](JsonApiUserSettingOutWithLinks.md) | | +**data** | [**List[JsonApiUserSettingOutWithLinks]**](JsonApiUserSettingOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserSettingOutList from a JSON string +json_api_user_setting_out_list_instance = JsonApiUserSettingOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserSettingOutList.to_json()) + +# convert the object into a dict +json_api_user_setting_out_list_dict = json_api_user_setting_out_list_instance.to_dict() +# create an instance of JsonApiUserSettingOutList from a dict +json_api_user_setting_out_list_from_dict = JsonApiUserSettingOutList.from_dict(json_api_user_setting_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserSettingOutWithLinks.md b/gooddata-api-client/docs/JsonApiUserSettingOutWithLinks.md index 3c893dd2a..11d282db8 100644 --- a/gooddata-api-client/docs/JsonApiUserSettingOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiUserSettingOutWithLinks.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "userSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_user_setting_out_with_links import JsonApiUserSettingOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserSettingOutWithLinks from a JSON string +json_api_user_setting_out_with_links_instance = JsonApiUserSettingOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserSettingOutWithLinks.to_json()) + +# convert the object into a dict +json_api_user_setting_out_with_links_dict = json_api_user_setting_out_with_links_instance.to_dict() +# create an instance of JsonApiUserSettingOutWithLinks from a dict +json_api_user_setting_out_with_links_from_dict = JsonApiUserSettingOutWithLinks.from_dict(json_api_user_setting_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiUserToManyLinkage.md b/gooddata-api-client/docs/JsonApiUserToManyLinkage.md deleted file mode 100644 index c2cc090ca..000000000 --- a/gooddata-api-client/docs/JsonApiUserToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiUserToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiUserLinkage]**](JsonApiUserLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiUserToOneLinkage.md b/gooddata-api-client/docs/JsonApiUserToOneLinkage.md index 23b23c0c8..31c2e7d29 100644 --- a/gooddata-api-client/docs/JsonApiUserToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiUserToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "user" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_user_to_one_linkage import JsonApiUserToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiUserToOneLinkage from a JSON string +json_api_user_to_one_linkage_instance = JsonApiUserToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiUserToOneLinkage.to_json()) +# convert the object into a dict +json_api_user_to_one_linkage_dict = json_api_user_to_one_linkage_instance.to_dict() +# create an instance of JsonApiUserToOneLinkage from a dict +json_api_user_to_one_linkage_from_dict = JsonApiUserToOneLinkage.from_dict(json_api_user_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectIn.md b/gooddata-api-client/docs/JsonApiVisualizationObjectIn.md index 2bb9d6440..0dca93793 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectIn.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectIn.md @@ -3,13 +3,30 @@ JSON:API representation of visualizationObject entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiVisualizationObjectInAttributes**](JsonApiVisualizationObjectInAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "visualizationObject" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_in import JsonApiVisualizationObjectIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectIn from a JSON string +json_api_visualization_object_in_instance = JsonApiVisualizationObjectIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectIn.to_json()) +# convert the object into a dict +json_api_visualization_object_in_dict = json_api_visualization_object_in_instance.to_dict() +# create an instance of JsonApiVisualizationObjectIn from a dict +json_api_visualization_object_in_from_dict = JsonApiVisualizationObjectIn.from_dict(json_api_visualization_object_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectInAttributes.md b/gooddata-api-client/docs/JsonApiVisualizationObjectInAttributes.md index 9fdaec069..53a6e7076 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectInAttributes.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectInAttributes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | **are_relations_valid** | **bool** | | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 250000 characters. | **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_in_attributes import JsonApiVisualizationObjectInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectInAttributes from a JSON string +json_api_visualization_object_in_attributes_instance = JsonApiVisualizationObjectInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectInAttributes.to_json()) + +# convert the object into a dict +json_api_visualization_object_in_attributes_dict = json_api_visualization_object_in_attributes_instance.to_dict() +# create an instance of JsonApiVisualizationObjectInAttributes from a dict +json_api_visualization_object_in_attributes_from_dict = JsonApiVisualizationObjectInAttributes.from_dict(json_api_visualization_object_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectInDocument.md b/gooddata-api-client/docs/JsonApiVisualizationObjectInDocument.md index 079bccb45..95dccecf1 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectInDocument.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiVisualizationObjectIn**](JsonApiVisualizationObjectIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectInDocument from a JSON string +json_api_visualization_object_in_document_instance = JsonApiVisualizationObjectInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectInDocument.to_json()) + +# convert the object into a dict +json_api_visualization_object_in_document_dict = json_api_visualization_object_in_document_instance.to_dict() +# create an instance of JsonApiVisualizationObjectInDocument from a dict +json_api_visualization_object_in_document_from_dict = JsonApiVisualizationObjectInDocument.from_dict(json_api_visualization_object_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectLinkage.md b/gooddata-api-client/docs/JsonApiVisualizationObjectLinkage.md index c18925cb9..bd06b3544 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectLinkage.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "visualizationObject" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectLinkage from a JSON string +json_api_visualization_object_linkage_instance = JsonApiVisualizationObjectLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectLinkage.to_json()) +# convert the object into a dict +json_api_visualization_object_linkage_dict = json_api_visualization_object_linkage_instance.to_dict() +# create an instance of JsonApiVisualizationObjectLinkage from a dict +json_api_visualization_object_linkage_from_dict = JsonApiVisualizationObjectLinkage.from_dict(json_api_visualization_object_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectOut.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOut.md index 0b593f8eb..d13ca7962 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOut.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOut.md @@ -3,15 +3,32 @@ JSON:API representation of visualizationObject entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiVisualizationObjectOutAttributes**](JsonApiVisualizationObjectOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "visualizationObject" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiMetricOutRelationships**](JsonApiMetricOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_out import JsonApiVisualizationObjectOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectOut from a JSON string +json_api_visualization_object_out_instance = JsonApiVisualizationObjectOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectOut.to_json()) +# convert the object into a dict +json_api_visualization_object_out_dict = json_api_visualization_object_out_instance.to_dict() +# create an instance of JsonApiVisualizationObjectOut from a dict +json_api_visualization_object_out_from_dict = JsonApiVisualizationObjectOut.from_dict(json_api_visualization_object_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md index aa4936193..6e806c019 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md @@ -2,18 +2,35 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | **are_relations_valid** | **bool** | | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 250000 characters. | **created_at** | **datetime** | | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] **modified_at** | **datetime** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectOutAttributes from a JSON string +json_api_visualization_object_out_attributes_instance = JsonApiVisualizationObjectOutAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectOutAttributes.to_json()) + +# convert the object into a dict +json_api_visualization_object_out_attributes_dict = json_api_visualization_object_out_attributes_instance.to_dict() +# create an instance of JsonApiVisualizationObjectOutAttributes from a dict +json_api_visualization_object_out_attributes_from_dict = JsonApiVisualizationObjectOutAttributes.from_dict(json_api_visualization_object_out_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md index 72ed05614..22351b6ed 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiVisualizationObjectOut**](JsonApiVisualizationObjectOut.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**included** | [**List[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectOutDocument from a JSON string +json_api_visualization_object_out_document_instance = JsonApiVisualizationObjectOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectOutDocument.to_json()) + +# convert the object into a dict +json_api_visualization_object_out_document_dict = json_api_visualization_object_out_document_instance.to_dict() +# create an instance of JsonApiVisualizationObjectOutDocument from a dict +json_api_visualization_object_out_document_from_dict = JsonApiVisualizationObjectOutDocument.from_dict(json_api_visualization_object_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectOutList.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutList.md index 5a79ed4b5..039275c75 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutList.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiVisualizationObjectOutWithLinks]**](JsonApiVisualizationObjectOutWithLinks.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiVisualizationObjectOutWithLinks]**](JsonApiVisualizationObjectOutWithLinks.md) | | +**included** | [**List[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectOutList from a JSON string +json_api_visualization_object_out_list_instance = JsonApiVisualizationObjectOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectOutList.to_json()) + +# convert the object into a dict +json_api_visualization_object_out_list_dict = json_api_visualization_object_out_list_instance.to_dict() +# create an instance of JsonApiVisualizationObjectOutList from a dict +json_api_visualization_object_out_list_from_dict = JsonApiVisualizationObjectOutList.from_dict(json_api_visualization_object_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectOutWithLinks.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutWithLinks.md index bfc02c912..44cd090b0 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiVisualizationObjectOutAttributes**](JsonApiVisualizationObjectOutAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "visualizationObject" **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiMetricOutRelationships**](JsonApiMetricOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectOutWithLinks from a JSON string +json_api_visualization_object_out_with_links_instance = JsonApiVisualizationObjectOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectOutWithLinks.to_json()) + +# convert the object into a dict +json_api_visualization_object_out_with_links_dict = json_api_visualization_object_out_with_links_instance.to_dict() +# create an instance of JsonApiVisualizationObjectOutWithLinks from a dict +json_api_visualization_object_out_with_links_from_dict = JsonApiVisualizationObjectOutWithLinks.from_dict(json_api_visualization_object_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectPatch.md b/gooddata-api-client/docs/JsonApiVisualizationObjectPatch.md index 1647aa879..852d6266f 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectPatch.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching visualizationObject entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiVisualizationObjectPatchAttributes**](JsonApiVisualizationObjectPatchAttributes.md) | | **id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "visualizationObject" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_patch import JsonApiVisualizationObjectPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectPatch from a JSON string +json_api_visualization_object_patch_instance = JsonApiVisualizationObjectPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectPatch.to_json()) +# convert the object into a dict +json_api_visualization_object_patch_dict = json_api_visualization_object_patch_instance.to_dict() +# create an instance of JsonApiVisualizationObjectPatch from a dict +json_api_visualization_object_patch_from_dict = JsonApiVisualizationObjectPatch.from_dict(json_api_visualization_object_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectPatchAttributes.md b/gooddata-api-client/docs/JsonApiVisualizationObjectPatchAttributes.md index b202c526d..5d5c5a4f7 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectPatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectPatchAttributes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | [optional] +**content** | **object** | Free-form JSON content. Maximum supported length is 250000 characters. | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_patch_attributes import JsonApiVisualizationObjectPatchAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectPatchAttributes from a JSON string +json_api_visualization_object_patch_attributes_instance = JsonApiVisualizationObjectPatchAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectPatchAttributes.to_json()) + +# convert the object into a dict +json_api_visualization_object_patch_attributes_dict = json_api_visualization_object_patch_attributes_instance.to_dict() +# create an instance of JsonApiVisualizationObjectPatchAttributes from a dict +json_api_visualization_object_patch_attributes_from_dict = JsonApiVisualizationObjectPatchAttributes.from_dict(json_api_visualization_object_patch_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectPatchDocument.md b/gooddata-api-client/docs/JsonApiVisualizationObjectPatchDocument.md index c68338acd..348bd43ca 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiVisualizationObjectPatch**](JsonApiVisualizationObjectPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectPatchDocument from a JSON string +json_api_visualization_object_patch_document_instance = JsonApiVisualizationObjectPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectPatchDocument.to_json()) + +# convert the object into a dict +json_api_visualization_object_patch_document_dict = json_api_visualization_object_patch_document_instance.to_dict() +# create an instance of JsonApiVisualizationObjectPatchDocument from a dict +json_api_visualization_object_patch_document_from_dict = JsonApiVisualizationObjectPatchDocument.from_dict(json_api_visualization_object_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectPostOptionalId.md b/gooddata-api-client/docs/JsonApiVisualizationObjectPostOptionalId.md index cacdf9e8d..de7b582bc 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectPostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectPostOptionalId.md @@ -3,13 +3,30 @@ JSON:API representation of visualizationObject entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiVisualizationObjectInAttributes**](JsonApiVisualizationObjectInAttributes.md) | | -**type** | **str** | Object type | defaults to "visualizationObject" **id** | **str** | API identifier of an object | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_post_optional_id import JsonApiVisualizationObjectPostOptionalId + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectPostOptionalId from a JSON string +json_api_visualization_object_post_optional_id_instance = JsonApiVisualizationObjectPostOptionalId.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectPostOptionalId.to_json()) +# convert the object into a dict +json_api_visualization_object_post_optional_id_dict = json_api_visualization_object_post_optional_id_instance.to_dict() +# create an instance of JsonApiVisualizationObjectPostOptionalId from a dict +json_api_visualization_object_post_optional_id_from_dict = JsonApiVisualizationObjectPostOptionalId.from_dict(json_api_visualization_object_post_optional_id_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiVisualizationObjectPostOptionalIdDocument.md index 8a5e13cba..e0cf954a5 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectPostOptionalIdDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiVisualizationObjectPostOptionalId**](JsonApiVisualizationObjectPostOptionalId.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectPostOptionalIdDocument from a JSON string +json_api_visualization_object_post_optional_id_document_instance = JsonApiVisualizationObjectPostOptionalIdDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectPostOptionalIdDocument.to_json()) + +# convert the object into a dict +json_api_visualization_object_post_optional_id_document_dict = json_api_visualization_object_post_optional_id_document_instance.to_dict() +# create an instance of JsonApiVisualizationObjectPostOptionalIdDocument from a dict +json_api_visualization_object_post_optional_id_document_from_dict = JsonApiVisualizationObjectPostOptionalIdDocument.from_dict(json_api_visualization_object_post_optional_id_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectToManyLinkage.md b/gooddata-api-client/docs/JsonApiVisualizationObjectToManyLinkage.md deleted file mode 100644 index 719e48f51..000000000 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiVisualizationObjectToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiVisualizationObjectLinkage]**](JsonApiVisualizationObjectLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectToOneLinkage.md b/gooddata-api-client/docs/JsonApiVisualizationObjectToOneLinkage.md index 836e57efa..867a7eaa0 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "visualizationObject" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiVisualizationObjectToOneLinkage from a JSON string +json_api_visualization_object_to_one_linkage_instance = JsonApiVisualizationObjectToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiVisualizationObjectToOneLinkage.to_json()) +# convert the object into a dict +json_api_visualization_object_to_one_linkage_dict = json_api_visualization_object_to_one_linkage_instance.to_dict() +# create an instance of JsonApiVisualizationObjectToOneLinkage from a dict +json_api_visualization_object_to_one_linkage_from_dict = JsonApiVisualizationObjectToOneLinkage.from_dict(json_api_visualization_object_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOut.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOut.md index 2d820f1c2..2f1a0dea7 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOut.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOut.md @@ -3,14 +3,31 @@ JSON:API representation of workspaceAutomation entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceAutomation" **attributes** | [**JsonApiAutomationOutAttributes**](JsonApiAutomationOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiWorkspaceAutomationOutRelationships**](JsonApiWorkspaceAutomationOutRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_automation_out import JsonApiWorkspaceAutomationOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceAutomationOut from a JSON string +json_api_workspace_automation_out_instance = JsonApiWorkspaceAutomationOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceAutomationOut.to_json()) +# convert the object into a dict +json_api_workspace_automation_out_dict = json_api_workspace_automation_out_instance.to_dict() +# create an instance of JsonApiWorkspaceAutomationOut from a dict +json_api_workspace_automation_out_from_dict = JsonApiWorkspaceAutomationOut.from_dict(json_api_workspace_automation_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutIncludes.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutIncludes.md index 77be9adf2..dccb11e41 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutIncludes.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiAutomationResultOutAttributes**](JsonApiAutomationResultOutAttributes.md) | | +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiAutomationResultOutRelationships**](JsonApiAutomationResultOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**attributes** | [**JsonApiAutomationResultOutAttributes**](JsonApiAutomationResultOutAttributes.md) | | [optional] -**id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "automationResult" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_automation_out_includes import JsonApiWorkspaceAutomationOutIncludes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceAutomationOutIncludes from a JSON string +json_api_workspace_automation_out_includes_instance = JsonApiWorkspaceAutomationOutIncludes.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceAutomationOutIncludes.to_json()) + +# convert the object into a dict +json_api_workspace_automation_out_includes_dict = json_api_workspace_automation_out_includes_instance.to_dict() +# create an instance of JsonApiWorkspaceAutomationOutIncludes from a dict +json_api_workspace_automation_out_includes_from_dict = JsonApiWorkspaceAutomationOutIncludes.from_dict(json_api_workspace_automation_out_includes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutList.md index 6dc4402b9..b0811c784 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutList.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiWorkspaceAutomationOutWithLinks]**](JsonApiWorkspaceAutomationOutWithLinks.md) | | -**included** | [**[JsonApiWorkspaceAutomationOutIncludes]**](JsonApiWorkspaceAutomationOutIncludes.md) | Included resources | [optional] +**data** | [**List[JsonApiWorkspaceAutomationOutWithLinks]**](JsonApiWorkspaceAutomationOutWithLinks.md) | | +**included** | [**List[JsonApiWorkspaceAutomationOutIncludes]**](JsonApiWorkspaceAutomationOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceAutomationOutList from a JSON string +json_api_workspace_automation_out_list_instance = JsonApiWorkspaceAutomationOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceAutomationOutList.to_json()) + +# convert the object into a dict +json_api_workspace_automation_out_list_dict = json_api_workspace_automation_out_list_instance.to_dict() +# create an instance of JsonApiWorkspaceAutomationOutList from a dict +json_api_workspace_automation_out_list_from_dict = JsonApiWorkspaceAutomationOutList.from_dict(json_api_workspace_automation_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationships.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationships.md index 5a7432f3c..ab0a73e1b 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationships.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboard** | [**JsonApiAutomationInRelationshipsAnalyticalDashboard**](JsonApiAutomationInRelationshipsAnalyticalDashboard.md) | | [optional] @@ -12,8 +13,24 @@ Name | Type | Description | Notes **notification_channel** | [**JsonApiAutomationInRelationshipsNotificationChannel**](JsonApiAutomationInRelationshipsNotificationChannel.md) | | [optional] **recipients** | [**JsonApiAutomationInRelationshipsRecipients**](JsonApiAutomationInRelationshipsRecipients.md) | | [optional] **workspace** | [**JsonApiWorkspaceAutomationOutRelationshipsWorkspace**](JsonApiWorkspaceAutomationOutRelationshipsWorkspace.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceAutomationOutRelationships from a JSON string +json_api_workspace_automation_out_relationships_instance = JsonApiWorkspaceAutomationOutRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceAutomationOutRelationships.to_json()) + +# convert the object into a dict +json_api_workspace_automation_out_relationships_dict = json_api_workspace_automation_out_relationships_instance.to_dict() +# create an instance of JsonApiWorkspaceAutomationOutRelationships from a dict +json_api_workspace_automation_out_relationships_from_dict = JsonApiWorkspaceAutomationOutRelationships.from_dict(json_api_workspace_automation_out_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationshipsWorkspace.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationshipsWorkspace.md index 6afcffaa2..7ce431bfd 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationshipsWorkspace.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationshipsWorkspace.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceToOneLinkage**](JsonApiWorkspaceToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_automation_out_relationships_workspace import JsonApiWorkspaceAutomationOutRelationshipsWorkspace + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceAutomationOutRelationshipsWorkspace from a JSON string +json_api_workspace_automation_out_relationships_workspace_instance = JsonApiWorkspaceAutomationOutRelationshipsWorkspace.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceAutomationOutRelationshipsWorkspace.to_json()) + +# convert the object into a dict +json_api_workspace_automation_out_relationships_workspace_dict = json_api_workspace_automation_out_relationships_workspace_instance.to_dict() +# create an instance of JsonApiWorkspaceAutomationOutRelationshipsWorkspace from a dict +json_api_workspace_automation_out_relationships_workspace_from_dict = JsonApiWorkspaceAutomationOutRelationshipsWorkspace.from_dict(json_api_workspace_automation_out_relationships_workspace_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutWithLinks.md index 7deb265a1..45db67078 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutWithLinks.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceAutomation" **attributes** | [**JsonApiAutomationOutAttributes**](JsonApiAutomationOutAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiWorkspaceAutomationOutRelationships**](JsonApiWorkspaceAutomationOutRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_automation_out_with_links import JsonApiWorkspaceAutomationOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceAutomationOutWithLinks from a JSON string +json_api_workspace_automation_out_with_links_instance = JsonApiWorkspaceAutomationOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceAutomationOutWithLinks.to_json()) + +# convert the object into a dict +json_api_workspace_automation_out_with_links_dict = json_api_workspace_automation_out_with_links_instance.to_dict() +# create an instance of JsonApiWorkspaceAutomationOutWithLinks from a dict +json_api_workspace_automation_out_with_links_from_dict = JsonApiWorkspaceAutomationOutWithLinks.from_dict(json_api_workspace_automation_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterIn.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterIn.md index 4eecfc869..1ccceb70c 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterIn.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterIn.md @@ -3,14 +3,31 @@ JSON:API representation of workspaceDataFilter entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceDataFilter" **attributes** | [**JsonApiWorkspaceDataFilterInAttributes**](JsonApiWorkspaceDataFilterInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiWorkspaceDataFilterInRelationships**](JsonApiWorkspaceDataFilterInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_in import JsonApiWorkspaceDataFilterIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterIn from a JSON string +json_api_workspace_data_filter_in_instance = JsonApiWorkspaceDataFilterIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterIn.to_json()) +# convert the object into a dict +json_api_workspace_data_filter_in_dict = json_api_workspace_data_filter_in_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterIn from a dict +json_api_workspace_data_filter_in_from_dict = JsonApiWorkspaceDataFilterIn.from_dict(json_api_workspace_data_filter_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInAttributes.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInAttributes.md index 367c947c2..c676e3d23 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInAttributes.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInAttributes.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **column_name** | **str** | | [optional] **description** | **str** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterInAttributes from a JSON string +json_api_workspace_data_filter_in_attributes_instance = JsonApiWorkspaceDataFilterInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterInAttributes.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_in_attributes_dict = json_api_workspace_data_filter_in_attributes_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterInAttributes from a dict +json_api_workspace_data_filter_in_attributes_from_dict = JsonApiWorkspaceDataFilterInAttributes.from_dict(json_api_workspace_data_filter_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInDocument.md index 4e1a00ef0..97e01f784 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceDataFilterIn**](JsonApiWorkspaceDataFilterIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterInDocument from a JSON string +json_api_workspace_data_filter_in_document_instance = JsonApiWorkspaceDataFilterInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterInDocument.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_in_document_dict = json_api_workspace_data_filter_in_document_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterInDocument from a dict +json_api_workspace_data_filter_in_document_from_dict = JsonApiWorkspaceDataFilterInDocument.from_dict(json_api_workspace_data_filter_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInRelationships.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInRelationships.md index a3595ee15..5ad004a1c 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInRelationships.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInRelationships.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **filter_settings** | [**JsonApiWorkspaceDataFilterInRelationshipsFilterSettings**](JsonApiWorkspaceDataFilterInRelationshipsFilterSettings.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterInRelationships from a JSON string +json_api_workspace_data_filter_in_relationships_instance = JsonApiWorkspaceDataFilterInRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterInRelationships.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_in_relationships_dict = json_api_workspace_data_filter_in_relationships_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterInRelationships from a dict +json_api_workspace_data_filter_in_relationships_from_dict = JsonApiWorkspaceDataFilterInRelationships.from_dict(json_api_workspace_data_filter_in_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInRelationshipsFilterSettings.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInRelationshipsFilterSettings.md index 9e2e2b071..189b05e64 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInRelationshipsFilterSettings.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterInRelationshipsFilterSettings.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**JsonApiWorkspaceDataFilterSettingToManyLinkage**](JsonApiWorkspaceDataFilterSettingToManyLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[JsonApiWorkspaceDataFilterSettingLinkage]**](JsonApiWorkspaceDataFilterSettingLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_in_relationships_filter_settings import JsonApiWorkspaceDataFilterInRelationshipsFilterSettings + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterInRelationshipsFilterSettings from a JSON string +json_api_workspace_data_filter_in_relationships_filter_settings_instance = JsonApiWorkspaceDataFilterInRelationshipsFilterSettings.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterInRelationshipsFilterSettings.to_json()) +# convert the object into a dict +json_api_workspace_data_filter_in_relationships_filter_settings_dict = json_api_workspace_data_filter_in_relationships_filter_settings_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterInRelationshipsFilterSettings from a dict +json_api_workspace_data_filter_in_relationships_filter_settings_from_dict = JsonApiWorkspaceDataFilterInRelationshipsFilterSettings.from_dict(json_api_workspace_data_filter_in_relationships_filter_settings_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterLinkage.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterLinkage.md index 612f5bf20..2addfa5f0 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterLinkage.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "workspaceDataFilter" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_linkage import JsonApiWorkspaceDataFilterLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterLinkage from a JSON string +json_api_workspace_data_filter_linkage_instance = JsonApiWorkspaceDataFilterLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterLinkage.to_json()) +# convert the object into a dict +json_api_workspace_data_filter_linkage_dict = json_api_workspace_data_filter_linkage_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterLinkage from a dict +json_api_workspace_data_filter_linkage_from_dict = JsonApiWorkspaceDataFilterLinkage.from_dict(json_api_workspace_data_filter_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOut.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOut.md index 2f7c1cc6a..1a42c735b 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOut.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOut.md @@ -3,15 +3,32 @@ JSON:API representation of workspaceDataFilter entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceDataFilter" **attributes** | [**JsonApiWorkspaceDataFilterInAttributes**](JsonApiWorkspaceDataFilterInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiWorkspaceDataFilterInRelationships**](JsonApiWorkspaceDataFilterInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterOut from a JSON string +json_api_workspace_data_filter_out_instance = JsonApiWorkspaceDataFilterOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterOut.to_json()) +# convert the object into a dict +json_api_workspace_data_filter_out_dict = json_api_workspace_data_filter_out_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterOut from a dict +json_api_workspace_data_filter_out_from_dict = JsonApiWorkspaceDataFilterOut.from_dict(json_api_workspace_data_filter_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutDocument.md index a5fe9fb3d..b62150329 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceDataFilterOut**](JsonApiWorkspaceDataFilterOut.md) | | -**included** | [**[JsonApiWorkspaceDataFilterSettingOutWithLinks]**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | Included resources | [optional] +**included** | [**List[JsonApiWorkspaceDataFilterSettingOutWithLinks]**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterOutDocument from a JSON string +json_api_workspace_data_filter_out_document_instance = JsonApiWorkspaceDataFilterOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterOutDocument.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_out_document_dict = json_api_workspace_data_filter_out_document_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterOutDocument from a dict +json_api_workspace_data_filter_out_document_from_dict = JsonApiWorkspaceDataFilterOutDocument.from_dict(json_api_workspace_data_filter_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutList.md index b2835c0ca..9ac854c85 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutList.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiWorkspaceDataFilterOutWithLinks]**](JsonApiWorkspaceDataFilterOutWithLinks.md) | | -**included** | [**[JsonApiWorkspaceDataFilterSettingOutWithLinks]**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | Included resources | [optional] +**data** | [**List[JsonApiWorkspaceDataFilterOutWithLinks]**](JsonApiWorkspaceDataFilterOutWithLinks.md) | | +**included** | [**List[JsonApiWorkspaceDataFilterSettingOutWithLinks]**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterOutList from a JSON string +json_api_workspace_data_filter_out_list_instance = JsonApiWorkspaceDataFilterOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterOutList.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_out_list_dict = json_api_workspace_data_filter_out_list_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterOutList from a dict +json_api_workspace_data_filter_out_list_from_dict = JsonApiWorkspaceDataFilterOutList.from_dict(json_api_workspace_data_filter_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutWithLinks.md index 10efd6f0e..6e36e87e5 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceDataFilter" **attributes** | [**JsonApiWorkspaceDataFilterInAttributes**](JsonApiWorkspaceDataFilterInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiWorkspaceDataFilterInRelationships**](JsonApiWorkspaceDataFilterInRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterOutWithLinks from a JSON string +json_api_workspace_data_filter_out_with_links_instance = JsonApiWorkspaceDataFilterOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterOutWithLinks.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_out_with_links_dict = json_api_workspace_data_filter_out_with_links_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterOutWithLinks from a dict +json_api_workspace_data_filter_out_with_links_from_dict = JsonApiWorkspaceDataFilterOutWithLinks.from_dict(json_api_workspace_data_filter_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterPatch.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterPatch.md index 527e87de3..7c11e090c 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterPatch.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterPatch.md @@ -3,14 +3,31 @@ JSON:API representation of patching workspaceDataFilter entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceDataFilter" **attributes** | [**JsonApiWorkspaceDataFilterInAttributes**](JsonApiWorkspaceDataFilterInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiWorkspaceDataFilterInRelationships**](JsonApiWorkspaceDataFilterInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_patch import JsonApiWorkspaceDataFilterPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterPatch from a JSON string +json_api_workspace_data_filter_patch_instance = JsonApiWorkspaceDataFilterPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterPatch.to_json()) +# convert the object into a dict +json_api_workspace_data_filter_patch_dict = json_api_workspace_data_filter_patch_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterPatch from a dict +json_api_workspace_data_filter_patch_from_dict = JsonApiWorkspaceDataFilterPatch.from_dict(json_api_workspace_data_filter_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterPatchDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterPatchDocument.md index 2ac583192..f5dc7eda8 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceDataFilterPatch**](JsonApiWorkspaceDataFilterPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterPatchDocument from a JSON string +json_api_workspace_data_filter_patch_document_instance = JsonApiWorkspaceDataFilterPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterPatchDocument.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_patch_document_dict = json_api_workspace_data_filter_patch_document_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterPatchDocument from a dict +json_api_workspace_data_filter_patch_document_from_dict = JsonApiWorkspaceDataFilterPatchDocument.from_dict(json_api_workspace_data_filter_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingIn.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingIn.md index ad15ae94b..67b9b01a2 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingIn.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingIn.md @@ -3,14 +3,31 @@ JSON:API representation of workspaceDataFilterSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceDataFilterSetting" **attributes** | [**JsonApiWorkspaceDataFilterSettingInAttributes**](JsonApiWorkspaceDataFilterSettingInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiWorkspaceDataFilterSettingInRelationships**](JsonApiWorkspaceDataFilterSettingInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in import JsonApiWorkspaceDataFilterSettingIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingIn from a JSON string +json_api_workspace_data_filter_setting_in_instance = JsonApiWorkspaceDataFilterSettingIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingIn.to_json()) +# convert the object into a dict +json_api_workspace_data_filter_setting_in_dict = json_api_workspace_data_filter_setting_in_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingIn from a dict +json_api_workspace_data_filter_setting_in_from_dict = JsonApiWorkspaceDataFilterSettingIn.from_dict(json_api_workspace_data_filter_setting_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInAttributes.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInAttributes.md index 043cb4c0d..8ea6691b4 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInAttributes.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInAttributes.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **description** | **str** | | [optional] -**filter_values** | **[str]** | | [optional] +**filter_values** | **List[str]** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingInAttributes from a JSON string +json_api_workspace_data_filter_setting_in_attributes_instance = JsonApiWorkspaceDataFilterSettingInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingInAttributes.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_setting_in_attributes_dict = json_api_workspace_data_filter_setting_in_attributes_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingInAttributes from a dict +json_api_workspace_data_filter_setting_in_attributes_from_dict = JsonApiWorkspaceDataFilterSettingInAttributes.from_dict(json_api_workspace_data_filter_setting_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInDocument.md index 3fd8f731d..e993584ad 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceDataFilterSettingIn**](JsonApiWorkspaceDataFilterSettingIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingInDocument from a JSON string +json_api_workspace_data_filter_setting_in_document_instance = JsonApiWorkspaceDataFilterSettingInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingInDocument.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_setting_in_document_dict = json_api_workspace_data_filter_setting_in_document_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingInDocument from a dict +json_api_workspace_data_filter_setting_in_document_from_dict = JsonApiWorkspaceDataFilterSettingInDocument.from_dict(json_api_workspace_data_filter_setting_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInRelationships.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInRelationships.md index fb3cd0f9c..e0c60323e 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInRelationships.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInRelationships.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **workspace_data_filter** | [**JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter**](JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingInRelationships from a JSON string +json_api_workspace_data_filter_setting_in_relationships_instance = JsonApiWorkspaceDataFilterSettingInRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingInRelationships.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_setting_in_relationships_dict = json_api_workspace_data_filter_setting_in_relationships_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingInRelationships from a dict +json_api_workspace_data_filter_setting_in_relationships_from_dict = JsonApiWorkspaceDataFilterSettingInRelationships.from_dict(json_api_workspace_data_filter_setting_in_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter.md index d75f58305..22cc0398b 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceDataFilterToOneLinkage**](JsonApiWorkspaceDataFilterToOneLinkage.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter import JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter from a JSON string +json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter_instance = JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter_dict = json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter from a dict +json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter_from_dict = JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter.from_dict(json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingLinkage.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingLinkage.md index 1e8c321cc..12e9880a3 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingLinkage.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "workspaceDataFilterSetting" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_linkage import JsonApiWorkspaceDataFilterSettingLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingLinkage from a JSON string +json_api_workspace_data_filter_setting_linkage_instance = JsonApiWorkspaceDataFilterSettingLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingLinkage.to_json()) +# convert the object into a dict +json_api_workspace_data_filter_setting_linkage_dict = json_api_workspace_data_filter_setting_linkage_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingLinkage from a dict +json_api_workspace_data_filter_setting_linkage_from_dict = JsonApiWorkspaceDataFilterSettingLinkage.from_dict(json_api_workspace_data_filter_setting_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOut.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOut.md index 0f9491fa0..e0ceda4c1 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOut.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOut.md @@ -3,15 +3,32 @@ JSON:API representation of workspaceDataFilterSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceDataFilterSetting" **attributes** | [**JsonApiWorkspaceDataFilterSettingInAttributes**](JsonApiWorkspaceDataFilterSettingInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiWorkspaceDataFilterSettingInRelationships**](JsonApiWorkspaceDataFilterSettingInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingOut from a JSON string +json_api_workspace_data_filter_setting_out_instance = JsonApiWorkspaceDataFilterSettingOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingOut.to_json()) +# convert the object into a dict +json_api_workspace_data_filter_setting_out_dict = json_api_workspace_data_filter_setting_out_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingOut from a dict +json_api_workspace_data_filter_setting_out_from_dict = JsonApiWorkspaceDataFilterSettingOut.from_dict(json_api_workspace_data_filter_setting_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutDocument.md index 20ee4e082..9a9c373a2 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceDataFilterSettingOut**](JsonApiWorkspaceDataFilterSettingOut.md) | | -**included** | [**[JsonApiWorkspaceDataFilterOutWithLinks]**](JsonApiWorkspaceDataFilterOutWithLinks.md) | Included resources | [optional] +**included** | [**List[JsonApiWorkspaceDataFilterOutWithLinks]**](JsonApiWorkspaceDataFilterOutWithLinks.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingOutDocument from a JSON string +json_api_workspace_data_filter_setting_out_document_instance = JsonApiWorkspaceDataFilterSettingOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingOutDocument.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_setting_out_document_dict = json_api_workspace_data_filter_setting_out_document_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingOutDocument from a dict +json_api_workspace_data_filter_setting_out_document_from_dict = JsonApiWorkspaceDataFilterSettingOutDocument.from_dict(json_api_workspace_data_filter_setting_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutList.md index 7d52d8999..6b3e63b64 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutList.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiWorkspaceDataFilterSettingOutWithLinks]**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | | -**included** | [**[JsonApiWorkspaceDataFilterOutWithLinks]**](JsonApiWorkspaceDataFilterOutWithLinks.md) | Included resources | [optional] +**data** | [**List[JsonApiWorkspaceDataFilterSettingOutWithLinks]**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | | +**included** | [**List[JsonApiWorkspaceDataFilterOutWithLinks]**](JsonApiWorkspaceDataFilterOutWithLinks.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingOutList from a JSON string +json_api_workspace_data_filter_setting_out_list_instance = JsonApiWorkspaceDataFilterSettingOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingOutList.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_setting_out_list_dict = json_api_workspace_data_filter_setting_out_list_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingOutList from a dict +json_api_workspace_data_filter_setting_out_list_from_dict = JsonApiWorkspaceDataFilterSettingOutList.from_dict(json_api_workspace_data_filter_setting_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutWithLinks.md index 1389a88cc..b35a34a15 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceDataFilterSetting" **attributes** | [**JsonApiWorkspaceDataFilterSettingInAttributes**](JsonApiWorkspaceDataFilterSettingInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **relationships** | [**JsonApiWorkspaceDataFilterSettingInRelationships**](JsonApiWorkspaceDataFilterSettingInRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingOutWithLinks from a JSON string +json_api_workspace_data_filter_setting_out_with_links_instance = JsonApiWorkspaceDataFilterSettingOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingOutWithLinks.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_setting_out_with_links_dict = json_api_workspace_data_filter_setting_out_with_links_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingOutWithLinks from a dict +json_api_workspace_data_filter_setting_out_with_links_from_dict = JsonApiWorkspaceDataFilterSettingOutWithLinks.from_dict(json_api_workspace_data_filter_setting_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingPatch.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingPatch.md index b82c81697..92a057401 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingPatch.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingPatch.md @@ -3,14 +3,31 @@ JSON:API representation of patching workspaceDataFilterSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceDataFilterSetting" **attributes** | [**JsonApiWorkspaceDataFilterSettingInAttributes**](JsonApiWorkspaceDataFilterSettingInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiWorkspaceDataFilterSettingInRelationships**](JsonApiWorkspaceDataFilterSettingInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch import JsonApiWorkspaceDataFilterSettingPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingPatch from a JSON string +json_api_workspace_data_filter_setting_patch_instance = JsonApiWorkspaceDataFilterSettingPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingPatch.to_json()) +# convert the object into a dict +json_api_workspace_data_filter_setting_patch_dict = json_api_workspace_data_filter_setting_patch_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingPatch from a dict +json_api_workspace_data_filter_setting_patch_from_dict = JsonApiWorkspaceDataFilterSettingPatch.from_dict(json_api_workspace_data_filter_setting_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingPatchDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingPatchDocument.md index b757fc1ae..76be1ef90 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceDataFilterSettingPatch**](JsonApiWorkspaceDataFilterSettingPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterSettingPatchDocument from a JSON string +json_api_workspace_data_filter_setting_patch_document_instance = JsonApiWorkspaceDataFilterSettingPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterSettingPatchDocument.to_json()) + +# convert the object into a dict +json_api_workspace_data_filter_setting_patch_document_dict = json_api_workspace_data_filter_setting_patch_document_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterSettingPatchDocument from a dict +json_api_workspace_data_filter_setting_patch_document_from_dict = JsonApiWorkspaceDataFilterSettingPatchDocument.from_dict(json_api_workspace_data_filter_setting_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingToManyLinkage.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingToManyLinkage.md deleted file mode 100644 index d8225cb29..000000000 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiWorkspaceDataFilterSettingToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiWorkspaceDataFilterSettingLinkage]**](JsonApiWorkspaceDataFilterSettingLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterToManyLinkage.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterToManyLinkage.md deleted file mode 100644 index 546ac3242..000000000 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterToManyLinkage.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonApiWorkspaceDataFilterToManyLinkage - -References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**[JsonApiWorkspaceDataFilterLinkage]**](JsonApiWorkspaceDataFilterLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterToOneLinkage.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterToOneLinkage.md index 042038b38..878fd537b 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "workspaceDataFilter" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_data_filter_to_one_linkage import JsonApiWorkspaceDataFilterToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceDataFilterToOneLinkage from a JSON string +json_api_workspace_data_filter_to_one_linkage_instance = JsonApiWorkspaceDataFilterToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceDataFilterToOneLinkage.to_json()) +# convert the object into a dict +json_api_workspace_data_filter_to_one_linkage_dict = json_api_workspace_data_filter_to_one_linkage_instance.to_dict() +# create an instance of JsonApiWorkspaceDataFilterToOneLinkage from a dict +json_api_workspace_data_filter_to_one_linkage_from_dict = JsonApiWorkspaceDataFilterToOneLinkage.from_dict(json_api_workspace_data_filter_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceIn.md b/gooddata-api-client/docs/JsonApiWorkspaceIn.md index c6df83edd..fb32f2ac2 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceIn.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceIn.md @@ -3,14 +3,31 @@ JSON:API representation of workspace entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspace" **attributes** | [**JsonApiWorkspaceInAttributes**](JsonApiWorkspaceInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiWorkspaceInRelationships**](JsonApiWorkspaceInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_in import JsonApiWorkspaceIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceIn from a JSON string +json_api_workspace_in_instance = JsonApiWorkspaceIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceIn.to_json()) +# convert the object into a dict +json_api_workspace_in_dict = json_api_workspace_in_instance.to_dict() +# create an instance of JsonApiWorkspaceIn from a dict +json_api_workspace_in_from_dict = JsonApiWorkspaceIn.from_dict(json_api_workspace_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceInAttributes.md b/gooddata-api-client/docs/JsonApiWorkspaceInAttributes.md index a5598028a..78daeface 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceInAttributes.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceInAttributes.md @@ -2,17 +2,34 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **cache_extra_limit** | **int** | | [optional] **data_source** | [**JsonApiWorkspaceInAttributesDataSource**](JsonApiWorkspaceInAttributesDataSource.md) | | [optional] -**description** | **str, none_type** | | [optional] -**early_access** | **str, none_type** | The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues. | [optional] -**early_access_values** | **[str], none_type** | The early access feature identifiers. They are used to enable experimental features. | [optional] -**name** | **str, none_type** | | [optional] -**prefix** | **str, none_type** | Custom prefix of entity identifiers in workspace | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**description** | **str** | | [optional] +**early_access** | **str** | The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues. | [optional] +**early_access_values** | **List[str]** | The early access feature identifiers. They are used to enable experimental features. | [optional] +**name** | **str** | | [optional] +**prefix** | **str** | Custom prefix of entity identifiers in workspace | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceInAttributes from a JSON string +json_api_workspace_in_attributes_instance = JsonApiWorkspaceInAttributes.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceInAttributes.to_json()) +# convert the object into a dict +json_api_workspace_in_attributes_dict = json_api_workspace_in_attributes_instance.to_dict() +# create an instance of JsonApiWorkspaceInAttributes from a dict +json_api_workspace_in_attributes_from_dict = JsonApiWorkspaceInAttributes.from_dict(json_api_workspace_in_attributes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceInAttributesDataSource.md b/gooddata-api-client/docs/JsonApiWorkspaceInAttributesDataSource.md index f9f13b34b..bf3bd2e88 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceInAttributesDataSource.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceInAttributesDataSource.md @@ -3,12 +3,29 @@ The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | The ID of the used data source. | -**schema_path** | **[str]** | The full schema path as array of its path parts. Will be rendered as subPath1.subPath2... | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**schema_path** | **List[str]** | The full schema path as array of its path parts. Will be rendered as subPath1.subPath2... | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_in_attributes_data_source import JsonApiWorkspaceInAttributesDataSource + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceInAttributesDataSource from a JSON string +json_api_workspace_in_attributes_data_source_instance = JsonApiWorkspaceInAttributesDataSource.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceInAttributesDataSource.to_json()) +# convert the object into a dict +json_api_workspace_in_attributes_data_source_dict = json_api_workspace_in_attributes_data_source_instance.to_dict() +# create an instance of JsonApiWorkspaceInAttributesDataSource from a dict +json_api_workspace_in_attributes_data_source_from_dict = JsonApiWorkspaceInAttributesDataSource.from_dict(json_api_workspace_in_attributes_data_source_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceInDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceInDocument.md index 7a638ea5a..e859543fa 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceInDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceIn**](JsonApiWorkspaceIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceInDocument from a JSON string +json_api_workspace_in_document_instance = JsonApiWorkspaceInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceInDocument.to_json()) + +# convert the object into a dict +json_api_workspace_in_document_dict = json_api_workspace_in_document_instance.to_dict() +# create an instance of JsonApiWorkspaceInDocument from a dict +json_api_workspace_in_document_from_dict = JsonApiWorkspaceInDocument.from_dict(json_api_workspace_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceInRelationships.md b/gooddata-api-client/docs/JsonApiWorkspaceInRelationships.md index 9f002a49d..0ea7d3b3d 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceInRelationships.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceInRelationships.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **parent** | [**JsonApiWorkspaceAutomationOutRelationshipsWorkspace**](JsonApiWorkspaceAutomationOutRelationshipsWorkspace.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceInRelationships from a JSON string +json_api_workspace_in_relationships_instance = JsonApiWorkspaceInRelationships.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceInRelationships.to_json()) + +# convert the object into a dict +json_api_workspace_in_relationships_dict = json_api_workspace_in_relationships_instance.to_dict() +# create an instance of JsonApiWorkspaceInRelationships from a dict +json_api_workspace_in_relationships_from_dict = JsonApiWorkspaceInRelationships.from_dict(json_api_workspace_in_relationships_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceLinkage.md b/gooddata-api-client/docs/JsonApiWorkspaceLinkage.md index db29379db..76306c399 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceLinkage.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceLinkage.md @@ -3,12 +3,29 @@ The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "workspace" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_linkage import JsonApiWorkspaceLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceLinkage from a JSON string +json_api_workspace_linkage_instance = JsonApiWorkspaceLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceLinkage.to_json()) +# convert the object into a dict +json_api_workspace_linkage_dict = json_api_workspace_linkage_instance.to_dict() +# create an instance of JsonApiWorkspaceLinkage from a dict +json_api_workspace_linkage_from_dict = JsonApiWorkspaceLinkage.from_dict(json_api_workspace_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceOut.md b/gooddata-api-client/docs/JsonApiWorkspaceOut.md index 87b21321d..7a1cf6307 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceOut.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceOut.md @@ -3,15 +3,32 @@ JSON:API representation of workspace entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspace" **attributes** | [**JsonApiWorkspaceInAttributes**](JsonApiWorkspaceInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiWorkspaceOutMeta**](JsonApiWorkspaceOutMeta.md) | | [optional] **relationships** | [**JsonApiWorkspaceInRelationships**](JsonApiWorkspaceInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_out import JsonApiWorkspaceOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceOut from a JSON string +json_api_workspace_out_instance = JsonApiWorkspaceOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceOut.to_json()) +# convert the object into a dict +json_api_workspace_out_dict = json_api_workspace_out_instance.to_dict() +# create an instance of JsonApiWorkspaceOut from a dict +json_api_workspace_out_from_dict = JsonApiWorkspaceOut.from_dict(json_api_workspace_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceOutDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceOutDocument.md index 6991c9531..680dd297a 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceOutDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceOutDocument.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceOut**](JsonApiWorkspaceOut.md) | | -**included** | [**[JsonApiWorkspaceOutWithLinks]**](JsonApiWorkspaceOutWithLinks.md) | Included resources | [optional] +**included** | [**List[JsonApiWorkspaceOutWithLinks]**](JsonApiWorkspaceOutWithLinks.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceOutDocument from a JSON string +json_api_workspace_out_document_instance = JsonApiWorkspaceOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceOutDocument.to_json()) + +# convert the object into a dict +json_api_workspace_out_document_dict = json_api_workspace_out_document_instance.to_dict() +# create an instance of JsonApiWorkspaceOutDocument from a dict +json_api_workspace_out_document_from_dict = JsonApiWorkspaceOutDocument.from_dict(json_api_workspace_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceOutList.md index 860a2b3b2..7351f0768 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceOutList.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceOutList.md @@ -3,14 +3,31 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiWorkspaceOutWithLinks]**](JsonApiWorkspaceOutWithLinks.md) | | -**included** | [**[JsonApiWorkspaceOutWithLinks]**](JsonApiWorkspaceOutWithLinks.md) | Included resources | [optional] +**data** | [**List[JsonApiWorkspaceOutWithLinks]**](JsonApiWorkspaceOutWithLinks.md) | | +**included** | [**List[JsonApiWorkspaceOutWithLinks]**](JsonApiWorkspaceOutWithLinks.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceOutList from a JSON string +json_api_workspace_out_list_instance = JsonApiWorkspaceOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceOutList.to_json()) + +# convert the object into a dict +json_api_workspace_out_list_dict = json_api_workspace_out_list_instance.to_dict() +# create an instance of JsonApiWorkspaceOutList from a dict +json_api_workspace_out_list_from_dict = JsonApiWorkspaceOutList.from_dict(json_api_workspace_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceOutMeta.md b/gooddata-api-client/docs/JsonApiWorkspaceOutMeta.md index e3696bf2a..8ef4e7625 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceOutMeta.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceOutMeta.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **config** | [**JsonApiWorkspaceOutMetaConfig**](JsonApiWorkspaceOutMetaConfig.md) | | [optional] **data_model** | [**JsonApiWorkspaceOutMetaDataModel**](JsonApiWorkspaceOutMetaDataModel.md) | | [optional] **hierarchy** | [**JsonApiWorkspaceOutMetaHierarchy**](JsonApiWorkspaceOutMetaHierarchy.md) | | [optional] -**permissions** | **[str]** | List of valid permissions for a logged-in user. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | **List[str]** | List of valid permissions for a logged-in user. | [optional] + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceOutMeta from a JSON string +json_api_workspace_out_meta_instance = JsonApiWorkspaceOutMeta.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceOutMeta.to_json()) +# convert the object into a dict +json_api_workspace_out_meta_dict = json_api_workspace_out_meta_instance.to_dict() +# create an instance of JsonApiWorkspaceOutMeta from a dict +json_api_workspace_out_meta_from_dict = JsonApiWorkspaceOutMeta.from_dict(json_api_workspace_out_meta_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceOutMetaConfig.md b/gooddata-api-client/docs/JsonApiWorkspaceOutMetaConfig.md index 3018650cd..f0735cd73 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceOutMetaConfig.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceOutMetaConfig.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approximate_count_available** | **bool** | is approximate count enabled - based on type of data-source connected to this workspace | [optional] if omitted the server will use the default value of False -**data_sampling_available** | **bool** | is sampling enabled - based on type of data-source connected to this workspace | [optional] if omitted the server will use the default value of False -**show_all_values_on_dates_available** | **bool** | is 'show all values' displayed for dates - based on type of data-source connected to this workspace | [optional] if omitted the server will use the default value of False -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**approximate_count_available** | **bool** | is approximate count enabled - based on type of data-source connected to this workspace | [optional] [default to False] +**data_sampling_available** | **bool** | is sampling enabled - based on type of data-source connected to this workspace | [optional] [default to False] +**show_all_values_on_dates_available** | **bool** | is 'show all values' displayed for dates - based on type of data-source connected to this workspace | [optional] [default to False] + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_out_meta_config import JsonApiWorkspaceOutMetaConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceOutMetaConfig from a JSON string +json_api_workspace_out_meta_config_instance = JsonApiWorkspaceOutMetaConfig.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceOutMetaConfig.to_json()) +# convert the object into a dict +json_api_workspace_out_meta_config_dict = json_api_workspace_out_meta_config_instance.to_dict() +# create an instance of JsonApiWorkspaceOutMetaConfig from a dict +json_api_workspace_out_meta_config_from_dict = JsonApiWorkspaceOutMetaConfig.from_dict(json_api_workspace_out_meta_config_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceOutMetaDataModel.md b/gooddata-api-client/docs/JsonApiWorkspaceOutMetaDataModel.md index 17a0852bf..89eb0f1dc 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceOutMetaDataModel.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceOutMetaDataModel.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dataset_count** | **int** | include the number of dataset of each workspace | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_out_meta_data_model import JsonApiWorkspaceOutMetaDataModel + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceOutMetaDataModel from a JSON string +json_api_workspace_out_meta_data_model_instance = JsonApiWorkspaceOutMetaDataModel.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceOutMetaDataModel.to_json()) + +# convert the object into a dict +json_api_workspace_out_meta_data_model_dict = json_api_workspace_out_meta_data_model_instance.to_dict() +# create an instance of JsonApiWorkspaceOutMetaDataModel from a dict +json_api_workspace_out_meta_data_model_from_dict = JsonApiWorkspaceOutMetaDataModel.from_dict(json_api_workspace_out_meta_data_model_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceOutMetaHierarchy.md b/gooddata-api-client/docs/JsonApiWorkspaceOutMetaHierarchy.md index c6e914ef4..4dc025365 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceOutMetaHierarchy.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceOutMetaHierarchy.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **children_count** | **int** | include the number of direct children of each workspace | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_out_meta_hierarchy import JsonApiWorkspaceOutMetaHierarchy + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceOutMetaHierarchy from a JSON string +json_api_workspace_out_meta_hierarchy_instance = JsonApiWorkspaceOutMetaHierarchy.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceOutMetaHierarchy.to_json()) + +# convert the object into a dict +json_api_workspace_out_meta_hierarchy_dict = json_api_workspace_out_meta_hierarchy_instance.to_dict() +# create an instance of JsonApiWorkspaceOutMetaHierarchy from a dict +json_api_workspace_out_meta_hierarchy_from_dict = JsonApiWorkspaceOutMetaHierarchy.from_dict(json_api_workspace_out_meta_hierarchy_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceOutWithLinks.md index 612ae493a..4583e135d 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceOutWithLinks.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspace" **attributes** | [**JsonApiWorkspaceInAttributes**](JsonApiWorkspaceInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiWorkspaceOutMeta**](JsonApiWorkspaceOutMeta.md) | | [optional] **relationships** | [**JsonApiWorkspaceInRelationships**](JsonApiWorkspaceInRelationships.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceOutWithLinks from a JSON string +json_api_workspace_out_with_links_instance = JsonApiWorkspaceOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceOutWithLinks.to_json()) + +# convert the object into a dict +json_api_workspace_out_with_links_dict = json_api_workspace_out_with_links_instance.to_dict() +# create an instance of JsonApiWorkspaceOutWithLinks from a dict +json_api_workspace_out_with_links_from_dict = JsonApiWorkspaceOutWithLinks.from_dict(json_api_workspace_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspacePatch.md b/gooddata-api-client/docs/JsonApiWorkspacePatch.md index 1b367daaf..393a54f50 100644 --- a/gooddata-api-client/docs/JsonApiWorkspacePatch.md +++ b/gooddata-api-client/docs/JsonApiWorkspacePatch.md @@ -3,14 +3,31 @@ JSON:API representation of patching workspace entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspace" **attributes** | [**JsonApiWorkspaceInAttributes**](JsonApiWorkspaceInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **relationships** | [**JsonApiWorkspaceInRelationships**](JsonApiWorkspaceInRelationships.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_patch import JsonApiWorkspacePatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspacePatch from a JSON string +json_api_workspace_patch_instance = JsonApiWorkspacePatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspacePatch.to_json()) +# convert the object into a dict +json_api_workspace_patch_dict = json_api_workspace_patch_instance.to_dict() +# create an instance of JsonApiWorkspacePatch from a dict +json_api_workspace_patch_from_dict = JsonApiWorkspacePatch.from_dict(json_api_workspace_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspacePatchDocument.md b/gooddata-api-client/docs/JsonApiWorkspacePatchDocument.md index e906e3c56..eb02f6095 100644 --- a/gooddata-api-client/docs/JsonApiWorkspacePatchDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspacePatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspacePatch**](JsonApiWorkspacePatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspacePatchDocument from a JSON string +json_api_workspace_patch_document_instance = JsonApiWorkspacePatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspacePatchDocument.to_json()) + +# convert the object into a dict +json_api_workspace_patch_document_dict = json_api_workspace_patch_document_instance.to_dict() +# create an instance of JsonApiWorkspacePatchDocument from a dict +json_api_workspace_patch_document_from_dict = JsonApiWorkspacePatchDocument.from_dict(json_api_workspace_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingIn.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingIn.md index 225c4be82..db3b8f5ba 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingIn.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingIn.md @@ -3,13 +3,30 @@ JSON:API representation of workspaceSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_setting_in import JsonApiWorkspaceSettingIn + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceSettingIn from a JSON string +json_api_workspace_setting_in_instance = JsonApiWorkspaceSettingIn.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceSettingIn.to_json()) +# convert the object into a dict +json_api_workspace_setting_in_dict = json_api_workspace_setting_in_instance.to_dict() +# create an instance of JsonApiWorkspaceSettingIn from a dict +json_api_workspace_setting_in_from_dict = JsonApiWorkspaceSettingIn.from_dict(json_api_workspace_setting_in_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingInDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingInDocument.md index f6fe1924a..8687db50a 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingInDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingInDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceSettingIn**](JsonApiWorkspaceSettingIn.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceSettingInDocument from a JSON string +json_api_workspace_setting_in_document_instance = JsonApiWorkspaceSettingInDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceSettingInDocument.to_json()) + +# convert the object into a dict +json_api_workspace_setting_in_document_dict = json_api_workspace_setting_in_document_instance.to_dict() +# create an instance of JsonApiWorkspaceSettingInDocument from a dict +json_api_workspace_setting_in_document_from_dict = JsonApiWorkspaceSettingInDocument.from_dict(json_api_workspace_setting_in_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingOut.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingOut.md index a7049defe..cccfb059c 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingOut.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingOut.md @@ -3,14 +3,31 @@ JSON:API representation of workspaceSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceSettingOut from a JSON string +json_api_workspace_setting_out_instance = JsonApiWorkspaceSettingOut.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceSettingOut.to_json()) +# convert the object into a dict +json_api_workspace_setting_out_dict = json_api_workspace_setting_out_instance.to_dict() +# create an instance of JsonApiWorkspaceSettingOut from a dict +json_api_workspace_setting_out_from_dict = JsonApiWorkspaceSettingOut.from_dict(json_api_workspace_setting_out_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingOutDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingOutDocument.md index ae2054538..02f191d4f 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingOutDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingOutDocument.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceSettingOut**](JsonApiWorkspaceSettingOut.md) | | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceSettingOutDocument from a JSON string +json_api_workspace_setting_out_document_instance = JsonApiWorkspaceSettingOutDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceSettingOutDocument.to_json()) + +# convert the object into a dict +json_api_workspace_setting_out_document_dict = json_api_workspace_setting_out_document_instance.to_dict() +# create an instance of JsonApiWorkspaceSettingOutDocument from a dict +json_api_workspace_setting_out_document_from_dict = JsonApiWorkspaceSettingOutDocument.from_dict(json_api_workspace_setting_out_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingOutList.md index f46fee7d4..6ac49ea3a 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingOutList.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingOutList.md @@ -3,13 +3,30 @@ A JSON:API document with a list of resources ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiWorkspaceSettingOutWithLinks]**](JsonApiWorkspaceSettingOutWithLinks.md) | | +**data** | [**List[JsonApiWorkspaceSettingOutWithLinks]**](JsonApiWorkspaceSettingOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceSettingOutList from a JSON string +json_api_workspace_setting_out_list_instance = JsonApiWorkspaceSettingOutList.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceSettingOutList.to_json()) + +# convert the object into a dict +json_api_workspace_setting_out_list_dict = json_api_workspace_setting_out_list_instance.to_dict() +# create an instance of JsonApiWorkspaceSettingOutList from a dict +json_api_workspace_setting_out_list_from_dict = JsonApiWorkspaceSettingOutList.from_dict(json_api_workspace_setting_out_list_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingOutWithLinks.md index e76e2d81b..fd0508afd 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingOutWithLinks.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**id** | **str** | API identifier of an object | **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**type** | **str** | Object type | **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_setting_out_with_links import JsonApiWorkspaceSettingOutWithLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceSettingOutWithLinks from a JSON string +json_api_workspace_setting_out_with_links_instance = JsonApiWorkspaceSettingOutWithLinks.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceSettingOutWithLinks.to_json()) + +# convert the object into a dict +json_api_workspace_setting_out_with_links_dict = json_api_workspace_setting_out_with_links_instance.to_dict() +# create an instance of JsonApiWorkspaceSettingOutWithLinks from a dict +json_api_workspace_setting_out_with_links_from_dict = JsonApiWorkspaceSettingOutWithLinks.from_dict(json_api_workspace_setting_out_with_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingPatch.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingPatch.md index 59f213615..ff15bd893 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingPatch.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingPatch.md @@ -3,13 +3,30 @@ JSON:API representation of patching workspaceSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | API identifier of an object | -**type** | **str** | Object type | defaults to "workspaceSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_setting_patch import JsonApiWorkspaceSettingPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceSettingPatch from a JSON string +json_api_workspace_setting_patch_instance = JsonApiWorkspaceSettingPatch.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceSettingPatch.to_json()) +# convert the object into a dict +json_api_workspace_setting_patch_dict = json_api_workspace_setting_patch_instance.to_dict() +# create an instance of JsonApiWorkspaceSettingPatch from a dict +json_api_workspace_setting_patch_from_dict = JsonApiWorkspaceSettingPatch.from_dict(json_api_workspace_setting_patch_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingPatchDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingPatchDocument.md index cca42c132..db0edbb4d 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingPatchDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingPatchDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceSettingPatch**](JsonApiWorkspaceSettingPatch.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceSettingPatchDocument from a JSON string +json_api_workspace_setting_patch_document_instance = JsonApiWorkspaceSettingPatchDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceSettingPatchDocument.to_json()) + +# convert the object into a dict +json_api_workspace_setting_patch_document_dict = json_api_workspace_setting_patch_document_instance.to_dict() +# create an instance of JsonApiWorkspaceSettingPatchDocument from a dict +json_api_workspace_setting_patch_document_from_dict = JsonApiWorkspaceSettingPatchDocument.from_dict(json_api_workspace_setting_patch_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingPostOptionalId.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingPostOptionalId.md index c2f4edf37..b0cd29169 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingPostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingPostOptionalId.md @@ -3,13 +3,30 @@ JSON:API representation of workspaceSetting entity. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | Object type | defaults to "workspaceSetting" **attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] **id** | **str** | API identifier of an object | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | Object type | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id import JsonApiWorkspaceSettingPostOptionalId + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceSettingPostOptionalId from a JSON string +json_api_workspace_setting_post_optional_id_instance = JsonApiWorkspaceSettingPostOptionalId.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceSettingPostOptionalId.to_json()) +# convert the object into a dict +json_api_workspace_setting_post_optional_id_dict = json_api_workspace_setting_post_optional_id_instance.to_dict() +# create an instance of JsonApiWorkspaceSettingPostOptionalId from a dict +json_api_workspace_setting_post_optional_id_from_dict = JsonApiWorkspaceSettingPostOptionalId.from_dict(json_api_workspace_setting_post_optional_id_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingPostOptionalIdDocument.md index 25ec9b36a..fa927898b 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingPostOptionalIdDocument.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiWorkspaceSettingPostOptionalId**](JsonApiWorkspaceSettingPostOptionalId.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceSettingPostOptionalIdDocument from a JSON string +json_api_workspace_setting_post_optional_id_document_instance = JsonApiWorkspaceSettingPostOptionalIdDocument.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceSettingPostOptionalIdDocument.to_json()) + +# convert the object into a dict +json_api_workspace_setting_post_optional_id_document_dict = json_api_workspace_setting_post_optional_id_document_instance.to_dict() +# create an instance of JsonApiWorkspaceSettingPostOptionalIdDocument from a dict +json_api_workspace_setting_post_optional_id_document_from_dict = JsonApiWorkspaceSettingPostOptionalIdDocument.from_dict(json_api_workspace_setting_post_optional_id_document_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceToOneLinkage.md b/gooddata-api-client/docs/JsonApiWorkspaceToOneLinkage.md index 051bb8eb6..2e4235544 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceToOneLinkage.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceToOneLinkage.md @@ -3,12 +3,29 @@ References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "workspace" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**id** | **str** | | +**type** | **str** | | + +## Example + +```python +from gooddata_api_client.models.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage + +# TODO update the JSON string below +json = "{}" +# create an instance of JsonApiWorkspaceToOneLinkage from a JSON string +json_api_workspace_to_one_linkage_instance = JsonApiWorkspaceToOneLinkage.from_json(json) +# print the JSON string representation of the object +print(JsonApiWorkspaceToOneLinkage.to_json()) +# convert the object into a dict +json_api_workspace_to_one_linkage_dict = json_api_workspace_to_one_linkage_instance.to_dict() +# create an instance of JsonApiWorkspaceToOneLinkage from a dict +json_api_workspace_to_one_linkage_from_dict = JsonApiWorkspaceToOneLinkage.from_dict(json_api_workspace_to_one_linkage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonNode.md b/gooddata-api-client/docs/JsonNode.md deleted file mode 100644 index 61f8c53c6..000000000 --- a/gooddata-api-client/docs/JsonNode.md +++ /dev/null @@ -1,12 +0,0 @@ -# JsonNode - -Free-form JSON object - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/KeyDriversDimension.md b/gooddata-api-client/docs/KeyDriversDimension.md index 5ab14f0a6..82d9031c0 100644 --- a/gooddata-api-client/docs/KeyDriversDimension.md +++ b/gooddata-api-client/docs/KeyDriversDimension.md @@ -2,17 +2,34 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute** | [**RestApiIdentifier**](RestApiIdentifier.md) | | **attribute_name** | **str** | | -**label** | [**RestApiIdentifier**](RestApiIdentifier.md) | | -**label_name** | **str** | | **format** | [**AttributeFormat**](AttributeFormat.md) | | [optional] **granularity** | **str** | | [optional] +**label** | [**RestApiIdentifier**](RestApiIdentifier.md) | | +**label_name** | **str** | | **value_type** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.key_drivers_dimension import KeyDriversDimension + +# TODO update the JSON string below +json = "{}" +# create an instance of KeyDriversDimension from a JSON string +key_drivers_dimension_instance = KeyDriversDimension.from_json(json) +# print the JSON string representation of the object +print(KeyDriversDimension.to_json()) + +# convert the object into a dict +key_drivers_dimension_dict = key_drivers_dimension_instance.to_dict() +# create an instance of KeyDriversDimension from a dict +key_drivers_dimension_from_dict = KeyDriversDimension.from_dict(key_drivers_dimension_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/KeyDriversRequest.md b/gooddata-api-client/docs/KeyDriversRequest.md index 0f41618f6..cc194edc3 100644 --- a/gooddata-api-client/docs/KeyDriversRequest.md +++ b/gooddata-api-client/docs/KeyDriversRequest.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**aux_metrics** | [**List[MeasureItem]**](MeasureItem.md) | Additional metrics to be included in the computation, but excluded from the analysis. | [optional] **metric** | [**MeasureItem**](MeasureItem.md) | | -**aux_metrics** | [**[MeasureItem]**](MeasureItem.md) | Additional metrics to be included in the computation, but excluded from the analysis. | [optional] -**sort_direction** | **str** | Sorting elements - ascending/descending order. | [optional] if omitted the server will use the default value of "DESC" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**sort_direction** | **str** | Sorting elements - ascending/descending order. | [optional] [default to 'DESC'] + +## Example + +```python +from gooddata_api_client.models.key_drivers_request import KeyDriversRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of KeyDriversRequest from a JSON string +key_drivers_request_instance = KeyDriversRequest.from_json(json) +# print the JSON string representation of the object +print(KeyDriversRequest.to_json()) +# convert the object into a dict +key_drivers_request_dict = key_drivers_request_instance.to_dict() +# create an instance of KeyDriversRequest from a dict +key_drivers_request_from_dict = KeyDriversRequest.from_dict(key_drivers_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/KeyDriversResponse.md b/gooddata-api-client/docs/KeyDriversResponse.md index 882ae2345..1d4c9bd77 100644 --- a/gooddata-api-client/docs/KeyDriversResponse.md +++ b/gooddata-api-client/docs/KeyDriversResponse.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dimensions** | [**[KeyDriversDimension]**](KeyDriversDimension.md) | | +**dimensions** | [**List[KeyDriversDimension]**](KeyDriversDimension.md) | | **links** | [**ExecutionLinks**](ExecutionLinks.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.key_drivers_response import KeyDriversResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of KeyDriversResponse from a JSON string +key_drivers_response_instance = KeyDriversResponse.from_json(json) +# print the JSON string representation of the object +print(KeyDriversResponse.to_json()) + +# convert the object into a dict +key_drivers_response_dict = key_drivers_response_instance.to_dict() +# create an instance of KeyDriversResponse from a dict +key_drivers_response_from_dict = KeyDriversResponse.from_dict(key_drivers_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/KeyDriversResult.md b/gooddata-api-client/docs/KeyDriversResult.md index d1d9a2933..1d2070a31 100644 --- a/gooddata-api-client/docs/KeyDriversResult.md +++ b/gooddata-api-client/docs/KeyDriversResult.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | **object** | | + +## Example + +```python +from gooddata_api_client.models.key_drivers_result import KeyDriversResult + +# TODO update the JSON string below +json = "{}" +# create an instance of KeyDriversResult from a JSON string +key_drivers_result_instance = KeyDriversResult.from_json(json) +# print the JSON string representation of the object +print(KeyDriversResult.to_json()) +# convert the object into a dict +key_drivers_result_dict = key_drivers_result_instance.to_dict() +# create an instance of KeyDriversResult from a dict +key_drivers_result_from_dict = KeyDriversResult.from_dict(key_drivers_result_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/LDMDeclarativeAPIsApi.md b/gooddata-api-client/docs/LDMDeclarativeAPIsApi.md index 30cd5729f..62101b19c 100644 --- a/gooddata-api-client/docs/LDMDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/LDMDeclarativeAPIsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **get_logical_model** -> DeclarativeModel get_logical_model(workspace_id) +> DeclarativeModel get_logical_model(workspace_id, include_parents=include_parents) Get logical model @@ -19,11 +19,11 @@ Retrieve current logical model of the workspace in declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import ldm_declarative_apis_api -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -32,37 +32,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = ldm_declarative_apis_api.LDMDeclarativeAPIsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.LDMDeclarativeAPIsApi(api_client) + workspace_id = 'workspace_id_example' # str | include_parents = True # bool | (optional) - # example passing only required values which don't have defaults set - try: - # Get logical model - api_response = api_instance.get_logical_model(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling LDMDeclarativeAPIsApi->get_logical_model: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get logical model api_response = api_instance.get_logical_model(workspace_id, include_parents=include_parents) + print("The response of LDMDeclarativeAPIsApi->get_logical_model:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LDMDeclarativeAPIsApi->get_logical_model: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **include_parents** | **bool**| | [optional] + **workspace_id** | **str**| | + **include_parents** | **bool**| | [optional] ### Return type @@ -77,7 +70,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -97,11 +89,11 @@ Set effective logical model of the workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import ldm_declarative_apis_api -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -110,180 +102,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = ldm_declarative_apis_api.LDMDeclarativeAPIsApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_model = DeclarativeModel( - ldm=DeclarativeLdm( - dataset_extensions=[ - DeclarativeDatasetExtension( - id="customers", - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - datasets=[ - DeclarativeDataset( - aggregated_facts=[ - DeclarativeAggregatedFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - source_column="customer_order_count", - source_column_data_type="NUMERIC", - source_fact_reference=DeclarativeSourceFactReference( - operation="SUM", - reference=FactIdentifier( - id="fact_id", - type="fact", - ), - ), - tags=["Customers"], - ), - ], - attributes=[ - DeclarativeAttribute( - default_view=LabelIdentifier( - id="label_id", - type="label", - ), - description="Customer name including first and last name.", - id="attr.customers.customer_name", - is_hidden=False, - labels=[ - DeclarativeLabel( - description="Customer name", - id="label.customer_name", - is_hidden=False, - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer name", - value_type="TEXT", - ), - ], - sort_column="customer_name", - sort_direction="ASC" | "DESC", - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer Name", - ), - ], - data_source_table_id=DataSourceTableIdentifier( - data_source_id="my-postgres", - id="customers", - path=["table_schema","table_name"], - type="dataSource", - ), - description="The customers of ours.", - facts=[ - DeclarativeFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - is_hidden=False, - source_column="customer_order_count", - source_column_data_type="NUMERIC", - tags=["Customers"], - title="Customer order count", - ), - ], - grain=[ - GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ], - id="customers", - precedence=0, - references=[ - DeclarativeReference( - identifier=ReferenceIdentifier( - id="customers", - type="DATASET", - ), - multivalue=False, - source_column_data_types=[ - "INT", - ], - source_columns=["customer_id"], - sources=[ - DeclarativeReferenceSource( - column="customer_id", - data_type="STRING", - target=GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ), - ], - ), - ], - sql=DeclarativeDatasetSql( - data_source_id="my-postgres", - statement="SELECT * FROM some_table", - ), - tags=["Customers"], - title="Customers", - workspace_data_filter_columns=[ - DeclarativeWorkspaceDataFilterColumn( - data_type="INT", - name="customer_id", - ), - ], - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - date_instances=[ - DeclarativeDateDataset( - description="A customer order date", - granularities=[ - "MINUTE", - ], - granularities_formatting=GranularitiesFormatting( - title_base="title_base_example", - title_pattern="%titleBase - %granularityTitle", - ), - id="date", - tags=["Customer dates"], - title="Date", - ), - ], - ), - ) # DeclarativeModel | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LDMDeclarativeAPIsApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_model = gooddata_api_client.DeclarativeModel() # DeclarativeModel | + try: # Set logical model api_instance.set_logical_model(workspace_id, declarative_model) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LDMDeclarativeAPIsApi->set_logical_model: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_model** | [**DeclarativeModel**](DeclarativeModel.md)| | + **workspace_id** | **str**| | + **declarative_model** | [**DeclarativeModel**](DeclarativeModel.md)| | ### Return type @@ -298,7 +138,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/LLMEndpointsApi.md b/gooddata-api-client/docs/LLMEndpointsApi.md index 6763be615..7662f9e74 100644 --- a/gooddata-api-client/docs/LLMEndpointsApi.md +++ b/gooddata-api-client/docs/LLMEndpointsApi.md @@ -21,12 +21,12 @@ Post LLM endpoint entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import llm_endpoints_api -from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -35,39 +35,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = llm_endpoints_api.LLMEndpointsApi(api_client) - json_api_llm_endpoint_in_document = JsonApiLlmEndpointInDocument( - data=JsonApiLlmEndpointIn( - attributes=JsonApiLlmEndpointInAttributes( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="OPENAI", - title="title_example", - token="token_example", - ), - id="id1", - type="llmEndpoint", - ), - ) # JsonApiLlmEndpointInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LLMEndpointsApi(api_client) + json_api_llm_endpoint_in_document = gooddata_api_client.JsonApiLlmEndpointInDocument() # JsonApiLlmEndpointInDocument | + try: # Post LLM endpoint entities api_response = api_instance.create_entity_llm_endpoints(json_api_llm_endpoint_in_document) + print("The response of LLMEndpointsApi->create_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LLMEndpointsApi->create_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | + **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | ### Return type @@ -82,7 +71,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -92,7 +80,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_llm_endpoints** -> delete_entity_llm_endpoints(id) +> delete_entity_llm_endpoints(id, filter=filter) @@ -100,10 +88,10 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import llm_endpoints_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -112,33 +100,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = llm_endpoints_api.LLMEndpointsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.LLMEndpointsApi(api_client) + id = 'id_example' # str | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - api_instance.delete_entity_llm_endpoints(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling LLMEndpointsApi->delete_entity_llm_endpoints: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: api_instance.delete_entity_llm_endpoints(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LLMEndpointsApi->delete_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -153,7 +135,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -163,7 +144,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_llm_endpoints** -> JsonApiLlmEndpointOutList get_all_entities_llm_endpoints() +> JsonApiLlmEndpointOutList get_all_entities_llm_endpoints(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all LLM endpoint entities @@ -171,11 +152,11 @@ Get all LLM endpoint entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import llm_endpoints_api -from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from gooddata_api_client.models.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -184,39 +165,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = llm_endpoints_api.LLMEndpointsApi(api_client) - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.LLMEndpointsApi(api_client) + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all LLM endpoint entities api_response = api_instance.get_all_entities_llm_endpoints(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of LLMEndpointsApi->get_all_entities_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LLMEndpointsApi->get_all_entities_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -231,7 +209,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -241,7 +218,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_llm_endpoints** -> JsonApiLlmEndpointOutDocument get_entity_llm_endpoints(id) +> JsonApiLlmEndpointOutDocument get_entity_llm_endpoints(id, filter=filter) Get LLM endpoint entity @@ -249,11 +226,11 @@ Get LLM endpoint entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import llm_endpoints_api -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -262,37 +239,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = llm_endpoints_api.LLMEndpointsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get LLM endpoint entity - api_response = api_instance.get_entity_llm_endpoints(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling LLMEndpointsApi->get_entity_llm_endpoints: %s\n" % e) + api_instance = gooddata_api_client.LLMEndpointsApi(api_client) + id = 'id_example' # str | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get LLM endpoint entity api_response = api_instance.get_entity_llm_endpoints(id, filter=filter) + print("The response of LLMEndpointsApi->get_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LLMEndpointsApi->get_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -307,7 +277,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -317,7 +286,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_llm_endpoints** -> JsonApiLlmEndpointOutDocument patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document) +> JsonApiLlmEndpointOutDocument patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document, filter=filter) Patch LLM endpoint entity @@ -325,12 +294,12 @@ Patch LLM endpoint entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import llm_endpoints_api -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument -from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -339,52 +308,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = llm_endpoints_api.LLMEndpointsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_llm_endpoint_patch_document = JsonApiLlmEndpointPatchDocument( - data=JsonApiLlmEndpointPatch( - attributes=JsonApiLlmEndpointPatchAttributes( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="OPENAI", - title="title_example", - token="token_example", - ), - id="id1", - type="llmEndpoint", - ), - ) # JsonApiLlmEndpointPatchDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch LLM endpoint entity - api_response = api_instance.patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling LLMEndpointsApi->patch_entity_llm_endpoints: %s\n" % e) + api_instance = gooddata_api_client.LLMEndpointsApi(api_client) + id = 'id_example' # str | + json_api_llm_endpoint_patch_document = gooddata_api_client.JsonApiLlmEndpointPatchDocument() # JsonApiLlmEndpointPatchDocument | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch LLM endpoint entity api_response = api_instance.patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document, filter=filter) + print("The response of LLMEndpointsApi->patch_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LLMEndpointsApi->patch_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_llm_endpoint_patch_document** | [**JsonApiLlmEndpointPatchDocument**](JsonApiLlmEndpointPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_llm_endpoint_patch_document** | [**JsonApiLlmEndpointPatchDocument**](JsonApiLlmEndpointPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -399,7 +348,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -409,7 +357,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_llm_endpoints** -> JsonApiLlmEndpointOutDocument update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document) +> JsonApiLlmEndpointOutDocument update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document, filter=filter) PUT LLM endpoint entity @@ -417,12 +365,12 @@ PUT LLM endpoint entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import llm_endpoints_api -from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -431,52 +379,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = llm_endpoints_api.LLMEndpointsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_llm_endpoint_in_document = JsonApiLlmEndpointInDocument( - data=JsonApiLlmEndpointIn( - attributes=JsonApiLlmEndpointInAttributes( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="OPENAI", - title="title_example", - token="token_example", - ), - id="id1", - type="llmEndpoint", - ), - ) # JsonApiLlmEndpointInDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # PUT LLM endpoint entity - api_response = api_instance.update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling LLMEndpointsApi->update_entity_llm_endpoints: %s\n" % e) + api_instance = gooddata_api_client.LLMEndpointsApi(api_client) + id = 'id_example' # str | + json_api_llm_endpoint_in_document = gooddata_api_client.JsonApiLlmEndpointInDocument() # JsonApiLlmEndpointInDocument | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # PUT LLM endpoint entity api_response = api_instance.update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document, filter=filter) + print("The response of LLMEndpointsApi->update_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LLMEndpointsApi->update_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -491,7 +419,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/LabelIdentifier.md b/gooddata-api-client/docs/LabelIdentifier.md index e7393aa7a..96b8d908c 100644 --- a/gooddata-api-client/docs/LabelIdentifier.md +++ b/gooddata-api-client/docs/LabelIdentifier.md @@ -3,12 +3,29 @@ A label identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Label ID. | -**type** | **str** | A type of the label. | defaults to "label" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | A type of the label. | + +## Example + +```python +from gooddata_api_client.models.label_identifier import LabelIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of LabelIdentifier from a JSON string +label_identifier_instance = LabelIdentifier.from_json(json) +# print the JSON string representation of the object +print(LabelIdentifier.to_json()) +# convert the object into a dict +label_identifier_dict = label_identifier_instance.to_dict() +# create an instance of LabelIdentifier from a dict +label_identifier_from_dict = LabelIdentifier.from_dict(label_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/LabelsApi.md b/gooddata-api-client/docs/LabelsApi.md index 5a7228ef8..7a8504e0a 100644 --- a/gooddata-api-client/docs/LabelsApi.md +++ b/gooddata-api-client/docs/LabelsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **get_all_entities_labels** -> JsonApiLabelOutList get_all_entities_labels(workspace_id) +> JsonApiLabelOutList get_all_entities_labels(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Labels @@ -17,11 +17,11 @@ Get all Labels ```python -import time import gooddata_api_client -from gooddata_api_client.api import labels_api -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -30,57 +30,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = labels_api.LabelsApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Labels - api_response = api_instance.get_all_entities_labels(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling LabelsApi->get_all_entities_labels: %s\n" % e) + api_instance = gooddata_api_client.LabelsApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;attribute.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attribute'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Labels api_response = api_instance.get_all_entities_labels(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of LabelsApi->get_all_entities_labels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LabelsApi->get_all_entities_labels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -95,7 +82,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -105,7 +91,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_labels** -> JsonApiLabelOutDocument get_entity_labels(workspace_id, object_id) +> JsonApiLabelOutDocument get_entity_labels(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Label @@ -113,11 +99,11 @@ Get a Label ```python -import time import gooddata_api_client -from gooddata_api_client.api import labels_api -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -126,49 +112,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = labels_api.LabelsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Label - api_response = api_instance.get_entity_labels(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling LabelsApi->get_entity_labels: %s\n" % e) + api_instance = gooddata_api_client.LabelsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;attribute.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attribute'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Label api_response = api_instance.get_entity_labels(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of LabelsApi->get_entity_labels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LabelsApi->get_entity_labels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -183,7 +158,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/LayoutApi.md b/gooddata-api-client/docs/LayoutApi.md index a49c2f32c..627cc4179 100644 --- a/gooddata-api-client/docs/LayoutApi.md +++ b/gooddata-api-client/docs/LayoutApi.md @@ -49,7 +49,7 @@ Method | HTTP request | Description # **get_analytics_model** -> DeclarativeAnalytics get_analytics_model(workspace_id) +> DeclarativeAnalytics get_analytics_model(workspace_id, exclude=exclude) Get analytics model @@ -59,11 +59,11 @@ Retrieve current analytics model of the workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -72,39 +72,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - try: - # Get analytics model - api_response = api_instance.get_analytics_model(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling LayoutApi->get_analytics_model: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get analytics model api_response = api_instance.get_analytics_model(workspace_id, exclude=exclude) + print("The response of LayoutApi->get_analytics_model:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_analytics_model: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **exclude** | **[str]**| | [optional] + **workspace_id** | **str**| | + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type @@ -119,7 +110,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -129,7 +119,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_automations** -> [DeclarativeAutomation] get_automations(workspace_id) +> List[DeclarativeAutomation] get_automations(workspace_id, exclude=exclude) Get automations @@ -139,11 +129,11 @@ Retrieve automations for the specific workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_automation import DeclarativeAutomation +from gooddata_api_client.models.declarative_automation import DeclarativeAutomation +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -152,43 +142,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - try: - # Get automations - api_response = api_instance.get_automations(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling LayoutApi->get_automations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get automations api_response = api_instance.get_automations(workspace_id, exclude=exclude) + print("The response of LayoutApi->get_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **exclude** | **[str]**| | [optional] + **workspace_id** | **str**| | + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type -[**[DeclarativeAutomation]**](DeclarativeAutomation.md) +[**List[DeclarativeAutomation]**](DeclarativeAutomation.md) ### Authorization @@ -199,7 +180,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -219,11 +199,11 @@ Retrieve current set of permissions of the data source in a declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.models.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -232,26 +212,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - data_source_id = "dataSourceId_example" # str | + api_instance = gooddata_api_client.LayoutApi(api_client) + data_source_id = 'data_source_id_example' # str | - # example passing only required values which don't have defaults set try: # Get permissions for the data source api_response = api_instance.get_data_source_permissions(data_source_id) + print("The response of LayoutApi->get_data_source_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_data_source_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | + **data_source_id** | **str**| | ### Return type @@ -266,7 +248,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -286,11 +267,11 @@ Retrieve all data sources including related physical model. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -299,21 +280,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) + api_instance = gooddata_api_client.LayoutApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all data sources api_response = api_instance.get_data_sources_layout() + print("The response of LayoutApi->get_data_sources_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_data_sources_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -329,7 +312,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -349,11 +331,11 @@ Gets complete layout of export templates. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.models.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -362,21 +344,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) + api_instance = gooddata_api_client.LayoutApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all export templates layout api_response = api_instance.get_export_templates_layout() + print("The response of LayoutApi->get_export_templates_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_export_templates_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -392,7 +376,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -402,7 +385,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_filter_views** -> [DeclarativeFilterView] get_filter_views(workspace_id) +> List[DeclarativeFilterView] get_filter_views(workspace_id, exclude=exclude) Get filter views @@ -412,11 +395,11 @@ Retrieve filter views for the specific workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.models.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -425,43 +408,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) - - # example passing only required values which don't have defaults set - try: - # Get filter views - api_response = api_instance.get_filter_views(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling LayoutApi->get_filter_views: %s\n" % e) + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get filter views api_response = api_instance.get_filter_views(workspace_id, exclude=exclude) + print("The response of LayoutApi->get_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **exclude** | **[str]**| | [optional] + **workspace_id** | **str**| | + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type -[**[DeclarativeFilterView]**](DeclarativeFilterView.md) +[**List[DeclarativeFilterView]**](DeclarativeFilterView.md) ### Authorization @@ -472,7 +446,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -482,7 +455,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_identity_providers_layout** -> [DeclarativeIdentityProvider] get_identity_providers_layout() +> List[DeclarativeIdentityProvider] get_identity_providers_layout() Get all identity providers layout @@ -492,11 +465,11 @@ Gets complete layout of identity providers. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.models.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -505,26 +478,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) + api_instance = gooddata_api_client.LayoutApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all identity providers layout api_response = api_instance.get_identity_providers_layout() + print("The response of LayoutApi->get_identity_providers_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_identity_providers_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -[**[DeclarativeIdentityProvider]**](DeclarativeIdentityProvider.md) +[**List[DeclarativeIdentityProvider]**](DeclarativeIdentityProvider.md) ### Authorization @@ -535,7 +510,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -545,7 +519,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_logical_model** -> DeclarativeModel get_logical_model(workspace_id) +> DeclarativeModel get_logical_model(workspace_id, include_parents=include_parents) Get logical model @@ -555,11 +529,11 @@ Retrieve current logical model of the workspace in declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -568,37 +542,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | include_parents = True # bool | (optional) - # example passing only required values which don't have defaults set - try: - # Get logical model - api_response = api_instance.get_logical_model(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling LayoutApi->get_logical_model: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get logical model api_response = api_instance.get_logical_model(workspace_id, include_parents=include_parents) + print("The response of LayoutApi->get_logical_model:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_logical_model: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **include_parents** | **bool**| | [optional] + **workspace_id** | **str**| | + **include_parents** | **bool**| | [optional] ### Return type @@ -613,7 +580,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -633,11 +599,11 @@ Gets complete layout of notification channels. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.models.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -646,21 +612,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) + api_instance = gooddata_api_client.LayoutApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all notification channels layout api_response = api_instance.get_notification_channels_layout() + print("The response of LayoutApi->get_notification_channels_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_notification_channels_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -676,7 +644,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -686,7 +653,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_organization_layout** -> DeclarativeOrganization get_organization_layout() +> DeclarativeOrganization get_organization_layout(exclude=exclude) Get organization layout @@ -696,11 +663,11 @@ Retrieve complete layout of organization, workspaces, user-groups, etc. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -709,29 +676,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) + api_instance = gooddata_api_client.LayoutApi(api_client) + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get organization layout api_response = api_instance.get_organization_layout(exclude=exclude) + print("The response of LayoutApi->get_organization_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_organization_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **exclude** | **[str]**| | [optional] + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type @@ -746,7 +712,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -756,7 +721,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_organization_permissions** -> [DeclarativeOrganizationPermission] get_organization_permissions() +> List[DeclarativeOrganizationPermission] get_organization_permissions() Get organization permissions @@ -766,11 +731,11 @@ Retrieve organization permissions ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -779,26 +744,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) + api_instance = gooddata_api_client.LayoutApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get organization permissions api_response = api_instance.get_organization_permissions() + print("The response of LayoutApi->get_organization_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_organization_permissions: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -[**[DeclarativeOrganizationPermission]**](DeclarativeOrganizationPermission.md) +[**List[DeclarativeOrganizationPermission]**](DeclarativeOrganizationPermission.md) ### Authorization @@ -809,7 +776,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -829,11 +795,11 @@ Retrieve current user data filters assigned to the workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -842,26 +808,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Get user data filters api_response = api_instance.get_user_data_filters(workspace_id) + print("The response of LayoutApi->get_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type @@ -876,7 +844,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -896,11 +863,11 @@ Retrieve current set of permissions of the user-group in a declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -909,26 +876,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - user_group_id = "userGroupId_example" # str | + api_instance = gooddata_api_client.LayoutApi(api_client) + user_group_id = 'user_group_id_example' # str | - # example passing only required values which don't have defaults set try: # Get permissions for the user-group api_response = api_instance.get_user_group_permissions(user_group_id) + print("The response of LayoutApi->get_user_group_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_user_group_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_group_id** | **str**| | + **user_group_id** | **str**| | ### Return type @@ -943,7 +912,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -963,11 +931,11 @@ Retrieve all user-groups eventually with parent group. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -976,21 +944,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) + api_instance = gooddata_api_client.LayoutApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all user groups api_response = api_instance.get_user_groups_layout() + print("The response of LayoutApi->get_user_groups_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_user_groups_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -1006,7 +976,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1026,11 +995,11 @@ Retrieve current set of permissions of the user in a declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1039,26 +1008,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - user_id = "userId_example" # str | + api_instance = gooddata_api_client.LayoutApi(api_client) + user_id = 'user_id_example' # str | - # example passing only required values which don't have defaults set try: # Get permissions for the user api_response = api_instance.get_user_permissions(user_id) + print("The response of LayoutApi->get_user_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_user_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | + **user_id** | **str**| | ### Return type @@ -1073,7 +1044,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1093,11 +1063,11 @@ Retrieve all users including authentication properties. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1106,21 +1076,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) + api_instance = gooddata_api_client.LayoutApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all users api_response = api_instance.get_users_layout() + print("The response of LayoutApi->get_users_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_users_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -1136,7 +1108,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1156,11 +1127,11 @@ Retrieve all users and user groups with theirs properties. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1169,21 +1140,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) + api_instance = gooddata_api_client.LayoutApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all users and user groups api_response = api_instance.get_users_user_groups_layout() + print("The response of LayoutApi->get_users_user_groups_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_users_user_groups_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -1199,7 +1172,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1219,11 +1191,11 @@ Retrieve all workspaces and related workspace data filters (and their settings / ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1232,21 +1204,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) + api_instance = gooddata_api_client.LayoutApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get workspace data filters for all workspaces api_response = api_instance.get_workspace_data_filters_layout() + print("The response of LayoutApi->get_workspace_data_filters_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_workspace_data_filters_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -1262,7 +1236,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1272,7 +1245,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_workspace_layout** -> DeclarativeWorkspaceModel get_workspace_layout(workspace_id) +> DeclarativeWorkspaceModel get_workspace_layout(workspace_id, exclude=exclude) Get workspace layout @@ -1282,11 +1255,11 @@ Retrieve current model of the workspace in declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1295,39 +1268,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) - - # example passing only required values which don't have defaults set - try: - # Get workspace layout - api_response = api_instance.get_workspace_layout(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling LayoutApi->get_workspace_layout: %s\n" % e) + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get workspace layout api_response = api_instance.get_workspace_layout(workspace_id, exclude=exclude) + print("The response of LayoutApi->get_workspace_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_workspace_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **exclude** | **[str]**| | [optional] + **workspace_id** | **str**| | + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type @@ -1342,7 +1306,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1362,11 +1325,11 @@ Retrieve current set of permissions of the workspace in a declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1375,26 +1338,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Get permissions for the workspace api_response = api_instance.get_workspace_permissions(workspace_id) + print("The response of LayoutApi->get_workspace_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_workspace_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type @@ -1409,7 +1374,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1419,7 +1383,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_workspaces_layout** -> DeclarativeWorkspaces get_workspaces_layout() +> DeclarativeWorkspaces get_workspaces_layout(exclude=exclude) Get all workspaces layout @@ -1429,11 +1393,11 @@ Gets complete layout of workspaces, their hierarchy, models. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1442,29 +1406,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) + api_instance = gooddata_api_client.LayoutApi(api_client) + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all workspaces layout api_response = api_instance.get_workspaces_layout(exclude=exclude) + print("The response of LayoutApi->get_workspaces_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->get_workspaces_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **exclude** | **[str]**| | [optional] + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type @@ -1479,7 +1442,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1499,11 +1461,11 @@ Set all data sources including related physical model. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1512,65 +1474,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - declarative_data_sources = DeclarativeDataSources( - data_sources=[ - DeclarativeDataSource( - authentication_type="USERNAME_PASSWORD", - cache_strategy="ALWAYS", - client_id="client1234", - client_secret="client_secret_example", - decoded_parameters=[ - Parameter( - name="name_example", - value="value_example", - ), - ], - id="pg_local_docker-demo", - name="postgres demo", - parameters=[ - Parameter( - name="name_example", - value="value_example", - ), - ], - password="*****", - permissions=[ - DeclarativeDataSourcePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="demo", - token="Bigquery service account JSON. Encode it using base64!", - type="POSTGRESQL", - url="jdbc:postgresql://postgres:5432/gooddata", - username="demo", - ), - ], - ) # DeclarativeDataSources | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + declarative_data_sources = gooddata_api_client.DeclarativeDataSources() # DeclarativeDataSources | + try: # Put all data sources api_instance.put_data_sources_layout(declarative_data_sources) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->put_data_sources_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_data_sources** | [**DeclarativeDataSources**](DeclarativeDataSources.md)| | + **declarative_data_sources** | [**DeclarativeDataSources**](DeclarativeDataSources.md)| | ### Return type @@ -1585,7 +1508,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1605,11 +1527,11 @@ Define all user groups with their parents eventually. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1618,47 +1540,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - declarative_user_groups = DeclarativeUserGroups( - user_groups=[ - DeclarativeUserGroup( - id="employees.all", - name="admins", - parents=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - permissions=[ - DeclarativeUserGroupPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - ), - ], - ) # DeclarativeUserGroups | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + declarative_user_groups = gooddata_api_client.DeclarativeUserGroups() # DeclarativeUserGroups | + try: # Put all user groups api_instance.put_user_groups_layout(declarative_user_groups) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->put_user_groups_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_user_groups** | [**DeclarativeUserGroups**](DeclarativeUserGroups.md)| | + **declarative_user_groups** | [**DeclarativeUserGroups**](DeclarativeUserGroups.md)| | ### Return type @@ -1673,7 +1574,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1693,11 +1593,11 @@ Set all users and their authentication properties. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1706,57 +1606,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - declarative_users = DeclarativeUsers( - users=[ - DeclarativeUser( - auth_id="auth_id_example", - email="user@example.com", - firstname="John", - id="employee123", - lastname="Wick", - permissions=[ - DeclarativeUserPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - user_groups=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - ), - ], - ) # DeclarativeUsers | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + declarative_users = gooddata_api_client.DeclarativeUsers() # DeclarativeUsers | + try: # Put all users api_instance.put_users_layout(declarative_users) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->put_users_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_users** | [**DeclarativeUsers**](DeclarativeUsers.md)| | + **declarative_users** | [**DeclarativeUsers**](DeclarativeUsers.md)| | ### Return type @@ -1771,7 +1640,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1791,11 +1659,11 @@ Define all users and user groups with theirs properties. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1804,78 +1672,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - declarative_users_user_groups = DeclarativeUsersUserGroups( - user_groups=[ - DeclarativeUserGroup( - id="employees.all", - name="admins", - parents=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - permissions=[ - DeclarativeUserGroupPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - ), - ], - users=[ - DeclarativeUser( - auth_id="auth_id_example", - email="user@example.com", - firstname="John", - id="employee123", - lastname="Wick", - permissions=[ - DeclarativeUserPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - user_groups=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - ), - ], - ) # DeclarativeUsersUserGroups | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + declarative_users_user_groups = gooddata_api_client.DeclarativeUsersUserGroups() # DeclarativeUsersUserGroups | + try: # Put all users and user groups api_instance.put_users_user_groups_layout(declarative_users_user_groups) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->put_users_user_groups_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_users_user_groups** | [**DeclarativeUsersUserGroups**](DeclarativeUsersUserGroups.md)| | + **declarative_users_user_groups** | [**DeclarativeUsersUserGroups**](DeclarativeUsersUserGroups.md)| | ### Return type @@ -1890,7 +1706,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1910,11 +1725,11 @@ Set complete layout of workspace, like model, authorization, etc. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1923,317 +1738,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_workspace_model = DeclarativeWorkspaceModel( - analytics=DeclarativeAnalyticsLayer( - analytical_dashboard_extensions=[ - DeclarativeAnalyticalDashboardExtension( - id="revenues-analysis", - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - ), - ], - analytical_dashboards=[ - DeclarativeAnalyticalDashboard( - content=JsonNode(), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Period to period comparison of revenues in main sectors.", - id="revenues-analysis", - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - tags=["Revenues"], - title="Revenues analysis", - ), - ], - attribute_hierarchies=[ - DeclarativeAttributeHierarchy( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - dashboard_plugins=[ - DeclarativeDashboardPlugin( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Three dimensional view of data.", - id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="3D map renderer", - ), - ], - export_definitions=[ - DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="export-definition-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), - tags=["Revenues"], - title="My regular export", - ), - ], - filter_contexts=[ - DeclarativeFilterContext( - content=JsonNode(), - description="Filter Context for Sales team.", - id="filter-sales", - tags=["Revenues"], - title="Filter Context for Sales team", - ), - ], - metrics=[ - DeclarativeMetric( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Sales for all the data available.", - id="total-sales", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Total sales", - ), - ], - visualization_objects=[ - DeclarativeVisualizationObject( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="visualization-1", - is_hidden=False, - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - ), - ldm=DeclarativeLdm( - dataset_extensions=[ - DeclarativeDatasetExtension( - id="customers", - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - datasets=[ - DeclarativeDataset( - aggregated_facts=[ - DeclarativeAggregatedFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - source_column="customer_order_count", - source_column_data_type="NUMERIC", - source_fact_reference=DeclarativeSourceFactReference( - operation="SUM", - reference=FactIdentifier( - id="fact_id", - type="fact", - ), - ), - tags=["Customers"], - ), - ], - attributes=[ - DeclarativeAttribute( - default_view=LabelIdentifier( - id="label_id", - type="label", - ), - description="Customer name including first and last name.", - id="attr.customers.customer_name", - is_hidden=False, - labels=[ - DeclarativeLabel( - description="Customer name", - id="label.customer_name", - is_hidden=False, - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer name", - value_type="TEXT", - ), - ], - sort_column="customer_name", - sort_direction="ASC" | "DESC", - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer Name", - ), - ], - data_source_table_id=DataSourceTableIdentifier( - data_source_id="my-postgres", - id="customers", - path=["table_schema","table_name"], - type="dataSource", - ), - description="The customers of ours.", - facts=[ - DeclarativeFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - is_hidden=False, - source_column="customer_order_count", - source_column_data_type="NUMERIC", - tags=["Customers"], - title="Customer order count", - ), - ], - grain=[ - GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ], - id="customers", - precedence=0, - references=[ - DeclarativeReference( - identifier=ReferenceIdentifier( - id="customers", - type="DATASET", - ), - multivalue=False, - source_column_data_types=[ - "INT", - ], - source_columns=["customer_id"], - sources=[ - DeclarativeReferenceSource( - column="customer_id", - data_type="STRING", - target=GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ), - ], - ), - ], - sql=DeclarativeDatasetSql( - data_source_id="my-postgres", - statement="SELECT * FROM some_table", - ), - tags=["Customers"], - title="Customers", - workspace_data_filter_columns=[ - DeclarativeWorkspaceDataFilterColumn( - data_type="INT", - name="customer_id", - ), - ], - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - date_instances=[ - DeclarativeDateDataset( - description="A customer order date", - granularities=[ - "MINUTE", - ], - granularities_formatting=GranularitiesFormatting( - title_base="title_base_example", - title_pattern="%titleBase - %granularityTitle", - ), - id="date", - tags=["Customer dates"], - title="Date", - ), - ], - ), - ) # DeclarativeWorkspaceModel | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_workspace_model = gooddata_api_client.DeclarativeWorkspaceModel() # DeclarativeWorkspaceModel | + try: # Set workspace layout api_instance.put_workspace_layout(workspace_id, declarative_workspace_model) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->put_workspace_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_workspace_model** | [**DeclarativeWorkspaceModel**](DeclarativeWorkspaceModel.md)| | + **workspace_id** | **str**| | + **declarative_workspace_model** | [**DeclarativeWorkspaceModel**](DeclarativeWorkspaceModel.md)| | ### Return type @@ -2248,7 +1774,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2268,11 +1793,11 @@ Set effective analytics model of the workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2281,165 +1806,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_analytics = DeclarativeAnalytics( - analytics=DeclarativeAnalyticsLayer( - analytical_dashboard_extensions=[ - DeclarativeAnalyticalDashboardExtension( - id="revenues-analysis", - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - ), - ], - analytical_dashboards=[ - DeclarativeAnalyticalDashboard( - content=JsonNode(), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Period to period comparison of revenues in main sectors.", - id="revenues-analysis", - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - tags=["Revenues"], - title="Revenues analysis", - ), - ], - attribute_hierarchies=[ - DeclarativeAttributeHierarchy( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - dashboard_plugins=[ - DeclarativeDashboardPlugin( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Three dimensional view of data.", - id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="3D map renderer", - ), - ], - export_definitions=[ - DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="export-definition-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), - tags=["Revenues"], - title="My regular export", - ), - ], - filter_contexts=[ - DeclarativeFilterContext( - content=JsonNode(), - description="Filter Context for Sales team.", - id="filter-sales", - tags=["Revenues"], - title="Filter Context for Sales team", - ), - ], - metrics=[ - DeclarativeMetric( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Sales for all the data available.", - id="total-sales", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Total sales", - ), - ], - visualization_objects=[ - DeclarativeVisualizationObject( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="visualization-1", - is_hidden=False, - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - ), - ) # DeclarativeAnalytics | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_analytics = gooddata_api_client.DeclarativeAnalytics() # DeclarativeAnalytics | + try: # Set analytics model api_instance.set_analytics_model(workspace_id, declarative_analytics) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_analytics_model: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_analytics** | [**DeclarativeAnalytics**](DeclarativeAnalytics.md)| | + **workspace_id** | **str**| | + **declarative_analytics** | [**DeclarativeAnalytics**](DeclarativeAnalytics.md)| | ### Return type @@ -2454,7 +1842,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2474,11 +1861,11 @@ Set automations for the specific workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_automation import DeclarativeAutomation +from gooddata_api_client.models.declarative_automation import DeclarativeAutomation +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2487,287 +1874,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_automation = [ - DeclarativeAutomation( - alert=AutomationAlert( - condition=AutomationAlertCondition(None), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - dashboard_tabular_exports=[ - AutomationDashboardTabularExport( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={ - "key": "key_example", - }, - evaluation_mode="PER_RECIPIENT", - export_definitions=[ - DeclarativeExportDefinitionIdentifier( - id="export123", - type="exportDefinition", - ), - ], - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - id="/6bUUGjjNSwg0_bs", - image_exports=[ - AutomationImageExport( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=AutomationMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - notification_channel=DeclarativeNotificationChannelIdentifier( - id="webhook123", - type="notificationChannel", - ), - raw_exports=[ - AutomationRawExport( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - recipients=[ - DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ], - schedule=AutomationSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - AutomationSlidesExport( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - AutomationTabularExport( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - visual_exports=[ - AutomationVisualExport( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - ] # [DeclarativeAutomation] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_automation = [gooddata_api_client.DeclarativeAutomation()] # List[DeclarativeAutomation] | + try: # Set automations api_instance.set_automations(workspace_id, declarative_automation) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_automation** | [**[DeclarativeAutomation]**](DeclarativeAutomation.md)| | + **workspace_id** | **str**| | + **declarative_automation** | [**List[DeclarativeAutomation]**](DeclarativeAutomation.md)| | ### Return type @@ -2782,7 +1910,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2802,11 +1929,11 @@ set data source permissions. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.models.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2815,37 +1942,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - data_source_id = "dataSourceId_example" # str | - declarative_data_source_permissions = DeclarativeDataSourcePermissions( - permissions=[ - DeclarativeDataSourcePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - ) # DeclarativeDataSourcePermissions | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + data_source_id = 'data_source_id_example' # str | + declarative_data_source_permissions = gooddata_api_client.DeclarativeDataSourcePermissions() # DeclarativeDataSourcePermissions | + try: # Set data source permissions. api_instance.set_data_source_permissions(data_source_id, declarative_data_source_permissions) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_data_source_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | - **declarative_data_source_permissions** | [**DeclarativeDataSourcePermissions**](DeclarativeDataSourcePermissions.md)| | + **data_source_id** | **str**| | + **declarative_data_source_permissions** | [**DeclarativeDataSourcePermissions**](DeclarativeDataSourcePermissions.md)| | ### Return type @@ -2860,7 +1978,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2880,11 +1997,11 @@ Sets export templates in organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.models.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2893,99 +2010,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - declarative_export_templates = DeclarativeExportTemplates( - export_templates=[ - DeclarativeExportTemplate( - dashboard_slides_template=DashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - id="default-export-template", - name="My default export template", - widget_slides_template=WidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - ], - ) # DeclarativeExportTemplates | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + declarative_export_templates = gooddata_api_client.DeclarativeExportTemplates() # DeclarativeExportTemplates | + try: # Set all export templates api_instance.set_export_templates(declarative_export_templates) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_export_templates** | [**DeclarativeExportTemplates**](DeclarativeExportTemplates.md)| | + **declarative_export_templates** | [**DeclarativeExportTemplates**](DeclarativeExportTemplates.md)| | ### Return type @@ -3000,7 +2044,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3020,11 +2063,11 @@ Set filter views for the specific workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.models.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3033,46 +2076,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_filter_view = [ - DeclarativeFilterView( - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - content=JsonNode(), - description="description_example", - id="filterView-1", - is_default=True, - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ), - ] # [DeclarativeFilterView] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_filter_view = [gooddata_api_client.DeclarativeFilterView()] # List[DeclarativeFilterView] | + try: # Set filter views api_instance.set_filter_views(workspace_id, declarative_filter_view) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_filter_view** | [**[DeclarativeFilterView]**](DeclarativeFilterView.md)| | + **workspace_id** | **str**| | + **declarative_filter_view** | [**List[DeclarativeFilterView]**](DeclarativeFilterView.md)| | ### Return type @@ -3087,7 +2112,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3107,11 +2131,11 @@ Sets identity providers in organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.models.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3120,46 +2144,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - declarative_identity_provider = [ - DeclarativeIdentityProvider( - custom_claim_mapping={ - "key": "key_example", - }, - id="filterView-1", - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - ] # [DeclarativeIdentityProvider] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + declarative_identity_provider = [gooddata_api_client.DeclarativeIdentityProvider()] # List[DeclarativeIdentityProvider] | + try: # Set all identity providers api_instance.set_identity_providers(declarative_identity_provider) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_identity_provider** | [**[DeclarativeIdentityProvider]**](DeclarativeIdentityProvider.md)| | + **declarative_identity_provider** | [**List[DeclarativeIdentityProvider]**](DeclarativeIdentityProvider.md)| | ### Return type @@ -3174,7 +2178,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3194,11 +2197,11 @@ Set effective logical model of the workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3207,180 +2210,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_model = DeclarativeModel( - ldm=DeclarativeLdm( - dataset_extensions=[ - DeclarativeDatasetExtension( - id="customers", - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - datasets=[ - DeclarativeDataset( - aggregated_facts=[ - DeclarativeAggregatedFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - source_column="customer_order_count", - source_column_data_type="NUMERIC", - source_fact_reference=DeclarativeSourceFactReference( - operation="SUM", - reference=FactIdentifier( - id="fact_id", - type="fact", - ), - ), - tags=["Customers"], - ), - ], - attributes=[ - DeclarativeAttribute( - default_view=LabelIdentifier( - id="label_id", - type="label", - ), - description="Customer name including first and last name.", - id="attr.customers.customer_name", - is_hidden=False, - labels=[ - DeclarativeLabel( - description="Customer name", - id="label.customer_name", - is_hidden=False, - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer name", - value_type="TEXT", - ), - ], - sort_column="customer_name", - sort_direction="ASC" | "DESC", - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer Name", - ), - ], - data_source_table_id=DataSourceTableIdentifier( - data_source_id="my-postgres", - id="customers", - path=["table_schema","table_name"], - type="dataSource", - ), - description="The customers of ours.", - facts=[ - DeclarativeFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - is_hidden=False, - source_column="customer_order_count", - source_column_data_type="NUMERIC", - tags=["Customers"], - title="Customer order count", - ), - ], - grain=[ - GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ], - id="customers", - precedence=0, - references=[ - DeclarativeReference( - identifier=ReferenceIdentifier( - id="customers", - type="DATASET", - ), - multivalue=False, - source_column_data_types=[ - "INT", - ], - source_columns=["customer_id"], - sources=[ - DeclarativeReferenceSource( - column="customer_id", - data_type="STRING", - target=GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ), - ], - ), - ], - sql=DeclarativeDatasetSql( - data_source_id="my-postgres", - statement="SELECT * FROM some_table", - ), - tags=["Customers"], - title="Customers", - workspace_data_filter_columns=[ - DeclarativeWorkspaceDataFilterColumn( - data_type="INT", - name="customer_id", - ), - ], - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - date_instances=[ - DeclarativeDateDataset( - description="A customer order date", - granularities=[ - "MINUTE", - ], - granularities_formatting=GranularitiesFormatting( - title_base="title_base_example", - title_pattern="%titleBase - %granularityTitle", - ), - id="date", - tags=["Customer dates"], - title="Date", - ), - ], - ), - ) # DeclarativeModel | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_model = gooddata_api_client.DeclarativeModel() # DeclarativeModel | + try: # Set logical model api_instance.set_logical_model(workspace_id, declarative_model) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_logical_model: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_model** | [**DeclarativeModel**](DeclarativeModel.md)| | + **workspace_id** | **str**| | + **declarative_model** | [**DeclarativeModel**](DeclarativeModel.md)| | ### Return type @@ -3395,7 +2246,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3415,11 +2265,11 @@ Sets notification channels in organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.models.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3428,39 +2278,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - declarative_notification_channels = DeclarativeNotificationChannels( - notification_channels=[ - DeclarativeNotificationChannel( - allowed_recipients="INTERNAL", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="INTERNAL_ONLY", - description="This is a channel", - destination=DeclarativeNotificationChannelDestination(None), - id="notification-channel-1", - in_platform_notification="DISABLED", - name="channel", - notification_source="notification_source_example", - ), - ], - ) # DeclarativeNotificationChannels | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + declarative_notification_channels = gooddata_api_client.DeclarativeNotificationChannels() # DeclarativeNotificationChannels | + try: # Set all notification channels api_instance.set_notification_channels(declarative_notification_channels) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_notification_channels** | [**DeclarativeNotificationChannels**](DeclarativeNotificationChannels.md)| | + **declarative_notification_channels** | [**DeclarativeNotificationChannels**](DeclarativeNotificationChannels.md)| | ### Return type @@ -3475,7 +2312,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -3495,11 +2331,11 @@ Sets complete layout of organization, like workspaces, user-groups, etc. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3508,964 +2344,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - declarative_organization = DeclarativeOrganization( - data_sources=[ - DeclarativeDataSource( - authentication_type="USERNAME_PASSWORD", - cache_strategy="ALWAYS", - client_id="client1234", - client_secret="client_secret_example", - decoded_parameters=[ - Parameter( - name="name_example", - value="value_example", - ), - ], - id="pg_local_docker-demo", - name="postgres demo", - parameters=[ - Parameter( - name="name_example", - value="value_example", - ), - ], - password="*****", - permissions=[ - DeclarativeDataSourcePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="demo", - token="Bigquery service account JSON. Encode it using base64!", - type="POSTGRESQL", - url="jdbc:postgresql://postgres:5432/gooddata", - username="demo", - ), - ], - export_templates=[ - DeclarativeExportTemplate( - dashboard_slides_template=DashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - id="default-export-template", - name="My default export template", - widget_slides_template=WidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - ], - identity_providers=[ - DeclarativeIdentityProvider( - custom_claim_mapping={ - "key": "key_example", - }, - id="filterView-1", - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - ], - jwks=[ - DeclarativeJwk( - content=DeclarativeJwkSpecification(), - id="jwk-1", - ), - ], - notification_channels=[ - DeclarativeNotificationChannel( - allowed_recipients="INTERNAL", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="INTERNAL_ONLY", - description="This is a channel", - destination=DeclarativeNotificationChannelDestination(None), - id="notification-channel-1", - in_platform_notification="DISABLED", - name="channel", - notification_source="notification_source_example", - ), - ], - organization=DeclarativeOrganizationInfo( - allowed_origins=[ - "allowed_origins_example", - ], - color_palettes=[ - DeclarativeColorPalette( - content=JsonNode(), - id="id_example", - name="name_example", - ), - ], - csp_directives=[ - DeclarativeCspDirective( - directive="directive_example", - sources=[ - "sources_example", - ], - ), - ], - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - hostname="alpha.com", - id="Alpha corporation", - identity_provider=DeclarativeIdentityProviderIdentifier( - id="gooddata.com", - type="identityProvider", - ), - name="Alpha corporation", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - permissions=[ - DeclarativeOrganizationPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - themes=[ - DeclarativeTheme( - content=JsonNode(), - id="id_example", - name="name_example", - ), - ], - ), - user_groups=[ - DeclarativeUserGroup( - id="employees.all", - name="admins", - parents=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - permissions=[ - DeclarativeUserGroupPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - ), - ], - users=[ - DeclarativeUser( - auth_id="auth_id_example", - email="user@example.com", - firstname="John", - id="employee123", - lastname="Wick", - permissions=[ - DeclarativeUserPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - user_groups=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - ), - ], - workspace_data_filters=[ - DeclarativeWorkspaceDataFilter( - column_name="country_id", - description="ID of country", - id="country_id", - title="Country ID", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - workspace_data_filter_settings=[ - DeclarativeWorkspaceDataFilterSetting( - description="ID of country setting", - filter_values=["US"], - id="country_id_setting", - title="Country ID setting", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - ), - ], - ), - ], - workspaces=[ - DeclarativeWorkspace( - automations=[ - DeclarativeAutomation( - alert=AutomationAlert( - condition=AutomationAlertCondition(None), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - dashboard_tabular_exports=[ - AutomationDashboardTabularExport( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={ - "key": "key_example", - }, - evaluation_mode="PER_RECIPIENT", - export_definitions=[ - DeclarativeExportDefinitionIdentifier( - id="export123", - type="exportDefinition", - ), - ], - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - id="/6bUUGjjNSwg0_bs", - image_exports=[ - AutomationImageExport( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=AutomationMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - notification_channel=DeclarativeNotificationChannelIdentifier( - id="webhook123", - type="notificationChannel", - ), - raw_exports=[ - AutomationRawExport( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - recipients=[ - DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ], - schedule=AutomationSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - AutomationSlidesExport( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - AutomationTabularExport( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - visual_exports=[ - AutomationVisualExport( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - ], - cache_extra_limit=1, - custom_application_settings=[ - DeclarativeCustomApplicationSetting( - application_name="Modeler", - content=JsonNode(), - id="modeler.demo", - ), - ], - data_source=WorkspaceDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - filter_views=[ - DeclarativeFilterView( - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - content=JsonNode(), - description="description_example", - id="filterView-1", - is_default=True, - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ), - ], - hierarchy_permissions=[ - DeclarativeWorkspaceHierarchyPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - id="alpha.sales", - model=DeclarativeWorkspaceModel( - analytics=DeclarativeAnalyticsLayer( - analytical_dashboard_extensions=[ - DeclarativeAnalyticalDashboardExtension( - id="revenues-analysis", - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - ), - ], - analytical_dashboards=[ - DeclarativeAnalyticalDashboard( - content=JsonNode(), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Period to period comparison of revenues in main sectors.", - id="revenues-analysis", - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - tags=["Revenues"], - title="Revenues analysis", - ), - ], - attribute_hierarchies=[ - DeclarativeAttributeHierarchy( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - dashboard_plugins=[ - DeclarativeDashboardPlugin( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Three dimensional view of data.", - id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="3D map renderer", - ), - ], - export_definitions=[ - DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="export-definition-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), - tags=["Revenues"], - title="My regular export", - ), - ], - filter_contexts=[ - DeclarativeFilterContext( - content=JsonNode(), - description="Filter Context for Sales team.", - id="filter-sales", - tags=["Revenues"], - title="Filter Context for Sales team", - ), - ], - metrics=[ - DeclarativeMetric( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Sales for all the data available.", - id="total-sales", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Total sales", - ), - ], - visualization_objects=[ - DeclarativeVisualizationObject( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="visualization-1", - is_hidden=False, - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - ), - ldm=DeclarativeLdm( - dataset_extensions=[ - DeclarativeDatasetExtension( - id="customers", - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - datasets=[ - DeclarativeDataset( - aggregated_facts=[ - DeclarativeAggregatedFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - source_column="customer_order_count", - source_column_data_type="NUMERIC", - source_fact_reference=DeclarativeSourceFactReference( - operation="SUM", - reference=FactIdentifier( - id="fact_id", - type="fact", - ), - ), - tags=["Customers"], - ), - ], - attributes=[ - DeclarativeAttribute( - default_view=LabelIdentifier( - id="label_id", - type="label", - ), - description="Customer name including first and last name.", - id="attr.customers.customer_name", - is_hidden=False, - labels=[ - DeclarativeLabel( - description="Customer name", - id="label.customer_name", - is_hidden=False, - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer name", - value_type="TEXT", - ), - ], - sort_column="customer_name", - sort_direction="ASC" | "DESC", - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer Name", - ), - ], - data_source_table_id=DataSourceTableIdentifier( - data_source_id="my-postgres", - id="customers", - path=["table_schema","table_name"], - type="dataSource", - ), - description="The customers of ours.", - facts=[ - DeclarativeFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - is_hidden=False, - source_column="customer_order_count", - source_column_data_type="NUMERIC", - tags=["Customers"], - title="Customer order count", - ), - ], - grain=[ - GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ], - id="customers", - precedence=0, - references=[ - DeclarativeReference( - identifier=ReferenceIdentifier( - id="customers", - type="DATASET", - ), - multivalue=False, - source_column_data_types=[ - "INT", - ], - source_columns=["customer_id"], - sources=[ - DeclarativeReferenceSource( - column="customer_id", - data_type="STRING", - target=GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ), - ], - ), - ], - sql=DeclarativeDatasetSql( - data_source_id="my-postgres", - statement="SELECT * FROM some_table", - ), - tags=["Customers"], - title="Customers", - workspace_data_filter_columns=[ - DeclarativeWorkspaceDataFilterColumn( - data_type="INT", - name="customer_id", - ), - ], - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - date_instances=[ - DeclarativeDateDataset( - description="A customer order date", - granularities=[ - "MINUTE", - ], - granularities_formatting=GranularitiesFormatting( - title_base="title_base_example", - title_pattern="%titleBase - %granularityTitle", - ), - id="date", - tags=["Customer dates"], - title="Date", - ), - ], - ), - ), - name="Alpha Sales", - parent=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - permissions=[ - DeclarativeSingleWorkspacePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - prefix="/6bUUGjjNSwg0_bs", - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - user_data_filters=[ - DeclarativeUserDataFilter( - description="ID of country setting", - id="country_id_setting", - maql="{label/country} = "USA" AND {label/date.year} = THIS(YEAR)", - tags=["Revenues"], - title="Country ID setting", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - user_group=DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ), - ], - ), - ], - ) # DeclarativeOrganization | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + declarative_organization = gooddata_api_client.DeclarativeOrganization() # DeclarativeOrganization | + try: # Set organization layout api_instance.set_organization_layout(declarative_organization) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_organization_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_organization** | [**DeclarativeOrganization**](DeclarativeOrganization.md)| | + **declarative_organization** | [**DeclarativeOrganization**](DeclarativeOrganization.md)| | ### Return type @@ -4480,7 +2378,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4500,11 +2397,11 @@ Sets organization permissions ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4513,33 +2410,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - declarative_organization_permission = [ - DeclarativeOrganizationPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ] # [DeclarativeOrganizationPermission] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + declarative_organization_permission = [gooddata_api_client.DeclarativeOrganizationPermission()] # List[DeclarativeOrganizationPermission] | + try: # Set organization permissions api_instance.set_organization_permissions(declarative_organization_permission) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_organization_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_organization_permission** | [**[DeclarativeOrganizationPermission]**](DeclarativeOrganizationPermission.md)| | + **declarative_organization_permission** | [**List[DeclarativeOrganizationPermission]**](DeclarativeOrganizationPermission.md)| | ### Return type @@ -4554,7 +2444,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4574,11 +2463,11 @@ Set user data filters assigned to the workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4587,45 +2476,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_user_data_filters = DeclarativeUserDataFilters( - user_data_filters=[ - DeclarativeUserDataFilter( - description="ID of country setting", - id="country_id_setting", - maql="{label/country} = "USA" AND {label/date.year} = THIS(YEAR)", - tags=["Revenues"], - title="Country ID setting", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - user_group=DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ), - ], - ) # DeclarativeUserDataFilters | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_user_data_filters = gooddata_api_client.DeclarativeUserDataFilters() # DeclarativeUserDataFilters | + try: # Set user data filters api_instance.set_user_data_filters(workspace_id, declarative_user_data_filters) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_user_data_filters** | [**DeclarativeUserDataFilters**](DeclarativeUserDataFilters.md)| | + **workspace_id** | **str**| | + **declarative_user_data_filters** | [**DeclarativeUserDataFilters**](DeclarativeUserDataFilters.md)| | ### Return type @@ -4640,7 +2512,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4660,11 +2531,11 @@ Set effective permissions for the user-group ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4673,37 +2544,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - user_group_id = "userGroupId_example" # str | - declarative_user_group_permissions = DeclarativeUserGroupPermissions( - permissions=[ - DeclarativeUserGroupPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - ) # DeclarativeUserGroupPermissions | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + user_group_id = 'user_group_id_example' # str | + declarative_user_group_permissions = gooddata_api_client.DeclarativeUserGroupPermissions() # DeclarativeUserGroupPermissions | + try: # Set permissions for the user-group api_instance.set_user_group_permissions(user_group_id, declarative_user_group_permissions) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_user_group_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_group_id** | **str**| | - **declarative_user_group_permissions** | [**DeclarativeUserGroupPermissions**](DeclarativeUserGroupPermissions.md)| | + **user_group_id** | **str**| | + **declarative_user_group_permissions** | [**DeclarativeUserGroupPermissions**](DeclarativeUserGroupPermissions.md)| | ### Return type @@ -4718,7 +2580,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4738,11 +2599,11 @@ Set effective permissions for the user ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4751,37 +2612,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - user_id = "userId_example" # str | - declarative_user_permissions = DeclarativeUserPermissions( - permissions=[ - DeclarativeUserPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - ) # DeclarativeUserPermissions | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + user_id = 'user_id_example' # str | + declarative_user_permissions = gooddata_api_client.DeclarativeUserPermissions() # DeclarativeUserPermissions | + try: # Set permissions for the user api_instance.set_user_permissions(user_id, declarative_user_permissions) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_user_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **declarative_user_permissions** | [**DeclarativeUserPermissions**](DeclarativeUserPermissions.md)| | + **user_id** | **str**| | + **declarative_user_permissions** | [**DeclarativeUserPermissions**](DeclarativeUserPermissions.md)| | ### Return type @@ -4796,7 +2648,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4816,11 +2667,11 @@ Sets workspace data filters in all workspaces in entire organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4829,50 +2680,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - declarative_workspace_data_filters = DeclarativeWorkspaceDataFilters( - workspace_data_filters=[ - DeclarativeWorkspaceDataFilter( - column_name="country_id", - description="ID of country", - id="country_id", - title="Country ID", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - workspace_data_filter_settings=[ - DeclarativeWorkspaceDataFilterSetting( - description="ID of country setting", - filter_values=["US"], - id="country_id_setting", - title="Country ID setting", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - ), - ], - ), - ], - ) # DeclarativeWorkspaceDataFilters | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + declarative_workspace_data_filters = gooddata_api_client.DeclarativeWorkspaceDataFilters() # DeclarativeWorkspaceDataFilters | + try: # Set all workspace data filters api_instance.set_workspace_data_filters_layout(declarative_workspace_data_filters) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_workspace_data_filters_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_workspace_data_filters** | [**DeclarativeWorkspaceDataFilters**](DeclarativeWorkspaceDataFilters.md)| | + **declarative_workspace_data_filters** | [**DeclarativeWorkspaceDataFilters**](DeclarativeWorkspaceDataFilters.md)| | ### Return type @@ -4887,7 +2714,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4907,11 +2733,11 @@ Set effective permissions for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4920,46 +2746,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_workspace_permissions = DeclarativeWorkspacePermissions( - hierarchy_permissions=[ - DeclarativeWorkspaceHierarchyPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - permissions=[ - DeclarativeSingleWorkspacePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - ) # DeclarativeWorkspacePermissions | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_workspace_permissions = gooddata_api_client.DeclarativeWorkspacePermissions() # DeclarativeWorkspacePermissions | + try: # Set permissions for the workspace api_instance.set_workspace_permissions(workspace_id, declarative_workspace_permissions) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_workspace_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_workspace_permissions** | [**DeclarativeWorkspacePermissions**](DeclarativeWorkspacePermissions.md)| | + **workspace_id** | **str**| | + **declarative_workspace_permissions** | [**DeclarativeWorkspacePermissions**](DeclarativeWorkspacePermissions.md)| | ### Return type @@ -4974,7 +2782,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -4994,11 +2801,11 @@ Sets complete layout of workspaces, their hierarchy, models. ```python -import time import gooddata_api_client -from gooddata_api_client.api import layout_api -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5007,694 +2814,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = layout_api.LayoutApi(api_client) - declarative_workspaces = DeclarativeWorkspaces( - workspace_data_filters=[ - DeclarativeWorkspaceDataFilter( - column_name="country_id", - description="ID of country", - id="country_id", - title="Country ID", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - workspace_data_filter_settings=[ - DeclarativeWorkspaceDataFilterSetting( - description="ID of country setting", - filter_values=["US"], - id="country_id_setting", - title="Country ID setting", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - ), - ], - ), - ], - workspaces=[ - DeclarativeWorkspace( - automations=[ - DeclarativeAutomation( - alert=AutomationAlert( - condition=AutomationAlertCondition(None), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - dashboard_tabular_exports=[ - AutomationDashboardTabularExport( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={ - "key": "key_example", - }, - evaluation_mode="PER_RECIPIENT", - export_definitions=[ - DeclarativeExportDefinitionIdentifier( - id="export123", - type="exportDefinition", - ), - ], - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - id="/6bUUGjjNSwg0_bs", - image_exports=[ - AutomationImageExport( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=AutomationMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - notification_channel=DeclarativeNotificationChannelIdentifier( - id="webhook123", - type="notificationChannel", - ), - raw_exports=[ - AutomationRawExport( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - recipients=[ - DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ], - schedule=AutomationSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - AutomationSlidesExport( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - AutomationTabularExport( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - visual_exports=[ - AutomationVisualExport( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - ], - cache_extra_limit=1, - custom_application_settings=[ - DeclarativeCustomApplicationSetting( - application_name="Modeler", - content=JsonNode(), - id="modeler.demo", - ), - ], - data_source=WorkspaceDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - filter_views=[ - DeclarativeFilterView( - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - content=JsonNode(), - description="description_example", - id="filterView-1", - is_default=True, - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ), - ], - hierarchy_permissions=[ - DeclarativeWorkspaceHierarchyPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - id="alpha.sales", - model=DeclarativeWorkspaceModel( - analytics=DeclarativeAnalyticsLayer( - analytical_dashboard_extensions=[ - DeclarativeAnalyticalDashboardExtension( - id="revenues-analysis", - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - ), - ], - analytical_dashboards=[ - DeclarativeAnalyticalDashboard( - content=JsonNode(), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Period to period comparison of revenues in main sectors.", - id="revenues-analysis", - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - tags=["Revenues"], - title="Revenues analysis", - ), - ], - attribute_hierarchies=[ - DeclarativeAttributeHierarchy( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - dashboard_plugins=[ - DeclarativeDashboardPlugin( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Three dimensional view of data.", - id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="3D map renderer", - ), - ], - export_definitions=[ - DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="export-definition-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), - tags=["Revenues"], - title="My regular export", - ), - ], - filter_contexts=[ - DeclarativeFilterContext( - content=JsonNode(), - description="Filter Context for Sales team.", - id="filter-sales", - tags=["Revenues"], - title="Filter Context for Sales team", - ), - ], - metrics=[ - DeclarativeMetric( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Sales for all the data available.", - id="total-sales", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Total sales", - ), - ], - visualization_objects=[ - DeclarativeVisualizationObject( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="visualization-1", - is_hidden=False, - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - ), - ldm=DeclarativeLdm( - dataset_extensions=[ - DeclarativeDatasetExtension( - id="customers", - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - datasets=[ - DeclarativeDataset( - aggregated_facts=[ - DeclarativeAggregatedFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - source_column="customer_order_count", - source_column_data_type="NUMERIC", - source_fact_reference=DeclarativeSourceFactReference( - operation="SUM", - reference=FactIdentifier( - id="fact_id", - type="fact", - ), - ), - tags=["Customers"], - ), - ], - attributes=[ - DeclarativeAttribute( - default_view=LabelIdentifier( - id="label_id", - type="label", - ), - description="Customer name including first and last name.", - id="attr.customers.customer_name", - is_hidden=False, - labels=[ - DeclarativeLabel( - description="Customer name", - id="label.customer_name", - is_hidden=False, - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer name", - value_type="TEXT", - ), - ], - sort_column="customer_name", - sort_direction="ASC" | "DESC", - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer Name", - ), - ], - data_source_table_id=DataSourceTableIdentifier( - data_source_id="my-postgres", - id="customers", - path=["table_schema","table_name"], - type="dataSource", - ), - description="The customers of ours.", - facts=[ - DeclarativeFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - is_hidden=False, - source_column="customer_order_count", - source_column_data_type="NUMERIC", - tags=["Customers"], - title="Customer order count", - ), - ], - grain=[ - GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ], - id="customers", - precedence=0, - references=[ - DeclarativeReference( - identifier=ReferenceIdentifier( - id="customers", - type="DATASET", - ), - multivalue=False, - source_column_data_types=[ - "INT", - ], - source_columns=["customer_id"], - sources=[ - DeclarativeReferenceSource( - column="customer_id", - data_type="STRING", - target=GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ), - ], - ), - ], - sql=DeclarativeDatasetSql( - data_source_id="my-postgres", - statement="SELECT * FROM some_table", - ), - tags=["Customers"], - title="Customers", - workspace_data_filter_columns=[ - DeclarativeWorkspaceDataFilterColumn( - data_type="INT", - name="customer_id", - ), - ], - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - date_instances=[ - DeclarativeDateDataset( - description="A customer order date", - granularities=[ - "MINUTE", - ], - granularities_formatting=GranularitiesFormatting( - title_base="title_base_example", - title_pattern="%titleBase - %granularityTitle", - ), - id="date", - tags=["Customer dates"], - title="Date", - ), - ], - ), - ), - name="Alpha Sales", - parent=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - permissions=[ - DeclarativeSingleWorkspacePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - prefix="/6bUUGjjNSwg0_bs", - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - user_data_filters=[ - DeclarativeUserDataFilter( - description="ID of country setting", - id="country_id_setting", - maql="{label/country} = "USA" AND {label/date.year} = THIS(YEAR)", - tags=["Revenues"], - title="Country ID setting", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - user_group=DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ), - ], - ), - ], - ) # DeclarativeWorkspaces | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.LayoutApi(api_client) + declarative_workspaces = gooddata_api_client.DeclarativeWorkspaces() # DeclarativeWorkspaces | + try: # Set all workspaces layout api_instance.set_workspaces_layout(declarative_workspaces) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling LayoutApi->set_workspaces_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_workspaces** | [**DeclarativeWorkspaces**](DeclarativeWorkspaces.md)| | + **declarative_workspaces** | [**DeclarativeWorkspaces**](DeclarativeWorkspaces.md)| | ### Return type @@ -5709,7 +2848,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ListLinks.md b/gooddata-api-client/docs/ListLinks.md index 845693140..f08ea0977 100644 --- a/gooddata-api-client/docs/ListLinks.md +++ b/gooddata-api-client/docs/ListLinks.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_self** | **str** | A string containing the link's URL. | +**var_self** | **str** | A string containing the link's URL. | **next** | **str** | A string containing the link's URL for the next page of data. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.list_links import ListLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of ListLinks from a JSON string +list_links_instance = ListLinks.from_json(json) +# print the JSON string representation of the object +print(ListLinks.to_json()) + +# convert the object into a dict +list_links_dict = list_links_instance.to_dict() +# create an instance of ListLinks from a dict +list_links_from_dict = ListLinks.from_dict(list_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ListLinksAllOf.md b/gooddata-api-client/docs/ListLinksAllOf.md deleted file mode 100644 index 105c83c51..000000000 --- a/gooddata-api-client/docs/ListLinksAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListLinksAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next** | **str** | A string containing the link's URL for the next page of data. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/LocalIdentifier.md b/gooddata-api-client/docs/LocalIdentifier.md index e6764f04d..912a6f143 100644 --- a/gooddata-api-client/docs/LocalIdentifier.md +++ b/gooddata-api-client/docs/LocalIdentifier.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**format** | **str** | Metric format. | [optional] [default to '#,##0.00'] **local_identifier** | **str** | Local identifier of the metric to be compared. | -**format** | **str, none_type** | Metric format. | [optional] if omitted the server will use the default value of "#,##0.00" -**title** | **str, none_type** | Metric title. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**title** | **str** | Metric title. | [optional] + +## Example + +```python +from gooddata_api_client.models.local_identifier import LocalIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of LocalIdentifier from a JSON string +local_identifier_instance = LocalIdentifier.from_json(json) +# print the JSON string representation of the object +print(LocalIdentifier.to_json()) +# convert the object into a dict +local_identifier_dict = local_identifier_instance.to_dict() +# create an instance of LocalIdentifier from a dict +local_identifier_from_dict = LocalIdentifier.from_dict(local_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/LocaleRequest.md b/gooddata-api-client/docs/LocaleRequest.md index f52cded21..11a9f418f 100644 --- a/gooddata-api-client/docs/LocaleRequest.md +++ b/gooddata-api-client/docs/LocaleRequest.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **locale** | **str** | Requested locale in the form of language tag (see RFC 5646). | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.locale_request import LocaleRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of LocaleRequest from a JSON string +locale_request_instance = LocaleRequest.from_json(json) +# print the JSON string representation of the object +print(LocaleRequest.to_json()) + +# convert the object into a dict +locale_request_dict = locale_request_instance.to_dict() +# create an instance of LocaleRequest from a dict +locale_request_from_dict = LocaleRequest.from_dict(locale_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ManageDashboardPermissionsRequestInner.md b/gooddata-api-client/docs/ManageDashboardPermissionsRequestInner.md index 79b1be80b..551454d4e 100644 --- a/gooddata-api-client/docs/ManageDashboardPermissionsRequestInner.md +++ b/gooddata-api-client/docs/ManageDashboardPermissionsRequestInner.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permissions** | **[str]** | | [optional] -**assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | [optional] -**assignee_rule** | [**AssigneeRule**](AssigneeRule.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | **List[str]** | | +**assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | +**assignee_rule** | [**AssigneeRule**](AssigneeRule.md) | | + +## Example + +```python +from gooddata_api_client.models.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner + +# TODO update the JSON string below +json = "{}" +# create an instance of ManageDashboardPermissionsRequestInner from a JSON string +manage_dashboard_permissions_request_inner_instance = ManageDashboardPermissionsRequestInner.from_json(json) +# print the JSON string representation of the object +print(ManageDashboardPermissionsRequestInner.to_json()) +# convert the object into a dict +manage_dashboard_permissions_request_inner_dict = manage_dashboard_permissions_request_inner_instance.to_dict() +# create an instance of ManageDashboardPermissionsRequestInner from a dict +manage_dashboard_permissions_request_inner_from_dict = ManageDashboardPermissionsRequestInner.from_dict(manage_dashboard_permissions_request_inner_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ManagePermissionsApi.md b/gooddata-api-client/docs/ManagePermissionsApi.md index 32a0948d7..4ca1a0c2b 100644 --- a/gooddata-api-client/docs/ManagePermissionsApi.md +++ b/gooddata-api-client/docs/ManagePermissionsApi.md @@ -20,11 +20,11 @@ Retrieve current set of permissions of the data source in a declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import manage_permissions_api -from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.models.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -33,26 +33,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = manage_permissions_api.ManagePermissionsApi(api_client) - data_source_id = "dataSourceId_example" # str | + api_instance = gooddata_api_client.ManagePermissionsApi(api_client) + data_source_id = 'data_source_id_example' # str | - # example passing only required values which don't have defaults set try: # Get permissions for the data source api_response = api_instance.get_data_source_permissions(data_source_id) + print("The response of ManagePermissionsApi->get_data_source_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ManagePermissionsApi->get_data_source_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | + **data_source_id** | **str**| | ### Return type @@ -67,7 +69,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -87,11 +88,11 @@ Manage Permissions for a Data Source ```python -import time import gooddata_api_client -from gooddata_api_client.api import manage_permissions_api -from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment +from gooddata_api_client.models.data_source_permission_assignment import DataSourcePermissionAssignment +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -100,37 +101,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = manage_permissions_api.ManagePermissionsApi(api_client) - data_source_id = "dataSourceId_example" # str | - data_source_permission_assignment = [ - DataSourcePermissionAssignment( - assignee_identifier=AssigneeIdentifier( - id="id_example", - type="user", - ), - permissions=[ - "MANAGE", - ], - ), - ] # [DataSourcePermissionAssignment] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ManagePermissionsApi(api_client) + data_source_id = 'data_source_id_example' # str | + data_source_permission_assignment = [gooddata_api_client.DataSourcePermissionAssignment()] # List[DataSourcePermissionAssignment] | + try: # Manage Permissions for a Data Source api_instance.manage_data_source_permissions(data_source_id, data_source_permission_assignment) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ManagePermissionsApi->manage_data_source_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | - **data_source_permission_assignment** | [**[DataSourcePermissionAssignment]**](DataSourcePermissionAssignment.md)| | + **data_source_id** | **str**| | + **data_source_permission_assignment** | [**List[DataSourcePermissionAssignment]**](DataSourcePermissionAssignment.md)| | ### Return type @@ -145,7 +137,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -165,11 +156,11 @@ set data source permissions. ```python -import time import gooddata_api_client -from gooddata_api_client.api import manage_permissions_api -from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.models.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -178,37 +169,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = manage_permissions_api.ManagePermissionsApi(api_client) - data_source_id = "dataSourceId_example" # str | - declarative_data_source_permissions = DeclarativeDataSourcePermissions( - permissions=[ - DeclarativeDataSourcePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - ) # DeclarativeDataSourcePermissions | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ManagePermissionsApi(api_client) + data_source_id = 'data_source_id_example' # str | + declarative_data_source_permissions = gooddata_api_client.DeclarativeDataSourcePermissions() # DeclarativeDataSourcePermissions | + try: # Set data source permissions. api_instance.set_data_source_permissions(data_source_id, declarative_data_source_permissions) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ManagePermissionsApi->set_data_source_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | - **declarative_data_source_permissions** | [**DeclarativeDataSourcePermissions**](DeclarativeDataSourcePermissions.md)| | + **data_source_id** | **str**| | + **declarative_data_source_permissions** | [**DeclarativeDataSourcePermissions**](DeclarativeDataSourcePermissions.md)| | ### Return type @@ -223,7 +205,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/MeasureDefinition.md b/gooddata-api-client/docs/MeasureDefinition.md index 5d064c9cb..670cbe856 100644 --- a/gooddata-api-client/docs/MeasureDefinition.md +++ b/gooddata-api-client/docs/MeasureDefinition.md @@ -3,15 +3,32 @@ Abstract metric definition type ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**inline** | [**InlineMeasureDefinitionInline**](InlineMeasureDefinitionInline.md) | | [optional] -**arithmetic_measure** | [**ArithmeticMeasureDefinitionArithmeticMeasure**](ArithmeticMeasureDefinitionArithmeticMeasure.md) | | [optional] -**measure** | [**SimpleMeasureDefinitionMeasure**](SimpleMeasureDefinitionMeasure.md) | | [optional] -**previous_period_measure** | [**PopDatasetMeasureDefinitionPreviousPeriodMeasure**](PopDatasetMeasureDefinitionPreviousPeriodMeasure.md) | | [optional] -**over_period_measure** | [**PopDateMeasureDefinitionOverPeriodMeasure**](PopDateMeasureDefinitionOverPeriodMeasure.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**inline** | [**InlineMeasureDefinitionInline**](InlineMeasureDefinitionInline.md) | | +**arithmetic_measure** | [**ArithmeticMeasureDefinitionArithmeticMeasure**](ArithmeticMeasureDefinitionArithmeticMeasure.md) | | +**measure** | [**SimpleMeasureDefinitionMeasure**](SimpleMeasureDefinitionMeasure.md) | | +**previous_period_measure** | [**PopDatasetMeasureDefinitionPreviousPeriodMeasure**](PopDatasetMeasureDefinitionPreviousPeriodMeasure.md) | | +**over_period_measure** | [**PopDateMeasureDefinitionOverPeriodMeasure**](PopDateMeasureDefinitionOverPeriodMeasure.md) | | + +## Example + +```python +from gooddata_api_client.models.measure_definition import MeasureDefinition + +# TODO update the JSON string below +json = "{}" +# create an instance of MeasureDefinition from a JSON string +measure_definition_instance = MeasureDefinition.from_json(json) +# print the JSON string representation of the object +print(MeasureDefinition.to_json()) +# convert the object into a dict +measure_definition_dict = measure_definition_instance.to_dict() +# create an instance of MeasureDefinition from a dict +measure_definition_from_dict = MeasureDefinition.from_dict(measure_definition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MeasureExecutionResultHeader.md b/gooddata-api-client/docs/MeasureExecutionResultHeader.md index df25c5e8f..9f6ea9717 100644 --- a/gooddata-api-client/docs/MeasureExecutionResultHeader.md +++ b/gooddata-api-client/docs/MeasureExecutionResultHeader.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **measure_header** | [**MeasureResultHeader**](MeasureResultHeader.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.measure_execution_result_header import MeasureExecutionResultHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of MeasureExecutionResultHeader from a JSON string +measure_execution_result_header_instance = MeasureExecutionResultHeader.from_json(json) +# print the JSON string representation of the object +print(MeasureExecutionResultHeader.to_json()) + +# convert the object into a dict +measure_execution_result_header_dict = measure_execution_result_header_instance.to_dict() +# create an instance of MeasureExecutionResultHeader from a dict +measure_execution_result_header_from_dict = MeasureExecutionResultHeader.from_dict(measure_execution_result_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MeasureGroupHeaders.md b/gooddata-api-client/docs/MeasureGroupHeaders.md index af346ee9c..8b5fff30d 100644 --- a/gooddata-api-client/docs/MeasureGroupHeaders.md +++ b/gooddata-api-client/docs/MeasureGroupHeaders.md @@ -3,11 +3,28 @@ Measure group headers ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**measure_group_headers** | [**[MeasureHeader]**](MeasureHeader.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**measure_group_headers** | [**List[MeasureHeader]**](MeasureHeader.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.measure_group_headers import MeasureGroupHeaders + +# TODO update the JSON string below +json = "{}" +# create an instance of MeasureGroupHeaders from a JSON string +measure_group_headers_instance = MeasureGroupHeaders.from_json(json) +# print the JSON string representation of the object +print(MeasureGroupHeaders.to_json()) +# convert the object into a dict +measure_group_headers_dict = measure_group_headers_instance.to_dict() +# create an instance of MeasureGroupHeaders from a dict +measure_group_headers_from_dict = MeasureGroupHeaders.from_dict(measure_group_headers_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MeasureHeader.md b/gooddata-api-client/docs/MeasureHeader.md index 099900d6b..2b8b00821 100644 --- a/gooddata-api-client/docs/MeasureHeader.md +++ b/gooddata-api-client/docs/MeasureHeader.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**local_identifier** | **str** | Local identifier of the measure this header relates to. | **format** | **str** | Format to be used to format the measure data. | [optional] +**local_identifier** | **str** | Local identifier of the measure this header relates to. | **name** | **str** | Name of the measure. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.measure_header import MeasureHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of MeasureHeader from a JSON string +measure_header_instance = MeasureHeader.from_json(json) +# print the JSON string representation of the object +print(MeasureHeader.to_json()) + +# convert the object into a dict +measure_header_dict = measure_header_instance.to_dict() +# create an instance of MeasureHeader from a dict +measure_header_from_dict = MeasureHeader.from_dict(measure_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MeasureItem.md b/gooddata-api-client/docs/MeasureItem.md index b6fd4a85b..8e3cd11be 100644 --- a/gooddata-api-client/docs/MeasureItem.md +++ b/gooddata-api-client/docs/MeasureItem.md @@ -3,12 +3,29 @@ Metric is a quantity that is calculated from the data. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **definition** | [**MeasureItemDefinition**](MeasureItemDefinition.md) | | **local_identifier** | **str** | Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.measure_item import MeasureItem + +# TODO update the JSON string below +json = "{}" +# create an instance of MeasureItem from a JSON string +measure_item_instance = MeasureItem.from_json(json) +# print the JSON string representation of the object +print(MeasureItem.to_json()) + +# convert the object into a dict +measure_item_dict = measure_item_instance.to_dict() +# create an instance of MeasureItem from a dict +measure_item_from_dict = MeasureItem.from_dict(measure_item_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MeasureItemDefinition.md b/gooddata-api-client/docs/MeasureItemDefinition.md index 1f49e6539..dc1d0afa5 100644 --- a/gooddata-api-client/docs/MeasureItemDefinition.md +++ b/gooddata-api-client/docs/MeasureItemDefinition.md @@ -2,14 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**arithmetic_measure** | [**ArithmeticMeasureDefinitionArithmeticMeasure**](ArithmeticMeasureDefinitionArithmeticMeasure.md) | | [optional] -**inline** | [**InlineMeasureDefinitionInline**](InlineMeasureDefinitionInline.md) | | [optional] -**previous_period_measure** | [**PopDatasetMeasureDefinitionPreviousPeriodMeasure**](PopDatasetMeasureDefinitionPreviousPeriodMeasure.md) | | [optional] -**over_period_measure** | [**PopDateMeasureDefinitionOverPeriodMeasure**](PopDateMeasureDefinitionOverPeriodMeasure.md) | | [optional] -**measure** | [**SimpleMeasureDefinitionMeasure**](SimpleMeasureDefinitionMeasure.md) | | [optional] +**arithmetic_measure** | [**ArithmeticMeasureDefinitionArithmeticMeasure**](ArithmeticMeasureDefinitionArithmeticMeasure.md) | | +**inline** | [**InlineMeasureDefinitionInline**](InlineMeasureDefinitionInline.md) | | +**previous_period_measure** | [**PopDatasetMeasureDefinitionPreviousPeriodMeasure**](PopDatasetMeasureDefinitionPreviousPeriodMeasure.md) | | +**over_period_measure** | [**PopDateMeasureDefinitionOverPeriodMeasure**](PopDateMeasureDefinitionOverPeriodMeasure.md) | | +**measure** | [**SimpleMeasureDefinitionMeasure**](SimpleMeasureDefinitionMeasure.md) | | + +## Example + +```python +from gooddata_api_client.models.measure_item_definition import MeasureItemDefinition + +# TODO update the JSON string below +json = "{}" +# create an instance of MeasureItemDefinition from a JSON string +measure_item_definition_instance = MeasureItemDefinition.from_json(json) +# print the JSON string representation of the object +print(MeasureItemDefinition.to_json()) +# convert the object into a dict +measure_item_definition_dict = measure_item_definition_instance.to_dict() +# create an instance of MeasureItemDefinition from a dict +measure_item_definition_from_dict = MeasureItemDefinition.from_dict(measure_item_definition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MeasureResultHeader.md b/gooddata-api-client/docs/MeasureResultHeader.md index f72fa10e3..cc9ee8427 100644 --- a/gooddata-api-client/docs/MeasureResultHeader.md +++ b/gooddata-api-client/docs/MeasureResultHeader.md @@ -3,11 +3,28 @@ Header containing the information related to metrics. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **measure_index** | **int** | Metric index. Starts at 0. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.measure_result_header import MeasureResultHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of MeasureResultHeader from a JSON string +measure_result_header_instance = MeasureResultHeader.from_json(json) +# print the JSON string representation of the object +print(MeasureResultHeader.to_json()) + +# convert the object into a dict +measure_result_header_dict = measure_result_header_instance.to_dict() +# create an instance of MeasureResultHeader from a dict +measure_result_header_from_dict = MeasureResultHeader.from_dict(measure_result_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MeasureValueFilter.md b/gooddata-api-client/docs/MeasureValueFilter.md index 9b770dde1..69a4ac303 100644 --- a/gooddata-api-client/docs/MeasureValueFilter.md +++ b/gooddata-api-client/docs/MeasureValueFilter.md @@ -3,12 +3,29 @@ Abstract filter definition type filtering by the value of the metric. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comparison_measure_value_filter** | [**ComparisonMeasureValueFilterComparisonMeasureValueFilter**](ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) | | [optional] -**range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**comparison_measure_value_filter** | [**ComparisonMeasureValueFilterComparisonMeasureValueFilter**](ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) | | +**range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | + +## Example + +```python +from gooddata_api_client.models.measure_value_filter import MeasureValueFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of MeasureValueFilter from a JSON string +measure_value_filter_instance = MeasureValueFilter.from_json(json) +# print the JSON string representation of the object +print(MeasureValueFilter.to_json()) +# convert the object into a dict +measure_value_filter_dict = measure_value_filter_instance.to_dict() +# create an instance of MeasureValueFilter from a dict +measure_value_filter_from_dict = MeasureValueFilter.from_dict(measure_value_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MemoryItem.md b/gooddata-api-client/docs/MemoryItem.md index 498fd94b1..cbd384905 100644 --- a/gooddata-api-client/docs/MemoryItem.md +++ b/gooddata-api-client/docs/MemoryItem.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Memory item ID | **instruction** | **str** | Instruction that will be injected into the prompt. | -**keywords** | **[str]** | List of keywords used to match the memory item. | +**keywords** | **List[str]** | List of keywords used to match the memory item. | **strategy** | **str** | Defines the application strategy. | [optional] **use_cases** | [**MemoryItemUseCases**](MemoryItemUseCases.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.memory_item import MemoryItem + +# TODO update the JSON string below +json = "{}" +# create an instance of MemoryItem from a JSON string +memory_item_instance = MemoryItem.from_json(json) +# print the JSON string representation of the object +print(MemoryItem.to_json()) + +# convert the object into a dict +memory_item_dict = memory_item_instance.to_dict() +# create an instance of MemoryItem from a dict +memory_item_from_dict = MemoryItem.from_dict(memory_item_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MemoryItemUseCases.md b/gooddata-api-client/docs/MemoryItemUseCases.md index 4ba51d9eb..5c805959f 100644 --- a/gooddata-api-client/docs/MemoryItemUseCases.md +++ b/gooddata-api-client/docs/MemoryItemUseCases.md @@ -3,6 +3,7 @@ Defines the prompts where the given instruction should be applied. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **general** | **bool** | Apply this memory item to the general answer prompt. | @@ -13,8 +14,24 @@ Name | Type | Description | Notes **router** | **bool** | Appy this memory item to the router prompt. | **search** | **bool** | Apply this memory item to the search prompt. | **visualization** | **bool** | Apply this memory item to the visualization prompt. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.memory_item_use_cases import MemoryItemUseCases + +# TODO update the JSON string below +json = "{}" +# create an instance of MemoryItemUseCases from a JSON string +memory_item_use_cases_instance = MemoryItemUseCases.from_json(json) +# print the JSON string representation of the object +print(MemoryItemUseCases.to_json()) + +# convert the object into a dict +memory_item_use_cases_dict = memory_item_use_cases_instance.to_dict() +# create an instance of MemoryItemUseCases from a dict +memory_item_use_cases_from_dict = MemoryItemUseCases.from_dict(memory_item_use_cases_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MetadataSyncApi.md b/gooddata-api-client/docs/MetadataSyncApi.md index bc6a8d307..9a79f11b8 100644 --- a/gooddata-api-client/docs/MetadataSyncApi.md +++ b/gooddata-api-client/docs/MetadataSyncApi.md @@ -19,10 +19,10 @@ Method | HTTP request | Description ```python -import time import gooddata_api_client -from gooddata_api_client.api import metadata_sync_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -31,25 +31,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = metadata_sync_api.MetadataSyncApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.MetadataSyncApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # (BETA) Sync Metadata to other services api_instance.metadata_sync(workspace_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling MetadataSyncApi->metadata_sync: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type @@ -64,7 +65,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -84,10 +84,10 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import metadata_sync_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -96,20 +96,21 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = metadata_sync_api.MetadataSyncApi(api_client) + api_instance = gooddata_api_client.MetadataSyncApi(api_client) - # example, this endpoint has no required or optional parameters try: # (BETA) Sync organization scope Metadata to other services api_instance.metadata_sync_organization() - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling MetadataSyncApi->metadata_sync_organization: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -125,7 +126,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/Metric.md b/gooddata-api-client/docs/Metric.md index 049008564..ceb0e306f 100644 --- a/gooddata-api-client/docs/Metric.md +++ b/gooddata-api-client/docs/Metric.md @@ -3,14 +3,31 @@ List of metrics to be used in the new visualization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**agg_function** | **str** | Agg function. Empty if a stored metric is used. | [optional] **id** | **str** | ID of the object | **title** | **str** | Title of metric. | **type** | **str** | Object type | -**agg_function** | **str** | Agg function. Empty if a stored metric is used. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.metric import Metric + +# TODO update the JSON string below +json = "{}" +# create an instance of Metric from a JSON string +metric_instance = Metric.from_json(json) +# print the JSON string representation of the object +print(Metric.to_json()) + +# convert the object into a dict +metric_dict = metric_instance.to_dict() +# create an instance of Metric from a dict +metric_from_dict = Metric.from_dict(metric_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MetricRecord.md b/gooddata-api-client/docs/MetricRecord.md index 8576cd2e9..0c0d331fc 100644 --- a/gooddata-api-client/docs/MetricRecord.md +++ b/gooddata-api-client/docs/MetricRecord.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **float** | | **formatted_value** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**value** | **float** | | + +## Example + +```python +from gooddata_api_client.models.metric_record import MetricRecord + +# TODO update the JSON string below +json = "{}" +# create an instance of MetricRecord from a JSON string +metric_record_instance = MetricRecord.from_json(json) +# print the JSON string representation of the object +print(MetricRecord.to_json()) +# convert the object into a dict +metric_record_dict = metric_record_instance.to_dict() +# create an instance of MetricRecord from a dict +metric_record_from_dict = MetricRecord.from_dict(metric_record_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MetricsApi.md b/gooddata-api-client/docs/MetricsApi.md index d357fdae8..b6b4fb222 100644 --- a/gooddata-api-client/docs/MetricsApi.md +++ b/gooddata-api-client/docs/MetricsApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **create_entity_metrics** -> JsonApiMetricOutDocument create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document) +> JsonApiMetricOutDocument create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, include=include, meta_include=meta_include) Post Metrics @@ -21,12 +21,12 @@ Post Metrics ```python -import time import gooddata_api_client -from gooddata_api_client.api import metrics_api -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -35,63 +35,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = metrics_api.MetricsApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_metric_post_optional_id_document = JsonApiMetricPostOptionalIdDocument( - data=JsonApiMetricPostOptionalId( - attributes=JsonApiMetricInAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - ), - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="metric", - ), - ) # JsonApiMetricPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Metrics - api_response = api_instance.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling MetricsApi->create_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.MetricsApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_metric_post_optional_id_document = gooddata_api_client.JsonApiMetricPostOptionalIdDocument() # JsonApiMetricPostOptionalIdDocument | + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Metrics api_response = api_instance.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of MetricsApi->create_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling MetricsApi->create_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_metric_post_optional_id_document** | [**JsonApiMetricPostOptionalIdDocument**](JsonApiMetricPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_metric_post_optional_id_document** | [**JsonApiMetricPostOptionalIdDocument**](JsonApiMetricPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -106,7 +77,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -116,7 +86,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_metrics** -> delete_entity_metrics(workspace_id, object_id) +> delete_entity_metrics(workspace_id, object_id, filter=filter) Delete a Metric @@ -124,10 +94,10 @@ Delete a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import metrics_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -136,37 +106,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = metrics_api.MetricsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Metric - api_instance.delete_entity_metrics(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling MetricsApi->delete_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.MetricsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Metric api_instance.delete_entity_metrics(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling MetricsApi->delete_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -181,7 +144,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -191,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_metrics** -> JsonApiMetricOutList get_all_entities_metrics(workspace_id) +> JsonApiMetricOutList get_all_entities_metrics(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Metrics @@ -199,11 +161,11 @@ Get all Metrics ```python -import time import gooddata_api_client -from gooddata_api_client.api import metrics_api -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -212,57 +174,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = metrics_api.MetricsApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Metrics - api_response = api_instance.get_all_entities_metrics(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling MetricsApi->get_all_entities_metrics: %s\n" % e) + api_instance = gooddata_api_client.MetricsApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Metrics api_response = api_instance.get_all_entities_metrics(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of MetricsApi->get_all_entities_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling MetricsApi->get_all_entities_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -277,7 +226,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -287,7 +235,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_metrics** -> JsonApiMetricOutDocument get_entity_metrics(workspace_id, object_id) +> JsonApiMetricOutDocument get_entity_metrics(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Metric @@ -295,11 +243,11 @@ Get a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import metrics_api -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -308,49 +256,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = metrics_api.MetricsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Metric - api_response = api_instance.get_entity_metrics(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling MetricsApi->get_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.MetricsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Metric api_response = api_instance.get_entity_metrics(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of MetricsApi->get_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling MetricsApi->get_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -365,7 +302,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -375,7 +311,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_metrics** -> JsonApiMetricOutDocument patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) +> JsonApiMetricOutDocument patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, filter=filter, include=include) Patch a Metric @@ -383,12 +319,12 @@ Patch a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import metrics_api -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -397,63 +333,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = metrics_api.MetricsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_metric_patch_document = JsonApiMetricPatchDocument( - data=JsonApiMetricPatch( - attributes=JsonApiMetricPatchAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - ), - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="metric", - ), - ) # JsonApiMetricPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Metric - api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling MetricsApi->patch_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.MetricsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_metric_patch_document = gooddata_api_client.JsonApiMetricPatchDocument() # JsonApiMetricPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Metric api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, filter=filter, include=include) + print("The response of MetricsApi->patch_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling MetricsApi->patch_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_metric_patch_document** | [**JsonApiMetricPatchDocument**](JsonApiMetricPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_metric_patch_document** | [**JsonApiMetricPatchDocument**](JsonApiMetricPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -468,7 +377,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -478,7 +386,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_metrics** -> JsonApiMetricOutDocument update_entity_metrics(workspace_id, object_id, json_api_metric_in_document) +> JsonApiMetricOutDocument update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, filter=filter, include=include) Put a Metric @@ -486,12 +394,12 @@ Put a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import metrics_api -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -500,63 +408,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = metrics_api.MetricsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_metric_in_document = JsonApiMetricInDocument( - data=JsonApiMetricIn( - attributes=JsonApiMetricInAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - ), - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="metric", - ), - ) # JsonApiMetricInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Metric - api_response = api_instance.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling MetricsApi->update_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.MetricsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_metric_in_document = gooddata_api_client.JsonApiMetricInDocument() # JsonApiMetricInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Metric api_response = api_instance.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, filter=filter, include=include) + print("The response of MetricsApi->update_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling MetricsApi->update_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_metric_in_document** | [**JsonApiMetricInDocument**](JsonApiMetricInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_metric_in_document** | [**JsonApiMetricInDocument**](JsonApiMetricInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -571,7 +452,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/NegativeAttributeFilter.md b/gooddata-api-client/docs/NegativeAttributeFilter.md index 2d031d527..b7a013f76 100644 --- a/gooddata-api-client/docs/NegativeAttributeFilter.md +++ b/gooddata-api-client/docs/NegativeAttributeFilter.md @@ -3,11 +3,28 @@ Filter able to limit element values by label and related selected negated elements. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.negative_attribute_filter import NegativeAttributeFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of NegativeAttributeFilter from a JSON string +negative_attribute_filter_instance = NegativeAttributeFilter.from_json(json) +# print the JSON string representation of the object +print(NegativeAttributeFilter.to_json()) + +# convert the object into a dict +negative_attribute_filter_dict = negative_attribute_filter_instance.to_dict() +# create an instance of NegativeAttributeFilter from a dict +negative_attribute_filter_from_dict = NegativeAttributeFilter.from_dict(negative_attribute_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/NegativeAttributeFilterNegativeAttributeFilter.md b/gooddata-api-client/docs/NegativeAttributeFilterNegativeAttributeFilter.md index cd8499341..305ca75a9 100644 --- a/gooddata-api-client/docs/NegativeAttributeFilterNegativeAttributeFilter.md +++ b/gooddata-api-client/docs/NegativeAttributeFilterNegativeAttributeFilter.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**label** | [**AfmIdentifier**](AfmIdentifier.md) | | -**not_in** | [**AttributeFilterElements**](AttributeFilterElements.md) | | **apply_on_result** | **bool** | | [optional] +**label** | [**AfmIdentifier**](AfmIdentifier.md) | | **local_identifier** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**not_in** | [**AttributeFilterElements**](AttributeFilterElements.md) | | + +## Example + +```python +from gooddata_api_client.models.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of NegativeAttributeFilterNegativeAttributeFilter from a JSON string +negative_attribute_filter_negative_attribute_filter_instance = NegativeAttributeFilterNegativeAttributeFilter.from_json(json) +# print the JSON string representation of the object +print(NegativeAttributeFilterNegativeAttributeFilter.to_json()) +# convert the object into a dict +negative_attribute_filter_negative_attribute_filter_dict = negative_attribute_filter_negative_attribute_filter_instance.to_dict() +# create an instance of NegativeAttributeFilterNegativeAttributeFilter from a dict +negative_attribute_filter_negative_attribute_filter_from_dict = NegativeAttributeFilterNegativeAttributeFilter.from_dict(negative_attribute_filter_negative_attribute_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Note.md b/gooddata-api-client/docs/Note.md index 65fef56c2..a5cb0975c 100644 --- a/gooddata-api-client/docs/Note.md +++ b/gooddata-api-client/docs/Note.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **applies_to** | **str** | | [optional] **category** | **str** | | [optional] **content** | **str** | | [optional] **id** | **str** | | [optional] -**other_attributes** | **{str: (str,)}** | | [optional] +**other_attributes** | **Dict[str, str]** | | [optional] **priority** | **int** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.note import Note + +# TODO update the JSON string below +json = "{}" +# create an instance of Note from a JSON string +note_instance = Note.from_json(json) +# print the JSON string representation of the object +print(Note.to_json()) + +# convert the object into a dict +note_dict = note_instance.to_dict() +# create an instance of Note from a dict +note_from_dict = Note.from_dict(note_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Notes.md b/gooddata-api-client/docs/Notes.md index 3ed862a5b..9111bf0ce 100644 --- a/gooddata-api-client/docs/Notes.md +++ b/gooddata-api-client/docs/Notes.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**note** | [**[Note]**](Note.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**note** | [**List[Note]**](Note.md) | | + +## Example + +```python +from gooddata_api_client.models.notes import Notes + +# TODO update the JSON string below +json = "{}" +# create an instance of Notes from a JSON string +notes_instance = Notes.from_json(json) +# print the JSON string representation of the object +print(Notes.to_json()) +# convert the object into a dict +notes_dict = notes_instance.to_dict() +# create an instance of Notes from a dict +notes_from_dict = Notes.from_dict(notes_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Notification.md b/gooddata-api-client/docs/Notification.md index 52cf44b1a..4dde8b207 100644 --- a/gooddata-api-client/docs/Notification.md +++ b/gooddata-api-client/docs/Notification.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**automation_id** | **str** | | [optional] **created_at** | **datetime** | | **data** | [**NotificationData**](NotificationData.md) | | **id** | **str** | | **is_read** | **bool** | | -**automation_id** | **str** | | [optional] **workspace_id** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.notification import Notification + +# TODO update the JSON string below +json = "{}" +# create an instance of Notification from a JSON string +notification_instance = Notification.from_json(json) +# print the JSON string representation of the object +print(Notification.to_json()) + +# convert the object into a dict +notification_dict = notification_instance.to_dict() +# create an instance of Notification from a dict +notification_from_dict = Notification.from_dict(notification_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/NotificationChannelDestination.md b/gooddata-api-client/docs/NotificationChannelDestination.md index 7bf38f616..bfc4e03b7 100644 --- a/gooddata-api-client/docs/NotificationChannelDestination.md +++ b/gooddata-api-client/docs/NotificationChannelDestination.md @@ -2,20 +2,37 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | | -**has_token** | **bool, none_type** | Flag indicating if webhook has a token. | [optional] [readonly] -**token** | **str, none_type** | Bearer token for the webhook. | [optional] +**has_token** | **bool** | Flag indicating if webhook has a token. | [optional] [readonly] +**token** | **str** | Bearer token for the webhook. | [optional] **url** | **str** | The webhook URL. | [optional] -**from_email** | **str** | E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead. | [optional] if omitted the server will use the default value of no-reply@gooddata.com -**from_email_name** | **str** | An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead. | [optional] if omitted the server will use the default value of "GoodData" +**from_email** | **str** | E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead. | [optional] [default to 'no-reply@gooddata.com'] +**from_email_name** | **str** | An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead. | [optional] [default to 'GoodData'] **host** | **str** | The SMTP server address. | [optional] **password** | **str** | The SMTP server password. | [optional] **port** | **int** | The SMTP server port. | [optional] **username** | **str** | The SMTP server username. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.notification_channel_destination import NotificationChannelDestination + +# TODO update the JSON string below +json = "{}" +# create an instance of NotificationChannelDestination from a JSON string +notification_channel_destination_instance = NotificationChannelDestination.from_json(json) +# print the JSON string representation of the object +print(NotificationChannelDestination.to_json()) + +# convert the object into a dict +notification_channel_destination_dict = notification_channel_destination_instance.to_dict() +# create an instance of NotificationChannelDestination from a dict +notification_channel_destination_from_dict = NotificationChannelDestination.from_dict(notification_channel_destination_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/NotificationChannelsApi.md b/gooddata-api-client/docs/NotificationChannelsApi.md index 6f7aaf0f9..b2c6c21d8 100644 --- a/gooddata-api-client/docs/NotificationChannelsApi.md +++ b/gooddata-api-client/docs/NotificationChannelsApi.md @@ -32,12 +32,12 @@ Post Notification Channel entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument -from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -46,41 +46,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - json_api_notification_channel_post_optional_id_document = JsonApiNotificationChannelPostOptionalIdDocument( - data=JsonApiNotificationChannelPostOptionalId( - attributes=JsonApiNotificationChannelInAttributes( - allowed_recipients="CREATOR", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="HIDDEN", - description="description_example", - destination=JsonApiNotificationChannelInAttributesDestination(None), - in_platform_notification="DISABLED", - name="name_example", - notification_source="notification_source_example", - ), - id="id1", - type="notificationChannel", - ), - ) # JsonApiNotificationChannelPostOptionalIdDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + json_api_notification_channel_post_optional_id_document = gooddata_api_client.JsonApiNotificationChannelPostOptionalIdDocument() # JsonApiNotificationChannelPostOptionalIdDocument | + try: # Post Notification Channel entities api_response = api_instance.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document) + print("The response of NotificationChannelsApi->create_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->create_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_notification_channel_post_optional_id_document** | [**JsonApiNotificationChannelPostOptionalIdDocument**](JsonApiNotificationChannelPostOptionalIdDocument.md)| | + **json_api_notification_channel_post_optional_id_document** | [**JsonApiNotificationChannelPostOptionalIdDocument**](JsonApiNotificationChannelPostOptionalIdDocument.md)| | ### Return type @@ -95,7 +82,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -105,7 +91,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_notification_channels** -> delete_entity_notification_channels(id) +> delete_entity_notification_channels(id, filter=filter) Delete Notification Channel entity @@ -113,10 +99,10 @@ Delete Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -125,35 +111,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Notification Channel entity - api_instance.delete_entity_notification_channels(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling NotificationChannelsApi->delete_entity_notification_channels: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Notification Channel entity api_instance.delete_entity_notification_channels(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->delete_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -168,7 +147,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -178,7 +156,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_notification_channel_identifiers** -> JsonApiNotificationChannelIdentifierOutList get_all_entities_notification_channel_identifiers() +> JsonApiNotificationChannelIdentifierOutList get_all_entities_notification_channel_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) @@ -186,11 +164,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.models.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -199,38 +177,35 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: api_response = api_instance.get_all_entities_notification_channel_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of NotificationChannelsApi->get_all_entities_notification_channel_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->get_all_entities_notification_channel_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -245,7 +220,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -255,7 +229,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_notification_channels** -> JsonApiNotificationChannelOutList get_all_entities_notification_channels() +> JsonApiNotificationChannelOutList get_all_entities_notification_channels(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Notification Channel entities @@ -263,11 +237,11 @@ Get all Notification Channel entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.models.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -276,39 +250,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Notification Channel entities api_response = api_instance.get_all_entities_notification_channels(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of NotificationChannelsApi->get_all_entities_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->get_all_entities_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -323,7 +294,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -333,7 +303,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_notification_channel_identifiers** -> JsonApiNotificationChannelIdentifierOutDocument get_entity_notification_channel_identifiers(id) +> JsonApiNotificationChannelIdentifierOutDocument get_entity_notification_channel_identifiers(id, filter=filter) @@ -341,11 +311,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -354,35 +324,29 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_entity_notification_channel_identifiers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling NotificationChannelsApi->get_entity_notification_channel_identifiers: %s\n" % e) + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: api_response = api_instance.get_entity_notification_channel_identifiers(id, filter=filter) + print("The response of NotificationChannelsApi->get_entity_notification_channel_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->get_entity_notification_channel_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -397,7 +361,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -407,7 +370,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_notification_channels** -> JsonApiNotificationChannelOutDocument get_entity_notification_channels(id) +> JsonApiNotificationChannelOutDocument get_entity_notification_channels(id, filter=filter) Get Notification Channel entity @@ -415,11 +378,11 @@ Get Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -428,37 +391,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Notification Channel entity - api_response = api_instance.get_entity_notification_channels(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling NotificationChannelsApi->get_entity_notification_channels: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Notification Channel entity api_response = api_instance.get_entity_notification_channels(id, filter=filter) + print("The response of NotificationChannelsApi->get_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->get_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -473,7 +429,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -493,11 +448,11 @@ Gets complete layout of export templates. ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.models.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -506,21 +461,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all export templates layout api_response = api_instance.get_export_templates_layout() + print("The response of NotificationChannelsApi->get_export_templates_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->get_export_templates_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -536,7 +493,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -556,11 +512,11 @@ Gets complete layout of notification channels. ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.models.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -569,21 +525,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all notification channels layout api_response = api_instance.get_notification_channels_layout() + print("The response of NotificationChannelsApi->get_notification_channels_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->get_notification_channels_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -599,7 +557,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -609,7 +566,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_notifications** -> Notifications get_notifications() +> Notifications get_notifications(workspace_id=workspace_id, is_read=is_read, page=page, size=size, meta_include=meta_include) Get latest notifications. @@ -619,11 +576,11 @@ Get latest in-platform notifications for the current user. ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.notifications import Notifications +from gooddata_api_client.models.notifications import Notifications +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -632,37 +589,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - workspace_id = "workspaceId_example" # str | Workspace ID to filter notifications by. (optional) + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace ID to filter notifications by. (optional) is_read = True # bool | Filter notifications by read status. (optional) - page = "0" # str | Zero-based page index (0..N) (optional) if omitted the server will use the default value of "0" - size = "20" # str | The size of the page to be returned. (optional) if omitted the server will use the default value of "20" - meta_include = [ - "total", - ] # [str] | Additional meta information to include in the response. (optional) - - # example passing only required values which don't have defaults set - # and optional values + page = '0' # str | Zero-based page index (0..N) (optional) (default to '0') + size = '20' # str | The size of the page to be returned. (optional) (default to '20') + meta_include = ['meta_include_example'] # List[str] | Additional meta information to include in the response. (optional) + try: # Get latest notifications. api_response = api_instance.get_notifications(workspace_id=workspace_id, is_read=is_read, page=page, size=size, meta_include=meta_include) + print("The response of NotificationChannelsApi->get_notifications:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->get_notifications: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace ID to filter notifications by. | [optional] - **is_read** | **bool**| Filter notifications by read status. | [optional] - **page** | **str**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of "0" - **size** | **str**| The size of the page to be returned. | [optional] if omitted the server will use the default value of "20" - **meta_include** | **[str]**| Additional meta information to include in the response. | [optional] + **workspace_id** | **str**| Workspace ID to filter notifications by. | [optional] + **is_read** | **bool**| Filter notifications by read status. | [optional] + **page** | **str**| Zero-based page index (0..N) | [optional] [default to '0'] + **size** | **str**| The size of the page to be returned. | [optional] [default to '20'] + **meta_include** | [**List[str]**](str.md)| Additional meta information to include in the response. | [optional] ### Return type @@ -677,7 +633,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -697,10 +652,10 @@ Mark in-platform notification by its ID as read. ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -709,25 +664,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - notification_id = "notificationId_example" # str | Notification ID to mark as read. + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + notification_id = 'notification_id_example' # str | Notification ID to mark as read. - # example passing only required values which don't have defaults set try: # Mark notification as read. api_instance.mark_as_read_notification(notification_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->mark_as_read_notification: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **notification_id** | **str**| Notification ID to mark as read. | + **notification_id** | **str**| Notification ID to mark as read. | ### Return type @@ -742,7 +698,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -752,7 +707,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **mark_as_read_notification_all** -> mark_as_read_notification_all() +> mark_as_read_notification_all(workspace_id=workspace_id) Mark all notifications as read. @@ -762,10 +717,10 @@ Mark all user in-platform notifications as read. ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -774,26 +729,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - workspace_id = "workspaceId_example" # str | Workspace ID where to mark notifications as read. (optional) + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace ID where to mark notifications as read. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Mark all notifications as read. api_instance.mark_as_read_notification_all(workspace_id=workspace_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->mark_as_read_notification_all: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace ID where to mark notifications as read. | [optional] + **workspace_id** | **str**| Workspace ID where to mark notifications as read. | [optional] ### Return type @@ -808,7 +763,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -818,7 +772,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_notification_channels** -> JsonApiNotificationChannelOutDocument patch_entity_notification_channels(id, json_api_notification_channel_patch_document) +> JsonApiNotificationChannelOutDocument patch_entity_notification_channels(id, json_api_notification_channel_patch_document, filter=filter) Patch Notification Channel entity @@ -826,12 +780,12 @@ Patch Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument -from gooddata_api_client.model.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -840,54 +794,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_notification_channel_patch_document = JsonApiNotificationChannelPatchDocument( - data=JsonApiNotificationChannelPatch( - attributes=JsonApiNotificationChannelInAttributes( - allowed_recipients="CREATOR", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="HIDDEN", - description="description_example", - destination=JsonApiNotificationChannelInAttributesDestination(None), - in_platform_notification="DISABLED", - name="name_example", - notification_source="notification_source_example", - ), - id="id1", - type="notificationChannel", - ), - ) # JsonApiNotificationChannelPatchDocument | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Notification Channel entity - api_response = api_instance.patch_entity_notification_channels(id, json_api_notification_channel_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling NotificationChannelsApi->patch_entity_notification_channels: %s\n" % e) + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + id = 'id_example' # str | + json_api_notification_channel_patch_document = gooddata_api_client.JsonApiNotificationChannelPatchDocument() # JsonApiNotificationChannelPatchDocument | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Notification Channel entity api_response = api_instance.patch_entity_notification_channels(id, json_api_notification_channel_patch_document, filter=filter) + print("The response of NotificationChannelsApi->patch_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->patch_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_notification_channel_patch_document** | [**JsonApiNotificationChannelPatchDocument**](JsonApiNotificationChannelPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_notification_channel_patch_document** | [**JsonApiNotificationChannelPatchDocument**](JsonApiNotificationChannelPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -902,7 +834,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -922,11 +853,11 @@ Sets export templates in organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.models.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -935,99 +866,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - declarative_export_templates = DeclarativeExportTemplates( - export_templates=[ - DeclarativeExportTemplate( - dashboard_slides_template=DashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - id="default-export-template", - name="My default export template", - widget_slides_template=WidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - ], - ) # DeclarativeExportTemplates | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + declarative_export_templates = gooddata_api_client.DeclarativeExportTemplates() # DeclarativeExportTemplates | + try: # Set all export templates api_instance.set_export_templates(declarative_export_templates) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->set_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_export_templates** | [**DeclarativeExportTemplates**](DeclarativeExportTemplates.md)| | + **declarative_export_templates** | [**DeclarativeExportTemplates**](DeclarativeExportTemplates.md)| | ### Return type @@ -1042,7 +900,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1062,11 +919,11 @@ Sets notification channels in organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.models.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1075,39 +932,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - declarative_notification_channels = DeclarativeNotificationChannels( - notification_channels=[ - DeclarativeNotificationChannel( - allowed_recipients="INTERNAL", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="INTERNAL_ONLY", - description="This is a channel", - destination=DeclarativeNotificationChannelDestination(None), - id="notification-channel-1", - in_platform_notification="DISABLED", - name="channel", - notification_source="notification_source_example", - ), - ], - ) # DeclarativeNotificationChannels | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + declarative_notification_channels = gooddata_api_client.DeclarativeNotificationChannels() # DeclarativeNotificationChannels | + try: # Set all notification channels api_instance.set_notification_channels(declarative_notification_channels) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->set_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_notification_channels** | [**DeclarativeNotificationChannels**](DeclarativeNotificationChannels.md)| | + **declarative_notification_channels** | [**DeclarativeNotificationChannels**](DeclarativeNotificationChannels.md)| | ### Return type @@ -1122,7 +966,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1132,7 +975,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **test_existing_notification_channel** -> TestResponse test_existing_notification_channel(notification_channel_id) +> TestResponse test_existing_notification_channel(notification_channel_id, test_destination_request=test_destination_request) Test existing notification channel. @@ -1142,12 +985,12 @@ Tests the existing notification channel by sending a test notification. ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1156,44 +999,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - notification_channel_id = "notificationChannelId_example" # str | - test_destination_request = TestDestinationRequest( - destination=DeclarativeNotificationChannelDestination(None), - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - ) # TestDestinationRequest | (optional) - - # example passing only required values which don't have defaults set - try: - # Test existing notification channel. - api_response = api_instance.test_existing_notification_channel(notification_channel_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling NotificationChannelsApi->test_existing_notification_channel: %s\n" % e) + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + notification_channel_id = 'notification_channel_id_example' # str | + test_destination_request = gooddata_api_client.TestDestinationRequest() # TestDestinationRequest | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Test existing notification channel. api_response = api_instance.test_existing_notification_channel(notification_channel_id, test_destination_request=test_destination_request) + print("The response of NotificationChannelsApi->test_existing_notification_channel:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->test_existing_notification_channel: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **notification_channel_id** | **str**| | - **test_destination_request** | [**TestDestinationRequest**](TestDestinationRequest.md)| | [optional] + **notification_channel_id** | **str**| | + **test_destination_request** | [**TestDestinationRequest**](TestDestinationRequest.md)| | [optional] ### Return type @@ -1208,7 +1037,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1228,12 +1056,12 @@ Tests the notification channel by sending a test notification. ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1242,33 +1070,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - test_destination_request = TestDestinationRequest( - destination=DeclarativeNotificationChannelDestination(None), - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - ) # TestDestinationRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + test_destination_request = gooddata_api_client.TestDestinationRequest() # TestDestinationRequest | + try: # Test notification channel. api_response = api_instance.test_notification_channel(test_destination_request) + print("The response of NotificationChannelsApi->test_notification_channel:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->test_notification_channel: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **test_destination_request** | [**TestDestinationRequest**](TestDestinationRequest.md)| | + **test_destination_request** | [**TestDestinationRequest**](TestDestinationRequest.md)| | ### Return type @@ -1283,7 +1106,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1293,7 +1115,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_notification_channels** -> JsonApiNotificationChannelOutDocument update_entity_notification_channels(id, json_api_notification_channel_in_document) +> JsonApiNotificationChannelOutDocument update_entity_notification_channels(id, json_api_notification_channel_in_document, filter=filter) Put Notification Channel entity @@ -1301,12 +1123,12 @@ Put Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import notification_channels_api -from gooddata_api_client.model.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1315,54 +1137,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = notification_channels_api.NotificationChannelsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_notification_channel_in_document = JsonApiNotificationChannelInDocument( - data=JsonApiNotificationChannelIn( - attributes=JsonApiNotificationChannelInAttributes( - allowed_recipients="CREATOR", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="HIDDEN", - description="description_example", - destination=JsonApiNotificationChannelInAttributesDestination(None), - in_platform_notification="DISABLED", - name="name_example", - notification_source="notification_source_example", - ), - id="id1", - type="notificationChannel", - ), - ) # JsonApiNotificationChannelInDocument | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Notification Channel entity - api_response = api_instance.update_entity_notification_channels(id, json_api_notification_channel_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling NotificationChannelsApi->update_entity_notification_channels: %s\n" % e) + api_instance = gooddata_api_client.NotificationChannelsApi(api_client) + id = 'id_example' # str | + json_api_notification_channel_in_document = gooddata_api_client.JsonApiNotificationChannelInDocument() # JsonApiNotificationChannelInDocument | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Notification Channel entity api_response = api_instance.update_entity_notification_channels(id, json_api_notification_channel_in_document, filter=filter) + print("The response of NotificationChannelsApi->update_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling NotificationChannelsApi->update_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_notification_channel_in_document** | [**JsonApiNotificationChannelInDocument**](JsonApiNotificationChannelInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_notification_channel_in_document** | [**JsonApiNotificationChannelInDocument**](JsonApiNotificationChannelInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1377,7 +1177,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/NotificationContent.md b/gooddata-api-client/docs/NotificationContent.md index d089295d3..4edfcc0e7 100644 --- a/gooddata-api-client/docs/NotificationContent.md +++ b/gooddata-api-client/docs/NotificationContent.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.notification_content import NotificationContent + +# TODO update the JSON string below +json = "{}" +# create an instance of NotificationContent from a JSON string +notification_content_instance = NotificationContent.from_json(json) +# print the JSON string representation of the object +print(NotificationContent.to_json()) + +# convert the object into a dict +notification_content_dict = notification_content_instance.to_dict() +# create an instance of NotificationContent from a dict +notification_content_from_dict = NotificationContent.from_dict(notification_content_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/NotificationData.md b/gooddata-api-client/docs/NotificationData.md index ddc8a753b..0811e3b55 100644 --- a/gooddata-api-client/docs/NotificationData.md +++ b/gooddata-api-client/docs/NotificationData.md @@ -2,13 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | | -**message** | **str** | | [optional] -**content** | [**WebhookMessage**](WebhookMessage.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**message** | **str** | | + +## Example + +```python +from gooddata_api_client.models.notification_data import NotificationData + +# TODO update the JSON string below +json = "{}" +# create an instance of NotificationData from a JSON string +notification_data_instance = NotificationData.from_json(json) +# print the JSON string representation of the object +print(NotificationData.to_json()) +# convert the object into a dict +notification_data_dict = notification_data_instance.to_dict() +# create an instance of NotificationData from a dict +notification_data_from_dict = NotificationData.from_dict(notification_data_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/NotificationFilter.md b/gooddata-api-client/docs/NotificationFilter.md index 8a2b68598..886ff7697 100644 --- a/gooddata-api-client/docs/NotificationFilter.md +++ b/gooddata-api-client/docs/NotificationFilter.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **filter** | **str** | | **title** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.notification_filter import NotificationFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of NotificationFilter from a JSON string +notification_filter_instance = NotificationFilter.from_json(json) +# print the JSON string representation of the object +print(NotificationFilter.to_json()) + +# convert the object into a dict +notification_filter_dict = notification_filter_instance.to_dict() +# create an instance of NotificationFilter from a dict +notification_filter_from_dict = NotificationFilter.from_dict(notification_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Notifications.md b/gooddata-api-client/docs/Notifications.md index 0d81ec12d..b21dfdd15 100644 --- a/gooddata-api-client/docs/Notifications.md +++ b/gooddata-api-client/docs/Notifications.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[Notification]**](Notification.md) | | +**data** | [**List[Notification]**](Notification.md) | | **meta** | [**NotificationsMeta**](NotificationsMeta.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.notifications import Notifications + +# TODO update the JSON string below +json = "{}" +# create an instance of Notifications from a JSON string +notifications_instance = Notifications.from_json(json) +# print the JSON string representation of the object +print(Notifications.to_json()) + +# convert the object into a dict +notifications_dict = notifications_instance.to_dict() +# create an instance of Notifications from a dict +notifications_from_dict = Notifications.from_dict(notifications_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/NotificationsMeta.md b/gooddata-api-client/docs/NotificationsMeta.md index 22ca9a348..8f2247f7f 100644 --- a/gooddata-api-client/docs/NotificationsMeta.md +++ b/gooddata-api-client/docs/NotificationsMeta.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total** | [**NotificationsMetaTotal**](NotificationsMetaTotal.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.notifications_meta import NotificationsMeta + +# TODO update the JSON string below +json = "{}" +# create an instance of NotificationsMeta from a JSON string +notifications_meta_instance = NotificationsMeta.from_json(json) +# print the JSON string representation of the object +print(NotificationsMeta.to_json()) + +# convert the object into a dict +notifications_meta_dict = notifications_meta_instance.to_dict() +# create an instance of NotificationsMeta from a dict +notifications_meta_from_dict = NotificationsMeta.from_dict(notifications_meta_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/NotificationsMetaTotal.md b/gooddata-api-client/docs/NotificationsMetaTotal.md index 05104bb48..768d7c54a 100644 --- a/gooddata-api-client/docs/NotificationsMetaTotal.md +++ b/gooddata-api-client/docs/NotificationsMetaTotal.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **all** | **int** | | **unread** | **int** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.notifications_meta_total import NotificationsMetaTotal + +# TODO update the JSON string below +json = "{}" +# create an instance of NotificationsMetaTotal from a JSON string +notifications_meta_total_instance = NotificationsMetaTotal.from_json(json) +# print the JSON string representation of the object +print(NotificationsMetaTotal.to_json()) + +# convert the object into a dict +notifications_meta_total_dict = notifications_meta_total_instance.to_dict() +# create an instance of NotificationsMetaTotal from a dict +notifications_meta_total_from_dict = NotificationsMetaTotal.from_dict(notifications_meta_total_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ObjectLinks.md b/gooddata-api-client/docs/ObjectLinks.md index d2761c718..0133efd3d 100644 --- a/gooddata-api-client/docs/ObjectLinks.md +++ b/gooddata-api-client/docs/ObjectLinks.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_self** | **str** | A string containing the link's URL. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**var_self** | **str** | A string containing the link's URL. | + +## Example + +```python +from gooddata_api_client.models.object_links import ObjectLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of ObjectLinks from a JSON string +object_links_instance = ObjectLinks.from_json(json) +# print the JSON string representation of the object +print(ObjectLinks.to_json()) +# convert the object into a dict +object_links_dict = object_links_instance.to_dict() +# create an instance of ObjectLinks from a dict +object_links_from_dict = ObjectLinks.from_dict(object_links_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ObjectLinksContainer.md b/gooddata-api-client/docs/ObjectLinksContainer.md index 69bc8612f..8ba9fa722 100644 --- a/gooddata-api-client/docs/ObjectLinksContainer.md +++ b/gooddata-api-client/docs/ObjectLinksContainer.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.object_links_container import ObjectLinksContainer + +# TODO update the JSON string below +json = "{}" +# create an instance of ObjectLinksContainer from a JSON string +object_links_container_instance = ObjectLinksContainer.from_json(json) +# print the JSON string representation of the object +print(ObjectLinksContainer.to_json()) + +# convert the object into a dict +object_links_container_dict = object_links_container_instance.to_dict() +# create an instance of ObjectLinksContainer from a dict +object_links_container_from_dict = ObjectLinksContainer.from_dict(object_links_container_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/OptionsApi.md b/gooddata-api-client/docs/OptionsApi.md index 6101e7a6e..dab5597f2 100644 --- a/gooddata-api-client/docs/OptionsApi.md +++ b/gooddata-api-client/docs/OptionsApi.md @@ -8,7 +8,7 @@ Method | HTTP request | Description # **get_all_options** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_options() +> object get_all_options() Links for all configuration options @@ -18,10 +18,10 @@ Retrieves links for all options for different configurations. ```python -import time import gooddata_api_client -from gooddata_api_client.api import options_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -30,26 +30,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = options_api.OptionsApi(api_client) + api_instance = gooddata_api_client.OptionsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Links for all configuration options api_response = api_instance.get_all_options() + print("The response of OptionsApi->get_all_options:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OptionsApi->get_all_options: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +**object** ### Authorization @@ -60,7 +62,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/OrganizationApi.md b/gooddata-api-client/docs/OrganizationApi.md index a16d1304c..ba9443edd 100644 --- a/gooddata-api-client/docs/OrganizationApi.md +++ b/gooddata-api-client/docs/OrganizationApi.md @@ -18,11 +18,11 @@ Switch the active identity provider for the organization. Requires MANAGE permis ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_api -from gooddata_api_client.model.switch_identity_provider_request import SwitchIdentityProviderRequest +from gooddata_api_client.models.switch_identity_provider_request import SwitchIdentityProviderRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -31,27 +31,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_api.OrganizationApi(api_client) - switch_identity_provider_request = SwitchIdentityProviderRequest( - idp_id="my-idp-123", - ) # SwitchIdentityProviderRequest | + api_instance = gooddata_api_client.OrganizationApi(api_client) + switch_identity_provider_request = gooddata_api_client.SwitchIdentityProviderRequest() # SwitchIdentityProviderRequest | - # example passing only required values which don't have defaults set try: # Switch Active Identity Provider api_instance.switch_active_identity_provider(switch_identity_provider_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationApi->switch_active_identity_provider: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **switch_identity_provider_request** | [**SwitchIdentityProviderRequest**](SwitchIdentityProviderRequest.md)| | + **switch_identity_provider_request** | [**SwitchIdentityProviderRequest**](SwitchIdentityProviderRequest.md)| | ### Return type @@ -66,7 +65,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/OrganizationAutomationIdentifier.md b/gooddata-api-client/docs/OrganizationAutomationIdentifier.md index 7d84b5cf7..3e41df3b1 100644 --- a/gooddata-api-client/docs/OrganizationAutomationIdentifier.md +++ b/gooddata-api-client/docs/OrganizationAutomationIdentifier.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **workspace_id** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.organization_automation_identifier import OrganizationAutomationIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of OrganizationAutomationIdentifier from a JSON string +organization_automation_identifier_instance = OrganizationAutomationIdentifier.from_json(json) +# print the JSON string representation of the object +print(OrganizationAutomationIdentifier.to_json()) + +# convert the object into a dict +organization_automation_identifier_dict = organization_automation_identifier_instance.to_dict() +# create an instance of OrganizationAutomationIdentifier from a dict +organization_automation_identifier_from_dict = OrganizationAutomationIdentifier.from_dict(organization_automation_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/OrganizationAutomationManagementBulkRequest.md b/gooddata-api-client/docs/OrganizationAutomationManagementBulkRequest.md index 4e434256e..a058b8516 100644 --- a/gooddata-api-client/docs/OrganizationAutomationManagementBulkRequest.md +++ b/gooddata-api-client/docs/OrganizationAutomationManagementBulkRequest.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**automations** | [**[OrganizationAutomationIdentifier]**](OrganizationAutomationIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**automations** | [**List[OrganizationAutomationIdentifier]**](OrganizationAutomationIdentifier.md) | | + +## Example + +```python +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of OrganizationAutomationManagementBulkRequest from a JSON string +organization_automation_management_bulk_request_instance = OrganizationAutomationManagementBulkRequest.from_json(json) +# print the JSON string representation of the object +print(OrganizationAutomationManagementBulkRequest.to_json()) +# convert the object into a dict +organization_automation_management_bulk_request_dict = organization_automation_management_bulk_request_instance.to_dict() +# create an instance of OrganizationAutomationManagementBulkRequest from a dict +organization_automation_management_bulk_request_from_dict = OrganizationAutomationManagementBulkRequest.from_dict(organization_automation_management_bulk_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/OrganizationControllerApi.md b/gooddata-api-client/docs/OrganizationControllerApi.md index 815263cc7..e36227d5b 100644 --- a/gooddata-api-client/docs/OrganizationControllerApi.md +++ b/gooddata-api-client/docs/OrganizationControllerApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **get_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument get_entity_cookie_security_configurations(id) +> JsonApiCookieSecurityConfigurationOutDocument get_entity_cookie_security_configurations(id, filter=filter) Get CookieSecurityConfiguration @@ -21,11 +21,11 @@ Get CookieSecurityConfiguration ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_controller_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -34,37 +34,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.OrganizationControllerApi(api_client) + id = 'id_example' # str | + filter = 'lastRotation==InstantValue;rotationInterval==DurationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get CookieSecurityConfiguration - api_response = api_instance.get_entity_cookie_security_configurations(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->get_entity_cookie_security_configurations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get CookieSecurityConfiguration api_response = api_instance.get_entity_cookie_security_configurations(id, filter=filter) + print("The response of OrganizationControllerApi->get_entity_cookie_security_configurations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationControllerApi->get_entity_cookie_security_configurations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -79,7 +72,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -89,7 +81,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_organizations** -> JsonApiOrganizationOutDocument get_entity_organizations(id) +> JsonApiOrganizationOutDocument get_entity_organizations(id, filter=filter, include=include, meta_include=meta_include) Get Organizations @@ -97,11 +89,11 @@ Get Organizations ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_controller_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -110,45 +102,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "bootstrapUser,bootstrapUserGroup,identityProvider", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Organizations - api_response = api_instance.get_entity_organizations(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->get_entity_organizations: %s\n" % e) + api_instance = gooddata_api_client.OrganizationControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['bootstrapUser,bootstrapUserGroup,identityProvider'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Organizations api_response = api_instance.get_entity_organizations(id, filter=filter, include=include, meta_include=meta_include) + print("The response of OrganizationControllerApi->get_entity_organizations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationControllerApi->get_entity_organizations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -163,7 +144,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -173,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) +> JsonApiCookieSecurityConfigurationOutDocument patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, filter=filter) Patch CookieSecurityConfiguration @@ -181,12 +161,12 @@ Patch CookieSecurityConfiguration ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_controller_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -195,48 +175,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_cookie_security_configuration_patch_document = JsonApiCookieSecurityConfigurationPatchDocument( - data=JsonApiCookieSecurityConfigurationPatch( - attributes=JsonApiCookieSecurityConfigurationInAttributes( - last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), - rotation_interval="P30D", - ), - id="id1", - type="cookieSecurityConfiguration", - ), - ) # JsonApiCookieSecurityConfigurationPatchDocument | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch CookieSecurityConfiguration - api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->patch_entity_cookie_security_configurations: %s\n" % e) + api_instance = gooddata_api_client.OrganizationControllerApi(api_client) + id = 'id_example' # str | + json_api_cookie_security_configuration_patch_document = gooddata_api_client.JsonApiCookieSecurityConfigurationPatchDocument() # JsonApiCookieSecurityConfigurationPatchDocument | + filter = 'lastRotation==InstantValue;rotationInterval==DurationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch CookieSecurityConfiguration api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, filter=filter) + print("The response of OrganizationControllerApi->patch_entity_cookie_security_configurations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationControllerApi->patch_entity_cookie_security_configurations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_cookie_security_configuration_patch_document** | [**JsonApiCookieSecurityConfigurationPatchDocument**](JsonApiCookieSecurityConfigurationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_cookie_security_configuration_patch_document** | [**JsonApiCookieSecurityConfigurationPatchDocument**](JsonApiCookieSecurityConfigurationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -251,7 +215,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -261,7 +224,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_organizations** -> JsonApiOrganizationOutDocument patch_entity_organizations(id, json_api_organization_patch_document) +> JsonApiOrganizationOutDocument patch_entity_organizations(id, json_api_organization_patch_document, filter=filter, include=include) Patch Organization @@ -269,12 +232,12 @@ Patch Organization ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_controller_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -283,75 +246,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_patch_document = JsonApiOrganizationPatchDocument( - data=JsonApiOrganizationPatch( - attributes=JsonApiOrganizationInAttributes( - allowed_origins=[ - "allowed_origins_example", - ], - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - hostname="hostname_example", - name="name_example", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - ), - id="id1", - relationships=JsonApiOrganizationInRelationships( - identity_provider=JsonApiOrganizationInRelationshipsIdentityProvider( - data=JsonApiIdentityProviderToOneLinkage(None), - ), - ), - type="organization", - ), - ) # JsonApiOrganizationPatchDocument | - filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "bootstrapUser,bootstrapUserGroup,identityProvider", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Organization - api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->patch_entity_organizations: %s\n" % e) + api_instance = gooddata_api_client.OrganizationControllerApi(api_client) + id = 'id_example' # str | + json_api_organization_patch_document = gooddata_api_client.JsonApiOrganizationPatchDocument() # JsonApiOrganizationPatchDocument | + filter = 'name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['bootstrapUser,bootstrapUserGroup,identityProvider'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Organization api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document, filter=filter, include=include) + print("The response of OrganizationControllerApi->patch_entity_organizations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationControllerApi->patch_entity_organizations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_patch_document** | [**JsonApiOrganizationPatchDocument**](JsonApiOrganizationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_organization_patch_document** | [**JsonApiOrganizationPatchDocument**](JsonApiOrganizationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -366,7 +288,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -376,7 +297,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document) +> JsonApiCookieSecurityConfigurationOutDocument update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, filter=filter) Put CookieSecurityConfiguration @@ -384,12 +305,12 @@ Put CookieSecurityConfiguration ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_controller_api -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -398,48 +319,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_cookie_security_configuration_in_document = JsonApiCookieSecurityConfigurationInDocument( - data=JsonApiCookieSecurityConfigurationIn( - attributes=JsonApiCookieSecurityConfigurationInAttributes( - last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), - rotation_interval="P30D", - ), - id="id1", - type="cookieSecurityConfiguration", - ), - ) # JsonApiCookieSecurityConfigurationInDocument | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put CookieSecurityConfiguration - api_response = api_instance.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->update_entity_cookie_security_configurations: %s\n" % e) + api_instance = gooddata_api_client.OrganizationControllerApi(api_client) + id = 'id_example' # str | + json_api_cookie_security_configuration_in_document = gooddata_api_client.JsonApiCookieSecurityConfigurationInDocument() # JsonApiCookieSecurityConfigurationInDocument | + filter = 'lastRotation==InstantValue;rotationInterval==DurationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put CookieSecurityConfiguration api_response = api_instance.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, filter=filter) + print("The response of OrganizationControllerApi->update_entity_cookie_security_configurations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationControllerApi->update_entity_cookie_security_configurations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_cookie_security_configuration_in_document** | [**JsonApiCookieSecurityConfigurationInDocument**](JsonApiCookieSecurityConfigurationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_cookie_security_configuration_in_document** | [**JsonApiCookieSecurityConfigurationInDocument**](JsonApiCookieSecurityConfigurationInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -454,7 +359,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -464,7 +368,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_organizations** -> JsonApiOrganizationOutDocument update_entity_organizations(id, json_api_organization_in_document) +> JsonApiOrganizationOutDocument update_entity_organizations(id, json_api_organization_in_document, filter=filter, include=include) Put Organization @@ -472,12 +376,12 @@ Put Organization ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_controller_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -486,75 +390,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_in_document = JsonApiOrganizationInDocument( - data=JsonApiOrganizationIn( - attributes=JsonApiOrganizationInAttributes( - allowed_origins=[ - "allowed_origins_example", - ], - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - hostname="hostname_example", - name="name_example", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - ), - id="id1", - relationships=JsonApiOrganizationInRelationships( - identity_provider=JsonApiOrganizationInRelationshipsIdentityProvider( - data=JsonApiIdentityProviderToOneLinkage(None), - ), - ), - type="organization", - ), - ) # JsonApiOrganizationInDocument | - filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "bootstrapUser,bootstrapUserGroup,identityProvider", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Organization - api_response = api_instance.update_entity_organizations(id, json_api_organization_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->update_entity_organizations: %s\n" % e) + api_instance = gooddata_api_client.OrganizationControllerApi(api_client) + id = 'id_example' # str | + json_api_organization_in_document = gooddata_api_client.JsonApiOrganizationInDocument() # JsonApiOrganizationInDocument | + filter = 'name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['bootstrapUser,bootstrapUserGroup,identityProvider'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Organization api_response = api_instance.update_entity_organizations(id, json_api_organization_in_document, filter=filter, include=include) + print("The response of OrganizationControllerApi->update_entity_organizations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationControllerApi->update_entity_organizations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_in_document** | [**JsonApiOrganizationInDocument**](JsonApiOrganizationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_organization_in_document** | [**JsonApiOrganizationInDocument**](JsonApiOrganizationInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -569,7 +432,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md index f9e243d0c..1e8b6c5a3 100644 --- a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **get_organization_layout** -> DeclarativeOrganization get_organization_layout() +> DeclarativeOrganization get_organization_layout(exclude=exclude) Get organization layout @@ -19,11 +19,11 @@ Retrieve complete layout of organization, workspaces, user-groups, etc. ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_declarative_apis_api -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -32,29 +32,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_declarative_apis_api.OrganizationDeclarativeAPIsApi(api_client) - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) + api_instance = gooddata_api_client.OrganizationDeclarativeAPIsApi(api_client) + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get organization layout api_response = api_instance.get_organization_layout(exclude=exclude) + print("The response of OrganizationDeclarativeAPIsApi->get_organization_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationDeclarativeAPIsApi->get_organization_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **exclude** | **[str]**| | [optional] + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type @@ -69,7 +68,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -89,11 +87,11 @@ Sets complete layout of organization, like workspaces, user-groups, etc. ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_declarative_apis_api -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -102,964 +100,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_declarative_apis_api.OrganizationDeclarativeAPIsApi(api_client) - declarative_organization = DeclarativeOrganization( - data_sources=[ - DeclarativeDataSource( - authentication_type="USERNAME_PASSWORD", - cache_strategy="ALWAYS", - client_id="client1234", - client_secret="client_secret_example", - decoded_parameters=[ - Parameter( - name="name_example", - value="value_example", - ), - ], - id="pg_local_docker-demo", - name="postgres demo", - parameters=[ - Parameter( - name="name_example", - value="value_example", - ), - ], - password="*****", - permissions=[ - DeclarativeDataSourcePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="demo", - token="Bigquery service account JSON. Encode it using base64!", - type="POSTGRESQL", - url="jdbc:postgresql://postgres:5432/gooddata", - username="demo", - ), - ], - export_templates=[ - DeclarativeExportTemplate( - dashboard_slides_template=DashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} + api_instance = gooddata_api_client.OrganizationDeclarativeAPIsApi(api_client) + declarative_organization = gooddata_api_client.DeclarativeOrganization() # DeclarativeOrganization | -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - id="default-export-template", - name="My default export template", - widget_slides_template=WidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - ], - identity_providers=[ - DeclarativeIdentityProvider( - custom_claim_mapping={ - "key": "key_example", - }, - id="filterView-1", - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - ], - jwks=[ - DeclarativeJwk( - content=DeclarativeJwkSpecification(), - id="jwk-1", - ), - ], - notification_channels=[ - DeclarativeNotificationChannel( - allowed_recipients="INTERNAL", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="INTERNAL_ONLY", - description="This is a channel", - destination=DeclarativeNotificationChannelDestination(None), - id="notification-channel-1", - in_platform_notification="DISABLED", - name="channel", - notification_source="notification_source_example", - ), - ], - organization=DeclarativeOrganizationInfo( - allowed_origins=[ - "allowed_origins_example", - ], - color_palettes=[ - DeclarativeColorPalette( - content=JsonNode(), - id="id_example", - name="name_example", - ), - ], - csp_directives=[ - DeclarativeCspDirective( - directive="directive_example", - sources=[ - "sources_example", - ], - ), - ], - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - hostname="alpha.com", - id="Alpha corporation", - identity_provider=DeclarativeIdentityProviderIdentifier( - id="gooddata.com", - type="identityProvider", - ), - name="Alpha corporation", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - permissions=[ - DeclarativeOrganizationPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - themes=[ - DeclarativeTheme( - content=JsonNode(), - id="id_example", - name="name_example", - ), - ], - ), - user_groups=[ - DeclarativeUserGroup( - id="employees.all", - name="admins", - parents=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - permissions=[ - DeclarativeUserGroupPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - ), - ], - users=[ - DeclarativeUser( - auth_id="auth_id_example", - email="user@example.com", - firstname="John", - id="employee123", - lastname="Wick", - permissions=[ - DeclarativeUserPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - user_groups=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - ), - ], - workspace_data_filters=[ - DeclarativeWorkspaceDataFilter( - column_name="country_id", - description="ID of country", - id="country_id", - title="Country ID", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - workspace_data_filter_settings=[ - DeclarativeWorkspaceDataFilterSetting( - description="ID of country setting", - filter_values=["US"], - id="country_id_setting", - title="Country ID setting", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - ), - ], - ), - ], - workspaces=[ - DeclarativeWorkspace( - automations=[ - DeclarativeAutomation( - alert=AutomationAlert( - condition=AutomationAlertCondition(None), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - dashboard_tabular_exports=[ - AutomationDashboardTabularExport( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={ - "key": "key_example", - }, - evaluation_mode="PER_RECIPIENT", - export_definitions=[ - DeclarativeExportDefinitionIdentifier( - id="export123", - type="exportDefinition", - ), - ], - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - id="/6bUUGjjNSwg0_bs", - image_exports=[ - AutomationImageExport( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=AutomationMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - notification_channel=DeclarativeNotificationChannelIdentifier( - id="webhook123", - type="notificationChannel", - ), - raw_exports=[ - AutomationRawExport( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - recipients=[ - DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ], - schedule=AutomationSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - AutomationSlidesExport( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - AutomationTabularExport( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - visual_exports=[ - AutomationVisualExport( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - ], - cache_extra_limit=1, - custom_application_settings=[ - DeclarativeCustomApplicationSetting( - application_name="Modeler", - content=JsonNode(), - id="modeler.demo", - ), - ], - data_source=WorkspaceDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - filter_views=[ - DeclarativeFilterView( - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - content=JsonNode(), - description="description_example", - id="filterView-1", - is_default=True, - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ), - ], - hierarchy_permissions=[ - DeclarativeWorkspaceHierarchyPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - id="alpha.sales", - model=DeclarativeWorkspaceModel( - analytics=DeclarativeAnalyticsLayer( - analytical_dashboard_extensions=[ - DeclarativeAnalyticalDashboardExtension( - id="revenues-analysis", - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - ), - ], - analytical_dashboards=[ - DeclarativeAnalyticalDashboard( - content=JsonNode(), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Period to period comparison of revenues in main sectors.", - id="revenues-analysis", - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - tags=["Revenues"], - title="Revenues analysis", - ), - ], - attribute_hierarchies=[ - DeclarativeAttributeHierarchy( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - dashboard_plugins=[ - DeclarativeDashboardPlugin( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Three dimensional view of data.", - id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="3D map renderer", - ), - ], - export_definitions=[ - DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="export-definition-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), - tags=["Revenues"], - title="My regular export", - ), - ], - filter_contexts=[ - DeclarativeFilterContext( - content=JsonNode(), - description="Filter Context for Sales team.", - id="filter-sales", - tags=["Revenues"], - title="Filter Context for Sales team", - ), - ], - metrics=[ - DeclarativeMetric( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Sales for all the data available.", - id="total-sales", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Total sales", - ), - ], - visualization_objects=[ - DeclarativeVisualizationObject( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="visualization-1", - is_hidden=False, - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - ), - ldm=DeclarativeLdm( - dataset_extensions=[ - DeclarativeDatasetExtension( - id="customers", - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - datasets=[ - DeclarativeDataset( - aggregated_facts=[ - DeclarativeAggregatedFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - source_column="customer_order_count", - source_column_data_type="NUMERIC", - source_fact_reference=DeclarativeSourceFactReference( - operation="SUM", - reference=FactIdentifier( - id="fact_id", - type="fact", - ), - ), - tags=["Customers"], - ), - ], - attributes=[ - DeclarativeAttribute( - default_view=LabelIdentifier( - id="label_id", - type="label", - ), - description="Customer name including first and last name.", - id="attr.customers.customer_name", - is_hidden=False, - labels=[ - DeclarativeLabel( - description="Customer name", - id="label.customer_name", - is_hidden=False, - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer name", - value_type="TEXT", - ), - ], - sort_column="customer_name", - sort_direction="ASC" | "DESC", - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer Name", - ), - ], - data_source_table_id=DataSourceTableIdentifier( - data_source_id="my-postgres", - id="customers", - path=["table_schema","table_name"], - type="dataSource", - ), - description="The customers of ours.", - facts=[ - DeclarativeFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - is_hidden=False, - source_column="customer_order_count", - source_column_data_type="NUMERIC", - tags=["Customers"], - title="Customer order count", - ), - ], - grain=[ - GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ], - id="customers", - precedence=0, - references=[ - DeclarativeReference( - identifier=ReferenceIdentifier( - id="customers", - type="DATASET", - ), - multivalue=False, - source_column_data_types=[ - "INT", - ], - source_columns=["customer_id"], - sources=[ - DeclarativeReferenceSource( - column="customer_id", - data_type="STRING", - target=GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ), - ], - ), - ], - sql=DeclarativeDatasetSql( - data_source_id="my-postgres", - statement="SELECT * FROM some_table", - ), - tags=["Customers"], - title="Customers", - workspace_data_filter_columns=[ - DeclarativeWorkspaceDataFilterColumn( - data_type="INT", - name="customer_id", - ), - ], - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - date_instances=[ - DeclarativeDateDataset( - description="A customer order date", - granularities=[ - "MINUTE", - ], - granularities_formatting=GranularitiesFormatting( - title_base="title_base_example", - title_pattern="%titleBase - %granularityTitle", - ), - id="date", - tags=["Customer dates"], - title="Date", - ), - ], - ), - ), - name="Alpha Sales", - parent=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - permissions=[ - DeclarativeSingleWorkspacePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - prefix="/6bUUGjjNSwg0_bs", - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - user_data_filters=[ - DeclarativeUserDataFilter( - description="ID of country setting", - id="country_id_setting", - maql="{label/country} = "USA" AND {label/date.year} = THIS(YEAR)", - tags=["Revenues"], - title="Country ID setting", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - user_group=DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ), - ], - ), - ], - ) # DeclarativeOrganization | - - # example passing only required values which don't have defaults set try: # Set organization layout api_instance.set_organization_layout(declarative_organization) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationDeclarativeAPIsApi->set_organization_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_organization** | [**DeclarativeOrganization**](DeclarativeOrganization.md)| | + **declarative_organization** | [**DeclarativeOrganization**](DeclarativeOrganization.md)| | ### Return type @@ -1074,7 +134,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/OrganizationEntityAPIsApi.md b/gooddata-api-client/docs/OrganizationEntityAPIsApi.md index 7c68fe2b2..bd799176a 100644 --- a/gooddata-api-client/docs/OrganizationEntityAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationEntityAPIsApi.md @@ -25,12 +25,12 @@ Post Organization Setting entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -39,35 +39,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_entity_apis_api.OrganizationEntityAPIsApi(api_client) - json_api_organization_setting_in_document = JsonApiOrganizationSettingInDocument( - data=JsonApiOrganizationSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="organizationSetting", - ), - ) # JsonApiOrganizationSettingInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.OrganizationEntityAPIsApi(api_client) + json_api_organization_setting_in_document = gooddata_api_client.JsonApiOrganizationSettingInDocument() # JsonApiOrganizationSettingInDocument | + try: # Post Organization Setting entities api_response = api_instance.create_entity_organization_settings(json_api_organization_setting_in_document) + print("The response of OrganizationEntityAPIsApi->create_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationEntityAPIsApi->create_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | + **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | ### Return type @@ -82,7 +75,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -92,7 +84,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_organization_settings** -> delete_entity_organization_settings(id) +> delete_entity_organization_settings(id, filter=filter) Delete Organization entity @@ -100,10 +92,10 @@ Delete Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_entity_apis_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -112,35 +104,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_entity_apis_api.OrganizationEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Organization entity - api_instance.delete_entity_organization_settings(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationEntityAPIsApi->delete_entity_organization_settings: %s\n" % e) + api_instance = gooddata_api_client.OrganizationEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Organization entity api_instance.delete_entity_organization_settings(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationEntityAPIsApi->delete_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -155,7 +140,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -165,7 +149,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_organization_settings** -> JsonApiOrganizationSettingOutList get_all_entities_organization_settings() +> JsonApiOrganizationSettingOutList get_all_entities_organization_settings(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get Organization entities @@ -173,11 +157,11 @@ Get Organization entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -186,39 +170,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_entity_apis_api.OrganizationEntityAPIsApi(api_client) - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationEntityAPIsApi(api_client) + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Organization entities api_response = api_instance.get_all_entities_organization_settings(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationEntityAPIsApi->get_all_entities_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationEntityAPIsApi->get_all_entities_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -233,7 +214,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -243,7 +223,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_organization_settings** -> JsonApiOrganizationSettingOutDocument get_entity_organization_settings(id) +> JsonApiOrganizationSettingOutDocument get_entity_organization_settings(id, filter=filter) Get Organization entity @@ -251,11 +231,11 @@ Get Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -264,37 +244,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_entity_apis_api.OrganizationEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.OrganizationEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Organization entity - api_response = api_instance.get_entity_organization_settings(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationEntityAPIsApi->get_entity_organization_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Organization entity api_response = api_instance.get_entity_organization_settings(id, filter=filter) + print("The response of OrganizationEntityAPIsApi->get_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationEntityAPIsApi->get_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -309,7 +282,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -319,7 +291,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_organizations** -> JsonApiOrganizationOutDocument get_entity_organizations(id) +> JsonApiOrganizationOutDocument get_entity_organizations(id, filter=filter, include=include, meta_include=meta_include) Get Organizations @@ -327,11 +299,11 @@ Get Organizations ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -340,45 +312,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_entity_apis_api.OrganizationEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "bootstrapUser,bootstrapUserGroup,identityProvider", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Organizations - api_response = api_instance.get_entity_organizations(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationEntityAPIsApi->get_entity_organizations: %s\n" % e) + api_instance = gooddata_api_client.OrganizationEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['bootstrapUser,bootstrapUserGroup,identityProvider'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Organizations api_response = api_instance.get_entity_organizations(id, filter=filter, include=include, meta_include=meta_include) + print("The response of OrganizationEntityAPIsApi->get_entity_organizations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationEntityAPIsApi->get_entity_organizations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -393,7 +354,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -403,7 +363,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_organization** -> get_organization() +> get_organization(meta_include=meta_include) Get current organization info @@ -413,10 +373,10 @@ Gets a basic information about organization. ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_entity_apis_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -425,28 +385,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_entity_apis_api.OrganizationEntityAPIsApi(api_client) - meta_include = [ - "metaInclude=permissions", - ] # [str] | Return list of permissions available to logged user. (optional) + api_instance = gooddata_api_client.OrganizationEntityAPIsApi(api_client) + meta_include = ['metaInclude=permissions'] # List[str] | Return list of permissions available to logged user. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get current organization info api_instance.get_organization(meta_include=meta_include) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationEntityAPIsApi->get_organization: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **meta_include** | **[str]**| Return list of permissions available to logged user. | [optional] + **meta_include** | [**List[str]**](str.md)| Return list of permissions available to logged user. | [optional] ### Return type @@ -461,7 +419,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -471,7 +428,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_organization_settings** -> JsonApiOrganizationSettingOutDocument patch_entity_organization_settings(id, json_api_organization_setting_patch_document) +> JsonApiOrganizationSettingOutDocument patch_entity_organization_settings(id, json_api_organization_setting_patch_document, filter=filter) Patch Organization entity @@ -479,12 +436,12 @@ Patch Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -493,48 +450,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_entity_apis_api.OrganizationEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_setting_patch_document = JsonApiOrganizationSettingPatchDocument( - data=JsonApiOrganizationSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="organizationSetting", - ), - ) # JsonApiOrganizationSettingPatchDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Organization entity - api_response = api_instance.patch_entity_organization_settings(id, json_api_organization_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationEntityAPIsApi->patch_entity_organization_settings: %s\n" % e) + api_instance = gooddata_api_client.OrganizationEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_organization_setting_patch_document = gooddata_api_client.JsonApiOrganizationSettingPatchDocument() # JsonApiOrganizationSettingPatchDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Organization entity api_response = api_instance.patch_entity_organization_settings(id, json_api_organization_setting_patch_document, filter=filter) + print("The response of OrganizationEntityAPIsApi->patch_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationEntityAPIsApi->patch_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_setting_patch_document** | [**JsonApiOrganizationSettingPatchDocument**](JsonApiOrganizationSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_organization_setting_patch_document** | [**JsonApiOrganizationSettingPatchDocument**](JsonApiOrganizationSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -549,7 +490,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -559,7 +499,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_organizations** -> JsonApiOrganizationOutDocument patch_entity_organizations(id, json_api_organization_patch_document) +> JsonApiOrganizationOutDocument patch_entity_organizations(id, json_api_organization_patch_document, filter=filter, include=include) Patch Organization @@ -567,12 +507,12 @@ Patch Organization ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -581,75 +521,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_entity_apis_api.OrganizationEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_patch_document = JsonApiOrganizationPatchDocument( - data=JsonApiOrganizationPatch( - attributes=JsonApiOrganizationInAttributes( - allowed_origins=[ - "allowed_origins_example", - ], - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - hostname="hostname_example", - name="name_example", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - ), - id="id1", - relationships=JsonApiOrganizationInRelationships( - identity_provider=JsonApiOrganizationInRelationshipsIdentityProvider( - data=JsonApiIdentityProviderToOneLinkage(None), - ), - ), - type="organization", - ), - ) # JsonApiOrganizationPatchDocument | - filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "bootstrapUser,bootstrapUserGroup,identityProvider", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Organization - api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationEntityAPIsApi->patch_entity_organizations: %s\n" % e) + api_instance = gooddata_api_client.OrganizationEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_organization_patch_document = gooddata_api_client.JsonApiOrganizationPatchDocument() # JsonApiOrganizationPatchDocument | + filter = 'name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['bootstrapUser,bootstrapUserGroup,identityProvider'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Organization api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document, filter=filter, include=include) + print("The response of OrganizationEntityAPIsApi->patch_entity_organizations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationEntityAPIsApi->patch_entity_organizations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_patch_document** | [**JsonApiOrganizationPatchDocument**](JsonApiOrganizationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_organization_patch_document** | [**JsonApiOrganizationPatchDocument**](JsonApiOrganizationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -664,7 +563,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -674,7 +572,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_organization_settings** -> JsonApiOrganizationSettingOutDocument update_entity_organization_settings(id, json_api_organization_setting_in_document) +> JsonApiOrganizationSettingOutDocument update_entity_organization_settings(id, json_api_organization_setting_in_document, filter=filter) Put Organization entity @@ -682,12 +580,12 @@ Put Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -696,48 +594,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_entity_apis_api.OrganizationEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_setting_in_document = JsonApiOrganizationSettingInDocument( - data=JsonApiOrganizationSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="organizationSetting", - ), - ) # JsonApiOrganizationSettingInDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Organization entity - api_response = api_instance.update_entity_organization_settings(id, json_api_organization_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationEntityAPIsApi->update_entity_organization_settings: %s\n" % e) + api_instance = gooddata_api_client.OrganizationEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_organization_setting_in_document = gooddata_api_client.JsonApiOrganizationSettingInDocument() # JsonApiOrganizationSettingInDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Organization entity api_response = api_instance.update_entity_organization_settings(id, json_api_organization_setting_in_document, filter=filter) + print("The response of OrganizationEntityAPIsApi->update_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationEntityAPIsApi->update_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -752,7 +634,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -762,7 +643,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_organizations** -> JsonApiOrganizationOutDocument update_entity_organizations(id, json_api_organization_in_document) +> JsonApiOrganizationOutDocument update_entity_organizations(id, json_api_organization_in_document, filter=filter, include=include) Put Organization @@ -770,12 +651,12 @@ Put Organization ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -784,75 +665,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_entity_apis_api.OrganizationEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_in_document = JsonApiOrganizationInDocument( - data=JsonApiOrganizationIn( - attributes=JsonApiOrganizationInAttributes( - allowed_origins=[ - "allowed_origins_example", - ], - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - hostname="hostname_example", - name="name_example", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - ), - id="id1", - relationships=JsonApiOrganizationInRelationships( - identity_provider=JsonApiOrganizationInRelationshipsIdentityProvider( - data=JsonApiIdentityProviderToOneLinkage(None), - ), - ), - type="organization", - ), - ) # JsonApiOrganizationInDocument | - filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "bootstrapUser,bootstrapUserGroup,identityProvider", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Organization - api_response = api_instance.update_entity_organizations(id, json_api_organization_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationEntityAPIsApi->update_entity_organizations: %s\n" % e) + api_instance = gooddata_api_client.OrganizationEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_organization_in_document = gooddata_api_client.JsonApiOrganizationInDocument() # JsonApiOrganizationInDocument | + filter = 'name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['bootstrapUser,bootstrapUserGroup,identityProvider'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Organization api_response = api_instance.update_entity_organizations(id, json_api_organization_in_document, filter=filter, include=include) + print("The response of OrganizationEntityAPIsApi->update_entity_organizations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationEntityAPIsApi->update_entity_organizations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_in_document** | [**JsonApiOrganizationInDocument**](JsonApiOrganizationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_organization_in_document** | [**JsonApiOrganizationInDocument**](JsonApiOrganizationInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -867,7 +707,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/OrganizationModelControllerApi.md b/gooddata-api-client/docs/OrganizationModelControllerApi.md index 4454b93fd..12e59b6c6 100644 --- a/gooddata-api-client/docs/OrganizationModelControllerApi.md +++ b/gooddata-api-client/docs/OrganizationModelControllerApi.md @@ -101,12 +101,12 @@ Post Color Pallettes ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -115,35 +115,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_color_palette_in_document = JsonApiColorPaletteInDocument( - data=JsonApiColorPaletteIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="colorPalette", - ), - ) # JsonApiColorPaletteInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_color_palette_in_document = gooddata_api_client.JsonApiColorPaletteInDocument() # JsonApiColorPaletteInDocument | + try: # Post Color Pallettes api_response = api_instance.create_entity_color_palettes(json_api_color_palette_in_document) + print("The response of OrganizationModelControllerApi->create_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | + **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | ### Return type @@ -158,7 +151,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -178,12 +170,12 @@ Post CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -192,36 +184,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_csp_directive_in_document = JsonApiCspDirectiveInDocument( - data=JsonApiCspDirectiveIn( - attributes=JsonApiCspDirectiveInAttributes( - sources=[ - "sources_example", - ], - ), - id="id1", - type="cspDirective", - ), - ) # JsonApiCspDirectiveInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_csp_directive_in_document = gooddata_api_client.JsonApiCspDirectiveInDocument() # JsonApiCspDirectiveInDocument | + try: # Post CSP Directives api_response = api_instance.create_entity_csp_directives(json_api_csp_directive_in_document) + print("The response of OrganizationModelControllerApi->create_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | + **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | ### Return type @@ -236,7 +220,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -246,7 +229,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_data_sources** -> JsonApiDataSourceOutDocument create_entity_data_sources(json_api_data_source_in_document) +> JsonApiDataSourceOutDocument create_entity_data_sources(json_api_data_source_in_document, meta_include=meta_include) Post Data Sources @@ -256,12 +239,12 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -270,64 +253,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_data_source_in_document = JsonApiDataSourceInDocument( - data=JsonApiDataSourceIn( - attributes=JsonApiDataSourceInAttributes( - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourceInDocument | - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Data Sources - api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->create_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_data_source_in_document = gooddata_api_client.JsonApiDataSourceInDocument() # JsonApiDataSourceInDocument | + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Data Sources api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->create_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] + **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -342,7 +291,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -360,12 +308,12 @@ Post Export Template entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -374,101 +322,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_export_template_post_optional_id_document = JsonApiExportTemplatePostOptionalIdDocument( - data=JsonApiExportTemplatePostOptionalId( - attributes=JsonApiExportTemplateInAttributes( - dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - name="name_example", - widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - id="id1", - type="exportTemplate", - ), - ) # JsonApiExportTemplatePostOptionalIdDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_export_template_post_optional_id_document = gooddata_api_client.JsonApiExportTemplatePostOptionalIdDocument() # JsonApiExportTemplatePostOptionalIdDocument | + try: # Post Export Template entities api_response = api_instance.create_entity_export_templates(json_api_export_template_post_optional_id_document) + print("The response of OrganizationModelControllerApi->create_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_export_template_post_optional_id_document** | [**JsonApiExportTemplatePostOptionalIdDocument**](JsonApiExportTemplatePostOptionalIdDocument.md)| | + **json_api_export_template_post_optional_id_document** | [**JsonApiExportTemplatePostOptionalIdDocument**](JsonApiExportTemplatePostOptionalIdDocument.md)| | ### Return type @@ -483,7 +358,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -501,12 +375,12 @@ Post Identity Providers ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -515,50 +389,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_identity_provider_in_document = JsonApiIdentityProviderInDocument( - data=JsonApiIdentityProviderIn( - attributes=JsonApiIdentityProviderInAttributes( - custom_claim_mapping={ - "key": "key_example", - }, - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - id="id1", - type="identityProvider", - ), - ) # JsonApiIdentityProviderInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_identity_provider_in_document = gooddata_api_client.JsonApiIdentityProviderInDocument() # JsonApiIdentityProviderInDocument | + try: # Post Identity Providers api_response = api_instance.create_entity_identity_providers(json_api_identity_provider_in_document) + print("The response of OrganizationModelControllerApi->create_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | + **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | ### Return type @@ -573,7 +425,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -593,12 +444,12 @@ Creates JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -607,34 +458,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_jwk_in_document = JsonApiJwkInDocument( - data=JsonApiJwkIn( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), - ), - id="id1", - type="jwk", - ), - ) # JsonApiJwkInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_jwk_in_document = gooddata_api_client.JsonApiJwkInDocument() # JsonApiJwkInDocument | + try: # Post Jwks api_response = api_instance.create_entity_jwks(json_api_jwk_in_document) + print("The response of OrganizationModelControllerApi->create_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | + **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | ### Return type @@ -649,7 +494,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -667,12 +511,12 @@ Post LLM endpoint entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -681,39 +525,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_llm_endpoint_in_document = JsonApiLlmEndpointInDocument( - data=JsonApiLlmEndpointIn( - attributes=JsonApiLlmEndpointInAttributes( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="OPENAI", - title="title_example", - token="token_example", - ), - id="id1", - type="llmEndpoint", - ), - ) # JsonApiLlmEndpointInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_llm_endpoint_in_document = gooddata_api_client.JsonApiLlmEndpointInDocument() # JsonApiLlmEndpointInDocument | + try: # Post LLM endpoint entities api_response = api_instance.create_entity_llm_endpoints(json_api_llm_endpoint_in_document) + print("The response of OrganizationModelControllerApi->create_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | + **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | ### Return type @@ -728,7 +561,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -746,12 +578,12 @@ Post Notification Channel entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument -from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -760,41 +592,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_notification_channel_post_optional_id_document = JsonApiNotificationChannelPostOptionalIdDocument( - data=JsonApiNotificationChannelPostOptionalId( - attributes=JsonApiNotificationChannelInAttributes( - allowed_recipients="CREATOR", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="HIDDEN", - description="description_example", - destination=JsonApiNotificationChannelInAttributesDestination(None), - in_platform_notification="DISABLED", - name="name_example", - notification_source="notification_source_example", - ), - id="id1", - type="notificationChannel", - ), - ) # JsonApiNotificationChannelPostOptionalIdDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_notification_channel_post_optional_id_document = gooddata_api_client.JsonApiNotificationChannelPostOptionalIdDocument() # JsonApiNotificationChannelPostOptionalIdDocument | + try: # Post Notification Channel entities api_response = api_instance.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document) + print("The response of OrganizationModelControllerApi->create_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_notification_channel_post_optional_id_document** | [**JsonApiNotificationChannelPostOptionalIdDocument**](JsonApiNotificationChannelPostOptionalIdDocument.md)| | + **json_api_notification_channel_post_optional_id_document** | [**JsonApiNotificationChannelPostOptionalIdDocument**](JsonApiNotificationChannelPostOptionalIdDocument.md)| | ### Return type @@ -809,7 +628,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -827,12 +645,12 @@ Post Organization Setting entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -841,35 +659,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_organization_setting_in_document = JsonApiOrganizationSettingInDocument( - data=JsonApiOrganizationSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="organizationSetting", - ), - ) # JsonApiOrganizationSettingInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_organization_setting_in_document = gooddata_api_client.JsonApiOrganizationSettingInDocument() # JsonApiOrganizationSettingInDocument | + try: # Post Organization Setting entities api_response = api_instance.create_entity_organization_settings(json_api_organization_setting_in_document) + print("The response of OrganizationModelControllerApi->create_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | + **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | ### Return type @@ -884,7 +695,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -902,12 +712,12 @@ Post Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -916,35 +726,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_theme_in_document = JsonApiThemeInDocument( - data=JsonApiThemeIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="theme", - ), - ) # JsonApiThemeInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_theme_in_document = gooddata_api_client.JsonApiThemeInDocument() # JsonApiThemeInDocument | + try: # Post Theming api_response = api_instance.create_entity_themes(json_api_theme_in_document) + print("The response of OrganizationModelControllerApi->create_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | + **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | ### Return type @@ -959,7 +762,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -969,7 +771,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_user_groups** -> JsonApiUserGroupOutDocument create_entity_user_groups(json_api_user_group_in_document) +> JsonApiUserGroupOutDocument create_entity_user_groups(json_api_user_group_in_document, include=include) Post User Group entities @@ -979,12 +781,12 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -993,57 +795,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_user_group_in_document = JsonApiUserGroupInDocument( - data=JsonApiUserGroupIn( - attributes=JsonApiUserGroupInAttributes( - name="name_example", - ), - id="id1", - relationships=JsonApiUserGroupInRelationships( - parents=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="userGroup", - ), - ) # JsonApiUserGroupInDocument | - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Post User Group entities - api_response = api_instance.create_entity_user_groups(json_api_user_group_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->create_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_user_group_in_document = gooddata_api_client.JsonApiUserGroupInDocument() # JsonApiUserGroupInDocument | + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post User Group entities api_response = api_instance.create_entity_user_groups(json_api_user_group_in_document, include=include) + print("The response of OrganizationModelControllerApi->create_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -1058,7 +833,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1068,7 +842,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_users** -> JsonApiUserOutDocument create_entity_users(json_api_user_in_document) +> JsonApiUserOutDocument create_entity_users(json_api_user_in_document, include=include) Post User entities @@ -1078,12 +852,12 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1092,60 +866,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_user_in_document = JsonApiUserInDocument( - data=JsonApiUserIn( - attributes=JsonApiUserInAttributes( - authentication_id="authentication_id_example", - email="email_example", - firstname="firstname_example", - lastname="lastname_example", - ), - id="id1", - relationships=JsonApiUserInRelationships( - user_groups=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="user", - ), - ) # JsonApiUserInDocument | - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Post User entities - api_response = api_instance.create_entity_users(json_api_user_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->create_entity_users: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_user_in_document = gooddata_api_client.JsonApiUserInDocument() # JsonApiUserInDocument | + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post User entities api_response = api_instance.create_entity_users(json_api_user_in_document, include=include) + print("The response of OrganizationModelControllerApi->create_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -1160,7 +904,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1170,7 +913,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_workspaces** -> JsonApiWorkspaceOutDocument create_entity_workspaces(json_api_workspace_in_document) +> JsonApiWorkspaceOutDocument create_entity_workspaces(json_api_workspace_in_document, include=include, meta_include=meta_include) Post Workspace entities @@ -1180,12 +923,12 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1194,69 +937,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_workspace_in_document = JsonApiWorkspaceInDocument( - data=JsonApiWorkspaceIn( - attributes=JsonApiWorkspaceInAttributes( - cache_extra_limit=1, - data_source=JsonApiWorkspaceInAttributesDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - name="name_example", - prefix="/6bUUGjjNSwg0_bs", - ), - id="id1", - relationships=JsonApiWorkspaceInRelationships( - parent=JsonApiWorkspaceAutomationOutRelationshipsWorkspace( - data=JsonApiWorkspaceToOneLinkage(None), - ), - ), - type="workspace", - ), - ) # JsonApiWorkspaceInDocument | - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Workspace entities - api_response = api_instance.create_entity_workspaces(json_api_workspace_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->create_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + json_api_workspace_in_document = gooddata_api_client.JsonApiWorkspaceInDocument() # JsonApiWorkspaceInDocument | + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=config,permissions,hierarchy,dataModelDatasets,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Workspace entities api_response = api_instance.create_entity_workspaces(json_api_workspace_in_document, include=include, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->create_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->create_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1271,7 +977,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1281,7 +986,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_color_palettes** -> delete_entity_color_palettes(id) +> delete_entity_color_palettes(id, filter=filter) Delete a Color Pallette @@ -1289,10 +994,10 @@ Delete a Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1301,35 +1006,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Color Pallette - api_instance.delete_entity_color_palettes(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_color_palettes: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Color Pallette api_instance.delete_entity_color_palettes(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1344,7 +1042,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1354,7 +1051,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_csp_directives** -> delete_entity_csp_directives(id) +> delete_entity_csp_directives(id, filter=filter) Delete CSP Directives @@ -1364,10 +1061,10 @@ Delete CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1376,35 +1073,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete CSP Directives - api_instance.delete_entity_csp_directives(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_csp_directives: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete CSP Directives api_instance.delete_entity_csp_directives(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1419,7 +1109,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1429,7 +1118,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_data_sources** -> delete_entity_data_sources(id) +> delete_entity_data_sources(id, filter=filter) Delete Data Source entity @@ -1439,10 +1128,10 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1451,35 +1140,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Data Source entity - api_instance.delete_entity_data_sources(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Data Source entity api_instance.delete_entity_data_sources(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1494,7 +1176,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1504,7 +1185,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_export_templates** -> delete_entity_export_templates(id) +> delete_entity_export_templates(id, filter=filter) Delete Export Template entity @@ -1512,10 +1193,10 @@ Delete Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1524,35 +1205,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Export Template entity - api_instance.delete_entity_export_templates(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_export_templates: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Export Template entity api_instance.delete_entity_export_templates(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1567,7 +1241,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1577,7 +1250,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_identity_providers** -> delete_entity_identity_providers(id) +> delete_entity_identity_providers(id, filter=filter) Delete Identity Provider @@ -1585,10 +1258,10 @@ Delete Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1597,35 +1270,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Identity Provider - api_instance.delete_entity_identity_providers(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_identity_providers: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Identity Provider api_instance.delete_entity_identity_providers(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1640,7 +1306,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1650,7 +1315,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_jwks** -> delete_entity_jwks(id) +> delete_entity_jwks(id, filter=filter) Delete Jwk @@ -1660,10 +1325,10 @@ Deletes JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1672,35 +1337,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Jwk - api_instance.delete_entity_jwks(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_jwks: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Jwk api_instance.delete_entity_jwks(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1715,7 +1373,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1725,7 +1382,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_llm_endpoints** -> delete_entity_llm_endpoints(id) +> delete_entity_llm_endpoints(id, filter=filter) @@ -1733,10 +1390,10 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1745,33 +1402,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - api_instance.delete_entity_llm_endpoints(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_endpoints: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: api_instance.delete_entity_llm_endpoints(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1786,7 +1437,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1796,7 +1446,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_notification_channels** -> delete_entity_notification_channels(id) +> delete_entity_notification_channels(id, filter=filter) Delete Notification Channel entity @@ -1804,10 +1454,10 @@ Delete Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1816,35 +1466,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Notification Channel entity - api_instance.delete_entity_notification_channels(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_notification_channels: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Notification Channel entity api_instance.delete_entity_notification_channels(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1859,7 +1502,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1869,7 +1511,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_organization_settings** -> delete_entity_organization_settings(id) +> delete_entity_organization_settings(id, filter=filter) Delete Organization entity @@ -1877,10 +1519,10 @@ Delete Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1889,35 +1531,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Organization entity - api_instance.delete_entity_organization_settings(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_organization_settings: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Organization entity api_instance.delete_entity_organization_settings(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1932,7 +1567,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1942,7 +1576,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_themes** -> delete_entity_themes(id) +> delete_entity_themes(id, filter=filter) Delete Theming @@ -1950,10 +1584,10 @@ Delete Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1962,35 +1596,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Theming - api_instance.delete_entity_themes(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_themes: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Theming api_instance.delete_entity_themes(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2005,7 +1632,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2015,7 +1641,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_user_groups** -> delete_entity_user_groups(id) +> delete_entity_user_groups(id, filter=filter) Delete UserGroup entity @@ -2025,10 +1651,10 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2037,35 +1663,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete UserGroup entity - api_instance.delete_entity_user_groups(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete UserGroup entity api_instance.delete_entity_user_groups(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2080,7 +1699,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2090,7 +1708,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_users** -> delete_entity_users(id) +> delete_entity_users(id, filter=filter) Delete User entity @@ -2100,10 +1718,10 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2112,35 +1730,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete User entity - api_instance.delete_entity_users(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_users: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete User entity api_instance.delete_entity_users(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2155,7 +1766,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2165,7 +1775,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspaces** -> delete_entity_workspaces(id) +> delete_entity_workspaces(id, filter=filter) Delete Workspace entity @@ -2175,10 +1785,10 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2187,35 +1797,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Workspace entity - api_instance.delete_entity_workspaces(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete Workspace entity api_instance.delete_entity_workspaces(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->delete_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2230,7 +1833,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2240,7 +1842,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_color_palettes** -> JsonApiColorPaletteOutList get_all_entities_color_palettes() +> JsonApiColorPaletteOutList get_all_entities_color_palettes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Color Pallettes @@ -2248,11 +1850,11 @@ Get all Color Pallettes ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2261,39 +1863,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Color Pallettes api_response = api_instance.get_all_entities_color_palettes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2308,7 +1907,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2318,7 +1916,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_csp_directives** -> JsonApiCspDirectiveOutList get_all_entities_csp_directives() +> JsonApiCspDirectiveOutList get_all_entities_csp_directives(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get CSP Directives @@ -2328,11 +1926,11 @@ Get CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2341,39 +1939,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get CSP Directives api_response = api_instance.get_all_entities_csp_directives(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2388,7 +1983,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2398,7 +1992,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_data_source_identifiers** -> JsonApiDataSourceIdentifierOutList get_all_entities_data_source_identifiers() +> JsonApiDataSourceIdentifierOutList get_all_entities_data_source_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Data Source Identifiers @@ -2406,11 +2000,11 @@ Get all Data Source Identifiers ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2419,39 +2013,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString;schema==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=permissions,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'name==someString;schema==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=permissions,page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Data Source Identifiers api_response = api_instance.get_all_entities_data_source_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_data_source_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_data_source_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2466,7 +2057,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2476,7 +2066,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_data_sources** -> JsonApiDataSourceOutList get_all_entities_data_sources() +> JsonApiDataSourceOutList get_all_entities_data_sources(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get Data Source entities @@ -2486,11 +2076,11 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2499,39 +2089,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=permissions,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=permissions,page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Data Source entities api_response = api_instance.get_all_entities_data_sources(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2546,7 +2133,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2556,7 +2142,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_entitlements** -> JsonApiEntitlementOutList get_all_entities_entitlements() +> JsonApiEntitlementOutList get_all_entities_entitlements(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get Entitlements @@ -2566,11 +2152,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2579,39 +2165,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'value==someString;expiry==LocalDateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Entitlements api_response = api_instance.get_all_entities_entitlements(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_entitlements:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_entitlements: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2626,7 +2209,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2636,7 +2218,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_export_templates** -> JsonApiExportTemplateOutList get_all_entities_export_templates() +> JsonApiExportTemplateOutList get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) GET all Export Template entities @@ -2644,11 +2226,11 @@ GET all Export Template entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.models.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2657,39 +2239,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # GET all Export Template entities api_response = api_instance.get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2704,7 +2283,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2714,7 +2292,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_identity_providers** -> JsonApiIdentityProviderOutList get_all_entities_identity_providers() +> JsonApiIdentityProviderOutList get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Identity Providers @@ -2722,11 +2300,11 @@ Get all Identity Providers ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.models.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2735,39 +2313,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Identity Providers api_response = api_instance.get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2782,7 +2357,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2792,7 +2366,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_jwks** -> JsonApiJwkOutList get_all_entities_jwks() +> JsonApiJwkOutList get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Jwks @@ -2802,11 +2376,11 @@ Returns all JSON web keys - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.models.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2815,39 +2389,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Jwks api_response = api_instance.get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2862,7 +2433,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2872,7 +2442,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_llm_endpoints** -> JsonApiLlmEndpointOutList get_all_entities_llm_endpoints() +> JsonApiLlmEndpointOutList get_all_entities_llm_endpoints(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all LLM endpoint entities @@ -2880,11 +2450,11 @@ Get all LLM endpoint entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from gooddata_api_client.models.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2893,39 +2463,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all LLM endpoint entities api_response = api_instance.get_all_entities_llm_endpoints(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2940,7 +2507,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2950,7 +2516,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_notification_channel_identifiers** -> JsonApiNotificationChannelIdentifierOutList get_all_entities_notification_channel_identifiers() +> JsonApiNotificationChannelIdentifierOutList get_all_entities_notification_channel_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) @@ -2958,11 +2524,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.models.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2971,38 +2537,35 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: api_response = api_instance.get_all_entities_notification_channel_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_notification_channel_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_notification_channel_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3017,7 +2580,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3027,7 +2589,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_notification_channels** -> JsonApiNotificationChannelOutList get_all_entities_notification_channels() +> JsonApiNotificationChannelOutList get_all_entities_notification_channels(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Notification Channel entities @@ -3035,11 +2597,11 @@ Get all Notification Channel entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.models.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3048,39 +2610,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Notification Channel entities api_response = api_instance.get_all_entities_notification_channels(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3095,7 +2654,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3105,7 +2663,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_organization_settings** -> JsonApiOrganizationSettingOutList get_all_entities_organization_settings() +> JsonApiOrganizationSettingOutList get_all_entities_organization_settings(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get Organization entities @@ -3113,11 +2671,11 @@ Get Organization entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3126,39 +2684,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Organization entities api_response = api_instance.get_all_entities_organization_settings(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3173,7 +2728,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3183,7 +2737,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_themes** -> JsonApiThemeOutList get_all_entities_themes() +> JsonApiThemeOutList get_all_entities_themes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get all Theming entities @@ -3191,11 +2745,11 @@ Get all Theming entities ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3204,39 +2758,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get all Theming entities api_response = api_instance.get_all_entities_themes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3251,7 +2802,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3261,7 +2811,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_user_groups** -> JsonApiUserGroupOutList get_all_entities_user_groups() +> JsonApiUserGroupOutList get_all_entities_user_groups(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get UserGroup entities @@ -3271,11 +2821,11 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3284,43 +2834,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get UserGroup entities api_response = api_instance.get_all_entities_user_groups(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3335,7 +2880,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3345,7 +2889,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_user_identifiers** -> JsonApiUserIdentifierOutList get_all_entities_user_identifiers() +> JsonApiUserIdentifierOutList get_all_entities_user_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get UserIdentifier entities @@ -3355,11 +2899,11 @@ UserIdentifier - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.models.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3368,39 +2912,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "firstname==someString;lastname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'firstname==someString;lastname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get UserIdentifier entities api_response = api_instance.get_all_entities_user_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_user_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_user_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3415,7 +2956,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3425,7 +2965,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_users** -> JsonApiUserOutList get_all_entities_users() +> JsonApiUserOutList get_all_entities_users(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get User entities @@ -3435,11 +2975,11 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3448,43 +2988,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get User entities api_response = api_instance.get_all_entities_users(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3499,7 +3034,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3509,7 +3043,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspaces** -> JsonApiWorkspaceOutList get_all_entities_workspaces() +> JsonApiWorkspaceOutList get_all_entities_workspaces(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get Workspace entities @@ -3519,11 +3053,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3532,43 +3066,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Workspace entities api_response = api_instance.get_all_entities_workspaces(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_all_entities_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_all_entities_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3583,7 +3112,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3593,7 +3121,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_color_palettes** -> JsonApiColorPaletteOutDocument get_entity_color_palettes(id) +> JsonApiColorPaletteOutDocument get_entity_color_palettes(id, filter=filter) Get Color Pallette @@ -3601,11 +3129,11 @@ Get Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3614,37 +3142,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Color Pallette - api_response = api_instance.get_entity_color_palettes(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_color_palettes: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Color Pallette api_response = api_instance.get_entity_color_palettes(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3659,7 +3180,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3669,7 +3189,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_csp_directives** -> JsonApiCspDirectiveOutDocument get_entity_csp_directives(id) +> JsonApiCspDirectiveOutDocument get_entity_csp_directives(id, filter=filter) Get CSP Directives @@ -3679,11 +3199,11 @@ Get CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3692,37 +3212,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get CSP Directives - api_response = api_instance.get_entity_csp_directives(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_csp_directives: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get CSP Directives api_response = api_instance.get_entity_csp_directives(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3737,7 +3250,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3747,7 +3259,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_data_source_identifiers** -> JsonApiDataSourceIdentifierOutDocument get_entity_data_source_identifiers(id) +> JsonApiDataSourceIdentifierOutDocument get_entity_data_source_identifiers(id, filter=filter, meta_include=meta_include) Get Data Source Identifier @@ -3755,11 +3267,11 @@ Get Data Source Identifier ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3768,41 +3280,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;schema==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Data Source Identifier - api_response = api_instance.get_entity_data_source_identifiers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_data_source_identifiers: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;schema==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Data Source Identifier api_response = api_instance.get_entity_data_source_identifiers(id, filter=filter, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_entity_data_source_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_data_source_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3817,7 +3320,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3827,7 +3329,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_data_sources** -> JsonApiDataSourceOutDocument get_entity_data_sources(id) +> JsonApiDataSourceOutDocument get_entity_data_sources(id, filter=filter, meta_include=meta_include) Get Data Source entity @@ -3837,11 +3339,11 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3850,41 +3352,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Data Source entity - api_response = api_instance.get_entity_data_sources(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + meta_include = ['metaInclude=permissions,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Data Source entity api_response = api_instance.get_entity_data_sources(id, filter=filter, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3899,7 +3392,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3909,7 +3401,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_entitlements** -> JsonApiEntitlementOutDocument get_entity_entitlements(id) +> JsonApiEntitlementOutDocument get_entity_entitlements(id, filter=filter) Get Entitlement @@ -3919,11 +3411,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3932,37 +3424,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'value==someString;expiry==LocalDateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Entitlement - api_response = api_instance.get_entity_entitlements(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_entitlements: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Entitlement api_response = api_instance.get_entity_entitlements(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_entitlements:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_entitlements: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -3977,7 +3462,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3987,7 +3471,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_export_templates** -> JsonApiExportTemplateOutDocument get_entity_export_templates(id) +> JsonApiExportTemplateOutDocument get_entity_export_templates(id, filter=filter) GET Export Template entity @@ -3995,11 +3479,11 @@ GET Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4008,37 +3492,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # GET Export Template entity - api_response = api_instance.get_entity_export_templates(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_export_templates: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # GET Export Template entity api_response = api_instance.get_entity_export_templates(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4053,7 +3530,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4063,7 +3539,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_identity_providers** -> JsonApiIdentityProviderOutDocument get_entity_identity_providers(id) +> JsonApiIdentityProviderOutDocument get_entity_identity_providers(id, filter=filter) Get Identity Provider @@ -4071,11 +3547,11 @@ Get Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4084,37 +3560,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Identity Provider - api_response = api_instance.get_entity_identity_providers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_identity_providers: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Identity Provider api_response = api_instance.get_entity_identity_providers(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4129,7 +3598,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4139,7 +3607,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_jwks** -> JsonApiJwkOutDocument get_entity_jwks(id) +> JsonApiJwkOutDocument get_entity_jwks(id, filter=filter) Get Jwk @@ -4149,11 +3617,11 @@ Returns JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4162,37 +3630,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Jwk - api_response = api_instance.get_entity_jwks(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_jwks: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Jwk api_response = api_instance.get_entity_jwks(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4207,7 +3668,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4217,7 +3677,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_llm_endpoints** -> JsonApiLlmEndpointOutDocument get_entity_llm_endpoints(id) +> JsonApiLlmEndpointOutDocument get_entity_llm_endpoints(id, filter=filter) Get LLM endpoint entity @@ -4225,11 +3685,11 @@ Get LLM endpoint entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4238,37 +3698,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get LLM endpoint entity - api_response = api_instance.get_entity_llm_endpoints(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_llm_endpoints: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get LLM endpoint entity api_response = api_instance.get_entity_llm_endpoints(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4283,7 +3736,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4293,7 +3745,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_notification_channel_identifiers** -> JsonApiNotificationChannelIdentifierOutDocument get_entity_notification_channel_identifiers(id) +> JsonApiNotificationChannelIdentifierOutDocument get_entity_notification_channel_identifiers(id, filter=filter) @@ -4301,11 +3753,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4314,35 +3766,29 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_entity_notification_channel_identifiers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_notification_channel_identifiers: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: api_response = api_instance.get_entity_notification_channel_identifiers(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_notification_channel_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_notification_channel_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4357,7 +3803,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4367,7 +3812,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_notification_channels** -> JsonApiNotificationChannelOutDocument get_entity_notification_channels(id) +> JsonApiNotificationChannelOutDocument get_entity_notification_channels(id, filter=filter) Get Notification Channel entity @@ -4375,11 +3820,11 @@ Get Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4388,37 +3833,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Notification Channel entity - api_response = api_instance.get_entity_notification_channels(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_notification_channels: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Notification Channel entity api_response = api_instance.get_entity_notification_channels(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4433,7 +3871,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4443,7 +3880,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_organization_settings** -> JsonApiOrganizationSettingOutDocument get_entity_organization_settings(id) +> JsonApiOrganizationSettingOutDocument get_entity_organization_settings(id, filter=filter) Get Organization entity @@ -4451,11 +3888,11 @@ Get Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4464,37 +3901,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get Organization entity - api_response = api_instance.get_entity_organization_settings(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_organization_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get Organization entity api_response = api_instance.get_entity_organization_settings(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4509,7 +3939,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4519,7 +3948,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_themes** -> JsonApiThemeOutDocument get_entity_themes(id) +> JsonApiThemeOutDocument get_entity_themes(id, filter=filter) Get Theming @@ -4527,11 +3956,11 @@ Get Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4540,37 +3969,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get Theming - api_response = api_instance.get_entity_themes(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_themes: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Theming api_response = api_instance.get_entity_themes(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4585,7 +4007,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4595,7 +4016,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_groups** -> JsonApiUserGroupOutDocument get_entity_user_groups(id) +> JsonApiUserGroupOutDocument get_entity_user_groups(id, filter=filter, include=include) Get UserGroup entity @@ -4605,11 +4026,11 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4618,41 +4039,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Get UserGroup entity - api_response = api_instance.get_entity_user_groups(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get UserGroup entity api_response = api_instance.get_entity_user_groups(id, filter=filter, include=include) + print("The response of OrganizationModelControllerApi->get_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -4667,7 +4079,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4677,7 +4088,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_identifiers** -> JsonApiUserIdentifierOutDocument get_entity_user_identifiers(id) +> JsonApiUserIdentifierOutDocument get_entity_user_identifiers(id, filter=filter) Get UserIdentifier entity @@ -4687,11 +4098,11 @@ UserIdentifier - represents basic information about entity interacting with plat ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.models.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4700,37 +4111,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "firstname==someString;lastname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get UserIdentifier entity - api_response = api_instance.get_entity_user_identifiers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_user_identifiers: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'firstname==someString;lastname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get UserIdentifier entity api_response = api_instance.get_entity_user_identifiers(id, filter=filter) + print("The response of OrganizationModelControllerApi->get_entity_user_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_user_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -4745,7 +4149,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4755,7 +4158,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_users** -> JsonApiUserOutDocument get_entity_users(id) +> JsonApiUserOutDocument get_entity_users(id, filter=filter, include=include) Get User entity @@ -4765,11 +4168,11 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4778,41 +4181,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Get User entity - api_response = api_instance.get_entity_users(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_users: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get User entity api_response = api_instance.get_entity_users(id, filter=filter, include=include) + print("The response of OrganizationModelControllerApi->get_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -4827,7 +4221,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4837,7 +4230,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspaces** -> JsonApiWorkspaceOutDocument get_entity_workspaces(id) +> JsonApiWorkspaceOutDocument get_entity_workspaces(id, filter=filter, include=include, meta_include=meta_include) Get Workspace entity @@ -4847,11 +4240,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4860,45 +4253,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Workspace entity - api_response = api_instance.get_entity_workspaces(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=config,permissions,hierarchy,dataModelDatasets,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Workspace entity api_response = api_instance.get_entity_workspaces(id, filter=filter, include=include, meta_include=meta_include) + print("The response of OrganizationModelControllerApi->get_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->get_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4913,7 +4295,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4923,7 +4304,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_color_palettes** -> JsonApiColorPaletteOutDocument patch_entity_color_palettes(id, json_api_color_palette_patch_document) +> JsonApiColorPaletteOutDocument patch_entity_color_palettes(id, json_api_color_palette_patch_document, filter=filter) Patch Color Pallette @@ -4931,12 +4312,12 @@ Patch Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4945,48 +4326,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_color_palette_patch_document = JsonApiColorPalettePatchDocument( - data=JsonApiColorPalettePatch( - attributes=JsonApiColorPalettePatchAttributes( - content={}, - name="name_example", - ), - id="id1", - type="colorPalette", - ), - ) # JsonApiColorPalettePatchDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Color Pallette - api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_color_palettes: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_color_palette_patch_document = gooddata_api_client.JsonApiColorPalettePatchDocument() # JsonApiColorPalettePatchDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Color Pallette api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document, filter=filter) + print("The response of OrganizationModelControllerApi->patch_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_color_palette_patch_document** | [**JsonApiColorPalettePatchDocument**](JsonApiColorPalettePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_color_palette_patch_document** | [**JsonApiColorPalettePatchDocument**](JsonApiColorPalettePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5001,7 +4366,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5011,7 +4375,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_csp_directives** -> JsonApiCspDirectiveOutDocument patch_entity_csp_directives(id, json_api_csp_directive_patch_document) +> JsonApiCspDirectiveOutDocument patch_entity_csp_directives(id, json_api_csp_directive_patch_document, filter=filter) Patch CSP Directives @@ -5021,12 +4385,12 @@ Patch CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5035,49 +4399,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_csp_directive_patch_document = JsonApiCspDirectivePatchDocument( - data=JsonApiCspDirectivePatch( - attributes=JsonApiCspDirectivePatchAttributes( - sources=[ - "sources_example", - ], - ), - id="id1", - type="cspDirective", - ), - ) # JsonApiCspDirectivePatchDocument | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch CSP Directives - api_response = api_instance.patch_entity_csp_directives(id, json_api_csp_directive_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_csp_directives: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_csp_directive_patch_document = gooddata_api_client.JsonApiCspDirectivePatchDocument() # JsonApiCspDirectivePatchDocument | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch CSP Directives api_response = api_instance.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, filter=filter) + print("The response of OrganizationModelControllerApi->patch_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_csp_directive_patch_document** | [**JsonApiCspDirectivePatchDocument**](JsonApiCspDirectivePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_csp_directive_patch_document** | [**JsonApiCspDirectivePatchDocument**](JsonApiCspDirectivePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5092,7 +4439,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5102,7 +4448,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_data_sources** -> JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document) +> JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document, filter=filter) Patch Data Source entity @@ -5112,12 +4458,12 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5126,64 +4472,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_data_source_patch_document = JsonApiDataSourcePatchDocument( - data=JsonApiDataSourcePatch( - attributes=JsonApiDataSourcePatchAttributes( - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourcePatchDocument | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Data Source entity - api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_data_source_patch_document = gooddata_api_client.JsonApiDataSourcePatchDocument() # JsonApiDataSourcePatchDocument | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Data Source entity api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document, filter=filter) + print("The response of OrganizationModelControllerApi->patch_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_data_source_patch_document** | [**JsonApiDataSourcePatchDocument**](JsonApiDataSourcePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_data_source_patch_document** | [**JsonApiDataSourcePatchDocument**](JsonApiDataSourcePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5198,7 +4512,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5208,7 +4521,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_export_templates** -> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document) +> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) Patch Export Template entity @@ -5216,12 +4529,12 @@ Patch Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument -from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5230,114 +4543,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_export_template_patch_document = JsonApiExportTemplatePatchDocument( - data=JsonApiExportTemplatePatch( - attributes=JsonApiExportTemplatePatchAttributes( - dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - name="name_example", - widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - id="id1", - type="exportTemplate", - ), - ) # JsonApiExportTemplatePatchDocument | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Export Template entity - api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_export_templates: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_export_template_patch_document = gooddata_api_client.JsonApiExportTemplatePatchDocument() # JsonApiExportTemplatePatchDocument | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Export Template entity api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) + print("The response of OrganizationModelControllerApi->patch_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5352,7 +4583,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5362,7 +4592,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_identity_providers** -> JsonApiIdentityProviderOutDocument patch_entity_identity_providers(id, json_api_identity_provider_patch_document) +> JsonApiIdentityProviderOutDocument patch_entity_identity_providers(id, json_api_identity_provider_patch_document, filter=filter) Patch Identity Provider @@ -5370,12 +4600,12 @@ Patch Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5384,63 +4614,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_identity_provider_patch_document = JsonApiIdentityProviderPatchDocument( - data=JsonApiIdentityProviderPatch( - attributes=JsonApiIdentityProviderInAttributes( - custom_claim_mapping={ - "key": "key_example", - }, - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - id="id1", - type="identityProvider", - ), - ) # JsonApiIdentityProviderPatchDocument | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Identity Provider - api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_identity_providers: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_identity_provider_patch_document = gooddata_api_client.JsonApiIdentityProviderPatchDocument() # JsonApiIdentityProviderPatchDocument | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Identity Provider api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, filter=filter) + print("The response of OrganizationModelControllerApi->patch_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_identity_provider_patch_document** | [**JsonApiIdentityProviderPatchDocument**](JsonApiIdentityProviderPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_identity_provider_patch_document** | [**JsonApiIdentityProviderPatchDocument**](JsonApiIdentityProviderPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5455,7 +4654,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5465,7 +4663,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_jwks** -> JsonApiJwkOutDocument patch_entity_jwks(id, json_api_jwk_patch_document) +> JsonApiJwkOutDocument patch_entity_jwks(id, json_api_jwk_patch_document, filter=filter) Patch Jwk @@ -5475,12 +4673,12 @@ Patches JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5489,47 +4687,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_jwk_patch_document = JsonApiJwkPatchDocument( - data=JsonApiJwkPatch( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), - ), - id="id1", - type="jwk", - ), - ) # JsonApiJwkPatchDocument | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Jwk - api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_jwks: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_jwk_patch_document = gooddata_api_client.JsonApiJwkPatchDocument() # JsonApiJwkPatchDocument | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Jwk api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document, filter=filter) + print("The response of OrganizationModelControllerApi->patch_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_jwk_patch_document** | [**JsonApiJwkPatchDocument**](JsonApiJwkPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_jwk_patch_document** | [**JsonApiJwkPatchDocument**](JsonApiJwkPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5544,7 +4727,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5554,7 +4736,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_llm_endpoints** -> JsonApiLlmEndpointOutDocument patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document) +> JsonApiLlmEndpointOutDocument patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document, filter=filter) Patch LLM endpoint entity @@ -5562,12 +4744,12 @@ Patch LLM endpoint entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument -from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5576,52 +4758,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_llm_endpoint_patch_document = JsonApiLlmEndpointPatchDocument( - data=JsonApiLlmEndpointPatch( - attributes=JsonApiLlmEndpointPatchAttributes( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="OPENAI", - title="title_example", - token="token_example", - ), - id="id1", - type="llmEndpoint", - ), - ) # JsonApiLlmEndpointPatchDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch LLM endpoint entity - api_response = api_instance.patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_llm_endpoints: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_llm_endpoint_patch_document = gooddata_api_client.JsonApiLlmEndpointPatchDocument() # JsonApiLlmEndpointPatchDocument | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch LLM endpoint entity api_response = api_instance.patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document, filter=filter) + print("The response of OrganizationModelControllerApi->patch_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_llm_endpoint_patch_document** | [**JsonApiLlmEndpointPatchDocument**](JsonApiLlmEndpointPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_llm_endpoint_patch_document** | [**JsonApiLlmEndpointPatchDocument**](JsonApiLlmEndpointPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5636,7 +4798,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5646,7 +4807,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_notification_channels** -> JsonApiNotificationChannelOutDocument patch_entity_notification_channels(id, json_api_notification_channel_patch_document) +> JsonApiNotificationChannelOutDocument patch_entity_notification_channels(id, json_api_notification_channel_patch_document, filter=filter) Patch Notification Channel entity @@ -5654,12 +4815,12 @@ Patch Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument -from gooddata_api_client.model.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5668,54 +4829,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_notification_channel_patch_document = JsonApiNotificationChannelPatchDocument( - data=JsonApiNotificationChannelPatch( - attributes=JsonApiNotificationChannelInAttributes( - allowed_recipients="CREATOR", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="HIDDEN", - description="description_example", - destination=JsonApiNotificationChannelInAttributesDestination(None), - in_platform_notification="DISABLED", - name="name_example", - notification_source="notification_source_example", - ), - id="id1", - type="notificationChannel", - ), - ) # JsonApiNotificationChannelPatchDocument | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Notification Channel entity - api_response = api_instance.patch_entity_notification_channels(id, json_api_notification_channel_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_notification_channels: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_notification_channel_patch_document = gooddata_api_client.JsonApiNotificationChannelPatchDocument() # JsonApiNotificationChannelPatchDocument | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Notification Channel entity api_response = api_instance.patch_entity_notification_channels(id, json_api_notification_channel_patch_document, filter=filter) + print("The response of OrganizationModelControllerApi->patch_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_notification_channel_patch_document** | [**JsonApiNotificationChannelPatchDocument**](JsonApiNotificationChannelPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_notification_channel_patch_document** | [**JsonApiNotificationChannelPatchDocument**](JsonApiNotificationChannelPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5730,7 +4869,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5740,7 +4878,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_organization_settings** -> JsonApiOrganizationSettingOutDocument patch_entity_organization_settings(id, json_api_organization_setting_patch_document) +> JsonApiOrganizationSettingOutDocument patch_entity_organization_settings(id, json_api_organization_setting_patch_document, filter=filter) Patch Organization entity @@ -5748,12 +4886,12 @@ Patch Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5762,48 +4900,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_setting_patch_document = JsonApiOrganizationSettingPatchDocument( - data=JsonApiOrganizationSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="organizationSetting", - ), - ) # JsonApiOrganizationSettingPatchDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Organization entity - api_response = api_instance.patch_entity_organization_settings(id, json_api_organization_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_organization_settings: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_organization_setting_patch_document = gooddata_api_client.JsonApiOrganizationSettingPatchDocument() # JsonApiOrganizationSettingPatchDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Organization entity api_response = api_instance.patch_entity_organization_settings(id, json_api_organization_setting_patch_document, filter=filter) + print("The response of OrganizationModelControllerApi->patch_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_setting_patch_document** | [**JsonApiOrganizationSettingPatchDocument**](JsonApiOrganizationSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_organization_setting_patch_document** | [**JsonApiOrganizationSettingPatchDocument**](JsonApiOrganizationSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5818,7 +4940,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5828,7 +4949,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_themes** -> JsonApiThemeOutDocument patch_entity_themes(id, json_api_theme_patch_document) +> JsonApiThemeOutDocument patch_entity_themes(id, json_api_theme_patch_document, filter=filter) Patch Theming @@ -5836,12 +4957,12 @@ Patch Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5850,48 +4971,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_theme_patch_document = JsonApiThemePatchDocument( - data=JsonApiThemePatch( - attributes=JsonApiColorPalettePatchAttributes( - content={}, - name="name_example", - ), - id="id1", - type="theme", - ), - ) # JsonApiThemePatchDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Theming - api_response = api_instance.patch_entity_themes(id, json_api_theme_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_themes: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_theme_patch_document = gooddata_api_client.JsonApiThemePatchDocument() # JsonApiThemePatchDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Theming api_response = api_instance.patch_entity_themes(id, json_api_theme_patch_document, filter=filter) + print("The response of OrganizationModelControllerApi->patch_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_theme_patch_document** | [**JsonApiThemePatchDocument**](JsonApiThemePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_theme_patch_document** | [**JsonApiThemePatchDocument**](JsonApiThemePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -5906,7 +5011,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5916,7 +5020,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_user_groups** -> JsonApiUserGroupOutDocument patch_entity_user_groups(id, json_api_user_group_patch_document) +> JsonApiUserGroupOutDocument patch_entity_user_groups(id, json_api_user_group_patch_document, filter=filter, include=include) Patch UserGroup entity @@ -5926,12 +5030,12 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5940,61 +5044,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_group_patch_document = JsonApiUserGroupPatchDocument( - data=JsonApiUserGroupPatch( - attributes=JsonApiUserGroupInAttributes( - name="name_example", - ), - id="id1", - relationships=JsonApiUserGroupInRelationships( - parents=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="userGroup", - ), - ) # JsonApiUserGroupPatchDocument | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch UserGroup entity - api_response = api_instance.patch_entity_user_groups(id, json_api_user_group_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_user_group_patch_document = gooddata_api_client.JsonApiUserGroupPatchDocument() # JsonApiUserGroupPatchDocument | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch UserGroup entity api_response = api_instance.patch_entity_user_groups(id, json_api_user_group_patch_document, filter=filter, include=include) + print("The response of OrganizationModelControllerApi->patch_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_group_patch_document** | [**JsonApiUserGroupPatchDocument**](JsonApiUserGroupPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_group_patch_document** | [**JsonApiUserGroupPatchDocument**](JsonApiUserGroupPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -6009,7 +5086,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6019,7 +5095,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_users** -> JsonApiUserOutDocument patch_entity_users(id, json_api_user_patch_document) +> JsonApiUserOutDocument patch_entity_users(id, json_api_user_patch_document, filter=filter, include=include) Patch User entity @@ -6029,12 +5105,12 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6043,64 +5119,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_patch_document = JsonApiUserPatchDocument( - data=JsonApiUserPatch( - attributes=JsonApiUserInAttributes( - authentication_id="authentication_id_example", - email="email_example", - firstname="firstname_example", - lastname="lastname_example", - ), - id="id1", - relationships=JsonApiUserInRelationships( - user_groups=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="user", - ), - ) # JsonApiUserPatchDocument | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch User entity - api_response = api_instance.patch_entity_users(id, json_api_user_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_users: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_user_patch_document = gooddata_api_client.JsonApiUserPatchDocument() # JsonApiUserPatchDocument | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch User entity api_response = api_instance.patch_entity_users(id, json_api_user_patch_document, filter=filter, include=include) + print("The response of OrganizationModelControllerApi->patch_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_patch_document** | [**JsonApiUserPatchDocument**](JsonApiUserPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_patch_document** | [**JsonApiUserPatchDocument**](JsonApiUserPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -6115,7 +5161,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6125,7 +5170,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspaces** -> JsonApiWorkspaceOutDocument patch_entity_workspaces(id, json_api_workspace_patch_document) +> JsonApiWorkspaceOutDocument patch_entity_workspaces(id, json_api_workspace_patch_document, filter=filter, include=include) Patch Workspace entity @@ -6135,12 +5180,12 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6149,69 +5194,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_workspace_patch_document = JsonApiWorkspacePatchDocument( - data=JsonApiWorkspacePatch( - attributes=JsonApiWorkspaceInAttributes( - cache_extra_limit=1, - data_source=JsonApiWorkspaceInAttributesDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - name="name_example", - prefix="/6bUUGjjNSwg0_bs", - ), - id="id1", - relationships=JsonApiWorkspaceInRelationships( - parent=JsonApiWorkspaceAutomationOutRelationshipsWorkspace( - data=JsonApiWorkspaceToOneLinkage(None), - ), - ), - type="workspace", - ), - ) # JsonApiWorkspacePatchDocument | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Workspace entity - api_response = api_instance.patch_entity_workspaces(id, json_api_workspace_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_workspace_patch_document = gooddata_api_client.JsonApiWorkspacePatchDocument() # JsonApiWorkspacePatchDocument | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Workspace entity api_response = api_instance.patch_entity_workspaces(id, json_api_workspace_patch_document, filter=filter, include=include) + print("The response of OrganizationModelControllerApi->patch_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->patch_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_workspace_patch_document** | [**JsonApiWorkspacePatchDocument**](JsonApiWorkspacePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_workspace_patch_document** | [**JsonApiWorkspacePatchDocument**](JsonApiWorkspacePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -6226,7 +5236,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6236,7 +5245,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_color_palettes** -> JsonApiColorPaletteOutDocument update_entity_color_palettes(id, json_api_color_palette_in_document) +> JsonApiColorPaletteOutDocument update_entity_color_palettes(id, json_api_color_palette_in_document, filter=filter) Put Color Pallette @@ -6244,12 +5253,12 @@ Put Color Pallette ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6258,48 +5267,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_color_palette_in_document = JsonApiColorPaletteInDocument( - data=JsonApiColorPaletteIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="colorPalette", - ), - ) # JsonApiColorPaletteInDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Color Pallette - api_response = api_instance.update_entity_color_palettes(id, json_api_color_palette_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_color_palettes: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_color_palette_in_document = gooddata_api_client.JsonApiColorPaletteInDocument() # JsonApiColorPaletteInDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Color Pallette api_response = api_instance.update_entity_color_palettes(id, json_api_color_palette_in_document, filter=filter) + print("The response of OrganizationModelControllerApi->update_entity_color_palettes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_color_palettes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -6314,7 +5307,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6324,7 +5316,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_csp_directives** -> JsonApiCspDirectiveOutDocument update_entity_csp_directives(id, json_api_csp_directive_in_document) +> JsonApiCspDirectiveOutDocument update_entity_csp_directives(id, json_api_csp_directive_in_document, filter=filter) Put CSP Directives @@ -6334,12 +5326,12 @@ Put CSP Directives ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6348,49 +5340,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_csp_directive_in_document = JsonApiCspDirectiveInDocument( - data=JsonApiCspDirectiveIn( - attributes=JsonApiCspDirectiveInAttributes( - sources=[ - "sources_example", - ], - ), - id="id1", - type="cspDirective", - ), - ) # JsonApiCspDirectiveInDocument | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put CSP Directives - api_response = api_instance.update_entity_csp_directives(id, json_api_csp_directive_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_csp_directives: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_csp_directive_in_document = gooddata_api_client.JsonApiCspDirectiveInDocument() # JsonApiCspDirectiveInDocument | + filter = 'sources==v1,v2,v3' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put CSP Directives api_response = api_instance.update_entity_csp_directives(id, json_api_csp_directive_in_document, filter=filter) + print("The response of OrganizationModelControllerApi->update_entity_csp_directives:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_csp_directives: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_csp_directive_in_document** | [**JsonApiCspDirectiveInDocument**](JsonApiCspDirectiveInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -6405,7 +5380,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6415,7 +5389,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_data_sources** -> JsonApiDataSourceOutDocument update_entity_data_sources(id, json_api_data_source_in_document) +> JsonApiDataSourceOutDocument update_entity_data_sources(id, json_api_data_source_in_document, filter=filter) Put Data Source entity @@ -6425,12 +5399,12 @@ Data Source - represents data source for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6439,64 +5413,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_data_source_in_document = JsonApiDataSourceInDocument( - data=JsonApiDataSourceIn( - attributes=JsonApiDataSourceInAttributes( - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourceInDocument | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Data Source entity - api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_data_sources: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_data_source_in_document = gooddata_api_client.JsonApiDataSourceInDocument() # JsonApiDataSourceInDocument | + filter = 'name==someString;type==DatabaseTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Data Source entity api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document, filter=filter) + print("The response of OrganizationModelControllerApi->update_entity_data_sources:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_data_sources: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -6511,7 +5453,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6521,7 +5462,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_export_templates** -> JsonApiExportTemplateOutDocument update_entity_export_templates(id, json_api_export_template_in_document) +> JsonApiExportTemplateOutDocument update_entity_export_templates(id, json_api_export_template_in_document, filter=filter) PUT Export Template entity @@ -6529,12 +5470,12 @@ PUT Export Template entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6543,114 +5484,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_export_template_in_document = JsonApiExportTemplateInDocument( - data=JsonApiExportTemplateIn( - attributes=JsonApiExportTemplateInAttributes( - dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - name="name_example", - widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - ), - id="id1", - type="exportTemplate", - ), - ) # JsonApiExportTemplateInDocument | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # PUT Export Template entity - api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_export_templates: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_export_template_in_document = gooddata_api_client.JsonApiExportTemplateInDocument() # JsonApiExportTemplateInDocument | + filter = 'name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # PUT Export Template entity api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document, filter=filter) + print("The response of OrganizationModelControllerApi->update_entity_export_templates:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_export_templates: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_export_template_in_document** | [**JsonApiExportTemplateInDocument**](JsonApiExportTemplateInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_export_template_in_document** | [**JsonApiExportTemplateInDocument**](JsonApiExportTemplateInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -6665,7 +5524,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6675,7 +5533,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_identity_providers** -> JsonApiIdentityProviderOutDocument update_entity_identity_providers(id, json_api_identity_provider_in_document) +> JsonApiIdentityProviderOutDocument update_entity_identity_providers(id, json_api_identity_provider_in_document, filter=filter) Put Identity Provider @@ -6683,12 +5541,12 @@ Put Identity Provider ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6697,63 +5555,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_identity_provider_in_document = JsonApiIdentityProviderInDocument( - data=JsonApiIdentityProviderIn( - attributes=JsonApiIdentityProviderInAttributes( - custom_claim_mapping={ - "key": "key_example", - }, - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - id="id1", - type="identityProvider", - ), - ) # JsonApiIdentityProviderInDocument | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Identity Provider - api_response = api_instance.update_entity_identity_providers(id, json_api_identity_provider_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_identity_providers: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_identity_provider_in_document = gooddata_api_client.JsonApiIdentityProviderInDocument() # JsonApiIdentityProviderInDocument | + filter = 'identifiers==v1,v2,v3;customClaimMapping==MapValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Identity Provider api_response = api_instance.update_entity_identity_providers(id, json_api_identity_provider_in_document, filter=filter) + print("The response of OrganizationModelControllerApi->update_entity_identity_providers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_identity_providers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_identity_provider_in_document** | [**JsonApiIdentityProviderInDocument**](JsonApiIdentityProviderInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -6768,7 +5595,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6778,7 +5604,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_jwks** -> JsonApiJwkOutDocument update_entity_jwks(id, json_api_jwk_in_document) +> JsonApiJwkOutDocument update_entity_jwks(id, json_api_jwk_in_document, filter=filter) Put Jwk @@ -6788,12 +5614,12 @@ Updates JSON web key - used to verify JSON web tokens (Jwts) ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6802,47 +5628,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_jwk_in_document = JsonApiJwkInDocument( - data=JsonApiJwkIn( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), - ), - id="id1", - type="jwk", - ), - ) # JsonApiJwkInDocument | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Jwk - api_response = api_instance.update_entity_jwks(id, json_api_jwk_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_jwks: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_jwk_in_document = gooddata_api_client.JsonApiJwkInDocument() # JsonApiJwkInDocument | + filter = 'content==JwkSpecificationValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Jwk api_response = api_instance.update_entity_jwks(id, json_api_jwk_in_document, filter=filter) + print("The response of OrganizationModelControllerApi->update_entity_jwks:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_jwks: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -6857,7 +5668,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6867,7 +5677,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_llm_endpoints** -> JsonApiLlmEndpointOutDocument update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document) +> JsonApiLlmEndpointOutDocument update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document, filter=filter) PUT LLM endpoint entity @@ -6875,12 +5685,12 @@ PUT LLM endpoint entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6889,52 +5699,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_llm_endpoint_in_document = JsonApiLlmEndpointInDocument( - data=JsonApiLlmEndpointIn( - attributes=JsonApiLlmEndpointInAttributes( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="OPENAI", - title="title_example", - token="token_example", - ), - id="id1", - type="llmEndpoint", - ), - ) # JsonApiLlmEndpointInDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # PUT LLM endpoint entity - api_response = api_instance.update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_llm_endpoints: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_llm_endpoint_in_document = gooddata_api_client.JsonApiLlmEndpointInDocument() # JsonApiLlmEndpointInDocument | + filter = 'title==someString;provider==LLMProviderValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # PUT LLM endpoint entity api_response = api_instance.update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document, filter=filter) + print("The response of OrganizationModelControllerApi->update_entity_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_llm_endpoint_in_document** | [**JsonApiLlmEndpointInDocument**](JsonApiLlmEndpointInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -6949,7 +5739,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6959,7 +5748,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_notification_channels** -> JsonApiNotificationChannelOutDocument update_entity_notification_channels(id, json_api_notification_channel_in_document) +> JsonApiNotificationChannelOutDocument update_entity_notification_channels(id, json_api_notification_channel_in_document, filter=filter) Put Notification Channel entity @@ -6967,12 +5756,12 @@ Put Notification Channel entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6981,54 +5770,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_notification_channel_in_document = JsonApiNotificationChannelInDocument( - data=JsonApiNotificationChannelIn( - attributes=JsonApiNotificationChannelInAttributes( - allowed_recipients="CREATOR", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="HIDDEN", - description="description_example", - destination=JsonApiNotificationChannelInAttributesDestination(None), - in_platform_notification="DISABLED", - name="name_example", - notification_source="notification_source_example", - ), - id="id1", - type="notificationChannel", - ), - ) # JsonApiNotificationChannelInDocument | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Notification Channel entity - api_response = api_instance.update_entity_notification_channels(id, json_api_notification_channel_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_notification_channels: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_notification_channel_in_document = gooddata_api_client.JsonApiNotificationChannelInDocument() # JsonApiNotificationChannelInDocument | + filter = 'name==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Notification Channel entity api_response = api_instance.update_entity_notification_channels(id, json_api_notification_channel_in_document, filter=filter) + print("The response of OrganizationModelControllerApi->update_entity_notification_channels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_notification_channels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_notification_channel_in_document** | [**JsonApiNotificationChannelInDocument**](JsonApiNotificationChannelInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_notification_channel_in_document** | [**JsonApiNotificationChannelInDocument**](JsonApiNotificationChannelInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -7043,7 +5810,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7053,7 +5819,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_organization_settings** -> JsonApiOrganizationSettingOutDocument update_entity_organization_settings(id, json_api_organization_setting_in_document) +> JsonApiOrganizationSettingOutDocument update_entity_organization_settings(id, json_api_organization_setting_in_document, filter=filter) Put Organization entity @@ -7061,12 +5827,12 @@ Put Organization entity ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7075,48 +5841,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_organization_setting_in_document = JsonApiOrganizationSettingInDocument( - data=JsonApiOrganizationSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="organizationSetting", - ), - ) # JsonApiOrganizationSettingInDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Organization entity - api_response = api_instance.update_entity_organization_settings(id, json_api_organization_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_organization_settings: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_organization_setting_in_document = gooddata_api_client.JsonApiOrganizationSettingInDocument() # JsonApiOrganizationSettingInDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Organization entity api_response = api_instance.update_entity_organization_settings(id, json_api_organization_setting_in_document, filter=filter) + print("The response of OrganizationModelControllerApi->update_entity_organization_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_organization_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_organization_setting_in_document** | [**JsonApiOrganizationSettingInDocument**](JsonApiOrganizationSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -7131,7 +5881,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7141,7 +5890,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_themes** -> JsonApiThemeOutDocument update_entity_themes(id, json_api_theme_in_document) +> JsonApiThemeOutDocument update_entity_themes(id, json_api_theme_in_document, filter=filter) Put Theming @@ -7149,12 +5898,12 @@ Put Theming ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7163,48 +5912,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_theme_in_document = JsonApiThemeInDocument( - data=JsonApiThemeIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", - ), - id="id1", - type="theme", - ), - ) # JsonApiThemeInDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Theming - api_response = api_instance.update_entity_themes(id, json_api_theme_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_themes: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_theme_in_document = gooddata_api_client.JsonApiThemeInDocument() # JsonApiThemeInDocument | + filter = 'name==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Theming api_response = api_instance.update_entity_themes(id, json_api_theme_in_document, filter=filter) + print("The response of OrganizationModelControllerApi->update_entity_themes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_themes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -7219,7 +5952,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7229,7 +5961,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_user_groups** -> JsonApiUserGroupOutDocument update_entity_user_groups(id, json_api_user_group_in_document) +> JsonApiUserGroupOutDocument update_entity_user_groups(id, json_api_user_group_in_document, filter=filter, include=include) Put UserGroup entity @@ -7239,12 +5971,12 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7253,61 +5985,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_group_in_document = JsonApiUserGroupInDocument( - data=JsonApiUserGroupIn( - attributes=JsonApiUserGroupInAttributes( - name="name_example", - ), - id="id1", - relationships=JsonApiUserGroupInRelationships( - parents=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="userGroup", - ), - ) # JsonApiUserGroupInDocument | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put UserGroup entity - api_response = api_instance.update_entity_user_groups(id, json_api_user_group_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_user_group_in_document = gooddata_api_client.JsonApiUserGroupInDocument() # JsonApiUserGroupInDocument | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put UserGroup entity api_response = api_instance.update_entity_user_groups(id, json_api_user_group_in_document, filter=filter, include=include) + print("The response of OrganizationModelControllerApi->update_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -7322,7 +6027,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7332,7 +6036,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_users** -> JsonApiUserOutDocument update_entity_users(id, json_api_user_in_document) +> JsonApiUserOutDocument update_entity_users(id, json_api_user_in_document, filter=filter, include=include) Put User entity @@ -7342,12 +6046,12 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7356,64 +6060,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_in_document = JsonApiUserInDocument( - data=JsonApiUserIn( - attributes=JsonApiUserInAttributes( - authentication_id="authentication_id_example", - email="email_example", - firstname="firstname_example", - lastname="lastname_example", - ), - id="id1", - relationships=JsonApiUserInRelationships( - user_groups=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="user", - ), - ) # JsonApiUserInDocument | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put User entity - api_response = api_instance.update_entity_users(id, json_api_user_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_users: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_user_in_document = gooddata_api_client.JsonApiUserInDocument() # JsonApiUserInDocument | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put User entity api_response = api_instance.update_entity_users(id, json_api_user_in_document, filter=filter, include=include) + print("The response of OrganizationModelControllerApi->update_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -7428,7 +6102,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7438,7 +6111,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspaces** -> JsonApiWorkspaceOutDocument update_entity_workspaces(id, json_api_workspace_in_document) +> JsonApiWorkspaceOutDocument update_entity_workspaces(id, json_api_workspace_in_document, filter=filter, include=include) Put Workspace entity @@ -7448,12 +6121,12 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7462,69 +6135,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_workspace_in_document = JsonApiWorkspaceInDocument( - data=JsonApiWorkspaceIn( - attributes=JsonApiWorkspaceInAttributes( - cache_extra_limit=1, - data_source=JsonApiWorkspaceInAttributesDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - name="name_example", - prefix="/6bUUGjjNSwg0_bs", - ), - id="id1", - relationships=JsonApiWorkspaceInRelationships( - parent=JsonApiWorkspaceAutomationOutRelationshipsWorkspace( - data=JsonApiWorkspaceToOneLinkage(None), - ), - ), - type="workspace", - ), - ) # JsonApiWorkspaceInDocument | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Workspace entity - api_response = api_instance.update_entity_workspaces(id, json_api_workspace_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.OrganizationModelControllerApi(api_client) + id = 'id_example' # str | + json_api_workspace_in_document = gooddata_api_client.JsonApiWorkspaceInDocument() # JsonApiWorkspaceInDocument | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Workspace entity api_response = api_instance.update_entity_workspaces(id, json_api_workspace_in_document, filter=filter, include=include) + print("The response of OrganizationModelControllerApi->update_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling OrganizationModelControllerApi->update_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -7539,7 +6177,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/OrganizationPermissionAssignment.md b/gooddata-api-client/docs/OrganizationPermissionAssignment.md index 1200943d4..17c46b913 100644 --- a/gooddata-api-client/docs/OrganizationPermissionAssignment.md +++ b/gooddata-api-client/docs/OrganizationPermissionAssignment.md @@ -3,12 +3,29 @@ Organization permission assignments ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | -**permissions** | **[str]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.organization_permission_assignment import OrganizationPermissionAssignment + +# TODO update the JSON string below +json = "{}" +# create an instance of OrganizationPermissionAssignment from a JSON string +organization_permission_assignment_instance = OrganizationPermissionAssignment.from_json(json) +# print the JSON string representation of the object +print(OrganizationPermissionAssignment.to_json()) +# convert the object into a dict +organization_permission_assignment_dict = organization_permission_assignment_instance.to_dict() +# create an instance of OrganizationPermissionAssignment from a dict +organization_permission_assignment_from_dict = OrganizationPermissionAssignment.from_dict(organization_permission_assignment_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Over.md b/gooddata-api-client/docs/Over.md index fca355abb..8ed79faae 100644 --- a/gooddata-api-client/docs/Over.md +++ b/gooddata-api-client/docs/Over.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | [**[IdentifierRef]**](IdentifierRef.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**attributes** | [**List[IdentifierRef]**](IdentifierRef.md) | | + +## Example + +```python +from gooddata_api_client.models.over import Over + +# TODO update the JSON string below +json = "{}" +# create an instance of Over from a JSON string +over_instance = Over.from_json(json) +# print the JSON string representation of the object +print(Over.to_json()) +# convert the object into a dict +over_dict = over_instance.to_dict() +# create an instance of Over from a dict +over_from_dict = Over.from_dict(over_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PageMetadata.md b/gooddata-api-client/docs/PageMetadata.md index 2776270ce..2dfdb7cff 100644 --- a/gooddata-api-client/docs/PageMetadata.md +++ b/gooddata-api-client/docs/PageMetadata.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **number** | **int** | The number of the current page | [optional] **size** | **int** | The size of the current page | [optional] **total_elements** | **int** | The total number of elements | [optional] **total_pages** | **int** | The total number of pages | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.page_metadata import PageMetadata + +# TODO update the JSON string below +json = "{}" +# create an instance of PageMetadata from a JSON string +page_metadata_instance = PageMetadata.from_json(json) +# print the JSON string representation of the object +print(PageMetadata.to_json()) + +# convert the object into a dict +page_metadata_dict = page_metadata_instance.to_dict() +# create an instance of PageMetadata from a dict +page_metadata_from_dict = PageMetadata.from_dict(page_metadata_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Paging.md b/gooddata-api-client/docs/Paging.md index 78ee468bb..dd6d9fa18 100644 --- a/gooddata-api-client/docs/Paging.md +++ b/gooddata-api-client/docs/Paging.md @@ -3,14 +3,31 @@ Current page description. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **int** | Count of items in this page. | +**next** | **str** | Link to next page, or null if this is last page. | [optional] **offset** | **int** | Offset of this page. | **total** | **int** | Count of returnable items ignoring paging. | -**next** | **str** | Link to next page, or null if this is last page. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.paging import Paging + +# TODO update the JSON string below +json = "{}" +# create an instance of Paging from a JSON string +paging_instance = Paging.from_json(json) +# print the JSON string representation of the object +print(Paging.to_json()) + +# convert the object into a dict +paging_dict = paging_instance.to_dict() +# create an instance of Paging from a dict +paging_from_dict = Paging.from_dict(paging_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Parameter.md b/gooddata-api-client/docs/Parameter.md index 1c744126c..85fc56c57 100644 --- a/gooddata-api-client/docs/Parameter.md +++ b/gooddata-api-client/docs/Parameter.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | | **value** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.parameter import Parameter + +# TODO update the JSON string below +json = "{}" +# create an instance of Parameter from a JSON string +parameter_instance = Parameter.from_json(json) +# print the JSON string representation of the object +print(Parameter.to_json()) + +# convert the object into a dict +parameter_dict = parameter_instance.to_dict() +# create an instance of Parameter from a dict +parameter_from_dict = Parameter.from_dict(parameter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PdfTableStyle.md b/gooddata-api-client/docs/PdfTableStyle.md index d65bd169c..d2f681450 100644 --- a/gooddata-api-client/docs/PdfTableStyle.md +++ b/gooddata-api-client/docs/PdfTableStyle.md @@ -3,12 +3,29 @@ Custom CSS styles for the table. (PDF, HTML) ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**properties** | [**List[PdfTableStyleProperty]**](PdfTableStyleProperty.md) | List of CSS properties. | [optional] **selector** | **str** | CSS selector where to apply given properties. | -**properties** | [**[PdfTableStyleProperty]**](PdfTableStyleProperty.md) | List of CSS properties. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.pdf_table_style import PdfTableStyle + +# TODO update the JSON string below +json = "{}" +# create an instance of PdfTableStyle from a JSON string +pdf_table_style_instance = PdfTableStyle.from_json(json) +# print the JSON string representation of the object +print(PdfTableStyle.to_json()) + +# convert the object into a dict +pdf_table_style_dict = pdf_table_style_instance.to_dict() +# create an instance of PdfTableStyle from a dict +pdf_table_style_from_dict = PdfTableStyle.from_dict(pdf_table_style_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PdfTableStyleProperty.md b/gooddata-api-client/docs/PdfTableStyleProperty.md index 44b87abb2..bf02fdd6f 100644 --- a/gooddata-api-client/docs/PdfTableStyleProperty.md +++ b/gooddata-api-client/docs/PdfTableStyleProperty.md @@ -3,12 +3,29 @@ CSS property. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **key** | **str** | CSS property key. | **value** | **str** | CSS property value. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.pdf_table_style_property import PdfTableStyleProperty + +# TODO update the JSON string below +json = "{}" +# create an instance of PdfTableStyleProperty from a JSON string +pdf_table_style_property_instance = PdfTableStyleProperty.from_json(json) +# print the JSON string representation of the object +print(PdfTableStyleProperty.to_json()) + +# convert the object into a dict +pdf_table_style_property_dict = pdf_table_style_property_instance.to_dict() +# create an instance of PdfTableStyleProperty from a dict +pdf_table_style_property_from_dict = PdfTableStyleProperty.from_dict(pdf_table_style_property_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PdmLdmRequest.md b/gooddata-api-client/docs/PdmLdmRequest.md index 370f6c72f..9cefb1d0e 100644 --- a/gooddata-api-client/docs/PdmLdmRequest.md +++ b/gooddata-api-client/docs/PdmLdmRequest.md @@ -3,13 +3,30 @@ PDM additions wrapper. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sqls** | [**[PdmSql]**](PdmSql.md) | List of SQL datasets. | [optional] -**table_overrides** | [**[TableOverride]**](TableOverride.md) | (BETA) List of table overrides. | [optional] -**tables** | [**[DeclarativeTable]**](DeclarativeTable.md) | List of physical database tables. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**sqls** | [**List[PdmSql]**](PdmSql.md) | List of SQL datasets. | [optional] +**table_overrides** | [**List[TableOverride]**](TableOverride.md) | (BETA) List of table overrides. | [optional] +**tables** | [**List[DeclarativeTable]**](DeclarativeTable.md) | List of physical database tables. | [optional] + +## Example + +```python +from gooddata_api_client.models.pdm_ldm_request import PdmLdmRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of PdmLdmRequest from a JSON string +pdm_ldm_request_instance = PdmLdmRequest.from_json(json) +# print the JSON string representation of the object +print(PdmLdmRequest.to_json()) +# convert the object into a dict +pdm_ldm_request_dict = pdm_ldm_request_instance.to_dict() +# create an instance of PdmLdmRequest from a dict +pdm_ldm_request_from_dict = PdmLdmRequest.from_dict(pdm_ldm_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PdmSql.md b/gooddata-api-client/docs/PdmSql.md index 7a732b652..40af4a300 100644 --- a/gooddata-api-client/docs/PdmSql.md +++ b/gooddata-api-client/docs/PdmSql.md @@ -3,13 +3,30 @@ SQL dataset definition. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**columns** | [**List[SqlColumn]**](SqlColumn.md) | Columns defining SQL dataset. | [optional] **statement** | **str** | SQL statement. | **title** | **str** | SQL dataset title. | -**columns** | [**[SqlColumn]**](SqlColumn.md) | Columns defining SQL dataset. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.pdm_sql import PdmSql + +# TODO update the JSON string below +json = "{}" +# create an instance of PdmSql from a JSON string +pdm_sql_instance = PdmSql.from_json(json) +# print the JSON string representation of the object +print(PdmSql.to_json()) + +# convert the object into a dict +pdm_sql_dict = pdm_sql_instance.to_dict() +# create an instance of PdmSql from a dict +pdm_sql_from_dict = PdmSql.from_dict(pdm_sql_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PermissionsApi.md b/gooddata-api-client/docs/PermissionsApi.md index 0583fb23a..1bcab98c2 100644 --- a/gooddata-api-client/docs/PermissionsApi.md +++ b/gooddata-api-client/docs/PermissionsApi.md @@ -29,11 +29,11 @@ Get Available Assignees ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.available_assignees import AvailableAssignees +from gooddata_api_client.models.available_assignees import AvailableAssignees +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -42,28 +42,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - workspace_id = "workspaceId_example" # str | - dashboard_id = "dashboardId_example" # str | + api_instance = gooddata_api_client.PermissionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + dashboard_id = 'dashboard_id_example' # str | - # example passing only required values which don't have defaults set try: # Get Available Assignees api_response = api_instance.available_assignees(workspace_id, dashboard_id) + print("The response of PermissionsApi->available_assignees:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->available_assignees: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **dashboard_id** | **str**| | + **workspace_id** | **str**| | + **dashboard_id** | **str**| | ### Return type @@ -78,7 +80,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -96,11 +97,11 @@ Get Dashboard Permissions ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.dashboard_permissions import DashboardPermissions +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -109,28 +110,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - workspace_id = "workspaceId_example" # str | - dashboard_id = "dashboardId_example" # str | + api_instance = gooddata_api_client.PermissionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + dashboard_id = 'dashboard_id_example' # str | - # example passing only required values which don't have defaults set try: # Get Dashboard Permissions api_response = api_instance.dashboard_permissions(workspace_id, dashboard_id) + print("The response of PermissionsApi->dashboard_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->dashboard_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **dashboard_id** | **str**| | + **workspace_id** | **str**| | + **dashboard_id** | **str**| | ### Return type @@ -145,7 +148,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -155,7 +157,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_organization_permissions** -> [DeclarativeOrganizationPermission] get_organization_permissions() +> List[DeclarativeOrganizationPermission] get_organization_permissions() Get organization permissions @@ -165,11 +167,11 @@ Retrieve organization permissions ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -178,26 +180,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) + api_instance = gooddata_api_client.PermissionsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get organization permissions api_response = api_instance.get_organization_permissions() + print("The response of PermissionsApi->get_organization_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->get_organization_permissions: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -[**[DeclarativeOrganizationPermission]**](DeclarativeOrganizationPermission.md) +[**List[DeclarativeOrganizationPermission]**](DeclarativeOrganizationPermission.md) ### Authorization @@ -208,7 +212,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -228,11 +231,11 @@ Retrieve current set of permissions of the user-group in a declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -241,26 +244,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - user_group_id = "userGroupId_example" # str | + api_instance = gooddata_api_client.PermissionsApi(api_client) + user_group_id = 'user_group_id_example' # str | - # example passing only required values which don't have defaults set try: # Get permissions for the user-group api_response = api_instance.get_user_group_permissions(user_group_id) + print("The response of PermissionsApi->get_user_group_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->get_user_group_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_group_id** | **str**| | + **user_group_id** | **str**| | ### Return type @@ -275,7 +280,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -295,11 +299,11 @@ Retrieve current set of permissions of the user in a declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -308,26 +312,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - user_id = "userId_example" # str | + api_instance = gooddata_api_client.PermissionsApi(api_client) + user_id = 'user_id_example' # str | - # example passing only required values which don't have defaults set try: # Get permissions for the user api_response = api_instance.get_user_permissions(user_id) + print("The response of PermissionsApi->get_user_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->get_user_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | + **user_id** | **str**| | ### Return type @@ -342,7 +348,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -362,11 +367,11 @@ Retrieve current set of permissions of the workspace in a declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -375,26 +380,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.PermissionsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Get permissions for the workspace api_response = api_instance.get_workspace_permissions(workspace_id) + print("The response of PermissionsApi->get_workspace_permissions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->get_workspace_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type @@ -409,7 +416,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -427,11 +433,11 @@ Manage Permissions for a Dashboard ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.models.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -440,31 +446,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - workspace_id = "workspaceId_example" # str | - dashboard_id = "dashboardId_example" # str | - manage_dashboard_permissions_request_inner = [ - ManageDashboardPermissionsRequestInner(None), - ] # [ManageDashboardPermissionsRequestInner] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.PermissionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + dashboard_id = 'dashboard_id_example' # str | + manage_dashboard_permissions_request_inner = [gooddata_api_client.ManageDashboardPermissionsRequestInner()] # List[ManageDashboardPermissionsRequestInner] | + try: # Manage Permissions for a Dashboard api_instance.manage_dashboard_permissions(workspace_id, dashboard_id, manage_dashboard_permissions_request_inner) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->manage_dashboard_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **dashboard_id** | **str**| | - **manage_dashboard_permissions_request_inner** | [**[ManageDashboardPermissionsRequestInner]**](ManageDashboardPermissionsRequestInner.md)| | + **workspace_id** | **str**| | + **dashboard_id** | **str**| | + **manage_dashboard_permissions_request_inner** | [**List[ManageDashboardPermissionsRequestInner]**](ManageDashboardPermissionsRequestInner.md)| | ### Return type @@ -479,7 +484,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -499,11 +503,11 @@ Manage Permissions for a Data Source ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment +from gooddata_api_client.models.data_source_permission_assignment import DataSourcePermissionAssignment +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -512,37 +516,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - data_source_id = "dataSourceId_example" # str | - data_source_permission_assignment = [ - DataSourcePermissionAssignment( - assignee_identifier=AssigneeIdentifier( - id="id_example", - type="user", - ), - permissions=[ - "MANAGE", - ], - ), - ] # [DataSourcePermissionAssignment] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.PermissionsApi(api_client) + data_source_id = 'data_source_id_example' # str | + data_source_permission_assignment = [gooddata_api_client.DataSourcePermissionAssignment()] # List[DataSourcePermissionAssignment] | + try: # Manage Permissions for a Data Source api_instance.manage_data_source_permissions(data_source_id, data_source_permission_assignment) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->manage_data_source_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| | - **data_source_permission_assignment** | [**[DataSourcePermissionAssignment]**](DataSourcePermissionAssignment.md)| | + **data_source_id** | **str**| | + **data_source_permission_assignment** | [**List[DataSourcePermissionAssignment]**](DataSourcePermissionAssignment.md)| | ### Return type @@ -557,7 +552,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -577,11 +571,11 @@ Manage Permissions for a Organization ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment +from gooddata_api_client.models.organization_permission_assignment import OrganizationPermissionAssignment +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -590,35 +584,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - organization_permission_assignment = [ - OrganizationPermissionAssignment( - assignee_identifier=AssigneeIdentifier( - id="id_example", - type="user", - ), - permissions=[ - "MANAGE", - ], - ), - ] # [OrganizationPermissionAssignment] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.PermissionsApi(api_client) + organization_permission_assignment = [gooddata_api_client.OrganizationPermissionAssignment()] # List[OrganizationPermissionAssignment] | + try: # Manage Permissions for a Organization api_instance.manage_organization_permissions(organization_permission_assignment) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->manage_organization_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organization_permission_assignment** | [**[OrganizationPermissionAssignment]**](OrganizationPermissionAssignment.md)| | + **organization_permission_assignment** | [**List[OrganizationPermissionAssignment]**](OrganizationPermissionAssignment.md)| | ### Return type @@ -633,7 +618,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -653,11 +637,11 @@ Manage Permissions for a Workspace and its Workspace Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment +from gooddata_api_client.models.workspace_permission_assignment import WorkspacePermissionAssignment +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -666,40 +650,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - workspace_id = "workspaceId_example" # str | - workspace_permission_assignment = [ - WorkspacePermissionAssignment( - assignee_identifier=AssigneeIdentifier( - id="id_example", - type="user", - ), - hierarchy_permissions=[ - "MANAGE", - ], - permissions=[ - "MANAGE", - ], - ), - ] # [WorkspacePermissionAssignment] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.PermissionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + workspace_permission_assignment = [gooddata_api_client.WorkspacePermissionAssignment()] # List[WorkspacePermissionAssignment] | + try: # Manage Permissions for a Workspace api_instance.manage_workspace_permissions(workspace_id, workspace_permission_assignment) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->manage_workspace_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **workspace_permission_assignment** | [**[WorkspacePermissionAssignment]**](WorkspacePermissionAssignment.md)| | + **workspace_id** | **str**| | + **workspace_permission_assignment** | [**List[WorkspacePermissionAssignment]**](WorkspacePermissionAssignment.md)| | ### Return type @@ -714,7 +686,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -734,11 +705,11 @@ Sets organization permissions ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -747,33 +718,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - declarative_organization_permission = [ - DeclarativeOrganizationPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ] # [DeclarativeOrganizationPermission] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.PermissionsApi(api_client) + declarative_organization_permission = [gooddata_api_client.DeclarativeOrganizationPermission()] # List[DeclarativeOrganizationPermission] | + try: # Set organization permissions api_instance.set_organization_permissions(declarative_organization_permission) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->set_organization_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_organization_permission** | [**[DeclarativeOrganizationPermission]**](DeclarativeOrganizationPermission.md)| | + **declarative_organization_permission** | [**List[DeclarativeOrganizationPermission]**](DeclarativeOrganizationPermission.md)| | ### Return type @@ -788,7 +752,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -808,11 +771,11 @@ Set effective permissions for the user-group ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -821,37 +784,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - user_group_id = "userGroupId_example" # str | - declarative_user_group_permissions = DeclarativeUserGroupPermissions( - permissions=[ - DeclarativeUserGroupPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - ) # DeclarativeUserGroupPermissions | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.PermissionsApi(api_client) + user_group_id = 'user_group_id_example' # str | + declarative_user_group_permissions = gooddata_api_client.DeclarativeUserGroupPermissions() # DeclarativeUserGroupPermissions | + try: # Set permissions for the user-group api_instance.set_user_group_permissions(user_group_id, declarative_user_group_permissions) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->set_user_group_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_group_id** | **str**| | - **declarative_user_group_permissions** | [**DeclarativeUserGroupPermissions**](DeclarativeUserGroupPermissions.md)| | + **user_group_id** | **str**| | + **declarative_user_group_permissions** | [**DeclarativeUserGroupPermissions**](DeclarativeUserGroupPermissions.md)| | ### Return type @@ -866,7 +820,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -886,11 +839,11 @@ Set effective permissions for the user ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -899,37 +852,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - user_id = "userId_example" # str | - declarative_user_permissions = DeclarativeUserPermissions( - permissions=[ - DeclarativeUserPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - ) # DeclarativeUserPermissions | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.PermissionsApi(api_client) + user_id = 'user_id_example' # str | + declarative_user_permissions = gooddata_api_client.DeclarativeUserPermissions() # DeclarativeUserPermissions | + try: # Set permissions for the user api_instance.set_user_permissions(user_id, declarative_user_permissions) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->set_user_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **declarative_user_permissions** | [**DeclarativeUserPermissions**](DeclarativeUserPermissions.md)| | + **user_id** | **str**| | + **declarative_user_permissions** | [**DeclarativeUserPermissions**](DeclarativeUserPermissions.md)| | ### Return type @@ -944,7 +888,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -964,11 +907,11 @@ Set effective permissions for the workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import permissions_api -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -977,46 +920,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = permissions_api.PermissionsApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_workspace_permissions = DeclarativeWorkspacePermissions( - hierarchy_permissions=[ - DeclarativeWorkspaceHierarchyPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - permissions=[ - DeclarativeSingleWorkspacePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - ) # DeclarativeWorkspacePermissions | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.PermissionsApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_workspace_permissions = gooddata_api_client.DeclarativeWorkspacePermissions() # DeclarativeWorkspacePermissions | + try: # Set permissions for the workspace api_instance.set_workspace_permissions(workspace_id, declarative_workspace_permissions) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PermissionsApi->set_workspace_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_workspace_permissions** | [**DeclarativeWorkspacePermissions**](DeclarativeWorkspacePermissions.md)| | + **workspace_id** | **str**| | + **declarative_workspace_permissions** | [**DeclarativeWorkspacePermissions**](DeclarativeWorkspacePermissions.md)| | ### Return type @@ -1031,7 +956,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/PermissionsAssignment.md b/gooddata-api-client/docs/PermissionsAssignment.md index c9acd8a7f..30df3cecf 100644 --- a/gooddata-api-client/docs/PermissionsAssignment.md +++ b/gooddata-api-client/docs/PermissionsAssignment.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**assignees** | [**[AssigneeIdentifier]**](AssigneeIdentifier.md) | | -**data_sources** | [**[UserManagementDataSourcePermissionAssignment]**](UserManagementDataSourcePermissionAssignment.md) | | [optional] -**workspaces** | [**[UserManagementWorkspacePermissionAssignment]**](UserManagementWorkspacePermissionAssignment.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**assignees** | [**List[AssigneeIdentifier]**](AssigneeIdentifier.md) | | +**data_sources** | [**List[UserManagementDataSourcePermissionAssignment]**](UserManagementDataSourcePermissionAssignment.md) | | [optional] +**workspaces** | [**List[UserManagementWorkspacePermissionAssignment]**](UserManagementWorkspacePermissionAssignment.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.permissions_assignment import PermissionsAssignment + +# TODO update the JSON string below +json = "{}" +# create an instance of PermissionsAssignment from a JSON string +permissions_assignment_instance = PermissionsAssignment.from_json(json) +# print the JSON string representation of the object +print(PermissionsAssignment.to_json()) +# convert the object into a dict +permissions_assignment_dict = permissions_assignment_instance.to_dict() +# create an instance of PermissionsAssignment from a dict +permissions_assignment_from_dict = PermissionsAssignment.from_dict(permissions_assignment_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PermissionsForAssignee.md b/gooddata-api-client/docs/PermissionsForAssignee.md index 9d9f840b1..f3080438d 100644 --- a/gooddata-api-client/docs/PermissionsForAssignee.md +++ b/gooddata-api-client/docs/PermissionsForAssignee.md @@ -3,12 +3,29 @@ Desired levels of permissions for an assignee identified by an identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permissions** | **[str]** | | +**permissions** | **List[str]** | | **assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.permissions_for_assignee import PermissionsForAssignee + +# TODO update the JSON string below +json = "{}" +# create an instance of PermissionsForAssignee from a JSON string +permissions_for_assignee_instance = PermissionsForAssignee.from_json(json) +# print the JSON string representation of the object +print(PermissionsForAssignee.to_json()) + +# convert the object into a dict +permissions_for_assignee_dict = permissions_for_assignee_instance.to_dict() +# create an instance of PermissionsForAssignee from a dict +permissions_for_assignee_from_dict = PermissionsForAssignee.from_dict(permissions_for_assignee_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PermissionsForAssigneeAllOf.md b/gooddata-api-client/docs/PermissionsForAssigneeAllOf.md deleted file mode 100644 index 91f1bf02b..000000000 --- a/gooddata-api-client/docs/PermissionsForAssigneeAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# PermissionsForAssigneeAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/PermissionsForAssigneeRule.md b/gooddata-api-client/docs/PermissionsForAssigneeRule.md index 25029abb9..b039e3b2a 100644 --- a/gooddata-api-client/docs/PermissionsForAssigneeRule.md +++ b/gooddata-api-client/docs/PermissionsForAssigneeRule.md @@ -3,12 +3,29 @@ Desired levels of permissions for a collection of assignees identified by a rule. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permissions** | **[str]** | | +**permissions** | **List[str]** | | **assignee_rule** | [**AssigneeRule**](AssigneeRule.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.permissions_for_assignee_rule import PermissionsForAssigneeRule + +# TODO update the JSON string below +json = "{}" +# create an instance of PermissionsForAssigneeRule from a JSON string +permissions_for_assignee_rule_instance = PermissionsForAssigneeRule.from_json(json) +# print the JSON string representation of the object +print(PermissionsForAssigneeRule.to_json()) + +# convert the object into a dict +permissions_for_assignee_rule_dict = permissions_for_assignee_rule_instance.to_dict() +# create an instance of PermissionsForAssigneeRule from a dict +permissions_for_assignee_rule_from_dict = PermissionsForAssigneeRule.from_dict(permissions_for_assignee_rule_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PlatformUsage.md b/gooddata-api-client/docs/PlatformUsage.md index e77ec532e..56a4b7bfa 100644 --- a/gooddata-api-client/docs/PlatformUsage.md +++ b/gooddata-api-client/docs/PlatformUsage.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | | **count** | **int** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**name** | **str** | | + +## Example + +```python +from gooddata_api_client.models.platform_usage import PlatformUsage + +# TODO update the JSON string below +json = "{}" +# create an instance of PlatformUsage from a JSON string +platform_usage_instance = PlatformUsage.from_json(json) +# print the JSON string representation of the object +print(PlatformUsage.to_json()) +# convert the object into a dict +platform_usage_dict = platform_usage_instance.to_dict() +# create an instance of PlatformUsage from a dict +platform_usage_from_dict = PlatformUsage.from_dict(platform_usage_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PlatformUsageRequest.md b/gooddata-api-client/docs/PlatformUsageRequest.md index 9ca868b5f..66ac73c4a 100644 --- a/gooddata-api-client/docs/PlatformUsageRequest.md +++ b/gooddata-api-client/docs/PlatformUsageRequest.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**usage_item_names** | **[str]** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**usage_item_names** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.platform_usage_request import PlatformUsageRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of PlatformUsageRequest from a JSON string +platform_usage_request_instance = PlatformUsageRequest.from_json(json) +# print the JSON string representation of the object +print(PlatformUsageRequest.to_json()) +# convert the object into a dict +platform_usage_request_dict = platform_usage_request_instance.to_dict() +# create an instance of PlatformUsageRequest from a dict +platform_usage_request_from_dict = PlatformUsageRequest.from_dict(platform_usage_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PluginsApi.md b/gooddata-api-client/docs/PluginsApi.md index 4bb541404..7548ce3cd 100644 --- a/gooddata-api-client/docs/PluginsApi.md +++ b/gooddata-api-client/docs/PluginsApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **create_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document) +> JsonApiDashboardPluginOutDocument create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, include=include, meta_include=meta_include) Post Plugins @@ -21,12 +21,12 @@ Post Plugins ```python -import time import gooddata_api_client -from gooddata_api_client.api import plugins_api -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -35,59 +35,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = plugins_api.PluginsApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_dashboard_plugin_post_optional_id_document = JsonApiDashboardPluginPostOptionalIdDocument( - data=JsonApiDashboardPluginPostOptionalId( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Plugins - api_response = api_instance.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling PluginsApi->create_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.PluginsApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_dashboard_plugin_post_optional_id_document = gooddata_api_client.JsonApiDashboardPluginPostOptionalIdDocument() # JsonApiDashboardPluginPostOptionalIdDocument | + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Plugins api_response = api_instance.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of PluginsApi->create_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PluginsApi->create_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_dashboard_plugin_post_optional_id_document** | [**JsonApiDashboardPluginPostOptionalIdDocument**](JsonApiDashboardPluginPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_dashboard_plugin_post_optional_id_document** | [**JsonApiDashboardPluginPostOptionalIdDocument**](JsonApiDashboardPluginPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -102,7 +77,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -112,7 +86,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_dashboard_plugins** -> delete_entity_dashboard_plugins(workspace_id, object_id) +> delete_entity_dashboard_plugins(workspace_id, object_id, filter=filter) Delete a Plugin @@ -120,10 +94,10 @@ Delete a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import plugins_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -132,37 +106,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = plugins_api.PluginsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Plugin - api_instance.delete_entity_dashboard_plugins(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling PluginsApi->delete_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.PluginsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Plugin api_instance.delete_entity_dashboard_plugins(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PluginsApi->delete_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -177,7 +144,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -187,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_dashboard_plugins** -> JsonApiDashboardPluginOutList get_all_entities_dashboard_plugins(workspace_id) +> JsonApiDashboardPluginOutList get_all_entities_dashboard_plugins(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Plugins @@ -195,11 +161,11 @@ Get all Plugins ```python -import time import gooddata_api_client -from gooddata_api_client.api import plugins_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -208,57 +174,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = plugins_api.PluginsApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Plugins - api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling PluginsApi->get_all_entities_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.PluginsApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Plugins api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of PluginsApi->get_all_entities_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PluginsApi->get_all_entities_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -273,7 +226,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -283,7 +235,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument get_entity_dashboard_plugins(workspace_id, object_id) +> JsonApiDashboardPluginOutDocument get_entity_dashboard_plugins(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Plugin @@ -291,11 +243,11 @@ Get a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import plugins_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -304,49 +256,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = plugins_api.PluginsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Plugin - api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling PluginsApi->get_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.PluginsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Plugin api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of PluginsApi->get_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PluginsApi->get_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -361,7 +302,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -371,7 +311,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) +> JsonApiDashboardPluginOutDocument patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, filter=filter, include=include) Patch a Plugin @@ -379,12 +319,12 @@ Patch a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import plugins_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -393,59 +333,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = plugins_api.PluginsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_dashboard_plugin_patch_document = JsonApiDashboardPluginPatchDocument( - data=JsonApiDashboardPluginPatch( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Plugin - api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling PluginsApi->patch_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.PluginsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_dashboard_plugin_patch_document = gooddata_api_client.JsonApiDashboardPluginPatchDocument() # JsonApiDashboardPluginPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Plugin api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, filter=filter, include=include) + print("The response of PluginsApi->patch_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PluginsApi->patch_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_dashboard_plugin_patch_document** | [**JsonApiDashboardPluginPatchDocument**](JsonApiDashboardPluginPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_dashboard_plugin_patch_document** | [**JsonApiDashboardPluginPatchDocument**](JsonApiDashboardPluginPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -460,7 +377,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -470,7 +386,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) +> JsonApiDashboardPluginOutDocument update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, filter=filter, include=include) Put a Plugin @@ -478,12 +394,12 @@ Put a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import plugins_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -492,59 +408,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = plugins_api.PluginsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_dashboard_plugin_in_document = JsonApiDashboardPluginInDocument( - data=JsonApiDashboardPluginIn( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Plugin - api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling PluginsApi->update_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.PluginsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_dashboard_plugin_in_document = gooddata_api_client.JsonApiDashboardPluginInDocument() # JsonApiDashboardPluginInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Plugin api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, filter=filter, include=include) + print("The response of PluginsApi->update_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling PluginsApi->update_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_dashboard_plugin_in_document** | [**JsonApiDashboardPluginInDocument**](JsonApiDashboardPluginInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_dashboard_plugin_in_document** | [**JsonApiDashboardPluginInDocument**](JsonApiDashboardPluginInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -559,7 +452,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/PopDataset.md b/gooddata-api-client/docs/PopDataset.md index 4ddba96cc..298872351 100644 --- a/gooddata-api-client/docs/PopDataset.md +++ b/gooddata-api-client/docs/PopDataset.md @@ -3,12 +3,29 @@ Combination of the date data set to use and how many periods ago to calculate the previous period for. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dataset** | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | | **periods_ago** | **int** | Number of periods ago to calculate the previous period for. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.pop_dataset import PopDataset + +# TODO update the JSON string below +json = "{}" +# create an instance of PopDataset from a JSON string +pop_dataset_instance = PopDataset.from_json(json) +# print the JSON string representation of the object +print(PopDataset.to_json()) + +# convert the object into a dict +pop_dataset_dict = pop_dataset_instance.to_dict() +# create an instance of PopDataset from a dict +pop_dataset_from_dict = PopDataset.from_dict(pop_dataset_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PopDatasetMeasureDefinition.md b/gooddata-api-client/docs/PopDatasetMeasureDefinition.md index 4ffa00d4a..f85c371af 100644 --- a/gooddata-api-client/docs/PopDatasetMeasureDefinition.md +++ b/gooddata-api-client/docs/PopDatasetMeasureDefinition.md @@ -3,11 +3,28 @@ Previous period type of metric. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **previous_period_measure** | [**PopDatasetMeasureDefinitionPreviousPeriodMeasure**](PopDatasetMeasureDefinitionPreviousPeriodMeasure.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.pop_dataset_measure_definition import PopDatasetMeasureDefinition + +# TODO update the JSON string below +json = "{}" +# create an instance of PopDatasetMeasureDefinition from a JSON string +pop_dataset_measure_definition_instance = PopDatasetMeasureDefinition.from_json(json) +# print the JSON string representation of the object +print(PopDatasetMeasureDefinition.to_json()) + +# convert the object into a dict +pop_dataset_measure_definition_dict = pop_dataset_measure_definition_instance.to_dict() +# create an instance of PopDatasetMeasureDefinition from a dict +pop_dataset_measure_definition_from_dict = PopDatasetMeasureDefinition.from_dict(pop_dataset_measure_definition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PopDatasetMeasureDefinitionPreviousPeriodMeasure.md b/gooddata-api-client/docs/PopDatasetMeasureDefinitionPreviousPeriodMeasure.md index 1c69a1c35..ac5f0cc6d 100644 --- a/gooddata-api-client/docs/PopDatasetMeasureDefinitionPreviousPeriodMeasure.md +++ b/gooddata-api-client/docs/PopDatasetMeasureDefinitionPreviousPeriodMeasure.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**date_datasets** | [**[PopDataset]**](PopDataset.md) | Specification of which date data sets to use for determining the period to calculate the previous period for. | +**date_datasets** | [**List[PopDataset]**](PopDataset.md) | Specification of which date data sets to use for determining the period to calculate the previous period for. | **measure_identifier** | [**AfmLocalIdentifier**](AfmLocalIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.pop_dataset_measure_definition_previous_period_measure import PopDatasetMeasureDefinitionPreviousPeriodMeasure + +# TODO update the JSON string below +json = "{}" +# create an instance of PopDatasetMeasureDefinitionPreviousPeriodMeasure from a JSON string +pop_dataset_measure_definition_previous_period_measure_instance = PopDatasetMeasureDefinitionPreviousPeriodMeasure.from_json(json) +# print the JSON string representation of the object +print(PopDatasetMeasureDefinitionPreviousPeriodMeasure.to_json()) + +# convert the object into a dict +pop_dataset_measure_definition_previous_period_measure_dict = pop_dataset_measure_definition_previous_period_measure_instance.to_dict() +# create an instance of PopDatasetMeasureDefinitionPreviousPeriodMeasure from a dict +pop_dataset_measure_definition_previous_period_measure_from_dict = PopDatasetMeasureDefinitionPreviousPeriodMeasure.from_dict(pop_dataset_measure_definition_previous_period_measure_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PopDate.md b/gooddata-api-client/docs/PopDate.md index 8fae19a34..3b2b35ac6 100644 --- a/gooddata-api-client/docs/PopDate.md +++ b/gooddata-api-client/docs/PopDate.md @@ -3,12 +3,29 @@ Combination of the date attribute to use and how many periods ago to calculate the PoP for. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute** | [**AfmObjectIdentifierAttribute**](AfmObjectIdentifierAttribute.md) | | **periods_ago** | **int** | Number of periods ago to calculate the previous period for. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.pop_date import PopDate + +# TODO update the JSON string below +json = "{}" +# create an instance of PopDate from a JSON string +pop_date_instance = PopDate.from_json(json) +# print the JSON string representation of the object +print(PopDate.to_json()) + +# convert the object into a dict +pop_date_dict = pop_date_instance.to_dict() +# create an instance of PopDate from a dict +pop_date_from_dict = PopDate.from_dict(pop_date_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PopDateMeasureDefinition.md b/gooddata-api-client/docs/PopDateMeasureDefinition.md index c1ba87b35..88972197c 100644 --- a/gooddata-api-client/docs/PopDateMeasureDefinition.md +++ b/gooddata-api-client/docs/PopDateMeasureDefinition.md @@ -3,11 +3,28 @@ Period over period type of metric. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **over_period_measure** | [**PopDateMeasureDefinitionOverPeriodMeasure**](PopDateMeasureDefinitionOverPeriodMeasure.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.pop_date_measure_definition import PopDateMeasureDefinition + +# TODO update the JSON string below +json = "{}" +# create an instance of PopDateMeasureDefinition from a JSON string +pop_date_measure_definition_instance = PopDateMeasureDefinition.from_json(json) +# print the JSON string representation of the object +print(PopDateMeasureDefinition.to_json()) + +# convert the object into a dict +pop_date_measure_definition_dict = pop_date_measure_definition_instance.to_dict() +# create an instance of PopDateMeasureDefinition from a dict +pop_date_measure_definition_from_dict = PopDateMeasureDefinition.from_dict(pop_date_measure_definition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PopDateMeasureDefinitionOverPeriodMeasure.md b/gooddata-api-client/docs/PopDateMeasureDefinitionOverPeriodMeasure.md index 2c95b3909..cd6c95c1b 100644 --- a/gooddata-api-client/docs/PopDateMeasureDefinitionOverPeriodMeasure.md +++ b/gooddata-api-client/docs/PopDateMeasureDefinitionOverPeriodMeasure.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**date_attributes** | [**[PopDate]**](PopDate.md) | Attributes to use for determining the period to calculate the PoP for. | +**date_attributes** | [**List[PopDate]**](PopDate.md) | Attributes to use for determining the period to calculate the PoP for. | **measure_identifier** | [**AfmLocalIdentifier**](AfmLocalIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.pop_date_measure_definition_over_period_measure import PopDateMeasureDefinitionOverPeriodMeasure + +# TODO update the JSON string below +json = "{}" +# create an instance of PopDateMeasureDefinitionOverPeriodMeasure from a JSON string +pop_date_measure_definition_over_period_measure_instance = PopDateMeasureDefinitionOverPeriodMeasure.from_json(json) +# print the JSON string representation of the object +print(PopDateMeasureDefinitionOverPeriodMeasure.to_json()) + +# convert the object into a dict +pop_date_measure_definition_over_period_measure_dict = pop_date_measure_definition_over_period_measure_instance.to_dict() +# create an instance of PopDateMeasureDefinitionOverPeriodMeasure from a dict +pop_date_measure_definition_over_period_measure_from_dict = PopDateMeasureDefinitionOverPeriodMeasure.from_dict(pop_date_measure_definition_over_period_measure_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PopMeasureDefinition.md b/gooddata-api-client/docs/PopMeasureDefinition.md index cb0e1e379..809d8e8f2 100644 --- a/gooddata-api-client/docs/PopMeasureDefinition.md +++ b/gooddata-api-client/docs/PopMeasureDefinition.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**previous_period_measure** | [**PopDatasetMeasureDefinitionPreviousPeriodMeasure**](PopDatasetMeasureDefinitionPreviousPeriodMeasure.md) | | [optional] -**over_period_measure** | [**PopDateMeasureDefinitionOverPeriodMeasure**](PopDateMeasureDefinitionOverPeriodMeasure.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**previous_period_measure** | [**PopDatasetMeasureDefinitionPreviousPeriodMeasure**](PopDatasetMeasureDefinitionPreviousPeriodMeasure.md) | | +**over_period_measure** | [**PopDateMeasureDefinitionOverPeriodMeasure**](PopDateMeasureDefinitionOverPeriodMeasure.md) | | + +## Example + +```python +from gooddata_api_client.models.pop_measure_definition import PopMeasureDefinition + +# TODO update the JSON string below +json = "{}" +# create an instance of PopMeasureDefinition from a JSON string +pop_measure_definition_instance = PopMeasureDefinition.from_json(json) +# print the JSON string representation of the object +print(PopMeasureDefinition.to_json()) +# convert the object into a dict +pop_measure_definition_dict = pop_measure_definition_instance.to_dict() +# create an instance of PopMeasureDefinition from a dict +pop_measure_definition_from_dict = PopMeasureDefinition.from_dict(pop_measure_definition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PositiveAttributeFilter.md b/gooddata-api-client/docs/PositiveAttributeFilter.md index 2a85e13e0..9bd4a3107 100644 --- a/gooddata-api-client/docs/PositiveAttributeFilter.md +++ b/gooddata-api-client/docs/PositiveAttributeFilter.md @@ -3,11 +3,28 @@ Filter able to limit element values by label and related selected elements. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.positive_attribute_filter import PositiveAttributeFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of PositiveAttributeFilter from a JSON string +positive_attribute_filter_instance = PositiveAttributeFilter.from_json(json) +# print the JSON string representation of the object +print(PositiveAttributeFilter.to_json()) + +# convert the object into a dict +positive_attribute_filter_dict = positive_attribute_filter_instance.to_dict() +# create an instance of PositiveAttributeFilter from a dict +positive_attribute_filter_from_dict = PositiveAttributeFilter.from_dict(positive_attribute_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PositiveAttributeFilterPositiveAttributeFilter.md b/gooddata-api-client/docs/PositiveAttributeFilterPositiveAttributeFilter.md index 131dd44f5..34a76da91 100644 --- a/gooddata-api-client/docs/PositiveAttributeFilterPositiveAttributeFilter.md +++ b/gooddata-api-client/docs/PositiveAttributeFilterPositiveAttributeFilter.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_in** | [**AttributeFilterElements**](AttributeFilterElements.md) | | -**label** | [**AfmIdentifier**](AfmIdentifier.md) | | **apply_on_result** | **bool** | | [optional] +**var_in** | [**AttributeFilterElements**](AttributeFilterElements.md) | | +**label** | [**AfmIdentifier**](AfmIdentifier.md) | | **local_identifier** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of PositiveAttributeFilterPositiveAttributeFilter from a JSON string +positive_attribute_filter_positive_attribute_filter_instance = PositiveAttributeFilterPositiveAttributeFilter.from_json(json) +# print the JSON string representation of the object +print(PositiveAttributeFilterPositiveAttributeFilter.to_json()) + +# convert the object into a dict +positive_attribute_filter_positive_attribute_filter_dict = positive_attribute_filter_positive_attribute_filter_instance.to_dict() +# create an instance of PositiveAttributeFilterPositiveAttributeFilter from a dict +positive_attribute_filter_positive_attribute_filter_from_dict = PositiveAttributeFilterPositiveAttributeFilter.from_dict(positive_attribute_filter_positive_attribute_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/QualityIssue.md b/gooddata-api-client/docs/QualityIssue.md index e4520e125..402d6ed33 100644 --- a/gooddata-api-client/docs/QualityIssue.md +++ b/gooddata-api-client/docs/QualityIssue.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **str** | | -**detail** | **{str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}** | | -**objects** | [**[QualityIssueObject]**](QualityIssueObject.md) | | +**detail** | **Dict[str, object]** | | +**objects** | [**List[QualityIssueObject]**](QualityIssueObject.md) | | **severity** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.quality_issue import QualityIssue + +# TODO update the JSON string below +json = "{}" +# create an instance of QualityIssue from a JSON string +quality_issue_instance = QualityIssue.from_json(json) +# print the JSON string representation of the object +print(QualityIssue.to_json()) + +# convert the object into a dict +quality_issue_dict = quality_issue_instance.to_dict() +# create an instance of QualityIssue from a dict +quality_issue_from_dict = QualityIssue.from_dict(quality_issue_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/QualityIssueObject.md b/gooddata-api-client/docs/QualityIssueObject.md index 73628533a..b5ebf7137 100644 --- a/gooddata-api-client/docs/QualityIssueObject.md +++ b/gooddata-api-client/docs/QualityIssueObject.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.quality_issue_object import QualityIssueObject + +# TODO update the JSON string below +json = "{}" +# create an instance of QualityIssueObject from a JSON string +quality_issue_object_instance = QualityIssueObject.from_json(json) +# print the JSON string representation of the object +print(QualityIssueObject.to_json()) + +# convert the object into a dict +quality_issue_object_dict = quality_issue_object_instance.to_dict() +# create an instance of QualityIssueObject from a dict +quality_issue_object_from_dict = QualityIssueObject.from_dict(quality_issue_object_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Range.md b/gooddata-api-client/docs/Range.md index c75b9fd80..51d5a0f02 100644 --- a/gooddata-api-client/docs/Range.md +++ b/gooddata-api-client/docs/Range.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_from** | [**Value**](Value.md) | | +**var_from** | [**Value**](Value.md) | | **measure** | [**LocalIdentifier**](LocalIdentifier.md) | | **operator** | **str** | | **to** | [**Value**](Value.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.range import Range + +# TODO update the JSON string below +json = "{}" +# create an instance of Range from a JSON string +range_instance = Range.from_json(json) +# print the JSON string representation of the object +print(Range.to_json()) + +# convert the object into a dict +range_dict = range_instance.to_dict() +# create an instance of Range from a dict +range_from_dict = Range.from_dict(range_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RangeMeasureValueFilter.md b/gooddata-api-client/docs/RangeMeasureValueFilter.md index 57e64a47d..4e343ce8d 100644 --- a/gooddata-api-client/docs/RangeMeasureValueFilter.md +++ b/gooddata-api-client/docs/RangeMeasureValueFilter.md @@ -3,11 +3,28 @@ Filter the result by comparing specified metric to given range of values. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.range_measure_value_filter import RangeMeasureValueFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of RangeMeasureValueFilter from a JSON string +range_measure_value_filter_instance = RangeMeasureValueFilter.from_json(json) +# print the JSON string representation of the object +print(RangeMeasureValueFilter.to_json()) + +# convert the object into a dict +range_measure_value_filter_dict = range_measure_value_filter_instance.to_dict() +# create an instance of RangeMeasureValueFilter from a dict +range_measure_value_filter_from_dict = RangeMeasureValueFilter.from_dict(range_measure_value_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RangeMeasureValueFilterRangeMeasureValueFilter.md b/gooddata-api-client/docs/RangeMeasureValueFilterRangeMeasureValueFilter.md index fed71711f..b86078787 100644 --- a/gooddata-api-client/docs/RangeMeasureValueFilterRangeMeasureValueFilter.md +++ b/gooddata-api-client/docs/RangeMeasureValueFilterRangeMeasureValueFilter.md @@ -2,18 +2,35 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_from** | **float** | | +**apply_on_result** | **bool** | | [optional] +**dimensionality** | [**List[AfmIdentifier]**](AfmIdentifier.md) | References to the attributes to be used when filtering. | [optional] +**var_from** | **float** | | +**local_identifier** | **str** | | [optional] **measure** | [**AfmIdentifier**](AfmIdentifier.md) | | **operator** | **str** | | **to** | **float** | | -**apply_on_result** | **bool** | | [optional] -**dimensionality** | [**[AfmIdentifier]**](AfmIdentifier.md) | References to the attributes to be used when filtering. | [optional] -**local_identifier** | **str** | | [optional] **treat_null_values_as** | **float** | A value that will be substituted for null values in the metric for the comparisons. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of RangeMeasureValueFilterRangeMeasureValueFilter from a JSON string +range_measure_value_filter_range_measure_value_filter_instance = RangeMeasureValueFilterRangeMeasureValueFilter.from_json(json) +# print the JSON string representation of the object +print(RangeMeasureValueFilterRangeMeasureValueFilter.to_json()) + +# convert the object into a dict +range_measure_value_filter_range_measure_value_filter_dict = range_measure_value_filter_range_measure_value_filter_instance.to_dict() +# create an instance of RangeMeasureValueFilterRangeMeasureValueFilter from a dict +range_measure_value_filter_range_measure_value_filter_from_dict = RangeMeasureValueFilterRangeMeasureValueFilter.from_dict(range_measure_value_filter_range_measure_value_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RangeWrapper.md b/gooddata-api-client/docs/RangeWrapper.md index 344dc4bd3..0172ba624 100644 --- a/gooddata-api-client/docs/RangeWrapper.md +++ b/gooddata-api-client/docs/RangeWrapper.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **range** | [**Range**](Range.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.range_wrapper import RangeWrapper + +# TODO update the JSON string below +json = "{}" +# create an instance of RangeWrapper from a JSON string +range_wrapper_instance = RangeWrapper.from_json(json) +# print the JSON string representation of the object +print(RangeWrapper.to_json()) + +# convert the object into a dict +range_wrapper_dict = range_wrapper_instance.to_dict() +# create an instance of RangeWrapper from a dict +range_wrapper_from_dict = RangeWrapper.from_dict(range_wrapper_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RankingFilter.md b/gooddata-api-client/docs/RankingFilter.md index 26511d7d2..95abfc7e3 100644 --- a/gooddata-api-client/docs/RankingFilter.md +++ b/gooddata-api-client/docs/RankingFilter.md @@ -3,11 +3,28 @@ Filter the result on top/bottom N values according to given metric(s). ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.ranking_filter import RankingFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of RankingFilter from a JSON string +ranking_filter_instance = RankingFilter.from_json(json) +# print the JSON string representation of the object +print(RankingFilter.to_json()) + +# convert the object into a dict +ranking_filter_dict = ranking_filter_instance.to_dict() +# create an instance of RankingFilter from a dict +ranking_filter_from_dict = RankingFilter.from_dict(ranking_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RankingFilterRankingFilter.md b/gooddata-api-client/docs/RankingFilterRankingFilter.md index d3b134682..ec42a3d49 100644 --- a/gooddata-api-client/docs/RankingFilterRankingFilter.md +++ b/gooddata-api-client/docs/RankingFilterRankingFilter.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**measures** | [**[AfmIdentifier]**](AfmIdentifier.md) | References to the metrics to be used when filtering. | -**operator** | **str** | The type of ranking to use, TOP or BOTTOM. | -**value** | **int** | Number of top/bottom values to filter. | **apply_on_result** | **bool** | | [optional] -**dimensionality** | [**[AfmIdentifier]**](AfmIdentifier.md) | References to the attributes to be used when filtering. | [optional] +**dimensionality** | [**List[AfmIdentifier]**](AfmIdentifier.md) | References to the attributes to be used when filtering. | [optional] **local_identifier** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**measures** | [**List[AfmIdentifier]**](AfmIdentifier.md) | References to the metrics to be used when filtering. | +**operator** | **str** | The type of ranking to use, TOP or BOTTOM. | +**value** | **int** | Number of top/bottom values to filter. | + +## Example + +```python +from gooddata_api_client.models.ranking_filter_ranking_filter import RankingFilterRankingFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of RankingFilterRankingFilter from a JSON string +ranking_filter_ranking_filter_instance = RankingFilterRankingFilter.from_json(json) +# print the JSON string representation of the object +print(RankingFilterRankingFilter.to_json()) +# convert the object into a dict +ranking_filter_ranking_filter_dict = ranking_filter_ranking_filter_instance.to_dict() +# create an instance of RankingFilterRankingFilter from a dict +ranking_filter_ranking_filter_from_dict = RankingFilterRankingFilter.from_dict(ranking_filter_ranking_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RawCustomLabel.md b/gooddata-api-client/docs/RawCustomLabel.md index 16608a50c..a6bec352a 100644 --- a/gooddata-api-client/docs/RawCustomLabel.md +++ b/gooddata-api-client/docs/RawCustomLabel.md @@ -3,11 +3,28 @@ Custom label object override. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **str** | Override value. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.raw_custom_label import RawCustomLabel + +# TODO update the JSON string below +json = "{}" +# create an instance of RawCustomLabel from a JSON string +raw_custom_label_instance = RawCustomLabel.from_json(json) +# print the JSON string representation of the object +print(RawCustomLabel.to_json()) + +# convert the object into a dict +raw_custom_label_dict = raw_custom_label_instance.to_dict() +# create an instance of RawCustomLabel from a dict +raw_custom_label_from_dict = RawCustomLabel.from_dict(raw_custom_label_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RawCustomMetric.md b/gooddata-api-client/docs/RawCustomMetric.md index 940e5050a..1e3ceade5 100644 --- a/gooddata-api-client/docs/RawCustomMetric.md +++ b/gooddata-api-client/docs/RawCustomMetric.md @@ -3,11 +3,28 @@ Custom metric object override. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **str** | Metric title override. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.raw_custom_metric import RawCustomMetric + +# TODO update the JSON string below +json = "{}" +# create an instance of RawCustomMetric from a JSON string +raw_custom_metric_instance = RawCustomMetric.from_json(json) +# print the JSON string representation of the object +print(RawCustomMetric.to_json()) + +# convert the object into a dict +raw_custom_metric_dict = raw_custom_metric_instance.to_dict() +# create an instance of RawCustomMetric from a dict +raw_custom_metric_from_dict = RawCustomMetric.from_dict(raw_custom_metric_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RawCustomOverride.md b/gooddata-api-client/docs/RawCustomOverride.md index b7484a5e8..9d1c9a5d6 100644 --- a/gooddata-api-client/docs/RawCustomOverride.md +++ b/gooddata-api-client/docs/RawCustomOverride.md @@ -3,12 +3,29 @@ Custom cell value overrides (IDs will be replaced with specified values). ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**labels** | [**{str: (RawCustomLabel,)}**](RawCustomLabel.md) | Map of CustomLabels with keys used as placeholders in export result. | [optional] -**metrics** | [**{str: (RawCustomMetric,)}**](RawCustomMetric.md) | Map of CustomMetrics with keys used as placeholders in export result. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**labels** | [**Dict[str, RawCustomLabel]**](RawCustomLabel.md) | Map of CustomLabels with keys used as placeholders in export result. | [optional] +**metrics** | [**Dict[str, RawCustomMetric]**](RawCustomMetric.md) | Map of CustomMetrics with keys used as placeholders in export result. | [optional] + +## Example + +```python +from gooddata_api_client.models.raw_custom_override import RawCustomOverride + +# TODO update the JSON string below +json = "{}" +# create an instance of RawCustomOverride from a JSON string +raw_custom_override_instance = RawCustomOverride.from_json(json) +# print the JSON string representation of the object +print(RawCustomOverride.to_json()) +# convert the object into a dict +raw_custom_override_dict = raw_custom_override_instance.to_dict() +# create an instance of RawCustomOverride from a dict +raw_custom_override_from_dict = RawCustomOverride.from_dict(raw_custom_override_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RawExportApi.md b/gooddata-api-client/docs/RawExportApi.md index 15c387eea..26ecdc8d6 100644 --- a/gooddata-api-client/docs/RawExportApi.md +++ b/gooddata-api-client/docs/RawExportApi.md @@ -19,12 +19,12 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import raw_export_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.raw_export_request import RawExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.raw_export_request import RawExportRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -33,76 +33,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = raw_export_api.RawExportApi(api_client) - workspace_id = "workspaceId_example" # str | - raw_export_request = RawExportRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - ) # RawExportRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.RawExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + raw_export_request = gooddata_api_client.RawExportRequest() # RawExportRequest | + try: # (EXPERIMENTAL) Create raw export request api_response = api_instance.create_raw_export(workspace_id, raw_export_request) + print("The response of RawExportApi->create_raw_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling RawExportApi->create_raw_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **raw_export_request** | [**RawExportRequest**](RawExportRequest.md)| | + **workspace_id** | **str**| | + **raw_export_request** | [**RawExportRequest**](RawExportRequest.md)| | ### Return type @@ -117,7 +71,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -127,7 +80,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_raw_export** -> file_type get_raw_export(workspace_id, export_id) +> bytearray get_raw_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -137,10 +90,10 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import raw_export_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -149,32 +102,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = raw_export_api.RawExportApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.RawExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files api_response = api_instance.get_raw_export(workspace_id, export_id) + print("The response of RawExportApi->get_raw_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling RawExportApi->get_raw_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -**file_type** +**bytearray** ### Authorization @@ -185,7 +140,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.apache.arrow.file, application/vnd.apache.arrow.stream, text/csv - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/RawExportAutomationRequest.md b/gooddata-api-client/docs/RawExportAutomationRequest.md index 2ed799995..25e3310b4 100644 --- a/gooddata-api-client/docs/RawExportAutomationRequest.md +++ b/gooddata-api-client/docs/RawExportAutomationRequest.md @@ -3,16 +3,33 @@ Export request object describing the export properties and overrides for raw exports. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**custom_override** | [**RawCustomOverride**](RawCustomOverride.md) | | [optional] **execution** | [**AFM**](AFM.md) | | +**execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] **file_name** | **str** | Filename of downloaded file without extension. | **format** | **str** | Requested resulting file type. | -**custom_override** | [**RawCustomOverride**](RawCustomOverride.md) | | [optional] -**execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] -**metadata** | [**JsonNode**](JsonNode.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**metadata** | **object** | Free-form JSON object | [optional] + +## Example + +```python +from gooddata_api_client.models.raw_export_automation_request import RawExportAutomationRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of RawExportAutomationRequest from a JSON string +raw_export_automation_request_instance = RawExportAutomationRequest.from_json(json) +# print the JSON string representation of the object +print(RawExportAutomationRequest.to_json()) +# convert the object into a dict +raw_export_automation_request_dict = raw_export_automation_request_instance.to_dict() +# create an instance of RawExportAutomationRequest from a dict +raw_export_automation_request_from_dict = RawExportAutomationRequest.from_dict(raw_export_automation_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RawExportRequest.md b/gooddata-api-client/docs/RawExportRequest.md index f5eb5467b..a54d42582 100644 --- a/gooddata-api-client/docs/RawExportRequest.md +++ b/gooddata-api-client/docs/RawExportRequest.md @@ -3,15 +3,32 @@ Export request object describing the export properties and overrides for raw exports. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**custom_override** | [**RawCustomOverride**](RawCustomOverride.md) | | [optional] **execution** | [**AFM**](AFM.md) | | +**execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] **file_name** | **str** | Filename of downloaded file without extension. | **format** | **str** | Requested resulting file type. | -**custom_override** | [**RawCustomOverride**](RawCustomOverride.md) | | [optional] -**execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.raw_export_request import RawExportRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of RawExportRequest from a JSON string +raw_export_request_instance = RawExportRequest.from_json(json) +# print the JSON string representation of the object +print(RawExportRequest.to_json()) + +# convert the object into a dict +raw_export_request_dict = raw_export_request_instance.to_dict() +# create an instance of RawExportRequest from a dict +raw_export_request_from_dict = RawExportRequest.from_dict(raw_export_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ReferenceIdentifier.md b/gooddata-api-client/docs/ReferenceIdentifier.md index 5a9a4449e..a3d8b5df7 100644 --- a/gooddata-api-client/docs/ReferenceIdentifier.md +++ b/gooddata-api-client/docs/ReferenceIdentifier.md @@ -3,12 +3,29 @@ A reference identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Reference ID. | -**type** | **str** | A type of the reference. | defaults to "dataset" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | A type of the reference. | + +## Example + +```python +from gooddata_api_client.models.reference_identifier import ReferenceIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of ReferenceIdentifier from a JSON string +reference_identifier_instance = ReferenceIdentifier.from_json(json) +# print the JSON string representation of the object +print(ReferenceIdentifier.to_json()) +# convert the object into a dict +reference_identifier_dict = reference_identifier_instance.to_dict() +# create an instance of ReferenceIdentifier from a dict +reference_identifier_from_dict = ReferenceIdentifier.from_dict(reference_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ReferenceSourceColumn.md b/gooddata-api-client/docs/ReferenceSourceColumn.md index 7de996605..f1df4c0b5 100644 --- a/gooddata-api-client/docs/ReferenceSourceColumn.md +++ b/gooddata-api-client/docs/ReferenceSourceColumn.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **column** | **str** | | -**target** | [**DatasetGrain**](DatasetGrain.md) | | **data_type** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**target** | [**DatasetGrain**](DatasetGrain.md) | | + +## Example + +```python +from gooddata_api_client.models.reference_source_column import ReferenceSourceColumn + +# TODO update the JSON string below +json = "{}" +# create an instance of ReferenceSourceColumn from a JSON string +reference_source_column_instance = ReferenceSourceColumn.from_json(json) +# print the JSON string representation of the object +print(ReferenceSourceColumn.to_json()) +# convert the object into a dict +reference_source_column_dict = reference_source_column_instance.to_dict() +# create an instance of ReferenceSourceColumn from a dict +reference_source_column_from_dict = ReferenceSourceColumn.from_dict(reference_source_column_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Relative.md b/gooddata-api-client/docs/Relative.md index 53b65f279..52f172e6e 100644 --- a/gooddata-api-client/docs/Relative.md +++ b/gooddata-api-client/docs/Relative.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **measure** | [**ArithmeticMeasure**](ArithmeticMeasure.md) | | **operator** | **str** | Relative condition operator. INCREASES_BY - the metric increases by the specified value. DECREASES_BY - the metric decreases by the specified value. CHANGES_BY - the metric increases or decreases by the specified value. | **threshold** | [**Value**](Value.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.relative import Relative + +# TODO update the JSON string below +json = "{}" +# create an instance of Relative from a JSON string +relative_instance = Relative.from_json(json) +# print the JSON string representation of the object +print(Relative.to_json()) + +# convert the object into a dict +relative_dict = relative_instance.to_dict() +# create an instance of Relative from a dict +relative_from_dict = Relative.from_dict(relative_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RelativeBoundedDateFilter.md b/gooddata-api-client/docs/RelativeBoundedDateFilter.md index 10dc6d766..417fbe0ed 100644 --- a/gooddata-api-client/docs/RelativeBoundedDateFilter.md +++ b/gooddata-api-client/docs/RelativeBoundedDateFilter.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**var_from** | **int** | | [optional] **granularity** | **str** | | -**_from** | **int** | | [optional] **to** | **int** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.relative_bounded_date_filter import RelativeBoundedDateFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of RelativeBoundedDateFilter from a JSON string +relative_bounded_date_filter_instance = RelativeBoundedDateFilter.from_json(json) +# print the JSON string representation of the object +print(RelativeBoundedDateFilter.to_json()) + +# convert the object into a dict +relative_bounded_date_filter_dict = relative_bounded_date_filter_instance.to_dict() +# create an instance of RelativeBoundedDateFilter from a dict +relative_bounded_date_filter_from_dict = RelativeBoundedDateFilter.from_dict(relative_bounded_date_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RelativeDateFilter.md b/gooddata-api-client/docs/RelativeDateFilter.md index 08457fe92..164014c23 100644 --- a/gooddata-api-client/docs/RelativeDateFilter.md +++ b/gooddata-api-client/docs/RelativeDateFilter.md @@ -3,11 +3,28 @@ A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.relative_date_filter import RelativeDateFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of RelativeDateFilter from a JSON string +relative_date_filter_instance = RelativeDateFilter.from_json(json) +# print the JSON string representation of the object +print(RelativeDateFilter.to_json()) + +# convert the object into a dict +relative_date_filter_dict = relative_date_filter_instance.to_dict() +# create an instance of RelativeDateFilter from a dict +relative_date_filter_from_dict = RelativeDateFilter.from_dict(relative_date_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md b/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md index eca210716..0d10d30ad 100644 --- a/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md +++ b/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md @@ -2,17 +2,34 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dataset** | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | | -**_from** | **int** | Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). | -**granularity** | **str** | Date granularity specifying particular date attribute in given dimension. | -**to** | **int** | End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). | **apply_on_result** | **bool** | | [optional] **bounded_filter** | [**BoundedFilter**](BoundedFilter.md) | | [optional] +**dataset** | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | | +**var_from** | **int** | Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). | +**granularity** | **str** | Date granularity specifying particular date attribute in given dimension. | **local_identifier** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**to** | **int** | End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). | + +## Example + +```python +from gooddata_api_client.models.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of RelativeDateFilterRelativeDateFilter from a JSON string +relative_date_filter_relative_date_filter_instance = RelativeDateFilterRelativeDateFilter.from_json(json) +# print the JSON string representation of the object +print(RelativeDateFilterRelativeDateFilter.to_json()) +# convert the object into a dict +relative_date_filter_relative_date_filter_dict = relative_date_filter_relative_date_filter_instance.to_dict() +# create an instance of RelativeDateFilterRelativeDateFilter from a dict +relative_date_filter_relative_date_filter_from_dict = RelativeDateFilterRelativeDateFilter.from_dict(relative_date_filter_relative_date_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RelativeWrapper.md b/gooddata-api-client/docs/RelativeWrapper.md index 1baff6884..5595d6fad 100644 --- a/gooddata-api-client/docs/RelativeWrapper.md +++ b/gooddata-api-client/docs/RelativeWrapper.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **relative** | [**Relative**](Relative.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.relative_wrapper import RelativeWrapper + +# TODO update the JSON string below +json = "{}" +# create an instance of RelativeWrapper from a JSON string +relative_wrapper_instance = RelativeWrapper.from_json(json) +# print the JSON string representation of the object +print(RelativeWrapper.to_json()) + +# convert the object into a dict +relative_wrapper_dict = relative_wrapper_instance.to_dict() +# create an instance of RelativeWrapper from a dict +relative_wrapper_from_dict = RelativeWrapper.from_dict(relative_wrapper_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ReportingSettingsApi.md b/gooddata-api-client/docs/ReportingSettingsApi.md index 5e68f9b9f..055409c24 100644 --- a/gooddata-api-client/docs/ReportingSettingsApi.md +++ b/gooddata-api-client/docs/ReportingSettingsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **resolve_all_settings_without_workspace** -> [ResolvedSetting] resolve_all_settings_without_workspace() +> List[ResolvedSetting] resolve_all_settings_without_workspace() Values for all settings without workspace. @@ -19,11 +19,11 @@ Resolves values for all settings without workspace by current user, organization ```python -import time import gooddata_api_client -from gooddata_api_client.api import reporting_settings_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -32,26 +32,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = reporting_settings_api.ReportingSettingsApi(api_client) + api_instance = gooddata_api_client.ReportingSettingsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Values for all settings without workspace. api_response = api_instance.resolve_all_settings_without_workspace() + print("The response of ReportingSettingsApi->resolve_all_settings_without_workspace:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ReportingSettingsApi->resolve_all_settings_without_workspace: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -[**[ResolvedSetting]**](ResolvedSetting.md) +[**List[ResolvedSetting]**](ResolvedSetting.md) ### Authorization @@ -62,7 +64,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -72,7 +73,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **resolve_settings_without_workspace** -> [ResolvedSetting] resolve_settings_without_workspace(resolve_settings_request) +> List[ResolvedSetting] resolve_settings_without_workspace(resolve_settings_request) Values for selected settings without workspace. @@ -82,12 +83,12 @@ Resolves values for selected settings without workspace by current user, organiz ```python -import time import gooddata_api_client -from gooddata_api_client.api import reporting_settings_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -96,32 +97,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = reporting_settings_api.ReportingSettingsApi(api_client) - resolve_settings_request = ResolveSettingsRequest( - settings=["timezone"], - ) # ResolveSettingsRequest | + api_instance = gooddata_api_client.ReportingSettingsApi(api_client) + resolve_settings_request = gooddata_api_client.ResolveSettingsRequest() # ResolveSettingsRequest | - # example passing only required values which don't have defaults set try: # Values for selected settings without workspace. api_response = api_instance.resolve_settings_without_workspace(resolve_settings_request) + print("The response of ReportingSettingsApi->resolve_settings_without_workspace:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ReportingSettingsApi->resolve_settings_without_workspace: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **resolve_settings_request** | [**ResolveSettingsRequest**](ResolveSettingsRequest.md)| | + **resolve_settings_request** | [**ResolveSettingsRequest**](ResolveSettingsRequest.md)| | ### Return type -[**[ResolvedSetting]**](ResolvedSetting.md) +[**List[ResolvedSetting]**](ResolvedSetting.md) ### Authorization @@ -132,7 +133,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ResolveSettingsRequest.md b/gooddata-api-client/docs/ResolveSettingsRequest.md index f80b70edc..9470a3ac9 100644 --- a/gooddata-api-client/docs/ResolveSettingsRequest.md +++ b/gooddata-api-client/docs/ResolveSettingsRequest.md @@ -3,11 +3,28 @@ A request containing setting IDs to resolve. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**settings** | **[str]** | An array of setting IDs to resolve. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**settings** | **List[str]** | An array of setting IDs to resolve. | + +## Example + +```python +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ResolveSettingsRequest from a JSON string +resolve_settings_request_instance = ResolveSettingsRequest.from_json(json) +# print the JSON string representation of the object +print(ResolveSettingsRequest.to_json()) +# convert the object into a dict +resolve_settings_request_dict = resolve_settings_request_instance.to_dict() +# create an instance of ResolveSettingsRequest from a dict +resolve_settings_request_from_dict = ResolveSettingsRequest.from_dict(resolve_settings_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ResolvedLlmEndpoint.md b/gooddata-api-client/docs/ResolvedLlmEndpoint.md index e17eecb17..31c87d9e5 100644 --- a/gooddata-api-client/docs/ResolvedLlmEndpoint.md +++ b/gooddata-api-client/docs/ResolvedLlmEndpoint.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Endpoint Id | **title** | **str** | Endpoint Title | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.resolved_llm_endpoint import ResolvedLlmEndpoint + +# TODO update the JSON string below +json = "{}" +# create an instance of ResolvedLlmEndpoint from a JSON string +resolved_llm_endpoint_instance = ResolvedLlmEndpoint.from_json(json) +# print the JSON string representation of the object +print(ResolvedLlmEndpoint.to_json()) + +# convert the object into a dict +resolved_llm_endpoint_dict = resolved_llm_endpoint_instance.to_dict() +# create an instance of ResolvedLlmEndpoint from a dict +resolved_llm_endpoint_from_dict = ResolvedLlmEndpoint.from_dict(resolved_llm_endpoint_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ResolvedLlmEndpoints.md b/gooddata-api-client/docs/ResolvedLlmEndpoints.md index bab5355ac..60da9eabd 100644 --- a/gooddata-api-client/docs/ResolvedLlmEndpoints.md +++ b/gooddata-api-client/docs/ResolvedLlmEndpoints.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[ResolvedLlmEndpoint]**](ResolvedLlmEndpoint.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data** | [**List[ResolvedLlmEndpoint]**](ResolvedLlmEndpoint.md) | | + +## Example + +```python +from gooddata_api_client.models.resolved_llm_endpoints import ResolvedLlmEndpoints + +# TODO update the JSON string below +json = "{}" +# create an instance of ResolvedLlmEndpoints from a JSON string +resolved_llm_endpoints_instance = ResolvedLlmEndpoints.from_json(json) +# print the JSON string representation of the object +print(ResolvedLlmEndpoints.to_json()) +# convert the object into a dict +resolved_llm_endpoints_dict = resolved_llm_endpoints_instance.to_dict() +# create an instance of ResolvedLlmEndpoints from a dict +resolved_llm_endpoints_from_dict = ResolvedLlmEndpoints.from_dict(resolved_llm_endpoints_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ResolvedSetting.md b/gooddata-api-client/docs/ResolvedSetting.md index a214a2f8c..1090d6775 100644 --- a/gooddata-api-client/docs/ResolvedSetting.md +++ b/gooddata-api-client/docs/ResolvedSetting.md @@ -3,13 +3,30 @@ Setting and its value. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**content** | **object** | Free-form JSON object | [optional] **id** | **str** | Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type. | -**content** | [**JsonNode**](JsonNode.md) | | [optional] **type** | **str** | Type of the setting. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.resolved_setting import ResolvedSetting + +# TODO update the JSON string below +json = "{}" +# create an instance of ResolvedSetting from a JSON string +resolved_setting_instance = ResolvedSetting.from_json(json) +# print the JSON string representation of the object +print(ResolvedSetting.to_json()) + +# convert the object into a dict +resolved_setting_dict = resolved_setting_instance.to_dict() +# create an instance of ResolvedSetting from a dict +resolved_setting_from_dict = ResolvedSetting.from_dict(resolved_setting_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RestApiIdentifier.md b/gooddata-api-client/docs/RestApiIdentifier.md index 620bbffd1..a0b1782ab 100644 --- a/gooddata-api-client/docs/RestApiIdentifier.md +++ b/gooddata-api-client/docs/RestApiIdentifier.md @@ -3,12 +3,29 @@ Object identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.rest_api_identifier import RestApiIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of RestApiIdentifier from a JSON string +rest_api_identifier_instance = RestApiIdentifier.from_json(json) +# print the JSON string representation of the object +print(RestApiIdentifier.to_json()) + +# convert the object into a dict +rest_api_identifier_dict = rest_api_identifier_instance.to_dict() +# create an instance of RestApiIdentifier from a dict +rest_api_identifier_from_dict = RestApiIdentifier.from_dict(rest_api_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ResultCacheMetadata.md b/gooddata-api-client/docs/ResultCacheMetadata.md index ca7506f26..26bf6e078 100644 --- a/gooddata-api-client/docs/ResultCacheMetadata.md +++ b/gooddata-api-client/docs/ResultCacheMetadata.md @@ -3,14 +3,31 @@ All execution result's metadata used for calculation including ExecutionResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **afm** | [**AFM**](AFM.md) | | **execution_response** | [**ExecutionResponse**](ExecutionResponse.md) | | **result_size** | **int** | | **result_spec** | [**ResultSpec**](ResultSpec.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.result_cache_metadata import ResultCacheMetadata + +# TODO update the JSON string below +json = "{}" +# create an instance of ResultCacheMetadata from a JSON string +result_cache_metadata_instance = ResultCacheMetadata.from_json(json) +# print the JSON string representation of the object +print(ResultCacheMetadata.to_json()) + +# convert the object into a dict +result_cache_metadata_dict = result_cache_metadata_instance.to_dict() +# create an instance of ResultCacheMetadata from a dict +result_cache_metadata_from_dict = ResultCacheMetadata.from_dict(result_cache_metadata_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ResultDimension.md b/gooddata-api-client/docs/ResultDimension.md index 034aea678..0de878462 100644 --- a/gooddata-api-client/docs/ResultDimension.md +++ b/gooddata-api-client/docs/ResultDimension.md @@ -3,12 +3,29 @@ Single result dimension ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**headers** | [**[ResultDimensionHeader]**](ResultDimensionHeader.md) | | +**headers** | [**List[ResultDimensionHeader]**](ResultDimensionHeader.md) | | **local_identifier** | **str** | Local identifier of the dimension. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.result_dimension import ResultDimension + +# TODO update the JSON string below +json = "{}" +# create an instance of ResultDimension from a JSON string +result_dimension_instance = ResultDimension.from_json(json) +# print the JSON string representation of the object +print(ResultDimension.to_json()) + +# convert the object into a dict +result_dimension_dict = result_dimension_instance.to_dict() +# create an instance of ResultDimension from a dict +result_dimension_from_dict = ResultDimension.from_dict(result_dimension_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ResultDimensionHeader.md b/gooddata-api-client/docs/ResultDimensionHeader.md index 27e9cdaa0..1531c24f0 100644 --- a/gooddata-api-client/docs/ResultDimensionHeader.md +++ b/gooddata-api-client/docs/ResultDimensionHeader.md @@ -3,12 +3,29 @@ One of the headers in a result dimension. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**measure_group_headers** | [**[MeasureHeader]**](MeasureHeader.md) | | [optional] -**attribute_header** | [**AttributeHeaderAttributeHeader**](AttributeHeaderAttributeHeader.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**measure_group_headers** | [**List[MeasureHeader]**](MeasureHeader.md) | | [optional] +**attribute_header** | [**AttributeHeaderAttributeHeader**](AttributeHeaderAttributeHeader.md) | | + +## Example + +```python +from gooddata_api_client.models.result_dimension_header import ResultDimensionHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of ResultDimensionHeader from a JSON string +result_dimension_header_instance = ResultDimensionHeader.from_json(json) +# print the JSON string representation of the object +print(ResultDimensionHeader.to_json()) +# convert the object into a dict +result_dimension_header_dict = result_dimension_header_instance.to_dict() +# create an instance of ResultDimensionHeader from a dict +result_dimension_header_from_dict = ResultDimensionHeader.from_dict(result_dimension_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ResultSpec.md b/gooddata-api-client/docs/ResultSpec.md index eb542f815..003e43039 100644 --- a/gooddata-api-client/docs/ResultSpec.md +++ b/gooddata-api-client/docs/ResultSpec.md @@ -3,12 +3,29 @@ Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```). ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dimensions** | [**[Dimension]**](Dimension.md) | | -**totals** | [**[Total]**](Total.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**dimensions** | [**List[Dimension]**](Dimension.md) | | +**totals** | [**List[Total]**](Total.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.result_spec import ResultSpec + +# TODO update the JSON string below +json = "{}" +# create an instance of ResultSpec from a JSON string +result_spec_instance = ResultSpec.from_json(json) +# print the JSON string representation of the object +print(ResultSpec.to_json()) +# convert the object into a dict +result_spec_dict = result_spec_instance.to_dict() +# create an instance of ResultSpec from a dict +result_spec_from_dict = ResultSpec.from_dict(result_spec_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RouteResult.md b/gooddata-api-client/docs/RouteResult.md index 488c7e549..f0836e961 100644 --- a/gooddata-api-client/docs/RouteResult.md +++ b/gooddata-api-client/docs/RouteResult.md @@ -3,12 +3,29 @@ Question -> Use Case routing. May contain final answer is a special use case is not required. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **reasoning** | **str** | Explanation why LLM picked this use case. | **use_case** | **str** | Use case where LLM routed based on question. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.route_result import RouteResult + +# TODO update the JSON string below +json = "{}" +# create an instance of RouteResult from a JSON string +route_result_instance = RouteResult.from_json(json) +# print the JSON string representation of the object +print(RouteResult.to_json()) + +# convert the object into a dict +route_result_dict = route_result_instance.to_dict() +# create an instance of RouteResult from a dict +route_result_from_dict = RouteResult.from_dict(route_result_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RsaSpecification.md b/gooddata-api-client/docs/RsaSpecification.md index b038ed17a..c02697aa6 100644 --- a/gooddata-api-client/docs/RsaSpecification.md +++ b/gooddata-api-client/docs/RsaSpecification.md @@ -2,18 +2,35 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **alg** | **str** | | **e** | **str** | | **kid** | **str** | | +**kty** | **str** | | **n** | **str** | | -**kty** | **str** | | defaults to "RSA" -**use** | **str** | | defaults to "sig" -**x5c** | **[str]** | | [optional] +**use** | **str** | | +**x5c** | **List[str]** | | [optional] **x5t** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.rsa_specification import RsaSpecification + +# TODO update the JSON string below +json = "{}" +# create an instance of RsaSpecification from a JSON string +rsa_specification_instance = RsaSpecification.from_json(json) +# print the JSON string representation of the object +print(RsaSpecification.to_json()) + +# convert the object into a dict +rsa_specification_dict = rsa_specification_instance.to_dict() +# create an instance of RsaSpecification from a dict +rsa_specification_from_dict = RsaSpecification.from_dict(rsa_specification_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RulePermission.md b/gooddata-api-client/docs/RulePermission.md index 1ab4881cd..75587da03 100644 --- a/gooddata-api-client/docs/RulePermission.md +++ b/gooddata-api-client/docs/RulePermission.md @@ -3,12 +3,29 @@ List of rules ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**permissions** | [**List[GrantedPermission]**](GrantedPermission.md) | Permissions granted by the rule | [optional] **type** | **str** | Type of the rule | -**permissions** | [**[GrantedPermission]**](GrantedPermission.md) | Permissions granted by the rule | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.rule_permission import RulePermission + +# TODO update the JSON string below +json = "{}" +# create an instance of RulePermission from a JSON string +rule_permission_instance = RulePermission.from_json(json) +# print the JSON string representation of the object +print(RulePermission.to_json()) + +# convert the object into a dict +rule_permission_dict = rule_permission_instance.to_dict() +# create an instance of RulePermission from a dict +rule_permission_from_dict = RulePermission.from_dict(rule_permission_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/RunningSection.md b/gooddata-api-client/docs/RunningSection.md index 040b90bae..9f6c9947d 100644 --- a/gooddata-api-client/docs/RunningSection.md +++ b/gooddata-api-client/docs/RunningSection.md @@ -3,12 +3,29 @@ Footer section of the slide ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**left** | **str, none_type** | Either {{logo}} variable or custom text with combination of other variables. | [optional] -**right** | **str, none_type** | Either {{logo}} variable or custom text with combination of other variables. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**left** | **str** | Either {{logo}} variable or custom text with combination of other variables. | [optional] +**right** | **str** | Either {{logo}} variable or custom text with combination of other variables. | [optional] + +## Example + +```python +from gooddata_api_client.models.running_section import RunningSection + +# TODO update the JSON string below +json = "{}" +# create an instance of RunningSection from a JSON string +running_section_instance = RunningSection.from_json(json) +# print the JSON string representation of the object +print(RunningSection.to_json()) +# convert the object into a dict +running_section_dict = running_section_instance.to_dict() +# create an instance of RunningSection from a dict +running_section_from_dict = RunningSection.from_dict(running_section_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SavedVisualization.md b/gooddata-api-client/docs/SavedVisualization.md index a8e13553a..b4da75c0a 100644 --- a/gooddata-api-client/docs/SavedVisualization.md +++ b/gooddata-api-client/docs/SavedVisualization.md @@ -3,12 +3,29 @@ Created and saved visualization IDs. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **created_visualization_id** | **str** | Created visualization ID. | **saved_visualization_id** | **str** | Saved visualization ID. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.saved_visualization import SavedVisualization + +# TODO update the JSON string below +json = "{}" +# create an instance of SavedVisualization from a JSON string +saved_visualization_instance = SavedVisualization.from_json(json) +# print the JSON string representation of the object +print(SavedVisualization.to_json()) + +# convert the object into a dict +saved_visualization_dict = saved_visualization_instance.to_dict() +# create an instance of SavedVisualization from a dict +saved_visualization_from_dict = SavedVisualization.from_dict(saved_visualization_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ScanRequest.md b/gooddata-api-client/docs/ScanRequest.md index fc6f9b06b..e3eeb4c54 100644 --- a/gooddata-api-client/docs/ScanRequest.md +++ b/gooddata-api-client/docs/ScanRequest.md @@ -3,16 +3,33 @@ A request containing all information critical to model scanning. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **scan_tables** | **bool** | A flag indicating whether the tables should be scanned. | **scan_views** | **bool** | A flag indicating whether the views should be scanned. | +**schemata** | **List[str]** | What schemata will be scanned. | [optional] **separator** | **str** | A separator between prefixes and the names. | -**schemata** | **[str]** | What schemata will be scanned. | [optional] **table_prefix** | **str** | Tables starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned. | [optional] **view_prefix** | **str** | Views starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.scan_request import ScanRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ScanRequest from a JSON string +scan_request_instance = ScanRequest.from_json(json) +# print the JSON string representation of the object +print(ScanRequest.to_json()) + +# convert the object into a dict +scan_request_dict = scan_request_instance.to_dict() +# create an instance of ScanRequest from a dict +scan_request_from_dict = ScanRequest.from_dict(scan_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ScanResultPdm.md b/gooddata-api-client/docs/ScanResultPdm.md index df8396a81..9153362c2 100644 --- a/gooddata-api-client/docs/ScanResultPdm.md +++ b/gooddata-api-client/docs/ScanResultPdm.md @@ -3,12 +3,29 @@ Result of scan of data source physical model. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pdm** | [**DeclarativeTables**](DeclarativeTables.md) | | -**warnings** | [**[TableWarning]**](TableWarning.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**warnings** | [**List[TableWarning]**](TableWarning.md) | | + +## Example + +```python +from gooddata_api_client.models.scan_result_pdm import ScanResultPdm + +# TODO update the JSON string below +json = "{}" +# create an instance of ScanResultPdm from a JSON string +scan_result_pdm_instance = ScanResultPdm.from_json(json) +# print the JSON string representation of the object +print(ScanResultPdm.to_json()) +# convert the object into a dict +scan_result_pdm_dict = scan_result_pdm_instance.to_dict() +# create an instance of ScanResultPdm from a dict +scan_result_pdm_from_dict = ScanResultPdm.from_dict(scan_result_pdm_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ScanSqlRequest.md b/gooddata-api-client/docs/ScanSqlRequest.md index 326eeac84..1e758be8c 100644 --- a/gooddata-api-client/docs/ScanSqlRequest.md +++ b/gooddata-api-client/docs/ScanSqlRequest.md @@ -3,11 +3,28 @@ A request with SQL query to by analyzed. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sql** | **str** | SQL query to be analyzed. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ScanSqlRequest from a JSON string +scan_sql_request_instance = ScanSqlRequest.from_json(json) +# print the JSON string representation of the object +print(ScanSqlRequest.to_json()) + +# convert the object into a dict +scan_sql_request_dict = scan_sql_request_instance.to_dict() +# create an instance of ScanSqlRequest from a dict +scan_sql_request_from_dict = ScanSqlRequest.from_dict(scan_sql_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ScanSqlResponse.md b/gooddata-api-client/docs/ScanSqlResponse.md index 6fc02693f..3a352d994 100644 --- a/gooddata-api-client/docs/ScanSqlResponse.md +++ b/gooddata-api-client/docs/ScanSqlResponse.md @@ -3,12 +3,29 @@ Result of scanSql. Consists of array of query columns including type. Sql query result data preview can be attached optionally ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**columns** | [**[SqlColumn]**](SqlColumn.md) | Array of columns with types. | -**data_preview** | **[[str, none_type]]** | Array of rows where each row is another array of string values. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**columns** | [**List[SqlColumn]**](SqlColumn.md) | Array of columns with types. | +**data_preview** | **List[List[Optional[str]]]** | Array of rows where each row is another array of string values. | [optional] + +## Example + +```python +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ScanSqlResponse from a JSON string +scan_sql_response_instance = ScanSqlResponse.from_json(json) +# print the JSON string representation of the object +print(ScanSqlResponse.to_json()) +# convert the object into a dict +scan_sql_response_dict = scan_sql_response_instance.to_dict() +# create an instance of ScanSqlResponse from a dict +scan_sql_response_from_dict = ScanSqlResponse.from_dict(scan_sql_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ScanningApi.md b/gooddata-api-client/docs/ScanningApi.md index 8cabb3419..024e253e1 100644 --- a/gooddata-api-client/docs/ScanningApi.md +++ b/gooddata-api-client/docs/ScanningApi.md @@ -20,11 +20,11 @@ It scans a database and reads metadata. The result of the request contains a lis ```python -import time import gooddata_api_client -from gooddata_api_client.api import scanning_api -from gooddata_api_client.model.data_source_schemata import DataSourceSchemata +from gooddata_api_client.models.data_source_schemata import DataSourceSchemata +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -33,26 +33,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = scanning_api.ScanningApi(api_client) - data_source_id = "myPostgres" # str | Data source id + api_instance = gooddata_api_client.ScanningApi(api_client) + data_source_id = 'myPostgres' # str | Data source id - # example passing only required values which don't have defaults set try: # Get a list of schema names of a database api_response = api_instance.get_data_source_schemata(data_source_id) + print("The response of ScanningApi->get_data_source_schemata:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ScanningApi->get_data_source_schemata: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| Data source id | + **data_source_id** | **str**| Data source id | ### Return type @@ -67,7 +69,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -87,12 +88,12 @@ It scans a database and transforms its metadata to a declarative definition of t ```python -import time import gooddata_api_client -from gooddata_api_client.api import scanning_api -from gooddata_api_client.model.scan_request import ScanRequest -from gooddata_api_client.model.scan_result_pdm import ScanResultPdm +from gooddata_api_client.models.scan_request import ScanRequest +from gooddata_api_client.models.scan_result_pdm import ScanResultPdm +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -101,35 +102,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = scanning_api.ScanningApi(api_client) - data_source_id = "myPostgres" # str | Data source id - scan_request = ScanRequest( - scan_tables=True, - scan_views=True, - schemata=["tpch","demo"], - separator="__", - table_prefix="out_table", - view_prefix="out_view", - ) # ScanRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.ScanningApi(api_client) + data_source_id = 'myPostgres' # str | Data source id + scan_request = gooddata_api_client.ScanRequest() # ScanRequest | + try: # Scan a database to get a physical data model (PDM) api_response = api_instance.scan_data_source(data_source_id, scan_request) + print("The response of ScanningApi->scan_data_source:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ScanningApi->scan_data_source: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| Data source id | - **scan_request** | [**ScanRequest**](ScanRequest.md)| | + **data_source_id** | **str**| Data source id | + **scan_request** | [**ScanRequest**](ScanRequest.md)| | ### Return type @@ -144,7 +140,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -164,12 +159,12 @@ It executes SQL query against specified data source and extracts metadata. Metad ```python -import time import gooddata_api_client -from gooddata_api_client.api import scanning_api -from gooddata_api_client.model.scan_sql_response import ScanSqlResponse -from gooddata_api_client.model.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -178,30 +173,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = scanning_api.ScanningApi(api_client) - data_source_id = "myPostgres" # str | Data source id - scan_sql_request = ScanSqlRequest( - sql="SELECT a.special_value as result FROM tableA a", - ) # ScanSqlRequest | + api_instance = gooddata_api_client.ScanningApi(api_client) + data_source_id = 'myPostgres' # str | Data source id + scan_sql_request = gooddata_api_client.ScanSqlRequest() # ScanSqlRequest | - # example passing only required values which don't have defaults set try: # Collect metadata about SQL query api_response = api_instance.scan_sql(data_source_id, scan_sql_request) + print("The response of ScanningApi->scan_sql:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling ScanningApi->scan_sql: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| Data source id | - **scan_sql_request** | [**ScanSqlRequest**](ScanSqlRequest.md)| | + **data_source_id** | **str**| Data source id | + **scan_sql_request** | [**ScanSqlRequest**](ScanSqlRequest.md)| | ### Return type @@ -216,7 +211,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/SearchRelationshipObject.md b/gooddata-api-client/docs/SearchRelationshipObject.md index a153fb111..2571b5c0a 100644 --- a/gooddata-api-client/docs/SearchRelationshipObject.md +++ b/gooddata-api-client/docs/SearchRelationshipObject.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **source_object_id** | **str** | Source object ID. | @@ -12,8 +13,24 @@ Name | Type | Description | Notes **target_object_title** | **str** | Target object title. | **target_object_type** | **str** | Target object type, e.g. visualization. | **target_workspace_id** | **str** | Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.search_relationship_object import SearchRelationshipObject + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchRelationshipObject from a JSON string +search_relationship_object_instance = SearchRelationshipObject.from_json(json) +# print the JSON string representation of the object +print(SearchRelationshipObject.to_json()) + +# convert the object into a dict +search_relationship_object_dict = search_relationship_object_instance.to_dict() +# create an instance of SearchRelationshipObject from a dict +search_relationship_object_from_dict = SearchRelationshipObject.from_dict(search_relationship_object_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SearchRequest.md b/gooddata-api-client/docs/SearchRequest.md index 09b33379c..d58bdf6a0 100644 --- a/gooddata-api-client/docs/SearchRequest.md +++ b/gooddata-api-client/docs/SearchRequest.md @@ -2,17 +2,34 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**deep_search** | **bool** | Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations. | [optional] [default to False] +**include_hidden** | **bool** | If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true. | [optional] [default to False] +**limit** | **int** | Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. | [optional] [default to 10] +**object_types** | **List[str]** | List of object types to search for. | [optional] **question** | **str** | Keyword/sentence is input for search. | -**deep_search** | **bool** | Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations. | [optional] if omitted the server will use the default value of False -**include_hidden** | **bool** | If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true. | [optional] if omitted the server will use the default value of False -**limit** | **int** | Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. | [optional] if omitted the server will use the default value of 10 -**object_types** | **[str]** | List of object types to search for. | [optional] -**relevant_score_threshold** | **float** | Score, above which we return found objects. Below this score objects are not relevant. | [optional] if omitted the server will use the default value of 0.3 -**title_to_descriptor_ratio** | **float** | Temporary for experiments. Ratio of title score to descriptor score. | [optional] if omitted the server will use the default value of 0.7 -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**relevant_score_threshold** | **float** | Score, above which we return found objects. Below this score objects are not relevant. | [optional] [default to 0.3] +**title_to_descriptor_ratio** | **float** | Temporary for experiments. Ratio of title score to descriptor score. | [optional] [default to 0.7] + +## Example + +```python +from gooddata_api_client.models.search_request import SearchRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchRequest from a JSON string +search_request_instance = SearchRequest.from_json(json) +# print the JSON string representation of the object +print(SearchRequest.to_json()) +# convert the object into a dict +search_request_dict = search_request_instance.to_dict() +# create an instance of SearchRequest from a dict +search_request_from_dict = SearchRequest.from_dict(search_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SearchResult.md b/gooddata-api-client/docs/SearchResult.md index 8ccddcf01..eabea14ce 100644 --- a/gooddata-api-client/docs/SearchResult.md +++ b/gooddata-api-client/docs/SearchResult.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **reasoning** | **str** | If something is not working properly this field will contain explanation. | -**relationships** | [**[SearchRelationshipObject]**](SearchRelationshipObject.md) | | -**results** | [**[SearchResultObject]**](SearchResultObject.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**relationships** | [**List[SearchRelationshipObject]**](SearchRelationshipObject.md) | | +**results** | [**List[SearchResultObject]**](SearchResultObject.md) | | + +## Example + +```python +from gooddata_api_client.models.search_result import SearchResult + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchResult from a JSON string +search_result_instance = SearchResult.from_json(json) +# print the JSON string representation of the object +print(SearchResult.to_json()) +# convert the object into a dict +search_result_dict = search_result_instance.to_dict() +# create an instance of SearchResult from a dict +search_result_from_dict = SearchResult.from_dict(search_result_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SearchResultObject.md b/gooddata-api-client/docs/SearchResultObject.md index 67eeace04..9dd708cfa 100644 --- a/gooddata-api-client/docs/SearchResultObject.md +++ b/gooddata-api-client/docs/SearchResultObject.md @@ -2,24 +2,41 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Object ID. | -**title** | **str** | Object title. | -**type** | **str** | Object type, e.g. dashboard. | -**workspace_id** | **str** | Workspace ID. | **created_at** | **datetime** | Timestamp when object was created. | [optional] **description** | **str** | Object description. | [optional] +**id** | **str** | Object ID. | **is_hidden** | **bool** | If true, this object is hidden from AI search results by default. | [optional] **modified_at** | **datetime** | Timestamp when object was last modified. | [optional] **score** | **float** | Result score calculated by a similarity search algorithm (cosine_distance). | [optional] **score_descriptor** | **float** | Result score for descriptor containing(now) description and tags. | [optional] **score_exact_match** | **int** | Result score for exact match(id/title). 1/1000. Other scores are multiplied by this. | [optional] **score_title** | **float** | Result score for object title. | [optional] -**tags** | **[str]** | | [optional] +**tags** | **List[str]** | | [optional] +**title** | **str** | Object title. | +**type** | **str** | Object type, e.g. dashboard. | **visualization_url** | **str** | If the object is visualization, this field defines the type of visualization. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**workspace_id** | **str** | Workspace ID. | + +## Example + +```python +from gooddata_api_client.models.search_result_object import SearchResultObject + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchResultObject from a JSON string +search_result_object_instance = SearchResultObject.from_json(json) +# print the JSON string representation of the object +print(SearchResultObject.to_json()) +# convert the object into a dict +search_result_object_dict = search_result_object_instance.to_dict() +# create an instance of SearchResultObject from a dict +search_result_object_from_dict = SearchResultObject.from_dict(search_result_object_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SectionSlideTemplate.md b/gooddata-api-client/docs/SectionSlideTemplate.md index b69720f8f..fc58cba8e 100644 --- a/gooddata-api-client/docs/SectionSlideTemplate.md +++ b/gooddata-api-client/docs/SectionSlideTemplate.md @@ -3,13 +3,30 @@ Settings for section slide. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**background_image** | **bool** | Show background image on the slide. | [optional] if omitted the server will use the default value of True +**background_image** | **bool** | Show background image on the slide. | [optional] [default to True] **footer** | [**RunningSection**](RunningSection.md) | | [optional] **header** | [**RunningSection**](RunningSection.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.section_slide_template import SectionSlideTemplate + +# TODO update the JSON string below +json = "{}" +# create an instance of SectionSlideTemplate from a JSON string +section_slide_template_instance = SectionSlideTemplate.from_json(json) +# print the JSON string representation of the object +print(SectionSlideTemplate.to_json()) + +# convert the object into a dict +section_slide_template_dict = section_slide_template_instance.to_dict() +# create an instance of SectionSlideTemplate from a dict +section_slide_template_from_dict = SectionSlideTemplate.from_dict(section_slide_template_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Settings.md b/gooddata-api-client/docs/Settings.md index be7b63266..e714ca322 100644 --- a/gooddata-api-client/docs/Settings.md +++ b/gooddata-api-client/docs/Settings.md @@ -3,19 +3,36 @@ Additional settings. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**export_info** | **bool** | If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF) | [optional] if omitted the server will use the default value of False +**export_info** | **bool** | If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF) | [optional] [default to False] **merge_headers** | **bool** | Merge equal headers in neighbouring cells. (XLSX) | [optional] -**page_orientation** | **str** | Set page orientation. (PDF) | [optional] if omitted the server will use the default value of "PORTRAIT" -**page_size** | **str** | Set page size. (PDF) | [optional] if omitted the server will use the default value of "A4" +**page_orientation** | **str** | Set page orientation. (PDF) | [optional] [default to 'PORTRAIT'] +**page_size** | **str** | Set page size. (PDF) | [optional] [default to 'A4'] **pdf_page_size** | **str** | Page size and orientation. (PDF) | [optional] -**pdf_table_style** | [**[PdfTableStyle]**](PdfTableStyle.md) | Custom CSS styles for the table. (PDF, HTML) | [optional] +**pdf_table_style** | [**List[PdfTableStyle]**](PdfTableStyle.md) | Custom CSS styles for the table. (PDF, HTML) | [optional] **pdf_top_left_content** | **str** | Top left header content. (PDF) | [optional] **pdf_top_right_content** | **str** | Top right header content. (PDF) | [optional] **show_filters** | **bool** | Print applied filters on top of the document. (PDF/HTML when visualizationObject is given) | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.settings import Settings + +# TODO update the JSON string below +json = "{}" +# create an instance of Settings from a JSON string +settings_instance = Settings.from_json(json) +# print the JSON string representation of the object +print(Settings.to_json()) + +# convert the object into a dict +settings_dict = settings_instance.to_dict() +# create an instance of Settings from a dict +settings_from_dict = Settings.from_dict(settings_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SimpleMeasureDefinition.md b/gooddata-api-client/docs/SimpleMeasureDefinition.md index 1561b7cab..2ffa10bbe 100644 --- a/gooddata-api-client/docs/SimpleMeasureDefinition.md +++ b/gooddata-api-client/docs/SimpleMeasureDefinition.md @@ -3,11 +3,28 @@ Metric defined by referencing a MAQL metric or an LDM fact object with aggregation. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **measure** | [**SimpleMeasureDefinitionMeasure**](SimpleMeasureDefinitionMeasure.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.simple_measure_definition import SimpleMeasureDefinition + +# TODO update the JSON string below +json = "{}" +# create an instance of SimpleMeasureDefinition from a JSON string +simple_measure_definition_instance = SimpleMeasureDefinition.from_json(json) +# print the JSON string representation of the object +print(SimpleMeasureDefinition.to_json()) + +# convert the object into a dict +simple_measure_definition_dict = simple_measure_definition_instance.to_dict() +# create an instance of SimpleMeasureDefinition from a dict +simple_measure_definition_from_dict = SimpleMeasureDefinition.from_dict(simple_measure_definition_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SimpleMeasureDefinitionMeasure.md b/gooddata-api-client/docs/SimpleMeasureDefinitionMeasure.md index e9492a8a9..49bb1ccbc 100644 --- a/gooddata-api-client/docs/SimpleMeasureDefinitionMeasure.md +++ b/gooddata-api-client/docs/SimpleMeasureDefinitionMeasure.md @@ -2,14 +2,31 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**item** | [**AfmObjectIdentifierCore**](AfmObjectIdentifierCore.md) | | **aggregation** | **str** | Definition of aggregation type of the metric. | [optional] -**compute_ratio** | **bool** | If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down). | [optional] if omitted the server will use the default value of False -**filters** | [**[FilterDefinitionForSimpleMeasure]**](FilterDefinitionForSimpleMeasure.md) | Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**compute_ratio** | **bool** | If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down). | [optional] [default to False] +**filters** | [**List[FilterDefinitionForSimpleMeasure]**](FilterDefinitionForSimpleMeasure.md) | Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed. | [optional] +**item** | [**AfmObjectIdentifierCore**](AfmObjectIdentifierCore.md) | | + +## Example + +```python +from gooddata_api_client.models.simple_measure_definition_measure import SimpleMeasureDefinitionMeasure + +# TODO update the JSON string below +json = "{}" +# create an instance of SimpleMeasureDefinitionMeasure from a JSON string +simple_measure_definition_measure_instance = SimpleMeasureDefinitionMeasure.from_json(json) +# print the JSON string representation of the object +print(SimpleMeasureDefinitionMeasure.to_json()) +# convert the object into a dict +simple_measure_definition_measure_dict = simple_measure_definition_measure_instance.to_dict() +# create an instance of SimpleMeasureDefinitionMeasure from a dict +simple_measure_definition_measure_from_dict = SimpleMeasureDefinitionMeasure.from_dict(simple_measure_definition_measure_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Skeleton.md b/gooddata-api-client/docs/Skeleton.md index cae44438a..2634f90d5 100644 --- a/gooddata-api-client/docs/Skeleton.md +++ b/gooddata-api-client/docs/Skeleton.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional] +**content** | **List[object]** | | [optional] **href** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.skeleton import Skeleton + +# TODO update the JSON string below +json = "{}" +# create an instance of Skeleton from a JSON string +skeleton_instance = Skeleton.from_json(json) +# print the JSON string representation of the object +print(Skeleton.to_json()) + +# convert the object into a dict +skeleton_dict = skeleton_instance.to_dict() +# create an instance of Skeleton from a dict +skeleton_from_dict = Skeleton.from_dict(skeleton_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SlidesExportApi.md b/gooddata-api-client/docs/SlidesExportApi.md index a4c29a2b1..e91cc553a 100644 --- a/gooddata-api-client/docs/SlidesExportApi.md +++ b/gooddata-api-client/docs/SlidesExportApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description # **create_slides_export** -> ExportResponse create_slides_export(workspace_id, slides_export_request) +> ExportResponse create_slides_export(workspace_id, slides_export_request, x_gdc_debug=x_gdc_debug) (EXPERIMENTAL) Create slides export request @@ -20,12 +20,12 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import slides_export_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.slides_export_request import SlidesExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.slides_export_request import SlidesExportRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -34,51 +34,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = slides_export_api.SlidesExportApi(api_client) - workspace_id = "workspaceId_example" # str | - slides_export_request = SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ) # SlidesExportRequest | - x_gdc_debug = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Create slides export request - api_response = api_instance.create_slides_export(workspace_id, slides_export_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling SlidesExportApi->create_slides_export: %s\n" % e) + api_instance = gooddata_api_client.SlidesExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + slides_export_request = gooddata_api_client.SlidesExportRequest() # SlidesExportRequest | + x_gdc_debug = False # bool | (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Create slides export request api_response = api_instance.create_slides_export(workspace_id, slides_export_request, x_gdc_debug=x_gdc_debug) + print("The response of SlidesExportApi->create_slides_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SlidesExportApi->create_slides_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **slides_export_request** | [**SlidesExportRequest**](SlidesExportRequest.md)| | - **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| | + **slides_export_request** | [**SlidesExportRequest**](SlidesExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] [default to False] ### Return type @@ -93,7 +74,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -103,7 +83,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_slides_export** -> file_type get_slides_export(workspace_id, export_id) +> bytearray get_slides_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -113,11 +93,10 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import slides_export_api -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -126,32 +105,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = slides_export_api.SlidesExportApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.SlidesExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files api_response = api_instance.get_slides_export(workspace_id, export_id) + print("The response of SlidesExportApi->get_slides_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SlidesExportApi->get_slides_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -**file_type** +**bytearray** ### Authorization @@ -162,7 +143,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation - ### HTTP response details | Status code | Description | Response headers | @@ -183,10 +163,10 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import slides_export_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -195,27 +175,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = slides_export_api.SlidesExportApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.SlidesExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve metadata context api_instance.get_slides_export_metadata(workspace_id, export_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SlidesExportApi->get_slides_export_metadata: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type @@ -230,7 +211,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/SlidesExportRequest.md b/gooddata-api-client/docs/SlidesExportRequest.md index 6844f53ac..a6a6b1fa2 100644 --- a/gooddata-api-client/docs/SlidesExportRequest.md +++ b/gooddata-api-client/docs/SlidesExportRequest.md @@ -3,17 +3,34 @@ Export request object describing the export properties and metadata for slides exports. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**dashboard_id** | **str** | Dashboard identifier | [optional] **file_name** | **str** | File name to be used for retrieving the pdf document. | **format** | **str** | Requested resulting file type. | -**dashboard_id** | **str** | Dashboard identifier | [optional] -**metadata** | [**JsonNode**](JsonNode.md) | | [optional] -**template_id** | **str, none_type** | Export template identifier. | [optional] -**visualization_ids** | **[str]** | List of visualization ids to be exported. Note that only one visualization is currently supported. | [optional] -**widget_ids** | **[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**metadata** | **object** | Free-form JSON object | [optional] +**template_id** | **str** | Export template identifier. | [optional] +**visualization_ids** | **List[str]** | List of visualization ids to be exported. Note that only one visualization is currently supported. | [optional] +**widget_ids** | **List[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | [optional] + +## Example + +```python +from gooddata_api_client.models.slides_export_request import SlidesExportRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of SlidesExportRequest from a JSON string +slides_export_request_instance = SlidesExportRequest.from_json(json) +# print the JSON string representation of the object +print(SlidesExportRequest.to_json()) +# convert the object into a dict +slides_export_request_dict = slides_export_request_instance.to_dict() +# create an instance of SlidesExportRequest from a dict +slides_export_request_from_dict = SlidesExportRequest.from_dict(slides_export_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SmartFunctionResponse.md b/gooddata-api-client/docs/SmartFunctionResponse.md index 887be7b5f..d13f16227 100644 --- a/gooddata-api-client/docs/SmartFunctionResponse.md +++ b/gooddata-api-client/docs/SmartFunctionResponse.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**ExecutionLinks**](ExecutionLinks.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.smart_function_response import SmartFunctionResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of SmartFunctionResponse from a JSON string +smart_function_response_instance = SmartFunctionResponse.from_json(json) +# print the JSON string representation of the object +print(SmartFunctionResponse.to_json()) + +# convert the object into a dict +smart_function_response_dict = smart_function_response_instance.to_dict() +# create an instance of SmartFunctionResponse from a dict +smart_function_response_from_dict = SmartFunctionResponse.from_dict(smart_function_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SmartFunctionsApi.md b/gooddata-api-client/docs/SmartFunctionsApi.md index 7c122dfba..d99bfdff7 100644 --- a/gooddata-api-client/docs/SmartFunctionsApi.md +++ b/gooddata-api-client/docs/SmartFunctionsApi.md @@ -38,12 +38,12 @@ Method | HTTP request | Description ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.chat_request import ChatRequest +from gooddata_api_client.models.chat_request import ChatRequest +from gooddata_api_client.models.chat_result import ChatResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -52,44 +52,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - chat_request = ChatRequest( - limit_create=3, - limit_create_context=10, - limit_search=5, - question="question_example", - relevant_score_threshold=0.45, - search_score_threshold=0.9, - thread_id_suffix="thread_id_suffix_example", - title_to_descriptor_ratio=0.7, - user_context=UserContext( - active_object=ActiveObjectIdentification( - id="id_example", - type="type_example", - workspace_id="workspace_id_example", - ), - ), - ) # ChatRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + chat_request = gooddata_api_client.ChatRequest() # ChatRequest | + try: # (BETA) Chat with AI api_response = api_instance.ai_chat(workspace_id, chat_request) + print("The response of SmartFunctionsApi->ai_chat:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->ai_chat: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **chat_request** | [**ChatRequest**](ChatRequest.md)| | + **workspace_id** | **str**| Workspace identifier | + **chat_request** | [**ChatRequest**](ChatRequest.md)| | ### Return type @@ -104,7 +90,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -124,12 +109,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_history_request import ChatHistoryRequest +from gooddata_api_client.models.chat_history_request import ChatHistoryRequest +from gooddata_api_client.models.chat_history_result import ChatHistoryResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -138,38 +123,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - chat_history_request = ChatHistoryRequest( - chat_history_interaction_id="chat_history_interaction_id_example", - reset=True, - response_state="SUCCESSFUL", - saved_visualization=SavedVisualization( - created_visualization_id="created_visualization_id_example", - saved_visualization_id="saved_visualization_id_example", - ), - thread_id_suffix="thread_id_suffix_example", - user_feedback="POSITIVE", - ) # ChatHistoryRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + chat_history_request = gooddata_api_client.ChatHistoryRequest() # ChatHistoryRequest | + try: # (BETA) Get Chat History api_response = api_instance.ai_chat_history(workspace_id, chat_history_request) + print("The response of SmartFunctionsApi->ai_chat_history:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->ai_chat_history: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **chat_history_request** | [**ChatHistoryRequest**](ChatHistoryRequest.md)| | + **workspace_id** | **str**| Workspace identifier | + **chat_history_request** | [**ChatHistoryRequest**](ChatHistoryRequest.md)| | ### Return type @@ -184,7 +161,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -194,7 +170,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_chat_stream** -> [dict] ai_chat_stream(workspace_id, chat_request) +> List[object] ai_chat_stream(workspace_id, chat_request) (BETA) Chat with AI @@ -204,11 +180,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.chat_request import ChatRequest +from gooddata_api_client.models.chat_request import ChatRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -217,48 +193,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - chat_request = ChatRequest( - limit_create=3, - limit_create_context=10, - limit_search=5, - question="question_example", - relevant_score_threshold=0.45, - search_score_threshold=0.9, - thread_id_suffix="thread_id_suffix_example", - title_to_descriptor_ratio=0.7, - user_context=UserContext( - active_object=ActiveObjectIdentification( - id="id_example", - type="type_example", - workspace_id="workspace_id_example", - ), - ), - ) # ChatRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + chat_request = gooddata_api_client.ChatRequest() # ChatRequest | + try: # (BETA) Chat with AI api_response = api_instance.ai_chat_stream(workspace_id, chat_request) + print("The response of SmartFunctionsApi->ai_chat_stream:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->ai_chat_stream: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **chat_request** | [**ChatRequest**](ChatRequest.md)| | + **workspace_id** | **str**| Workspace identifier | + **chat_request** | [**ChatRequest**](ChatRequest.md)| | ### Return type -**[dict]** +**List[object]** ### Authorization @@ -269,7 +231,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: text/event-stream - ### HTTP response details | Status code | Description | Response headers | @@ -289,11 +250,11 @@ Returns usage statistics of chat for a user in a workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.chat_usage_response import ChatUsageResponse +from gooddata_api_client.models.chat_usage_response import ChatUsageResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -302,26 +263,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier - # example passing only required values which don't have defaults set try: # Get Chat Usage api_response = api_instance.ai_chat_usage(workspace_id) + print("The response of SmartFunctionsApi->ai_chat_usage:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->ai_chat_usage: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| Workspace identifier | ### Return type @@ -336,7 +299,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -356,12 +318,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.search_result import SearchResult -from gooddata_api_client.model.search_request import SearchRequest +from gooddata_api_client.models.search_request import SearchRequest +from gooddata_api_client.models.search_result import SearchResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -370,38 +332,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - search_request = SearchRequest( - deep_search=False, - include_hidden=False, - limit=10, - object_types=[ - "attribute", - ], - question="question_example", - relevant_score_threshold=0.3, - title_to_descriptor_ratio=0.7, - ) # SearchRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + search_request = gooddata_api_client.SearchRequest() # SearchRequest | + try: # (BETA) Semantic Search in Metadata api_response = api_instance.ai_search(workspace_id, search_request) + print("The response of SmartFunctionsApi->ai_search:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->ai_search: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **search_request** | [**SearchRequest**](SearchRequest.md)| | + **workspace_id** | **str**| Workspace identifier | + **search_request** | [**SearchRequest**](SearchRequest.md)| | ### Return type @@ -416,7 +370,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -426,7 +379,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **anomaly_detection** -> SmartFunctionResponse anomaly_detection(workspace_id, result_id, anomaly_detection_request) +> SmartFunctionResponse anomaly_detection(workspace_id, result_id, anomaly_detection_request, skip_cache=skip_cache) (EXPERIMENTAL) Smart functions - Anomaly Detection @@ -436,12 +389,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.anomaly_detection_request import AnomalyDetectionRequest -from gooddata_api_client.model.smart_function_response import SmartFunctionResponse +from gooddata_api_client.models.anomaly_detection_request import AnomalyDetectionRequest +from gooddata_api_client.models.smart_function_response import SmartFunctionResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -450,43 +403,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "9bd52018570364264fcf62d373da6bed313120e8" # str | Input result ID to be used in the computation - anomaly_detection_request = AnomalyDetectionRequest( - sensitivity=3.14, - ) # AnomalyDetectionRequest | - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Smart functions - Anomaly Detection - api_response = api_instance.anomaly_detection(workspace_id, result_id, anomaly_detection_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling SmartFunctionsApi->anomaly_detection: %s\n" % e) + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = '9bd52018570364264fcf62d373da6bed313120e8' # str | Input result ID to be used in the computation + anomaly_detection_request = gooddata_api_client.AnomalyDetectionRequest() # AnomalyDetectionRequest | + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Smart functions - Anomaly Detection api_response = api_instance.anomaly_detection(workspace_id, result_id, anomaly_detection_request, skip_cache=skip_cache) + print("The response of SmartFunctionsApi->anomaly_detection:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->anomaly_detection: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Input result ID to be used in the computation | - **anomaly_detection_request** | [**AnomalyDetectionRequest**](AnomalyDetectionRequest.md)| | - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Input result ID to be used in the computation | + **anomaly_detection_request** | [**AnomalyDetectionRequest**](AnomalyDetectionRequest.md)| | + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] ### Return type @@ -501,7 +445,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -511,7 +454,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **anomaly_detection_result** -> AnomalyDetectionResult anomaly_detection_result(workspace_id, result_id) +> AnomalyDetectionResult anomaly_detection_result(workspace_id, result_id, offset=offset, limit=limit) (EXPERIMENTAL) Smart functions - Anomaly Detection Result @@ -521,11 +464,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.anomaly_detection_result import AnomalyDetectionResult +from gooddata_api_client.models.anomaly_detection_result import AnomalyDetectionResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -534,41 +477,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID - offset = 1 # int | (optional) - limit = 1 # int | (optional) - - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Smart functions - Anomaly Detection Result - api_response = api_instance.anomaly_detection_result(workspace_id, result_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling SmartFunctionsApi->anomaly_detection_result: %s\n" % e) + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID + offset = 56 # int | (optional) + limit = 56 # int | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Smart functions - Anomaly Detection Result api_response = api_instance.anomaly_detection_result(workspace_id, result_id, offset=offset, limit=limit) + print("The response of SmartFunctionsApi->anomaly_detection_result:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->anomaly_detection_result: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | - **offset** | **int**| | [optional] - **limit** | **int**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **offset** | **int**| | [optional] + **limit** | **int**| | [optional] ### Return type @@ -583,7 +519,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -593,7 +528,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **clustering** -> SmartFunctionResponse clustering(workspace_id, result_id, clustering_request) +> SmartFunctionResponse clustering(workspace_id, result_id, clustering_request, skip_cache=skip_cache) (EXPERIMENTAL) Smart functions - Clustering @@ -603,12 +538,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.clustering_request import ClusteringRequest -from gooddata_api_client.model.smart_function_response import SmartFunctionResponse +from gooddata_api_client.models.clustering_request import ClusteringRequest +from gooddata_api_client.models.smart_function_response import SmartFunctionResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -617,44 +552,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "9bd52018570364264fcf62d373da6bed313120e8" # str | Input result ID to be used in the computation - clustering_request = ClusteringRequest( - number_of_clusters=1, - threshold=0.03, - ) # ClusteringRequest | - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Smart functions - Clustering - api_response = api_instance.clustering(workspace_id, result_id, clustering_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling SmartFunctionsApi->clustering: %s\n" % e) + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = '9bd52018570364264fcf62d373da6bed313120e8' # str | Input result ID to be used in the computation + clustering_request = gooddata_api_client.ClusteringRequest() # ClusteringRequest | + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Smart functions - Clustering api_response = api_instance.clustering(workspace_id, result_id, clustering_request, skip_cache=skip_cache) + print("The response of SmartFunctionsApi->clustering:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->clustering: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Input result ID to be used in the computation | - **clustering_request** | [**ClusteringRequest**](ClusteringRequest.md)| | - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Input result ID to be used in the computation | + **clustering_request** | [**ClusteringRequest**](ClusteringRequest.md)| | + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] ### Return type @@ -669,7 +594,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -679,7 +603,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **clustering_result** -> ClusteringResult clustering_result(workspace_id, result_id) +> ClusteringResult clustering_result(workspace_id, result_id, offset=offset, limit=limit) (EXPERIMENTAL) Smart functions - Clustering Result @@ -689,11 +613,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.clustering_result import ClusteringResult +from gooddata_api_client.models.clustering_result import ClusteringResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -702,41 +626,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID - offset = 1 # int | (optional) - limit = 1 # int | (optional) + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID + offset = 56 # int | (optional) + limit = 56 # int | (optional) - # example passing only required values which don't have defaults set - try: - # (EXPERIMENTAL) Smart functions - Clustering Result - api_response = api_instance.clustering_result(workspace_id, result_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling SmartFunctionsApi->clustering_result: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # (EXPERIMENTAL) Smart functions - Clustering Result api_response = api_instance.clustering_result(workspace_id, result_id, offset=offset, limit=limit) + print("The response of SmartFunctionsApi->clustering_result:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->clustering_result: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | - **offset** | **int**| | [optional] - **limit** | **int**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **offset** | **int**| | [optional] + **limit** | **int**| | [optional] ### Return type @@ -751,7 +668,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -771,11 +687,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.memory_item import MemoryItem +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -784,45 +700,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - memory_item = MemoryItem( - id="id_example", - instruction="instruction_example", - keywords=[ - "keywords_example", - ], - strategy="MEMORY_ITEM_STRATEGY_ALLWAYS", - use_cases=MemoryItemUseCases( - general=True, - howto=True, - keywords=True, - metric=True, - normalize=True, - router=True, - search=True, - visualization=True, - ), - ) # MemoryItem | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + memory_item = gooddata_api_client.MemoryItem() # MemoryItem | + try: # (EXPERIMENTAL) Create new memory item api_response = api_instance.create_memory_item(workspace_id, memory_item) + print("The response of SmartFunctionsApi->create_memory_item:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->create_memory_item: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **memory_item** | [**MemoryItem**](MemoryItem.md)| | + **workspace_id** | **str**| Workspace identifier | + **memory_item** | [**MemoryItem**](MemoryItem.md)| | ### Return type @@ -837,7 +738,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -847,7 +747,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **forecast** -> SmartFunctionResponse forecast(workspace_id, result_id, forecast_request) +> SmartFunctionResponse forecast(workspace_id, result_id, forecast_request, skip_cache=skip_cache) (BETA) Smart functions - Forecast @@ -857,12 +757,12 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.forecast_request import ForecastRequest -from gooddata_api_client.model.smart_function_response import SmartFunctionResponse +from gooddata_api_client.models.forecast_request import ForecastRequest +from gooddata_api_client.models.smart_function_response import SmartFunctionResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -871,45 +771,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "9bd52018570364264fcf62d373da6bed313120e8" # str | Input result ID to be used in the computation - forecast_request = ForecastRequest( - confidence_level=0.95, - forecast_period=1, - seasonal=False, - ) # ForecastRequest | - skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # (BETA) Smart functions - Forecast - api_response = api_instance.forecast(workspace_id, result_id, forecast_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling SmartFunctionsApi->forecast: %s\n" % e) + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = '9bd52018570364264fcf62d373da6bed313120e8' # str | Input result ID to be used in the computation + forecast_request = gooddata_api_client.ForecastRequest() # ForecastRequest | + skip_cache = False # bool | Ignore all caches during execution of current request. (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # (BETA) Smart functions - Forecast api_response = api_instance.forecast(workspace_id, result_id, forecast_request, skip_cache=skip_cache) + print("The response of SmartFunctionsApi->forecast:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->forecast: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Input result ID to be used in the computation | - **forecast_request** | [**ForecastRequest**](ForecastRequest.md)| | - **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Input result ID to be used in the computation | + **forecast_request** | [**ForecastRequest**](ForecastRequest.md)| | + **skip_cache** | **bool**| Ignore all caches during execution of current request. | [optional] [default to False] ### Return type @@ -924,7 +813,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -934,7 +822,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **forecast_result** -> ForecastResult forecast_result(workspace_id, result_id) +> ForecastResult forecast_result(workspace_id, result_id, offset=offset, limit=limit) (BETA) Smart functions - Forecast Result @@ -944,11 +832,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.forecast_result import ForecastResult +from gooddata_api_client.models.forecast_result import ForecastResult +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -957,41 +845,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID - offset = 1 # int | (optional) - limit = 1 # int | (optional) - - # example passing only required values which don't have defaults set - try: - # (BETA) Smart functions - Forecast Result - api_response = api_instance.forecast_result(workspace_id, result_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling SmartFunctionsApi->forecast_result: %s\n" % e) + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + result_id = 'a9b28f9dc55f37ea9f4a5fb0c76895923591e781' # str | Result ID + offset = 56 # int | (optional) + limit = 56 # int | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # (BETA) Smart functions - Forecast Result api_response = api_instance.forecast_result(workspace_id, result_id, offset=offset, limit=limit) + print("The response of SmartFunctionsApi->forecast_result:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->forecast_result: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **result_id** | **str**| Result ID | - **offset** | **int**| | [optional] - **limit** | **int**| | [optional] + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **offset** | **int**| | [optional] + **limit** | **int**| | [optional] ### Return type @@ -1006,7 +887,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1026,11 +906,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.memory_item import MemoryItem +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1039,28 +919,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - memory_id = "memoryId_example" # str | + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + memory_id = 'memory_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Get memory item api_response = api_instance.get_memory_item(workspace_id, memory_id) + print("The response of SmartFunctionsApi->get_memory_item:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->get_memory_item: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **memory_id** | **str**| | + **workspace_id** | **str**| Workspace identifier | + **memory_id** | **str**| | ### Return type @@ -1075,7 +957,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1095,11 +976,11 @@ Returns metadata quality issues detected by the platform linter. ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse +from gooddata_api_client.models.get_quality_issues_response import GetQualityIssuesResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1108,26 +989,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier - # example passing only required values which don't have defaults set try: # Get Quality Issues api_response = api_instance.get_quality_issues(workspace_id) + print("The response of SmartFunctionsApi->get_quality_issues:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->get_quality_issues: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| Workspace identifier | ### Return type @@ -1142,7 +1025,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1152,7 +1034,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **list_memory_items** -> [MemoryItem] list_memory_items(workspace_id) +> List[MemoryItem] list_memory_items(workspace_id) (EXPERIMENTAL) List all memory items @@ -1162,11 +1044,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.memory_item import MemoryItem +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1175,30 +1057,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) List all memory items api_response = api_instance.list_memory_items(workspace_id) + print("The response of SmartFunctionsApi->list_memory_items:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->list_memory_items: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| Workspace identifier | ### Return type -[**[MemoryItem]**](MemoryItem.md) +[**List[MemoryItem]**](MemoryItem.md) ### Authorization @@ -1209,7 +1093,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1229,10 +1112,10 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1241,27 +1124,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - memory_id = "memoryId_example" # str | + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + memory_id = 'memory_id_example' # str | - # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Remove memory item api_instance.remove_memory_item(workspace_id, memory_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->remove_memory_item: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **memory_id** | **str**| | + **workspace_id** | **str**| Workspace identifier | + **memory_id** | **str**| | ### Return type @@ -1276,7 +1160,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1296,11 +1179,11 @@ Returns a list of available LLM Endpoints ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.resolved_llm_endpoints import ResolvedLlmEndpoints +from gooddata_api_client.models.resolved_llm_endpoints import ResolvedLlmEndpoints +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1309,26 +1192,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier - # example passing only required values which don't have defaults set try: # Get Active LLM Endpoints for this workspace api_response = api_instance.resolve_llm_endpoints(workspace_id) + print("The response of SmartFunctionsApi->resolve_llm_endpoints:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->resolve_llm_endpoints: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| Workspace identifier | ### Return type @@ -1343,7 +1228,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1363,11 +1247,11 @@ Returns a list of tags for this workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags +from gooddata_api_client.models.analytics_catalog_tags import AnalyticsCatalogTags +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1376,26 +1260,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier - # example passing only required values which don't have defaults set try: # Get Analytics Catalog Tags api_response = api_instance.tags(workspace_id) + print("The response of SmartFunctionsApi->tags:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->tags: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| Workspace identifier | ### Return type @@ -1410,7 +1296,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1430,11 +1315,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.memory_item import MemoryItem +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1443,47 +1328,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - memory_id = "memoryId_example" # str | - memory_item = MemoryItem( - id="id_example", - instruction="instruction_example", - keywords=[ - "keywords_example", - ], - strategy="MEMORY_ITEM_STRATEGY_ALLWAYS", - use_cases=MemoryItemUseCases( - general=True, - howto=True, - keywords=True, - metric=True, - normalize=True, - router=True, - search=True, - visualization=True, - ), - ) # MemoryItem | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + workspace_id = 'workspace_id_example' # str | Workspace identifier + memory_id = 'memory_id_example' # str | + memory_item = gooddata_api_client.MemoryItem() # MemoryItem | + try: # (EXPERIMENTAL) Update memory item api_response = api_instance.update_memory_item(workspace_id, memory_id, memory_item) + print("The response of SmartFunctionsApi->update_memory_item:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->update_memory_item: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **memory_id** | **str**| | - **memory_item** | [**MemoryItem**](MemoryItem.md)| | + **workspace_id** | **str**| Workspace identifier | + **memory_id** | **str**| | + **memory_item** | [**MemoryItem**](MemoryItem.md)| | ### Return type @@ -1498,7 +1368,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1518,12 +1387,12 @@ Validates LLM endpoint with provided parameters. ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse -from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest +from gooddata_api_client.models.validate_llm_endpoint_request import ValidateLLMEndpointRequest +from gooddata_api_client.models.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1532,32 +1401,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - validate_llm_endpoint_request = ValidateLLMEndpointRequest( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="provider_example", - token="token_example", - ) # ValidateLLMEndpointRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + validate_llm_endpoint_request = gooddata_api_client.ValidateLLMEndpointRequest() # ValidateLLMEndpointRequest | + try: # Validate LLM Endpoint api_response = api_instance.validate_llm_endpoint(validate_llm_endpoint_request) + print("The response of SmartFunctionsApi->validate_llm_endpoint:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->validate_llm_endpoint: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **validate_llm_endpoint_request** | [**ValidateLLMEndpointRequest**](ValidateLLMEndpointRequest.md)| | + **validate_llm_endpoint_request** | [**ValidateLLMEndpointRequest**](ValidateLLMEndpointRequest.md)| | ### Return type @@ -1572,7 +1437,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1582,7 +1446,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **validate_llm_endpoint_by_id** -> ValidateLLMEndpointResponse validate_llm_endpoint_by_id(llm_endpoint_id) +> ValidateLLMEndpointResponse validate_llm_endpoint_by_id(llm_endpoint_id, validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request) Validate LLM Endpoint By Id @@ -1592,12 +1456,12 @@ Validates existing LLM endpoint with provided parameters and updates it if they ```python -import time import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse -from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest +from gooddata_api_client.models.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest +from gooddata_api_client.models.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1606,43 +1470,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = smart_functions_api.SmartFunctionsApi(api_client) - llm_endpoint_id = "llmEndpointId_example" # str | - validate_llm_endpoint_by_id_request = ValidateLLMEndpointByIdRequest( - base_url="base_url_example", - llm_model="llm_model_example", - llm_organization="llm_organization_example", - provider="provider_example", - token="token_example", - ) # ValidateLLMEndpointByIdRequest | (optional) - - # example passing only required values which don't have defaults set - try: - # Validate LLM Endpoint By Id - api_response = api_instance.validate_llm_endpoint_by_id(llm_endpoint_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling SmartFunctionsApi->validate_llm_endpoint_by_id: %s\n" % e) + api_instance = gooddata_api_client.SmartFunctionsApi(api_client) + llm_endpoint_id = 'llm_endpoint_id_example' # str | + validate_llm_endpoint_by_id_request = gooddata_api_client.ValidateLLMEndpointByIdRequest() # ValidateLLMEndpointByIdRequest | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Validate LLM Endpoint By Id api_response = api_instance.validate_llm_endpoint_by_id(llm_endpoint_id, validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request) + print("The response of SmartFunctionsApi->validate_llm_endpoint_by_id:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling SmartFunctionsApi->validate_llm_endpoint_by_id: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **llm_endpoint_id** | **str**| | - **validate_llm_endpoint_by_id_request** | [**ValidateLLMEndpointByIdRequest**](ValidateLLMEndpointByIdRequest.md)| | [optional] + **llm_endpoint_id** | **str**| | + **validate_llm_endpoint_by_id_request** | [**ValidateLLMEndpointByIdRequest**](ValidateLLMEndpointByIdRequest.md)| | [optional] ### Return type @@ -1657,7 +1508,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/Smtp.md b/gooddata-api-client/docs/Smtp.md index 8261d2624..7ca3786b9 100644 --- a/gooddata-api-client/docs/Smtp.md +++ b/gooddata-api-client/docs/Smtp.md @@ -3,17 +3,34 @@ Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | The destination type. | defaults to "SMTP" -**from_email** | **str** | E-mail address to send notifications from. | [optional] if omitted the server will use the default value of no-reply@gooddata.com -**from_email_name** | **str** | An optional e-mail name to send notifications from. | [optional] if omitted the server will use the default value of "GoodData" +**from_email** | **str** | E-mail address to send notifications from. | [optional] [default to 'no-reply@gooddata.com'] +**from_email_name** | **str** | An optional e-mail name to send notifications from. | [optional] [default to 'GoodData'] **host** | **str** | The SMTP server address. | [optional] **password** | **str** | The SMTP server password. | [optional] **port** | **int** | The SMTP server port. | [optional] +**type** | **str** | The destination type. | **username** | **str** | The SMTP server username. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.smtp import Smtp + +# TODO update the JSON string below +json = "{}" +# create an instance of Smtp from a JSON string +smtp_instance = Smtp.from_json(json) +# print the JSON string representation of the object +print(Smtp.to_json()) + +# convert the object into a dict +smtp_dict = smtp_instance.to_dict() +# create an instance of Smtp from a dict +smtp_from_dict = Smtp.from_dict(smtp_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SmtpAllOf.md b/gooddata-api-client/docs/SmtpAllOf.md deleted file mode 100644 index 1eccc4ee3..000000000 --- a/gooddata-api-client/docs/SmtpAllOf.md +++ /dev/null @@ -1,18 +0,0 @@ -# SmtpAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**from_email** | **str** | E-mail address to send notifications from. | [optional] if omitted the server will use the default value of no-reply@gooddata.com -**from_email_name** | **str** | An optional e-mail name to send notifications from. | [optional] if omitted the server will use the default value of "GoodData" -**host** | **str** | The SMTP server address. | [optional] -**password** | **str** | The SMTP server password. | [optional] -**port** | **int** | The SMTP server port. | [optional] -**type** | **str** | The destination type. | [optional] if omitted the server will use the default value of "SMTP" -**username** | **str** | The SMTP server username. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/SortKey.md b/gooddata-api-client/docs/SortKey.md index a07267fc8..da77857f0 100644 --- a/gooddata-api-client/docs/SortKey.md +++ b/gooddata-api-client/docs/SortKey.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attribute** | [**SortKeyAttributeAttribute**](SortKeyAttributeAttribute.md) | | [optional] -**value** | [**SortKeyValueValue**](SortKeyValueValue.md) | | [optional] -**total** | [**SortKeyTotalTotal**](SortKeyTotalTotal.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**attribute** | [**SortKeyAttributeAttribute**](SortKeyAttributeAttribute.md) | | +**value** | [**SortKeyValueValue**](SortKeyValueValue.md) | | +**total** | [**SortKeyTotalTotal**](SortKeyTotalTotal.md) | | + +## Example + +```python +from gooddata_api_client.models.sort_key import SortKey + +# TODO update the JSON string below +json = "{}" +# create an instance of SortKey from a JSON string +sort_key_instance = SortKey.from_json(json) +# print the JSON string representation of the object +print(SortKey.to_json()) +# convert the object into a dict +sort_key_dict = sort_key_instance.to_dict() +# create an instance of SortKey from a dict +sort_key_from_dict = SortKey.from_dict(sort_key_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SortKeyAttribute.md b/gooddata-api-client/docs/SortKeyAttribute.md index b063eec36..d7cbb9823 100644 --- a/gooddata-api-client/docs/SortKeyAttribute.md +++ b/gooddata-api-client/docs/SortKeyAttribute.md @@ -3,11 +3,28 @@ Sorting rule for sorting by attribute value in current dimension. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute** | [**SortKeyAttributeAttribute**](SortKeyAttributeAttribute.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.sort_key_attribute import SortKeyAttribute + +# TODO update the JSON string below +json = "{}" +# create an instance of SortKeyAttribute from a JSON string +sort_key_attribute_instance = SortKeyAttribute.from_json(json) +# print the JSON string representation of the object +print(SortKeyAttribute.to_json()) + +# convert the object into a dict +sort_key_attribute_dict = sort_key_attribute_instance.to_dict() +# create an instance of SortKeyAttribute from a dict +sort_key_attribute_from_dict = SortKeyAttribute.from_dict(sort_key_attribute_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SortKeyAttributeAttribute.md b/gooddata-api-client/docs/SortKeyAttributeAttribute.md index b29c71196..7a8358f59 100644 --- a/gooddata-api-client/docs/SortKeyAttributeAttribute.md +++ b/gooddata-api-client/docs/SortKeyAttributeAttribute.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute_identifier** | **str** | Item reference (to 'itemIdentifiers') referencing, which item should be used for sorting. Only references to attributes are allowed. | **direction** | **str** | Sorting elements - ascending/descending order. | [optional] -**sort_type** | **str** | Mechanism by which this attribute should be sorted. Available options are: - DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) - LABEL: sorting by this label values - ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label) - ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions. | [optional] if omitted the server will use the default value of "DEFAULT" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**sort_type** | **str** | Mechanism by which this attribute should be sorted. Available options are: - DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) - LABEL: sorting by this label values - ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label) - ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions. | [optional] [default to 'DEFAULT'] + +## Example + +```python +from gooddata_api_client.models.sort_key_attribute_attribute import SortKeyAttributeAttribute + +# TODO update the JSON string below +json = "{}" +# create an instance of SortKeyAttributeAttribute from a JSON string +sort_key_attribute_attribute_instance = SortKeyAttributeAttribute.from_json(json) +# print the JSON string representation of the object +print(SortKeyAttributeAttribute.to_json()) +# convert the object into a dict +sort_key_attribute_attribute_dict = sort_key_attribute_attribute_instance.to_dict() +# create an instance of SortKeyAttributeAttribute from a dict +sort_key_attribute_attribute_from_dict = SortKeyAttributeAttribute.from_dict(sort_key_attribute_attribute_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SortKeyTotal.md b/gooddata-api-client/docs/SortKeyTotal.md index 4b2042048..3ec9d10db 100644 --- a/gooddata-api-client/docs/SortKeyTotal.md +++ b/gooddata-api-client/docs/SortKeyTotal.md @@ -3,11 +3,28 @@ Sorting rule for sorting by total value. DataColumnLocators are only required if there is ambiguity. Locator for measureGroup is taken from the metric of the total. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total** | [**SortKeyTotalTotal**](SortKeyTotalTotal.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.sort_key_total import SortKeyTotal + +# TODO update the JSON string below +json = "{}" +# create an instance of SortKeyTotal from a JSON string +sort_key_total_instance = SortKeyTotal.from_json(json) +# print the JSON string representation of the object +print(SortKeyTotal.to_json()) + +# convert the object into a dict +sort_key_total_dict = sort_key_total_instance.to_dict() +# create an instance of SortKeyTotal from a dict +sort_key_total_from_dict = SortKeyTotal.from_dict(sort_key_total_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SortKeyTotalTotal.md b/gooddata-api-client/docs/SortKeyTotalTotal.md index 37340dc5d..4b7a7f4ad 100644 --- a/gooddata-api-client/docs/SortKeyTotalTotal.md +++ b/gooddata-api-client/docs/SortKeyTotalTotal.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total_identifier** | **str** | Local identifier of the total to sort by. | **data_column_locators** | [**DataColumnLocators**](DataColumnLocators.md) | | [optional] **direction** | **str** | Sorting elements - ascending/descending order. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**total_identifier** | **str** | Local identifier of the total to sort by. | + +## Example + +```python +from gooddata_api_client.models.sort_key_total_total import SortKeyTotalTotal + +# TODO update the JSON string below +json = "{}" +# create an instance of SortKeyTotalTotal from a JSON string +sort_key_total_total_instance = SortKeyTotalTotal.from_json(json) +# print the JSON string representation of the object +print(SortKeyTotalTotal.to_json()) +# convert the object into a dict +sort_key_total_total_dict = sort_key_total_total_instance.to_dict() +# create an instance of SortKeyTotalTotal from a dict +sort_key_total_total_from_dict = SortKeyTotalTotal.from_dict(sort_key_total_total_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SortKeyValue.md b/gooddata-api-client/docs/SortKeyValue.md index 5daa1dd0d..5c474cf41 100644 --- a/gooddata-api-client/docs/SortKeyValue.md +++ b/gooddata-api-client/docs/SortKeyValue.md @@ -3,11 +3,28 @@ Sorting rule for sorting by measure value. DataColumnLocators for each dimension opposite to the sorted one must be specified. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | [**SortKeyValueValue**](SortKeyValueValue.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.sort_key_value import SortKeyValue + +# TODO update the JSON string below +json = "{}" +# create an instance of SortKeyValue from a JSON string +sort_key_value_instance = SortKeyValue.from_json(json) +# print the JSON string representation of the object +print(SortKeyValue.to_json()) + +# convert the object into a dict +sort_key_value_dict = sort_key_value_instance.to_dict() +# create an instance of SortKeyValue from a dict +sort_key_value_from_dict = SortKeyValue.from_dict(sort_key_value_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SortKeyValueValue.md b/gooddata-api-client/docs/SortKeyValueValue.md index 73ddef89d..019cc62c7 100644 --- a/gooddata-api-client/docs/SortKeyValueValue.md +++ b/gooddata-api-client/docs/SortKeyValueValue.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_column_locators** | [**DataColumnLocators**](DataColumnLocators.md) | | **direction** | **str** | Sorting elements - ascending/descending order. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.sort_key_value_value import SortKeyValueValue + +# TODO update the JSON string below +json = "{}" +# create an instance of SortKeyValueValue from a JSON string +sort_key_value_value_instance = SortKeyValueValue.from_json(json) +# print the JSON string representation of the object +print(SortKeyValueValue.to_json()) + +# convert the object into a dict +sort_key_value_value_dict = sort_key_value_value_instance.to_dict() +# create an instance of SortKeyValueValue from a dict +sort_key_value_value_from_dict = SortKeyValueValue.from_dict(sort_key_value_value_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SqlColumn.md b/gooddata-api-client/docs/SqlColumn.md index 13e3460b0..8e74a2668 100644 --- a/gooddata-api-client/docs/SqlColumn.md +++ b/gooddata-api-client/docs/SqlColumn.md @@ -3,12 +3,29 @@ A SQL query result column. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_type** | **str** | Column type | **name** | **str** | Column name | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.sql_column import SqlColumn + +# TODO update the JSON string below +json = "{}" +# create an instance of SqlColumn from a JSON string +sql_column_instance = SqlColumn.from_json(json) +# print the JSON string representation of the object +print(SqlColumn.to_json()) + +# convert the object into a dict +sql_column_dict = sql_column_instance.to_dict() +# create an instance of SqlColumn from a dict +sql_column_from_dict = SqlColumn.from_dict(sql_column_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SqlQuery.md b/gooddata-api-client/docs/SqlQuery.md index 98c101025..ff34aa698 100644 --- a/gooddata-api-client/docs/SqlQuery.md +++ b/gooddata-api-client/docs/SqlQuery.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sql** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.sql_query import SqlQuery + +# TODO update the JSON string below +json = "{}" +# create an instance of SqlQuery from a JSON string +sql_query_instance = SqlQuery.from_json(json) +# print the JSON string representation of the object +print(SqlQuery.to_json()) + +# convert the object into a dict +sql_query_dict = sql_query_instance.to_dict() +# create an instance of SqlQuery from a dict +sql_query_from_dict = SqlQuery.from_dict(sql_query_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SqlQueryAllOf.md b/gooddata-api-client/docs/SqlQueryAllOf.md deleted file mode 100644 index c06185fa8..000000000 --- a/gooddata-api-client/docs/SqlQueryAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# SqlQueryAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sql** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/Suggestion.md b/gooddata-api-client/docs/Suggestion.md index 2465bb44c..177f9fe4e 100644 --- a/gooddata-api-client/docs/Suggestion.md +++ b/gooddata-api-client/docs/Suggestion.md @@ -3,12 +3,29 @@ List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **label** | **str** | Suggestion button label | **query** | **str** | Suggestion query | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.suggestion import Suggestion + +# TODO update the JSON string below +json = "{}" +# create an instance of Suggestion from a JSON string +suggestion_instance = Suggestion.from_json(json) +# print the JSON string representation of the object +print(Suggestion.to_json()) + +# convert the object into a dict +suggestion_dict = suggestion_instance.to_dict() +# create an instance of Suggestion from a dict +suggestion_from_dict = Suggestion.from_dict(suggestion_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SwitchIdentityProviderRequest.md b/gooddata-api-client/docs/SwitchIdentityProviderRequest.md index 88db80908..16300001e 100644 --- a/gooddata-api-client/docs/SwitchIdentityProviderRequest.md +++ b/gooddata-api-client/docs/SwitchIdentityProviderRequest.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **idp_id** | **str** | Identity provider ID to set as active for the organization. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.switch_identity_provider_request import SwitchIdentityProviderRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of SwitchIdentityProviderRequest from a JSON string +switch_identity_provider_request_instance = SwitchIdentityProviderRequest.from_json(json) +# print the JSON string representation of the object +print(SwitchIdentityProviderRequest.to_json()) + +# convert the object into a dict +switch_identity_provider_request_dict = switch_identity_provider_request_instance.to_dict() +# create an instance of SwitchIdentityProviderRequest from a dict +switch_identity_provider_request_from_dict = SwitchIdentityProviderRequest.from_dict(switch_identity_provider_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Table.md b/gooddata-api-client/docs/Table.md index 68c4ca937..095947d26 100644 --- a/gooddata-api-client/docs/Table.md +++ b/gooddata-api-client/docs/Table.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **table_name** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.table import Table + +# TODO update the JSON string below +json = "{}" +# create an instance of Table from a JSON string +table_instance = Table.from_json(json) +# print the JSON string representation of the object +print(Table.to_json()) + +# convert the object into a dict +table_dict = table_instance.to_dict() +# create an instance of Table from a dict +table_from_dict = Table.from_dict(table_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TableAllOf.md b/gooddata-api-client/docs/TableAllOf.md deleted file mode 100644 index 365a36d2e..000000000 --- a/gooddata-api-client/docs/TableAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# TableAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**table_name** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/TableOverride.md b/gooddata-api-client/docs/TableOverride.md index 0fbb19402..c07989bc2 100644 --- a/gooddata-api-client/docs/TableOverride.md +++ b/gooddata-api-client/docs/TableOverride.md @@ -3,12 +3,29 @@ Table override settings. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**columns** | [**[ColumnOverride]**](ColumnOverride.md) | An array of column overrides | -**path** | **[str]** | Path for the table. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**columns** | [**List[ColumnOverride]**](ColumnOverride.md) | An array of column overrides | +**path** | **List[str]** | Path for the table. | + +## Example + +```python +from gooddata_api_client.models.table_override import TableOverride + +# TODO update the JSON string below +json = "{}" +# create an instance of TableOverride from a JSON string +table_override_instance = TableOverride.from_json(json) +# print the JSON string representation of the object +print(TableOverride.to_json()) +# convert the object into a dict +table_override_dict = table_override_instance.to_dict() +# create an instance of TableOverride from a dict +table_override_from_dict = TableOverride.from_dict(table_override_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TableWarning.md b/gooddata-api-client/docs/TableWarning.md index 7d3b06eca..568155ae9 100644 --- a/gooddata-api-client/docs/TableWarning.md +++ b/gooddata-api-client/docs/TableWarning.md @@ -3,13 +3,30 @@ Warnings related to single table. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**columns** | [**[ColumnWarning]**](ColumnWarning.md) | | -**name** | **str** | Table name. | +**columns** | [**List[ColumnWarning]**](ColumnWarning.md) | | **message** | **str** | Warning message related to the table. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**name** | **str** | Table name. | + +## Example + +```python +from gooddata_api_client.models.table_warning import TableWarning + +# TODO update the JSON string below +json = "{}" +# create an instance of TableWarning from a JSON string +table_warning_instance = TableWarning.from_json(json) +# print the JSON string representation of the object +print(TableWarning.to_json()) +# convert the object into a dict +table_warning_dict = table_warning_instance.to_dict() +# create an instance of TableWarning from a dict +table_warning_from_dict = TableWarning.from_dict(table_warning_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TabularExportApi.md b/gooddata-api-client/docs/TabularExportApi.md index 244e36e44..865382cfe 100644 --- a/gooddata-api-client/docs/TabularExportApi.md +++ b/gooddata-api-client/docs/TabularExportApi.md @@ -20,12 +20,12 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python -import time import gooddata_api_client -from gooddata_api_client.api import tabular_export_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.dashboard_tabular_export_request import DashboardTabularExportRequest +from gooddata_api_client.models.dashboard_tabular_export_request import DashboardTabularExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -34,45 +34,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = tabular_export_api.TabularExportApi(api_client) - workspace_id = "workspaceId_example" # str | - dashboard_id = "dashboardId_example" # str | - dashboard_tabular_export_request = DashboardTabularExportRequest( - dashboard_filters_override=[ - DashboardFilter(), - ], - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ) # DashboardTabularExportRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.TabularExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + dashboard_id = 'dashboard_id_example' # str | + dashboard_tabular_export_request = gooddata_api_client.DashboardTabularExportRequest() # DashboardTabularExportRequest | + try: # (EXPERIMENTAL) Create dashboard tabular export request api_response = api_instance.create_dashboard_export_request(workspace_id, dashboard_id, dashboard_tabular_export_request) + print("The response of TabularExportApi->create_dashboard_export_request:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling TabularExportApi->create_dashboard_export_request: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **dashboard_id** | **str**| | - **dashboard_tabular_export_request** | [**DashboardTabularExportRequest**](DashboardTabularExportRequest.md)| | + **workspace_id** | **str**| | + **dashboard_id** | **str**| | + **dashboard_tabular_export_request** | [**DashboardTabularExportRequest**](DashboardTabularExportRequest.md)| | ### Return type @@ -87,7 +74,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -107,12 +93,12 @@ An tabular export job will be created based on the export request and put to que ```python -import time import gooddata_api_client -from gooddata_api_client.api import tabular_export_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -121,72 +107,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = tabular_export_api.TabularExportApi(api_client) - workspace_id = "workspaceId_example" # str | - tabular_export_request = TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ) # TabularExportRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.TabularExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + tabular_export_request = gooddata_api_client.TabularExportRequest() # TabularExportRequest | + try: # Create tabular export request api_response = api_instance.create_tabular_export(workspace_id, tabular_export_request) + print("The response of TabularExportApi->create_tabular_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling TabularExportApi->create_tabular_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **tabular_export_request** | [**TabularExportRequest**](TabularExportRequest.md)| | + **workspace_id** | **str**| | + **tabular_export_request** | [**TabularExportRequest**](TabularExportRequest.md)| | ### Return type @@ -201,7 +145,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -211,7 +154,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_tabular_export** -> file_type get_tabular_export(workspace_id, export_id) +> bytearray get_tabular_export(workspace_id, export_id) Retrieve exported files @@ -221,10 +164,10 @@ After clients creates a POST export request, the processing of it will start sho ```python -import time import gooddata_api_client -from gooddata_api_client.api import tabular_export_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -233,32 +176,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = tabular_export_api.TabularExportApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.TabularExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # Retrieve exported files api_response = api_instance.get_tabular_export(workspace_id, export_id) + print("The response of TabularExportApi->get_tabular_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling TabularExportApi->get_tabular_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -**file_type** +**bytearray** ### Authorization @@ -269,7 +214,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, text/csv, text/html - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/TabularExportRequest.md b/gooddata-api-client/docs/TabularExportRequest.md index 55026f1e5..fd276af89 100644 --- a/gooddata-api-client/docs/TabularExportRequest.md +++ b/gooddata-api-client/docs/TabularExportRequest.md @@ -3,19 +3,36 @@ Export request object describing the export properties and overrides for tabular exports. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**file_name** | **str** | Filename of downloaded file without extension. | -**format** | **str** | Expected file format. | **custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] **execution_result** | **str** | Execution result identifier. | [optional] -**metadata** | [**JsonNode**](JsonNode.md) | | [optional] +**file_name** | **str** | Filename of downloaded file without extension. | +**format** | **str** | Expected file format. | +**metadata** | **object** | Free-form JSON object | [optional] **related_dashboard_id** | **str** | Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard. | [optional] **settings** | [**Settings**](Settings.md) | | [optional] **visualization_object** | **str** | Visualization object identifier. Alternative to executionResult property. | [optional] -**visualization_object_custom_filters** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**visualization_object_custom_filters** | **List[object]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] + +## Example + +```python +from gooddata_api_client.models.tabular_export_request import TabularExportRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of TabularExportRequest from a JSON string +tabular_export_request_instance = TabularExportRequest.from_json(json) +# print the JSON string representation of the object +print(TabularExportRequest.to_json()) +# convert the object into a dict +tabular_export_request_dict = tabular_export_request_instance.to_dict() +# create an instance of TabularExportRequest from a dict +tabular_export_request_from_dict = TabularExportRequest.from_dict(tabular_export_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TestConnectionApi.md b/gooddata-api-client/docs/TestConnectionApi.md index 9fcfab0b5..0094592d0 100644 --- a/gooddata-api-client/docs/TestConnectionApi.md +++ b/gooddata-api-client/docs/TestConnectionApi.md @@ -19,12 +19,12 @@ Test if it is possible to connect to a database using an existing data source de ```python -import time import gooddata_api_client -from gooddata_api_client.api import test_connection_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_request import TestRequest +from gooddata_api_client.models.test_request import TestRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -33,44 +33,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = test_connection_api.TestConnectionApi(api_client) - data_source_id = "myPostgres" # str | Data source id - test_request = TestRequest( - client_id="client_id_example", - client_secret="client_secret_example", - parameters=[ - DataSourceParameter( - name="name_example", - value="value_example", - ), - ], - password="admin123", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="public", - token="token_example", - url="jdbc:postgresql://localhost:5432/db_name", - username="dbadmin", - ) # TestRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.TestConnectionApi(api_client) + data_source_id = 'myPostgres' # str | Data source id + test_request = gooddata_api_client.TestRequest() # TestRequest | + try: # Test data source connection by data source id api_response = api_instance.test_data_source(data_source_id, test_request) + print("The response of TestConnectionApi->test_data_source:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling TestConnectionApi->test_data_source: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| Data source id | - **test_request** | [**TestRequest**](TestRequest.md)| | + **data_source_id** | **str**| Data source id | + **test_request** | [**TestRequest**](TestRequest.md)| | ### Return type @@ -85,7 +71,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -105,12 +90,12 @@ Test if it is possible to connect to a database using a connection provided by t ```python -import time import gooddata_api_client -from gooddata_api_client.api import test_connection_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -119,43 +104,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = test_connection_api.TestConnectionApi(api_client) - test_definition_request = TestDefinitionRequest( - client_id="client_id_example", - client_secret="client_secret_example", - parameters=[ - DataSourceParameter( - name="name_example", - value="value_example", - ), - ], - password="admin123", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="public", - token="token_example", - type="POSTGRESQL", - url="jdbc:postgresql://localhost:5432/db_name", - username="dbadmin", - ) # TestDefinitionRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.TestConnectionApi(api_client) + test_definition_request = gooddata_api_client.TestDefinitionRequest() # TestDefinitionRequest | + try: # Test connection by data source definition api_response = api_instance.test_data_source_definition(test_definition_request) + print("The response of TestConnectionApi->test_data_source_definition:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling TestConnectionApi->test_data_source_definition: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **test_definition_request** | [**TestDefinitionRequest**](TestDefinitionRequest.md)| | + **test_definition_request** | [**TestDefinitionRequest**](TestDefinitionRequest.md)| | ### Return type @@ -170,7 +140,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/TestDefinitionRequest.md b/gooddata-api-client/docs/TestDefinitionRequest.md index dea6137b3..1558bf0cf 100644 --- a/gooddata-api-client/docs/TestDefinitionRequest.md +++ b/gooddata-api-client/docs/TestDefinitionRequest.md @@ -3,21 +3,38 @@ A request containing all information for testing data source definition. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | Type of database, where test should connect to. | **client_id** | **str** | Id for client based authentication for data sources which supports it. | [optional] **client_secret** | **str** | Secret for client based authentication for data sources which supports it. | [optional] -**parameters** | [**[DataSourceParameter]**](DataSourceParameter.md) | | [optional] +**parameters** | [**List[DataSourceParameter]**](DataSourceParameter.md) | | [optional] **password** | **str** | Database user password. | [optional] **private_key** | **str** | Private key for data sources which supports key-pair authentication. | [optional] **private_key_passphrase** | **str** | Passphrase for a encrypted version of a private key. | [optional] -**schema** | **str** | Database schema. | [optional] +**var_schema** | **str** | Database schema. | [optional] **token** | **str** | Secret for token based authentication for data sources which supports it. | [optional] +**type** | **str** | Type of database, where test should connect to. | **url** | **str** | URL to database in JDBC format, where test should connect to. | [optional] **username** | **str** | Database user name. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of TestDefinitionRequest from a JSON string +test_definition_request_instance = TestDefinitionRequest.from_json(json) +# print the JSON string representation of the object +print(TestDefinitionRequest.to_json()) + +# convert the object into a dict +test_definition_request_dict = test_definition_request_instance.to_dict() +# create an instance of TestDefinitionRequest from a dict +test_definition_request_from_dict = TestDefinitionRequest.from_dict(test_definition_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TestDestinationRequest.md b/gooddata-api-client/docs/TestDestinationRequest.md index 16fd8e55d..22c7831a0 100644 --- a/gooddata-api-client/docs/TestDestinationRequest.md +++ b/gooddata-api-client/docs/TestDestinationRequest.md @@ -3,12 +3,29 @@ Request body with notification channel destination to test. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **destination** | [**DeclarativeNotificationChannelDestination**](DeclarativeNotificationChannelDestination.md) | | -**external_recipients** | [**[AutomationExternalRecipient], none_type**](AutomationExternalRecipient.md) | External recipients of the test result. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**external_recipients** | [**List[AutomationExternalRecipient]**](AutomationExternalRecipient.md) | External recipients of the test result. | [optional] + +## Example + +```python +from gooddata_api_client.models.test_destination_request import TestDestinationRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of TestDestinationRequest from a JSON string +test_destination_request_instance = TestDestinationRequest.from_json(json) +# print the JSON string representation of the object +print(TestDestinationRequest.to_json()) +# convert the object into a dict +test_destination_request_dict = test_destination_request_instance.to_dict() +# create an instance of TestDestinationRequest from a dict +test_destination_request_from_dict = TestDestinationRequest.from_dict(test_destination_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TestNotification.md b/gooddata-api-client/docs/TestNotification.md index de23cc1fd..2444c859a 100644 --- a/gooddata-api-client/docs/TestNotification.md +++ b/gooddata-api-client/docs/TestNotification.md @@ -2,12 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **message** | **str** | | -**type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.test_notification import TestNotification + +# TODO update the JSON string below +json = "{}" +# create an instance of TestNotification from a JSON string +test_notification_instance = TestNotification.from_json(json) +# print the JSON string representation of the object +print(TestNotification.to_json()) + +# convert the object into a dict +test_notification_dict = test_notification_instance.to_dict() +# create an instance of TestNotification from a dict +test_notification_from_dict = TestNotification.from_dict(test_notification_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TestNotificationAllOf.md b/gooddata-api-client/docs/TestNotificationAllOf.md deleted file mode 100644 index caaf725dc..000000000 --- a/gooddata-api-client/docs/TestNotificationAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# TestNotificationAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/TestQueryDuration.md b/gooddata-api-client/docs/TestQueryDuration.md index f7d9eee93..3f375f54e 100644 --- a/gooddata-api-client/docs/TestQueryDuration.md +++ b/gooddata-api-client/docs/TestQueryDuration.md @@ -3,12 +3,29 @@ A structure containing duration of the test queries run on a data source. It is omitted if an error happens. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**simple_select** | **int** | Field containing duration of a test select query on a data source. In milliseconds. | **create_cache_table** | **int** | Field containing duration of a test 'create table as select' query on a datasource. In milliseconds. The field is omitted if a data source doesn't support caching. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**simple_select** | **int** | Field containing duration of a test select query on a data source. In milliseconds. | + +## Example + +```python +from gooddata_api_client.models.test_query_duration import TestQueryDuration + +# TODO update the JSON string below +json = "{}" +# create an instance of TestQueryDuration from a JSON string +test_query_duration_instance = TestQueryDuration.from_json(json) +# print the JSON string representation of the object +print(TestQueryDuration.to_json()) +# convert the object into a dict +test_query_duration_dict = test_query_duration_instance.to_dict() +# create an instance of TestQueryDuration from a dict +test_query_duration_from_dict = TestQueryDuration.from_dict(test_query_duration_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TestRequest.md b/gooddata-api-client/docs/TestRequest.md index c79efb371..fab4ecce5 100644 --- a/gooddata-api-client/docs/TestRequest.md +++ b/gooddata-api-client/docs/TestRequest.md @@ -3,20 +3,37 @@ A request containing all information for testing existing data source. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client_id** | **str** | Id for client based authentication for data sources which supports it. | [optional] **client_secret** | **str** | Secret for client based authentication for data sources which supports it. | [optional] -**parameters** | [**[DataSourceParameter]**](DataSourceParameter.md) | | [optional] +**parameters** | [**List[DataSourceParameter]**](DataSourceParameter.md) | | [optional] **password** | **str** | Database user password. | [optional] **private_key** | **str** | Private key for data sources which supports key-pair authentication. | [optional] **private_key_passphrase** | **str** | Passphrase for a encrypted version of a private key. | [optional] -**schema** | **str** | Database schema. | [optional] +**var_schema** | **str** | Database schema. | [optional] **token** | **str** | Secret for token based authentication for data sources which supports it. | [optional] **url** | **str** | URL to database in JDBC format, where test should connect to. | [optional] **username** | **str** | Database user name. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.test_request import TestRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of TestRequest from a JSON string +test_request_instance = TestRequest.from_json(json) +# print the JSON string representation of the object +print(TestRequest.to_json()) + +# convert the object into a dict +test_request_dict = test_request_instance.to_dict() +# create an instance of TestRequest from a dict +test_request_from_dict = TestRequest.from_dict(test_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TestResponse.md b/gooddata-api-client/docs/TestResponse.md index 1bc06923c..51a8a325d 100644 --- a/gooddata-api-client/docs/TestResponse.md +++ b/gooddata-api-client/docs/TestResponse.md @@ -3,13 +3,30 @@ Response from data source testing. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**successful** | **bool** | A flag indicating whether test passed or not. | **error** | **str** | Field containing more details in case of a failure. Details are available to a privileged user only. | [optional] **query_duration_millis** | [**TestQueryDuration**](TestQueryDuration.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**successful** | **bool** | A flag indicating whether test passed or not. | + +## Example + +```python +from gooddata_api_client.models.test_response import TestResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of TestResponse from a JSON string +test_response_instance = TestResponse.from_json(json) +# print the JSON string representation of the object +print(TestResponse.to_json()) +# convert the object into a dict +test_response_dict = test_response_instance.to_dict() +# create an instance of TestResponse from a dict +test_response_from_dict = TestResponse.from_dict(test_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Total.md b/gooddata-api-client/docs/Total.md index 05e31881a..c4045cd0f 100644 --- a/gooddata-api-client/docs/Total.md +++ b/gooddata-api-client/docs/Total.md @@ -3,14 +3,31 @@ Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it's described in `TotalDimension` ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **function** | **str** | Aggregation function to compute the total. | **local_identifier** | **str** | Total identification within this request. Used e.g. in sorting by a total. | **metric** | **str** | The metric for which the total will be computed | -**total_dimensions** | [**[TotalDimension]**](TotalDimension.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**total_dimensions** | [**List[TotalDimension]**](TotalDimension.md) | | + +## Example + +```python +from gooddata_api_client.models.total import Total + +# TODO update the JSON string below +json = "{}" +# create an instance of Total from a JSON string +total_instance = Total.from_json(json) +# print the JSON string representation of the object +print(Total.to_json()) +# convert the object into a dict +total_dict = total_instance.to_dict() +# create an instance of Total from a dict +total_from_dict = Total.from_dict(total_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TotalDimension.md b/gooddata-api-client/docs/TotalDimension.md index 732c5fb23..8a70b22a5 100644 --- a/gooddata-api-client/docs/TotalDimension.md +++ b/gooddata-api-client/docs/TotalDimension.md @@ -3,12 +3,29 @@ A list of dimensions across which the total will be computed. Total headers for only these dimensions will be returned in the result. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dimension_identifier** | **str** | An identifier of a dimension for which the total will be computed. | -**total_dimension_items** | **[str]** | List of dimension items which will be used for total computation. The total is a grand total in this dimension if the list is empty or it includes the first dimension item from the dimension definition, and its data and header will be returned in a separate `ExecutionResultGrandTotal` structure. Otherwise, it is a subtotal and the data will be integrated into the main result. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**total_dimension_items** | **List[str]** | List of dimension items which will be used for total computation. The total is a grand total in this dimension if the list is empty or it includes the first dimension item from the dimension definition, and its data and header will be returned in a separate `ExecutionResultGrandTotal` structure. Otherwise, it is a subtotal and the data will be integrated into the main result. | + +## Example + +```python +from gooddata_api_client.models.total_dimension import TotalDimension + +# TODO update the JSON string below +json = "{}" +# create an instance of TotalDimension from a JSON string +total_dimension_instance = TotalDimension.from_json(json) +# print the JSON string representation of the object +print(TotalDimension.to_json()) +# convert the object into a dict +total_dimension_dict = total_dimension_instance.to_dict() +# create an instance of TotalDimension from a dict +total_dimension_from_dict = TotalDimension.from_dict(total_dimension_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TotalExecutionResultHeader.md b/gooddata-api-client/docs/TotalExecutionResultHeader.md index e16c6eba0..e566e14f4 100644 --- a/gooddata-api-client/docs/TotalExecutionResultHeader.md +++ b/gooddata-api-client/docs/TotalExecutionResultHeader.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_header** | [**TotalResultHeader**](TotalResultHeader.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.total_execution_result_header import TotalExecutionResultHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of TotalExecutionResultHeader from a JSON string +total_execution_result_header_instance = TotalExecutionResultHeader.from_json(json) +# print the JSON string representation of the object +print(TotalExecutionResultHeader.to_json()) + +# convert the object into a dict +total_execution_result_header_dict = total_execution_result_header_instance.to_dict() +# create an instance of TotalExecutionResultHeader from a dict +total_execution_result_header_from_dict = TotalExecutionResultHeader.from_dict(total_execution_result_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TotalResultHeader.md b/gooddata-api-client/docs/TotalResultHeader.md index c58b4da09..5c33942e0 100644 --- a/gooddata-api-client/docs/TotalResultHeader.md +++ b/gooddata-api-client/docs/TotalResultHeader.md @@ -3,11 +3,28 @@ Header containing the information related to a subtotal. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **function** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.total_result_header import TotalResultHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of TotalResultHeader from a JSON string +total_result_header_instance = TotalResultHeader.from_json(json) +# print the JSON string representation of the object +print(TotalResultHeader.to_json()) + +# convert the object into a dict +total_result_header_dict = total_result_header_instance.to_dict() +# create an instance of TotalResultHeader from a dict +total_result_header_from_dict = TotalResultHeader.from_dict(total_result_header_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/TranslationsApi.md b/gooddata-api-client/docs/TranslationsApi.md index dd948fdfd..4dfea411a 100644 --- a/gooddata-api-client/docs/TranslationsApi.md +++ b/gooddata-api-client/docs/TranslationsApi.md @@ -21,11 +21,11 @@ Cleans up all translations for a particular locale. ```python -import time import gooddata_api_client -from gooddata_api_client.api import translations_api -from gooddata_api_client.model.locale_request import LocaleRequest +from gooddata_api_client.models.locale_request import LocaleRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -34,29 +34,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = translations_api.TranslationsApi(api_client) - workspace_id = "workspaceId_example" # str | - locale_request = LocaleRequest( - locale="en-US", - ) # LocaleRequest | + api_instance = gooddata_api_client.TranslationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + locale_request = gooddata_api_client.LocaleRequest() # LocaleRequest | - # example passing only required values which don't have defaults set try: # Cleans up translations. api_instance.clean_translations(workspace_id, locale_request) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling TranslationsApi->clean_translations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **locale_request** | [**LocaleRequest**](LocaleRequest.md)| | + **workspace_id** | **str**| | + **locale_request** | [**LocaleRequest**](LocaleRequest.md)| | ### Return type @@ -71,7 +70,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -81,7 +79,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_translation_tags** -> [str] get_translation_tags(workspace_id) +> List[str] get_translation_tags(workspace_id) Get translation tags. @@ -91,10 +89,10 @@ Provides a list of effective translation tags. ```python -import time import gooddata_api_client -from gooddata_api_client.api import translations_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -103,30 +101,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = translations_api.TranslationsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.TranslationsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Get translation tags. api_response = api_instance.get_translation_tags(workspace_id) + print("The response of TranslationsApi->get_translation_tags:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling TranslationsApi->get_translation_tags: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type -**[str]** +**List[str]** ### Authorization @@ -137,7 +137,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -157,12 +156,12 @@ Retrieve all translation for existing entities in a particular locale. The sourc ```python -import time import gooddata_api_client -from gooddata_api_client.api import translations_api -from gooddata_api_client.model.locale_request import LocaleRequest -from gooddata_api_client.model.xliff import Xliff +from gooddata_api_client.models.locale_request import LocaleRequest +from gooddata_api_client.models.xliff import Xliff +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -171,30 +170,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = translations_api.TranslationsApi(api_client) - workspace_id = "workspaceId_example" # str | - locale_request = LocaleRequest( - locale="en-US", - ) # LocaleRequest | + api_instance = gooddata_api_client.TranslationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + locale_request = gooddata_api_client.LocaleRequest() # LocaleRequest | - # example passing only required values which don't have defaults set try: # Retrieve translations for entities. api_response = api_instance.retrieve_translations(workspace_id, locale_request) + print("The response of TranslationsApi->retrieve_translations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling TranslationsApi->retrieve_translations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **locale_request** | [**LocaleRequest**](LocaleRequest.md)| | + **workspace_id** | **str**| | + **locale_request** | [**LocaleRequest**](LocaleRequest.md)| | ### Return type @@ -209,7 +208,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/xml - ### HTTP response details | Status code | Description | Response headers | @@ -229,11 +227,11 @@ Set translation for existing entities in a particular locale. ```python -import time import gooddata_api_client -from gooddata_api_client.api import translations_api -from gooddata_api_client.model.xliff import Xliff +from gooddata_api_client.models.xliff import Xliff +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -242,75 +240,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = translations_api.TranslationsApi(api_client) - workspace_id = "workspaceId_example" # str | - xliff = Xliff( - file=[ - File( - any=[ - {}, - ], - can_resegment="YES", - id="id_example", - notes=Notes( - note=[ - Note( - applies_to="SOURCE", - category="category_example", - content="content_example", - id="id_example", - other_attributes={ - "key": "key_example", - }, - priority=1, - ), - ], - ), - original="original_example", - other_attributes={ - "key": "key_example", - }, - skeleton=Skeleton( - content=[ - {}, - ], - href="href_example", - ), - space="space_example", - src_dir="LTR", - translate="YES", - trg_dir="LTR", - unit_or_group=[ - {}, - ], - ), - ], - other_attributes={ - "key": "key_example", - }, - space="space_example", - src_lang="src_lang_example", - trg_lang="trg_lang_example", - version="version_example", - ) # Xliff | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.TranslationsApi(api_client) + workspace_id = 'workspace_id_example' # str | + xliff = gooddata_api_client.Xliff() # Xliff | + try: # Set translations for entities. api_instance.set_translations(workspace_id, xliff) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling TranslationsApi->set_translations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **xliff** | [**Xliff**](Xliff.md)| | + **workspace_id** | **str**| | + **xliff** | [**Xliff**](Xliff.md)| | ### Return type @@ -325,7 +276,6 @@ No authorization required - **Content-Type**: application/xml - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/TriggerAutomationRequest.md b/gooddata-api-client/docs/TriggerAutomationRequest.md index f47b43e55..34e09c87d 100644 --- a/gooddata-api-client/docs/TriggerAutomationRequest.md +++ b/gooddata-api-client/docs/TriggerAutomationRequest.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **automation** | [**AdHocAutomation**](AdHocAutomation.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.trigger_automation_request import TriggerAutomationRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of TriggerAutomationRequest from a JSON string +trigger_automation_request_instance = TriggerAutomationRequest.from_json(json) +# print the JSON string representation of the object +print(TriggerAutomationRequest.to_json()) + +# convert the object into a dict +trigger_automation_request_dict = trigger_automation_request_instance.to_dict() +# create an instance of TriggerAutomationRequest from a dict +trigger_automation_request_from_dict = TriggerAutomationRequest.from_dict(trigger_automation_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UsageApi.md b/gooddata-api-client/docs/UsageApi.md index b85c6f70b..efed9de6b 100644 --- a/gooddata-api-client/docs/UsageApi.md +++ b/gooddata-api-client/docs/UsageApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **all_platform_usage** -> [PlatformUsage] all_platform_usage() +> List[PlatformUsage] all_platform_usage() Info about the platform usage. @@ -19,11 +19,11 @@ Provides information about platform usage, like amount of users, workspaces, ... ```python -import time import gooddata_api_client -from gooddata_api_client.api import usage_api -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage import PlatformUsage +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -32,26 +32,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = usage_api.UsageApi(api_client) + api_instance = gooddata_api_client.UsageApi(api_client) - # example, this endpoint has no required or optional parameters try: # Info about the platform usage. api_response = api_instance.all_platform_usage() + print("The response of UsageApi->all_platform_usage:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UsageApi->all_platform_usage: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type -[**[PlatformUsage]**](PlatformUsage.md) +[**List[PlatformUsage]**](PlatformUsage.md) ### Authorization @@ -62,7 +64,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -72,7 +73,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **particular_platform_usage** -> [PlatformUsage] particular_platform_usage(platform_usage_request) +> List[PlatformUsage] particular_platform_usage(platform_usage_request) Info about the platform usage for particular items. @@ -82,12 +83,12 @@ Provides information about platform usage, like amount of users, workspaces, ... ```python -import time import gooddata_api_client -from gooddata_api_client.api import usage_api -from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage_request import PlatformUsageRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -96,34 +97,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = usage_api.UsageApi(api_client) - platform_usage_request = PlatformUsageRequest( - usage_item_names=[ - "UserCount", - ], - ) # PlatformUsageRequest | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UsageApi(api_client) + platform_usage_request = gooddata_api_client.PlatformUsageRequest() # PlatformUsageRequest | + try: # Info about the platform usage for particular items. api_response = api_instance.particular_platform_usage(platform_usage_request) + print("The response of UsageApi->particular_platform_usage:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UsageApi->particular_platform_usage: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **platform_usage_request** | [**PlatformUsageRequest**](PlatformUsageRequest.md)| | + **platform_usage_request** | [**PlatformUsageRequest**](PlatformUsageRequest.md)| | ### Return type -[**[PlatformUsage]**](PlatformUsage.md) +[**List[PlatformUsage]**](PlatformUsage.md) ### Authorization @@ -134,7 +133,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/UserAssignee.md b/gooddata-api-client/docs/UserAssignee.md index 9e4cf1c20..6abe4c2fb 100644 --- a/gooddata-api-client/docs/UserAssignee.md +++ b/gooddata-api-client/docs/UserAssignee.md @@ -3,13 +3,30 @@ List of users ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | **email** | **str** | User email address | [optional] +**id** | **str** | | **name** | **str** | User name | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.user_assignee import UserAssignee + +# TODO update the JSON string below +json = "{}" +# create an instance of UserAssignee from a JSON string +user_assignee_instance = UserAssignee.from_json(json) +# print the JSON string representation of the object +print(UserAssignee.to_json()) + +# convert the object into a dict +user_assignee_dict = user_assignee_instance.to_dict() +# create an instance of UserAssignee from a dict +user_assignee_from_dict = UserAssignee.from_dict(user_assignee_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserContext.md b/gooddata-api-client/docs/UserContext.md index 887cb2b08..93940e380 100644 --- a/gooddata-api-client/docs/UserContext.md +++ b/gooddata-api-client/docs/UserContext.md @@ -3,11 +3,28 @@ User context, which can affect the behavior of the underlying AI features. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **active_object** | [**ActiveObjectIdentification**](ActiveObjectIdentification.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.user_context import UserContext + +# TODO update the JSON string below +json = "{}" +# create an instance of UserContext from a JSON string +user_context_instance = UserContext.from_json(json) +# print the JSON string representation of the object +print(UserContext.to_json()) + +# convert the object into a dict +user_context_dict = user_context_instance.to_dict() +# create an instance of UserContext from a dict +user_context_from_dict = UserContext.from_dict(user_context_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserDataFiltersApi.md b/gooddata-api-client/docs/UserDataFiltersApi.md index dfa6fbc99..472b156cd 100644 --- a/gooddata-api-client/docs/UserDataFiltersApi.md +++ b/gooddata-api-client/docs/UserDataFiltersApi.md @@ -19,11 +19,11 @@ Retrieve current user data filters assigned to the workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_data_filters_api -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -32,26 +32,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_data_filters_api.UserDataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.UserDataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Get user data filters api_response = api_instance.get_user_data_filters(workspace_id) + print("The response of UserDataFiltersApi->get_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserDataFiltersApi->get_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type @@ -66,7 +68,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -86,11 +87,11 @@ Set user data filters assigned to the workspace. ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_data_filters_api -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -99,45 +100,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_data_filters_api.UserDataFiltersApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_user_data_filters = DeclarativeUserDataFilters( - user_data_filters=[ - DeclarativeUserDataFilter( - description="ID of country setting", - id="country_id_setting", - maql="{label/country} = "USA" AND {label/date.year} = THIS(YEAR)", - tags=["Revenues"], - title="Country ID setting", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - user_group=DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ), - ], - ) # DeclarativeUserDataFilters | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserDataFiltersApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_user_data_filters = gooddata_api_client.DeclarativeUserDataFilters() # DeclarativeUserDataFilters | + try: # Set user data filters api_instance.set_user_data_filters(workspace_id, declarative_user_data_filters) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserDataFiltersApi->set_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_user_data_filters** | [**DeclarativeUserDataFilters**](DeclarativeUserDataFilters.md)| | + **workspace_id** | **str**| | + **declarative_user_data_filters** | [**DeclarativeUserDataFilters**](DeclarativeUserDataFilters.md)| | ### Return type @@ -152,7 +136,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/UserGroupAssignee.md b/gooddata-api-client/docs/UserGroupAssignee.md index 116a1d1aa..06bc1f8dc 100644 --- a/gooddata-api-client/docs/UserGroupAssignee.md +++ b/gooddata-api-client/docs/UserGroupAssignee.md @@ -3,12 +3,29 @@ List of user groups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **name** | **str** | User group name | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.user_group_assignee import UserGroupAssignee + +# TODO update the JSON string below +json = "{}" +# create an instance of UserGroupAssignee from a JSON string +user_group_assignee_instance = UserGroupAssignee.from_json(json) +# print the JSON string representation of the object +print(UserGroupAssignee.to_json()) + +# convert the object into a dict +user_group_assignee_dict = user_group_assignee_instance.to_dict() +# create an instance of UserGroupAssignee from a dict +user_group_assignee_from_dict = UserGroupAssignee.from_dict(user_group_assignee_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserGroupIdentifier.md b/gooddata-api-client/docs/UserGroupIdentifier.md index 69b90366d..410b9c054 100644 --- a/gooddata-api-client/docs/UserGroupIdentifier.md +++ b/gooddata-api-client/docs/UserGroupIdentifier.md @@ -3,12 +3,29 @@ A list of groups where user is a member ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **name** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.user_group_identifier import UserGroupIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of UserGroupIdentifier from a JSON string +user_group_identifier_instance = UserGroupIdentifier.from_json(json) +# print the JSON string representation of the object +print(UserGroupIdentifier.to_json()) + +# convert the object into a dict +user_group_identifier_dict = user_group_identifier_instance.to_dict() +# create an instance of UserGroupIdentifier from a dict +user_group_identifier_from_dict = UserGroupIdentifier.from_dict(user_group_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserGroupPermission.md b/gooddata-api-client/docs/UserGroupPermission.md index 24950b263..2fc343c5f 100644 --- a/gooddata-api-client/docs/UserGroupPermission.md +++ b/gooddata-api-client/docs/UserGroupPermission.md @@ -3,13 +3,30 @@ List of user groups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **name** | **str** | Name of the user group | [optional] -**permissions** | [**[GrantedPermission]**](GrantedPermission.md) | Permissions granted to the user group | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | [**List[GrantedPermission]**](GrantedPermission.md) | Permissions granted to the user group | [optional] + +## Example + +```python +from gooddata_api_client.models.user_group_permission import UserGroupPermission + +# TODO update the JSON string below +json = "{}" +# create an instance of UserGroupPermission from a JSON string +user_group_permission_instance = UserGroupPermission.from_json(json) +# print the JSON string representation of the object +print(UserGroupPermission.to_json()) +# convert the object into a dict +user_group_permission_dict = user_group_permission_instance.to_dict() +# create an instance of UserGroupPermission from a dict +user_group_permission_from_dict = UserGroupPermission.from_dict(user_group_permission_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserGroupsDeclarativeAPIsApi.md b/gooddata-api-client/docs/UserGroupsDeclarativeAPIsApi.md index c2667b6e8..70b30e6b9 100644 --- a/gooddata-api-client/docs/UserGroupsDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/UserGroupsDeclarativeAPIsApi.md @@ -21,11 +21,11 @@ Retrieve all user-groups eventually with parent group. ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_groups_declarative_apis_api -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -34,21 +34,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_groups_declarative_apis_api.UserGroupsDeclarativeAPIsApi(api_client) + api_instance = gooddata_api_client.UserGroupsDeclarativeAPIsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all user groups api_response = api_instance.get_user_groups_layout() + print("The response of UserGroupsDeclarativeAPIsApi->get_user_groups_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserGroupsDeclarativeAPIsApi->get_user_groups_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -64,7 +66,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -84,11 +85,11 @@ Retrieve all users and user groups with theirs properties. ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_groups_declarative_apis_api -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -97,21 +98,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_groups_declarative_apis_api.UserGroupsDeclarativeAPIsApi(api_client) + api_instance = gooddata_api_client.UserGroupsDeclarativeAPIsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all users and user groups api_response = api_instance.get_users_user_groups_layout() + print("The response of UserGroupsDeclarativeAPIsApi->get_users_user_groups_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserGroupsDeclarativeAPIsApi->get_users_user_groups_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -127,7 +130,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -147,11 +149,11 @@ Define all user groups with their parents eventually. ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_groups_declarative_apis_api -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -160,47 +162,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_groups_declarative_apis_api.UserGroupsDeclarativeAPIsApi(api_client) - declarative_user_groups = DeclarativeUserGroups( - user_groups=[ - DeclarativeUserGroup( - id="employees.all", - name="admins", - parents=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - permissions=[ - DeclarativeUserGroupPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - ), - ], - ) # DeclarativeUserGroups | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserGroupsDeclarativeAPIsApi(api_client) + declarative_user_groups = gooddata_api_client.DeclarativeUserGroups() # DeclarativeUserGroups | + try: # Put all user groups api_instance.put_user_groups_layout(declarative_user_groups) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserGroupsDeclarativeAPIsApi->put_user_groups_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_user_groups** | [**DeclarativeUserGroups**](DeclarativeUserGroups.md)| | + **declarative_user_groups** | [**DeclarativeUserGroups**](DeclarativeUserGroups.md)| | ### Return type @@ -215,7 +196,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -235,11 +215,11 @@ Define all users and user groups with theirs properties. ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_groups_declarative_apis_api -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -248,78 +228,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_groups_declarative_apis_api.UserGroupsDeclarativeAPIsApi(api_client) - declarative_users_user_groups = DeclarativeUsersUserGroups( - user_groups=[ - DeclarativeUserGroup( - id="employees.all", - name="admins", - parents=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - permissions=[ - DeclarativeUserGroupPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - ), - ], - users=[ - DeclarativeUser( - auth_id="auth_id_example", - email="user@example.com", - firstname="John", - id="employee123", - lastname="Wick", - permissions=[ - DeclarativeUserPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - user_groups=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - ), - ], - ) # DeclarativeUsersUserGroups | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserGroupsDeclarativeAPIsApi(api_client) + declarative_users_user_groups = gooddata_api_client.DeclarativeUsersUserGroups() # DeclarativeUsersUserGroups | + try: # Put all users and user groups api_instance.put_users_user_groups_layout(declarative_users_user_groups) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserGroupsDeclarativeAPIsApi->put_users_user_groups_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_users_user_groups** | [**DeclarativeUsersUserGroups**](DeclarativeUsersUserGroups.md)| | + **declarative_users_user_groups** | [**DeclarativeUsersUserGroups**](DeclarativeUsersUserGroups.md)| | ### Return type @@ -334,7 +262,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/UserGroupsEntityAPIsApi.md b/gooddata-api-client/docs/UserGroupsEntityAPIsApi.md index e02a85710..900d17624 100644 --- a/gooddata-api-client/docs/UserGroupsEntityAPIsApi.md +++ b/gooddata-api-client/docs/UserGroupsEntityAPIsApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **create_entity_user_groups** -> JsonApiUserGroupOutDocument create_entity_user_groups(json_api_user_group_in_document) +> JsonApiUserGroupOutDocument create_entity_user_groups(json_api_user_group_in_document, include=include) Post User Group entities @@ -23,12 +23,12 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_groups_entity_apis_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -37,57 +37,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_groups_entity_apis_api.UserGroupsEntityAPIsApi(api_client) - json_api_user_group_in_document = JsonApiUserGroupInDocument( - data=JsonApiUserGroupIn( - attributes=JsonApiUserGroupInAttributes( - name="name_example", - ), - id="id1", - relationships=JsonApiUserGroupInRelationships( - parents=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="userGroup", - ), - ) # JsonApiUserGroupInDocument | - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Post User Group entities - api_response = api_instance.create_entity_user_groups(json_api_user_group_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserGroupsEntityAPIsApi->create_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.UserGroupsEntityAPIsApi(api_client) + json_api_user_group_in_document = gooddata_api_client.JsonApiUserGroupInDocument() # JsonApiUserGroupInDocument | + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post User Group entities api_response = api_instance.create_entity_user_groups(json_api_user_group_in_document, include=include) + print("The response of UserGroupsEntityAPIsApi->create_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserGroupsEntityAPIsApi->create_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -102,7 +75,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -112,7 +84,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_user_groups** -> delete_entity_user_groups(id) +> delete_entity_user_groups(id, filter=filter) Delete UserGroup entity @@ -122,10 +94,10 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_groups_entity_apis_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -134,35 +106,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_groups_entity_apis_api.UserGroupsEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.UserGroupsEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete UserGroup entity - api_instance.delete_entity_user_groups(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserGroupsEntityAPIsApi->delete_entity_user_groups: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete UserGroup entity api_instance.delete_entity_user_groups(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserGroupsEntityAPIsApi->delete_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -177,7 +142,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -187,7 +151,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_user_groups** -> JsonApiUserGroupOutList get_all_entities_user_groups() +> JsonApiUserGroupOutList get_all_entities_user_groups(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get UserGroup entities @@ -197,11 +161,11 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_groups_entity_apis_api -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -210,43 +174,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_groups_entity_apis_api.UserGroupsEntityAPIsApi(api_client) - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.UserGroupsEntityAPIsApi(api_client) + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get UserGroup entities api_response = api_instance.get_all_entities_user_groups(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of UserGroupsEntityAPIsApi->get_all_entities_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserGroupsEntityAPIsApi->get_all_entities_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -261,7 +220,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -271,7 +229,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_groups** -> JsonApiUserGroupOutDocument get_entity_user_groups(id) +> JsonApiUserGroupOutDocument get_entity_user_groups(id, filter=filter, include=include) Get UserGroup entity @@ -281,11 +239,11 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_groups_entity_apis_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -294,41 +252,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_groups_entity_apis_api.UserGroupsEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Get UserGroup entity - api_response = api_instance.get_entity_user_groups(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserGroupsEntityAPIsApi->get_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.UserGroupsEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get UserGroup entity api_response = api_instance.get_entity_user_groups(id, filter=filter, include=include) + print("The response of UserGroupsEntityAPIsApi->get_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserGroupsEntityAPIsApi->get_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -343,7 +292,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -353,7 +301,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_user_groups** -> JsonApiUserGroupOutDocument patch_entity_user_groups(id, json_api_user_group_patch_document) +> JsonApiUserGroupOutDocument patch_entity_user_groups(id, json_api_user_group_patch_document, filter=filter, include=include) Patch UserGroup entity @@ -363,12 +311,12 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_groups_entity_apis_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -377,61 +325,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_groups_entity_apis_api.UserGroupsEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_group_patch_document = JsonApiUserGroupPatchDocument( - data=JsonApiUserGroupPatch( - attributes=JsonApiUserGroupInAttributes( - name="name_example", - ), - id="id1", - relationships=JsonApiUserGroupInRelationships( - parents=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="userGroup", - ), - ) # JsonApiUserGroupPatchDocument | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch UserGroup entity - api_response = api_instance.patch_entity_user_groups(id, json_api_user_group_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserGroupsEntityAPIsApi->patch_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.UserGroupsEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_user_group_patch_document = gooddata_api_client.JsonApiUserGroupPatchDocument() # JsonApiUserGroupPatchDocument | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch UserGroup entity api_response = api_instance.patch_entity_user_groups(id, json_api_user_group_patch_document, filter=filter, include=include) + print("The response of UserGroupsEntityAPIsApi->patch_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserGroupsEntityAPIsApi->patch_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_group_patch_document** | [**JsonApiUserGroupPatchDocument**](JsonApiUserGroupPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_group_patch_document** | [**JsonApiUserGroupPatchDocument**](JsonApiUserGroupPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -446,7 +367,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -456,7 +376,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_user_groups** -> JsonApiUserGroupOutDocument update_entity_user_groups(id, json_api_user_group_in_document) +> JsonApiUserGroupOutDocument update_entity_user_groups(id, json_api_user_group_in_document, filter=filter, include=include) Put UserGroup entity @@ -466,12 +386,12 @@ User Group - creates tree-like structure for categorizing users ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_groups_entity_apis_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -480,61 +400,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_groups_entity_apis_api.UserGroupsEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_group_in_document = JsonApiUserGroupInDocument( - data=JsonApiUserGroupIn( - attributes=JsonApiUserGroupInAttributes( - name="name_example", - ), - id="id1", - relationships=JsonApiUserGroupInRelationships( - parents=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="userGroup", - ), - ) # JsonApiUserGroupInDocument | - filter = "name==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parents", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put UserGroup entity - api_response = api_instance.update_entity_user_groups(id, json_api_user_group_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserGroupsEntityAPIsApi->update_entity_user_groups: %s\n" % e) + api_instance = gooddata_api_client.UserGroupsEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_user_group_in_document = gooddata_api_client.JsonApiUserGroupInDocument() # JsonApiUserGroupInDocument | + filter = 'name==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parents'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put UserGroup entity api_response = api_instance.update_entity_user_groups(id, json_api_user_group_in_document, filter=filter, include=include) + print("The response of UserGroupsEntityAPIsApi->update_entity_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserGroupsEntityAPIsApi->update_entity_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -549,7 +442,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/UserIdentifiersApi.md b/gooddata-api-client/docs/UserIdentifiersApi.md index e2e074072..601079ec8 100644 --- a/gooddata-api-client/docs/UserIdentifiersApi.md +++ b/gooddata-api-client/docs/UserIdentifiersApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **get_all_entities_user_identifiers** -> JsonApiUserIdentifierOutList get_all_entities_user_identifiers() +> JsonApiUserIdentifierOutList get_all_entities_user_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) Get UserIdentifier entities @@ -19,11 +19,11 @@ UserIdentifier - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_identifiers_api -from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.models.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -32,39 +32,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_identifiers_api.UserIdentifiersApi(api_client) - filter = "firstname==someString;lastname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.UserIdentifiersApi(api_client) + filter = 'firstname==someString;lastname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get UserIdentifier entities api_response = api_instance.get_all_entities_user_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of UserIdentifiersApi->get_all_entities_user_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserIdentifiersApi->get_all_entities_user_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -79,7 +76,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -89,7 +85,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_identifiers** -> JsonApiUserIdentifierOutDocument get_entity_user_identifiers(id) +> JsonApiUserIdentifierOutDocument get_entity_user_identifiers(id, filter=filter) Get UserIdentifier entity @@ -99,11 +95,11 @@ UserIdentifier - represents basic information about entity interacting with plat ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_identifiers_api -from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.models.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -112,37 +108,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_identifiers_api.UserIdentifiersApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "firstname==someString;lastname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get UserIdentifier entity - api_response = api_instance.get_entity_user_identifiers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserIdentifiersApi->get_entity_user_identifiers: %s\n" % e) + api_instance = gooddata_api_client.UserIdentifiersApi(api_client) + id = 'id_example' # str | + filter = 'firstname==someString;lastname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get UserIdentifier entity api_response = api_instance.get_entity_user_identifiers(id, filter=filter) + print("The response of UserIdentifiersApi->get_entity_user_identifiers:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserIdentifiersApi->get_entity_user_identifiers: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -157,7 +146,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/UserManagementApi.md b/gooddata-api-client/docs/UserManagementApi.md index a2a5e3881..ad016cc9c 100644 --- a/gooddata-api-client/docs/UserManagementApi.md +++ b/gooddata-api-client/docs/UserManagementApi.md @@ -27,11 +27,11 @@ Method | HTTP request | Description ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers +from gooddata_api_client.models.user_management_user_group_members import UserManagementUserGroupMembers +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -40,32 +40,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - user_group_id = "userGroupId_example" # str | - user_management_user_group_members = UserManagementUserGroupMembers( - members=[ - UserManagementUserGroupMember( - id="id_example", - ), - ], - ) # UserManagementUserGroupMembers | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserManagementApi(api_client) + user_group_id = 'user_group_id_example' # str | + user_management_user_group_members = gooddata_api_client.UserManagementUserGroupMembers() # UserManagementUserGroupMembers | + try: api_instance.add_group_members(user_group_id, user_management_user_group_members) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->add_group_members: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_group_id** | **str**| | - **user_management_user_group_members** | [**UserManagementUserGroupMembers**](UserManagementUserGroupMembers.md)| | + **user_group_id** | **str**| | + **user_management_user_group_members** | [**UserManagementUserGroupMembers**](UserManagementUserGroupMembers.md)| | ### Return type @@ -80,7 +75,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -98,11 +92,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.permissions_assignment import PermissionsAssignment +from gooddata_api_client.models.permissions_assignment import PermissionsAssignment +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -111,50 +105,25 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - permissions_assignment = PermissionsAssignment( - assignees=[ - AssigneeIdentifier( - id="id_example", - type="user", - ), - ], - data_sources=[ - UserManagementDataSourcePermissionAssignment( - id="id_example", - permissions=[ - "MANAGE", - ], - ), - ], - workspaces=[ - UserManagementWorkspacePermissionAssignment( - hierarchy_permissions=[ - "MANAGE", - ], - id="id_example", - permissions=[ - "MANAGE", - ], - ), - ], - ) # PermissionsAssignment | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserManagementApi(api_client) + permissions_assignment = gooddata_api_client.PermissionsAssignment() # PermissionsAssignment | + try: api_instance.assign_permissions(permissions_assignment) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->assign_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **permissions_assignment** | [**PermissionsAssignment**](PermissionsAssignment.md)| | + **permissions_assignment** | [**PermissionsAssignment**](PermissionsAssignment.md)| | ### Return type @@ -169,7 +138,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -187,11 +155,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers +from gooddata_api_client.models.user_management_user_group_members import UserManagementUserGroupMembers +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -200,25 +168,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - user_group_id = "userGroupId_example" # str | + api_instance = gooddata_api_client.UserManagementApi(api_client) + user_group_id = 'user_group_id_example' # str | - # example passing only required values which don't have defaults set try: api_response = api_instance.get_group_members(user_group_id) + print("The response of UserManagementApi->get_group_members:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->get_group_members: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_group_id** | **str**| | + **user_group_id** | **str**| | ### Return type @@ -233,7 +203,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -251,11 +220,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.models.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -264,25 +233,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - user_id = "userId_example" # str | + api_instance = gooddata_api_client.UserManagementApi(api_client) + user_id = 'user_id_example' # str | - # example passing only required values which don't have defaults set try: api_response = api_instance.list_permissions_for_user(user_id) + print("The response of UserManagementApi->list_permissions_for_user:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->list_permissions_for_user: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | + **user_id** | **str**| | ### Return type @@ -297,7 +268,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -315,11 +285,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.models.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -328,25 +298,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - user_group_id = "userGroupId_example" # str | + api_instance = gooddata_api_client.UserManagementApi(api_client) + user_group_id = 'user_group_id_example' # str | - # example passing only required values which don't have defaults set try: api_response = api_instance.list_permissions_for_user_group(user_group_id) + print("The response of UserManagementApi->list_permissions_for_user_group:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->list_permissions_for_user_group: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_group_id** | **str**| | + **user_group_id** | **str**| | ### Return type @@ -361,7 +333,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -371,7 +342,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **list_user_groups** -> UserManagementUserGroups list_user_groups() +> UserManagementUserGroups list_user_groups(page=page, size=size, name=name, workspace=workspace, data_source=data_source) @@ -379,11 +350,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.user_management_user_groups import UserManagementUserGroups +from gooddata_api_client.models.user_management_user_groups import UserManagementUserGroups +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -392,34 +363,35 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - page = page=0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = size=20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 - name = "name=charles" # str | Filter by user name. Note that user name is case insensitive. (optional) - workspace = "workspace=demo" # str | Filter by workspaceId. (optional) - data_source = "dataSource=demo-test-ds" # str | Filter by dataSourceId. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.UserManagementApi(api_client) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned. (optional) (default to 20) + name = 'name=charles' # str | Filter by user name. Note that user name is case insensitive. (optional) + workspace = 'workspace=demo' # str | Filter by workspaceId. (optional) + data_source = 'dataSource=demo-test-ds' # str | Filter by dataSourceId. (optional) + try: api_response = api_instance.list_user_groups(page=page, size=size, name=name, workspace=workspace, data_source=data_source) + print("The response of UserManagementApi->list_user_groups:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->list_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 - **name** | **str**| Filter by user name. Note that user name is case insensitive. | [optional] - **workspace** | **str**| Filter by workspaceId. | [optional] - **data_source** | **str**| Filter by dataSourceId. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned. | [optional] [default to 20] + **name** | **str**| Filter by user name. Note that user name is case insensitive. | [optional] + **workspace** | **str**| Filter by workspaceId. | [optional] + **data_source** | **str**| Filter by dataSourceId. | [optional] ### Return type @@ -434,7 +406,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -444,7 +415,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **list_users** -> UserManagementUsers list_users() +> UserManagementUsers list_users(page=page, size=size, name=name, workspace=workspace, group=group, data_source=data_source) @@ -452,11 +423,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.user_management_users import UserManagementUsers +from gooddata_api_client.models.user_management_users import UserManagementUsers +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -465,36 +436,37 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - page = page=0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = size=20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 - name = "name=charles" # str | Filter by user name. Note that user name is case insensitive. (optional) - workspace = "workspace=demo" # str | Filter by workspaceId. (optional) - group = "group=admin" # str | Filter by userGroupId. (optional) - data_source = "dataSource=demo-test-ds" # str | Filter by dataSourceId. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.UserManagementApi(api_client) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned. (optional) (default to 20) + name = 'name=charles' # str | Filter by user name. Note that user name is case insensitive. (optional) + workspace = 'workspace=demo' # str | Filter by workspaceId. (optional) + group = 'group=admin' # str | Filter by userGroupId. (optional) + data_source = 'dataSource=demo-test-ds' # str | Filter by dataSourceId. (optional) + try: api_response = api_instance.list_users(page=page, size=size, name=name, workspace=workspace, group=group, data_source=data_source) + print("The response of UserManagementApi->list_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->list_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 - **name** | **str**| Filter by user name. Note that user name is case insensitive. | [optional] - **workspace** | **str**| Filter by workspaceId. | [optional] - **group** | **str**| Filter by userGroupId. | [optional] - **data_source** | **str**| Filter by dataSourceId. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned. | [optional] [default to 20] + **name** | **str**| Filter by user name. Note that user name is case insensitive. | [optional] + **workspace** | **str**| Filter by workspaceId. | [optional] + **group** | **str**| Filter by userGroupId. | [optional] + **data_source** | **str**| Filter by dataSourceId. | [optional] ### Return type @@ -509,7 +481,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -527,11 +498,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.models.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -540,46 +511,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - user_id = "userId_example" # str | - user_management_permission_assignments = UserManagementPermissionAssignments( - data_sources=[ - UserManagementDataSourcePermissionAssignment( - id="id_example", - permissions=[ - "MANAGE", - ], - ), - ], - workspaces=[ - UserManagementWorkspacePermissionAssignment( - hierarchy_permissions=[ - "MANAGE", - ], - id="id_example", - permissions=[ - "MANAGE", - ], - ), - ], - ) # UserManagementPermissionAssignments | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserManagementApi(api_client) + user_id = 'user_id_example' # str | + user_management_permission_assignments = gooddata_api_client.UserManagementPermissionAssignments() # UserManagementPermissionAssignments | + try: api_instance.manage_permissions_for_user(user_id, user_management_permission_assignments) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->manage_permissions_for_user: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **user_management_permission_assignments** | [**UserManagementPermissionAssignments**](UserManagementPermissionAssignments.md)| | + **user_id** | **str**| | + **user_management_permission_assignments** | [**UserManagementPermissionAssignments**](UserManagementPermissionAssignments.md)| | ### Return type @@ -594,7 +546,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -612,11 +563,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.models.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -625,46 +576,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - user_group_id = "userGroupId_example" # str | - user_management_permission_assignments = UserManagementPermissionAssignments( - data_sources=[ - UserManagementDataSourcePermissionAssignment( - id="id_example", - permissions=[ - "MANAGE", - ], - ), - ], - workspaces=[ - UserManagementWorkspacePermissionAssignment( - hierarchy_permissions=[ - "MANAGE", - ], - id="id_example", - permissions=[ - "MANAGE", - ], - ), - ], - ) # UserManagementPermissionAssignments | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserManagementApi(api_client) + user_group_id = 'user_group_id_example' # str | + user_management_permission_assignments = gooddata_api_client.UserManagementPermissionAssignments() # UserManagementPermissionAssignments | + try: api_instance.manage_permissions_for_user_group(user_group_id, user_management_permission_assignments) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->manage_permissions_for_user_group: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_group_id** | **str**| | - **user_management_permission_assignments** | [**UserManagementPermissionAssignments**](UserManagementPermissionAssignments.md)| | + **user_group_id** | **str**| | + **user_management_permission_assignments** | [**UserManagementPermissionAssignments**](UserManagementPermissionAssignments.md)| | ### Return type @@ -679,7 +611,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -697,11 +628,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers +from gooddata_api_client.models.user_management_user_group_members import UserManagementUserGroupMembers +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -710,32 +641,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - user_group_id = "userGroupId_example" # str | - user_management_user_group_members = UserManagementUserGroupMembers( - members=[ - UserManagementUserGroupMember( - id="id_example", - ), - ], - ) # UserManagementUserGroupMembers | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserManagementApi(api_client) + user_group_id = 'user_group_id_example' # str | + user_management_user_group_members = gooddata_api_client.UserManagementUserGroupMembers() # UserManagementUserGroupMembers | + try: api_instance.remove_group_members(user_group_id, user_management_user_group_members) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->remove_group_members: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_group_id** | **str**| | - **user_management_user_group_members** | [**UserManagementUserGroupMembers**](UserManagementUserGroupMembers.md)| | + **user_group_id** | **str**| | + **user_management_user_group_members** | [**UserManagementUserGroupMembers**](UserManagementUserGroupMembers.md)| | ### Return type @@ -750,7 +676,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -768,11 +693,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -781,29 +706,25 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - assignee_identifier = [ - AssigneeIdentifier( - id="id_example", - type="user", - ), - ] # [AssigneeIdentifier] | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserManagementApi(api_client) + assignee_identifier = [gooddata_api_client.AssigneeIdentifier()] # List[AssigneeIdentifier] | + try: api_instance.remove_users_user_groups(assignee_identifier) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->remove_users_user_groups: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **assignee_identifier** | [**[AssigneeIdentifier]**](AssigneeIdentifier.md)| | + **assignee_identifier** | [**List[AssigneeIdentifier]**](AssigneeIdentifier.md)| | ### Return type @@ -818,7 +739,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -836,11 +756,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_management_api -from gooddata_api_client.model.permissions_assignment import PermissionsAssignment +from gooddata_api_client.models.permissions_assignment import PermissionsAssignment +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -849,50 +769,25 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_management_api.UserManagementApi(api_client) - permissions_assignment = PermissionsAssignment( - assignees=[ - AssigneeIdentifier( - id="id_example", - type="user", - ), - ], - data_sources=[ - UserManagementDataSourcePermissionAssignment( - id="id_example", - permissions=[ - "MANAGE", - ], - ), - ], - workspaces=[ - UserManagementWorkspacePermissionAssignment( - hierarchy_permissions=[ - "MANAGE", - ], - id="id_example", - permissions=[ - "MANAGE", - ], - ), - ], - ) # PermissionsAssignment | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserManagementApi(api_client) + permissions_assignment = gooddata_api_client.PermissionsAssignment() # PermissionsAssignment | + try: api_instance.revoke_permissions(permissions_assignment) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserManagementApi->revoke_permissions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **permissions_assignment** | [**PermissionsAssignment**](PermissionsAssignment.md)| | + **permissions_assignment** | [**PermissionsAssignment**](PermissionsAssignment.md)| | ### Return type @@ -907,7 +802,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/UserManagementDataSourcePermissionAssignment.md b/gooddata-api-client/docs/UserManagementDataSourcePermissionAssignment.md index ce6dd671b..b2341e2d6 100644 --- a/gooddata-api-client/docs/UserManagementDataSourcePermissionAssignment.md +++ b/gooddata-api-client/docs/UserManagementDataSourcePermissionAssignment.md @@ -3,13 +3,30 @@ Datasource permission assignments for users and userGroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Id of the datasource | -**permissions** | **[str]** | | **name** | **str** | Name of the datasource | [optional] [readonly] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment + +# TODO update the JSON string below +json = "{}" +# create an instance of UserManagementDataSourcePermissionAssignment from a JSON string +user_management_data_source_permission_assignment_instance = UserManagementDataSourcePermissionAssignment.from_json(json) +# print the JSON string representation of the object +print(UserManagementDataSourcePermissionAssignment.to_json()) +# convert the object into a dict +user_management_data_source_permission_assignment_dict = user_management_data_source_permission_assignment_instance.to_dict() +# create an instance of UserManagementDataSourcePermissionAssignment from a dict +user_management_data_source_permission_assignment_from_dict = UserManagementDataSourcePermissionAssignment.from_dict(user_management_data_source_permission_assignment_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserManagementPermissionAssignments.md b/gooddata-api-client/docs/UserManagementPermissionAssignments.md index a41805898..e07fdb448 100644 --- a/gooddata-api-client/docs/UserManagementPermissionAssignments.md +++ b/gooddata-api-client/docs/UserManagementPermissionAssignments.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_sources** | [**[UserManagementDataSourcePermissionAssignment]**](UserManagementDataSourcePermissionAssignment.md) | | -**workspaces** | [**[UserManagementWorkspacePermissionAssignment]**](UserManagementWorkspacePermissionAssignment.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**data_sources** | [**List[UserManagementDataSourcePermissionAssignment]**](UserManagementDataSourcePermissionAssignment.md) | | +**workspaces** | [**List[UserManagementWorkspacePermissionAssignment]**](UserManagementWorkspacePermissionAssignment.md) | | + +## Example + +```python +from gooddata_api_client.models.user_management_permission_assignments import UserManagementPermissionAssignments + +# TODO update the JSON string below +json = "{}" +# create an instance of UserManagementPermissionAssignments from a JSON string +user_management_permission_assignments_instance = UserManagementPermissionAssignments.from_json(json) +# print the JSON string representation of the object +print(UserManagementPermissionAssignments.to_json()) +# convert the object into a dict +user_management_permission_assignments_dict = user_management_permission_assignments_instance.to_dict() +# create an instance of UserManagementPermissionAssignments from a dict +user_management_permission_assignments_from_dict = UserManagementPermissionAssignments.from_dict(user_management_permission_assignments_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserManagementUserGroupMember.md b/gooddata-api-client/docs/UserManagementUserGroupMember.md index b03c413b6..185a5afba 100644 --- a/gooddata-api-client/docs/UserManagementUserGroupMember.md +++ b/gooddata-api-client/docs/UserManagementUserGroupMember.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **name** | **str** | | [optional] [readonly] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.user_management_user_group_member import UserManagementUserGroupMember + +# TODO update the JSON string below +json = "{}" +# create an instance of UserManagementUserGroupMember from a JSON string +user_management_user_group_member_instance = UserManagementUserGroupMember.from_json(json) +# print the JSON string representation of the object +print(UserManagementUserGroupMember.to_json()) + +# convert the object into a dict +user_management_user_group_member_dict = user_management_user_group_member_instance.to_dict() +# create an instance of UserManagementUserGroupMember from a dict +user_management_user_group_member_from_dict = UserManagementUserGroupMember.from_dict(user_management_user_group_member_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserManagementUserGroupMembers.md b/gooddata-api-client/docs/UserManagementUserGroupMembers.md index 019c5f04c..b0575a64f 100644 --- a/gooddata-api-client/docs/UserManagementUserGroupMembers.md +++ b/gooddata-api-client/docs/UserManagementUserGroupMembers.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**members** | [**[UserManagementUserGroupMember]**](UserManagementUserGroupMember.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**members** | [**List[UserManagementUserGroupMember]**](UserManagementUserGroupMember.md) | | + +## Example + +```python +from gooddata_api_client.models.user_management_user_group_members import UserManagementUserGroupMembers + +# TODO update the JSON string below +json = "{}" +# create an instance of UserManagementUserGroupMembers from a JSON string +user_management_user_group_members_instance = UserManagementUserGroupMembers.from_json(json) +# print the JSON string representation of the object +print(UserManagementUserGroupMembers.to_json()) +# convert the object into a dict +user_management_user_group_members_dict = user_management_user_group_members_instance.to_dict() +# create an instance of UserManagementUserGroupMembers from a dict +user_management_user_group_members_from_dict = UserManagementUserGroupMembers.from_dict(user_management_user_group_members_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserManagementUserGroups.md b/gooddata-api-client/docs/UserManagementUserGroups.md index 14eb5d978..b1a6c4a4d 100644 --- a/gooddata-api-client/docs/UserManagementUserGroups.md +++ b/gooddata-api-client/docs/UserManagementUserGroups.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_count** | **int** | Total number of groups | -**user_groups** | [**[UserManagementUserGroupsItem]**](UserManagementUserGroupsItem.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**user_groups** | [**List[UserManagementUserGroupsItem]**](UserManagementUserGroupsItem.md) | | + +## Example + +```python +from gooddata_api_client.models.user_management_user_groups import UserManagementUserGroups + +# TODO update the JSON string below +json = "{}" +# create an instance of UserManagementUserGroups from a JSON string +user_management_user_groups_instance = UserManagementUserGroups.from_json(json) +# print the JSON string representation of the object +print(UserManagementUserGroups.to_json()) +# convert the object into a dict +user_management_user_groups_dict = user_management_user_groups_instance.to_dict() +# create an instance of UserManagementUserGroups from a dict +user_management_user_groups_from_dict = UserManagementUserGroups.from_dict(user_management_user_groups_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserManagementUserGroupsItem.md b/gooddata-api-client/docs/UserManagementUserGroupsItem.md index 8bc567136..a81f24c33 100644 --- a/gooddata-api-client/docs/UserManagementUserGroupsItem.md +++ b/gooddata-api-client/docs/UserManagementUserGroupsItem.md @@ -3,16 +3,33 @@ List of groups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_sources** | [**[UserManagementDataSourcePermissionAssignment]**](UserManagementDataSourcePermissionAssignment.md) | | +**data_sources** | [**List[UserManagementDataSourcePermissionAssignment]**](UserManagementDataSourcePermissionAssignment.md) | | **id** | **str** | | +**name** | **str** | Group name | [optional] **organization_admin** | **bool** | Is group organization admin | **user_count** | **int** | The number of users belonging to the group | -**workspaces** | [**[UserManagementWorkspacePermissionAssignment]**](UserManagementWorkspacePermissionAssignment.md) | | -**name** | **str** | Group name | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**workspaces** | [**List[UserManagementWorkspacePermissionAssignment]**](UserManagementWorkspacePermissionAssignment.md) | | + +## Example + +```python +from gooddata_api_client.models.user_management_user_groups_item import UserManagementUserGroupsItem + +# TODO update the JSON string below +json = "{}" +# create an instance of UserManagementUserGroupsItem from a JSON string +user_management_user_groups_item_instance = UserManagementUserGroupsItem.from_json(json) +# print the JSON string representation of the object +print(UserManagementUserGroupsItem.to_json()) +# convert the object into a dict +user_management_user_groups_item_dict = user_management_user_groups_item_instance.to_dict() +# create an instance of UserManagementUserGroupsItem from a dict +user_management_user_groups_item_from_dict = UserManagementUserGroupsItem.from_dict(user_management_user_groups_item_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserManagementUsers.md b/gooddata-api-client/docs/UserManagementUsers.md index 74d9cff51..3a3a570d0 100644 --- a/gooddata-api-client/docs/UserManagementUsers.md +++ b/gooddata-api-client/docs/UserManagementUsers.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_count** | **int** | The total number of users is based on applied filters. | -**users** | [**[UserManagementUsersItem]**](UserManagementUsersItem.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**users** | [**List[UserManagementUsersItem]**](UserManagementUsersItem.md) | | + +## Example + +```python +from gooddata_api_client.models.user_management_users import UserManagementUsers + +# TODO update the JSON string below +json = "{}" +# create an instance of UserManagementUsers from a JSON string +user_management_users_instance = UserManagementUsers.from_json(json) +# print the JSON string representation of the object +print(UserManagementUsers.to_json()) +# convert the object into a dict +user_management_users_dict = user_management_users_instance.to_dict() +# create an instance of UserManagementUsers from a dict +user_management_users_from_dict = UserManagementUsers.from_dict(user_management_users_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserManagementUsersItem.md b/gooddata-api-client/docs/UserManagementUsersItem.md index 00544790f..57dc921ff 100644 --- a/gooddata-api-client/docs/UserManagementUsersItem.md +++ b/gooddata-api-client/docs/UserManagementUsersItem.md @@ -3,17 +3,34 @@ List of users ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_sources** | [**[UserManagementDataSourcePermissionAssignment]**](UserManagementDataSourcePermissionAssignment.md) | | -**id** | **str** | | -**organization_admin** | **bool** | Is user organization admin | -**user_groups** | [**[UserGroupIdentifier]**](UserGroupIdentifier.md) | | -**workspaces** | [**[UserManagementWorkspacePermissionAssignment]**](UserManagementWorkspacePermissionAssignment.md) | | +**data_sources** | [**List[UserManagementDataSourcePermissionAssignment]**](UserManagementDataSourcePermissionAssignment.md) | | **email** | **str** | User email address | [optional] +**id** | **str** | | **name** | **str** | User name | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**organization_admin** | **bool** | Is user organization admin | +**user_groups** | [**List[UserGroupIdentifier]**](UserGroupIdentifier.md) | | +**workspaces** | [**List[UserManagementWorkspacePermissionAssignment]**](UserManagementWorkspacePermissionAssignment.md) | | + +## Example + +```python +from gooddata_api_client.models.user_management_users_item import UserManagementUsersItem + +# TODO update the JSON string below +json = "{}" +# create an instance of UserManagementUsersItem from a JSON string +user_management_users_item_instance = UserManagementUsersItem.from_json(json) +# print the JSON string representation of the object +print(UserManagementUsersItem.to_json()) +# convert the object into a dict +user_management_users_item_dict = user_management_users_item_instance.to_dict() +# create an instance of UserManagementUsersItem from a dict +user_management_users_item_from_dict = UserManagementUsersItem.from_dict(user_management_users_item_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserManagementWorkspacePermissionAssignment.md b/gooddata-api-client/docs/UserManagementWorkspacePermissionAssignment.md index 829a60d93..85e32a29f 100644 --- a/gooddata-api-client/docs/UserManagementWorkspacePermissionAssignment.md +++ b/gooddata-api-client/docs/UserManagementWorkspacePermissionAssignment.md @@ -3,14 +3,31 @@ Workspace permission assignments for users and userGroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hierarchy_permissions** | **[str]** | | +**hierarchy_permissions** | **List[str]** | | **id** | **str** | | -**permissions** | **[str]** | | **name** | **str** | | [optional] [readonly] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | **List[str]** | | + +## Example + +```python +from gooddata_api_client.models.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment + +# TODO update the JSON string below +json = "{}" +# create an instance of UserManagementWorkspacePermissionAssignment from a JSON string +user_management_workspace_permission_assignment_instance = UserManagementWorkspacePermissionAssignment.from_json(json) +# print the JSON string representation of the object +print(UserManagementWorkspacePermissionAssignment.to_json()) +# convert the object into a dict +user_management_workspace_permission_assignment_dict = user_management_workspace_permission_assignment_instance.to_dict() +# create an instance of UserManagementWorkspacePermissionAssignment from a dict +user_management_workspace_permission_assignment_from_dict = UserManagementWorkspacePermissionAssignment.from_dict(user_management_workspace_permission_assignment_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserModelControllerApi.md b/gooddata-api-client/docs/UserModelControllerApi.md index 08476d14f..e7af857dd 100644 --- a/gooddata-api-client/docs/UserModelControllerApi.md +++ b/gooddata-api-client/docs/UserModelControllerApi.md @@ -24,12 +24,12 @@ Post a new API token for the user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -38,33 +38,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - json_api_api_token_in_document = JsonApiApiTokenInDocument( - data=JsonApiApiTokenIn( - id="id1", - type="apiToken", - ), - ) # JsonApiApiTokenInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserModelControllerApi(api_client) + user_id = 'user_id_example' # str | + json_api_api_token_in_document = gooddata_api_client.JsonApiApiTokenInDocument() # JsonApiApiTokenInDocument | + try: # Post a new API token for the user api_response = api_instance.create_entity_api_tokens(user_id, json_api_api_token_in_document) + print("The response of UserModelControllerApi->create_entity_api_tokens:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserModelControllerApi->create_entity_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **json_api_api_token_in_document** | [**JsonApiApiTokenInDocument**](JsonApiApiTokenInDocument.md)| | + **user_id** | **str**| | + **json_api_api_token_in_document** | [**JsonApiApiTokenInDocument**](JsonApiApiTokenInDocument.md)| | ### Return type @@ -79,7 +76,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -97,12 +93,12 @@ Post new user settings for the user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -111,37 +107,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - json_api_user_setting_in_document = JsonApiUserSettingInDocument( - data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="userSetting", - ), - ) # JsonApiUserSettingInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserModelControllerApi(api_client) + user_id = 'user_id_example' # str | + json_api_user_setting_in_document = gooddata_api_client.JsonApiUserSettingInDocument() # JsonApiUserSettingInDocument | + try: # Post new user settings for the user api_response = api_instance.create_entity_user_settings(user_id, json_api_user_setting_in_document) + print("The response of UserModelControllerApi->create_entity_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserModelControllerApi->create_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | + **user_id** | **str**| | + **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | ### Return type @@ -156,7 +145,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -166,7 +154,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_api_tokens** -> delete_entity_api_tokens(user_id, id) +> delete_entity_api_tokens(user_id, id, filter=filter) Delete an API Token for a user @@ -174,10 +162,10 @@ Delete an API Token for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -186,37 +174,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete an API Token for a user - api_instance.delete_entity_api_tokens(user_id, id) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->delete_entity_api_tokens: %s\n" % e) + api_instance = gooddata_api_client.UserModelControllerApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'bearerToken==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete an API Token for a user api_instance.delete_entity_api_tokens(user_id, id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserModelControllerApi->delete_entity_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -231,7 +212,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -241,7 +221,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_user_settings** -> delete_entity_user_settings(user_id, id) +> delete_entity_user_settings(user_id, id, filter=filter) Delete a setting for a user @@ -249,10 +229,10 @@ Delete a setting for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -261,37 +241,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.UserModelControllerApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a setting for a user - api_instance.delete_entity_user_settings(user_id, id) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->delete_entity_user_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a setting for a user api_instance.delete_entity_user_settings(user_id, id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserModelControllerApi->delete_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -306,7 +279,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -316,7 +288,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_api_tokens** -> JsonApiApiTokenOutList get_all_entities_api_tokens(user_id) +> JsonApiApiTokenOutList get_all_entities_api_tokens(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) List all api tokens for a user @@ -324,11 +296,11 @@ List all api tokens for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -337,49 +309,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # List all api tokens for a user - api_response = api_instance.get_all_entities_api_tokens(user_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_all_entities_api_tokens: %s\n" % e) + api_instance = gooddata_api_client.UserModelControllerApi(api_client) + user_id = 'user_id_example' # str | + filter = 'bearerToken==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # List all api tokens for a user api_response = api_instance.get_all_entities_api_tokens(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of UserModelControllerApi->get_all_entities_api_tokens:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserModelControllerApi->get_all_entities_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **user_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -394,7 +355,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -404,7 +364,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_user_settings** -> JsonApiUserSettingOutList get_all_entities_user_settings(user_id) +> JsonApiUserSettingOutList get_all_entities_user_settings(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) List all settings for a user @@ -412,11 +372,11 @@ List all settings for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -425,49 +385,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # List all settings for a user - api_response = api_instance.get_all_entities_user_settings(user_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_all_entities_user_settings: %s\n" % e) + api_instance = gooddata_api_client.UserModelControllerApi(api_client) + user_id = 'user_id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # List all settings for a user api_response = api_instance.get_all_entities_user_settings(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of UserModelControllerApi->get_all_entities_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserModelControllerApi->get_all_entities_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **user_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -482,7 +431,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -492,7 +440,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_api_tokens** -> JsonApiApiTokenOutDocument get_entity_api_tokens(user_id, id) +> JsonApiApiTokenOutDocument get_entity_api_tokens(user_id, id, filter=filter) Get an API Token for a user @@ -500,11 +448,11 @@ Get an API Token for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -513,39 +461,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.UserModelControllerApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'bearerToken==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get an API Token for a user - api_response = api_instance.get_entity_api_tokens(user_id, id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_entity_api_tokens: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get an API Token for a user api_response = api_instance.get_entity_api_tokens(user_id, id, filter=filter) + print("The response of UserModelControllerApi->get_entity_api_tokens:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserModelControllerApi->get_entity_api_tokens: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -560,7 +501,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -570,7 +510,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_settings** -> JsonApiUserSettingOutDocument get_entity_user_settings(user_id, id) +> JsonApiUserSettingOutDocument get_entity_user_settings(user_id, id, filter=filter) Get a setting for a user @@ -578,11 +518,11 @@ Get a setting for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -591,39 +531,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.UserModelControllerApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Get a setting for a user - api_response = api_instance.get_entity_user_settings(user_id, id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_entity_user_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Get a setting for a user api_response = api_instance.get_entity_user_settings(user_id, id, filter=filter) + print("The response of UserModelControllerApi->get_entity_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserModelControllerApi->get_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -638,7 +571,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -648,7 +580,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_user_settings** -> JsonApiUserSettingOutDocument update_entity_user_settings(user_id, id, json_api_user_setting_in_document) +> JsonApiUserSettingOutDocument update_entity_user_settings(user_id, id, json_api_user_setting_in_document, filter=filter) Put new user settings for the user @@ -656,12 +588,12 @@ Put new user settings for the user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -670,50 +602,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_setting_in_document = JsonApiUserSettingInDocument( - data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="userSetting", - ), - ) # JsonApiUserSettingInDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put new user settings for the user - api_response = api_instance.update_entity_user_settings(user_id, id, json_api_user_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->update_entity_user_settings: %s\n" % e) + api_instance = gooddata_api_client.UserModelControllerApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + json_api_user_setting_in_document = gooddata_api_client.JsonApiUserSettingInDocument() # JsonApiUserSettingInDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put new user settings for the user api_response = api_instance.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, filter=filter) + print("The response of UserModelControllerApi->update_entity_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserModelControllerApi->update_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -728,7 +644,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/UserPermission.md b/gooddata-api-client/docs/UserPermission.md index 896b4e34f..c8cfdae56 100644 --- a/gooddata-api-client/docs/UserPermission.md +++ b/gooddata-api-client/docs/UserPermission.md @@ -3,14 +3,31 @@ List of users ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | **email** | **str** | User email address | [optional] +**id** | **str** | | **name** | **str** | Name of user | [optional] -**permissions** | [**[GrantedPermission]**](GrantedPermission.md) | Permissions granted to the user | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**permissions** | [**List[GrantedPermission]**](GrantedPermission.md) | Permissions granted to the user | [optional] + +## Example + +```python +from gooddata_api_client.models.user_permission import UserPermission + +# TODO update the JSON string below +json = "{}" +# create an instance of UserPermission from a JSON string +user_permission_instance = UserPermission.from_json(json) +# print the JSON string representation of the object +print(UserPermission.to_json()) +# convert the object into a dict +user_permission_dict = user_permission_instance.to_dict() +# create an instance of UserPermission from a dict +user_permission_from_dict = UserPermission.from_dict(user_permission_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserSettingsApi.md b/gooddata-api-client/docs/UserSettingsApi.md index 867dbcc39..f8f2b43d3 100644 --- a/gooddata-api-client/docs/UserSettingsApi.md +++ b/gooddata-api-client/docs/UserSettingsApi.md @@ -20,12 +20,12 @@ Post new user settings for the user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_settings_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -34,37 +34,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_settings_api.UserSettingsApi(api_client) - user_id = "userId_example" # str | - json_api_user_setting_in_document = JsonApiUserSettingInDocument( - data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="userSetting", - ), - ) # JsonApiUserSettingInDocument | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UserSettingsApi(api_client) + user_id = 'user_id_example' # str | + json_api_user_setting_in_document = gooddata_api_client.JsonApiUserSettingInDocument() # JsonApiUserSettingInDocument | + try: # Post new user settings for the user api_response = api_instance.create_entity_user_settings(user_id, json_api_user_setting_in_document) + print("The response of UserSettingsApi->create_entity_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserSettingsApi->create_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | + **user_id** | **str**| | + **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | ### Return type @@ -79,7 +72,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -89,7 +81,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_user_settings** -> delete_entity_user_settings(user_id, id) +> delete_entity_user_settings(user_id, id, filter=filter) Delete a setting for a user @@ -97,10 +89,10 @@ Delete a setting for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_settings_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -109,37 +101,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_settings_api.UserSettingsApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a setting for a user - api_instance.delete_entity_user_settings(user_id, id) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserSettingsApi->delete_entity_user_settings: %s\n" % e) + api_instance = gooddata_api_client.UserSettingsApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a setting for a user api_instance.delete_entity_user_settings(user_id, id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserSettingsApi->delete_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -154,7 +139,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -164,7 +148,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_user_settings** -> JsonApiUserSettingOutList get_all_entities_user_settings(user_id) +> JsonApiUserSettingOutList get_all_entities_user_settings(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) List all settings for a user @@ -172,11 +156,11 @@ List all settings for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_settings_api -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -185,49 +169,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_settings_api.UserSettingsApi(api_client) - user_id = "userId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # List all settings for a user - api_response = api_instance.get_all_entities_user_settings(user_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserSettingsApi->get_all_entities_user_settings: %s\n" % e) + api_instance = gooddata_api_client.UserSettingsApi(api_client) + user_id = 'user_id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # List all settings for a user api_response = api_instance.get_all_entities_user_settings(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of UserSettingsApi->get_all_entities_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserSettingsApi->get_all_entities_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **user_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -242,7 +215,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -252,7 +224,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_settings** -> JsonApiUserSettingOutDocument get_entity_user_settings(user_id, id) +> JsonApiUserSettingOutDocument get_entity_user_settings(user_id, id, filter=filter) Get a setting for a user @@ -260,11 +232,11 @@ Get a setting for a user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_settings_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -273,39 +245,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_settings_api.UserSettingsApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get a setting for a user - api_response = api_instance.get_entity_user_settings(user_id, id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserSettingsApi->get_entity_user_settings: %s\n" % e) + api_instance = gooddata_api_client.UserSettingsApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a setting for a user api_response = api_instance.get_entity_user_settings(user_id, id, filter=filter) + print("The response of UserSettingsApi->get_entity_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserSettingsApi->get_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -320,7 +285,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -330,7 +294,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_user_settings** -> JsonApiUserSettingOutDocument update_entity_user_settings(user_id, id, json_api_user_setting_in_document) +> JsonApiUserSettingOutDocument update_entity_user_settings(user_id, id, json_api_user_setting_in_document, filter=filter) Put new user settings for the user @@ -338,12 +302,12 @@ Put new user settings for the user ```python -import time import gooddata_api_client -from gooddata_api_client.api import user_settings_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -352,50 +316,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = user_settings_api.UserSettingsApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_setting_in_document = JsonApiUserSettingInDocument( - data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="userSetting", - ), - ) # JsonApiUserSettingInDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put new user settings for the user - api_response = api_instance.update_entity_user_settings(user_id, id, json_api_user_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserSettingsApi->update_entity_user_settings: %s\n" % e) + api_instance = gooddata_api_client.UserSettingsApi(api_client) + user_id = 'user_id_example' # str | + id = 'id_example' # str | + json_api_user_setting_in_document = gooddata_api_client.JsonApiUserSettingInDocument() # JsonApiUserSettingInDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put new user settings for the user api_response = api_instance.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, filter=filter) + print("The response of UserSettingsApi->update_entity_user_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UserSettingsApi->update_entity_user_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **user_id** | **str**| | + **id** | **str**| | + **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -410,7 +358,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/UsersDeclarativeAPIsApi.md b/gooddata-api-client/docs/UsersDeclarativeAPIsApi.md index c40a5a2c6..c5e71467c 100644 --- a/gooddata-api-client/docs/UsersDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/UsersDeclarativeAPIsApi.md @@ -19,11 +19,11 @@ Retrieve all users including authentication properties. ```python -import time import gooddata_api_client -from gooddata_api_client.api import users_declarative_apis_api -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -32,21 +32,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = users_declarative_apis_api.UsersDeclarativeAPIsApi(api_client) + api_instance = gooddata_api_client.UsersDeclarativeAPIsApi(api_client) - # example, this endpoint has no required or optional parameters try: # Get all users api_response = api_instance.get_users_layout() + print("The response of UsersDeclarativeAPIsApi->get_users_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UsersDeclarativeAPIsApi->get_users_layout: %s\n" % e) ``` + ### Parameters + This endpoint does not need any parameter. ### Return type @@ -62,7 +64,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -82,11 +83,11 @@ Set all users and their authentication properties. ```python -import time import gooddata_api_client -from gooddata_api_client.api import users_declarative_apis_api -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -95,57 +96,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = users_declarative_apis_api.UsersDeclarativeAPIsApi(api_client) - declarative_users = DeclarativeUsers( - users=[ - DeclarativeUser( - auth_id="auth_id_example", - email="user@example.com", - firstname="John", - id="employee123", - lastname="Wick", - permissions=[ - DeclarativeUserPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="SEE", - ), - ], - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - user_groups=[ - DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ], - ), - ], - ) # DeclarativeUsers | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.UsersDeclarativeAPIsApi(api_client) + declarative_users = gooddata_api_client.DeclarativeUsers() # DeclarativeUsers | + try: # Put all users api_instance.put_users_layout(declarative_users) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UsersDeclarativeAPIsApi->put_users_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_users** | [**DeclarativeUsers**](DeclarativeUsers.md)| | + **declarative_users** | [**DeclarativeUsers**](DeclarativeUsers.md)| | ### Return type @@ -160,7 +130,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/UsersEntityAPIsApi.md b/gooddata-api-client/docs/UsersEntityAPIsApi.md index 6fdf6f43c..b27ba88aa 100644 --- a/gooddata-api-client/docs/UsersEntityAPIsApi.md +++ b/gooddata-api-client/docs/UsersEntityAPIsApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **create_entity_users** -> JsonApiUserOutDocument create_entity_users(json_api_user_in_document) +> JsonApiUserOutDocument create_entity_users(json_api_user_in_document, include=include) Post User entities @@ -23,12 +23,12 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import users_entity_apis_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -37,60 +37,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = users_entity_apis_api.UsersEntityAPIsApi(api_client) - json_api_user_in_document = JsonApiUserInDocument( - data=JsonApiUserIn( - attributes=JsonApiUserInAttributes( - authentication_id="authentication_id_example", - email="email_example", - firstname="firstname_example", - lastname="lastname_example", - ), - id="id1", - relationships=JsonApiUserInRelationships( - user_groups=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="user", - ), - ) # JsonApiUserInDocument | - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Post User entities - api_response = api_instance.create_entity_users(json_api_user_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UsersEntityAPIsApi->create_entity_users: %s\n" % e) + api_instance = gooddata_api_client.UsersEntityAPIsApi(api_client) + json_api_user_in_document = gooddata_api_client.JsonApiUserInDocument() # JsonApiUserInDocument | + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post User entities api_response = api_instance.create_entity_users(json_api_user_in_document, include=include) + print("The response of UsersEntityAPIsApi->create_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UsersEntityAPIsApi->create_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -105,7 +75,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -115,7 +84,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_users** -> delete_entity_users(id) +> delete_entity_users(id, filter=filter) Delete User entity @@ -125,10 +94,10 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import users_entity_apis_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -137,35 +106,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = users_entity_apis_api.UsersEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.UsersEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete User entity - api_instance.delete_entity_users(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling UsersEntityAPIsApi->delete_entity_users: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete User entity api_instance.delete_entity_users(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UsersEntityAPIsApi->delete_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -180,7 +142,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -190,7 +151,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_users** -> JsonApiUserOutList get_all_entities_users() +> JsonApiUserOutList get_all_entities_users(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get User entities @@ -200,11 +161,11 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import users_entity_apis_api -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -213,43 +174,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = users_entity_apis_api.UsersEntityAPIsApi(api_client) - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.UsersEntityAPIsApi(api_client) + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) + try: # Get User entities api_response = api_instance.get_all_entities_users(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of UsersEntityAPIsApi->get_all_entities_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UsersEntityAPIsApi->get_all_entities_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -264,7 +220,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -274,7 +229,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_users** -> JsonApiUserOutDocument get_entity_users(id) +> JsonApiUserOutDocument get_entity_users(id, filter=filter, include=include) Get User entity @@ -284,11 +239,11 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import users_entity_apis_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -297,41 +252,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = users_entity_apis_api.UsersEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Get User entity - api_response = api_instance.get_entity_users(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UsersEntityAPIsApi->get_entity_users: %s\n" % e) + api_instance = gooddata_api_client.UsersEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get User entity api_response = api_instance.get_entity_users(id, filter=filter, include=include) + print("The response of UsersEntityAPIsApi->get_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UsersEntityAPIsApi->get_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -346,7 +292,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -356,7 +301,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_users** -> JsonApiUserOutDocument patch_entity_users(id, json_api_user_patch_document) +> JsonApiUserOutDocument patch_entity_users(id, json_api_user_patch_document, filter=filter, include=include) Patch User entity @@ -366,12 +311,12 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import users_entity_apis_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -380,64 +325,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = users_entity_apis_api.UsersEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_patch_document = JsonApiUserPatchDocument( - data=JsonApiUserPatch( - attributes=JsonApiUserInAttributes( - authentication_id="authentication_id_example", - email="email_example", - firstname="firstname_example", - lastname="lastname_example", - ), - id="id1", - relationships=JsonApiUserInRelationships( - user_groups=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="user", - ), - ) # JsonApiUserPatchDocument | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch User entity - api_response = api_instance.patch_entity_users(id, json_api_user_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UsersEntityAPIsApi->patch_entity_users: %s\n" % e) + api_instance = gooddata_api_client.UsersEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_user_patch_document = gooddata_api_client.JsonApiUserPatchDocument() # JsonApiUserPatchDocument | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch User entity api_response = api_instance.patch_entity_users(id, json_api_user_patch_document, filter=filter, include=include) + print("The response of UsersEntityAPIsApi->patch_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UsersEntityAPIsApi->patch_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_patch_document** | [**JsonApiUserPatchDocument**](JsonApiUserPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_patch_document** | [**JsonApiUserPatchDocument**](JsonApiUserPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -452,7 +367,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -462,7 +376,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_users** -> JsonApiUserOutDocument update_entity_users(id, json_api_user_in_document) +> JsonApiUserOutDocument update_entity_users(id, json_api_user_in_document, filter=filter, include=include) Put User entity @@ -472,12 +386,12 @@ User - represents entity interacting with platform ```python -import time import gooddata_api_client -from gooddata_api_client.api import users_entity_apis_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -486,64 +400,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = users_entity_apis_api.UsersEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_in_document = JsonApiUserInDocument( - data=JsonApiUserIn( - attributes=JsonApiUserInAttributes( - authentication_id="authentication_id_example", - email="email_example", - firstname="firstname_example", - lastname="lastname_example", - ), - id="id1", - relationships=JsonApiUserInRelationships( - user_groups=JsonApiUserGroupInRelationshipsParents( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="user", - ), - ) # JsonApiUserInDocument | - filter = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put User entity - api_response = api_instance.update_entity_users(id, json_api_user_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UsersEntityAPIsApi->update_entity_users: %s\n" % e) + api_instance = gooddata_api_client.UsersEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_user_in_document = gooddata_api_client.JsonApiUserInDocument() # JsonApiUserInDocument | + filter = 'authenticationId==someString;firstname==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['userGroups'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put User entity api_response = api_instance.update_entity_users(id, json_api_user_in_document, filter=filter, include=include) + print("The response of UsersEntityAPIsApi->update_entity_users:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling UsersEntityAPIsApi->update_entity_users: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -558,7 +442,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ValidateByItem.md b/gooddata-api-client/docs/ValidateByItem.md index 92021ad07..3c851c4bc 100644 --- a/gooddata-api-client/docs/ValidateByItem.md +++ b/gooddata-api-client/docs/ValidateByItem.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Specifies entity used for valid elements computation. | **type** | **str** | Specifies entity type which could be label, attribute, fact, or metric. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.validate_by_item import ValidateByItem + +# TODO update the JSON string below +json = "{}" +# create an instance of ValidateByItem from a JSON string +validate_by_item_instance = ValidateByItem.from_json(json) +# print the JSON string representation of the object +print(ValidateByItem.to_json()) + +# convert the object into a dict +validate_by_item_dict = validate_by_item_instance.to_dict() +# create an instance of ValidateByItem from a dict +validate_by_item_from_dict = ValidateByItem.from_dict(validate_by_item_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ValidateLLMEndpointByIdRequest.md b/gooddata-api-client/docs/ValidateLLMEndpointByIdRequest.md index bec19e758..763cb27c1 100644 --- a/gooddata-api-client/docs/ValidateLLMEndpointByIdRequest.md +++ b/gooddata-api-client/docs/ValidateLLMEndpointByIdRequest.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **base_url** | **str** | Base URL for the LLM endpoint validation | [optional] @@ -9,8 +10,24 @@ Name | Type | Description | Notes **llm_organization** | **str** | Organization name for the LLM endpoint validation | [optional] **provider** | **str** | Provider for the LLM endpoint validation | [optional] **token** | **str** | Token for the LLM endpoint validation | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ValidateLLMEndpointByIdRequest from a JSON string +validate_llm_endpoint_by_id_request_instance = ValidateLLMEndpointByIdRequest.from_json(json) +# print the JSON string representation of the object +print(ValidateLLMEndpointByIdRequest.to_json()) + +# convert the object into a dict +validate_llm_endpoint_by_id_request_dict = validate_llm_endpoint_by_id_request_instance.to_dict() +# create an instance of ValidateLLMEndpointByIdRequest from a dict +validate_llm_endpoint_by_id_request_from_dict = ValidateLLMEndpointByIdRequest.from_dict(validate_llm_endpoint_by_id_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ValidateLLMEndpointRequest.md b/gooddata-api-client/docs/ValidateLLMEndpointRequest.md index 95b7b3c7a..35a73c557 100644 --- a/gooddata-api-client/docs/ValidateLLMEndpointRequest.md +++ b/gooddata-api-client/docs/ValidateLLMEndpointRequest.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**provider** | **str** | Provider for the LLM endpoint validation | -**token** | **str** | Token for the LLM endpoint validation | **base_url** | **str** | Base URL for the LLM endpoint validation | [optional] **llm_model** | **str** | LLM model for the LLM endpoint validation | [optional] **llm_organization** | **str** | Organization name for the LLM endpoint validation | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**provider** | **str** | Provider for the LLM endpoint validation | +**token** | **str** | Token for the LLM endpoint validation | + +## Example + +```python +from gooddata_api_client.models.validate_llm_endpoint_request import ValidateLLMEndpointRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ValidateLLMEndpointRequest from a JSON string +validate_llm_endpoint_request_instance = ValidateLLMEndpointRequest.from_json(json) +# print the JSON string representation of the object +print(ValidateLLMEndpointRequest.to_json()) +# convert the object into a dict +validate_llm_endpoint_request_dict = validate_llm_endpoint_request_instance.to_dict() +# create an instance of ValidateLLMEndpointRequest from a dict +validate_llm_endpoint_request_from_dict = ValidateLLMEndpointRequest.from_dict(validate_llm_endpoint_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ValidateLLMEndpointResponse.md b/gooddata-api-client/docs/ValidateLLMEndpointResponse.md index ac0f3534f..b604d0d9e 100644 --- a/gooddata-api-client/docs/ValidateLLMEndpointResponse.md +++ b/gooddata-api-client/docs/ValidateLLMEndpointResponse.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **message** | **str** | Additional message about the LLM endpoint validation | **successful** | **bool** | Whether the LLM endpoint validation was successful | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.validate_llm_endpoint_response import ValidateLLMEndpointResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ValidateLLMEndpointResponse from a JSON string +validate_llm_endpoint_response_instance = ValidateLLMEndpointResponse.from_json(json) +# print the JSON string representation of the object +print(ValidateLLMEndpointResponse.to_json()) + +# convert the object into a dict +validate_llm_endpoint_response_dict = validate_llm_endpoint_response_instance.to_dict() +# create an instance of ValidateLLMEndpointResponse from a dict +validate_llm_endpoint_response_from_dict = ValidateLLMEndpointResponse.from_dict(validate_llm_endpoint_response_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/Value.md b/gooddata-api-client/docs/Value.md index b793f9d1d..49a2b2ad5 100644 --- a/gooddata-api-client/docs/Value.md +++ b/gooddata-api-client/docs/Value.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **float** | Value of the alert threshold to compare the metric to. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.value import Value + +# TODO update the JSON string below +json = "{}" +# create an instance of Value from a JSON string +value_instance = Value.from_json(json) +# print the JSON string representation of the object +print(Value.to_json()) + +# convert the object into a dict +value_dict = value_instance.to_dict() +# create an instance of Value from a dict +value_from_dict = Value.from_dict(value_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/VisibleFilter.md b/gooddata-api-client/docs/VisibleFilter.md index d82654e7e..05e796425 100644 --- a/gooddata-api-client/docs/VisibleFilter.md +++ b/gooddata-api-client/docs/VisibleFilter.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**is_all_time_date_filter** | **bool** | Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways. | [optional] if omitted the server will use the default value of False +**is_all_time_date_filter** | **bool** | Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways. | [optional] [default to False] **local_identifier** | **str** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.visible_filter import VisibleFilter + +# TODO update the JSON string below +json = "{}" +# create an instance of VisibleFilter from a JSON string +visible_filter_instance = VisibleFilter.from_json(json) +# print the JSON string representation of the object +print(VisibleFilter.to_json()) + +# convert the object into a dict +visible_filter_dict = visible_filter_instance.to_dict() +# create an instance of VisibleFilter from a dict +visible_filter_from_dict = VisibleFilter.from_dict(visible_filter_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/VisualExportApi.md b/gooddata-api-client/docs/VisualExportApi.md index 526dc524b..1731b4150 100644 --- a/gooddata-api-client/docs/VisualExportApi.md +++ b/gooddata-api-client/docs/VisualExportApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description # **create_pdf_export** -> ExportResponse create_pdf_export(workspace_id, visual_export_request) +> ExportResponse create_pdf_export(workspace_id, visual_export_request, x_gdc_debug=x_gdc_debug) Create visual - pdf export request @@ -20,12 +20,12 @@ An visual export job will be created based on the export request and put to queu ```python -import time import gooddata_api_client -from gooddata_api_client.api import visual_export_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.visual_export_request import VisualExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.visual_export_request import VisualExportRequest +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -34,43 +34,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = visual_export_api.VisualExportApi(api_client) - workspace_id = "workspaceId_example" # str | - visual_export_request = VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ) # VisualExportRequest | - x_gdc_debug = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Create visual - pdf export request - api_response = api_instance.create_pdf_export(workspace_id, visual_export_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling VisualExportApi->create_pdf_export: %s\n" % e) + api_instance = gooddata_api_client.VisualExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + visual_export_request = gooddata_api_client.VisualExportRequest() # VisualExportRequest | + x_gdc_debug = False # bool | (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # Create visual - pdf export request api_response = api_instance.create_pdf_export(workspace_id, visual_export_request, x_gdc_debug=x_gdc_debug) + print("The response of VisualExportApi->create_pdf_export:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling VisualExportApi->create_pdf_export: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **visual_export_request** | [**VisualExportRequest**](VisualExportRequest.md)| | - **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| | + **visual_export_request** | [**VisualExportRequest**](VisualExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] [default to False] ### Return type @@ -85,7 +74,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -95,7 +83,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_exported_file** -> file_type get_exported_file(workspace_id, export_id) +> bytearray get_exported_file(workspace_id, export_id) Retrieve exported files @@ -105,10 +93,10 @@ Returns 202 until original POST export request is not processed.Returns 200 with ```python -import time import gooddata_api_client -from gooddata_api_client.api import visual_export_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -117,32 +105,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = visual_export_api.VisualExportApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.VisualExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # Retrieve exported files api_response = api_instance.get_exported_file(workspace_id, export_id) + print("The response of VisualExportApi->get_exported_file:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling VisualExportApi->get_exported_file: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -**file_type** +**bytearray** ### Authorization @@ -153,7 +143,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/pdf - ### HTTP response details | Status code | Description | Response headers | @@ -174,10 +163,10 @@ This endpoint serves as a cache for user-defined metadata of the export for the ```python -import time import gooddata_api_client -from gooddata_api_client.api import visual_export_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -186,27 +175,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = visual_export_api.VisualExportApi(api_client) - workspace_id = "workspaceId_example" # str | - export_id = "exportId_example" # str | + api_instance = gooddata_api_client.VisualExportApi(api_client) + workspace_id = 'workspace_id_example' # str | + export_id = 'export_id_example' # str | - # example passing only required values which don't have defaults set try: # Retrieve metadata context api_instance.get_metadata(workspace_id, export_id) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling VisualExportApi->get_metadata: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **export_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type @@ -221,7 +211,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/VisualExportRequest.md b/gooddata-api-client/docs/VisualExportRequest.md index 1d3c4dda1..46a9fc1b8 100644 --- a/gooddata-api-client/docs/VisualExportRequest.md +++ b/gooddata-api-client/docs/VisualExportRequest.md @@ -3,13 +3,30 @@ Export request object describing the export properties and metadata for dashboard PDF exports. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dashboard_id** | **str** | Dashboard identifier | **file_name** | **str** | File name to be used for retrieving the pdf document. | -**metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Metadata definition in free-form JSON format. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**metadata** | **object** | Metadata definition in free-form JSON format. | [optional] + +## Example + +```python +from gooddata_api_client.models.visual_export_request import VisualExportRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of VisualExportRequest from a JSON string +visual_export_request_instance = VisualExportRequest.from_json(json) +# print the JSON string representation of the object +print(VisualExportRequest.to_json()) +# convert the object into a dict +visual_export_request_dict = visual_export_request_instance.to_dict() +# create an instance of VisualExportRequest from a dict +visual_export_request_from_dict = VisualExportRequest.from_dict(visual_export_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/VisualizationObjectApi.md b/gooddata-api-client/docs/VisualizationObjectApi.md index dfceada8f..8bec92eb3 100644 --- a/gooddata-api-client/docs/VisualizationObjectApi.md +++ b/gooddata-api-client/docs/VisualizationObjectApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **create_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) +> JsonApiVisualizationObjectOutDocument create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, include=include, meta_include=meta_include) Post Visualization Objects @@ -21,12 +21,12 @@ Post Visualization Objects ```python -import time import gooddata_api_client -from gooddata_api_client.api import visualization_object_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -35,60 +35,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = visualization_object_api.VisualizationObjectApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_visualization_object_post_optional_id_document = JsonApiVisualizationObjectPostOptionalIdDocument( - data=JsonApiVisualizationObjectPostOptionalId( - attributes=JsonApiVisualizationObjectInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", - ), - ) # JsonApiVisualizationObjectPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Visualization Objects - api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling VisualizationObjectApi->create_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.VisualizationObjectApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_visualization_object_post_optional_id_document = gooddata_api_client.JsonApiVisualizationObjectPostOptionalIdDocument() # JsonApiVisualizationObjectPostOptionalIdDocument | + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Visualization Objects api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of VisualizationObjectApi->create_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling VisualizationObjectApi->create_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_visualization_object_post_optional_id_document** | [**JsonApiVisualizationObjectPostOptionalIdDocument**](JsonApiVisualizationObjectPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_visualization_object_post_optional_id_document** | [**JsonApiVisualizationObjectPostOptionalIdDocument**](JsonApiVisualizationObjectPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -103,7 +77,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -113,7 +86,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_visualization_objects** -> delete_entity_visualization_objects(workspace_id, object_id) +> delete_entity_visualization_objects(workspace_id, object_id, filter=filter) Delete a Visualization Object @@ -121,10 +94,10 @@ Delete a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import visualization_object_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -133,37 +106,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = visualization_object_api.VisualizationObjectApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Visualization Object - api_instance.delete_entity_visualization_objects(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling VisualizationObjectApi->delete_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.VisualizationObjectApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Visualization Object api_instance.delete_entity_visualization_objects(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling VisualizationObjectApi->delete_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -178,7 +144,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -188,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_visualization_objects** -> JsonApiVisualizationObjectOutList get_all_entities_visualization_objects(workspace_id) +> JsonApiVisualizationObjectOutList get_all_entities_visualization_objects(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Visualization Objects @@ -196,11 +161,11 @@ Get all Visualization Objects ```python -import time import gooddata_api_client -from gooddata_api_client.api import visualization_object_api -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -209,57 +174,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = visualization_object_api.VisualizationObjectApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Visualization Objects - api_response = api_instance.get_all_entities_visualization_objects(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling VisualizationObjectApi->get_all_entities_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.VisualizationObjectApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Visualization Objects api_response = api_instance.get_all_entities_visualization_objects(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of VisualizationObjectApi->get_all_entities_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling VisualizationObjectApi->get_all_entities_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -274,7 +226,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -284,7 +235,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument get_entity_visualization_objects(workspace_id, object_id) +> JsonApiVisualizationObjectOutDocument get_entity_visualization_objects(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Visualization Object @@ -292,11 +243,11 @@ Get a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import visualization_object_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -305,49 +256,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = visualization_object_api.VisualizationObjectApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Visualization Object - api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling VisualizationObjectApi->get_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.VisualizationObjectApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Visualization Object api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of VisualizationObjectApi->get_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling VisualizationObjectApi->get_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -362,7 +302,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -372,7 +311,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document) +> JsonApiVisualizationObjectOutDocument patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, filter=filter, include=include) Patch a Visualization Object @@ -380,12 +319,12 @@ Patch a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import visualization_object_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -394,60 +333,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = visualization_object_api.VisualizationObjectApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_visualization_object_patch_document = JsonApiVisualizationObjectPatchDocument( - data=JsonApiVisualizationObjectPatch( - attributes=JsonApiVisualizationObjectPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", - ), - ) # JsonApiVisualizationObjectPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Visualization Object - api_response = api_instance.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling VisualizationObjectApi->patch_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.VisualizationObjectApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_visualization_object_patch_document = gooddata_api_client.JsonApiVisualizationObjectPatchDocument() # JsonApiVisualizationObjectPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Visualization Object api_response = api_instance.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, filter=filter, include=include) + print("The response of VisualizationObjectApi->patch_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling VisualizationObjectApi->patch_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_visualization_object_patch_document** | [**JsonApiVisualizationObjectPatchDocument**](JsonApiVisualizationObjectPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_visualization_object_patch_document** | [**JsonApiVisualizationObjectPatchDocument**](JsonApiVisualizationObjectPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -462,7 +377,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -472,7 +386,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) +> JsonApiVisualizationObjectOutDocument update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, filter=filter, include=include) Put a Visualization Object @@ -480,12 +394,12 @@ Put a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import visualization_object_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -494,60 +408,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = visualization_object_api.VisualizationObjectApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_visualization_object_in_document = JsonApiVisualizationObjectInDocument( - data=JsonApiVisualizationObjectIn( - attributes=JsonApiVisualizationObjectInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", - ), - ) # JsonApiVisualizationObjectInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Visualization Object - api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling VisualizationObjectApi->update_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.VisualizationObjectApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_visualization_object_in_document = gooddata_api_client.JsonApiVisualizationObjectInDocument() # JsonApiVisualizationObjectInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Visualization Object api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, filter=filter, include=include) + print("The response of VisualizationObjectApi->update_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling VisualizationObjectApi->update_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_visualization_object_in_document** | [**JsonApiVisualizationObjectInDocument**](JsonApiVisualizationObjectInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_visualization_object_in_document** | [**JsonApiVisualizationObjectInDocument**](JsonApiVisualizationObjectInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -562,7 +452,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/Webhook.md b/gooddata-api-client/docs/Webhook.md index 81cc3adc8..347e20d3f 100644 --- a/gooddata-api-client/docs/Webhook.md +++ b/gooddata-api-client/docs/Webhook.md @@ -3,14 +3,31 @@ Webhook destination for notifications. The property url is required on create and update. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | The destination type. | defaults to "WEBHOOK" -**has_token** | **bool, none_type** | Flag indicating if webhook has a token. | [optional] [readonly] -**token** | **str, none_type** | Bearer token for the webhook. | [optional] +**has_token** | **bool** | Flag indicating if webhook has a token. | [optional] [readonly] +**token** | **str** | Bearer token for the webhook. | [optional] +**type** | **str** | The destination type. | **url** | **str** | The webhook URL. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.webhook import Webhook + +# TODO update the JSON string below +json = "{}" +# create an instance of Webhook from a JSON string +webhook_instance = Webhook.from_json(json) +# print the JSON string representation of the object +print(Webhook.to_json()) + +# convert the object into a dict +webhook_dict = webhook_instance.to_dict() +# create an instance of Webhook from a dict +webhook_from_dict = Webhook.from_dict(webhook_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WebhookAllOf.md b/gooddata-api-client/docs/WebhookAllOf.md deleted file mode 100644 index 1da385e28..000000000 --- a/gooddata-api-client/docs/WebhookAllOf.md +++ /dev/null @@ -1,15 +0,0 @@ -# WebhookAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**has_token** | **bool, none_type** | Flag indicating if webhook has a token. | [optional] [readonly] -**token** | **str, none_type** | Bearer token for the webhook. | [optional] -**type** | **str** | The destination type. | [optional] if omitted the server will use the default value of "WEBHOOK" -**url** | **str** | The webhook URL. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/WebhookAutomationInfo.md b/gooddata-api-client/docs/WebhookAutomationInfo.md index 25fb08a49..e0eea1bc1 100644 --- a/gooddata-api-client/docs/WebhookAutomationInfo.md +++ b/gooddata-api-client/docs/WebhookAutomationInfo.md @@ -2,15 +2,32 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**dashboard_title** | **str** | | [optional] **dashboard_url** | **str** | | **id** | **str** | | **is_custom_dashboard_url** | **bool** | | -**dashboard_title** | **str** | | [optional] **title** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.webhook_automation_info import WebhookAutomationInfo + +# TODO update the JSON string below +json = "{}" +# create an instance of WebhookAutomationInfo from a JSON string +webhook_automation_info_instance = WebhookAutomationInfo.from_json(json) +# print the JSON string representation of the object +print(WebhookAutomationInfo.to_json()) + +# convert the object into a dict +webhook_automation_info_dict = webhook_automation_info_instance.to_dict() +# create an instance of WebhookAutomationInfo from a dict +webhook_automation_info_from_dict = WebhookAutomationInfo.from_dict(webhook_automation_info_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WebhookMessage.md b/gooddata-api-client/docs/WebhookMessage.md index 0b16f2662..eafe6211c 100644 --- a/gooddata-api-client/docs/WebhookMessage.md +++ b/gooddata-api-client/docs/WebhookMessage.md @@ -2,13 +2,30 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**WebhookMessageData**](WebhookMessageData.md) | | **timestamp** | **datetime** | | **type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.webhook_message import WebhookMessage + +# TODO update the JSON string below +json = "{}" +# create an instance of WebhookMessage from a JSON string +webhook_message_instance = WebhookMessage.from_json(json) +# print the JSON string representation of the object +print(WebhookMessage.to_json()) + +# convert the object into a dict +webhook_message_dict = webhook_message_instance.to_dict() +# create an instance of WebhookMessage from a dict +webhook_message_from_dict = WebhookMessage.from_dict(webhook_message_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WebhookMessageData.md b/gooddata-api-client/docs/WebhookMessageData.md index 1c2a792f0..248c56106 100644 --- a/gooddata-api-client/docs/WebhookMessageData.md +++ b/gooddata-api-client/docs/WebhookMessageData.md @@ -2,23 +2,40 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**automation** | [**WebhookAutomationInfo**](WebhookAutomationInfo.md) | | **alert** | [**AlertDescription**](AlertDescription.md) | | [optional] -**dashboard_tabular_exports** | [**[ExportResult]**](ExportResult.md) | | [optional] -**details** | **{str: (str,)}** | | [optional] -**filters** | [**[NotificationFilter]**](NotificationFilter.md) | | [optional] -**image_exports** | [**[ExportResult]**](ExportResult.md) | | [optional] +**automation** | [**WebhookAutomationInfo**](WebhookAutomationInfo.md) | | +**dashboard_tabular_exports** | [**List[ExportResult]**](ExportResult.md) | | [optional] +**details** | **Dict[str, str]** | | [optional] +**filters** | [**List[NotificationFilter]**](NotificationFilter.md) | | [optional] +**image_exports** | [**List[ExportResult]**](ExportResult.md) | | [optional] **notification_source** | **str** | | [optional] -**raw_exports** | [**[ExportResult]**](ExportResult.md) | | [optional] -**recipients** | [**[WebhookRecipient]**](WebhookRecipient.md) | | [optional] +**raw_exports** | [**List[ExportResult]**](ExportResult.md) | | [optional] +**recipients** | [**List[WebhookRecipient]**](WebhookRecipient.md) | | [optional] **remaining_action_count** | **int** | | [optional] -**slides_exports** | [**[ExportResult]**](ExportResult.md) | | [optional] -**tabular_exports** | [**[ExportResult]**](ExportResult.md) | | [optional] -**visual_exports** | [**[ExportResult]**](ExportResult.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**slides_exports** | [**List[ExportResult]**](ExportResult.md) | | [optional] +**tabular_exports** | [**List[ExportResult]**](ExportResult.md) | | [optional] +**visual_exports** | [**List[ExportResult]**](ExportResult.md) | | [optional] + +## Example + +```python +from gooddata_api_client.models.webhook_message_data import WebhookMessageData + +# TODO update the JSON string below +json = "{}" +# create an instance of WebhookMessageData from a JSON string +webhook_message_data_instance = WebhookMessageData.from_json(json) +# print the JSON string representation of the object +print(WebhookMessageData.to_json()) +# convert the object into a dict +webhook_message_data_dict = webhook_message_data_instance.to_dict() +# create an instance of WebhookMessageData from a dict +webhook_message_data_from_dict = WebhookMessageData.from_dict(webhook_message_data_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WebhookRecipient.md b/gooddata-api-client/docs/WebhookRecipient.md index b0406a784..9c251788a 100644 --- a/gooddata-api-client/docs/WebhookRecipient.md +++ b/gooddata-api-client/docs/WebhookRecipient.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **str** | | **id** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.webhook_recipient import WebhookRecipient + +# TODO update the JSON string below +json = "{}" +# create an instance of WebhookRecipient from a JSON string +webhook_recipient_instance = WebhookRecipient.from_json(json) +# print the JSON string representation of the object +print(WebhookRecipient.to_json()) + +# convert the object into a dict +webhook_recipient_dict = webhook_recipient_instance.to_dict() +# create an instance of WebhookRecipient from a dict +webhook_recipient_from_dict = WebhookRecipient.from_dict(webhook_recipient_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WidgetSlidesTemplate.md b/gooddata-api-client/docs/WidgetSlidesTemplate.md index de38ac034..db51865b2 100644 --- a/gooddata-api-client/docs/WidgetSlidesTemplate.md +++ b/gooddata-api-client/docs/WidgetSlidesTemplate.md @@ -3,12 +3,29 @@ Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**applied_on** | **[str]** | Export types this template applies to. | +**applied_on** | **List[str]** | Export types this template applies to. | **content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.widget_slides_template import WidgetSlidesTemplate + +# TODO update the JSON string below +json = "{}" +# create an instance of WidgetSlidesTemplate from a JSON string +widget_slides_template_instance = WidgetSlidesTemplate.from_json(json) +# print the JSON string representation of the object +print(WidgetSlidesTemplate.to_json()) + +# convert the object into a dict +widget_slides_template_dict = widget_slides_template_instance.to_dict() +# create an instance of WidgetSlidesTemplate from a dict +widget_slides_template_from_dict = WidgetSlidesTemplate.from_dict(widget_slides_template_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WorkspaceAutomationIdentifier.md b/gooddata-api-client/docs/WorkspaceAutomationIdentifier.md index e44d9da14..7631052ba 100644 --- a/gooddata-api-client/docs/WorkspaceAutomationIdentifier.md +++ b/gooddata-api-client/docs/WorkspaceAutomationIdentifier.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.workspace_automation_identifier import WorkspaceAutomationIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkspaceAutomationIdentifier from a JSON string +workspace_automation_identifier_instance = WorkspaceAutomationIdentifier.from_json(json) +# print the JSON string representation of the object +print(WorkspaceAutomationIdentifier.to_json()) + +# convert the object into a dict +workspace_automation_identifier_dict = workspace_automation_identifier_instance.to_dict() +# create an instance of WorkspaceAutomationIdentifier from a dict +workspace_automation_identifier_from_dict = WorkspaceAutomationIdentifier.from_dict(workspace_automation_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WorkspaceAutomationManagementBulkRequest.md b/gooddata-api-client/docs/WorkspaceAutomationManagementBulkRequest.md index 926f0a5bd..07376cf5a 100644 --- a/gooddata-api-client/docs/WorkspaceAutomationManagementBulkRequest.md +++ b/gooddata-api-client/docs/WorkspaceAutomationManagementBulkRequest.md @@ -2,11 +2,28 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**automations** | [**[WorkspaceAutomationIdentifier]**](WorkspaceAutomationIdentifier.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**automations** | [**List[WorkspaceAutomationIdentifier]**](WorkspaceAutomationIdentifier.md) | | + +## Example + +```python +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkspaceAutomationManagementBulkRequest from a JSON string +workspace_automation_management_bulk_request_instance = WorkspaceAutomationManagementBulkRequest.from_json(json) +# print the JSON string representation of the object +print(WorkspaceAutomationManagementBulkRequest.to_json()) +# convert the object into a dict +workspace_automation_management_bulk_request_dict = workspace_automation_management_bulk_request_instance.to_dict() +# create an instance of WorkspaceAutomationManagementBulkRequest from a dict +workspace_automation_management_bulk_request_from_dict = WorkspaceAutomationManagementBulkRequest.from_dict(workspace_automation_management_bulk_request_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WorkspaceDataSource.md b/gooddata-api-client/docs/WorkspaceDataSource.md index 239767845..877697228 100644 --- a/gooddata-api-client/docs/WorkspaceDataSource.md +++ b/gooddata-api-client/docs/WorkspaceDataSource.md @@ -3,12 +3,29 @@ The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | The ID of the used data source. | -**schema_path** | **[str]** | The full schema path as array of its path parts. Will be rendered as subPath1.subPath2... | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**schema_path** | **List[str]** | The full schema path as array of its path parts. Will be rendered as subPath1.subPath2... | [optional] + +## Example + +```python +from gooddata_api_client.models.workspace_data_source import WorkspaceDataSource + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkspaceDataSource from a JSON string +workspace_data_source_instance = WorkspaceDataSource.from_json(json) +# print the JSON string representation of the object +print(WorkspaceDataSource.to_json()) +# convert the object into a dict +workspace_data_source_dict = workspace_data_source_instance.to_dict() +# create an instance of WorkspaceDataSource from a dict +workspace_data_source_from_dict = WorkspaceDataSource.from_dict(workspace_data_source_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WorkspaceIdentifier.md b/gooddata-api-client/docs/WorkspaceIdentifier.md index a69d274e0..bd58bb31c 100644 --- a/gooddata-api-client/docs/WorkspaceIdentifier.md +++ b/gooddata-api-client/docs/WorkspaceIdentifier.md @@ -3,12 +3,29 @@ A workspace identifier. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Identifier of the workspace. | -**type** | **str** | A type. | defaults to "workspace" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**type** | **str** | A type. | + +## Example + +```python +from gooddata_api_client.models.workspace_identifier import WorkspaceIdentifier + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkspaceIdentifier from a JSON string +workspace_identifier_instance = WorkspaceIdentifier.from_json(json) +# print the JSON string representation of the object +print(WorkspaceIdentifier.to_json()) +# convert the object into a dict +workspace_identifier_dict = workspace_identifier_instance.to_dict() +# create an instance of WorkspaceIdentifier from a dict +workspace_identifier_from_dict = WorkspaceIdentifier.from_dict(workspace_identifier_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md index 7b84f861c..06eaf2022 100644 --- a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md +++ b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md @@ -101,7 +101,7 @@ Method | HTTP request | Description # **create_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document) +> JsonApiAnalyticalDashboardOutDocument create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, include=include, meta_include=meta_include) Post Dashboards @@ -109,12 +109,12 @@ Post Dashboards ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -123,59 +123,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_analytical_dashboard_post_optional_id_document = JsonApiAnalyticalDashboardPostOptionalIdDocument( - data=JsonApiAnalyticalDashboardPostOptionalId( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=permissions,origin,accessInfo,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Dashboards - api_response = api_instance.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_analytical_dashboard_post_optional_id_document = gooddata_api_client.JsonApiAnalyticalDashboardPostOptionalIdDocument() # JsonApiAnalyticalDashboardPostOptionalIdDocument | + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=permissions,origin,accessInfo,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Dashboards api_response = api_instance.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_analytical_dashboard_post_optional_id_document** | [**JsonApiAnalyticalDashboardPostOptionalIdDocument**](JsonApiAnalyticalDashboardPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_analytical_dashboard_post_optional_id_document** | [**JsonApiAnalyticalDashboardPostOptionalIdDocument**](JsonApiAnalyticalDashboardPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -190,7 +165,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -200,7 +174,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document) +> JsonApiAttributeHierarchyOutDocument create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, include=include, meta_include=meta_include) Post Attribute Hierarchies @@ -208,12 +182,12 @@ Post Attribute Hierarchies ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -222,59 +196,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_attribute_hierarchy_in_document = JsonApiAttributeHierarchyInDocument( - data=JsonApiAttributeHierarchyIn( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyInDocument | - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Attribute Hierarchies - api_response = api_instance.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_attribute_hierarchy_in_document = gooddata_api_client.JsonApiAttributeHierarchyInDocument() # JsonApiAttributeHierarchyInDocument | + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Attribute Hierarchies api_response = api_instance.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, include=include, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -289,7 +238,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -299,7 +247,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_automations** -> JsonApiAutomationOutDocument create_entity_automations(workspace_id, json_api_automation_in_document) +> JsonApiAutomationOutDocument create_entity_automations(workspace_id, json_api_automation_in_document, include=include, meta_include=meta_include) Post Automations @@ -307,12 +255,12 @@ Post Automations ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -321,301 +269,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_automation_in_document = JsonApiAutomationInDocument( - data=JsonApiAutomationIn( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationInDocument | - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Automations - api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_automation_in_document = gooddata_api_client.JsonApiAutomationInDocument() # JsonApiAutomationInDocument | + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Automations api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document, include=include, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -630,7 +311,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -640,7 +320,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document) +> JsonApiCustomApplicationSettingOutDocument create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, meta_include=meta_include) Post Custom Application Settings @@ -648,12 +328,12 @@ Post Custom Application Settings ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -662,50 +342,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_custom_application_setting_post_optional_id_document = JsonApiCustomApplicationSettingPostOptionalIdDocument( - data=JsonApiCustomApplicationSettingPostOptionalId( - attributes=JsonApiCustomApplicationSettingInAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingPostOptionalIdDocument | - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Custom Application Settings - api_response = api_instance.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_custom_application_setting_post_optional_id_document = gooddata_api_client.JsonApiCustomApplicationSettingPostOptionalIdDocument() # JsonApiCustomApplicationSettingPostOptionalIdDocument | + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Custom Application Settings api_response = api_instance.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_custom_application_setting_post_optional_id_document** | [**JsonApiCustomApplicationSettingPostOptionalIdDocument**](JsonApiCustomApplicationSettingPostOptionalIdDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_custom_application_setting_post_optional_id_document** | [**JsonApiCustomApplicationSettingPostOptionalIdDocument**](JsonApiCustomApplicationSettingPostOptionalIdDocument.md)| | + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -720,7 +382,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -730,7 +391,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document) +> JsonApiDashboardPluginOutDocument create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, include=include, meta_include=meta_include) Post Plugins @@ -738,12 +399,12 @@ Post Plugins ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -752,59 +413,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_dashboard_plugin_post_optional_id_document = JsonApiDashboardPluginPostOptionalIdDocument( - data=JsonApiDashboardPluginPostOptionalId( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Plugins - api_response = api_instance.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_dashboard_plugin_post_optional_id_document = gooddata_api_client.JsonApiDashboardPluginPostOptionalIdDocument() # JsonApiDashboardPluginPostOptionalIdDocument | + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Plugins api_response = api_instance.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_dashboard_plugin_post_optional_id_document** | [**JsonApiDashboardPluginPostOptionalIdDocument**](JsonApiDashboardPluginPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_dashboard_plugin_post_optional_id_document** | [**JsonApiDashboardPluginPostOptionalIdDocument**](JsonApiDashboardPluginPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -819,7 +455,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -829,7 +464,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_export_definitions** -> JsonApiExportDefinitionOutDocument create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document) +> JsonApiExportDefinitionOutDocument create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, include=include, meta_include=meta_include) Post Export Definitions @@ -837,12 +472,12 @@ Post Export Definitions ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -851,67 +486,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_export_definition_post_optional_id_document = JsonApiExportDefinitionPostOptionalIdDocument( - data=JsonApiExportDefinitionPostOptionalId( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionPostOptionalIdDocument | - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Export Definitions - api_response = api_instance.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_export_definition_post_optional_id_document = gooddata_api_client.JsonApiExportDefinitionPostOptionalIdDocument() # JsonApiExportDefinitionPostOptionalIdDocument | + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Export Definitions api_response = api_instance.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_export_definition_post_optional_id_document** | [**JsonApiExportDefinitionPostOptionalIdDocument**](JsonApiExportDefinitionPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_export_definition_post_optional_id_document** | [**JsonApiExportDefinitionPostOptionalIdDocument**](JsonApiExportDefinitionPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -926,7 +528,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -936,7 +537,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_filter_contexts** -> JsonApiFilterContextOutDocument create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document) +> JsonApiFilterContextOutDocument create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, include=include, meta_include=meta_include) Post Context Filters @@ -944,12 +545,12 @@ Post Context Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -958,59 +559,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_filter_context_post_optional_id_document = JsonApiFilterContextPostOptionalIdDocument( - data=JsonApiFilterContextPostOptionalId( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextPostOptionalIdDocument | - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Context Filters - api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_filter_context_post_optional_id_document = gooddata_api_client.JsonApiFilterContextPostOptionalIdDocument() # JsonApiFilterContextPostOptionalIdDocument | + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Context Filters api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_filter_context_post_optional_id_document** | [**JsonApiFilterContextPostOptionalIdDocument**](JsonApiFilterContextPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_filter_context_post_optional_id_document** | [**JsonApiFilterContextPostOptionalIdDocument**](JsonApiFilterContextPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1025,7 +601,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1035,7 +610,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_filter_views** -> JsonApiFilterViewOutDocument create_entity_filter_views(workspace_id, json_api_filter_view_in_document) +> JsonApiFilterViewOutDocument create_entity_filter_views(workspace_id, json_api_filter_view_in_document, include=include) Post Filter views @@ -1043,12 +618,12 @@ Post Filter views ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1057,64 +632,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_filter_view_in_document = JsonApiFilterViewInDocument( - data=JsonApiFilterViewIn( - attributes=JsonApiFilterViewInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewInDocument | - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Filter views - api_response = api_instance.create_entity_filter_views(workspace_id, json_api_filter_view_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_filter_view_in_document = gooddata_api_client.JsonApiFilterViewInDocument() # JsonApiFilterViewInDocument | + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Filter views api_response = api_instance.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, include=include) + print("The response of WorkspaceObjectControllerApi->create_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -1129,7 +672,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1139,7 +681,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_metrics** -> JsonApiMetricOutDocument create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document) +> JsonApiMetricOutDocument create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, include=include, meta_include=meta_include) Post Metrics @@ -1147,12 +689,12 @@ Post Metrics ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1161,63 +703,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_metric_post_optional_id_document = JsonApiMetricPostOptionalIdDocument( - data=JsonApiMetricPostOptionalId( - attributes=JsonApiMetricInAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - ), - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="metric", - ), - ) # JsonApiMetricPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Metrics - api_response = api_instance.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_metric_post_optional_id_document = gooddata_api_client.JsonApiMetricPostOptionalIdDocument() # JsonApiMetricPostOptionalIdDocument | + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Metrics api_response = api_instance.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_metric_post_optional_id_document** | [**JsonApiMetricPostOptionalIdDocument**](JsonApiMetricPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_metric_post_optional_id_document** | [**JsonApiMetricPostOptionalIdDocument**](JsonApiMetricPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1232,7 +745,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1242,7 +754,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) +> JsonApiUserDataFilterOutDocument create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, include=include, meta_include=meta_include) Post User Data Filters @@ -1250,12 +762,12 @@ Post User Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1264,67 +776,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_user_data_filter_post_optional_id_document = JsonApiUserDataFilterPostOptionalIdDocument( - data=JsonApiUserDataFilterPostOptionalId( - attributes=JsonApiUserDataFilterInAttributes( - are_relations_valid=True, - description="description_example", - maql="maql_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", - ), - ) # JsonApiUserDataFilterPostOptionalIdDocument | - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post User Data Filters - api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_user_data_filter_post_optional_id_document = gooddata_api_client.JsonApiUserDataFilterPostOptionalIdDocument() # JsonApiUserDataFilterPostOptionalIdDocument | + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post User Data Filters api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_user_data_filter_post_optional_id_document** | [**JsonApiUserDataFilterPostOptionalIdDocument**](JsonApiUserDataFilterPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_user_data_filter_post_optional_id_document** | [**JsonApiUserDataFilterPostOptionalIdDocument**](JsonApiUserDataFilterPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1339,7 +818,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1349,7 +827,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) +> JsonApiVisualizationObjectOutDocument create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, include=include, meta_include=meta_include) Post Visualization Objects @@ -1357,12 +835,12 @@ Post Visualization Objects ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1371,60 +849,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_visualization_object_post_optional_id_document = JsonApiVisualizationObjectPostOptionalIdDocument( - data=JsonApiVisualizationObjectPostOptionalId( - attributes=JsonApiVisualizationObjectInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", - ), - ) # JsonApiVisualizationObjectPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Visualization Objects - api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_visualization_object_post_optional_id_document = gooddata_api_client.JsonApiVisualizationObjectPostOptionalIdDocument() # JsonApiVisualizationObjectPostOptionalIdDocument | + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Visualization Objects api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, include=include, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_visualization_object_post_optional_id_document** | [**JsonApiVisualizationObjectPostOptionalIdDocument**](JsonApiVisualizationObjectPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_visualization_object_post_optional_id_document** | [**JsonApiVisualizationObjectPostOptionalIdDocument**](JsonApiVisualizationObjectPostOptionalIdDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1439,7 +891,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1449,7 +900,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) +> JsonApiWorkspaceDataFilterSettingOutDocument create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, include=include, meta_include=meta_include) Post Settings for Workspace Data Filters @@ -1457,12 +908,12 @@ Post Settings for Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1471,62 +922,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( - data=JsonApiWorkspaceDataFilterSettingIn( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", - ), - ) # JsonApiWorkspaceDataFilterSettingInDocument | - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Settings for Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_workspace_data_filter_setting_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterSettingInDocument() # JsonApiWorkspaceDataFilterSettingInDocument | + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Settings for Workspace Data Filters api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, include=include, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1541,7 +964,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1551,7 +973,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) +> JsonApiWorkspaceDataFilterOutDocument create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, include=include, meta_include=meta_include) Post Workspace Data Filters @@ -1559,12 +981,12 @@ Post Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1573,65 +995,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( - data=JsonApiWorkspaceDataFilterIn( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), - ), - ), - type="workspaceDataFilter", - ), - ) # JsonApiWorkspaceDataFilterInDocument | - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_workspace_data_filter_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterInDocument() # JsonApiWorkspaceDataFilterInDocument | + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Workspace Data Filters api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, include=include, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1646,7 +1037,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1656,7 +1046,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) +> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, meta_include=meta_include) Post Settings for Workspaces @@ -1664,12 +1054,12 @@ Post Settings for Workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1678,50 +1068,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_setting_post_optional_id_document = JsonApiWorkspaceSettingPostOptionalIdDocument( - data=JsonApiWorkspaceSettingPostOptionalId( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="workspaceSetting", - ), - ) # JsonApiWorkspaceSettingPostOptionalIdDocument | - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Settings for Workspaces - api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_workspace_setting_post_optional_id_document = gooddata_api_client.JsonApiWorkspaceSettingPostOptionalIdDocument() # JsonApiWorkspaceSettingPostOptionalIdDocument | + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Settings for Workspaces api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->create_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_setting_post_optional_id_document** | [**JsonApiWorkspaceSettingPostOptionalIdDocument**](JsonApiWorkspaceSettingPostOptionalIdDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_workspace_setting_post_optional_id_document** | [**JsonApiWorkspaceSettingPostOptionalIdDocument**](JsonApiWorkspaceSettingPostOptionalIdDocument.md)| | + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -1736,7 +1108,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1746,7 +1117,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_analytical_dashboards** -> delete_entity_analytical_dashboards(workspace_id, object_id) +> delete_entity_analytical_dashboards(workspace_id, object_id, filter=filter) Delete a Dashboard @@ -1754,10 +1125,10 @@ Delete a Dashboard ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1766,37 +1137,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Dashboard - api_instance.delete_entity_analytical_dashboards(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Dashboard api_instance.delete_entity_analytical_dashboards(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1811,7 +1175,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1821,7 +1184,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_attribute_hierarchies** -> delete_entity_attribute_hierarchies(workspace_id, object_id) +> delete_entity_attribute_hierarchies(workspace_id, object_id, filter=filter) Delete an Attribute Hierarchy @@ -1829,10 +1192,10 @@ Delete an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1841,37 +1204,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete an Attribute Hierarchy - api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_attribute_hierarchies: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete an Attribute Hierarchy api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1886,7 +1242,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1896,7 +1251,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_automations** -> delete_entity_automations(workspace_id, object_id) +> delete_entity_automations(workspace_id, object_id, filter=filter) Delete an Automation @@ -1904,10 +1259,10 @@ Delete an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1916,37 +1271,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete an Automation - api_instance.delete_entity_automations(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete an Automation api_instance.delete_entity_automations(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1961,7 +1309,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -1971,7 +1318,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_custom_application_settings** -> delete_entity_custom_application_settings(workspace_id, object_id) +> delete_entity_custom_application_settings(workspace_id, object_id, filter=filter) Delete a Custom Application Setting @@ -1979,10 +1326,10 @@ Delete a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1991,37 +1338,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Custom Application Setting - api_instance.delete_entity_custom_application_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_custom_application_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Custom Application Setting api_instance.delete_entity_custom_application_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2036,7 +1376,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2046,7 +1385,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_dashboard_plugins** -> delete_entity_dashboard_plugins(workspace_id, object_id) +> delete_entity_dashboard_plugins(workspace_id, object_id, filter=filter) Delete a Plugin @@ -2054,10 +1393,10 @@ Delete a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2066,37 +1405,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Plugin - api_instance.delete_entity_dashboard_plugins(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_dashboard_plugins: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Plugin api_instance.delete_entity_dashboard_plugins(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2111,7 +1443,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2121,7 +1452,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_export_definitions** -> delete_entity_export_definitions(workspace_id, object_id) +> delete_entity_export_definitions(workspace_id, object_id, filter=filter) Delete an Export Definition @@ -2129,10 +1460,10 @@ Delete an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2141,37 +1472,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete an Export Definition - api_instance.delete_entity_export_definitions(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete an Export Definition api_instance.delete_entity_export_definitions(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2186,7 +1510,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2196,7 +1519,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_filter_contexts** -> delete_entity_filter_contexts(workspace_id, object_id) +> delete_entity_filter_contexts(workspace_id, object_id, filter=filter) Delete a Context Filter @@ -2204,10 +1527,10 @@ Delete a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2216,37 +1539,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Context Filter - api_instance.delete_entity_filter_contexts(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Context Filter api_instance.delete_entity_filter_contexts(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2261,7 +1577,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2271,7 +1586,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_filter_views** -> delete_entity_filter_views(workspace_id, object_id) +> delete_entity_filter_views(workspace_id, object_id, filter=filter) Delete Filter view @@ -2279,10 +1594,10 @@ Delete Filter view ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2291,37 +1606,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Filter view - api_instance.delete_entity_filter_views(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_filter_views: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Filter view api_instance.delete_entity_filter_views(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2336,7 +1644,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2346,7 +1653,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_metrics** -> delete_entity_metrics(workspace_id, object_id) +> delete_entity_metrics(workspace_id, object_id, filter=filter) Delete a Metric @@ -2354,10 +1661,10 @@ Delete a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2366,37 +1673,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Metric - api_instance.delete_entity_metrics(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_metrics: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Metric api_instance.delete_entity_metrics(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2411,7 +1711,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2421,7 +1720,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_user_data_filters** -> delete_entity_user_data_filters(workspace_id, object_id) +> delete_entity_user_data_filters(workspace_id, object_id, filter=filter) Delete a User Data Filter @@ -2429,10 +1728,10 @@ Delete a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2441,37 +1740,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a User Data Filter - api_instance.delete_entity_user_data_filters(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_user_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a User Data Filter api_instance.delete_entity_user_data_filters(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2486,7 +1778,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2496,7 +1787,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_visualization_objects** -> delete_entity_visualization_objects(workspace_id, object_id) +> delete_entity_visualization_objects(workspace_id, object_id, filter=filter) Delete a Visualization Object @@ -2504,10 +1795,10 @@ Delete a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2516,37 +1807,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Visualization Object - api_instance.delete_entity_visualization_objects(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Visualization Object api_instance.delete_entity_visualization_objects(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2561,7 +1845,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2571,7 +1854,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspace_data_filter_settings** -> delete_entity_workspace_data_filter_settings(workspace_id, object_id) +> delete_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter) Delete a Settings for Workspace Data Filter @@ -2579,10 +1862,10 @@ Delete a Settings for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2591,37 +1874,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Settings for Workspace Data Filter - api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_data_filter_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Settings for Workspace Data Filter api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2636,7 +1912,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2646,7 +1921,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspace_data_filters** -> delete_entity_workspace_data_filters(workspace_id, object_id) +> delete_entity_workspace_data_filters(workspace_id, object_id, filter=filter) Delete a Workspace Data Filter @@ -2654,10 +1929,10 @@ Delete a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2666,37 +1941,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Workspace Data Filter - api_instance.delete_entity_workspace_data_filters(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Workspace Data Filter api_instance.delete_entity_workspace_data_filters(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2711,7 +1979,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2721,7 +1988,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspace_settings** -> delete_entity_workspace_settings(workspace_id, object_id) +> delete_entity_workspace_settings(workspace_id, object_id, filter=filter) Delete a Setting for Workspace @@ -2729,10 +1996,10 @@ Delete a Setting for Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2741,37 +2008,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Setting for Workspace - api_instance.delete_entity_workspace_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Setting for Workspace api_instance.delete_entity_workspace_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -2786,7 +2046,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -2796,7 +2055,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_aggregated_facts** -> JsonApiAggregatedFactOutList get_all_entities_aggregated_facts(workspace_id) +> JsonApiAggregatedFactOutList get_all_entities_aggregated_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) @@ -2804,11 +2063,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList +from gooddata_api_client.models.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2817,55 +2076,43 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,sourceFact", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_all_entities_aggregated_facts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_aggregated_facts: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset,sourceFact'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: api_response = api_instance.get_all_entities_aggregated_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_aggregated_facts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_aggregated_facts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2880,7 +2127,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2890,7 +2136,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_analytical_dashboards** -> JsonApiAnalyticalDashboardOutList get_all_entities_analytical_dashboards(workspace_id) +> JsonApiAnalyticalDashboardOutList get_all_entities_analytical_dashboards(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Dashboards @@ -2898,11 +2144,11 @@ Get all Dashboards ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -2911,57 +2157,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=permissions,origin,accessInfo,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Dashboards - api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=permissions,origin,accessInfo,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Dashboards api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -2976,7 +2209,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -2986,7 +2218,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_attribute_hierarchies** -> JsonApiAttributeHierarchyOutList get_all_entities_attribute_hierarchies(workspace_id) +> JsonApiAttributeHierarchyOutList get_all_entities_attribute_hierarchies(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Attribute Hierarchies @@ -2994,11 +2226,11 @@ Get all Attribute Hierarchies ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.models.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3007,57 +2239,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Attribute Hierarchies - api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Attribute Hierarchies api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3072,7 +2291,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3082,7 +2300,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_attributes** -> JsonApiAttributeOutList get_all_entities_attributes(workspace_id) +> JsonApiAttributeOutList get_all_entities_attributes(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Attributes @@ -3090,11 +2308,11 @@ Get all Attributes ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3103,57 +2321,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,defaultView,labels,attributeHierarchies", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Attributes - api_response = api_instance.get_all_entities_attributes(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_attributes: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;dataset.id==321;defaultView.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset,defaultView,labels,attributeHierarchies'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Attributes api_response = api_instance.get_all_entities_attributes(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_attributes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_attributes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3168,7 +2373,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3178,7 +2382,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_automations** -> JsonApiAutomationOutList get_all_entities_automations(workspace_id) +> JsonApiAutomationOutList get_all_entities_automations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Automations @@ -3186,11 +2390,11 @@ Get all Automations ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.models.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3199,57 +2403,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Automations - api_response = api_instance.get_all_entities_automations(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_automations: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Automations api_response = api_instance.get_all_entities_automations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3264,7 +2455,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3274,7 +2464,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_custom_application_settings** -> JsonApiCustomApplicationSettingOutList get_all_entities_custom_application_settings(workspace_id) +> JsonApiCustomApplicationSettingOutList get_all_entities_custom_application_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Custom Application Settings @@ -3282,11 +2472,11 @@ Get all Custom Application Settings ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3295,53 +2485,42 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Custom Application Settings - api_response = api_instance.get_all_entities_custom_application_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Custom Application Settings api_response = api_instance.get_all_entities_custom_application_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3356,7 +2535,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3366,7 +2544,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_dashboard_plugins** -> JsonApiDashboardPluginOutList get_all_entities_dashboard_plugins(workspace_id) +> JsonApiDashboardPluginOutList get_all_entities_dashboard_plugins(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Plugins @@ -3374,11 +2552,11 @@ Get all Plugins ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3387,57 +2565,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Plugins - api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Plugins api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3452,7 +2617,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3462,7 +2626,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_datasets** -> JsonApiDatasetOutList get_all_entities_datasets(workspace_id) +> JsonApiDatasetOutList get_all_entities_datasets(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Datasets @@ -3470,11 +2634,11 @@ Get all Datasets ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3483,57 +2647,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Datasets - api_response = api_instance.get_all_entities_datasets(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_datasets: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,facts,aggregatedFacts,references,workspaceDataFilters'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Datasets api_response = api_instance.get_all_entities_datasets(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_datasets:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_datasets: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3548,7 +2699,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3558,7 +2708,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_export_definitions** -> JsonApiExportDefinitionOutList get_all_entities_export_definitions(workspace_id) +> JsonApiExportDefinitionOutList get_all_entities_export_definitions(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Export Definitions @@ -3566,11 +2716,11 @@ Get all Export Definitions ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.models.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3579,57 +2729,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Export Definitions - api_response = api_instance.get_all_entities_export_definitions(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Export Definitions api_response = api_instance.get_all_entities_export_definitions(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3644,7 +2781,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3654,7 +2790,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_facts** -> JsonApiFactOutList get_all_entities_facts(workspace_id) +> JsonApiFactOutList get_all_entities_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Facts @@ -3662,11 +2798,11 @@ Get all Facts ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3675,57 +2811,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Facts - api_response = api_instance.get_all_entities_facts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_facts: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;dataset.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Facts api_response = api_instance.get_all_entities_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_facts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_facts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3740,7 +2863,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3750,7 +2872,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_filter_contexts** -> JsonApiFilterContextOutList get_all_entities_filter_contexts(workspace_id) +> JsonApiFilterContextOutList get_all_entities_filter_contexts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Context Filters @@ -3758,11 +2880,11 @@ Get all Context Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3771,57 +2893,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Context Filters - api_response = api_instance.get_all_entities_filter_contexts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Context Filters api_response = api_instance.get_all_entities_filter_contexts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3836,7 +2945,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3846,7 +2954,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_filter_views** -> JsonApiFilterViewOutList get_all_entities_filter_views(workspace_id) +> JsonApiFilterViewOutList get_all_entities_filter_views(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Filter views @@ -3854,11 +2962,11 @@ Get all Filter views ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.models.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3867,57 +2975,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Filter views - api_response = api_instance.get_all_entities_filter_views(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_filter_views: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Filter views api_response = api_instance.get_all_entities_filter_views(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -3932,7 +3027,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -3942,7 +3036,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_labels** -> JsonApiLabelOutList get_all_entities_labels(workspace_id) +> JsonApiLabelOutList get_all_entities_labels(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Labels @@ -3950,11 +3044,11 @@ Get all Labels ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -3963,57 +3057,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Labels - api_response = api_instance.get_all_entities_labels(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_labels: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;attribute.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attribute'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Labels api_response = api_instance.get_all_entities_labels(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_labels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_labels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4028,7 +3109,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4038,7 +3118,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_metrics** -> JsonApiMetricOutList get_all_entities_metrics(workspace_id) +> JsonApiMetricOutList get_all_entities_metrics(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Metrics @@ -4046,11 +3126,11 @@ Get all Metrics ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4059,57 +3139,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Metrics - api_response = api_instance.get_all_entities_metrics(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_metrics: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Metrics api_response = api_instance.get_all_entities_metrics(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4124,7 +3191,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4134,7 +3200,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_user_data_filters** -> JsonApiUserDataFilterOutList get_all_entities_user_data_filters(workspace_id) +> JsonApiUserDataFilterOutList get_all_entities_user_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all User Data Filters @@ -4142,11 +3208,11 @@ Get all User Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4155,57 +3221,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all User Data Filters - api_response = api_instance.get_all_entities_user_data_filters(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all User Data Filters api_response = api_instance.get_all_entities_user_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4220,7 +3273,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4230,7 +3282,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_visualization_objects** -> JsonApiVisualizationObjectOutList get_all_entities_visualization_objects(workspace_id) +> JsonApiVisualizationObjectOutList get_all_entities_visualization_objects(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Visualization Objects @@ -4238,11 +3290,11 @@ Get all Visualization Objects ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4251,57 +3303,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Visualization Objects - api_response = api_instance.get_all_entities_visualization_objects(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Visualization Objects api_response = api_instance.get_all_entities_visualization_objects(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4316,7 +3355,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4326,7 +3364,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id) +> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Settings for Workspace Data Filters @@ -4334,11 +3372,11 @@ Get all Settings for Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4347,57 +3385,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Settings for Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Settings for Workspace Data Filters api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4412,7 +3437,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4422,7 +3446,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id) +> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Workspace Data Filters @@ -4430,11 +3454,11 @@ Get all Workspace Data Filters ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4443,57 +3467,44 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Workspace Data Filters api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4508,7 +3519,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4518,7 +3528,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspace_settings** -> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id) +> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Setting for Workspaces @@ -4526,11 +3536,11 @@ Get all Setting for Workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4539,53 +3549,42 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Setting for Workspaces - api_response = api_instance.get_all_entities_workspace_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Setting for Workspaces api_response = api_instance.get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_all_entities_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4600,7 +3599,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4610,7 +3608,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_aggregated_facts** -> JsonApiAggregatedFactOutDocument get_entity_aggregated_facts(workspace_id, object_id) +> JsonApiAggregatedFactOutDocument get_entity_aggregated_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) @@ -4618,11 +3616,11 @@ No authorization required ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument +from gooddata_api_client.models.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4631,47 +3629,37 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,sourceFact", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_aggregated_facts: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset,sourceFact'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_aggregated_facts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_aggregated_facts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4686,7 +3674,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4696,7 +3683,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id) +> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Dashboard @@ -4704,11 +3691,11 @@ Get a Dashboard ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4717,49 +3704,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=permissions,origin,accessInfo,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Dashboard - api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=permissions,origin,accessInfo,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Dashboard api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4774,7 +3750,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4784,7 +3759,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument get_entity_attribute_hierarchies(workspace_id, object_id) +> JsonApiAttributeHierarchyOutDocument get_entity_attribute_hierarchies(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Attribute Hierarchy @@ -4792,11 +3767,11 @@ Get an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4805,49 +3780,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Attribute Hierarchy - api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Attribute Hierarchy api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4862,7 +3826,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4872,7 +3835,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_attributes** -> JsonApiAttributeOutDocument get_entity_attributes(workspace_id, object_id) +> JsonApiAttributeOutDocument get_entity_attributes(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Attribute @@ -4880,11 +3843,11 @@ Get an Attribute ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4893,49 +3856,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,defaultView,labels,attributeHierarchies", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Attribute - api_response = api_instance.get_entity_attributes(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_attributes: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;dataset.id==321;defaultView.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset,defaultView,labels,attributeHierarchies'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Attribute api_response = api_instance.get_entity_attributes(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_attributes:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_attributes: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -4950,7 +3902,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -4960,7 +3911,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_automations** -> JsonApiAutomationOutDocument get_entity_automations(workspace_id, object_id) +> JsonApiAutomationOutDocument get_entity_automations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Automation @@ -4968,11 +3919,11 @@ Get an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -4981,49 +3932,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Automation - api_response = api_instance.get_entity_automations(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Automation api_response = api_instance.get_entity_automations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5038,7 +3978,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5048,7 +3987,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument get_entity_custom_application_settings(workspace_id, object_id) +> JsonApiCustomApplicationSettingOutDocument get_entity_custom_application_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Custom Application Setting @@ -5056,11 +3995,11 @@ Get a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5069,45 +4008,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Custom Application Setting - api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Custom Application Setting api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5122,7 +4052,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5132,7 +4061,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument get_entity_dashboard_plugins(workspace_id, object_id) +> JsonApiDashboardPluginOutDocument get_entity_dashboard_plugins(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Plugin @@ -5140,11 +4069,11 @@ Get a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5153,49 +4082,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Plugin - api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Plugin api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5210,7 +4128,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5220,7 +4137,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_datasets** -> JsonApiDatasetOutDocument get_entity_datasets(workspace_id, object_id) +> JsonApiDatasetOutDocument get_entity_datasets(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Dataset @@ -5228,11 +4145,11 @@ Get a Dataset ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5241,49 +4158,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Dataset - api_response = api_instance.get_entity_datasets(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_datasets: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,facts,aggregatedFacts,references,workspaceDataFilters'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Dataset api_response = api_instance.get_entity_datasets(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_datasets:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_datasets: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5298,7 +4204,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5308,7 +4213,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_export_definitions** -> JsonApiExportDefinitionOutDocument get_entity_export_definitions(workspace_id, object_id) +> JsonApiExportDefinitionOutDocument get_entity_export_definitions(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get an Export Definition @@ -5316,11 +4221,11 @@ Get an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5329,49 +4234,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Export Definition - api_response = api_instance.get_entity_export_definitions(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get an Export Definition api_response = api_instance.get_entity_export_definitions(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5386,7 +4280,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5396,7 +4289,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_facts** -> JsonApiFactOutDocument get_entity_facts(workspace_id, object_id) +> JsonApiFactOutDocument get_entity_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Fact @@ -5404,11 +4297,11 @@ Get a Fact ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5417,49 +4310,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Fact - api_response = api_instance.get_entity_facts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_facts: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;dataset.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['dataset'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Fact api_response = api_instance.get_entity_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_facts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_facts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5474,7 +4356,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5484,7 +4365,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_filter_contexts** -> JsonApiFilterContextOutDocument get_entity_filter_contexts(workspace_id, object_id) +> JsonApiFilterContextOutDocument get_entity_filter_contexts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Context Filter @@ -5492,11 +4373,11 @@ Get a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5505,49 +4386,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Context Filter - api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Context Filter api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5562,7 +4432,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5572,7 +4441,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_filter_views** -> JsonApiFilterViewOutDocument get_entity_filter_views(workspace_id, object_id) +> JsonApiFilterViewOutDocument get_entity_filter_views(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations) Get Filter view @@ -5580,11 +4449,11 @@ Get Filter view ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5593,45 +4462,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Get Filter view - api_response = api_instance.get_entity_filter_views(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) - # example passing only required values which don't have defaults set - # and optional values try: # Get Filter view api_response = api_instance.get_entity_filter_views(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations) + print("The response of WorkspaceObjectControllerApi->get_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] ### Return type @@ -5646,7 +4506,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5656,7 +4515,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_labels** -> JsonApiLabelOutDocument get_entity_labels(workspace_id, object_id) +> JsonApiLabelOutDocument get_entity_labels(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Label @@ -5664,11 +4523,11 @@ Get a Label ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5677,49 +4536,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Label - api_response = api_instance.get_entity_labels(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_labels: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;attribute.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attribute'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Label api_response = api_instance.get_entity_labels(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_labels:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_labels: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5734,7 +4582,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5744,7 +4591,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_metrics** -> JsonApiMetricOutDocument get_entity_metrics(workspace_id, object_id) +> JsonApiMetricOutDocument get_entity_metrics(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Metric @@ -5752,11 +4599,11 @@ Get a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5765,49 +4612,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Metric - api_response = api_instance.get_entity_metrics(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Metric api_response = api_instance.get_entity_metrics(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5822,7 +4658,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5832,7 +4667,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument get_entity_user_data_filters(workspace_id, object_id) +> JsonApiUserDataFilterOutDocument get_entity_user_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a User Data Filter @@ -5840,11 +4675,11 @@ Get a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5853,49 +4688,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a User Data Filter - api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a User Data Filter api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5910,7 +4734,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -5920,7 +4743,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument get_entity_visualization_objects(workspace_id, object_id) +> JsonApiVisualizationObjectOutDocument get_entity_visualization_objects(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Visualization Object @@ -5928,11 +4751,11 @@ Get a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -5941,49 +4764,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Visualization Object - api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Visualization Object api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -5998,7 +4810,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6008,7 +4819,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id) +> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Setting for Workspace Data Filter @@ -6016,11 +4827,11 @@ Get a Setting for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6029,49 +4840,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Setting for Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Setting for Workspace Data Filter api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6086,7 +4886,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6096,7 +4895,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id) +> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Workspace Data Filter @@ -6104,11 +4903,11 @@ Get a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6117,49 +4916,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Workspace Data Filter api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6174,7 +4962,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6184,7 +4971,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id) +> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Setting for Workspace @@ -6192,11 +4979,11 @@ Get a Setting for Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6205,45 +4992,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Setting for Workspace - api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Setting for Workspace api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspaceObjectControllerApi->get_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -6258,7 +5036,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6268,7 +5045,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) +> JsonApiAnalyticalDashboardOutDocument patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, filter=filter, include=include) Patch a Dashboard @@ -6276,12 +5053,12 @@ Patch a Dashboard ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6290,59 +5067,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_analytical_dashboard_patch_document = JsonApiAnalyticalDashboardPatchDocument( - data=JsonApiAnalyticalDashboardPatch( - attributes=JsonApiAnalyticalDashboardPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Dashboard - api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_analytical_dashboard_patch_document = gooddata_api_client.JsonApiAnalyticalDashboardPatchDocument() # JsonApiAnalyticalDashboardPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Dashboard api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_analytical_dashboard_patch_document** | [**JsonApiAnalyticalDashboardPatchDocument**](JsonApiAnalyticalDashboardPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_analytical_dashboard_patch_document** | [**JsonApiAnalyticalDashboardPatchDocument**](JsonApiAnalyticalDashboardPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -6357,7 +5111,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6367,7 +5120,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) +> JsonApiAttributeHierarchyOutDocument patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, filter=filter, include=include) Patch an Attribute Hierarchy @@ -6375,12 +5128,12 @@ Patch an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6389,59 +5142,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_attribute_hierarchy_patch_document = JsonApiAttributeHierarchyPatchDocument( - data=JsonApiAttributeHierarchyPatch( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Attribute Hierarchy - api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_attribute_hierarchy_patch_document = gooddata_api_client.JsonApiAttributeHierarchyPatchDocument() # JsonApiAttributeHierarchyPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch an Attribute Hierarchy api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_attribute_hierarchy_patch_document** | [**JsonApiAttributeHierarchyPatchDocument**](JsonApiAttributeHierarchyPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_attribute_hierarchy_patch_document** | [**JsonApiAttributeHierarchyPatchDocument**](JsonApiAttributeHierarchyPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -6456,7 +5186,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6466,7 +5195,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_automations** -> JsonApiAutomationOutDocument patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) +> JsonApiAutomationOutDocument patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, filter=filter, include=include) Patch an Automation @@ -6474,12 +5203,12 @@ Patch an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6488,301 +5217,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_automation_patch_document = JsonApiAutomationPatchDocument( - data=JsonApiAutomationPatch( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationPatchDocument | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Automation - api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_automation_patch_document = gooddata_api_client.JsonApiAutomationPatchDocument() # JsonApiAutomationPatchDocument | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch an Automation api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_automation_patch_document** | [**JsonApiAutomationPatchDocument**](JsonApiAutomationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_automation_patch_document** | [**JsonApiAutomationPatchDocument**](JsonApiAutomationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -6797,7 +5261,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6807,7 +5270,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) +> JsonApiCustomApplicationSettingOutDocument patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, filter=filter) Patch a Custom Application Setting @@ -6815,12 +5278,12 @@ Patch a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6829,50 +5292,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_custom_application_setting_patch_document = JsonApiCustomApplicationSettingPatchDocument( - data=JsonApiCustomApplicationSettingPatch( - attributes=JsonApiCustomApplicationSettingPatchAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingPatchDocument | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Custom Application Setting - api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_custom_application_setting_patch_document = gooddata_api_client.JsonApiCustomApplicationSettingPatchDocument() # JsonApiCustomApplicationSettingPatchDocument | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Custom Application Setting api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, filter=filter) + print("The response of WorkspaceObjectControllerApi->patch_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_custom_application_setting_patch_document** | [**JsonApiCustomApplicationSettingPatchDocument**](JsonApiCustomApplicationSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_custom_application_setting_patch_document** | [**JsonApiCustomApplicationSettingPatchDocument**](JsonApiCustomApplicationSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -6887,7 +5334,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6897,7 +5343,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) +> JsonApiDashboardPluginOutDocument patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, filter=filter, include=include) Patch a Plugin @@ -6905,12 +5351,12 @@ Patch a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -6919,59 +5365,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_dashboard_plugin_patch_document = JsonApiDashboardPluginPatchDocument( - data=JsonApiDashboardPluginPatch( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Plugin - api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_dashboard_plugin_patch_document = gooddata_api_client.JsonApiDashboardPluginPatchDocument() # JsonApiDashboardPluginPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Plugin api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_dashboard_plugin_patch_document** | [**JsonApiDashboardPluginPatchDocument**](JsonApiDashboardPluginPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_dashboard_plugin_patch_document** | [**JsonApiDashboardPluginPatchDocument**](JsonApiDashboardPluginPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -6986,7 +5409,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -6996,7 +5418,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_export_definitions** -> JsonApiExportDefinitionOutDocument patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) +> JsonApiExportDefinitionOutDocument patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, filter=filter, include=include) Patch an Export Definition @@ -7004,12 +5426,12 @@ Patch an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7018,67 +5440,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_export_definition_patch_document = JsonApiExportDefinitionPatchDocument( - data=JsonApiExportDefinitionPatch( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionPatchDocument | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Export Definition - api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_export_definition_patch_document = gooddata_api_client.JsonApiExportDefinitionPatchDocument() # JsonApiExportDefinitionPatchDocument | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch an Export Definition api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_export_definition_patch_document** | [**JsonApiExportDefinitionPatchDocument**](JsonApiExportDefinitionPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_export_definition_patch_document** | [**JsonApiExportDefinitionPatchDocument**](JsonApiExportDefinitionPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -7093,7 +5484,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7103,7 +5493,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_filter_contexts** -> JsonApiFilterContextOutDocument patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) +> JsonApiFilterContextOutDocument patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, filter=filter, include=include) Patch a Context Filter @@ -7111,12 +5501,12 @@ Patch a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7125,59 +5515,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_context_patch_document = JsonApiFilterContextPatchDocument( - data=JsonApiFilterContextPatch( - attributes=JsonApiAnalyticalDashboardPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextPatchDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Context Filter - api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_context_patch_document = gooddata_api_client.JsonApiFilterContextPatchDocument() # JsonApiFilterContextPatchDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Context Filter api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_context_patch_document** | [**JsonApiFilterContextPatchDocument**](JsonApiFilterContextPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_context_patch_document** | [**JsonApiFilterContextPatchDocument**](JsonApiFilterContextPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -7192,7 +5559,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7202,7 +5568,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_filter_views** -> JsonApiFilterViewOutDocument patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) +> JsonApiFilterViewOutDocument patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, filter=filter, include=include) Patch Filter view @@ -7210,12 +5576,12 @@ Patch Filter view ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7224,68 +5590,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_view_patch_document = JsonApiFilterViewPatchDocument( - data=JsonApiFilterViewPatch( - attributes=JsonApiFilterViewPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewPatchDocument | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Filter view - api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_view_patch_document = gooddata_api_client.JsonApiFilterViewPatchDocument() # JsonApiFilterViewPatchDocument | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Filter view api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_view_patch_document** | [**JsonApiFilterViewPatchDocument**](JsonApiFilterViewPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_view_patch_document** | [**JsonApiFilterViewPatchDocument**](JsonApiFilterViewPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -7300,7 +5634,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7310,7 +5643,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_metrics** -> JsonApiMetricOutDocument patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) +> JsonApiMetricOutDocument patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, filter=filter, include=include) Patch a Metric @@ -7318,12 +5651,12 @@ Patch a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7332,63 +5665,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_metric_patch_document = JsonApiMetricPatchDocument( - data=JsonApiMetricPatch( - attributes=JsonApiMetricPatchAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - ), - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="metric", - ), - ) # JsonApiMetricPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Metric - api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_metric_patch_document = gooddata_api_client.JsonApiMetricPatchDocument() # JsonApiMetricPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Metric api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_metric_patch_document** | [**JsonApiMetricPatchDocument**](JsonApiMetricPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_metric_patch_document** | [**JsonApiMetricPatchDocument**](JsonApiMetricPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -7403,7 +5709,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7413,7 +5718,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document) +> JsonApiUserDataFilterOutDocument patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, filter=filter, include=include) Patch a User Data Filter @@ -7421,12 +5726,12 @@ Patch a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7435,67 +5740,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_user_data_filter_patch_document = JsonApiUserDataFilterPatchDocument( - data=JsonApiUserDataFilterPatch( - attributes=JsonApiUserDataFilterPatchAttributes( - are_relations_valid=True, - description="description_example", - maql="maql_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", - ), - ) # JsonApiUserDataFilterPatchDocument | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a User Data Filter - api_response = api_instance.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_user_data_filter_patch_document = gooddata_api_client.JsonApiUserDataFilterPatchDocument() # JsonApiUserDataFilterPatchDocument | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a User Data Filter api_response = api_instance.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_user_data_filter_patch_document** | [**JsonApiUserDataFilterPatchDocument**](JsonApiUserDataFilterPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_user_data_filter_patch_document** | [**JsonApiUserDataFilterPatchDocument**](JsonApiUserDataFilterPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -7510,7 +5784,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7520,7 +5793,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document) +> JsonApiVisualizationObjectOutDocument patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, filter=filter, include=include) Patch a Visualization Object @@ -7528,12 +5801,12 @@ Patch a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7542,60 +5815,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_visualization_object_patch_document = JsonApiVisualizationObjectPatchDocument( - data=JsonApiVisualizationObjectPatch( - attributes=JsonApiVisualizationObjectPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", - ), - ) # JsonApiVisualizationObjectPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Visualization Object - api_response = api_instance.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_visualization_object_patch_document = gooddata_api_client.JsonApiVisualizationObjectPatchDocument() # JsonApiVisualizationObjectPatchDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Visualization Object api_response = api_instance.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_visualization_object_patch_document** | [**JsonApiVisualizationObjectPatchDocument**](JsonApiVisualizationObjectPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_visualization_object_patch_document** | [**JsonApiVisualizationObjectPatchDocument**](JsonApiVisualizationObjectPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -7610,7 +5859,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7620,7 +5868,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document) +> JsonApiWorkspaceDataFilterSettingOutDocument patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, filter=filter, include=include) Patch a Settings for Workspace Data Filter @@ -7628,12 +5876,12 @@ Patch a Settings for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7642,62 +5890,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_setting_patch_document = JsonApiWorkspaceDataFilterSettingPatchDocument( - data=JsonApiWorkspaceDataFilterSettingPatch( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", - ), - ) # JsonApiWorkspaceDataFilterSettingPatchDocument | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Settings for Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_setting_patch_document = gooddata_api_client.JsonApiWorkspaceDataFilterSettingPatchDocument() # JsonApiWorkspaceDataFilterSettingPatchDocument | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Settings for Workspace Data Filter api_response = api_instance.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_setting_patch_document** | [**JsonApiWorkspaceDataFilterSettingPatchDocument**](JsonApiWorkspaceDataFilterSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_setting_patch_document** | [**JsonApiWorkspaceDataFilterSettingPatchDocument**](JsonApiWorkspaceDataFilterSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -7712,7 +5934,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7722,7 +5943,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) +> JsonApiWorkspaceDataFilterOutDocument patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, filter=filter, include=include) Patch a Workspace Data Filter @@ -7730,12 +5951,12 @@ Patch a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7744,65 +5965,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_patch_document = JsonApiWorkspaceDataFilterPatchDocument( - data=JsonApiWorkspaceDataFilterPatch( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), - ), - ), - type="workspaceDataFilter", - ), - ) # JsonApiWorkspaceDataFilterPatchDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_patch_document = gooddata_api_client.JsonApiWorkspaceDataFilterPatchDocument() # JsonApiWorkspaceDataFilterPatchDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Workspace Data Filter api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->patch_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_patch_document** | [**JsonApiWorkspaceDataFilterPatchDocument**](JsonApiWorkspaceDataFilterPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_patch_document** | [**JsonApiWorkspaceDataFilterPatchDocument**](JsonApiWorkspaceDataFilterPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -7817,7 +6009,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7827,7 +6018,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) +> JsonApiWorkspaceSettingOutDocument patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, filter=filter) Patch a Setting for Workspace @@ -7835,12 +6026,12 @@ Patch a Setting for Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7849,50 +6040,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_setting_patch_document = JsonApiWorkspaceSettingPatchDocument( - data=JsonApiWorkspaceSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="workspaceSetting", - ), - ) # JsonApiWorkspaceSettingPatchDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Setting for Workspace - api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_setting_patch_document = gooddata_api_client.JsonApiWorkspaceSettingPatchDocument() # JsonApiWorkspaceSettingPatchDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Setting for Workspace api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, filter=filter) + print("The response of WorkspaceObjectControllerApi->patch_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_setting_patch_document** | [**JsonApiWorkspaceSettingPatchDocument**](JsonApiWorkspaceSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_setting_patch_document** | [**JsonApiWorkspaceSettingPatchDocument**](JsonApiWorkspaceSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -7907,7 +6082,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -7917,7 +6091,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document) +> JsonApiAnalyticalDashboardOutDocument update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, filter=filter, include=include) Put Dashboards @@ -7925,12 +6099,12 @@ Put Dashboards ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -7939,59 +6113,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_analytical_dashboard_in_document = JsonApiAnalyticalDashboardInDocument( - data=JsonApiAnalyticalDashboardIn( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Dashboards - api_response = api_instance.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_analytical_dashboards: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_analytical_dashboard_in_document = gooddata_api_client.JsonApiAnalyticalDashboardInDocument() # JsonApiAnalyticalDashboardInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Dashboards api_response = api_instance.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_analytical_dashboards:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_analytical_dashboards: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_analytical_dashboard_in_document** | [**JsonApiAnalyticalDashboardInDocument**](JsonApiAnalyticalDashboardInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_analytical_dashboard_in_document** | [**JsonApiAnalyticalDashboardInDocument**](JsonApiAnalyticalDashboardInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -8006,7 +6157,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8016,7 +6166,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document) +> JsonApiAttributeHierarchyOutDocument update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, filter=filter, include=include) Put an Attribute Hierarchy @@ -8024,12 +6174,12 @@ Put an Attribute Hierarchy ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8038,59 +6188,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_attribute_hierarchy_in_document = JsonApiAttributeHierarchyInDocument( - data=JsonApiAttributeHierarchyIn( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Attribute Hierarchy - api_response = api_instance.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_attribute_hierarchies: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_attribute_hierarchy_in_document = gooddata_api_client.JsonApiAttributeHierarchyInDocument() # JsonApiAttributeHierarchyInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,attributes'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put an Attribute Hierarchy api_response = api_instance.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_attribute_hierarchies:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_attribute_hierarchies: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -8105,7 +6232,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8115,7 +6241,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_automations** -> JsonApiAutomationOutDocument update_entity_automations(workspace_id, object_id, json_api_automation_in_document) +> JsonApiAutomationOutDocument update_entity_automations(workspace_id, object_id, json_api_automation_in_document, filter=filter, include=include) Put an Automation @@ -8123,12 +6249,12 @@ Put an Automation ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8137,301 +6263,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_automation_in_document = JsonApiAutomationInDocument( - data=JsonApiAutomationIn( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationInDocument | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Automation - api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_automations: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_automation_in_document = gooddata_api_client.JsonApiAutomationInDocument() # JsonApiAutomationInDocument | + filter = 'title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put an Automation api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_automations:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_automations: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -8446,7 +6307,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8456,7 +6316,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document) +> JsonApiCustomApplicationSettingOutDocument update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, filter=filter) Put a Custom Application Setting @@ -8464,12 +6324,12 @@ Put a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8478,50 +6338,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_custom_application_setting_in_document = JsonApiCustomApplicationSettingInDocument( - data=JsonApiCustomApplicationSettingIn( - attributes=JsonApiCustomApplicationSettingInAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingInDocument | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Custom Application Setting - api_response = api_instance.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_custom_application_setting_in_document = gooddata_api_client.JsonApiCustomApplicationSettingInDocument() # JsonApiCustomApplicationSettingInDocument | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Custom Application Setting api_response = api_instance.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, filter=filter) + print("The response of WorkspaceObjectControllerApi->update_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_custom_application_setting_in_document** | [**JsonApiCustomApplicationSettingInDocument**](JsonApiCustomApplicationSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_custom_application_setting_in_document** | [**JsonApiCustomApplicationSettingInDocument**](JsonApiCustomApplicationSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -8536,7 +6380,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8546,7 +6389,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) +> JsonApiDashboardPluginOutDocument update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, filter=filter, include=include) Put a Plugin @@ -8554,12 +6397,12 @@ Put a Plugin ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8568,59 +6411,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_dashboard_plugin_in_document = JsonApiDashboardPluginInDocument( - data=JsonApiDashboardPluginIn( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Plugin - api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_dashboard_plugins: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_dashboard_plugin_in_document = gooddata_api_client.JsonApiDashboardPluginInDocument() # JsonApiDashboardPluginInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Plugin api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_dashboard_plugins:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_dashboard_plugins: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_dashboard_plugin_in_document** | [**JsonApiDashboardPluginInDocument**](JsonApiDashboardPluginInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_dashboard_plugin_in_document** | [**JsonApiDashboardPluginInDocument**](JsonApiDashboardPluginInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -8635,7 +6455,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8645,7 +6464,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_export_definitions** -> JsonApiExportDefinitionOutDocument update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document) +> JsonApiExportDefinitionOutDocument update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, filter=filter, include=include) Put an Export Definition @@ -8653,12 +6472,12 @@ Put an Export Definition ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.models.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8667,67 +6486,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_export_definition_in_document = JsonApiExportDefinitionInDocument( - data=JsonApiExportDefinitionIn( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionInDocument | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Export Definition - api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_export_definitions: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_export_definition_in_document = gooddata_api_client.JsonApiExportDefinitionInDocument() # JsonApiExportDefinitionInDocument | + filter = 'title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put an Export Definition api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_export_definitions:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_export_definitions: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_export_definition_in_document** | [**JsonApiExportDefinitionInDocument**](JsonApiExportDefinitionInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_export_definition_in_document** | [**JsonApiExportDefinitionInDocument**](JsonApiExportDefinitionInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -8742,7 +6530,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8752,7 +6539,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_filter_contexts** -> JsonApiFilterContextOutDocument update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document) +> JsonApiFilterContextOutDocument update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, filter=filter, include=include) Put a Context Filter @@ -8760,12 +6547,12 @@ Put a Context Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8774,59 +6561,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_context_in_document = JsonApiFilterContextInDocument( - data=JsonApiFilterContextIn( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextInDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Context Filter - api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_filter_contexts: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_context_in_document = gooddata_api_client.JsonApiFilterContextInDocument() # JsonApiFilterContextInDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['attributes,datasets,labels'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Context Filter api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_filter_contexts:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_filter_contexts: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_context_in_document** | [**JsonApiFilterContextInDocument**](JsonApiFilterContextInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_context_in_document** | [**JsonApiFilterContextInDocument**](JsonApiFilterContextInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -8841,7 +6605,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8851,7 +6614,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_filter_views** -> JsonApiFilterViewOutDocument update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document) +> JsonApiFilterViewOutDocument update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, filter=filter, include=include) Put Filter views @@ -8859,12 +6622,12 @@ Put Filter views ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8873,68 +6636,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_view_in_document = JsonApiFilterViewInDocument( - data=JsonApiFilterViewIn( - attributes=JsonApiFilterViewInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewInDocument | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Filter views - api_response = api_instance.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_filter_views: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_filter_view_in_document = gooddata_api_client.JsonApiFilterViewInDocument() # JsonApiFilterViewInDocument | + filter = 'title==someString;description==someString;analyticalDashboard.id==321;user.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['analyticalDashboard,user'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Filter views api_response = api_instance.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_filter_views:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_filter_views: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -8949,7 +6680,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -8959,7 +6689,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_metrics** -> JsonApiMetricOutDocument update_entity_metrics(workspace_id, object_id, json_api_metric_in_document) +> JsonApiMetricOutDocument update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, filter=filter, include=include) Put a Metric @@ -8967,12 +6697,12 @@ Put a Metric ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -8981,63 +6711,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_metric_in_document = JsonApiMetricInDocument( - data=JsonApiMetricIn( - attributes=JsonApiMetricInAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - ), - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="metric", - ), - ) # JsonApiMetricInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Metric - api_response = api_instance.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_metrics: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_metric_in_document = gooddata_api_client.JsonApiMetricInDocument() # JsonApiMetricInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Metric api_response = api_instance.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_metrics:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_metrics: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_metric_in_document** | [**JsonApiMetricInDocument**](JsonApiMetricInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_metric_in_document** | [**JsonApiMetricInDocument**](JsonApiMetricInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -9052,7 +6755,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9062,7 +6764,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document) +> JsonApiUserDataFilterOutDocument update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, filter=filter, include=include) Put a User Data Filter @@ -9070,12 +6772,12 @@ Put a User Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9084,67 +6786,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_user_data_filter_in_document = JsonApiUserDataFilterInDocument( - data=JsonApiUserDataFilterIn( - attributes=JsonApiUserDataFilterInAttributes( - are_relations_valid=True, - description="description_example", - maql="maql_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", - ), - ) # JsonApiUserDataFilterInDocument | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a User Data Filter - api_response = api_instance.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_user_data_filters: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_user_data_filter_in_document = gooddata_api_client.JsonApiUserDataFilterInDocument() # JsonApiUserDataFilterInDocument | + filter = 'title==someString;description==someString;user.id==321;userGroup.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['user,userGroup,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a User Data Filter api_response = api_instance.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_user_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_user_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_user_data_filter_in_document** | [**JsonApiUserDataFilterInDocument**](JsonApiUserDataFilterInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_user_data_filter_in_document** | [**JsonApiUserDataFilterInDocument**](JsonApiUserDataFilterInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -9159,7 +6830,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9169,7 +6839,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) +> JsonApiVisualizationObjectOutDocument update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, filter=filter, include=include) Put a Visualization Object @@ -9177,12 +6847,12 @@ Put a Visualization Object ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9191,60 +6861,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_visualization_object_in_document = JsonApiVisualizationObjectInDocument( - data=JsonApiVisualizationObjectIn( - attributes=JsonApiVisualizationObjectInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", - ), - ) # JsonApiVisualizationObjectInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Visualization Object - api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_visualization_objects: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_visualization_object_in_document = gooddata_api_client.JsonApiVisualizationObjectInDocument() # JsonApiVisualizationObjectInDocument | + filter = 'title==someString;description==someString;createdBy.id==321;modifiedBy.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['createdBy,modifiedBy,facts,attributes,labels,metrics,datasets'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Visualization Object api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_visualization_objects:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_visualization_objects: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_visualization_object_in_document** | [**JsonApiVisualizationObjectInDocument**](JsonApiVisualizationObjectInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_visualization_object_in_document** | [**JsonApiVisualizationObjectInDocument**](JsonApiVisualizationObjectInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -9259,7 +6905,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9269,7 +6914,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document) +> JsonApiWorkspaceDataFilterSettingOutDocument update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, filter=filter, include=include) Put a Settings for Workspace Data Filter @@ -9277,12 +6922,12 @@ Put a Settings for Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9291,62 +6936,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( - data=JsonApiWorkspaceDataFilterSettingIn( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", - ), - ) # JsonApiWorkspaceDataFilterSettingInDocument | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Settings for Workspace Data Filter - api_response = api_instance.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_data_filter_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_setting_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterSettingInDocument() # JsonApiWorkspaceDataFilterSettingInDocument | + filter = 'title==someString;description==someString;workspaceDataFilter.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['workspaceDataFilter'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Settings for Workspace Data Filter api_response = api_instance.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_workspace_data_filter_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_data_filter_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -9361,7 +6980,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9371,7 +6989,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document) +> JsonApiWorkspaceDataFilterOutDocument update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, filter=filter, include=include) Put a Workspace Data Filter @@ -9379,12 +6997,12 @@ Put a Workspace Data Filter ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9393,65 +7011,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( - data=JsonApiWorkspaceDataFilterIn( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), - ), - ), - type="workspaceDataFilter", - ), - ) # JsonApiWorkspaceDataFilterInDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Workspace Data Filter - api_response = api_instance.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_data_filters: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_data_filter_in_document = gooddata_api_client.JsonApiWorkspaceDataFilterInDocument() # JsonApiWorkspaceDataFilterInDocument | + filter = 'title==someString;description==someString' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['filterSettings'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Workspace Data Filter api_response = api_instance.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, filter=filter, include=include) + print("The response of WorkspaceObjectControllerApi->update_entity_workspace_data_filters:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_data_filters: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -9466,7 +7055,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -9476,7 +7064,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document) +> JsonApiWorkspaceSettingOutDocument update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, filter=filter) Put a Setting for a Workspace @@ -9484,12 +7072,12 @@ Put a Setting for a Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -9498,50 +7086,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_setting_in_document = JsonApiWorkspaceSettingInDocument( - data=JsonApiWorkspaceSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="workspaceSetting", - ), - ) # JsonApiWorkspaceSettingInDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Setting for a Workspace - api_response = api_instance.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspaceObjectControllerApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_setting_in_document = gooddata_api_client.JsonApiWorkspaceSettingInDocument() # JsonApiWorkspaceSettingInDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Setting for a Workspace api_response = api_instance.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, filter=filter) + print("The response of WorkspaceObjectControllerApi->update_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_setting_in_document** | [**JsonApiWorkspaceSettingInDocument**](JsonApiWorkspaceSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_setting_in_document** | [**JsonApiWorkspaceSettingInDocument**](JsonApiWorkspaceSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -9556,7 +7128,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/WorkspacePermissionAssignment.md b/gooddata-api-client/docs/WorkspacePermissionAssignment.md index 64b35cd37..22caa81b7 100644 --- a/gooddata-api-client/docs/WorkspacePermissionAssignment.md +++ b/gooddata-api-client/docs/WorkspacePermissionAssignment.md @@ -3,13 +3,30 @@ Workspace permission assignments ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | -**hierarchy_permissions** | **[str]** | | [optional] -**permissions** | **[str]** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**hierarchy_permissions** | **List[str]** | | [optional] +**permissions** | **List[str]** | | [optional] + +## Example + +```python +from gooddata_api_client.models.workspace_permission_assignment import WorkspacePermissionAssignment + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkspacePermissionAssignment from a JSON string +workspace_permission_assignment_instance = WorkspacePermissionAssignment.from_json(json) +# print the JSON string representation of the object +print(WorkspacePermissionAssignment.to_json()) +# convert the object into a dict +workspace_permission_assignment_dict = workspace_permission_assignment_instance.to_dict() +# create an instance of WorkspacePermissionAssignment from a dict +workspace_permission_assignment_from_dict = WorkspacePermissionAssignment.from_dict(workspace_permission_assignment_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WorkspaceUser.md b/gooddata-api-client/docs/WorkspaceUser.md index 0b4abcfc3..218e005dc 100644 --- a/gooddata-api-client/docs/WorkspaceUser.md +++ b/gooddata-api-client/docs/WorkspaceUser.md @@ -3,13 +3,30 @@ List of workspace users ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | **email** | **str** | User email address | [optional] +**id** | **str** | | **name** | **str** | User name | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.workspace_user import WorkspaceUser + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkspaceUser from a JSON string +workspace_user_instance = WorkspaceUser.from_json(json) +# print the JSON string representation of the object +print(WorkspaceUser.to_json()) + +# convert the object into a dict +workspace_user_dict = workspace_user_instance.to_dict() +# create an instance of WorkspaceUser from a dict +workspace_user_from_dict = WorkspaceUser.from_dict(workspace_user_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WorkspaceUserGroup.md b/gooddata-api-client/docs/WorkspaceUserGroup.md index 3d8aa117a..3ad97957c 100644 --- a/gooddata-api-client/docs/WorkspaceUserGroup.md +++ b/gooddata-api-client/docs/WorkspaceUserGroup.md @@ -3,12 +3,29 @@ List of workspace groups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | **name** | **str** | Group name | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.workspace_user_group import WorkspaceUserGroup + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkspaceUserGroup from a JSON string +workspace_user_group_instance = WorkspaceUserGroup.from_json(json) +# print the JSON string representation of the object +print(WorkspaceUserGroup.to_json()) + +# convert the object into a dict +workspace_user_group_dict = workspace_user_group_instance.to_dict() +# create an instance of WorkspaceUserGroup from a dict +workspace_user_group_from_dict = WorkspaceUserGroup.from_dict(workspace_user_group_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WorkspaceUserGroups.md b/gooddata-api-client/docs/WorkspaceUserGroups.md index f69035027..d02b4ca44 100644 --- a/gooddata-api-client/docs/WorkspaceUserGroups.md +++ b/gooddata-api-client/docs/WorkspaceUserGroups.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_count** | **int** | Total number of groups | -**user_groups** | [**[WorkspaceUserGroup]**](WorkspaceUserGroup.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**user_groups** | [**List[WorkspaceUserGroup]**](WorkspaceUserGroup.md) | | + +## Example + +```python +from gooddata_api_client.models.workspace_user_groups import WorkspaceUserGroups + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkspaceUserGroups from a JSON string +workspace_user_groups_instance = WorkspaceUserGroups.from_json(json) +# print the JSON string representation of the object +print(WorkspaceUserGroups.to_json()) +# convert the object into a dict +workspace_user_groups_dict = workspace_user_groups_instance.to_dict() +# create an instance of WorkspaceUserGroups from a dict +workspace_user_groups_from_dict = WorkspaceUserGroups.from_dict(workspace_user_groups_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WorkspaceUsers.md b/gooddata-api-client/docs/WorkspaceUsers.md index 606e6ea03..ddf6cc7c0 100644 --- a/gooddata-api-client/docs/WorkspaceUsers.md +++ b/gooddata-api-client/docs/WorkspaceUsers.md @@ -2,12 +2,29 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_count** | **int** | The total number of users is based on applied filters. | -**users** | [**[WorkspaceUser]**](WorkspaceUser.md) | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +**users** | [**List[WorkspaceUser]**](WorkspaceUser.md) | | + +## Example + +```python +from gooddata_api_client.models.workspace_users import WorkspaceUsers + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkspaceUsers from a JSON string +workspace_users_instance = WorkspaceUsers.from_json(json) +# print the JSON string representation of the object +print(WorkspaceUsers.to_json()) +# convert the object into a dict +workspace_users_dict = workspace_users_instance.to_dict() +# create an instance of WorkspaceUsers from a dict +workspace_users_from_dict = WorkspaceUsers.from_dict(workspace_users_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md index 3768d4ff0..8b67e8ebc 100644 --- a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md @@ -11,7 +11,7 @@ Method | HTTP request | Description # **get_workspace_layout** -> DeclarativeWorkspaceModel get_workspace_layout(workspace_id) +> DeclarativeWorkspaceModel get_workspace_layout(workspace_id, exclude=exclude) Get workspace layout @@ -21,11 +21,11 @@ Retrieve current model of the workspace in declarative form. ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_declarative_apis_api -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -34,39 +34,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_declarative_apis_api.WorkspacesDeclarativeAPIsApi(api_client) - workspace_id = "workspaceId_example" # str | - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) - - # example passing only required values which don't have defaults set - try: - # Get workspace layout - api_response = api_instance.get_workspace_layout(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesDeclarativeAPIsApi->get_workspace_layout: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesDeclarativeAPIsApi(api_client) + workspace_id = 'workspace_id_example' # str | + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get workspace layout api_response = api_instance.get_workspace_layout(workspace_id, exclude=exclude) + print("The response of WorkspacesDeclarativeAPIsApi->get_workspace_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesDeclarativeAPIsApi->get_workspace_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **exclude** | **[str]**| | [optional] + **workspace_id** | **str**| | + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type @@ -81,7 +72,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -91,7 +81,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_workspaces_layout** -> DeclarativeWorkspaces get_workspaces_layout() +> DeclarativeWorkspaces get_workspaces_layout(exclude=exclude) Get all workspaces layout @@ -101,11 +91,11 @@ Gets complete layout of workspaces, their hierarchy, models. ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_declarative_apis_api -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -114,29 +104,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_declarative_apis_api.WorkspacesDeclarativeAPIsApi(api_client) - exclude = [ - "ACTIVITY_INFO", - ] # [str] | (optional) + api_instance = gooddata_api_client.WorkspacesDeclarativeAPIsApi(api_client) + exclude = ['exclude_example'] # List[str] | (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all workspaces layout api_response = api_instance.get_workspaces_layout(exclude=exclude) + print("The response of WorkspacesDeclarativeAPIsApi->get_workspaces_layout:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesDeclarativeAPIsApi->get_workspaces_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **exclude** | **[str]**| | [optional] + **exclude** | [**List[str]**](str.md)| | [optional] ### Return type @@ -151,7 +140,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -171,11 +159,11 @@ Set complete layout of workspace, like model, authorization, etc. ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_declarative_apis_api -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -184,317 +172,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_declarative_apis_api.WorkspacesDeclarativeAPIsApi(api_client) - workspace_id = "workspaceId_example" # str | - declarative_workspace_model = DeclarativeWorkspaceModel( - analytics=DeclarativeAnalyticsLayer( - analytical_dashboard_extensions=[ - DeclarativeAnalyticalDashboardExtension( - id="revenues-analysis", - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - ), - ], - analytical_dashboards=[ - DeclarativeAnalyticalDashboard( - content=JsonNode(), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Period to period comparison of revenues in main sectors.", - id="revenues-analysis", - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - tags=["Revenues"], - title="Revenues analysis", - ), - ], - attribute_hierarchies=[ - DeclarativeAttributeHierarchy( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - dashboard_plugins=[ - DeclarativeDashboardPlugin( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Three dimensional view of data.", - id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="3D map renderer", - ), - ], - export_definitions=[ - DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="export-definition-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), - tags=["Revenues"], - title="My regular export", - ), - ], - filter_contexts=[ - DeclarativeFilterContext( - content=JsonNode(), - description="Filter Context for Sales team.", - id="filter-sales", - tags=["Revenues"], - title="Filter Context for Sales team", - ), - ], - metrics=[ - DeclarativeMetric( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Sales for all the data available.", - id="total-sales", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Total sales", - ), - ], - visualization_objects=[ - DeclarativeVisualizationObject( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="visualization-1", - is_hidden=False, - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - ), - ldm=DeclarativeLdm( - dataset_extensions=[ - DeclarativeDatasetExtension( - id="customers", - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - datasets=[ - DeclarativeDataset( - aggregated_facts=[ - DeclarativeAggregatedFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - source_column="customer_order_count", - source_column_data_type="NUMERIC", - source_fact_reference=DeclarativeSourceFactReference( - operation="SUM", - reference=FactIdentifier( - id="fact_id", - type="fact", - ), - ), - tags=["Customers"], - ), - ], - attributes=[ - DeclarativeAttribute( - default_view=LabelIdentifier( - id="label_id", - type="label", - ), - description="Customer name including first and last name.", - id="attr.customers.customer_name", - is_hidden=False, - labels=[ - DeclarativeLabel( - description="Customer name", - id="label.customer_name", - is_hidden=False, - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer name", - value_type="TEXT", - ), - ], - sort_column="customer_name", - sort_direction="ASC" | "DESC", - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer Name", - ), - ], - data_source_table_id=DataSourceTableIdentifier( - data_source_id="my-postgres", - id="customers", - path=["table_schema","table_name"], - type="dataSource", - ), - description="The customers of ours.", - facts=[ - DeclarativeFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - is_hidden=False, - source_column="customer_order_count", - source_column_data_type="NUMERIC", - tags=["Customers"], - title="Customer order count", - ), - ], - grain=[ - GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ], - id="customers", - precedence=0, - references=[ - DeclarativeReference( - identifier=ReferenceIdentifier( - id="customers", - type="DATASET", - ), - multivalue=False, - source_column_data_types=[ - "INT", - ], - source_columns=["customer_id"], - sources=[ - DeclarativeReferenceSource( - column="customer_id", - data_type="STRING", - target=GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ), - ], - ), - ], - sql=DeclarativeDatasetSql( - data_source_id="my-postgres", - statement="SELECT * FROM some_table", - ), - tags=["Customers"], - title="Customers", - workspace_data_filter_columns=[ - DeclarativeWorkspaceDataFilterColumn( - data_type="INT", - name="customer_id", - ), - ], - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - date_instances=[ - DeclarativeDateDataset( - description="A customer order date", - granularities=[ - "MINUTE", - ], - granularities_formatting=GranularitiesFormatting( - title_base="title_base_example", - title_pattern="%titleBase - %granularityTitle", - ), - id="date", - tags=["Customer dates"], - title="Date", - ), - ], - ), - ) # DeclarativeWorkspaceModel | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.WorkspacesDeclarativeAPIsApi(api_client) + workspace_id = 'workspace_id_example' # str | + declarative_workspace_model = gooddata_api_client.DeclarativeWorkspaceModel() # DeclarativeWorkspaceModel | + try: # Set workspace layout api_instance.put_workspace_layout(workspace_id, declarative_workspace_model) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesDeclarativeAPIsApi->put_workspace_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **declarative_workspace_model** | [**DeclarativeWorkspaceModel**](DeclarativeWorkspaceModel.md)| | + **workspace_id** | **str**| | + **declarative_workspace_model** | [**DeclarativeWorkspaceModel**](DeclarativeWorkspaceModel.md)| | ### Return type @@ -509,7 +208,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -529,11 +227,11 @@ Sets complete layout of workspaces, their hierarchy, models. ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_declarative_apis_api -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -542,694 +240,26 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_declarative_apis_api.WorkspacesDeclarativeAPIsApi(api_client) - declarative_workspaces = DeclarativeWorkspaces( - workspace_data_filters=[ - DeclarativeWorkspaceDataFilter( - column_name="country_id", - description="ID of country", - id="country_id", - title="Country ID", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - workspace_data_filter_settings=[ - DeclarativeWorkspaceDataFilterSetting( - description="ID of country setting", - filter_values=["US"], - id="country_id_setting", - title="Country ID setting", - workspace=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - ), - ], - ), - ], - workspaces=[ - DeclarativeWorkspace( - automations=[ - DeclarativeAutomation( - alert=AutomationAlert( - condition=AutomationAlertCondition(None), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - trigger="ALWAYS", - ), - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - dashboard_tabular_exports=[ - AutomationDashboardTabularExport( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={ - "key": "key_example", - }, - evaluation_mode="PER_RECIPIENT", - export_definitions=[ - DeclarativeExportDefinitionIdentifier( - id="export123", - type="exportDefinition", - ), - ], - external_recipients=[ - AutomationExternalRecipient( - email="email_example", - ), - ], - id="/6bUUGjjNSwg0_bs", - image_exports=[ - AutomationImageExport( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=AutomationMetadata( - visible_filters=[ - VisibleFilter( - is_all_time_date_filter=False, - local_identifier="local_identifier_example", - title="title_example", - ), - ], - widget="widget_example", - ), - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - notification_channel=DeclarativeNotificationChannelIdentifier( - id="webhook123", - type="notificationChannel", - ), - raw_exports=[ - AutomationRawExport( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - recipients=[ - DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ], - schedule=AutomationSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - AutomationSlidesExport( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - AutomationTabularExport( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - visual_exports=[ - AutomationVisualExport( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - ], - cache_extra_limit=1, - custom_application_settings=[ - DeclarativeCustomApplicationSetting( - application_name="Modeler", - content=JsonNode(), - id="modeler.demo", - ), - ], - data_source=WorkspaceDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - filter_views=[ - DeclarativeFilterView( - analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( - id="dashboard123", - type="analyticalDashboard", - ), - content=JsonNode(), - description="description_example", - id="filterView-1", - is_default=True, - tags=[ - "["Revenue","Sales"]", - ], - title="title_example", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - ), - ], - hierarchy_permissions=[ - DeclarativeWorkspaceHierarchyPermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - id="alpha.sales", - model=DeclarativeWorkspaceModel( - analytics=DeclarativeAnalyticsLayer( - analytical_dashboard_extensions=[ - DeclarativeAnalyticalDashboardExtension( - id="revenues-analysis", - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - ), - ], - analytical_dashboards=[ - DeclarativeAnalyticalDashboard( - content=JsonNode(), - created_at="2023-07-20 12:30", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Period to period comparison of revenues in main sectors.", - id="revenues-analysis", - modified_at="2023-07-20 12:30", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - permissions=[ - DeclarativeAnalyticalDashboardPermissionsInner(None), - ], - tags=["Revenues"], - title="Revenues analysis", - ), - ], - attribute_hierarchies=[ - DeclarativeAttributeHierarchy( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - dashboard_plugins=[ - DeclarativeDashboardPlugin( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Three dimensional view of data.", - id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="3D map renderer", - ), - ], - export_definitions=[ - DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="export-definition-1", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), - tags=["Revenues"], - title="My regular export", - ), - ], - filter_contexts=[ - DeclarativeFilterContext( - content=JsonNode(), - description="Filter Context for Sales team.", - id="filter-sales", - tags=["Revenues"], - title="Filter Context for Sales team", - ), - ], - metrics=[ - DeclarativeMetric( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Sales for all the data available.", - id="total-sales", - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Total sales", - ), - ], - visualization_objects=[ - DeclarativeVisualizationObject( - content=JsonNode(), - created_at="["2023-07-20 12:30"]", - created_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - description="Simple number for total goods in current production.", - id="visualization-1", - is_hidden=False, - modified_at="["2023-07-20 12:30"]", - modified_by=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - tags=["Revenues"], - title="Count of goods", - ), - ], - ), - ldm=DeclarativeLdm( - dataset_extensions=[ - DeclarativeDatasetExtension( - id="customers", - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - datasets=[ - DeclarativeDataset( - aggregated_facts=[ - DeclarativeAggregatedFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - source_column="customer_order_count", - source_column_data_type="NUMERIC", - source_fact_reference=DeclarativeSourceFactReference( - operation="SUM", - reference=FactIdentifier( - id="fact_id", - type="fact", - ), - ), - tags=["Customers"], - ), - ], - attributes=[ - DeclarativeAttribute( - default_view=LabelIdentifier( - id="label_id", - type="label", - ), - description="Customer name including first and last name.", - id="attr.customers.customer_name", - is_hidden=False, - labels=[ - DeclarativeLabel( - description="Customer name", - id="label.customer_name", - is_hidden=False, - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer name", - value_type="TEXT", - ), - ], - sort_column="customer_name", - sort_direction="ASC" | "DESC", - source_column="customer_name", - source_column_data_type="STRING", - tags=["Customers"], - title="Customer Name", - ), - ], - data_source_table_id=DataSourceTableIdentifier( - data_source_id="my-postgres", - id="customers", - path=["table_schema","table_name"], - type="dataSource", - ), - description="The customers of ours.", - facts=[ - DeclarativeFact( - description="A number of orders created by the customer - including all orders, even the non-delivered ones.", - id="fact.customer_order_count", - is_hidden=False, - source_column="customer_order_count", - source_column_data_type="NUMERIC", - tags=["Customers"], - title="Customer order count", - ), - ], - grain=[ - GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ], - id="customers", - precedence=0, - references=[ - DeclarativeReference( - identifier=ReferenceIdentifier( - id="customers", - type="DATASET", - ), - multivalue=False, - source_column_data_types=[ - "INT", - ], - source_columns=["customer_id"], - sources=[ - DeclarativeReferenceSource( - column="customer_id", - data_type="STRING", - target=GrainIdentifier( - id="attr.customers.customer_name", - type="ATTRIBUTE", - ), - ), - ], - ), - ], - sql=DeclarativeDatasetSql( - data_source_id="my-postgres", - statement="SELECT * FROM some_table", - ), - tags=["Customers"], - title="Customers", - workspace_data_filter_columns=[ - DeclarativeWorkspaceDataFilterColumn( - data_type="INT", - name="customer_id", - ), - ], - workspace_data_filter_references=[ - DeclarativeWorkspaceDataFilterReferences( - filter_column="filter_id", - filter_column_data_type="INT", - filter_id=DatasetWorkspaceDataFilterIdentifier( - id="country_id", - type="workspaceDataFilter", - ), - ), - ], - ), - ], - date_instances=[ - DeclarativeDateDataset( - description="A customer order date", - granularities=[ - "MINUTE", - ], - granularities_formatting=GranularitiesFormatting( - title_base="title_base_example", - title_pattern="%titleBase - %granularityTitle", - ), - id="date", - tags=["Customer dates"], - title="Date", - ), - ], - ), - ), - name="Alpha Sales", - parent=WorkspaceIdentifier( - id="alpha.sales", - type="workspace", - ), - permissions=[ - DeclarativeSingleWorkspacePermission( - assignee=AssigneeIdentifier( - id="id_example", - type="user", - ), - name="MANAGE", - ), - ], - prefix="/6bUUGjjNSwg0_bs", - settings=[ - DeclarativeSetting( - content=JsonNode(), - id="/6bUUGjjNSwg0_bs", - type="TIMEZONE", - ), - ], - user_data_filters=[ - DeclarativeUserDataFilter( - description="ID of country setting", - id="country_id_setting", - maql="{label/country} = "USA" AND {label/date.year} = THIS(YEAR)", - tags=["Revenues"], - title="Country ID setting", - user=DeclarativeUserIdentifier( - id="employee123", - type="user", - ), - user_group=DeclarativeUserGroupIdentifier( - id="group.admins", - type="userGroup", - ), - ), - ], - ), - ], - ) # DeclarativeWorkspaces | - - # example passing only required values which don't have defaults set + api_instance = gooddata_api_client.WorkspacesDeclarativeAPIsApi(api_client) + declarative_workspaces = gooddata_api_client.DeclarativeWorkspaces() # DeclarativeWorkspaces | + try: # Set all workspaces layout api_instance.set_workspaces_layout(declarative_workspaces) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesDeclarativeAPIsApi->set_workspaces_layout: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **declarative_workspaces** | [**DeclarativeWorkspaces**](DeclarativeWorkspaces.md)| | + **declarative_workspaces** | [**DeclarativeWorkspaces**](DeclarativeWorkspaces.md)| | ### Return type @@ -1244,7 +274,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/WorkspacesEntityAPIsApi.md b/gooddata-api-client/docs/WorkspacesEntityAPIsApi.md index 349658e87..3e054df7f 100644 --- a/gooddata-api-client/docs/WorkspacesEntityAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesEntityAPIsApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **create_entity_workspaces** -> JsonApiWorkspaceOutDocument create_entity_workspaces(json_api_workspace_in_document) +> JsonApiWorkspaceOutDocument create_entity_workspaces(json_api_workspace_in_document, include=include, meta_include=meta_include) Post Workspace entities @@ -23,12 +23,12 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_entity_apis_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -37,69 +37,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_entity_apis_api.WorkspacesEntityAPIsApi(api_client) - json_api_workspace_in_document = JsonApiWorkspaceInDocument( - data=JsonApiWorkspaceIn( - attributes=JsonApiWorkspaceInAttributes( - cache_extra_limit=1, - data_source=JsonApiWorkspaceInAttributesDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - name="name_example", - prefix="/6bUUGjjNSwg0_bs", - ), - id="id1", - relationships=JsonApiWorkspaceInRelationships( - parent=JsonApiWorkspaceAutomationOutRelationshipsWorkspace( - data=JsonApiWorkspaceToOneLinkage(None), - ), - ), - type="workspace", - ), - ) # JsonApiWorkspaceInDocument | - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Workspace entities - api_response = api_instance.create_entity_workspaces(json_api_workspace_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesEntityAPIsApi->create_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesEntityAPIsApi(api_client) + json_api_workspace_in_document = gooddata_api_client.JsonApiWorkspaceInDocument() # JsonApiWorkspaceInDocument | + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=config,permissions,hierarchy,dataModelDatasets,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Workspace entities api_response = api_instance.create_entity_workspaces(json_api_workspace_in_document, include=include, meta_include=meta_include) + print("The response of WorkspacesEntityAPIsApi->create_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesEntityAPIsApi->create_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -114,7 +77,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -124,7 +86,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspaces** -> delete_entity_workspaces(id) +> delete_entity_workspaces(id, filter=filter) Delete Workspace entity @@ -134,10 +96,10 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_entity_apis_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -146,35 +108,28 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_entity_apis_api.WorkspacesEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.WorkspacesEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete Workspace entity - api_instance.delete_entity_workspaces(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesEntityAPIsApi->delete_entity_workspaces: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete Workspace entity api_instance.delete_entity_workspaces(id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesEntityAPIsApi->delete_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -189,7 +144,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -199,7 +153,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspaces** -> JsonApiWorkspaceOutList get_all_entities_workspaces() +> JsonApiWorkspaceOutList get_all_entities_workspaces(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) Get Workspace entities @@ -209,11 +163,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_entity_apis_api -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -222,43 +176,38 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_entity_apis_api.WorkspacesEntityAPIsApi(api_client) - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values + api_instance = gooddata_api_client.WorkspacesEntityAPIsApi(api_client) + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = ['metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all'] # List[str] | Include Meta objects. (optional) + try: # Get Workspace entities api_response = api_instance.get_all_entities_workspaces(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + print("The response of WorkspacesEntityAPIsApi->get_all_entities_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesEntityAPIsApi->get_all_entities_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -273,7 +222,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -283,7 +231,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspaces** -> JsonApiWorkspaceOutDocument get_entity_workspaces(id) +> JsonApiWorkspaceOutDocument get_entity_workspaces(id, filter=filter, include=include, meta_include=meta_include) Get Workspace entity @@ -293,11 +241,11 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_entity_apis_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -306,45 +254,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_entity_apis_api.WorkspacesEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Workspace entity - api_response = api_instance.get_entity_workspaces(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesEntityAPIsApi->get_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesEntityAPIsApi(api_client) + id = 'id_example' # str | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = ['metaInclude=config,permissions,hierarchy,dataModelDatasets,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get Workspace entity api_response = api_instance.get_entity_workspaces(id, filter=filter, include=include, meta_include=meta_include) + print("The response of WorkspacesEntityAPIsApi->get_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesEntityAPIsApi->get_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -359,7 +296,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -369,7 +305,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspaces** -> JsonApiWorkspaceOutDocument patch_entity_workspaces(id, json_api_workspace_patch_document) +> JsonApiWorkspaceOutDocument patch_entity_workspaces(id, json_api_workspace_patch_document, filter=filter, include=include) Patch Workspace entity @@ -379,12 +315,12 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_entity_apis_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -393,69 +329,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_entity_apis_api.WorkspacesEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_workspace_patch_document = JsonApiWorkspacePatchDocument( - data=JsonApiWorkspacePatch( - attributes=JsonApiWorkspaceInAttributes( - cache_extra_limit=1, - data_source=JsonApiWorkspaceInAttributesDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - name="name_example", - prefix="/6bUUGjjNSwg0_bs", - ), - id="id1", - relationships=JsonApiWorkspaceInRelationships( - parent=JsonApiWorkspaceAutomationOutRelationshipsWorkspace( - data=JsonApiWorkspaceToOneLinkage(None), - ), - ), - type="workspace", - ), - ) # JsonApiWorkspacePatchDocument | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Workspace entity - api_response = api_instance.patch_entity_workspaces(id, json_api_workspace_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesEntityAPIsApi->patch_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_workspace_patch_document = gooddata_api_client.JsonApiWorkspacePatchDocument() # JsonApiWorkspacePatchDocument | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch Workspace entity api_response = api_instance.patch_entity_workspaces(id, json_api_workspace_patch_document, filter=filter, include=include) + print("The response of WorkspacesEntityAPIsApi->patch_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesEntityAPIsApi->patch_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_workspace_patch_document** | [**JsonApiWorkspacePatchDocument**](JsonApiWorkspacePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_workspace_patch_document** | [**JsonApiWorkspacePatchDocument**](JsonApiWorkspacePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -470,7 +371,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -480,7 +380,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspaces** -> JsonApiWorkspaceOutDocument update_entity_workspaces(id, json_api_workspace_in_document) +> JsonApiWorkspaceOutDocument update_entity_workspaces(id, json_api_workspace_in_document, filter=filter, include=include) Put Workspace entity @@ -490,12 +390,12 @@ Space of the shared interest ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_entity_apis_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -504,69 +404,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_entity_apis_api.WorkspacesEntityAPIsApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_workspace_in_document = JsonApiWorkspaceInDocument( - data=JsonApiWorkspaceIn( - attributes=JsonApiWorkspaceInAttributes( - cache_extra_limit=1, - data_source=JsonApiWorkspaceInAttributesDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], - ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], - name="name_example", - prefix="/6bUUGjjNSwg0_bs", - ), - id="id1", - relationships=JsonApiWorkspaceInRelationships( - parent=JsonApiWorkspaceAutomationOutRelationshipsWorkspace( - data=JsonApiWorkspaceToOneLinkage(None), - ), - ), - type="workspace", - ), - ) # JsonApiWorkspaceInDocument | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Workspace entity - api_response = api_instance.update_entity_workspaces(id, json_api_workspace_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesEntityAPIsApi->update_entity_workspaces: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesEntityAPIsApi(api_client) + id = 'id_example' # str | + json_api_workspace_in_document = gooddata_api_client.JsonApiWorkspaceInDocument() # JsonApiWorkspaceInDocument | + filter = 'name==someString;earlyAccess==someString;parent.id==321' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = ['parent'] # List[str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put Workspace entity api_response = api_instance.update_entity_workspaces(id, json_api_workspace_in_document, filter=filter, include=include) + print("The response of WorkspacesEntityAPIsApi->update_entity_workspaces:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesEntityAPIsApi->update_entity_workspaces: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **id** | **str**| | + **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | [**List[str]**](str.md)| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type @@ -581,7 +446,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/WorkspacesSettingsApi.md b/gooddata-api-client/docs/WorkspacesSettingsApi.md index 2443000a6..e2d556be3 100644 --- a/gooddata-api-client/docs/WorkspacesSettingsApi.md +++ b/gooddata-api-client/docs/WorkspacesSettingsApi.md @@ -21,7 +21,7 @@ Method | HTTP request | Description # **create_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document) +> JsonApiCustomApplicationSettingOutDocument create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, meta_include=meta_include) Post Custom Application Settings @@ -29,12 +29,12 @@ Post Custom Application Settings ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -43,50 +43,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_custom_application_setting_post_optional_id_document = JsonApiCustomApplicationSettingPostOptionalIdDocument( - data=JsonApiCustomApplicationSettingPostOptionalId( - attributes=JsonApiCustomApplicationSettingInAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingPostOptionalIdDocument | - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Custom Application Settings - api_response = api_instance.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->create_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_custom_application_setting_post_optional_id_document = gooddata_api_client.JsonApiCustomApplicationSettingPostOptionalIdDocument() # JsonApiCustomApplicationSettingPostOptionalIdDocument | + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Custom Application Settings api_response = api_instance.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, meta_include=meta_include) + print("The response of WorkspacesSettingsApi->create_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->create_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_custom_application_setting_post_optional_id_document** | [**JsonApiCustomApplicationSettingPostOptionalIdDocument**](JsonApiCustomApplicationSettingPostOptionalIdDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_custom_application_setting_post_optional_id_document** | [**JsonApiCustomApplicationSettingPostOptionalIdDocument**](JsonApiCustomApplicationSettingPostOptionalIdDocument.md)| | + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -101,7 +83,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -111,7 +92,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) +> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, meta_include=meta_include) Post Settings for Workspaces @@ -119,12 +100,12 @@ Post Settings for Workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -133,50 +114,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_setting_post_optional_id_document = JsonApiWorkspaceSettingPostOptionalIdDocument( - data=JsonApiWorkspaceSettingPostOptionalId( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="workspaceSetting", - ), - ) # JsonApiWorkspaceSettingPostOptionalIdDocument | - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Settings for Workspaces - api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->create_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + json_api_workspace_setting_post_optional_id_document = gooddata_api_client.JsonApiWorkspaceSettingPostOptionalIdDocument() # JsonApiWorkspaceSettingPostOptionalIdDocument | + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Post Settings for Workspaces api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, meta_include=meta_include) + print("The response of WorkspacesSettingsApi->create_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->create_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_setting_post_optional_id_document** | [**JsonApiWorkspaceSettingPostOptionalIdDocument**](JsonApiWorkspaceSettingPostOptionalIdDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **json_api_workspace_setting_post_optional_id_document** | [**JsonApiWorkspaceSettingPostOptionalIdDocument**](JsonApiWorkspaceSettingPostOptionalIdDocument.md)| | + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -191,7 +154,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -201,7 +163,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_custom_application_settings** -> delete_entity_custom_application_settings(workspace_id, object_id) +> delete_entity_custom_application_settings(workspace_id, object_id, filter=filter) Delete a Custom Application Setting @@ -209,10 +171,10 @@ Delete a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -221,37 +183,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - try: - # Delete a Custom Application Setting - api_instance.delete_entity_custom_application_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->delete_entity_custom_application_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Custom Application Setting api_instance.delete_entity_custom_application_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->delete_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -266,7 +221,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -276,7 +230,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_entity_workspace_settings** -> delete_entity_workspace_settings(workspace_id, object_id) +> delete_entity_workspace_settings(workspace_id, object_id, filter=filter) Delete a Setting for Workspace @@ -284,10 +238,10 @@ Delete a Setting for Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -296,37 +250,30 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Setting for Workspace - api_instance.delete_entity_workspace_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->delete_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Delete a Setting for Workspace api_instance.delete_entity_workspace_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->delete_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -341,7 +288,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined - ### HTTP response details | Status code | Description | Response headers | @@ -351,7 +297,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_custom_application_settings** -> JsonApiCustomApplicationSettingOutList get_all_entities_custom_application_settings(workspace_id) +> JsonApiCustomApplicationSettingOutList get_all_entities_custom_application_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Custom Application Settings @@ -359,11 +305,11 @@ Get all Custom Application Settings ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -372,53 +318,42 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Custom Application Settings - api_response = api_instance.get_all_entities_custom_application_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->get_all_entities_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Custom Application Settings api_response = api_instance.get_all_entities_custom_application_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspacesSettingsApi->get_all_entities_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->get_all_entities_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -433,7 +368,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -443,7 +377,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_entities_workspace_settings** -> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id) +> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get all Setting for Workspaces @@ -451,11 +385,11 @@ Get all Setting for Workspaces ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -464,53 +398,42 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Setting for Workspaces - api_response = api_instance.get_all_entities_workspace_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->get_all_entities_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + origin = ALL # str | (optional) (default to ALL) + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) (default to 0) + size = 20 # int | The size of the page to be returned (optional) (default to 20) + sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,page,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get all Setting for Workspaces api_response = api_instance.get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspacesSettingsApi->get_all_entities_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->get_all_entities_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **origin** | **str**| | [optional] [default to ALL] + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] [default to 0] + **size** | **int**| The size of the page to be returned | [optional] [default to 20] + **sort** | [**List[str]**](str.md)| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -525,7 +448,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -535,7 +457,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument get_entity_custom_application_settings(workspace_id, object_id) +> JsonApiCustomApplicationSettingOutDocument get_entity_custom_application_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Custom Application Setting @@ -543,11 +465,11 @@ Get a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -556,45 +478,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Custom Application Setting - api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->get_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Custom Application Setting api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspacesSettingsApi->get_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->get_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -609,7 +522,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -619,7 +531,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id) +> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) Get a Setting for Workspace @@ -627,11 +539,11 @@ Get a Setting for Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -640,45 +552,36 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Setting for Workspace - api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->get_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) (default to False) + meta_include = ['metaInclude=origin,all'] # List[str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Get a Setting for Workspace api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + print("The response of WorkspacesSettingsApi->get_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->get_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] [default to False] + **meta_include** | [**List[str]**](str.md)| Include Meta objects. | [optional] ### Return type @@ -693,7 +596,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -703,7 +605,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) +> JsonApiCustomApplicationSettingOutDocument patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, filter=filter) Patch a Custom Application Setting @@ -711,12 +613,12 @@ Patch a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -725,50 +627,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_custom_application_setting_patch_document = JsonApiCustomApplicationSettingPatchDocument( - data=JsonApiCustomApplicationSettingPatch( - attributes=JsonApiCustomApplicationSettingPatchAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingPatchDocument | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Custom Application Setting - api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->patch_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_custom_application_setting_patch_document = gooddata_api_client.JsonApiCustomApplicationSettingPatchDocument() # JsonApiCustomApplicationSettingPatchDocument | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Custom Application Setting api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, filter=filter) + print("The response of WorkspacesSettingsApi->patch_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->patch_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_custom_application_setting_patch_document** | [**JsonApiCustomApplicationSettingPatchDocument**](JsonApiCustomApplicationSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_custom_application_setting_patch_document** | [**JsonApiCustomApplicationSettingPatchDocument**](JsonApiCustomApplicationSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -783,7 +669,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -793,7 +678,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) +> JsonApiWorkspaceSettingOutDocument patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, filter=filter) Patch a Setting for Workspace @@ -801,12 +686,12 @@ Patch a Setting for Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -815,50 +700,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_setting_patch_document = JsonApiWorkspaceSettingPatchDocument( - data=JsonApiWorkspaceSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="workspaceSetting", - ), - ) # JsonApiWorkspaceSettingPatchDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Setting for Workspace - api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->patch_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_setting_patch_document = gooddata_api_client.JsonApiWorkspaceSettingPatchDocument() # JsonApiWorkspaceSettingPatchDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Patch a Setting for Workspace api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, filter=filter) + print("The response of WorkspacesSettingsApi->patch_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->patch_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_setting_patch_document** | [**JsonApiWorkspaceSettingPatchDocument**](JsonApiWorkspaceSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_setting_patch_document** | [**JsonApiWorkspaceSettingPatchDocument**](JsonApiWorkspaceSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -873,7 +742,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -883,7 +751,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document) +> JsonApiCustomApplicationSettingOutDocument update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, filter=filter) Put a Custom Application Setting @@ -891,12 +759,12 @@ Put a Custom Application Setting ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -905,50 +773,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_custom_application_setting_in_document = JsonApiCustomApplicationSettingInDocument( - data=JsonApiCustomApplicationSettingIn( - attributes=JsonApiCustomApplicationSettingInAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingInDocument | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Custom Application Setting - api_response = api_instance.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->update_entity_custom_application_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_custom_application_setting_in_document = gooddata_api_client.JsonApiCustomApplicationSettingInDocument() # JsonApiCustomApplicationSettingInDocument | + filter = 'applicationName==someString;content==JsonNodeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Custom Application Setting api_response = api_instance.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, filter=filter) + print("The response of WorkspacesSettingsApi->update_entity_custom_application_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->update_entity_custom_application_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_custom_application_setting_in_document** | [**JsonApiCustomApplicationSettingInDocument**](JsonApiCustomApplicationSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_custom_application_setting_in_document** | [**JsonApiCustomApplicationSettingInDocument**](JsonApiCustomApplicationSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -963,7 +815,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -973,7 +824,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document) +> JsonApiWorkspaceSettingOutDocument update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, filter=filter) Put a Setting for a Workspace @@ -981,12 +832,12 @@ Put a Setting for a Workspace ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -995,50 +846,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_setting_in_document = JsonApiWorkspaceSettingInDocument( - data=JsonApiWorkspaceSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="workspaceSetting", - ), - ) # JsonApiWorkspaceSettingInDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Setting for a Workspace - api_response = api_instance.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspacesSettingsApi->update_entity_workspace_settings: %s\n" % e) + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + object_id = 'object_id_example' # str | + json_api_workspace_setting_in_document = gooddata_api_client.JsonApiWorkspaceSettingInDocument() # JsonApiWorkspaceSettingInDocument | + filter = 'content==JsonNodeValue;type==SettingTypeValue' # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - # example passing only required values which don't have defaults set - # and optional values try: # Put a Setting for a Workspace api_response = api_instance.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, filter=filter) + print("The response of WorkspacesSettingsApi->update_entity_workspace_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->update_entity_workspace_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_setting_in_document** | [**JsonApiWorkspaceSettingInDocument**](JsonApiWorkspaceSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_setting_in_document** | [**JsonApiWorkspaceSettingInDocument**](JsonApiWorkspaceSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -1053,7 +888,6 @@ No authorization required - **Content-Type**: application/vnd.gooddata.api+json - **Accept**: application/vnd.gooddata.api+json - ### HTTP response details | Status code | Description | Response headers | @@ -1063,7 +897,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **workspace_resolve_all_settings** -> [ResolvedSetting] workspace_resolve_all_settings(workspace_id) +> List[ResolvedSetting] workspace_resolve_all_settings(workspace_id) Values for all settings. @@ -1073,11 +907,11 @@ Resolves values for all settings in a workspace by current user, workspace, orga ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1086,30 +920,32 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | - # example passing only required values which don't have defaults set try: # Values for all settings. api_response = api_instance.workspace_resolve_all_settings(workspace_id) + print("The response of WorkspacesSettingsApi->workspace_resolve_all_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->workspace_resolve_all_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **workspace_id** | **str**| | ### Return type -[**[ResolvedSetting]**](ResolvedSetting.md) +[**List[ResolvedSetting]**](ResolvedSetting.md) ### Authorization @@ -1120,7 +956,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | @@ -1130,7 +965,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **workspace_resolve_settings** -> [ResolvedSetting] workspace_resolve_settings(workspace_id, resolve_settings_request) +> List[ResolvedSetting] workspace_resolve_settings(workspace_id, resolve_settings_request) Values for selected settings. @@ -1140,12 +975,12 @@ Resolves value for selected settings in a workspace by current user, workspace, ```python -import time import gooddata_api_client -from gooddata_api_client.api import workspaces_settings_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.rest import ApiException from pprint import pprint + # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = gooddata_api_client.Configuration( @@ -1154,34 +989,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: +with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = workspaces_settings_api.WorkspacesSettingsApi(api_client) - workspace_id = "workspaceId_example" # str | - resolve_settings_request = ResolveSettingsRequest( - settings=["timezone"], - ) # ResolveSettingsRequest | + api_instance = gooddata_api_client.WorkspacesSettingsApi(api_client) + workspace_id = 'workspace_id_example' # str | + resolve_settings_request = gooddata_api_client.ResolveSettingsRequest() # ResolveSettingsRequest | - # example passing only required values which don't have defaults set try: # Values for selected settings. api_response = api_instance.workspace_resolve_settings(workspace_id, resolve_settings_request) + print("The response of WorkspacesSettingsApi->workspace_resolve_settings:\n") pprint(api_response) - except gooddata_api_client.ApiException as e: + except Exception as e: print("Exception when calling WorkspacesSettingsApi->workspace_resolve_settings: %s\n" % e) ``` + ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **resolve_settings_request** | [**ResolveSettingsRequest**](ResolveSettingsRequest.md)| | + **workspace_id** | **str**| | + **resolve_settings_request** | [**ResolveSettingsRequest**](ResolveSettingsRequest.md)| | ### Return type -[**[ResolvedSetting]**](ResolvedSetting.md) +[**List[ResolvedSetting]**](ResolvedSetting.md) ### Authorization @@ -1192,7 +1027,6 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/Xliff.md b/gooddata-api-client/docs/Xliff.md index 6bdde8c9a..90c0ee784 100644 --- a/gooddata-api-client/docs/Xliff.md +++ b/gooddata-api-client/docs/Xliff.md @@ -2,16 +2,33 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**file** | [**[File]**](File.md) | | -**other_attributes** | **{str: (str,)}** | | [optional] +**file** | [**List[File]**](File.md) | | +**other_attributes** | **Dict[str, str]** | | [optional] **space** | **str** | | [optional] **src_lang** | **str** | | [optional] **trg_lang** | **str** | | [optional] **version** | **str** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] +## Example + +```python +from gooddata_api_client.models.xliff import Xliff + +# TODO update the JSON string below +json = "{}" +# create an instance of Xliff from a JSON string +xliff_instance = Xliff.from_json(json) +# print the JSON string representation of the object +print(Xliff.to_json()) + +# convert the object into a dict +xliff_dict = xliff_instance.to_dict() +# create an instance of Xliff from a dict +xliff_from_dict = Xliff.from_dict(xliff_dict) +``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/apis/tags/APITokensApi.md b/gooddata-api-client/docs/apis/tags/APITokensApi.md index d7bee66f0..3ed9214a0 100644 --- a/gooddata-api-client/docs/apis/tags/APITokensApi.md +++ b/gooddata-api-client/docs/apis/tags/APITokensApi.md @@ -22,8 +22,8 @@ Post a new API token for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import api_tokens_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -250,7 +250,7 @@ List all api tokens for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import api_tokens_api -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -407,7 +407,7 @@ Get an API Token for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import api_tokens_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -540,8 +540,8 @@ Put new API token for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import api_tokens_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -686,4 +686,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/ActionsApi.md b/gooddata-api-client/docs/apis/tags/ActionsApi.md index e75f8cb98..085992a7b 100644 --- a/gooddata-api-client/docs/apis/tags/ActionsApi.md +++ b/gooddata-api-client/docs/apis/tags/ActionsApi.md @@ -53,7 +53,7 @@ Provides information about platform usage, like amount of users, workspaces, ... ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage import PlatformUsage from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -120,7 +120,7 @@ Get Available Assignees ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.available_assignees import AvailableAssignees +from gooddata_api_client.models.available_assignees import AvailableAssignees from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -218,8 +218,8 @@ Finds entities with given ID in hierarchy (e.g. to check possible future conflic ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.hierarchy_object_identification import HierarchyObjectIdentification +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -339,8 +339,8 @@ Returns paged list of elements (values) of given label satisfying given filterin ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.elements_request import ElementsRequest -from gooddata_api_client.model.elements_response import ElementsResponse +from gooddata_api_client.models.elements_request import ElementsRequest +from gooddata_api_client.models.elements_response import ElementsResponse from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -536,8 +536,8 @@ AFM is a combination of attributes, measures and filters that describe a query y ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution_response import AfmExecutionResponse +from gooddata_api_client.models.afm_execution import AfmExecution from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -792,8 +792,8 @@ Returns list containing attributes, facts, or metrics, which can be added to giv ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.afm_valid_objects_query import AfmValidObjectsQuery -from gooddata_api_client.model.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.models.afm_valid_objects_query import AfmValidObjectsQuery +from gooddata_api_client.models.afm_valid_objects_response import AfmValidObjectsResponse from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -924,8 +924,8 @@ An visual export job will be created based on the export request and put to queu ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.pdf_export_request import PdfExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.pdf_export_request import PdfExportRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1030,8 +1030,8 @@ An tabular export job will be created based on the export request and put to que ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.tabular_export_request import TabularExportRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1151,7 +1151,7 @@ Get Dashboard Permissions ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.dashboard_permissions import DashboardPermissions +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1249,7 +1249,7 @@ The resource provides static structures needed for investigation of a problem wi ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution import AfmExecution from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1497,8 +1497,8 @@ Generate logical data model (LDM) from physical data model (PDM) stored in data ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.declarative_model import DeclarativeModel -from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1616,7 +1616,7 @@ It scans a database and reads metadata. The result of the request contains a lis ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.data_source_schemata import DataSourceSchemata +from gooddata_api_client.models.data_source_schemata import DataSourceSchemata from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1705,7 +1705,7 @@ Computes the dependent entities graph ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1794,8 +1794,8 @@ Computes the dependent entities graph from given entry points ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2236,7 +2236,7 @@ Finds API identifier conflicts in given workspace hierarchy. ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2329,7 +2329,7 @@ Manage Permissions for a Dashboard ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.permissions_for_assignee import PermissionsForAssignee +from gooddata_api_client.models.permissions_for_assignee import PermissionsForAssignee from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2449,7 +2449,7 @@ Finds API identifier overrides in given workspace hierarchy. ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2544,8 +2544,8 @@ Provides information about platform usage, like amount of users, workspaces, ... ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage_request import PlatformUsageRequest +from gooddata_api_client.models.platform_usage import PlatformUsage from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2717,7 +2717,7 @@ Resolves values of available entitlements for the organization. ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.api_entitlement import ApiEntitlement +from gooddata_api_client.models.api_entitlement import ApiEntitlement from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2786,7 +2786,7 @@ Resolves values for all settings without workspace by current user, organization ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2855,8 +2855,8 @@ Resolves values for requested entitlements in the organization. ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.api_entitlement import ApiEntitlement -from gooddata_api_client.model.entitlements_request import EntitlementsRequest +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.models.entitlements_request import EntitlementsRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2948,8 +2948,8 @@ Resolves values for selected settings without workspace by current user, organiz ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3039,7 +3039,7 @@ The resource provides execution result's metadata as AFM and resultSpec used in ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.models.result_cache_metadata import ResultCacheMetadata from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3137,7 +3137,7 @@ Gets a single execution result. ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.execution_result import ExecutionResult +from gooddata_api_client.models.execution_result import ExecutionResult from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3311,8 +3311,8 @@ It scans a database and transforms its metadata to a declarative definition of t ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.scan_request import ScanRequest -from gooddata_api_client.model.scan_result_pdm import ScanResultPdm +from gooddata_api_client.models.scan_request import ScanRequest +from gooddata_api_client.models.scan_result_pdm import ScanResultPdm from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3420,8 +3420,8 @@ It executes SQL query against specified data source and extracts metadata. Metad ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.scan_sql_response import ScanSqlResponse -from gooddata_api_client.model.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3524,8 +3524,8 @@ Test if it is possible to connect to a database using an existing data source de ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_request import TestRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.models.test_request import TestRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3642,8 +3642,8 @@ Test if it is possible to connect to a database using a connection provided by t ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3738,7 +3738,7 @@ Resolves values for all settings in a workspace by current user, workspace, orga ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3833,8 +3833,8 @@ Resolves value for selected settings in a workspace by current user, workspace, ```python import gooddata_api_client from gooddata_api_client.apis.tags import actions_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3929,4 +3929,3 @@ Class Name | Input Type | Accessed Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/AnalyticsModelApi.md b/gooddata-api-client/docs/apis/tags/AnalyticsModelApi.md index 1d456d052..9f6feea1e 100644 --- a/gooddata-api-client/docs/apis/tags/AnalyticsModelApi.md +++ b/gooddata-api-client/docs/apis/tags/AnalyticsModelApi.md @@ -21,7 +21,7 @@ Retrieve current analytics model of the workspace. ```python import gooddata_api_client from gooddata_api_client.apis.tags import analytics_model_api -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -110,7 +110,7 @@ Set effective analytics model of the workspace. ```python import gooddata_api_client from gooddata_api_client.apis.tags import analytics_model_api -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -252,4 +252,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/AppearanceApi.md b/gooddata-api-client/docs/apis/tags/AppearanceApi.md index b4af57a11..7b2949d92 100644 --- a/gooddata-api-client/docs/apis/tags/AppearanceApi.md +++ b/gooddata-api-client/docs/apis/tags/AppearanceApi.md @@ -29,8 +29,8 @@ Post Color Pallettes ```python import gooddata_api_client from gooddata_api_client.apis.tags import appearance_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -119,8 +119,8 @@ Post Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import appearance_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -435,7 +435,7 @@ Get all Color Pallettes ```python import gooddata_api_client from gooddata_api_client.apis.tags import appearance_api -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -557,7 +557,7 @@ Get all Theming entities ```python import gooddata_api_client from gooddata_api_client.apis.tags import appearance_api -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -679,7 +679,7 @@ Get Color Pallette ```python import gooddata_api_client from gooddata_api_client.apis.tags import appearance_api -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -802,7 +802,7 @@ Get Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import appearance_api -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -925,8 +925,8 @@ Patch Color Pallette ```python import gooddata_api_client from gooddata_api_client.apis.tags import appearance_api -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1081,8 +1081,8 @@ Patch Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import appearance_api -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1237,8 +1237,8 @@ Put Color Pallette ```python import gooddata_api_client from gooddata_api_client.apis.tags import appearance_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1393,8 +1393,8 @@ Put Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import appearance_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1537,4 +1537,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/AttributesApi.md b/gooddata-api-client/docs/apis/tags/AttributesApi.md index f076d4f90..8b6c70103 100644 --- a/gooddata-api-client/docs/apis/tags/AttributesApi.md +++ b/gooddata-api-client/docs/apis/tags/AttributesApi.md @@ -19,7 +19,7 @@ Get all Attributes ```python import gooddata_api_client from gooddata_api_client.apis.tags import attributes_api -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -243,7 +243,7 @@ Get a Attribute ```python import gooddata_api_client from gooddata_api_client.apis.tags import attributes_api -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -420,4 +420,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/CSPDirectivesApi.md b/gooddata-api-client/docs/apis/tags/CSPDirectivesApi.md index 215e20281..4957e3088 100644 --- a/gooddata-api-client/docs/apis/tags/CSPDirectivesApi.md +++ b/gooddata-api-client/docs/apis/tags/CSPDirectivesApi.md @@ -25,8 +25,8 @@ Post CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import csp_directives_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -233,7 +233,7 @@ Get CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import csp_directives_api -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -357,7 +357,7 @@ Get CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import csp_directives_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -482,8 +482,8 @@ Patch CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import csp_directives_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -642,8 +642,8 @@ Put CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import csp_directives_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -788,4 +788,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/ComputationApi.md b/gooddata-api-client/docs/apis/tags/ComputationApi.md index 958dbb7ef..e70281214 100644 --- a/gooddata-api-client/docs/apis/tags/ComputationApi.md +++ b/gooddata-api-client/docs/apis/tags/ComputationApi.md @@ -27,8 +27,8 @@ Returns paged list of elements (values) of given label satisfying given filterin ```python import gooddata_api_client from gooddata_api_client.apis.tags import computation_api -from gooddata_api_client.model.elements_request import ElementsRequest -from gooddata_api_client.model.elements_response import ElementsResponse +from gooddata_api_client.models.elements_request import ElementsRequest +from gooddata_api_client.models.elements_response import ElementsResponse from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -224,8 +224,8 @@ AFM is a combination of attributes, measures and filters that describe a query y ```python import gooddata_api_client from gooddata_api_client.apis.tags import computation_api -from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution_response import AfmExecutionResponse +from gooddata_api_client.models.afm_execution import AfmExecution from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -480,8 +480,8 @@ Returns list containing attributes, facts, or metrics, which can be added to giv ```python import gooddata_api_client from gooddata_api_client.apis.tags import computation_api -from gooddata_api_client.model.afm_valid_objects_query import AfmValidObjectsQuery -from gooddata_api_client.model.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.models.afm_valid_objects_query import AfmValidObjectsQuery +from gooddata_api_client.models.afm_valid_objects_response import AfmValidObjectsResponse from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -612,8 +612,8 @@ An tabular export job will be created based on the export request and put to que ```python import gooddata_api_client from gooddata_api_client.apis.tags import computation_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.tabular_export_request import TabularExportRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -735,7 +735,7 @@ The resource provides static structures needed for investigation of a problem wi ```python import gooddata_api_client from gooddata_api_client.apis.tags import computation_api -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution import AfmExecution from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1108,7 +1108,7 @@ The resource provides execution result's metadata as AFM and resultSpec used in ```python import gooddata_api_client from gooddata_api_client.apis.tags import computation_api -from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.models.result_cache_metadata import ResultCacheMetadata from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1206,7 +1206,7 @@ Gets a single execution result. ```python import gooddata_api_client from gooddata_api_client.apis.tags import computation_api -from gooddata_api_client.model.execution_result import ExecutionResult +from gooddata_api_client.models.execution_result import ExecutionResult from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1366,4 +1366,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/ContextFiltersApi.md b/gooddata-api-client/docs/apis/tags/ContextFiltersApi.md index 62b4dc744..ba2fe1394 100644 --- a/gooddata-api-client/docs/apis/tags/ContextFiltersApi.md +++ b/gooddata-api-client/docs/apis/tags/ContextFiltersApi.md @@ -23,8 +23,8 @@ Post Context Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import context_filters_api -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -337,7 +337,7 @@ Get all Context Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import context_filters_api -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -561,7 +561,7 @@ Get a Context Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import context_filters_api -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -750,8 +750,8 @@ Patch a Context Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import context_filters_api -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -942,8 +942,8 @@ Put a Context Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import context_filters_api -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1122,4 +1122,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/CookieSecurityConfigurationApi.md b/gooddata-api-client/docs/apis/tags/CookieSecurityConfigurationApi.md index 99d6a7cf5..5160a768c 100644 --- a/gooddata-api-client/docs/apis/tags/CookieSecurityConfigurationApi.md +++ b/gooddata-api-client/docs/apis/tags/CookieSecurityConfigurationApi.md @@ -20,7 +20,7 @@ Get CookieSecurityConfiguration ```python import gooddata_api_client from gooddata_api_client.apis.tags import cookie_security_configuration_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -143,8 +143,8 @@ Patch CookieSecurityConfiguration ```python import gooddata_api_client from gooddata_api_client.apis.tags import cookie_security_configuration_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -299,8 +299,8 @@ Put CookieSecurityConfiguration ```python import gooddata_api_client from gooddata_api_client.apis.tags import cookie_security_configuration_api -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -443,4 +443,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/DashboardsApi.md b/gooddata-api-client/docs/apis/tags/DashboardsApi.md index e22cb6424..779f8f5f4 100644 --- a/gooddata-api-client/docs/apis/tags/DashboardsApi.md +++ b/gooddata-api-client/docs/apis/tags/DashboardsApi.md @@ -23,8 +23,8 @@ Post Dashboards ```python import gooddata_api_client from gooddata_api_client.apis.tags import dashboards_api -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -337,7 +337,7 @@ Get all Dashboards ```python import gooddata_api_client from gooddata_api_client.apis.tags import dashboards_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -561,7 +561,7 @@ Get a Dashboard ```python import gooddata_api_client from gooddata_api_client.apis.tags import dashboards_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -750,8 +750,8 @@ Patch a Dashboard ```python import gooddata_api_client from gooddata_api_client.apis.tags import dashboards_api -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -942,8 +942,8 @@ Put Dashboards ```python import gooddata_api_client from gooddata_api_client.apis.tags import dashboards_api -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1122,4 +1122,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/DataFiltersApi.md b/gooddata-api-client/docs/apis/tags/DataFiltersApi.md index 75f03b462..53e3a6681 100644 --- a/gooddata-api-client/docs/apis/tags/DataFiltersApi.md +++ b/gooddata-api-client/docs/apis/tags/DataFiltersApi.md @@ -33,8 +33,8 @@ Post User Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -240,8 +240,8 @@ Post Workspace Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -671,7 +671,7 @@ Get all User Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -895,7 +895,7 @@ Get all Settings for Workspace Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1101,7 +1101,7 @@ Get all Workspace Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1307,7 +1307,7 @@ Get a User Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1496,7 +1496,7 @@ Get a Setting for Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1667,7 +1667,7 @@ Get a Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1840,7 +1840,7 @@ Retrieve all workspaces and related workspace data filters (and their settings / ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1901,8 +1901,8 @@ Patch a User Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2109,8 +2109,8 @@ Patch a Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2315,7 +2315,7 @@ Sets workspace data filters in all workspaces in entire organization. ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2409,8 +2409,8 @@ Put a User Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2617,8 +2617,8 @@ Put a Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_filters_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2809,4 +2809,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/DataSourceDeclarativeAPIsApi.md b/gooddata-api-client/docs/apis/tags/DataSourceDeclarativeAPIsApi.md index 540513c69..515a1f2d5 100644 --- a/gooddata-api-client/docs/apis/tags/DataSourceDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/DataSourceDeclarativeAPIsApi.md @@ -21,7 +21,7 @@ Retrieve all data sources including related physical model. ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_declarative_apis_api -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -84,7 +84,7 @@ Set all data sources including related physical model. ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_declarative_apis_api -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -196,4 +196,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/DataSourceEntitiesControllerApi.md b/gooddata-api-client/docs/apis/tags/DataSourceEntitiesControllerApi.md index cb261afae..ef2a94a9d 100644 --- a/gooddata-api-client/docs/apis/tags/DataSourceEntitiesControllerApi.md +++ b/gooddata-api-client/docs/apis/tags/DataSourceEntitiesControllerApi.md @@ -19,7 +19,7 @@ Method | HTTP request | Description ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_entities_controller_api -from gooddata_api_client.model.json_api_data_source_table_out_list import JsonApiDataSourceTableOutList +from gooddata_api_client.models.json_api_data_source_table_out_list import JsonApiDataSourceTableOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -174,7 +174,7 @@ No authorization required ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_entities_controller_api -from gooddata_api_client.model.json_api_data_source_table_out_document import JsonApiDataSourceTableOutDocument +from gooddata_api_client.models.json_api_data_source_table_out_document import JsonApiDataSourceTableOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -293,4 +293,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/DataSourceEntityAPIsApi.md b/gooddata-api-client/docs/apis/tags/DataSourceEntityAPIsApi.md index 9ff91f6bb..4b06fe9ca 100644 --- a/gooddata-api-client/docs/apis/tags/DataSourceEntityAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/DataSourceEntityAPIsApi.md @@ -29,8 +29,8 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -316,7 +316,7 @@ Get all Data Source Identifiers ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -456,7 +456,7 @@ No authorization required ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_table_out_list import JsonApiDataSourceTableOutList +from gooddata_api_client.models.json_api_data_source_table_out_list import JsonApiDataSourceTableOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -613,7 +613,7 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -753,7 +753,7 @@ Get Data Source Identifier ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -894,7 +894,7 @@ No authorization required ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_table_out_document import JsonApiDataSourceTableOutDocument +from gooddata_api_client.models.json_api_data_source_table_out_document import JsonApiDataSourceTableOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1027,7 +1027,7 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1170,8 +1170,8 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1358,8 +1358,8 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import data_source_entity_apis_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1532,4 +1532,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/DatasetsApi.md b/gooddata-api-client/docs/apis/tags/DatasetsApi.md index 3ffeb0bb1..051c60a70 100644 --- a/gooddata-api-client/docs/apis/tags/DatasetsApi.md +++ b/gooddata-api-client/docs/apis/tags/DatasetsApi.md @@ -19,7 +19,7 @@ Get all Datasets ```python import gooddata_api_client from gooddata_api_client.apis.tags import datasets_api -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -243,7 +243,7 @@ Get a Dataset ```python import gooddata_api_client from gooddata_api_client.apis.tags import datasets_api -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -420,4 +420,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/DependencyGraphApi.md b/gooddata-api-client/docs/apis/tags/DependencyGraphApi.md index 8d8fdeddd..d3ff27802 100644 --- a/gooddata-api-client/docs/apis/tags/DependencyGraphApi.md +++ b/gooddata-api-client/docs/apis/tags/DependencyGraphApi.md @@ -21,7 +21,7 @@ Computes the dependent entities graph ```python import gooddata_api_client from gooddata_api_client.apis.tags import dependency_graph_api -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -110,8 +110,8 @@ Computes the dependent entities graph from given entry points ```python import gooddata_api_client from gooddata_api_client.apis.tags import dependency_graph_api -from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -205,4 +205,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/EntitiesApi.md b/gooddata-api-client/docs/apis/tags/EntitiesApi.md index c38eaa87e..7cc8d2f81 100644 --- a/gooddata-api-client/docs/apis/tags/EntitiesApi.md +++ b/gooddata-api-client/docs/apis/tags/EntitiesApi.md @@ -154,8 +154,8 @@ Post Dashboards ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -345,8 +345,8 @@ Post a new API token for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -450,8 +450,8 @@ Post Color Pallettes ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -542,8 +542,8 @@ Post CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -633,8 +633,8 @@ Post Custom Application Settings ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -798,8 +798,8 @@ Post Plugins ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -975,8 +975,8 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1147,8 +1147,8 @@ Post Context Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1338,8 +1338,8 @@ Post Metrics ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1535,8 +1535,8 @@ Post Organization Setting entities ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1625,8 +1625,8 @@ Post Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1715,8 +1715,8 @@ Post User Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1924,8 +1924,8 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2082,8 +2082,8 @@ Post new user settings for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2193,8 +2193,8 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2357,8 +2357,8 @@ Post Visualization Objects ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2548,8 +2548,8 @@ Post Workspace Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2733,8 +2733,8 @@ Post Settings for Workspaces ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2900,8 +2900,8 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5339,7 +5339,7 @@ Get all Dashboards ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5563,7 +5563,7 @@ List all api tokens for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5720,7 +5720,7 @@ Get all Attributes ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5944,7 +5944,7 @@ Get all Color Pallettes ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6068,7 +6068,7 @@ Get CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6190,7 +6190,7 @@ Get all Custom Application Settings ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6398,7 +6398,7 @@ Get all Plugins ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6606,7 +6606,7 @@ Get all Data Source Identifiers ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6746,7 +6746,7 @@ No authorization required ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_data_source_table_out_list import JsonApiDataSourceTableOutList +from gooddata_api_client.models.json_api_data_source_table_out_list import JsonApiDataSourceTableOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6903,7 +6903,7 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7043,7 +7043,7 @@ Get all Datasets ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7269,7 +7269,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7391,7 +7391,7 @@ Get all Facts ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7615,7 +7615,7 @@ Get all Context Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7839,7 +7839,7 @@ Get all Labels ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8063,7 +8063,7 @@ Get all Metrics ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8287,7 +8287,7 @@ Get Organization entities ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8409,7 +8409,7 @@ Get all Theming entities ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8531,7 +8531,7 @@ Get all User Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8757,7 +8757,7 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8895,7 +8895,7 @@ List all settings for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9054,7 +9054,7 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9192,7 +9192,7 @@ Get all Visualization Objects ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9416,7 +9416,7 @@ Get all Settings for Workspace Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9622,7 +9622,7 @@ Get all Workspace Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9828,7 +9828,7 @@ Get all Setting for Workspaces ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10038,7 +10038,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10320,7 +10320,7 @@ Get a Dashboard ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10509,7 +10509,7 @@ Get an API Token for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10642,7 +10642,7 @@ Get a Attribute ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10831,7 +10831,7 @@ Get Color Pallette ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10954,7 +10954,7 @@ Get CookieSecurityConfiguration ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11079,7 +11079,7 @@ Get CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11202,7 +11202,7 @@ Get a Custom Application Setting ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11375,7 +11375,7 @@ Get a Plugin ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11548,7 +11548,7 @@ Get Data Source Identifier ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11689,7 +11689,7 @@ No authorization required ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_data_source_table_out_document import JsonApiDataSourceTableOutDocument +from gooddata_api_client.models.json_api_data_source_table_out_document import JsonApiDataSourceTableOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11822,7 +11822,7 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11963,7 +11963,7 @@ Get a Dataset ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12154,7 +12154,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12277,7 +12277,7 @@ Get a Fact ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12466,7 +12466,7 @@ Get a Context Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12655,7 +12655,7 @@ Get a Label ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12844,7 +12844,7 @@ Get a Metric ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -13033,7 +13033,7 @@ Get Organization entity ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -13156,7 +13156,7 @@ Get Organizations ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -13313,7 +13313,7 @@ Get Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -13436,7 +13436,7 @@ Get a User Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -13627,7 +13627,7 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -13766,7 +13766,7 @@ Get a setting for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -13901,7 +13901,7 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -14040,7 +14040,7 @@ Get a Visualization Object ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -14229,7 +14229,7 @@ Get a Setting for Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -14400,7 +14400,7 @@ Get a Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -14571,7 +14571,7 @@ Get a Setting for Workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -14746,7 +14746,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -14991,8 +14991,8 @@ Patch a Dashboard ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -15183,8 +15183,8 @@ Patch Color Pallette ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -15339,8 +15339,8 @@ Patch CookieSecurityConfiguration ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -15497,8 +15497,8 @@ Patch CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -15655,8 +15655,8 @@ Patch a Custom Application Setting ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -15821,8 +15821,8 @@ Patch a Plugin ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -15999,8 +15999,8 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -16185,8 +16185,8 @@ Patch a Context Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -16377,8 +16377,8 @@ Patch a Metric ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -16575,8 +16575,8 @@ Patch Organization entity ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -16731,8 +16731,8 @@ Patch Organization ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -16919,8 +16919,8 @@ Patch Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -17075,8 +17075,8 @@ Patch a User Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -17285,8 +17285,8 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -17477,8 +17477,8 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -17673,8 +17673,8 @@ Patch a Visualization Object ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -17865,8 +17865,8 @@ Patch a Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -18069,8 +18069,8 @@ Patch a Setting for Workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -18237,8 +18237,8 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -18423,8 +18423,8 @@ Put Dashboards ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -18615,8 +18615,8 @@ Put new API token for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -18773,8 +18773,8 @@ Put Color Pallette ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -18929,8 +18929,8 @@ Put CookieSecurityConfiguration ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -19087,8 +19087,8 @@ Put CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -19245,8 +19245,8 @@ Put a Custom Application Setting ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -19411,8 +19411,8 @@ Put a Plugin ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -19589,8 +19589,8 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -19775,8 +19775,8 @@ Put a Context Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -19967,8 +19967,8 @@ Put a Metric ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -20165,8 +20165,8 @@ Put Organization entity ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -20321,8 +20321,8 @@ Put Organization ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -20509,8 +20509,8 @@ Put Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -20665,8 +20665,8 @@ Put a User Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -20875,8 +20875,8 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -21065,8 +21065,8 @@ Put new user settings for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -21233,8 +21233,8 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -21429,8 +21429,8 @@ Put a Visualization Object ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -21621,8 +21621,8 @@ Put a Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -21825,8 +21825,8 @@ Put a Setting for a Workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -21993,8 +21993,8 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import entities_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -22167,4 +22167,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/EntitlementApi.md b/gooddata-api-client/docs/apis/tags/EntitlementApi.md index b7d882290..b9fab9b13 100644 --- a/gooddata-api-client/docs/apis/tags/EntitlementApi.md +++ b/gooddata-api-client/docs/apis/tags/EntitlementApi.md @@ -23,7 +23,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import entitlement_api -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -147,7 +147,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import entitlement_api -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -272,7 +272,7 @@ Resolves values of available entitlements for the organization. ```python import gooddata_api_client from gooddata_api_client.apis.tags import entitlement_api -from gooddata_api_client.model.api_entitlement import ApiEntitlement +from gooddata_api_client.models.api_entitlement import ApiEntitlement from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -341,8 +341,8 @@ Resolves values for requested entitlements in the organization. ```python import gooddata_api_client from gooddata_api_client.apis.tags import entitlement_api -from gooddata_api_client.model.api_entitlement import ApiEntitlement -from gooddata_api_client.model.entitlements_request import EntitlementsRequest +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.models.entitlements_request import EntitlementsRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -420,4 +420,3 @@ Class Name | Input Type | Accessed Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/ExportingApi.md b/gooddata-api-client/docs/apis/tags/ExportingApi.md index 50cb738e1..3dc740fa7 100644 --- a/gooddata-api-client/docs/apis/tags/ExportingApi.md +++ b/gooddata-api-client/docs/apis/tags/ExportingApi.md @@ -22,8 +22,8 @@ An visual export job will be created based on the export request and put to queu ```python import gooddata_api_client from gooddata_api_client.apis.tags import exporting_api -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.pdf_export_request import PdfExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.pdf_export_request import PdfExportRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -322,4 +322,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/FactsApi.md b/gooddata-api-client/docs/apis/tags/FactsApi.md index 91d9d1398..0dabe22a9 100644 --- a/gooddata-api-client/docs/apis/tags/FactsApi.md +++ b/gooddata-api-client/docs/apis/tags/FactsApi.md @@ -19,7 +19,7 @@ Get all Facts ```python import gooddata_api_client from gooddata_api_client.apis.tags import facts_api -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -243,7 +243,7 @@ Get a Fact ```python import gooddata_api_client from gooddata_api_client.apis.tags import facts_api -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -420,4 +420,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/GenerateLogicalDataModelApi.md b/gooddata-api-client/docs/apis/tags/GenerateLogicalDataModelApi.md index a71e07777..7a44185e6 100644 --- a/gooddata-api-client/docs/apis/tags/GenerateLogicalDataModelApi.md +++ b/gooddata-api-client/docs/apis/tags/GenerateLogicalDataModelApi.md @@ -20,8 +20,8 @@ Generate logical data model (LDM) from physical data model (PDM) stored in data ```python import gooddata_api_client from gooddata_api_client.apis.tags import generate_logical_data_model_api -from gooddata_api_client.model.declarative_model import DeclarativeModel -from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -125,4 +125,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/LDMDeclarativeAPIsApi.md b/gooddata-api-client/docs/apis/tags/LDMDeclarativeAPIsApi.md index 174f554af..a8c7523c2 100644 --- a/gooddata-api-client/docs/apis/tags/LDMDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/LDMDeclarativeAPIsApi.md @@ -21,7 +21,7 @@ Retrieve current logical model of the workspace in declarative form. ```python import gooddata_api_client from gooddata_api_client.apis.tags import ldm_declarative_apis_api -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -146,7 +146,7 @@ Set effective logical model of the workspace. ```python import gooddata_api_client from gooddata_api_client.apis.tags import ldm_declarative_apis_api -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -322,4 +322,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/LabelsApi.md b/gooddata-api-client/docs/apis/tags/LabelsApi.md index b27e367a3..56d2e539f 100644 --- a/gooddata-api-client/docs/apis/tags/LabelsApi.md +++ b/gooddata-api-client/docs/apis/tags/LabelsApi.md @@ -19,7 +19,7 @@ Get all Labels ```python import gooddata_api_client from gooddata_api_client.apis.tags import labels_api -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -243,7 +243,7 @@ Get a Label ```python import gooddata_api_client from gooddata_api_client.apis.tags import labels_api -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -420,4 +420,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/LayoutApi.md b/gooddata-api-client/docs/apis/tags/LayoutApi.md index 171820194..defde6e76 100644 --- a/gooddata-api-client/docs/apis/tags/LayoutApi.md +++ b/gooddata-api-client/docs/apis/tags/LayoutApi.md @@ -49,7 +49,7 @@ Retrieve current analytics model of the workspace. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -138,7 +138,7 @@ Retrieve all data sources including related physical model. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -201,7 +201,7 @@ Retrieve current logical model of the workspace in declarative form. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -326,7 +326,7 @@ Retrieve complete layout of organization, workspaces, user-groups, etc. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -389,7 +389,7 @@ Retrieve complete layout of tables with their columns ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_pdm import DeclarativePdm +from gooddata_api_client.models.declarative_pdm import DeclarativePdm from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -478,7 +478,7 @@ Retrieve current user data filters assigned to the workspace. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -567,7 +567,7 @@ Retrieve current set of permissions of the user-group in a declarative form. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -656,7 +656,7 @@ Retrieve all user-groups eventually with parent group. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -719,7 +719,7 @@ Retrieve current set of permissions of the user in a declarative form. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -808,7 +808,7 @@ Retrieve all users including authentication properties. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -871,7 +871,7 @@ Retrieve all users and user groups with theirs properties. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -934,7 +934,7 @@ Retrieve all workspaces and related workspace data filters (and their settings / ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -997,7 +997,7 @@ Retrieve current model of the workspace in declarative form. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1086,7 +1086,7 @@ Retrieve current set of permissions of the workspace in a declarative form. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1175,7 +1175,7 @@ Gets complete layout of workspaces, their hierarchy, models. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1238,7 +1238,7 @@ Set all data sources including related physical model. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1364,7 +1364,7 @@ Define all user groups with their parents eventually. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1460,7 +1460,7 @@ Set all users and their authentication properties. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1566,7 +1566,7 @@ Define all users and user groups with theirs properties. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1685,7 +1685,7 @@ Set complete layout of workspace, like model, authorization, etc. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1937,7 +1937,7 @@ Set effective analytics model of the workspace. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2093,7 +2093,7 @@ Set effective logical model of the workspace. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2283,7 +2283,7 @@ Sets complete layout of organization, like workspaces, user-groups, etc. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2712,7 +2712,7 @@ Sets complete layout of tables with their columns under corresponding Data Sourc ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_pdm import DeclarativePdm +from gooddata_api_client.models.declarative_pdm import DeclarativePdm from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2825,7 +2825,7 @@ Set user data filters assigned to the workspace. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2936,7 +2936,7 @@ Set effective permissions for the user-group ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3039,7 +3039,7 @@ Set effective permissions for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3142,7 +3142,7 @@ Sets workspace data filters in all workspaces in entire organization. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3238,7 +3238,7 @@ Set effective permissions for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3344,7 +3344,7 @@ Sets complete layout of workspaces, their hierarchy, models. ```python import gooddata_api_client from gooddata_api_client.apis.tags import layout_api -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3636,4 +3636,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/MetricsApi.md b/gooddata-api-client/docs/apis/tags/MetricsApi.md index c4f1927e5..b5864bbcb 100644 --- a/gooddata-api-client/docs/apis/tags/MetricsApi.md +++ b/gooddata-api-client/docs/apis/tags/MetricsApi.md @@ -23,8 +23,8 @@ Post Metrics ```python import gooddata_api_client from gooddata_api_client.apis.tags import metrics_api -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -343,7 +343,7 @@ Get all Metrics ```python import gooddata_api_client from gooddata_api_client.apis.tags import metrics_api -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -567,7 +567,7 @@ Get a Metric ```python import gooddata_api_client from gooddata_api_client.apis.tags import metrics_api -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -756,8 +756,8 @@ Patch a Metric ```python import gooddata_api_client from gooddata_api_client.apis.tags import metrics_api -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -954,8 +954,8 @@ Put a Metric ```python import gooddata_api_client from gooddata_api_client.apis.tags import metrics_api -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1140,4 +1140,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/OrganizationControllerApi.md b/gooddata-api-client/docs/apis/tags/OrganizationControllerApi.md index adee7db04..d1332419c 100644 --- a/gooddata-api-client/docs/apis/tags/OrganizationControllerApi.md +++ b/gooddata-api-client/docs/apis/tags/OrganizationControllerApi.md @@ -23,7 +23,7 @@ Get CookieSecurityConfiguration ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_controller_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -146,7 +146,7 @@ Get Organizations ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_controller_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -303,8 +303,8 @@ Patch CookieSecurityConfiguration ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_controller_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -459,8 +459,8 @@ Patch Organization ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_controller_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -647,8 +647,8 @@ Put CookieSecurityConfiguration ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_controller_api -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -803,8 +803,8 @@ Put Organization ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_controller_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -979,4 +979,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/OrganizationDeclarativeAPIsApi.md b/gooddata-api-client/docs/apis/tags/OrganizationDeclarativeAPIsApi.md index ed6e01a67..e036469ce 100644 --- a/gooddata-api-client/docs/apis/tags/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/OrganizationDeclarativeAPIsApi.md @@ -21,7 +21,7 @@ Retrieve complete layout of organization, workspaces, user-groups, etc. ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_declarative_apis_api -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -84,7 +84,7 @@ Sets complete layout of organization, like workspaces, user-groups, etc. ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_declarative_apis_api -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -499,4 +499,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/OrganizationEntityAPIsApi.md b/gooddata-api-client/docs/apis/tags/OrganizationEntityAPIsApi.md index 10827a5cd..2e3737c63 100644 --- a/gooddata-api-client/docs/apis/tags/OrganizationEntityAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/OrganizationEntityAPIsApi.md @@ -27,8 +27,8 @@ Post Organization Setting entities ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -230,7 +230,7 @@ Get Organization entities ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -352,7 +352,7 @@ Get Organization entity ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -475,7 +475,7 @@ Get Organizations ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -720,8 +720,8 @@ Patch Organization entity ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -876,8 +876,8 @@ Patch Organization ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1064,8 +1064,8 @@ Put Organization entity ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1220,8 +1220,8 @@ Put Organization ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_entity_apis_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1396,4 +1396,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/OrganizationModelControllerApi.md b/gooddata-api-client/docs/apis/tags/OrganizationModelControllerApi.md index d37670157..2cac61fab 100644 --- a/gooddata-api-client/docs/apis/tags/OrganizationModelControllerApi.md +++ b/gooddata-api-client/docs/apis/tags/OrganizationModelControllerApi.md @@ -69,8 +69,8 @@ Post Color Pallettes ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -161,8 +161,8 @@ Post CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -254,8 +254,8 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -426,8 +426,8 @@ Post Organization Setting entities ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -516,8 +516,8 @@ Post Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -608,8 +608,8 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -768,8 +768,8 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -934,8 +934,8 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2020,7 +2020,7 @@ Get all Color Pallettes ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2144,7 +2144,7 @@ Get CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2266,7 +2266,7 @@ Get all Data Source Identifiers ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2408,7 +2408,7 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2550,7 +2550,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2672,7 +2672,7 @@ Get Organization entities ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2794,7 +2794,7 @@ Get all Theming entities ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2918,7 +2918,7 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3058,7 +3058,7 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3198,7 +3198,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3354,7 +3354,7 @@ Get Color Pallette ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3479,7 +3479,7 @@ Get CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3602,7 +3602,7 @@ Get Data Source Identifier ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3745,7 +3745,7 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3888,7 +3888,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4011,7 +4011,7 @@ Get Organization entity ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4134,7 +4134,7 @@ Get Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4259,7 +4259,7 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4400,7 +4400,7 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4541,7 +4541,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4698,8 +4698,8 @@ Patch Color Pallette ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4856,8 +4856,8 @@ Patch CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5016,8 +5016,8 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5202,8 +5202,8 @@ Patch Organization entity ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5358,8 +5358,8 @@ Patch Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5516,8 +5516,8 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5708,8 +5708,8 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5906,8 +5906,8 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6092,8 +6092,8 @@ Put Color Pallette ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6250,8 +6250,8 @@ Put CSP Directives ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6410,8 +6410,8 @@ Data Source - represents data source for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6596,8 +6596,8 @@ Put Organization entity ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6752,8 +6752,8 @@ Put Theming ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6910,8 +6910,8 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7102,8 +7102,8 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7300,8 +7300,8 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import organization_model_controller_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7474,4 +7474,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/PDMDeclarativeAPIsApi.md b/gooddata-api-client/docs/apis/tags/PDMDeclarativeAPIsApi.md index b82adc271..f97bdbc98 100644 --- a/gooddata-api-client/docs/apis/tags/PDMDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/PDMDeclarativeAPIsApi.md @@ -21,7 +21,7 @@ Retrieve complete layout of tables with their columns ```python import gooddata_api_client from gooddata_api_client.apis.tags import pdm_declarative_apis_api -from gooddata_api_client.model.declarative_pdm import DeclarativePdm +from gooddata_api_client.models.declarative_pdm import DeclarativePdm from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -110,7 +110,7 @@ Sets complete layout of tables with their columns under corresponding Data Sourc ```python import gooddata_api_client from gooddata_api_client.apis.tags import pdm_declarative_apis_api -from gooddata_api_client.model.declarative_pdm import DeclarativePdm +from gooddata_api_client.models.declarative_pdm import DeclarativePdm from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -209,4 +209,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/PermissionsApi.md b/gooddata-api-client/docs/apis/tags/PermissionsApi.md index 43732cc5d..9498560cb 100644 --- a/gooddata-api-client/docs/apis/tags/PermissionsApi.md +++ b/gooddata-api-client/docs/apis/tags/PermissionsApi.md @@ -22,7 +22,7 @@ Get Available Assignees ```python import gooddata_api_client from gooddata_api_client.apis.tags import permissions_api -from gooddata_api_client.model.available_assignees import AvailableAssignees +from gooddata_api_client.models.available_assignees import AvailableAssignees from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -118,7 +118,7 @@ Get Dashboard Permissions ```python import gooddata_api_client from gooddata_api_client.apis.tags import permissions_api -from gooddata_api_client.model.dashboard_permissions import DashboardPermissions +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -216,7 +216,7 @@ Retrieve current set of permissions of the workspace in a declarative form. ```python import gooddata_api_client from gooddata_api_client.apis.tags import permissions_api -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -303,7 +303,7 @@ Manage Permissions for a Dashboard ```python import gooddata_api_client from gooddata_api_client.apis.tags import permissions_api -from gooddata_api_client.model.permissions_for_assignee import PermissionsForAssignee +from gooddata_api_client.models.permissions_for_assignee import PermissionsForAssignee from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -423,7 +423,7 @@ Set effective permissions for the workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import permissions_api -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -515,4 +515,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/PluginsApi.md b/gooddata-api-client/docs/apis/tags/PluginsApi.md index 500dad9c9..6a7d47b6f 100644 --- a/gooddata-api-client/docs/apis/tags/PluginsApi.md +++ b/gooddata-api-client/docs/apis/tags/PluginsApi.md @@ -23,8 +23,8 @@ Post Plugins ```python import gooddata_api_client from gooddata_api_client.apis.tags import plugins_api -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -321,7 +321,7 @@ Get all Plugins ```python import gooddata_api_client from gooddata_api_client.apis.tags import plugins_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -529,7 +529,7 @@ Get a Plugin ```python import gooddata_api_client from gooddata_api_client.apis.tags import plugins_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -702,8 +702,8 @@ Patch a Plugin ```python import gooddata_api_client from gooddata_api_client.apis.tags import plugins_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -878,8 +878,8 @@ Put a Plugin ```python import gooddata_api_client from gooddata_api_client.apis.tags import plugins_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1042,4 +1042,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/ReportingSettingsApi.md b/gooddata-api-client/docs/apis/tags/ReportingSettingsApi.md index 04fd45e81..59ca92588 100644 --- a/gooddata-api-client/docs/apis/tags/ReportingSettingsApi.md +++ b/gooddata-api-client/docs/apis/tags/ReportingSettingsApi.md @@ -21,7 +21,7 @@ Resolves values for all settings without workspace by current user, organization ```python import gooddata_api_client from gooddata_api_client.apis.tags import reporting_settings_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -90,8 +90,8 @@ Resolves values for selected settings without workspace by current user, organiz ```python import gooddata_api_client from gooddata_api_client.apis.tags import reporting_settings_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -167,4 +167,3 @@ Class Name | Input Type | Accessed Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/ScanningApi.md b/gooddata-api-client/docs/apis/tags/ScanningApi.md index 086f73fbc..d5af8d20e 100644 --- a/gooddata-api-client/docs/apis/tags/ScanningApi.md +++ b/gooddata-api-client/docs/apis/tags/ScanningApi.md @@ -22,7 +22,7 @@ It scans a database and reads metadata. The result of the request contains a lis ```python import gooddata_api_client from gooddata_api_client.apis.tags import scanning_api -from gooddata_api_client.model.data_source_schemata import DataSourceSchemata +from gooddata_api_client.models.data_source_schemata import DataSourceSchemata from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -111,8 +111,8 @@ It scans a database and transforms its metadata to a declarative definition of t ```python import gooddata_api_client from gooddata_api_client.apis.tags import scanning_api -from gooddata_api_client.model.scan_request import ScanRequest -from gooddata_api_client.model.scan_result_pdm import ScanResultPdm +from gooddata_api_client.models.scan_request import ScanRequest +from gooddata_api_client.models.scan_result_pdm import ScanResultPdm from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -220,8 +220,8 @@ It executes SQL query against specified data source and extracts metadata. Metad ```python import gooddata_api_client from gooddata_api_client.apis.tags import scanning_api -from gooddata_api_client.model.scan_sql_response import ScanSqlResponse -from gooddata_api_client.model.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -310,4 +310,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/TestConnectionApi.md b/gooddata-api-client/docs/apis/tags/TestConnectionApi.md index 6118e6ce4..f848ef71c 100644 --- a/gooddata-api-client/docs/apis/tags/TestConnectionApi.md +++ b/gooddata-api-client/docs/apis/tags/TestConnectionApi.md @@ -21,8 +21,8 @@ Test if it is possible to connect to a database using an existing data source de ```python import gooddata_api_client from gooddata_api_client.apis.tags import test_connection_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_request import TestRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.models.test_request import TestRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -139,8 +139,8 @@ Test if it is possible to connect to a database using a connection provided by t ```python import gooddata_api_client from gooddata_api_client.apis.tags import test_connection_api -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -221,4 +221,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/UsageApi.md b/gooddata-api-client/docs/apis/tags/UsageApi.md index eb86b55d4..c1398e297 100644 --- a/gooddata-api-client/docs/apis/tags/UsageApi.md +++ b/gooddata-api-client/docs/apis/tags/UsageApi.md @@ -21,7 +21,7 @@ Provides information about platform usage, like amount of users, workspaces, ... ```python import gooddata_api_client from gooddata_api_client.apis.tags import usage_api -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage import PlatformUsage from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -90,8 +90,8 @@ Provides information about platform usage, like amount of users, workspaces, ... ```python import gooddata_api_client from gooddata_api_client.apis.tags import usage_api -from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage_request import PlatformUsageRequest +from gooddata_api_client.models.platform_usage import PlatformUsage from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -169,4 +169,3 @@ Class Name | Input Type | Accessed Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/UserDataFiltersApi.md b/gooddata-api-client/docs/apis/tags/UserDataFiltersApi.md index 8072304d0..17d053098 100644 --- a/gooddata-api-client/docs/apis/tags/UserDataFiltersApi.md +++ b/gooddata-api-client/docs/apis/tags/UserDataFiltersApi.md @@ -21,7 +21,7 @@ Retrieve current user data filters assigned to the workspace. ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_data_filters_api -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -110,7 +110,7 @@ Set user data filters assigned to the workspace. ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_data_filters_api -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -207,4 +207,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/UserGroupsDeclarativeAPIsApi.md b/gooddata-api-client/docs/apis/tags/UserGroupsDeclarativeAPIsApi.md index de376942d..e154286fc 100644 --- a/gooddata-api-client/docs/apis/tags/UserGroupsDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/UserGroupsDeclarativeAPIsApi.md @@ -23,7 +23,7 @@ Retrieve all user-groups eventually with parent group. ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_groups_declarative_apis_api -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -86,7 +86,7 @@ Retrieve all users and user groups with theirs properties. ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_groups_declarative_apis_api -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -149,7 +149,7 @@ Define all user groups with their parents eventually. ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_groups_declarative_apis_api -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -245,7 +245,7 @@ Define all users and user groups with theirs properties. ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_groups_declarative_apis_api -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -350,4 +350,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/UserGroupsEntityAPIsApi.md b/gooddata-api-client/docs/apis/tags/UserGroupsEntityAPIsApi.md index 34dc7d2d4..0be8e5ae3 100644 --- a/gooddata-api-client/docs/apis/tags/UserGroupsEntityAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/UserGroupsEntityAPIsApi.md @@ -25,8 +25,8 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_groups_entity_apis_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -300,7 +300,7 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_groups_entity_apis_api -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -440,7 +440,7 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_groups_entity_apis_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -581,8 +581,8 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_groups_entity_apis_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -773,8 +773,8 @@ User Group - creates tree-like structure for categorizing users ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_groups_entity_apis_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -951,4 +951,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/UserModelControllerApi.md b/gooddata-api-client/docs/apis/tags/UserModelControllerApi.md index 025d862bd..923cdff45 100644 --- a/gooddata-api-client/docs/apis/tags/UserModelControllerApi.md +++ b/gooddata-api-client/docs/apis/tags/UserModelControllerApi.md @@ -27,8 +27,8 @@ Post a new API token for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_model_controller_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -132,8 +132,8 @@ Post new user settings for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -487,7 +487,7 @@ List all api tokens for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_model_controller_api -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -644,7 +644,7 @@ List all settings for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -801,7 +801,7 @@ Get an API Token for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_model_controller_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -934,7 +934,7 @@ Get a setting for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1067,8 +1067,8 @@ Put new API token for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_model_controller_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1225,8 +1225,8 @@ Put new user settings for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1379,4 +1379,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/UserSettingsApi.md b/gooddata-api-client/docs/apis/tags/UserSettingsApi.md index 5ccd58625..3f1a337e8 100644 --- a/gooddata-api-client/docs/apis/tags/UserSettingsApi.md +++ b/gooddata-api-client/docs/apis/tags/UserSettingsApi.md @@ -22,8 +22,8 @@ Post new user settings for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_settings_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -254,7 +254,7 @@ List all settings for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_settings_api -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -411,7 +411,7 @@ Get a setting for a user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_settings_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -544,8 +544,8 @@ Put new user settings for the user ```python import gooddata_api_client from gooddata_api_client.apis.tags import user_settings_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -698,4 +698,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/UsersDeclarativeAPIsApi.md b/gooddata-api-client/docs/apis/tags/UsersDeclarativeAPIsApi.md index 1e1b3fb86..f502ac0b8 100644 --- a/gooddata-api-client/docs/apis/tags/UsersDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/UsersDeclarativeAPIsApi.md @@ -21,7 +21,7 @@ Retrieve all users including authentication properties. ```python import gooddata_api_client from gooddata_api_client.apis.tags import users_declarative_apis_api -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -84,7 +84,7 @@ Set all users and their authentication properties. ```python import gooddata_api_client from gooddata_api_client.apis.tags import users_declarative_apis_api -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -176,4 +176,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/UsersEntityAPIsApi.md b/gooddata-api-client/docs/apis/tags/UsersEntityAPIsApi.md index 66015e458..18ec82f06 100644 --- a/gooddata-api-client/docs/apis/tags/UsersEntityAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/UsersEntityAPIsApi.md @@ -25,8 +25,8 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import users_entity_apis_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -306,7 +306,7 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import users_entity_apis_api -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -446,7 +446,7 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import users_entity_apis_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -587,8 +587,8 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import users_entity_apis_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -785,8 +785,8 @@ User - represents entity interacting with platform ```python import gooddata_api_client from gooddata_api_client.apis.tags import users_entity_apis_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -969,4 +969,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/VisualizationObjectApi.md b/gooddata-api-client/docs/apis/tags/VisualizationObjectApi.md index 6862242d5..113213ff4 100644 --- a/gooddata-api-client/docs/apis/tags/VisualizationObjectApi.md +++ b/gooddata-api-client/docs/apis/tags/VisualizationObjectApi.md @@ -23,8 +23,8 @@ Post Visualization Objects ```python import gooddata_api_client from gooddata_api_client.apis.tags import visualization_object_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -337,7 +337,7 @@ Get all Visualization Objects ```python import gooddata_api_client from gooddata_api_client.apis.tags import visualization_object_api -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -561,7 +561,7 @@ Get a Visualization Object ```python import gooddata_api_client from gooddata_api_client.apis.tags import visualization_object_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -750,8 +750,8 @@ Patch a Visualization Object ```python import gooddata_api_client from gooddata_api_client.apis.tags import visualization_object_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -942,8 +942,8 @@ Put a Visualization Object ```python import gooddata_api_client from gooddata_api_client.apis.tags import visualization_object_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1122,4 +1122,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/WorkspaceObjectControllerApi.md b/gooddata-api-client/docs/apis/tags/WorkspaceObjectControllerApi.md index d4befc5e0..98419c901 100644 --- a/gooddata-api-client/docs/apis/tags/WorkspaceObjectControllerApi.md +++ b/gooddata-api-client/docs/apis/tags/WorkspaceObjectControllerApi.md @@ -81,8 +81,8 @@ Post Dashboards ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -272,8 +272,8 @@ Post Custom Application Settings ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -437,8 +437,8 @@ Post Plugins ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -612,8 +612,8 @@ Post Context Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -803,8 +803,8 @@ Post Metrics ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1000,8 +1000,8 @@ Post User Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1207,8 +1207,8 @@ Post Visualization Objects ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1398,8 +1398,8 @@ Post Workspace Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1583,8 +1583,8 @@ Post Settings for Workspaces ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2855,7 +2855,7 @@ Get all Dashboards ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3079,7 +3079,7 @@ Get all Attributes ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3303,7 +3303,7 @@ Get all Custom Application Settings ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3511,7 +3511,7 @@ Get all Plugins ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3719,7 +3719,7 @@ Get all Datasets ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3943,7 +3943,7 @@ Get all Facts ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4167,7 +4167,7 @@ Get all Context Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4391,7 +4391,7 @@ Get all Labels ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4615,7 +4615,7 @@ Get all Metrics ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4839,7 +4839,7 @@ Get all User Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5063,7 +5063,7 @@ Get all Visualization Objects ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5287,7 +5287,7 @@ Get all Settings for Workspace Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5493,7 +5493,7 @@ Get all Workspace Data Filters ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5699,7 +5699,7 @@ Get all Setting for Workspaces ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -5907,7 +5907,7 @@ Get a Dashboard ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6096,7 +6096,7 @@ Get a Attribute ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6285,7 +6285,7 @@ Get a Custom Application Setting ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6458,7 +6458,7 @@ Get a Plugin ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6631,7 +6631,7 @@ Get a Dataset ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -6820,7 +6820,7 @@ Get a Fact ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7009,7 +7009,7 @@ Get a Context Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7198,7 +7198,7 @@ Get a Label ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7387,7 +7387,7 @@ Get a Metric ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7576,7 +7576,7 @@ Get a User Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7765,7 +7765,7 @@ Get a Visualization Object ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7954,7 +7954,7 @@ Get a Setting for Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8125,7 +8125,7 @@ Get a Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8296,7 +8296,7 @@ Get a Setting for Workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8469,8 +8469,8 @@ Patch a Dashboard ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8661,8 +8661,8 @@ Patch a Custom Application Setting ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8827,8 +8827,8 @@ Patch a Plugin ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9003,8 +9003,8 @@ Patch a Context Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9195,8 +9195,8 @@ Patch a Metric ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9393,8 +9393,8 @@ Patch a User Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9601,8 +9601,8 @@ Patch a Visualization Object ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9793,8 +9793,8 @@ Patch a Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9997,8 +9997,8 @@ Patch a Setting for Workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10163,8 +10163,8 @@ Put Dashboards ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10355,8 +10355,8 @@ Put a Custom Application Setting ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10521,8 +10521,8 @@ Put a Plugin ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10697,8 +10697,8 @@ Put a Context Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10889,8 +10889,8 @@ Put a Metric ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11087,8 +11087,8 @@ Put a User Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11295,8 +11295,8 @@ Put a Visualization Object ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11487,8 +11487,8 @@ Put a Workspace Data Filter ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11691,8 +11691,8 @@ Put a Setting for a Workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11845,4 +11845,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/apis/tags/WorkspacesDeclarativeAPIsApi.md index 7b711bf3b..51d3c0243 100644 --- a/gooddata-api-client/docs/apis/tags/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/WorkspacesDeclarativeAPIsApi.md @@ -23,7 +23,7 @@ Retrieve current model of the workspace in declarative form. ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_declarative_apis_api -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -112,7 +112,7 @@ Gets complete layout of workspaces, their hierarchy, models. ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_declarative_apis_api -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -175,7 +175,7 @@ Set complete layout of workspace, like model, authorization, etc. ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_declarative_apis_api -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -427,7 +427,7 @@ Sets complete layout of workspaces, their hierarchy, models. ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_declarative_apis_api -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -719,4 +719,3 @@ headers | Unset | headers were not defined | No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/WorkspacesEntityAPIsApi.md b/gooddata-api-client/docs/apis/tags/WorkspacesEntityAPIsApi.md index 6f91eff8c..90ca8cc7e 100644 --- a/gooddata-api-client/docs/apis/tags/WorkspacesEntityAPIsApi.md +++ b/gooddata-api-client/docs/apis/tags/WorkspacesEntityAPIsApi.md @@ -25,8 +25,8 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_entity_apis_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -314,7 +314,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_entity_apis_api -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -472,7 +472,7 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_entity_apis_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -631,8 +631,8 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_entity_apis_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -819,8 +819,8 @@ Space of the shared interest ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_entity_apis_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -993,4 +993,3 @@ Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/apis/tags/WorkspacesSettingsApi.md b/gooddata-api-client/docs/apis/tags/WorkspacesSettingsApi.md index 491355b4b..9ae82f414 100644 --- a/gooddata-api-client/docs/apis/tags/WorkspacesSettingsApi.md +++ b/gooddata-api-client/docs/apis/tags/WorkspacesSettingsApi.md @@ -31,8 +31,8 @@ Post Custom Application Settings ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -196,8 +196,8 @@ Post Settings for Workspaces ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -607,7 +607,7 @@ Get all Custom Application Settings ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -815,7 +815,7 @@ Get all Setting for Workspaces ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1023,7 +1023,7 @@ Get a Custom Application Setting ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1196,7 +1196,7 @@ Get a Setting for Workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1369,8 +1369,8 @@ Patch a Custom Application Setting ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1535,8 +1535,8 @@ Patch a Setting for Workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1701,8 +1701,8 @@ Put a Custom Application Setting ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -1867,8 +1867,8 @@ Put a Setting for a Workspace ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2035,7 +2035,7 @@ Resolves values for all settings in a workspace by current user, workspace, orga ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2130,8 +2130,8 @@ Resolves value for selected settings in a workspace by current user, workspace, ```python import gooddata_api_client from gooddata_api_client.apis.tags import workspaces_settings_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -2226,4 +2226,3 @@ Class Name | Input Type | Accessed Type | Description | Notes No authorization required [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) - diff --git a/gooddata-api-client/docs/models/AFM.md b/gooddata-api-client/docs/models/AFM.md index a8bdf0b44..b4abad0ea 100644 --- a/gooddata-api-client/docs/models/AFM.md +++ b/gooddata-api-client/docs/models/AFM.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm.AFM +# gooddata_api_client.models.afm.AFM Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics. @@ -73,4 +73,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AbsoluteDateFilter.md b/gooddata-api-client/docs/models/AbsoluteDateFilter.md index 3408834cf..9b091416f 100644 --- a/gooddata-api-client/docs/models/AbsoluteDateFilter.md +++ b/gooddata-api-client/docs/models/AbsoluteDateFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.absolute_date_filter.AbsoluteDateFilter +# gooddata_api_client.models.absolute_date_filter.AbsoluteDateFilter A datetime filter specifying exact from and to values. @@ -30,4 +30,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AbstractMeasureValueFilter.md b/gooddata-api-client/docs/models/AbstractMeasureValueFilter.md index 8d5f8b7eb..fb956f830 100644 --- a/gooddata-api-client/docs/models/AbstractMeasureValueFilter.md +++ b/gooddata-api-client/docs/models/AbstractMeasureValueFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.abstract_measure_value_filter.AbstractMeasureValueFilter +# gooddata_api_client.models.abstract_measure_value_filter.AbstractMeasureValueFilter ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -14,4 +14,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [RankingFilter](RankingFilter.md) | [**RankingFilter**](RankingFilter.md) | [**RankingFilter**](RankingFilter.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AfmExecution.md b/gooddata-api-client/docs/models/AfmExecution.md index 40d91cffc..1172beefe 100644 --- a/gooddata-api-client/docs/models/AfmExecution.md +++ b/gooddata-api-client/docs/models/AfmExecution.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm_execution.AfmExecution +# gooddata_api_client.models.afm_execution.AfmExecution ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AfmExecutionResponse.md b/gooddata-api-client/docs/models/AfmExecutionResponse.md index a8e70850b..61f1036b9 100644 --- a/gooddata-api-client/docs/models/AfmExecutionResponse.md +++ b/gooddata-api-client/docs/models/AfmExecutionResponse.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm_execution_response.AfmExecutionResponse +# gooddata_api_client.models.afm_execution_response.AfmExecutionResponse ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AfmIdentifier.md b/gooddata-api-client/docs/models/AfmIdentifier.md index cb87f3a55..53132f6d7 100644 --- a/gooddata-api-client/docs/models/AfmIdentifier.md +++ b/gooddata-api-client/docs/models/AfmIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm_identifier.AfmIdentifier +# gooddata_api_client.models.afm_identifier.AfmIdentifier ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [AfmLocalIdentifier](AfmLocalIdentifier.md) | [**AfmLocalIdentifier**](AfmLocalIdentifier.md) | [**AfmLocalIdentifier**](AfmLocalIdentifier.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AfmLocalIdentifier.md b/gooddata-api-client/docs/models/AfmLocalIdentifier.md index f2abf9e5e..299c6569e 100644 --- a/gooddata-api-client/docs/models/AfmLocalIdentifier.md +++ b/gooddata-api-client/docs/models/AfmLocalIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm_local_identifier.AfmLocalIdentifier +# gooddata_api_client.models.afm_local_identifier.AfmLocalIdentifier ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AfmObjectIdentifier.md b/gooddata-api-client/docs/models/AfmObjectIdentifier.md index 626cb4062..878a2373c 100644 --- a/gooddata-api-client/docs/models/AfmObjectIdentifier.md +++ b/gooddata-api-client/docs/models/AfmObjectIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm_object_identifier.AfmObjectIdentifier +# gooddata_api_client.models.afm_object_identifier.AfmObjectIdentifier ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers. @@ -28,4 +28,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AfmObjectIdentifierAttribute.md b/gooddata-api-client/docs/models/AfmObjectIdentifierAttribute.md index e0ecd001a..4d0595e60 100644 --- a/gooddata-api-client/docs/models/AfmObjectIdentifierAttribute.md +++ b/gooddata-api-client/docs/models/AfmObjectIdentifierAttribute.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm_object_identifier_attribute.AfmObjectIdentifierAttribute +# gooddata_api_client.models.afm_object_identifier_attribute.AfmObjectIdentifierAttribute ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -26,4 +26,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AfmObjectIdentifierCore.md b/gooddata-api-client/docs/models/AfmObjectIdentifierCore.md index 963980695..1eebf07cb 100644 --- a/gooddata-api-client/docs/models/AfmObjectIdentifierCore.md +++ b/gooddata-api-client/docs/models/AfmObjectIdentifierCore.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm_object_identifier_core.AfmObjectIdentifierCore +# gooddata_api_client.models.afm_object_identifier_core.AfmObjectIdentifierCore ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -26,4 +26,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AfmObjectIdentifierDataset.md b/gooddata-api-client/docs/models/AfmObjectIdentifierDataset.md index 545e0f2bc..fe3f597bb 100644 --- a/gooddata-api-client/docs/models/AfmObjectIdentifierDataset.md +++ b/gooddata-api-client/docs/models/AfmObjectIdentifierDataset.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm_object_identifier_dataset.AfmObjectIdentifierDataset +# gooddata_api_client.models.afm_object_identifier_dataset.AfmObjectIdentifierDataset ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -26,4 +26,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AfmObjectIdentifierLabel.md b/gooddata-api-client/docs/models/AfmObjectIdentifierLabel.md index d3ace1d04..e80b157fa 100644 --- a/gooddata-api-client/docs/models/AfmObjectIdentifierLabel.md +++ b/gooddata-api-client/docs/models/AfmObjectIdentifierLabel.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm_object_identifier_label.AfmObjectIdentifierLabel +# gooddata_api_client.models.afm_object_identifier_label.AfmObjectIdentifierLabel ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -26,4 +26,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AfmValidObjectsQuery.md b/gooddata-api-client/docs/models/AfmValidObjectsQuery.md index 6758a7aad..a00976d05 100644 --- a/gooddata-api-client/docs/models/AfmValidObjectsQuery.md +++ b/gooddata-api-client/docs/models/AfmValidObjectsQuery.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm_valid_objects_query.AfmValidObjectsQuery +# gooddata_api_client.models.afm_valid_objects_query.AfmValidObjectsQuery Entity holding AFM and list of object types whose validity should be computed. @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | must be one of ["facts", "attributes", "measures", "UNRECOGNIZED", ] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AfmValidObjectsResponse.md b/gooddata-api-client/docs/models/AfmValidObjectsResponse.md index c5b29cf9d..67aab0ff0 100644 --- a/gooddata-api-client/docs/models/AfmValidObjectsResponse.md +++ b/gooddata-api-client/docs/models/AfmValidObjectsResponse.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.afm_valid_objects_response.AfmValidObjectsResponse +# gooddata_api_client.models.afm_valid_objects_response.AfmValidObjectsResponse All objects of specified types valid with respect to given AFM. @@ -26,4 +26,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**RestApiIdentifier**](RestApiIdentifier.md) | [**RestApiIdentifier**](RestApiIdentifier.md) | [**RestApiIdentifier**](RestApiIdentifier.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ApiEntitlement.md b/gooddata-api-client/docs/models/ApiEntitlement.md index c255b9ad9..e363872ac 100644 --- a/gooddata-api-client/docs/models/ApiEntitlement.md +++ b/gooddata-api-client/docs/models/ApiEntitlement.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.api_entitlement.ApiEntitlement +# gooddata_api_client.models.api_entitlement.ApiEntitlement ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ArithmeticMeasureDefinition.md b/gooddata-api-client/docs/models/ArithmeticMeasureDefinition.md index d119b1c7b..eae727f0a 100644 --- a/gooddata-api-client/docs/models/ArithmeticMeasureDefinition.md +++ b/gooddata-api-client/docs/models/ArithmeticMeasureDefinition.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.arithmetic_measure_definition.ArithmeticMeasureDefinition +# gooddata_api_client.models.arithmetic_measure_definition.ArithmeticMeasureDefinition Metric representing arithmetics between metrics. @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**AfmLocalIdentifier**](AfmLocalIdentifier.md) | [**AfmLocalIdentifier**](AfmLocalIdentifier.md) | [**AfmLocalIdentifier**](AfmLocalIdentifier.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AssigneeIdentifier.md b/gooddata-api-client/docs/models/AssigneeIdentifier.md index 6a492b78b..4645589f6 100644 --- a/gooddata-api-client/docs/models/AssigneeIdentifier.md +++ b/gooddata-api-client/docs/models/AssigneeIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.assignee_identifier.AssigneeIdentifier +# gooddata_api_client.models.assignee_identifier.AssigneeIdentifier Identifier of a user or user-group. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AttributeExecutionResultHeader.md b/gooddata-api-client/docs/models/AttributeExecutionResultHeader.md index 027824000..8009cb6db 100644 --- a/gooddata-api-client/docs/models/AttributeExecutionResultHeader.md +++ b/gooddata-api-client/docs/models/AttributeExecutionResultHeader.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.attribute_execution_result_header.AttributeExecutionResultHeader +# gooddata_api_client.models.attribute_execution_result_header.AttributeExecutionResultHeader ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AttributeFilter.md b/gooddata-api-client/docs/models/AttributeFilter.md index f77ffc955..18f2d9312 100644 --- a/gooddata-api-client/docs/models/AttributeFilter.md +++ b/gooddata-api-client/docs/models/AttributeFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.attribute_filter.AttributeFilter +# gooddata_api_client.models.attribute_filter.AttributeFilter Abstract filter definition type attributes @@ -15,4 +15,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [PositiveAttributeFilter](PositiveAttributeFilter.md) | [**PositiveAttributeFilter**](PositiveAttributeFilter.md) | [**PositiveAttributeFilter**](PositiveAttributeFilter.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AttributeFilterElements.md b/gooddata-api-client/docs/models/AttributeFilterElements.md index d3203f39e..dee817b5e 100644 --- a/gooddata-api-client/docs/models/AttributeFilterElements.md +++ b/gooddata-api-client/docs/models/AttributeFilterElements.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.attribute_filter_elements.AttributeFilterElements +# gooddata_api_client.models.attribute_filter_elements.AttributeFilterElements Filter on specific set of label values. @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | Set of label values. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AttributeFormat.md b/gooddata-api-client/docs/models/AttributeFormat.md index 0c1dd920d..8afb9c536 100644 --- a/gooddata-api-client/docs/models/AttributeFormat.md +++ b/gooddata-api-client/docs/models/AttributeFormat.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.attribute_format.AttributeFormat +# gooddata_api_client.models.attribute_format.AttributeFormat ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AttributeHeaderOut.md b/gooddata-api-client/docs/models/AttributeHeaderOut.md index b69c6dc49..6dda4356c 100644 --- a/gooddata-api-client/docs/models/AttributeHeaderOut.md +++ b/gooddata-api-client/docs/models/AttributeHeaderOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.attribute_header_out.AttributeHeaderOut +# gooddata_api_client.models.attribute_header_out.AttributeHeaderOut ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -32,4 +32,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AttributeItem.md b/gooddata-api-client/docs/models/AttributeItem.md index d350f02a3..ea779d1a7 100644 --- a/gooddata-api-client/docs/models/AttributeItem.md +++ b/gooddata-api-client/docs/models/AttributeItem.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.attribute_item.AttributeItem +# gooddata_api_client.models.attribute_item.AttributeItem ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AttributeResultHeader.md b/gooddata-api-client/docs/models/AttributeResultHeader.md index 56dc520d1..df98447ec 100644 --- a/gooddata-api-client/docs/models/AttributeResultHeader.md +++ b/gooddata-api-client/docs/models/AttributeResultHeader.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.attribute_result_header.AttributeResultHeader +# gooddata_api_client.models.attribute_result_header.AttributeResultHeader Header containing the information related to attributes. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/AvailableAssignees.md b/gooddata-api-client/docs/models/AvailableAssignees.md index 91f5a0f89..63c1e3afe 100644 --- a/gooddata-api-client/docs/models/AvailableAssignees.md +++ b/gooddata-api-client/docs/models/AvailableAssignees.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.available_assignees.AvailableAssignees +# gooddata_api_client.models.available_assignees.AvailableAssignees ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -41,4 +41,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**UserAssignee**](UserAssignee.md) | [**UserAssignee**](UserAssignee.md) | [**UserAssignee**](UserAssignee.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ColumnWarning.md b/gooddata-api-client/docs/models/ColumnWarning.md index 368fb47a7..1cc817967 100644 --- a/gooddata-api-client/docs/models/ColumnWarning.md +++ b/gooddata-api-client/docs/models/ColumnWarning.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.column_warning.ColumnWarning +# gooddata_api_client.models.column_warning.ColumnWarning Warning related to single column. @@ -43,4 +43,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ComparisonMeasureValueFilter.md b/gooddata-api-client/docs/models/ComparisonMeasureValueFilter.md index 0f6caaf9b..47432aed1 100644 --- a/gooddata-api-client/docs/models/ComparisonMeasureValueFilter.md +++ b/gooddata-api-client/docs/models/ComparisonMeasureValueFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.comparison_measure_value_filter.ComparisonMeasureValueFilter +# gooddata_api_client.models.comparison_measure_value_filter.ComparisonMeasureValueFilter Filter the result by comparing specified metric to given constant value, using given comparison operator. @@ -31,4 +31,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/CustomLabel.md b/gooddata-api-client/docs/models/CustomLabel.md index 5d5b0c03a..03c362e55 100644 --- a/gooddata-api-client/docs/models/CustomLabel.md +++ b/gooddata-api-client/docs/models/CustomLabel.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.custom_label.CustomLabel +# gooddata_api_client.models.custom_label.CustomLabel Custom label object override. @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/CustomMetric.md b/gooddata-api-client/docs/models/CustomMetric.md index 0465db1d8..88a87d276 100644 --- a/gooddata-api-client/docs/models/CustomMetric.md +++ b/gooddata-api-client/docs/models/CustomMetric.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.custom_metric.CustomMetric +# gooddata_api_client.models.custom_metric.CustomMetric Custom metric object override. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/CustomOverride.md b/gooddata-api-client/docs/models/CustomOverride.md index caa8c836b..fbfb8e5d1 100644 --- a/gooddata-api-client/docs/models/CustomOverride.md +++ b/gooddata-api-client/docs/models/CustomOverride.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.custom_override.CustomOverride +# gooddata_api_client.models.custom_override.CustomOverride Custom cell value overrides (IDs will be replaced with specified values). @@ -43,4 +43,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | [**CustomMetric**](CustomMetric.md) | [**CustomMetric**](CustomMetric.md) | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DashboardPermissions.md b/gooddata-api-client/docs/models/DashboardPermissions.md index d9387cec6..e0999f08a 100644 --- a/gooddata-api-client/docs/models/DashboardPermissions.md +++ b/gooddata-api-client/docs/models/DashboardPermissions.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.dashboard_permissions.DashboardPermissions +# gooddata_api_client.models.dashboard_permissions.DashboardPermissions ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -41,4 +41,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**UserPermission**](UserPermission.md) | [**UserPermission**](UserPermission.md) | [**UserPermission**](UserPermission.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DataColumnLocator.md b/gooddata-api-client/docs/models/DataColumnLocator.md index a897f3804..b7f2d1db5 100644 --- a/gooddata-api-client/docs/models/DataColumnLocator.md +++ b/gooddata-api-client/docs/models/DataColumnLocator.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.data_column_locator.DataColumnLocator +# gooddata_api_client.models.data_column_locator.DataColumnLocator Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified. @@ -28,4 +28,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | str, | str, | any string name can be used but the value must be the correct type Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DataColumnLocators.md b/gooddata-api-client/docs/models/DataColumnLocators.md index 2ecadbe4a..24b8529b8 100644 --- a/gooddata-api-client/docs/models/DataColumnLocators.md +++ b/gooddata-api-client/docs/models/DataColumnLocators.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.data_column_locators.DataColumnLocators +# gooddata_api_client.models.data_column_locators.DataColumnLocators ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -26,4 +26,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | [**DataColumnLocator**](DataColumnLocator.md) | [**DataColumnLocator**](DataColumnLocator.md) | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DataSourceParameter.md b/gooddata-api-client/docs/models/DataSourceParameter.md index 9b404f633..0129da1c4 100644 --- a/gooddata-api-client/docs/models/DataSourceParameter.md +++ b/gooddata-api-client/docs/models/DataSourceParameter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.data_source_parameter.DataSourceParameter +# gooddata_api_client.models.data_source_parameter.DataSourceParameter A parameter for testing data source connection @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DataSourceSchemata.md b/gooddata-api-client/docs/models/DataSourceSchemata.md index a78ef453c..10d00d66c 100644 --- a/gooddata-api-client/docs/models/DataSourceSchemata.md +++ b/gooddata-api-client/docs/models/DataSourceSchemata.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.data_source_schemata.DataSourceSchemata +# gooddata_api_client.models.data_source_schemata.DataSourceSchemata Result of getSchemata. Contains list of available DB schema names. @@ -26,4 +26,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DataSourceTableIdentifier.md b/gooddata-api-client/docs/models/DataSourceTableIdentifier.md index 48df11321..e45d9be58 100644 --- a/gooddata-api-client/docs/models/DataSourceTableIdentifier.md +++ b/gooddata-api-client/docs/models/DataSourceTableIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.data_source_table_identifier.DataSourceTableIdentifier +# gooddata_api_client.models.data_source_table_identifier.DataSourceTableIdentifier An id of the table from PDM mapped to this dataset. Including ID of data source. @@ -16,4 +16,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DatasetReferenceIdentifier.md b/gooddata-api-client/docs/models/DatasetReferenceIdentifier.md index 4bf283280..dc8dd18c8 100644 --- a/gooddata-api-client/docs/models/DatasetReferenceIdentifier.md +++ b/gooddata-api-client/docs/models/DatasetReferenceIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.dataset_reference_identifier.DatasetReferenceIdentifier +# gooddata_api_client.models.dataset_reference_identifier.DatasetReferenceIdentifier ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DateFilter.md b/gooddata-api-client/docs/models/DateFilter.md index 001f7d85d..38d34c8f7 100644 --- a/gooddata-api-client/docs/models/DateFilter.md +++ b/gooddata-api-client/docs/models/DateFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.date_filter.DateFilter +# gooddata_api_client.models.date_filter.DateFilter Abstract filter definition type for dates @@ -15,4 +15,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [RelativeDateFilter](RelativeDateFilter.md) | [**RelativeDateFilter**](RelativeDateFilter.md) | [**RelativeDateFilter**](RelativeDateFilter.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboard.md b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboard.md index a8769a7c2..7fb603e55 100644 --- a/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboard.md +++ b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboard.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_analytical_dashboard.DeclarativeAnalyticalDashboard +# gooddata_api_client.models.declarative_analytical_dashboard.DeclarativeAnalyticalDashboard ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | A list of tags. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardExtension.md b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardExtension.md index ff7b391dc..c24e3b93d 100644 --- a/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardExtension.md +++ b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardExtension.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_analytical_dashboard_extension.DeclarativeAnalyticalDashboardExtension +# gooddata_api_client.models.declarative_analytical_dashboard_extension.DeclarativeAnalyticalDashboardExtension ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeAnalyticalDashboardPermission**](DeclarativeAnalyticalDashboardPermission.md) | [**DeclarativeAnalyticalDashboardPermission**](DeclarativeAnalyticalDashboardPermission.md) | [**DeclarativeAnalyticalDashboardPermission**](DeclarativeAnalyticalDashboardPermission.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermission.md b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermission.md index 7ab8769e5..7495734e2 100644 --- a/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermission.md +++ b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermission.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_analytical_dashboard_permission.DeclarativeAnalyticalDashboardPermission +# gooddata_api_client.models.declarative_analytical_dashboard_permission.DeclarativeAnalyticalDashboardPermission Analytical dashboard permission. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeAnalytics.md b/gooddata-api-client/docs/models/DeclarativeAnalytics.md index 5dbd4f7af..bf5da28ca 100644 --- a/gooddata-api-client/docs/models/DeclarativeAnalytics.md +++ b/gooddata-api-client/docs/models/DeclarativeAnalytics.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_analytics.DeclarativeAnalytics +# gooddata_api_client.models.declarative_analytics.DeclarativeAnalytics Entities describing users' view on data. @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeAnalyticsLayer.md b/gooddata-api-client/docs/models/DeclarativeAnalyticsLayer.md index 29021821a..182103feb 100644 --- a/gooddata-api-client/docs/models/DeclarativeAnalyticsLayer.md +++ b/gooddata-api-client/docs/models/DeclarativeAnalyticsLayer.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_analytics_layer.DeclarativeAnalyticsLayer +# gooddata_api_client.models.declarative_analytics_layer.DeclarativeAnalyticsLayer ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -101,4 +101,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeVisualizationObject**](DeclarativeVisualizationObject.md) | [**DeclarativeVisualizationObject**](DeclarativeVisualizationObject.md) | [**DeclarativeVisualizationObject**](DeclarativeVisualizationObject.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeAttribute.md b/gooddata-api-client/docs/models/DeclarativeAttribute.md index 4e9198328..652cf7c78 100644 --- a/gooddata-api-client/docs/models/DeclarativeAttribute.md +++ b/gooddata-api-client/docs/models/DeclarativeAttribute.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_attribute.DeclarativeAttribute +# gooddata_api_client.models.declarative_attribute.DeclarativeAttribute A dataset attribute. @@ -51,4 +51,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | A list of tags. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeColorPalette.md b/gooddata-api-client/docs/models/DeclarativeColorPalette.md index 13c9d99d5..d8e763220 100644 --- a/gooddata-api-client/docs/models/DeclarativeColorPalette.md +++ b/gooddata-api-client/docs/models/DeclarativeColorPalette.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_color_palette.DeclarativeColorPalette +# gooddata_api_client.models.declarative_color_palette.DeclarativeColorPalette Color palette and its properties. @@ -25,4 +25,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | Custom setting content in JSON format. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeColumn.md b/gooddata-api-client/docs/models/DeclarativeColumn.md index 6d4ee0460..509901d96 100644 --- a/gooddata-api-client/docs/models/DeclarativeColumn.md +++ b/gooddata-api-client/docs/models/DeclarativeColumn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_column.DeclarativeColumn +# gooddata_api_client.models.declarative_column.DeclarativeColumn A table column. @@ -18,4 +18,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeCspDirective.md b/gooddata-api-client/docs/models/DeclarativeCspDirective.md index f5a1f593d..9aee198c2 100644 --- a/gooddata-api-client/docs/models/DeclarativeCspDirective.md +++ b/gooddata-api-client/docs/models/DeclarativeCspDirective.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_csp_directive.DeclarativeCspDirective +# gooddata_api_client.models.declarative_csp_directive.DeclarativeCspDirective ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -25,4 +25,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeCustomApplicationSetting.md b/gooddata-api-client/docs/models/DeclarativeCustomApplicationSetting.md index 7cc32733d..5d5e36f90 100644 --- a/gooddata-api-client/docs/models/DeclarativeCustomApplicationSetting.md +++ b/gooddata-api-client/docs/models/DeclarativeCustomApplicationSetting.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_custom_application_setting.DeclarativeCustomApplicationSetting +# gooddata_api_client.models.declarative_custom_application_setting.DeclarativeCustomApplicationSetting Custom application setting and its value. @@ -25,4 +25,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | Custom setting content in JSON format. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeDashboardPlugin.md b/gooddata-api-client/docs/models/DeclarativeDashboardPlugin.md index d1bc196a5..69e1fce67 100644 --- a/gooddata-api-client/docs/models/DeclarativeDashboardPlugin.md +++ b/gooddata-api-client/docs/models/DeclarativeDashboardPlugin.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_dashboard_plugin.DeclarativeDashboardPlugin +# gooddata_api_client.models.declarative_dashboard_plugin.DeclarativeDashboardPlugin ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -39,4 +39,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | A list of tags. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeDataSource.md b/gooddata-api-client/docs/models/DeclarativeDataSource.md index 6cf64f904..caf6b1344 100644 --- a/gooddata-api-client/docs/models/DeclarativeDataSource.md +++ b/gooddata-api-client/docs/models/DeclarativeDataSource.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_data_source.DeclarativeDataSource +# gooddata_api_client.models.declarative_data_source.DeclarativeDataSource A data source and its properties. @@ -77,4 +77,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeDataSourcePermission**](DeclarativeDataSourcePermission.md) | [**DeclarativeDataSourcePermission**](DeclarativeDataSourcePermission.md) | [**DeclarativeDataSourcePermission**](DeclarativeDataSourcePermission.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeDataSourcePermission.md b/gooddata-api-client/docs/models/DeclarativeDataSourcePermission.md index 0ee85205d..04512e490 100644 --- a/gooddata-api-client/docs/models/DeclarativeDataSourcePermission.md +++ b/gooddata-api-client/docs/models/DeclarativeDataSourcePermission.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_data_source_permission.DeclarativeDataSourcePermission +# gooddata_api_client.models.declarative_data_source_permission.DeclarativeDataSourcePermission ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeDataSources.md b/gooddata-api-client/docs/models/DeclarativeDataSources.md index e771e94a6..f8ddc094d 100644 --- a/gooddata-api-client/docs/models/DeclarativeDataSources.md +++ b/gooddata-api-client/docs/models/DeclarativeDataSources.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_data_sources.DeclarativeDataSources +# gooddata_api_client.models.declarative_data_sources.DeclarativeDataSources A data source and its properties. @@ -26,4 +26,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeDataSource**](DeclarativeDataSource.md) | [**DeclarativeDataSource**](DeclarativeDataSource.md) | [**DeclarativeDataSource**](DeclarativeDataSource.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeDataset.md b/gooddata-api-client/docs/models/DeclarativeDataset.md index fefeb201b..6b3124d9e 100644 --- a/gooddata-api-client/docs/models/DeclarativeDataset.md +++ b/gooddata-api-client/docs/models/DeclarativeDataset.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_dataset.DeclarativeDataset +# gooddata_api_client.models.declarative_dataset.DeclarativeDataset A dataset defined by its properties. @@ -108,4 +108,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeWorkspaceDataFilterColumn**](DeclarativeWorkspaceDataFilterColumn.md) | [**DeclarativeWorkspaceDataFilterColumn**](DeclarativeWorkspaceDataFilterColumn.md) | [**DeclarativeWorkspaceDataFilterColumn**](DeclarativeWorkspaceDataFilterColumn.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeDatasetSql.md b/gooddata-api-client/docs/models/DeclarativeDatasetSql.md index 192393b83..174b1b522 100644 --- a/gooddata-api-client/docs/models/DeclarativeDatasetSql.md +++ b/gooddata-api-client/docs/models/DeclarativeDatasetSql.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_dataset_sql.DeclarativeDatasetSql +# gooddata_api_client.models.declarative_dataset_sql.DeclarativeDatasetSql SQL defining this dataset. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeDateDataset.md b/gooddata-api-client/docs/models/DeclarativeDateDataset.md index bc35ffeb9..ebe3a3f28 100644 --- a/gooddata-api-client/docs/models/DeclarativeDateDataset.md +++ b/gooddata-api-client/docs/models/DeclarativeDateDataset.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_date_dataset.DeclarativeDateDataset +# gooddata_api_client.models.declarative_date_dataset.DeclarativeDateDataset A date dataset. @@ -47,4 +47,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | A list of tags. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeFact.md b/gooddata-api-client/docs/models/DeclarativeFact.md index 9f3fac8c3..03139e2dd 100644 --- a/gooddata-api-client/docs/models/DeclarativeFact.md +++ b/gooddata-api-client/docs/models/DeclarativeFact.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_fact.DeclarativeFact +# gooddata_api_client.models.declarative_fact.DeclarativeFact A dataset fact. @@ -33,4 +33,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | A list of tags. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeFilterContext.md b/gooddata-api-client/docs/models/DeclarativeFilterContext.md index b488e7aa8..fcedeabb8 100644 --- a/gooddata-api-client/docs/models/DeclarativeFilterContext.md +++ b/gooddata-api-client/docs/models/DeclarativeFilterContext.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_filter_context.DeclarativeFilterContext +# gooddata_api_client.models.declarative_filter_context.DeclarativeFilterContext ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -39,4 +39,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | A list of tags. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeLabel.md b/gooddata-api-client/docs/models/DeclarativeLabel.md index 0db653ee8..45612765d 100644 --- a/gooddata-api-client/docs/models/DeclarativeLabel.md +++ b/gooddata-api-client/docs/models/DeclarativeLabel.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_label.DeclarativeLabel +# gooddata_api_client.models.declarative_label.DeclarativeLabel A attribute label. @@ -34,4 +34,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | A list of tags. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeLdm.md b/gooddata-api-client/docs/models/DeclarativeLdm.md index 4fc591c84..a32efbc90 100644 --- a/gooddata-api-client/docs/models/DeclarativeLdm.md +++ b/gooddata-api-client/docs/models/DeclarativeLdm.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_ldm.DeclarativeLdm +# gooddata_api_client.models.declarative_ldm.DeclarativeLdm A logical data model (LDM) representation. @@ -43,4 +43,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeDateDataset**](DeclarativeDateDataset.md) | [**DeclarativeDateDataset**](DeclarativeDateDataset.md) | [**DeclarativeDateDataset**](DeclarativeDateDataset.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeMetric.md b/gooddata-api-client/docs/models/DeclarativeMetric.md index dc33d03cd..dc8489505 100644 --- a/gooddata-api-client/docs/models/DeclarativeMetric.md +++ b/gooddata-api-client/docs/models/DeclarativeMetric.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_metric.DeclarativeMetric +# gooddata_api_client.models.declarative_metric.DeclarativeMetric ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -39,4 +39,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | A list of tags. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeModel.md b/gooddata-api-client/docs/models/DeclarativeModel.md index 0ab9d38d4..f8ee51b04 100644 --- a/gooddata-api-client/docs/models/DeclarativeModel.md +++ b/gooddata-api-client/docs/models/DeclarativeModel.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_model.DeclarativeModel +# gooddata_api_client.models.declarative_model.DeclarativeModel A data model structured as a set of its attributes. @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeOrganization.md b/gooddata-api-client/docs/models/DeclarativeOrganization.md index 208b2ac7e..84904d999 100644 --- a/gooddata-api-client/docs/models/DeclarativeOrganization.md +++ b/gooddata-api-client/docs/models/DeclarativeOrganization.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_organization.DeclarativeOrganization +# gooddata_api_client.models.declarative_organization.DeclarativeOrganization Complete definition of an organization in a declarative form. @@ -79,4 +79,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeWorkspace**](DeclarativeWorkspace.md) | [**DeclarativeWorkspace**](DeclarativeWorkspace.md) | [**DeclarativeWorkspace**](DeclarativeWorkspace.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeOrganizationInfo.md b/gooddata-api-client/docs/models/DeclarativeOrganizationInfo.md index 7a3233fe4..37f70a5d9 100644 --- a/gooddata-api-client/docs/models/DeclarativeOrganizationInfo.md +++ b/gooddata-api-client/docs/models/DeclarativeOrganizationInfo.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_organization_info.DeclarativeOrganizationInfo +# gooddata_api_client.models.declarative_organization_info.DeclarativeOrganizationInfo Information available about an organization. @@ -94,4 +94,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeTheme**](DeclarativeTheme.md) | [**DeclarativeTheme**](DeclarativeTheme.md) | [**DeclarativeTheme**](DeclarativeTheme.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeOrganizationPermission.md b/gooddata-api-client/docs/models/DeclarativeOrganizationPermission.md index 176144869..0e820122c 100644 --- a/gooddata-api-client/docs/models/DeclarativeOrganizationPermission.md +++ b/gooddata-api-client/docs/models/DeclarativeOrganizationPermission.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_organization_permission.DeclarativeOrganizationPermission +# gooddata_api_client.models.declarative_organization_permission.DeclarativeOrganizationPermission Definition of an organization permission assigned to a user/user-group. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativePdm.md b/gooddata-api-client/docs/models/DeclarativePdm.md index 95a041f34..17a09779d 100644 --- a/gooddata-api-client/docs/models/DeclarativePdm.md +++ b/gooddata-api-client/docs/models/DeclarativePdm.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_pdm.DeclarativePdm +# gooddata_api_client.models.declarative_pdm.DeclarativePdm A physical data model (PDM) representation for single data source. @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeReference.md b/gooddata-api-client/docs/models/DeclarativeReference.md index e788d4633..7ce501b50 100644 --- a/gooddata-api-client/docs/models/DeclarativeReference.md +++ b/gooddata-api-client/docs/models/DeclarativeReference.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_reference.DeclarativeReference +# gooddata_api_client.models.declarative_reference.DeclarativeReference A dataset reference. @@ -45,4 +45,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeSetting.md b/gooddata-api-client/docs/models/DeclarativeSetting.md index 9ad5b19b0..c13e55cda 100644 --- a/gooddata-api-client/docs/models/DeclarativeSetting.md +++ b/gooddata-api-client/docs/models/DeclarativeSetting.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_setting.DeclarativeSetting +# gooddata_api_client.models.declarative_setting.DeclarativeSetting Setting and its value. @@ -25,4 +25,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | Custom setting content in JSON format. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeSingleWorkspacePermission.md b/gooddata-api-client/docs/models/DeclarativeSingleWorkspacePermission.md index 08f768526..b8761fd77 100644 --- a/gooddata-api-client/docs/models/DeclarativeSingleWorkspacePermission.md +++ b/gooddata-api-client/docs/models/DeclarativeSingleWorkspacePermission.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_single_workspace_permission.DeclarativeSingleWorkspacePermission +# gooddata_api_client.models.declarative_single_workspace_permission.DeclarativeSingleWorkspacePermission ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeTable.md b/gooddata-api-client/docs/models/DeclarativeTable.md index 992cf6008..e3977cc0a 100644 --- a/gooddata-api-client/docs/models/DeclarativeTable.md +++ b/gooddata-api-client/docs/models/DeclarativeTable.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_table.DeclarativeTable +# gooddata_api_client.models.declarative_table.DeclarativeTable A database table. @@ -46,4 +46,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeTables.md b/gooddata-api-client/docs/models/DeclarativeTables.md index 1f5013f4d..8797914a7 100644 --- a/gooddata-api-client/docs/models/DeclarativeTables.md +++ b/gooddata-api-client/docs/models/DeclarativeTables.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_tables.DeclarativeTables +# gooddata_api_client.models.declarative_tables.DeclarativeTables A physical data model (PDM) tables. @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeTable**](DeclarativeTable.md) | [**DeclarativeTable**](DeclarativeTable.md) | [**DeclarativeTable**](DeclarativeTable.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeTheme.md b/gooddata-api-client/docs/models/DeclarativeTheme.md index 400414c54..f0c57f331 100644 --- a/gooddata-api-client/docs/models/DeclarativeTheme.md +++ b/gooddata-api-client/docs/models/DeclarativeTheme.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_theme.DeclarativeTheme +# gooddata_api_client.models.declarative_theme.DeclarativeTheme Theme and its properties. @@ -25,4 +25,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | Custom setting content in JSON format. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUser.md b/gooddata-api-client/docs/models/DeclarativeUser.md index 0f657724a..869850e4d 100644 --- a/gooddata-api-client/docs/models/DeclarativeUser.md +++ b/gooddata-api-client/docs/models/DeclarativeUser.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_user.DeclarativeUser +# gooddata_api_client.models.declarative_user.DeclarativeUser A user and its properties @@ -59,4 +59,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**UserGroupIdentifier**](UserGroupIdentifier.md) | [**UserGroupIdentifier**](UserGroupIdentifier.md) | [**UserGroupIdentifier**](UserGroupIdentifier.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUserDataFilter.md b/gooddata-api-client/docs/models/DeclarativeUserDataFilter.md index 70d8a7fe8..bd8244930 100644 --- a/gooddata-api-client/docs/models/DeclarativeUserDataFilter.md +++ b/gooddata-api-client/docs/models/DeclarativeUserDataFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_user_data_filter.DeclarativeUserDataFilter +# gooddata_api_client.models.declarative_user_data_filter.DeclarativeUserDataFilter User Data Filters serving the filtering of what data users can see in workspaces. @@ -34,4 +34,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | A list of tags. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUserDataFilters.md b/gooddata-api-client/docs/models/DeclarativeUserDataFilters.md index e7cb8d01c..cbafd932f 100644 --- a/gooddata-api-client/docs/models/DeclarativeUserDataFilters.md +++ b/gooddata-api-client/docs/models/DeclarativeUserDataFilters.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_user_data_filters.DeclarativeUserDataFilters +# gooddata_api_client.models.declarative_user_data_filters.DeclarativeUserDataFilters Declarative form of user data filters. @@ -26,4 +26,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeUserDataFilter**](DeclarativeUserDataFilter.md) | [**DeclarativeUserDataFilter**](DeclarativeUserDataFilter.md) | [**DeclarativeUserDataFilter**](DeclarativeUserDataFilter.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUserGroup.md b/gooddata-api-client/docs/models/DeclarativeUserGroup.md index c296dfe69..8b8ff12b8 100644 --- a/gooddata-api-client/docs/models/DeclarativeUserGroup.md +++ b/gooddata-api-client/docs/models/DeclarativeUserGroup.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_user_group.DeclarativeUserGroup +# gooddata_api_client.models.declarative_user_group.DeclarativeUserGroup A user-group and its properties @@ -41,4 +41,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeUserGroupPermission**](DeclarativeUserGroupPermission.md) | [**DeclarativeUserGroupPermission**](DeclarativeUserGroupPermission.md) | [**DeclarativeUserGroupPermission**](DeclarativeUserGroupPermission.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUserGroupIdentifier.md b/gooddata-api-client/docs/models/DeclarativeUserGroupIdentifier.md index ca3118b6e..5afd75dad 100644 --- a/gooddata-api-client/docs/models/DeclarativeUserGroupIdentifier.md +++ b/gooddata-api-client/docs/models/DeclarativeUserGroupIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_user_group_identifier.DeclarativeUserGroupIdentifier +# gooddata_api_client.models.declarative_user_group_identifier.DeclarativeUserGroupIdentifier A user group identifier. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUserGroupPermission.md b/gooddata-api-client/docs/models/DeclarativeUserGroupPermission.md index da9c6bb96..7a584213f 100644 --- a/gooddata-api-client/docs/models/DeclarativeUserGroupPermission.md +++ b/gooddata-api-client/docs/models/DeclarativeUserGroupPermission.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_user_group_permission.DeclarativeUserGroupPermission +# gooddata_api_client.models.declarative_user_group_permission.DeclarativeUserGroupPermission Definition of a user-group permission assigned to a user/user-group. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUserGroupPermissions.md b/gooddata-api-client/docs/models/DeclarativeUserGroupPermissions.md index 0b91803e7..eed52cba6 100644 --- a/gooddata-api-client/docs/models/DeclarativeUserGroupPermissions.md +++ b/gooddata-api-client/docs/models/DeclarativeUserGroupPermissions.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_user_group_permissions.DeclarativeUserGroupPermissions +# gooddata_api_client.models.declarative_user_group_permissions.DeclarativeUserGroupPermissions Definition of permissions associated with a user-group. @@ -26,4 +26,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeUserGroupPermission**](DeclarativeUserGroupPermission.md) | [**DeclarativeUserGroupPermission**](DeclarativeUserGroupPermission.md) | [**DeclarativeUserGroupPermission**](DeclarativeUserGroupPermission.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUserGroups.md b/gooddata-api-client/docs/models/DeclarativeUserGroups.md index cc3da1cc8..4880dae6c 100644 --- a/gooddata-api-client/docs/models/DeclarativeUserGroups.md +++ b/gooddata-api-client/docs/models/DeclarativeUserGroups.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_user_groups.DeclarativeUserGroups +# gooddata_api_client.models.declarative_user_groups.DeclarativeUserGroups Declarative form of userGroups and its properties. @@ -26,4 +26,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeUserGroup**](DeclarativeUserGroup.md) | [**DeclarativeUserGroup**](DeclarativeUserGroup.md) | [**DeclarativeUserGroup**](DeclarativeUserGroup.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUserPermission.md b/gooddata-api-client/docs/models/DeclarativeUserPermission.md index 889cf9b54..1151aa160 100644 --- a/gooddata-api-client/docs/models/DeclarativeUserPermission.md +++ b/gooddata-api-client/docs/models/DeclarativeUserPermission.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_user_permission.DeclarativeUserPermission +# gooddata_api_client.models.declarative_user_permission.DeclarativeUserPermission Definition of a user permission assigned to a user/user-group. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUserPermissions.md b/gooddata-api-client/docs/models/DeclarativeUserPermissions.md index fbeeee846..b91979f68 100644 --- a/gooddata-api-client/docs/models/DeclarativeUserPermissions.md +++ b/gooddata-api-client/docs/models/DeclarativeUserPermissions.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_user_permissions.DeclarativeUserPermissions +# gooddata_api_client.models.declarative_user_permissions.DeclarativeUserPermissions Definition of permissions associated with a user. @@ -26,4 +26,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeUserPermission**](DeclarativeUserPermission.md) | [**DeclarativeUserPermission**](DeclarativeUserPermission.md) | [**DeclarativeUserPermission**](DeclarativeUserPermission.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUsers.md b/gooddata-api-client/docs/models/DeclarativeUsers.md index 57682dc4c..2629d4fcc 100644 --- a/gooddata-api-client/docs/models/DeclarativeUsers.md +++ b/gooddata-api-client/docs/models/DeclarativeUsers.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_users.DeclarativeUsers +# gooddata_api_client.models.declarative_users.DeclarativeUsers Declarative form of users and its properties. @@ -26,4 +26,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeUser**](DeclarativeUser.md) | [**DeclarativeUser**](DeclarativeUser.md) | [**DeclarativeUser**](DeclarativeUser.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeUsersUserGroups.md b/gooddata-api-client/docs/models/DeclarativeUsersUserGroups.md index 73a169ae9..c31b1c977 100644 --- a/gooddata-api-client/docs/models/DeclarativeUsersUserGroups.md +++ b/gooddata-api-client/docs/models/DeclarativeUsersUserGroups.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_users_user_groups.DeclarativeUsersUserGroups +# gooddata_api_client.models.declarative_users_user_groups.DeclarativeUsersUserGroups Declarative form of both users and user groups and theirs properties. @@ -39,4 +39,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeUser**](DeclarativeUser.md) | [**DeclarativeUser**](DeclarativeUser.md) | [**DeclarativeUser**](DeclarativeUser.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeVisualizationObject.md b/gooddata-api-client/docs/models/DeclarativeVisualizationObject.md index 3ca12e46f..b68bf3e73 100644 --- a/gooddata-api-client/docs/models/DeclarativeVisualizationObject.md +++ b/gooddata-api-client/docs/models/DeclarativeVisualizationObject.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_visualization_object.DeclarativeVisualizationObject +# gooddata_api_client.models.declarative_visualization_object.DeclarativeVisualizationObject ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -39,4 +39,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | A list of tags. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeWorkspace.md b/gooddata-api-client/docs/models/DeclarativeWorkspace.md index 6797abe7b..4d00b5d72 100644 --- a/gooddata-api-client/docs/models/DeclarativeWorkspace.md +++ b/gooddata-api-client/docs/models/DeclarativeWorkspace.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_workspace.DeclarativeWorkspace +# gooddata_api_client.models.declarative_workspace.DeclarativeWorkspace A declarative form of a particular workspace. @@ -91,4 +91,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeUserDataFilter**](DeclarativeUserDataFilter.md) | [**DeclarativeUserDataFilter**](DeclarativeUserDataFilter.md) | [**DeclarativeUserDataFilter**](DeclarativeUserDataFilter.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilter.md b/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilter.md index 817868562..6a65bbab1 100644 --- a/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilter.md +++ b/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_workspace_data_filter.DeclarativeWorkspaceDataFilter +# gooddata_api_client.models.declarative_workspace_data_filter.DeclarativeWorkspaceDataFilter Workspace Data Filters serving the filtering of what data users can see in workspaces. @@ -33,4 +33,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeWorkspaceDataFilterSetting**](DeclarativeWorkspaceDataFilterSetting.md) | [**DeclarativeWorkspaceDataFilterSetting**](DeclarativeWorkspaceDataFilterSetting.md) | [**DeclarativeWorkspaceDataFilterSetting**](DeclarativeWorkspaceDataFilterSetting.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilterColumn.md b/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilterColumn.md index 0997192f2..e718ffe8a 100644 --- a/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilterColumn.md +++ b/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilterColumn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_workspace_data_filter_column.DeclarativeWorkspaceDataFilterColumn +# gooddata_api_client.models.declarative_workspace_data_filter_column.DeclarativeWorkspaceDataFilterColumn ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilterSetting.md b/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilterSetting.md index 5e21a55aa..a0d4c4893 100644 --- a/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilterSetting.md +++ b/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilterSetting.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_workspace_data_filter_setting.DeclarativeWorkspaceDataFilterSetting +# gooddata_api_client.models.declarative_workspace_data_filter_setting.DeclarativeWorkspaceDataFilterSetting Workspace Data Filters serving the filtering of what data users can see in workspaces. @@ -32,4 +32,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | Only those rows are returned, where columnName from filter matches those values. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilters.md b/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilters.md index a91c9672d..8f1166353 100644 --- a/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilters.md +++ b/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilters.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_workspace_data_filters.DeclarativeWorkspaceDataFilters +# gooddata_api_client.models.declarative_workspace_data_filters.DeclarativeWorkspaceDataFilters Declarative form of data filters. @@ -26,4 +26,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeWorkspaceDataFilter**](DeclarativeWorkspaceDataFilter.md) | [**DeclarativeWorkspaceDataFilter**](DeclarativeWorkspaceDataFilter.md) | [**DeclarativeWorkspaceDataFilter**](DeclarativeWorkspaceDataFilter.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeWorkspaceHierarchyPermission.md b/gooddata-api-client/docs/models/DeclarativeWorkspaceHierarchyPermission.md index 4c4ff3b7b..0a2174d71 100644 --- a/gooddata-api-client/docs/models/DeclarativeWorkspaceHierarchyPermission.md +++ b/gooddata-api-client/docs/models/DeclarativeWorkspaceHierarchyPermission.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_workspace_hierarchy_permission.DeclarativeWorkspaceHierarchyPermission +# gooddata_api_client.models.declarative_workspace_hierarchy_permission.DeclarativeWorkspaceHierarchyPermission ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeWorkspaceModel.md b/gooddata-api-client/docs/models/DeclarativeWorkspaceModel.md index 277a72738..40d3d888c 100644 --- a/gooddata-api-client/docs/models/DeclarativeWorkspaceModel.md +++ b/gooddata-api-client/docs/models/DeclarativeWorkspaceModel.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_workspace_model.DeclarativeWorkspaceModel +# gooddata_api_client.models.declarative_workspace_model.DeclarativeWorkspaceModel A declarative form of a model and analytics for a workspace. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeWorkspacePermissions.md b/gooddata-api-client/docs/models/DeclarativeWorkspacePermissions.md index 7273b402a..ba7b559f8 100644 --- a/gooddata-api-client/docs/models/DeclarativeWorkspacePermissions.md +++ b/gooddata-api-client/docs/models/DeclarativeWorkspacePermissions.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_workspace_permissions.DeclarativeWorkspacePermissions +# gooddata_api_client.models.declarative_workspace_permissions.DeclarativeWorkspacePermissions Definition of permissions associated with a workspace. @@ -39,4 +39,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeSingleWorkspacePermission**](DeclarativeSingleWorkspacePermission.md) | [**DeclarativeSingleWorkspacePermission**](DeclarativeSingleWorkspacePermission.md) | [**DeclarativeSingleWorkspacePermission**](DeclarativeSingleWorkspacePermission.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DeclarativeWorkspaces.md b/gooddata-api-client/docs/models/DeclarativeWorkspaces.md index b24339a11..2b6fd41df 100644 --- a/gooddata-api-client/docs/models/DeclarativeWorkspaces.md +++ b/gooddata-api-client/docs/models/DeclarativeWorkspaces.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.declarative_workspaces.DeclarativeWorkspaces +# gooddata_api_client.models.declarative_workspaces.DeclarativeWorkspaces A declarative form of a all workspace layout. @@ -39,4 +39,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DeclarativeWorkspace**](DeclarativeWorkspace.md) | [**DeclarativeWorkspace**](DeclarativeWorkspace.md) | [**DeclarativeWorkspace**](DeclarativeWorkspace.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DependentEntitiesGraph.md b/gooddata-api-client/docs/models/DependentEntitiesGraph.md index 06242af75..616063e49 100644 --- a/gooddata-api-client/docs/models/DependentEntitiesGraph.md +++ b/gooddata-api-client/docs/models/DependentEntitiesGraph.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.dependent_entities_graph.DependentEntitiesGraph +# gooddata_api_client.models.dependent_entities_graph.DependentEntitiesGraph ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -49,4 +49,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DependentEntitiesNode**](DependentEntitiesNode.md) | [**DependentEntitiesNode**](DependentEntitiesNode.md) | [**DependentEntitiesNode**](DependentEntitiesNode.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DependentEntitiesNode.md b/gooddata-api-client/docs/models/DependentEntitiesNode.md index 4d22a7616..535963f78 100644 --- a/gooddata-api-client/docs/models/DependentEntitiesNode.md +++ b/gooddata-api-client/docs/models/DependentEntitiesNode.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.dependent_entities_node.DependentEntitiesNode +# gooddata_api_client.models.dependent_entities_node.DependentEntitiesNode ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DependentEntitiesRequest.md b/gooddata-api-client/docs/models/DependentEntitiesRequest.md index ecb32379e..94fd4503f 100644 --- a/gooddata-api-client/docs/models/DependentEntitiesRequest.md +++ b/gooddata-api-client/docs/models/DependentEntitiesRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.dependent_entities_request.DependentEntitiesRequest +# gooddata_api_client.models.dependent_entities_request.DependentEntitiesRequest ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -24,4 +24,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**EntityIdentifier**](EntityIdentifier.md) | [**EntityIdentifier**](EntityIdentifier.md) | [**EntityIdentifier**](EntityIdentifier.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DependentEntitiesResponse.md b/gooddata-api-client/docs/models/DependentEntitiesResponse.md index e90e23fdd..c6e92bea9 100644 --- a/gooddata-api-client/docs/models/DependentEntitiesResponse.md +++ b/gooddata-api-client/docs/models/DependentEntitiesResponse.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.dependent_entities_response.DependentEntitiesResponse +# gooddata_api_client.models.dependent_entities_response.DependentEntitiesResponse ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/Dimension.md b/gooddata-api-client/docs/models/Dimension.md index 75fc2f886..337bbd041 100644 --- a/gooddata-api-client/docs/models/Dimension.md +++ b/gooddata-api-client/docs/models/Dimension.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.dimension.Dimension +# gooddata_api_client.models.dimension.Dimension Single dimension description. @@ -44,4 +44,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**SortKey**](SortKey.md) | [**SortKey**](SortKey.md) | [**SortKey**](SortKey.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/DimensionHeader.md b/gooddata-api-client/docs/models/DimensionHeader.md index fd7cf6f35..c2d111da8 100644 --- a/gooddata-api-client/docs/models/DimensionHeader.md +++ b/gooddata-api-client/docs/models/DimensionHeader.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.dimension_header.DimensionHeader +# gooddata_api_client.models.dimension_header.DimensionHeader Contains the dimension-specific header information. @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**HeaderGroup**](HeaderGroup.md) | [**HeaderGroup**](HeaderGroup.md) | [**HeaderGroup**](HeaderGroup.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/Element.md b/gooddata-api-client/docs/models/Element.md index 1cafcdb4c..c547d7d22 100644 --- a/gooddata-api-client/docs/models/Element.md +++ b/gooddata-api-client/docs/models/Element.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.element.Element +# gooddata_api_client.models.element.Element List of returned elements. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ElementsRequest.md b/gooddata-api-client/docs/models/ElementsRequest.md index dbe8d3f9b..cab0eef75 100644 --- a/gooddata-api-client/docs/models/ElementsRequest.md +++ b/gooddata-api-client/docs/models/ElementsRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.elements_request.ElementsRequest +# gooddata_api_client.models.elements_request.ElementsRequest ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -33,4 +33,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | Return only items, whose ```label``` title exactly matches one of ```filter```. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ElementsResponse.md b/gooddata-api-client/docs/models/ElementsResponse.md index 2af088d7d..94af2552c 100644 --- a/gooddata-api-client/docs/models/ElementsResponse.md +++ b/gooddata-api-client/docs/models/ElementsResponse.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.elements_response.ElementsResponse +# gooddata_api_client.models.elements_response.ElementsResponse Entity holding list of sorted & filtered label elements, related primary label of attribute owning requested label and paging. @@ -32,4 +32,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**Element**](Element.md) | [**Element**](Element.md) | [**Element**](Element.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/EntitlementsRequest.md b/gooddata-api-client/docs/models/EntitlementsRequest.md index 73184dfca..e4f02f42d 100644 --- a/gooddata-api-client/docs/models/EntitlementsRequest.md +++ b/gooddata-api-client/docs/models/EntitlementsRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.entitlements_request.EntitlementsRequest +# gooddata_api_client.models.entitlements_request.EntitlementsRequest ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -24,4 +24,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | must be one of ["Contract", "CustomTheming", "PdfExports", "ManagedOIDC", "UiLocalization", "Tier", "UserCount", "UnlimitedUsers", "UnlimitedWorkspaces", "WhiteLabeling", "WorkspaceCount", ] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/EntityIdentifier.md b/gooddata-api-client/docs/models/EntityIdentifier.md index 7d101c471..cbd4d17ae 100644 --- a/gooddata-api-client/docs/models/EntityIdentifier.md +++ b/gooddata-api-client/docs/models/EntityIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.entity_identifier.EntityIdentifier +# gooddata_api_client.models.entity_identifier.EntityIdentifier ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ExecutionLinks.md b/gooddata-api-client/docs/models/ExecutionLinks.md index 64b5b513c..33e14ac4a 100644 --- a/gooddata-api-client/docs/models/ExecutionLinks.md +++ b/gooddata-api-client/docs/models/ExecutionLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.execution_links.ExecutionLinks +# gooddata_api_client.models.execution_links.ExecutionLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ExecutionResponse.md b/gooddata-api-client/docs/models/ExecutionResponse.md index 684e84b40..bc1ef1feb 100644 --- a/gooddata-api-client/docs/models/ExecutionResponse.md +++ b/gooddata-api-client/docs/models/ExecutionResponse.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.execution_response.ExecutionResponse +# gooddata_api_client.models.execution_response.ExecutionResponse ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -25,4 +25,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**ResultDimension**](ResultDimension.md) | [**ResultDimension**](ResultDimension.md) | [**ResultDimension**](ResultDimension.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ExecutionResult.md b/gooddata-api-client/docs/models/ExecutionResult.md index afdb6762e..f7be41464 100644 --- a/gooddata-api-client/docs/models/ExecutionResult.md +++ b/gooddata-api-client/docs/models/ExecutionResult.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.execution_result.ExecutionResult +# gooddata_api_client.models.execution_result.ExecutionResult Contains the result of an AFM execution. @@ -64,4 +64,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**ExecutionResultGrandTotal**](ExecutionResultGrandTotal.md) | [**ExecutionResultGrandTotal**](ExecutionResultGrandTotal.md) | [**ExecutionResultGrandTotal**](ExecutionResultGrandTotal.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ExecutionResultGrandTotal.md b/gooddata-api-client/docs/models/ExecutionResultGrandTotal.md index 7c968e568..6b0c1ce19 100644 --- a/gooddata-api-client/docs/models/ExecutionResultGrandTotal.md +++ b/gooddata-api-client/docs/models/ExecutionResultGrandTotal.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.execution_result_grand_total.ExecutionResultGrandTotal +# gooddata_api_client.models.execution_result_grand_total.ExecutionResultGrandTotal Contains the data of grand totals with the same dimensions. @@ -65,4 +65,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | Dimensions of the grand totals. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ExecutionResultHeader.md b/gooddata-api-client/docs/models/ExecutionResultHeader.md index 4259475fe..12c8937f2 100644 --- a/gooddata-api-client/docs/models/ExecutionResultHeader.md +++ b/gooddata-api-client/docs/models/ExecutionResultHeader.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.execution_result_header.ExecutionResultHeader +# gooddata_api_client.models.execution_result_header.ExecutionResultHeader Abstract execution result header @@ -16,4 +16,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [TotalExecutionResultHeader](TotalExecutionResultHeader.md) | [**TotalExecutionResultHeader**](TotalExecutionResultHeader.md) | [**TotalExecutionResultHeader**](TotalExecutionResultHeader.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ExecutionResultPaging.md b/gooddata-api-client/docs/models/ExecutionResultPaging.md index 1f2ec739e..1edf1cb4d 100644 --- a/gooddata-api-client/docs/models/ExecutionResultPaging.md +++ b/gooddata-api-client/docs/models/ExecutionResultPaging.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.execution_result_paging.ExecutionResultPaging +# gooddata_api_client.models.execution_result_paging.ExecutionResultPaging A paging information related to the data presented in the execution result. These paging information are multi-dimensional. @@ -58,4 +58,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ExecutionSettings.md b/gooddata-api-client/docs/models/ExecutionSettings.md index ffc5995da..300e2fb9c 100644 --- a/gooddata-api-client/docs/models/ExecutionSettings.md +++ b/gooddata-api-client/docs/models/ExecutionSettings.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.execution_settings.ExecutionSettings +# gooddata_api_client.models.execution_settings.ExecutionSettings Various settings affecting the process of AFM execution or its result @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ExportResponse.md b/gooddata-api-client/docs/models/ExportResponse.md index b779c4c6f..85db6d549 100644 --- a/gooddata-api-client/docs/models/ExportResponse.md +++ b/gooddata-api-client/docs/models/ExportResponse.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.export_response.ExportResponse +# gooddata_api_client.models.export_response.ExportResponse ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/FilterBy.md b/gooddata-api-client/docs/models/FilterBy.md index c67c7354e..78e81c85b 100644 --- a/gooddata-api-client/docs/models/FilterBy.md +++ b/gooddata-api-client/docs/models/FilterBy.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.filter_by.FilterBy +# gooddata_api_client.models.filter_by.FilterBy Specifies what is used for filtering. @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/FilterDefinition.md b/gooddata-api-client/docs/models/FilterDefinition.md index e1fcd732b..a4d1edbd7 100644 --- a/gooddata-api-client/docs/models/FilterDefinition.md +++ b/gooddata-api-client/docs/models/FilterDefinition.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.filter_definition.FilterDefinition +# gooddata_api_client.models.filter_definition.FilterDefinition Abstract filter definition type @@ -21,4 +21,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [PositiveAttributeFilter](PositiveAttributeFilter.md) | [**PositiveAttributeFilter**](PositiveAttributeFilter.md) | [**PositiveAttributeFilter**](PositiveAttributeFilter.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/FilterDefinitionForSimpleMeasure.md b/gooddata-api-client/docs/models/FilterDefinitionForSimpleMeasure.md index 4a942660c..06538a9a7 100644 --- a/gooddata-api-client/docs/models/FilterDefinitionForSimpleMeasure.md +++ b/gooddata-api-client/docs/models/FilterDefinitionForSimpleMeasure.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.filter_definition_for_simple_measure.FilterDefinitionForSimpleMeasure +# gooddata_api_client.models.filter_definition_for_simple_measure.FilterDefinitionForSimpleMeasure Abstract filter definition type for simple metric. @@ -15,4 +15,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [AttributeFilter](AttributeFilter.md) | [**AttributeFilter**](AttributeFilter.md) | [**AttributeFilter**](AttributeFilter.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/GenerateLdmRequest.md b/gooddata-api-client/docs/models/GenerateLdmRequest.md index f8cdef451..611dd6636 100644 --- a/gooddata-api-client/docs/models/GenerateLdmRequest.md +++ b/gooddata-api-client/docs/models/GenerateLdmRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.generate_ldm_request.GenerateLdmRequest +# gooddata_api_client.models.generate_ldm_request.GenerateLdmRequest A request containing all information needed for generation of logical model. @@ -27,4 +27,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/GrainIdentifier.md b/gooddata-api-client/docs/models/GrainIdentifier.md index 7b0d0fa44..df3f846a2 100644 --- a/gooddata-api-client/docs/models/GrainIdentifier.md +++ b/gooddata-api-client/docs/models/GrainIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.grain_identifier.GrainIdentifier +# gooddata_api_client.models.grain_identifier.GrainIdentifier A grain identifier. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/GrantedPermission.md b/gooddata-api-client/docs/models/GrantedPermission.md index fd117240b..0c05c9e10 100644 --- a/gooddata-api-client/docs/models/GrantedPermission.md +++ b/gooddata-api-client/docs/models/GrantedPermission.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.granted_permission.GrantedPermission +# gooddata_api_client.models.granted_permission.GrantedPermission Permissions granted to the user group @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/GranularitiesFormatting.md b/gooddata-api-client/docs/models/GranularitiesFormatting.md index a1da525e9..c2f938c29 100644 --- a/gooddata-api-client/docs/models/GranularitiesFormatting.md +++ b/gooddata-api-client/docs/models/GranularitiesFormatting.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.granularities_formatting.GranularitiesFormatting +# gooddata_api_client.models.granularities_formatting.GranularitiesFormatting A date dataset granularities title formatting rules. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/HeaderGroup.md b/gooddata-api-client/docs/models/HeaderGroup.md index bdde0caec..d8f5f491d 100644 --- a/gooddata-api-client/docs/models/HeaderGroup.md +++ b/gooddata-api-client/docs/models/HeaderGroup.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.header_group.HeaderGroup +# gooddata_api_client.models.header_group.HeaderGroup Contains the information specific for a group of headers. These groups correlate to attributes and metric groups. @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**ExecutionResultHeader**](ExecutionResultHeader.md) | [**ExecutionResultHeader**](ExecutionResultHeader.md) | [**ExecutionResultHeader**](ExecutionResultHeader.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/HierarchyObjectIdentification.md b/gooddata-api-client/docs/models/HierarchyObjectIdentification.md index d8fb1c580..ab5b6577d 100644 --- a/gooddata-api-client/docs/models/HierarchyObjectIdentification.md +++ b/gooddata-api-client/docs/models/HierarchyObjectIdentification.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.hierarchy_object_identification.HierarchyObjectIdentification +# gooddata_api_client.models.hierarchy_object_identification.HierarchyObjectIdentification Represents objects with given ID and type in workspace hierarchy (more than one can exists in different workspaces). @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/IdentifierDuplications.md b/gooddata-api-client/docs/models/IdentifierDuplications.md index ad656baf0..e9ac9f89a 100644 --- a/gooddata-api-client/docs/models/IdentifierDuplications.md +++ b/gooddata-api-client/docs/models/IdentifierDuplications.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.identifier_duplications.IdentifierDuplications +# gooddata_api_client.models.identifier_duplications.IdentifierDuplications Contains information about conflicting IDs in workspace hierarchy @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/InlineFilterDefinition.md b/gooddata-api-client/docs/models/InlineFilterDefinition.md index 7d78a6bc6..5b5186952 100644 --- a/gooddata-api-client/docs/models/InlineFilterDefinition.md +++ b/gooddata-api-client/docs/models/InlineFilterDefinition.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.inline_filter_definition.InlineFilterDefinition +# gooddata_api_client.models.inline_filter_definition.InlineFilterDefinition Filter in form of direct MAQL query. @@ -28,4 +28,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/InlineMeasureDefinition.md b/gooddata-api-client/docs/models/InlineMeasureDefinition.md index 59198e905..e905445f6 100644 --- a/gooddata-api-client/docs/models/InlineMeasureDefinition.md +++ b/gooddata-api-client/docs/models/InlineMeasureDefinition.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.inline_measure_definition.InlineMeasureDefinition +# gooddata_api_client.models.inline_measure_definition.InlineMeasureDefinition Metric defined by the raw MAQL query. @@ -27,4 +27,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardIn.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardIn.md index 256f0dddf..cd5352f5f 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardIn.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_in.JsonApiAnalyticalDashboardIn +# gooddata_api_client.models.json_api_analytical_dashboard_in.JsonApiAnalyticalDashboardIn JSON:API representation of analyticalDashboard entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardInDocument.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardInDocument.md index 5651ca799..73f384170 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_in_document.JsonApiAnalyticalDashboardInDocument +# gooddata_api_client.models.json_api_analytical_dashboard_in_document.JsonApiAnalyticalDashboardInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardLinkage.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardLinkage.md index cb2ebe817..9a25baeb8 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_linkage.JsonApiAnalyticalDashboardLinkage +# gooddata_api_client.models.json_api_analytical_dashboard_linkage.JsonApiAnalyticalDashboardLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOut.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOut.md index 665d2884f..fd1fc7591 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOut.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_out.JsonApiAnalyticalDashboardOut +# gooddata_api_client.models.json_api_analytical_dashboard_out.JsonApiAnalyticalDashboardOut JSON:API representation of analyticalDashboard entity. @@ -222,4 +222,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutDocument.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutDocument.md index d3c54eea5..7b8cc449c 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_out_document.JsonApiAnalyticalDashboardOutDocument +# gooddata_api_client.models.json_api_analytical_dashboard_out_document.JsonApiAnalyticalDashboardOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiAnalyticalDashboardOutIncludes**](JsonApiAnalyticalDashboardOutIncludes.md) | [**JsonApiAnalyticalDashboardOutIncludes**](JsonApiAnalyticalDashboardOutIncludes.md) | [**JsonApiAnalyticalDashboardOutIncludes**](JsonApiAnalyticalDashboardOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutIncludes.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutIncludes.md index caa725c5a..087164225 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutIncludes.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutIncludes.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_out_includes.JsonApiAnalyticalDashboardOutIncludes +# gooddata_api_client.models.json_api_analytical_dashboard_out_includes.JsonApiAnalyticalDashboardOutIncludes ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -18,4 +18,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiDashboardPluginOutWithLinks](JsonApiDashboardPluginOutWithLinks.md) | [**JsonApiDashboardPluginOutWithLinks**](JsonApiDashboardPluginOutWithLinks.md) | [**JsonApiDashboardPluginOutWithLinks**](JsonApiDashboardPluginOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutList.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutList.md index dcca0774c..078b73291 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutList.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_out_list.JsonApiAnalyticalDashboardOutList +# gooddata_api_client.models.json_api_analytical_dashboard_out_list.JsonApiAnalyticalDashboardOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiAnalyticalDashboardOutIncludes**](JsonApiAnalyticalDashboardOutIncludes.md) | [**JsonApiAnalyticalDashboardOutIncludes**](JsonApiAnalyticalDashboardOutIncludes.md) | [**JsonApiAnalyticalDashboardOutIncludes**](JsonApiAnalyticalDashboardOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutWithLinks.md index e66968afb..0e4170869 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_out_with_links.JsonApiAnalyticalDashboardOutWithLinks +# gooddata_api_client.models.json_api_analytical_dashboard_out_with_links.JsonApiAnalyticalDashboardOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPatch.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPatch.md index b034f11f3..f1c3e4109 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPatch.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_patch.JsonApiAnalyticalDashboardPatch +# gooddata_api_client.models.json_api_analytical_dashboard_patch.JsonApiAnalyticalDashboardPatch JSON:API representation of patching analyticalDashboard entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPatchDocument.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPatchDocument.md index 6b1ab4313..3f774916e 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_patch_document.JsonApiAnalyticalDashboardPatchDocument +# gooddata_api_client.models.json_api_analytical_dashboard_patch_document.JsonApiAnalyticalDashboardPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPostOptionalId.md index 4611b1953..7e100b313 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPostOptionalId.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPostOptionalId.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id.JsonApiAnalyticalDashboardPostOptionalId +# gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id.JsonApiAnalyticalDashboardPostOptionalId JSON:API representation of analyticalDashboard entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPostOptionalIdDocument.md index fde0e40c8..74d7fb252 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardPostOptionalIdDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document.JsonApiAnalyticalDashboardPostOptionalIdDocument +# gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document.JsonApiAnalyticalDashboardPostOptionalIdDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardToManyLinkage.md index 74446cb78..da27dc003 100644 --- a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardToManyLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardToManyLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_analytical_dashboard_to_many_linkage.JsonApiAnalyticalDashboardToManyLinkage +# gooddata_api_client.models.json_api_analytical_dashboard_to_many_linkage.JsonApiAnalyticalDashboardToManyLinkage References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiAnalyticalDashboardLinkage**](JsonApiAnalyticalDashboardLinkage.md) | [**JsonApiAnalyticalDashboardLinkage**](JsonApiAnalyticalDashboardLinkage.md) | [**JsonApiAnalyticalDashboardLinkage**](JsonApiAnalyticalDashboardLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiApiTokenIn.md b/gooddata-api-client/docs/models/JsonApiApiTokenIn.md index f91083b3f..94a491faf 100644 --- a/gooddata-api-client/docs/models/JsonApiApiTokenIn.md +++ b/gooddata-api-client/docs/models/JsonApiApiTokenIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_api_token_in.JsonApiApiTokenIn +# gooddata_api_client.models.json_api_api_token_in.JsonApiApiTokenIn JSON:API representation of apiToken entity. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiApiTokenInDocument.md b/gooddata-api-client/docs/models/JsonApiApiTokenInDocument.md index 737515c1b..5cf4adf4c 100644 --- a/gooddata-api-client/docs/models/JsonApiApiTokenInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiApiTokenInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_api_token_in_document.JsonApiApiTokenInDocument +# gooddata_api_client.models.json_api_api_token_in_document.JsonApiApiTokenInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiApiTokenOut.md b/gooddata-api-client/docs/models/JsonApiApiTokenOut.md index a1990e4c4..c82392cf4 100644 --- a/gooddata-api-client/docs/models/JsonApiApiTokenOut.md +++ b/gooddata-api-client/docs/models/JsonApiApiTokenOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_api_token_out.JsonApiApiTokenOut +# gooddata_api_client.models.json_api_api_token_out.JsonApiApiTokenOut JSON:API representation of apiToken entity. @@ -29,4 +29,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiApiTokenOutDocument.md b/gooddata-api-client/docs/models/JsonApiApiTokenOutDocument.md index 8c06a5158..a64088134 100644 --- a/gooddata-api-client/docs/models/JsonApiApiTokenOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiApiTokenOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_api_token_out_document.JsonApiApiTokenOutDocument +# gooddata_api_client.models.json_api_api_token_out_document.JsonApiApiTokenOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiApiTokenOutList.md b/gooddata-api-client/docs/models/JsonApiApiTokenOutList.md index 2df023c77..3185161d5 100644 --- a/gooddata-api-client/docs/models/JsonApiApiTokenOutList.md +++ b/gooddata-api-client/docs/models/JsonApiApiTokenOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_api_token_out_list.JsonApiApiTokenOutList +# gooddata_api_client.models.json_api_api_token_out_list.JsonApiApiTokenOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiApiTokenOutWithLinks**](JsonApiApiTokenOutWithLinks.md) | [**JsonApiApiTokenOutWithLinks**](JsonApiApiTokenOutWithLinks.md) | [**JsonApiApiTokenOutWithLinks**](JsonApiApiTokenOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiApiTokenOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiApiTokenOutWithLinks.md index caee508b8..789f17afa 100644 --- a/gooddata-api-client/docs/models/JsonApiApiTokenOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiApiTokenOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_api_token_out_with_links.JsonApiApiTokenOutWithLinks +# gooddata_api_client.models.json_api_api_token_out_with_links.JsonApiApiTokenOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAttributeLinkage.md b/gooddata-api-client/docs/models/JsonApiAttributeLinkage.md index b20cd0dff..ed03b8c17 100644 --- a/gooddata-api-client/docs/models/JsonApiAttributeLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiAttributeLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_attribute_linkage.JsonApiAttributeLinkage +# gooddata_api_client.models.json_api_attribute_linkage.JsonApiAttributeLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAttributeOut.md b/gooddata-api-client/docs/models/JsonApiAttributeOut.md index 9baa34a7c..aaa114751 100644 --- a/gooddata-api-client/docs/models/JsonApiAttributeOut.md +++ b/gooddata-api-client/docs/models/JsonApiAttributeOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_attribute_out.JsonApiAttributeOut +# gooddata_api_client.models.json_api_attribute_out.JsonApiAttributeOut JSON:API representation of attribute entity. @@ -132,4 +132,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAttributeOutDocument.md b/gooddata-api-client/docs/models/JsonApiAttributeOutDocument.md index 567a17f74..926802a46 100644 --- a/gooddata-api-client/docs/models/JsonApiAttributeOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiAttributeOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_attribute_out_document.JsonApiAttributeOutDocument +# gooddata_api_client.models.json_api_attribute_out_document.JsonApiAttributeOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiAttributeOutIncludes**](JsonApiAttributeOutIncludes.md) | [**JsonApiAttributeOutIncludes**](JsonApiAttributeOutIncludes.md) | [**JsonApiAttributeOutIncludes**](JsonApiAttributeOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAttributeOutIncludes.md b/gooddata-api-client/docs/models/JsonApiAttributeOutIncludes.md index 549a27e41..d9ceb7543 100644 --- a/gooddata-api-client/docs/models/JsonApiAttributeOutIncludes.md +++ b/gooddata-api-client/docs/models/JsonApiAttributeOutIncludes.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_attribute_out_includes.JsonApiAttributeOutIncludes +# gooddata_api_client.models.json_api_attribute_out_includes.JsonApiAttributeOutIncludes ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiLabelOutWithLinks](JsonApiLabelOutWithLinks.md) | [**JsonApiLabelOutWithLinks**](JsonApiLabelOutWithLinks.md) | [**JsonApiLabelOutWithLinks**](JsonApiLabelOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAttributeOutList.md b/gooddata-api-client/docs/models/JsonApiAttributeOutList.md index f8a7146a5..b8e035760 100644 --- a/gooddata-api-client/docs/models/JsonApiAttributeOutList.md +++ b/gooddata-api-client/docs/models/JsonApiAttributeOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_attribute_out_list.JsonApiAttributeOutList +# gooddata_api_client.models.json_api_attribute_out_list.JsonApiAttributeOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiAttributeOutIncludes**](JsonApiAttributeOutIncludes.md) | [**JsonApiAttributeOutIncludes**](JsonApiAttributeOutIncludes.md) | [**JsonApiAttributeOutIncludes**](JsonApiAttributeOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAttributeOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiAttributeOutWithLinks.md index 8a0eb8626..452f1dc51 100644 --- a/gooddata-api-client/docs/models/JsonApiAttributeOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiAttributeOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_attribute_out_with_links.JsonApiAttributeOutWithLinks +# gooddata_api_client.models.json_api_attribute_out_with_links.JsonApiAttributeOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAttributeToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiAttributeToManyLinkage.md index d40d814ca..0cb6702b5 100644 --- a/gooddata-api-client/docs/models/JsonApiAttributeToManyLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiAttributeToManyLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_attribute_to_many_linkage.JsonApiAttributeToManyLinkage +# gooddata_api_client.models.json_api_attribute_to_many_linkage.JsonApiAttributeToManyLinkage References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiAttributeLinkage**](JsonApiAttributeLinkage.md) | [**JsonApiAttributeLinkage**](JsonApiAttributeLinkage.md) | [**JsonApiAttributeLinkage**](JsonApiAttributeLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiAttributeToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiAttributeToOneLinkage.md index 0c353e333..ff33baa79 100644 --- a/gooddata-api-client/docs/models/JsonApiAttributeToOneLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiAttributeToOneLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_attribute_to_one_linkage.JsonApiAttributeToOneLinkage +# gooddata_api_client.models.json_api_attribute_to_one_linkage.JsonApiAttributeToOneLinkage References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -14,4 +14,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiAttributeLinkage](JsonApiAttributeLinkage.md) | [**JsonApiAttributeLinkage**](JsonApiAttributeLinkage.md) | [**JsonApiAttributeLinkage**](JsonApiAttributeLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiColorPaletteIn.md b/gooddata-api-client/docs/models/JsonApiColorPaletteIn.md index f908b2371..05b5c9629 100644 --- a/gooddata-api-client/docs/models/JsonApiColorPaletteIn.md +++ b/gooddata-api-client/docs/models/JsonApiColorPaletteIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_color_palette_in.JsonApiColorPaletteIn +# gooddata_api_client.models.json_api_color_palette_in.JsonApiColorPaletteIn JSON:API representation of colorPalette entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiColorPaletteInDocument.md b/gooddata-api-client/docs/models/JsonApiColorPaletteInDocument.md index 028a57886..6e9cecb74 100644 --- a/gooddata-api-client/docs/models/JsonApiColorPaletteInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiColorPaletteInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_color_palette_in_document.JsonApiColorPaletteInDocument +# gooddata_api_client.models.json_api_color_palette_in_document.JsonApiColorPaletteInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiColorPaletteOut.md b/gooddata-api-client/docs/models/JsonApiColorPaletteOut.md index 8ea82ae6c..5190d83a8 100644 --- a/gooddata-api-client/docs/models/JsonApiColorPaletteOut.md +++ b/gooddata-api-client/docs/models/JsonApiColorPaletteOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_color_palette_out.JsonApiColorPaletteOut +# gooddata_api_client.models.json_api_color_palette_out.JsonApiColorPaletteOut JSON:API representation of colorPalette entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiColorPaletteOutDocument.md b/gooddata-api-client/docs/models/JsonApiColorPaletteOutDocument.md index d04e1d8cf..1d174fbe9 100644 --- a/gooddata-api-client/docs/models/JsonApiColorPaletteOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiColorPaletteOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_color_palette_out_document.JsonApiColorPaletteOutDocument +# gooddata_api_client.models.json_api_color_palette_out_document.JsonApiColorPaletteOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiColorPaletteOutList.md b/gooddata-api-client/docs/models/JsonApiColorPaletteOutList.md index be4fb8d61..6b04bd7fa 100644 --- a/gooddata-api-client/docs/models/JsonApiColorPaletteOutList.md +++ b/gooddata-api-client/docs/models/JsonApiColorPaletteOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_color_palette_out_list.JsonApiColorPaletteOutList +# gooddata_api_client.models.json_api_color_palette_out_list.JsonApiColorPaletteOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiColorPaletteOutWithLinks**](JsonApiColorPaletteOutWithLinks.md) | [**JsonApiColorPaletteOutWithLinks**](JsonApiColorPaletteOutWithLinks.md) | [**JsonApiColorPaletteOutWithLinks**](JsonApiColorPaletteOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiColorPaletteOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiColorPaletteOutWithLinks.md index 18291df42..59370713a 100644 --- a/gooddata-api-client/docs/models/JsonApiColorPaletteOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiColorPaletteOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_color_palette_out_with_links.JsonApiColorPaletteOutWithLinks +# gooddata_api_client.models.json_api_color_palette_out_with_links.JsonApiColorPaletteOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiColorPalettePatch.md b/gooddata-api-client/docs/models/JsonApiColorPalettePatch.md index 08acd7e16..c03277de0 100644 --- a/gooddata-api-client/docs/models/JsonApiColorPalettePatch.md +++ b/gooddata-api-client/docs/models/JsonApiColorPalettePatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_color_palette_patch.JsonApiColorPalettePatch +# gooddata_api_client.models.json_api_color_palette_patch.JsonApiColorPalettePatch JSON:API representation of patching colorPalette entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiColorPalettePatchDocument.md b/gooddata-api-client/docs/models/JsonApiColorPalettePatchDocument.md index f75d4ef54..f875c3308 100644 --- a/gooddata-api-client/docs/models/JsonApiColorPalettePatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiColorPalettePatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_color_palette_patch_document.JsonApiColorPalettePatchDocument +# gooddata_api_client.models.json_api_color_palette_patch_document.JsonApiColorPalettePatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationIn.md b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationIn.md index 4fccfe9ad..3877d162b 100644 --- a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationIn.md +++ b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_cookie_security_configuration_in.JsonApiCookieSecurityConfigurationIn +# gooddata_api_client.models.json_api_cookie_security_configuration_in.JsonApiCookieSecurityConfigurationIn JSON:API representation of cookieSecurityConfiguration entity. @@ -30,4 +30,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationInDocument.md b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationInDocument.md index 7db20d3ba..2e7743a2a 100644 --- a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_cookie_security_configuration_in_document.JsonApiCookieSecurityConfigurationInDocument +# gooddata_api_client.models.json_api_cookie_security_configuration_in_document.JsonApiCookieSecurityConfigurationInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationOut.md b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationOut.md index a1e6bc077..7634542a6 100644 --- a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationOut.md +++ b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_cookie_security_configuration_out.JsonApiCookieSecurityConfigurationOut +# gooddata_api_client.models.json_api_cookie_security_configuration_out.JsonApiCookieSecurityConfigurationOut JSON:API representation of cookieSecurityConfiguration entity. @@ -30,4 +30,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationOutDocument.md b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationOutDocument.md index 7ce67adb7..d3c31bc41 100644 --- a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_cookie_security_configuration_out_document.JsonApiCookieSecurityConfigurationOutDocument +# gooddata_api_client.models.json_api_cookie_security_configuration_out_document.JsonApiCookieSecurityConfigurationOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationPatch.md b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationPatch.md index b928a9f54..ca76b326b 100644 --- a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationPatch.md +++ b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_cookie_security_configuration_patch.JsonApiCookieSecurityConfigurationPatch +# gooddata_api_client.models.json_api_cookie_security_configuration_patch.JsonApiCookieSecurityConfigurationPatch JSON:API representation of patching cookieSecurityConfiguration entity. @@ -30,4 +30,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationPatchDocument.md b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationPatchDocument.md index da39f0dfb..c6f277523 100644 --- a/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiCookieSecurityConfigurationPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_cookie_security_configuration_patch_document.JsonApiCookieSecurityConfigurationPatchDocument +# gooddata_api_client.models.json_api_cookie_security_configuration_patch_document.JsonApiCookieSecurityConfigurationPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCspDirectiveIn.md b/gooddata-api-client/docs/models/JsonApiCspDirectiveIn.md index 2e8c3ffe1..47f8c94c8 100644 --- a/gooddata-api-client/docs/models/JsonApiCspDirectiveIn.md +++ b/gooddata-api-client/docs/models/JsonApiCspDirectiveIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_csp_directive_in.JsonApiCspDirectiveIn +# gooddata_api_client.models.json_api_csp_directive_in.JsonApiCspDirectiveIn JSON:API representation of cspDirective entity. @@ -41,4 +41,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCspDirectiveInDocument.md b/gooddata-api-client/docs/models/JsonApiCspDirectiveInDocument.md index a0cea9652..2a3b3138d 100644 --- a/gooddata-api-client/docs/models/JsonApiCspDirectiveInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiCspDirectiveInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_csp_directive_in_document.JsonApiCspDirectiveInDocument +# gooddata_api_client.models.json_api_csp_directive_in_document.JsonApiCspDirectiveInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCspDirectiveOut.md b/gooddata-api-client/docs/models/JsonApiCspDirectiveOut.md index 84cb9c790..61e37532f 100644 --- a/gooddata-api-client/docs/models/JsonApiCspDirectiveOut.md +++ b/gooddata-api-client/docs/models/JsonApiCspDirectiveOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_csp_directive_out.JsonApiCspDirectiveOut +# gooddata_api_client.models.json_api_csp_directive_out.JsonApiCspDirectiveOut JSON:API representation of cspDirective entity. @@ -41,4 +41,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCspDirectiveOutDocument.md b/gooddata-api-client/docs/models/JsonApiCspDirectiveOutDocument.md index eff6e898c..8a22355bb 100644 --- a/gooddata-api-client/docs/models/JsonApiCspDirectiveOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiCspDirectiveOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_csp_directive_out_document.JsonApiCspDirectiveOutDocument +# gooddata_api_client.models.json_api_csp_directive_out_document.JsonApiCspDirectiveOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCspDirectiveOutList.md b/gooddata-api-client/docs/models/JsonApiCspDirectiveOutList.md index e464adc44..75e2f2ead 100644 --- a/gooddata-api-client/docs/models/JsonApiCspDirectiveOutList.md +++ b/gooddata-api-client/docs/models/JsonApiCspDirectiveOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_csp_directive_out_list.JsonApiCspDirectiveOutList +# gooddata_api_client.models.json_api_csp_directive_out_list.JsonApiCspDirectiveOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiCspDirectiveOutWithLinks**](JsonApiCspDirectiveOutWithLinks.md) | [**JsonApiCspDirectiveOutWithLinks**](JsonApiCspDirectiveOutWithLinks.md) | [**JsonApiCspDirectiveOutWithLinks**](JsonApiCspDirectiveOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCspDirectiveOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiCspDirectiveOutWithLinks.md index 1023f7f5d..4555229c5 100644 --- a/gooddata-api-client/docs/models/JsonApiCspDirectiveOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiCspDirectiveOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_csp_directive_out_with_links.JsonApiCspDirectiveOutWithLinks +# gooddata_api_client.models.json_api_csp_directive_out_with_links.JsonApiCspDirectiveOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCspDirectivePatch.md b/gooddata-api-client/docs/models/JsonApiCspDirectivePatch.md index 980920ca3..d49351679 100644 --- a/gooddata-api-client/docs/models/JsonApiCspDirectivePatch.md +++ b/gooddata-api-client/docs/models/JsonApiCspDirectivePatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_csp_directive_patch.JsonApiCspDirectivePatch +# gooddata_api_client.models.json_api_csp_directive_patch.JsonApiCspDirectivePatch JSON:API representation of patching cspDirective entity. @@ -41,4 +41,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCspDirectivePatchDocument.md b/gooddata-api-client/docs/models/JsonApiCspDirectivePatchDocument.md index a504e57f7..c37ef62b1 100644 --- a/gooddata-api-client/docs/models/JsonApiCspDirectivePatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiCspDirectivePatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_csp_directive_patch_document.JsonApiCspDirectivePatchDocument +# gooddata_api_client.models.json_api_csp_directive_patch_document.JsonApiCspDirectivePatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingIn.md b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingIn.md index cc7b49573..ccf3edd57 100644 --- a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingIn.md +++ b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_custom_application_setting_in.JsonApiCustomApplicationSettingIn +# gooddata_api_client.models.json_api_custom_application_setting_in.JsonApiCustomApplicationSettingIn JSON:API representation of customApplicationSetting entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingInDocument.md b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingInDocument.md index 9f6334145..982b38f8b 100644 --- a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_custom_application_setting_in_document.JsonApiCustomApplicationSettingInDocument +# gooddata_api_client.models.json_api_custom_application_setting_in_document.JsonApiCustomApplicationSettingInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOut.md b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOut.md index fff73e811..4190601e5 100644 --- a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOut.md +++ b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_custom_application_setting_out.JsonApiCustomApplicationSettingOut +# gooddata_api_client.models.json_api_custom_application_setting_out.JsonApiCustomApplicationSettingOut JSON:API representation of customApplicationSetting entity. @@ -65,4 +65,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutDocument.md b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutDocument.md index 90385613b..293c5cac1 100644 --- a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_custom_application_setting_out_document.JsonApiCustomApplicationSettingOutDocument +# gooddata_api_client.models.json_api_custom_application_setting_out_document.JsonApiCustomApplicationSettingOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutList.md b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutList.md index 42a204d79..3f336e4d4 100644 --- a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutList.md +++ b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_custom_application_setting_out_list.JsonApiCustomApplicationSettingOutList +# gooddata_api_client.models.json_api_custom_application_setting_out_list.JsonApiCustomApplicationSettingOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiCustomApplicationSettingOutWithLinks**](JsonApiCustomApplicationSettingOutWithLinks.md) | [**JsonApiCustomApplicationSettingOutWithLinks**](JsonApiCustomApplicationSettingOutWithLinks.md) | [**JsonApiCustomApplicationSettingOutWithLinks**](JsonApiCustomApplicationSettingOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutWithLinks.md index 40d2245d6..ac0b058a2 100644 --- a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_custom_application_setting_out_with_links.JsonApiCustomApplicationSettingOutWithLinks +# gooddata_api_client.models.json_api_custom_application_setting_out_with_links.JsonApiCustomApplicationSettingOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPatch.md b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPatch.md index 02314c690..b2783cdfb 100644 --- a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPatch.md +++ b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_custom_application_setting_patch.JsonApiCustomApplicationSettingPatch +# gooddata_api_client.models.json_api_custom_application_setting_patch.JsonApiCustomApplicationSettingPatch JSON:API representation of patching customApplicationSetting entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPatchDocument.md b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPatchDocument.md index b056af1f5..d5bbfb087 100644 --- a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_custom_application_setting_patch_document.JsonApiCustomApplicationSettingPatchDocument +# gooddata_api_client.models.json_api_custom_application_setting_patch_document.JsonApiCustomApplicationSettingPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPostOptionalId.md index 02fae4e51..a4d7d0db4 100644 --- a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPostOptionalId.md +++ b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPostOptionalId.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_custom_application_setting_post_optional_id.JsonApiCustomApplicationSettingPostOptionalId +# gooddata_api_client.models.json_api_custom_application_setting_post_optional_id.JsonApiCustomApplicationSettingPostOptionalId JSON:API representation of customApplicationSetting entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPostOptionalIdDocument.md index 3cfbdc1e3..67b08ca10 100644 --- a/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/models/JsonApiCustomApplicationSettingPostOptionalIdDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document.JsonApiCustomApplicationSettingPostOptionalIdDocument +# gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document.JsonApiCustomApplicationSettingPostOptionalIdDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginIn.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginIn.md index 9c39f4cd8..6fdfac076 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginIn.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_in.JsonApiDashboardPluginIn +# gooddata_api_client.models.json_api_dashboard_plugin_in.JsonApiDashboardPluginIn JSON:API representation of dashboardPlugin entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginInDocument.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginInDocument.md index 9d76b7461..386983280 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_in_document.JsonApiDashboardPluginInDocument +# gooddata_api_client.models.json_api_dashboard_plugin_in_document.JsonApiDashboardPluginInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginLinkage.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginLinkage.md index f7089875b..1d16d1aa6 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_linkage.JsonApiDashboardPluginLinkage +# gooddata_api_client.models.json_api_dashboard_plugin_linkage.JsonApiDashboardPluginLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginOut.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginOut.md index c7391f17c..a80986ed8 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginOut.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_out.JsonApiDashboardPluginOut +# gooddata_api_client.models.json_api_dashboard_plugin_out.JsonApiDashboardPluginOut JSON:API representation of dashboardPlugin entity. @@ -82,4 +82,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginOutDocument.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginOutDocument.md index c5691d56f..87d48ae84 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_out_document.JsonApiDashboardPluginOutDocument +# gooddata_api_client.models.json_api_dashboard_plugin_out_document.JsonApiDashboardPluginOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginOutList.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginOutList.md index 6d4b5edc5..6fc107128 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginOutList.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_out_list.JsonApiDashboardPluginOutList +# gooddata_api_client.models.json_api_dashboard_plugin_out_list.JsonApiDashboardPluginOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiDashboardPluginOutWithLinks**](JsonApiDashboardPluginOutWithLinks.md) | [**JsonApiDashboardPluginOutWithLinks**](JsonApiDashboardPluginOutWithLinks.md) | [**JsonApiDashboardPluginOutWithLinks**](JsonApiDashboardPluginOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginOutWithLinks.md index e6fae4660..863bad247 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_out_with_links.JsonApiDashboardPluginOutWithLinks +# gooddata_api_client.models.json_api_dashboard_plugin_out_with_links.JsonApiDashboardPluginOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginPatch.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginPatch.md index bbccfbdb4..2c1878b75 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginPatch.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_patch.JsonApiDashboardPluginPatch +# gooddata_api_client.models.json_api_dashboard_plugin_patch.JsonApiDashboardPluginPatch JSON:API representation of patching dashboardPlugin entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginPatchDocument.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginPatchDocument.md index 543417860..166372eea 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_patch_document.JsonApiDashboardPluginPatchDocument +# gooddata_api_client.models.json_api_dashboard_plugin_patch_document.JsonApiDashboardPluginPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginPostOptionalId.md index dde026e05..624b36479 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginPostOptionalId.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginPostOptionalId.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id.JsonApiDashboardPluginPostOptionalId +# gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id.JsonApiDashboardPluginPostOptionalId JSON:API representation of dashboardPlugin entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginPostOptionalIdDocument.md index 3236cb3cf..c3659fcbd 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginPostOptionalIdDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document.JsonApiDashboardPluginPostOptionalIdDocument +# gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document.JsonApiDashboardPluginPostOptionalIdDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDashboardPluginToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiDashboardPluginToManyLinkage.md index 5a87b89d9..689aa7e74 100644 --- a/gooddata-api-client/docs/models/JsonApiDashboardPluginToManyLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiDashboardPluginToManyLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dashboard_plugin_to_many_linkage.JsonApiDashboardPluginToManyLinkage +# gooddata_api_client.models.json_api_dashboard_plugin_to_many_linkage.JsonApiDashboardPluginToManyLinkage References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiDashboardPluginLinkage**](JsonApiDashboardPluginLinkage.md) | [**JsonApiDashboardPluginLinkage**](JsonApiDashboardPluginLinkage.md) | [**JsonApiDashboardPluginLinkage**](JsonApiDashboardPluginLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOut.md b/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOut.md index 0289e3dc5..2c69816f5 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOut.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_identifier_out.JsonApiDataSourceIdentifierOut +# gooddata_api_client.models.json_api_data_source_identifier_out.JsonApiDataSourceIdentifierOut JSON:API representation of dataSourceIdentifier entity. @@ -59,4 +59,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | must be one of ["MANAGE", "USE", ] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutDocument.md b/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutDocument.md index c7f324ae6..1285d83c4 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_identifier_out_document.JsonApiDataSourceIdentifierOutDocument +# gooddata_api_client.models.json_api_data_source_identifier_out_document.JsonApiDataSourceIdentifierOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutList.md b/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutList.md index 98e6f526f..383a5b640 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutList.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_identifier_out_list.JsonApiDataSourceIdentifierOutList +# gooddata_api_client.models.json_api_data_source_identifier_out_list.JsonApiDataSourceIdentifierOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiDataSourceIdentifierOutWithLinks**](JsonApiDataSourceIdentifierOutWithLinks.md) | [**JsonApiDataSourceIdentifierOutWithLinks**](JsonApiDataSourceIdentifierOutWithLinks.md) | [**JsonApiDataSourceIdentifierOutWithLinks**](JsonApiDataSourceIdentifierOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutWithLinks.md index cbe016f79..5383b87c2 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceIdentifierOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_identifier_out_with_links.JsonApiDataSourceIdentifierOutWithLinks +# gooddata_api_client.models.json_api_data_source_identifier_out_with_links.JsonApiDataSourceIdentifierOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceIn.md b/gooddata-api-client/docs/models/JsonApiDataSourceIn.md index 728c67556..aa47d8077 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceIn.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_in.JsonApiDataSourceIn +# gooddata_api_client.models.json_api_data_source_in.JsonApiDataSourceIn JSON:API representation of dataSource entity. @@ -76,4 +76,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceInDocument.md b/gooddata-api-client/docs/models/JsonApiDataSourceInDocument.md index 643e22889..a98dd43e8 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_in_document.JsonApiDataSourceInDocument +# gooddata_api_client.models.json_api_data_source_in_document.JsonApiDataSourceInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceOut.md b/gooddata-api-client/docs/models/JsonApiDataSourceOut.md index 35b2adb73..928f42f55 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceOut.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_out.JsonApiDataSourceOut +# gooddata_api_client.models.json_api_data_source_out.JsonApiDataSourceOut JSON:API representation of dataSource entity. @@ -129,4 +129,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | must be one of ["MANAGE", "USE", ] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceOutDocument.md b/gooddata-api-client/docs/models/JsonApiDataSourceOutDocument.md index e5af06855..b44c35cf0 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_out_document.JsonApiDataSourceOutDocument +# gooddata_api_client.models.json_api_data_source_out_document.JsonApiDataSourceOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceOutList.md b/gooddata-api-client/docs/models/JsonApiDataSourceOutList.md index 9f42c2227..0db1b1916 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceOutList.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_out_list.JsonApiDataSourceOutList +# gooddata_api_client.models.json_api_data_source_out_list.JsonApiDataSourceOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiDataSourceOutWithLinks**](JsonApiDataSourceOutWithLinks.md) | [**JsonApiDataSourceOutWithLinks**](JsonApiDataSourceOutWithLinks.md) | [**JsonApiDataSourceOutWithLinks**](JsonApiDataSourceOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiDataSourceOutWithLinks.md index 082f4a8a3..0354de8d1 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_out_with_links.JsonApiDataSourceOutWithLinks +# gooddata_api_client.models.json_api_data_source_out_with_links.JsonApiDataSourceOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourcePatch.md b/gooddata-api-client/docs/models/JsonApiDataSourcePatch.md index b3cf43566..0bd4bdf97 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourcePatch.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourcePatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_patch.JsonApiDataSourcePatch +# gooddata_api_client.models.json_api_data_source_patch.JsonApiDataSourcePatch JSON:API representation of patching dataSource entity. @@ -76,4 +76,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourcePatchDocument.md b/gooddata-api-client/docs/models/JsonApiDataSourcePatchDocument.md index ceb56baef..62ffe1782 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourcePatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourcePatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_patch_document.JsonApiDataSourcePatchDocument +# gooddata_api_client.models.json_api_data_source_patch_document.JsonApiDataSourcePatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceTableOut.md b/gooddata-api-client/docs/models/JsonApiDataSourceTableOut.md index ac910a259..8e209c81a 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceTableOut.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceTableOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_table_out.JsonApiDataSourceTableOut +# gooddata_api_client.models.json_api_data_source_table_out.JsonApiDataSourceTableOut Tables in data source @@ -77,4 +77,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceTableOutDocument.md b/gooddata-api-client/docs/models/JsonApiDataSourceTableOutDocument.md index eb5e35eaa..ef2c47452 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceTableOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceTableOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_table_out_document.JsonApiDataSourceTableOutDocument +# gooddata_api_client.models.json_api_data_source_table_out_document.JsonApiDataSourceTableOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceTableOutList.md b/gooddata-api-client/docs/models/JsonApiDataSourceTableOutList.md index 7c6a7dcfa..bfb871a19 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceTableOutList.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceTableOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_table_out_list.JsonApiDataSourceTableOutList +# gooddata_api_client.models.json_api_data_source_table_out_list.JsonApiDataSourceTableOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiDataSourceTableOutWithLinks**](JsonApiDataSourceTableOutWithLinks.md) | [**JsonApiDataSourceTableOutWithLinks**](JsonApiDataSourceTableOutWithLinks.md) | [**JsonApiDataSourceTableOutWithLinks**](JsonApiDataSourceTableOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDataSourceTableOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiDataSourceTableOutWithLinks.md index 1b591e5db..b450305a0 100644 --- a/gooddata-api-client/docs/models/JsonApiDataSourceTableOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiDataSourceTableOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_data_source_table_out_with_links.JsonApiDataSourceTableOutWithLinks +# gooddata_api_client.models.json_api_data_source_table_out_with_links.JsonApiDataSourceTableOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDatasetLinkage.md b/gooddata-api-client/docs/models/JsonApiDatasetLinkage.md index 1a42e70b8..85aacc42e 100644 --- a/gooddata-api-client/docs/models/JsonApiDatasetLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiDatasetLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dataset_linkage.JsonApiDatasetLinkage +# gooddata_api_client.models.json_api_dataset_linkage.JsonApiDatasetLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDatasetOut.md b/gooddata-api-client/docs/models/JsonApiDatasetOut.md index 5e23a0c2a..82a2eed5d 100644 --- a/gooddata-api-client/docs/models/JsonApiDatasetOut.md +++ b/gooddata-api-client/docs/models/JsonApiDatasetOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dataset_out.JsonApiDatasetOut +# gooddata_api_client.models.json_api_dataset_out.JsonApiDatasetOut JSON:API representation of dataset entity. @@ -252,4 +252,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDatasetOutDocument.md b/gooddata-api-client/docs/models/JsonApiDatasetOutDocument.md index d61d3eef5..bd1ed850e 100644 --- a/gooddata-api-client/docs/models/JsonApiDatasetOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiDatasetOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dataset_out_document.JsonApiDatasetOutDocument +# gooddata_api_client.models.json_api_dataset_out_document.JsonApiDatasetOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiDatasetOutIncludes**](JsonApiDatasetOutIncludes.md) | [**JsonApiDatasetOutIncludes**](JsonApiDatasetOutIncludes.md) | [**JsonApiDatasetOutIncludes**](JsonApiDatasetOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDatasetOutIncludes.md b/gooddata-api-client/docs/models/JsonApiDatasetOutIncludes.md index 43ed8c11a..346d73385 100644 --- a/gooddata-api-client/docs/models/JsonApiDatasetOutIncludes.md +++ b/gooddata-api-client/docs/models/JsonApiDatasetOutIncludes.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dataset_out_includes.JsonApiDatasetOutIncludes +# gooddata_api_client.models.json_api_dataset_out_includes.JsonApiDatasetOutIncludes ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -14,4 +14,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiDatasetOutWithLinks](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDatasetOutList.md b/gooddata-api-client/docs/models/JsonApiDatasetOutList.md index 1e3d18642..ed682994a 100644 --- a/gooddata-api-client/docs/models/JsonApiDatasetOutList.md +++ b/gooddata-api-client/docs/models/JsonApiDatasetOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dataset_out_list.JsonApiDatasetOutList +# gooddata_api_client.models.json_api_dataset_out_list.JsonApiDatasetOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiDatasetOutIncludes**](JsonApiDatasetOutIncludes.md) | [**JsonApiDatasetOutIncludes**](JsonApiDatasetOutIncludes.md) | [**JsonApiDatasetOutIncludes**](JsonApiDatasetOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDatasetOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiDatasetOutWithLinks.md index b7686f680..b78ca12a3 100644 --- a/gooddata-api-client/docs/models/JsonApiDatasetOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiDatasetOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dataset_out_with_links.JsonApiDatasetOutWithLinks +# gooddata_api_client.models.json_api_dataset_out_with_links.JsonApiDatasetOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDatasetToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiDatasetToManyLinkage.md index d69c15e9f..9bc8f5332 100644 --- a/gooddata-api-client/docs/models/JsonApiDatasetToManyLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiDatasetToManyLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dataset_to_many_linkage.JsonApiDatasetToManyLinkage +# gooddata_api_client.models.json_api_dataset_to_many_linkage.JsonApiDatasetToManyLinkage References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiDatasetLinkage**](JsonApiDatasetLinkage.md) | [**JsonApiDatasetLinkage**](JsonApiDatasetLinkage.md) | [**JsonApiDatasetLinkage**](JsonApiDatasetLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiDatasetToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiDatasetToOneLinkage.md index ab1ef16f0..f19c80e1f 100644 --- a/gooddata-api-client/docs/models/JsonApiDatasetToOneLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiDatasetToOneLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_dataset_to_one_linkage.JsonApiDatasetToOneLinkage +# gooddata_api_client.models.json_api_dataset_to_one_linkage.JsonApiDatasetToOneLinkage References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -14,4 +14,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiDatasetLinkage](JsonApiDatasetLinkage.md) | [**JsonApiDatasetLinkage**](JsonApiDatasetLinkage.md) | [**JsonApiDatasetLinkage**](JsonApiDatasetLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiEntitlementOut.md b/gooddata-api-client/docs/models/JsonApiEntitlementOut.md index ebff99759..ce7b87bfa 100644 --- a/gooddata-api-client/docs/models/JsonApiEntitlementOut.md +++ b/gooddata-api-client/docs/models/JsonApiEntitlementOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_entitlement_out.JsonApiEntitlementOut +# gooddata_api_client.models.json_api_entitlement_out.JsonApiEntitlementOut JSON:API representation of entitlement entity. @@ -30,4 +30,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiEntitlementOutDocument.md b/gooddata-api-client/docs/models/JsonApiEntitlementOutDocument.md index 5f81ae246..3057635b8 100644 --- a/gooddata-api-client/docs/models/JsonApiEntitlementOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiEntitlementOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_entitlement_out_document.JsonApiEntitlementOutDocument +# gooddata_api_client.models.json_api_entitlement_out_document.JsonApiEntitlementOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiEntitlementOutList.md b/gooddata-api-client/docs/models/JsonApiEntitlementOutList.md index 2806b395f..917ced4a8 100644 --- a/gooddata-api-client/docs/models/JsonApiEntitlementOutList.md +++ b/gooddata-api-client/docs/models/JsonApiEntitlementOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_entitlement_out_list.JsonApiEntitlementOutList +# gooddata_api_client.models.json_api_entitlement_out_list.JsonApiEntitlementOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiEntitlementOutWithLinks**](JsonApiEntitlementOutWithLinks.md) | [**JsonApiEntitlementOutWithLinks**](JsonApiEntitlementOutWithLinks.md) | [**JsonApiEntitlementOutWithLinks**](JsonApiEntitlementOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiEntitlementOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiEntitlementOutWithLinks.md index 9fb617ae9..e112d6693 100644 --- a/gooddata-api-client/docs/models/JsonApiEntitlementOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiEntitlementOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_entitlement_out_with_links.JsonApiEntitlementOutWithLinks +# gooddata_api_client.models.json_api_entitlement_out_with_links.JsonApiEntitlementOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFactLinkage.md b/gooddata-api-client/docs/models/JsonApiFactLinkage.md index 76d2e8a00..ca030e41e 100644 --- a/gooddata-api-client/docs/models/JsonApiFactLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiFactLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_fact_linkage.JsonApiFactLinkage +# gooddata_api_client.models.json_api_fact_linkage.JsonApiFactLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFactOut.md b/gooddata-api-client/docs/models/JsonApiFactOut.md index e050d2217..651c19133 100644 --- a/gooddata-api-client/docs/models/JsonApiFactOut.md +++ b/gooddata-api-client/docs/models/JsonApiFactOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_fact_out.JsonApiFactOut +# gooddata_api_client.models.json_api_fact_out.JsonApiFactOut JSON:API representation of fact entity. @@ -101,4 +101,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFactOutDocument.md b/gooddata-api-client/docs/models/JsonApiFactOutDocument.md index 5bb905a55..7c55ce0e8 100644 --- a/gooddata-api-client/docs/models/JsonApiFactOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiFactOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_fact_out_document.JsonApiFactOutDocument +# gooddata_api_client.models.json_api_fact_out_document.JsonApiFactOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFactOutList.md b/gooddata-api-client/docs/models/JsonApiFactOutList.md index e8a266112..a25e838e4 100644 --- a/gooddata-api-client/docs/models/JsonApiFactOutList.md +++ b/gooddata-api-client/docs/models/JsonApiFactOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_fact_out_list.JsonApiFactOutList +# gooddata_api_client.models.json_api_fact_out_list.JsonApiFactOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFactOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiFactOutWithLinks.md index 661e078d6..898b9ecea 100644 --- a/gooddata-api-client/docs/models/JsonApiFactOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiFactOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_fact_out_with_links.JsonApiFactOutWithLinks +# gooddata_api_client.models.json_api_fact_out_with_links.JsonApiFactOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFactToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiFactToManyLinkage.md index b4afeb001..1e21ec699 100644 --- a/gooddata-api-client/docs/models/JsonApiFactToManyLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiFactToManyLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_fact_to_many_linkage.JsonApiFactToManyLinkage +# gooddata_api_client.models.json_api_fact_to_many_linkage.JsonApiFactToManyLinkage References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiFactLinkage**](JsonApiFactLinkage.md) | [**JsonApiFactLinkage**](JsonApiFactLinkage.md) | [**JsonApiFactLinkage**](JsonApiFactLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextIn.md b/gooddata-api-client/docs/models/JsonApiFilterContextIn.md index 45a8604c5..a59b661f6 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextIn.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_in.JsonApiFilterContextIn +# gooddata_api_client.models.json_api_filter_context_in.JsonApiFilterContextIn JSON:API representation of filterContext entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextInDocument.md b/gooddata-api-client/docs/models/JsonApiFilterContextInDocument.md index c9ddcb6bb..d6f27a90e 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_in_document.JsonApiFilterContextInDocument +# gooddata_api_client.models.json_api_filter_context_in_document.JsonApiFilterContextInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextLinkage.md b/gooddata-api-client/docs/models/JsonApiFilterContextLinkage.md index 230cd1244..237d2ed77 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_linkage.JsonApiFilterContextLinkage +# gooddata_api_client.models.json_api_filter_context_linkage.JsonApiFilterContextLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextOut.md b/gooddata-api-client/docs/models/JsonApiFilterContextOut.md index 83f6ea0da..e531bbbec 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextOut.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_out.JsonApiFilterContextOut +# gooddata_api_client.models.json_api_filter_context_out.JsonApiFilterContextOut JSON:API representation of filterContext entity. @@ -137,4 +137,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextOutDocument.md b/gooddata-api-client/docs/models/JsonApiFilterContextOutDocument.md index d38254115..faabfa552 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_out_document.JsonApiFilterContextOutDocument +# gooddata_api_client.models.json_api_filter_context_out_document.JsonApiFilterContextOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiFilterContextOutIncludes**](JsonApiFilterContextOutIncludes.md) | [**JsonApiFilterContextOutIncludes**](JsonApiFilterContextOutIncludes.md) | [**JsonApiFilterContextOutIncludes**](JsonApiFilterContextOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextOutIncludes.md b/gooddata-api-client/docs/models/JsonApiFilterContextOutIncludes.md index f4663f01c..ca69a72f8 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextOutIncludes.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextOutIncludes.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_out_includes.JsonApiFilterContextOutIncludes +# gooddata_api_client.models.json_api_filter_context_out_includes.JsonApiFilterContextOutIncludes ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -14,4 +14,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiLabelOutWithLinks](JsonApiLabelOutWithLinks.md) | [**JsonApiLabelOutWithLinks**](JsonApiLabelOutWithLinks.md) | [**JsonApiLabelOutWithLinks**](JsonApiLabelOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextOutList.md b/gooddata-api-client/docs/models/JsonApiFilterContextOutList.md index 8052f38e3..86e7e1f29 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextOutList.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_out_list.JsonApiFilterContextOutList +# gooddata_api_client.models.json_api_filter_context_out_list.JsonApiFilterContextOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiFilterContextOutIncludes**](JsonApiFilterContextOutIncludes.md) | [**JsonApiFilterContextOutIncludes**](JsonApiFilterContextOutIncludes.md) | [**JsonApiFilterContextOutIncludes**](JsonApiFilterContextOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiFilterContextOutWithLinks.md index 77efae04f..7d3e40a93 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_out_with_links.JsonApiFilterContextOutWithLinks +# gooddata_api_client.models.json_api_filter_context_out_with_links.JsonApiFilterContextOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextPatch.md b/gooddata-api-client/docs/models/JsonApiFilterContextPatch.md index 0f7118889..d1be94716 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextPatch.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_patch.JsonApiFilterContextPatch +# gooddata_api_client.models.json_api_filter_context_patch.JsonApiFilterContextPatch JSON:API representation of patching filterContext entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextPatchDocument.md b/gooddata-api-client/docs/models/JsonApiFilterContextPatchDocument.md index c997f2eac..79d35695d 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_patch_document.JsonApiFilterContextPatchDocument +# gooddata_api_client.models.json_api_filter_context_patch_document.JsonApiFilterContextPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiFilterContextPostOptionalId.md index 2d6d36975..d8efbead3 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextPostOptionalId.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextPostOptionalId.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_post_optional_id.JsonApiFilterContextPostOptionalId +# gooddata_api_client.models.json_api_filter_context_post_optional_id.JsonApiFilterContextPostOptionalId JSON:API representation of filterContext entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiFilterContextPostOptionalIdDocument.md index 934bdac13..03bd24d45 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextPostOptionalIdDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_post_optional_id_document.JsonApiFilterContextPostOptionalIdDocument +# gooddata_api_client.models.json_api_filter_context_post_optional_id_document.JsonApiFilterContextPostOptionalIdDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiFilterContextToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiFilterContextToManyLinkage.md index 1e2275b66..afa9689c0 100644 --- a/gooddata-api-client/docs/models/JsonApiFilterContextToManyLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiFilterContextToManyLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_filter_context_to_many_linkage.JsonApiFilterContextToManyLinkage +# gooddata_api_client.models.json_api_filter_context_to_many_linkage.JsonApiFilterContextToManyLinkage References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiFilterContextLinkage**](JsonApiFilterContextLinkage.md) | [**JsonApiFilterContextLinkage**](JsonApiFilterContextLinkage.md) | [**JsonApiFilterContextLinkage**](JsonApiFilterContextLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiLabelLinkage.md b/gooddata-api-client/docs/models/JsonApiLabelLinkage.md index a133a4c30..c3a9c5b15 100644 --- a/gooddata-api-client/docs/models/JsonApiLabelLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiLabelLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_label_linkage.JsonApiLabelLinkage +# gooddata_api_client.models.json_api_label_linkage.JsonApiLabelLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiLabelOut.md b/gooddata-api-client/docs/models/JsonApiLabelOut.md index 1bbe1190a..23190cf8f 100644 --- a/gooddata-api-client/docs/models/JsonApiLabelOut.md +++ b/gooddata-api-client/docs/models/JsonApiLabelOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_label_out.JsonApiLabelOut +# gooddata_api_client.models.json_api_label_out.JsonApiLabelOut JSON:API representation of label entity. @@ -103,4 +103,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiLabelOutDocument.md b/gooddata-api-client/docs/models/JsonApiLabelOutDocument.md index 69a03b9c1..8b5b516ca 100644 --- a/gooddata-api-client/docs/models/JsonApiLabelOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiLabelOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_label_out_document.JsonApiLabelOutDocument +# gooddata_api_client.models.json_api_label_out_document.JsonApiLabelOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiAttributeOutWithLinks**](JsonApiAttributeOutWithLinks.md) | [**JsonApiAttributeOutWithLinks**](JsonApiAttributeOutWithLinks.md) | [**JsonApiAttributeOutWithLinks**](JsonApiAttributeOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiLabelOutList.md b/gooddata-api-client/docs/models/JsonApiLabelOutList.md index 6bd4460cc..5d15f9c82 100644 --- a/gooddata-api-client/docs/models/JsonApiLabelOutList.md +++ b/gooddata-api-client/docs/models/JsonApiLabelOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_label_out_list.JsonApiLabelOutList +# gooddata_api_client.models.json_api_label_out_list.JsonApiLabelOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiAttributeOutWithLinks**](JsonApiAttributeOutWithLinks.md) | [**JsonApiAttributeOutWithLinks**](JsonApiAttributeOutWithLinks.md) | [**JsonApiAttributeOutWithLinks**](JsonApiAttributeOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiLabelOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiLabelOutWithLinks.md index 694c81786..55c482503 100644 --- a/gooddata-api-client/docs/models/JsonApiLabelOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiLabelOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_label_out_with_links.JsonApiLabelOutWithLinks +# gooddata_api_client.models.json_api_label_out_with_links.JsonApiLabelOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiLabelToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiLabelToManyLinkage.md index b139d79cf..0a2b13c9b 100644 --- a/gooddata-api-client/docs/models/JsonApiLabelToManyLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiLabelToManyLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_label_to_many_linkage.JsonApiLabelToManyLinkage +# gooddata_api_client.models.json_api_label_to_many_linkage.JsonApiLabelToManyLinkage References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiLabelLinkage**](JsonApiLabelLinkage.md) | [**JsonApiLabelLinkage**](JsonApiLabelLinkage.md) | [**JsonApiLabelLinkage**](JsonApiLabelLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiLabelToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiLabelToOneLinkage.md index 9daad06ea..b92842065 100644 --- a/gooddata-api-client/docs/models/JsonApiLabelToOneLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiLabelToOneLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_label_to_one_linkage.JsonApiLabelToOneLinkage +# gooddata_api_client.models.json_api_label_to_one_linkage.JsonApiLabelToOneLinkage References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -14,4 +14,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiLabelLinkage](JsonApiLabelLinkage.md) | [**JsonApiLabelLinkage**](JsonApiLabelLinkage.md) | [**JsonApiLabelLinkage**](JsonApiLabelLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricIn.md b/gooddata-api-client/docs/models/JsonApiMetricIn.md index 551bfd687..09e99e264 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricIn.md +++ b/gooddata-api-client/docs/models/JsonApiMetricIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_in.JsonApiMetricIn +# gooddata_api_client.models.json_api_metric_in.JsonApiMetricIn JSON:API representation of metric entity. @@ -59,4 +59,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricInDocument.md b/gooddata-api-client/docs/models/JsonApiMetricInDocument.md index 9838bfd1c..47d67e64f 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiMetricInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_in_document.JsonApiMetricInDocument +# gooddata_api_client.models.json_api_metric_in_document.JsonApiMetricInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricLinkage.md b/gooddata-api-client/docs/models/JsonApiMetricLinkage.md index 095275a8b..4e34c6535 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiMetricLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_linkage.JsonApiMetricLinkage +# gooddata_api_client.models.json_api_metric_linkage.JsonApiMetricLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricOut.md b/gooddata-api-client/docs/models/JsonApiMetricOut.md index 33c615216..4936fe3b2 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricOut.md +++ b/gooddata-api-client/docs/models/JsonApiMetricOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_out.JsonApiMetricOut +# gooddata_api_client.models.json_api_metric_out.JsonApiMetricOut JSON:API representation of metric entity. @@ -170,4 +170,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricOutDocument.md b/gooddata-api-client/docs/models/JsonApiMetricOutDocument.md index d666cdc20..6676d9dff 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiMetricOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_out_document.JsonApiMetricOutDocument +# gooddata_api_client.models.json_api_metric_out_document.JsonApiMetricOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricOutIncludes.md b/gooddata-api-client/docs/models/JsonApiMetricOutIncludes.md index c6c85bb71..62f007820 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricOutIncludes.md +++ b/gooddata-api-client/docs/models/JsonApiMetricOutIncludes.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_out_includes.JsonApiMetricOutIncludes +# gooddata_api_client.models.json_api_metric_out_includes.JsonApiMetricOutIncludes ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -16,4 +16,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiDatasetOutWithLinks](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricOutList.md b/gooddata-api-client/docs/models/JsonApiMetricOutList.md index 506d18cb1..e76d62e2d 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricOutList.md +++ b/gooddata-api-client/docs/models/JsonApiMetricOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_out_list.JsonApiMetricOutList +# gooddata_api_client.models.json_api_metric_out_list.JsonApiMetricOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiMetricOutWithLinks.md index 3cd94773d..706151393 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiMetricOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_out_with_links.JsonApiMetricOutWithLinks +# gooddata_api_client.models.json_api_metric_out_with_links.JsonApiMetricOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricPatch.md b/gooddata-api-client/docs/models/JsonApiMetricPatch.md index 677e204dd..6b61694e3 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricPatch.md +++ b/gooddata-api-client/docs/models/JsonApiMetricPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_patch.JsonApiMetricPatch +# gooddata_api_client.models.json_api_metric_patch.JsonApiMetricPatch JSON:API representation of patching metric entity. @@ -59,4 +59,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricPatchDocument.md b/gooddata-api-client/docs/models/JsonApiMetricPatchDocument.md index 70dc9b76e..a6e769351 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiMetricPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_patch_document.JsonApiMetricPatchDocument +# gooddata_api_client.models.json_api_metric_patch_document.JsonApiMetricPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiMetricPostOptionalId.md index 0fab8b20f..4b6bc5891 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricPostOptionalId.md +++ b/gooddata-api-client/docs/models/JsonApiMetricPostOptionalId.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_post_optional_id.JsonApiMetricPostOptionalId +# gooddata_api_client.models.json_api_metric_post_optional_id.JsonApiMetricPostOptionalId JSON:API representation of metric entity. @@ -59,4 +59,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiMetricPostOptionalIdDocument.md index f49f386bf..7958d97a3 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/models/JsonApiMetricPostOptionalIdDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_post_optional_id_document.JsonApiMetricPostOptionalIdDocument +# gooddata_api_client.models.json_api_metric_post_optional_id_document.JsonApiMetricPostOptionalIdDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiMetricToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiMetricToManyLinkage.md index fe6a6506a..305500e18 100644 --- a/gooddata-api-client/docs/models/JsonApiMetricToManyLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiMetricToManyLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_metric_to_many_linkage.JsonApiMetricToManyLinkage +# gooddata_api_client.models.json_api_metric_to_many_linkage.JsonApiMetricToManyLinkage References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiMetricLinkage**](JsonApiMetricLinkage.md) | [**JsonApiMetricLinkage**](JsonApiMetricLinkage.md) | [**JsonApiMetricLinkage**](JsonApiMetricLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationIn.md b/gooddata-api-client/docs/models/JsonApiOrganizationIn.md index 8122d4711..18853eca0 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationIn.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_in.JsonApiOrganizationIn +# gooddata_api_client.models.json_api_organization_in.JsonApiOrganizationIn JSON:API representation of organization entity. @@ -48,4 +48,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationInDocument.md b/gooddata-api-client/docs/models/JsonApiOrganizationInDocument.md index 608d3a673..eef5fae82 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_in_document.JsonApiOrganizationInDocument +# gooddata_api_client.models.json_api_organization_in_document.JsonApiOrganizationInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationOut.md b/gooddata-api-client/docs/models/JsonApiOrganizationOut.md index 676de12a5..b9c15a504 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationOut.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_out.JsonApiOrganizationOut +# gooddata_api_client.models.json_api_organization_out.JsonApiOrganizationOut JSON:API representation of organization entity. @@ -116,4 +116,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationOutDocument.md b/gooddata-api-client/docs/models/JsonApiOrganizationOutDocument.md index 8201b418d..a42af1e0d 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_out_document.JsonApiOrganizationOutDocument +# gooddata_api_client.models.json_api_organization_out_document.JsonApiOrganizationOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiOrganizationOutIncludes**](JsonApiOrganizationOutIncludes.md) | [**JsonApiOrganizationOutIncludes**](JsonApiOrganizationOutIncludes.md) | [**JsonApiOrganizationOutIncludes**](JsonApiOrganizationOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationOutIncludes.md b/gooddata-api-client/docs/models/JsonApiOrganizationOutIncludes.md index f75db94a1..c15678cec 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationOutIncludes.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationOutIncludes.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_out_includes.JsonApiOrganizationOutIncludes +# gooddata_api_client.models.json_api_organization_out_includes.JsonApiOrganizationOutIncludes ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiUserGroupOutWithLinks](JsonApiUserGroupOutWithLinks.md) | [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationPatch.md b/gooddata-api-client/docs/models/JsonApiOrganizationPatch.md index 26919b0b3..552c2b6b1 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationPatch.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_patch.JsonApiOrganizationPatch +# gooddata_api_client.models.json_api_organization_patch.JsonApiOrganizationPatch JSON:API representation of patching organization entity. @@ -48,4 +48,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationPatchDocument.md b/gooddata-api-client/docs/models/JsonApiOrganizationPatchDocument.md index 580dc015b..4b22ae8c3 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_patch_document.JsonApiOrganizationPatchDocument +# gooddata_api_client.models.json_api_organization_patch_document.JsonApiOrganizationPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationSettingIn.md b/gooddata-api-client/docs/models/JsonApiOrganizationSettingIn.md index 729088962..f9a2ea85f 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationSettingIn.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationSettingIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_setting_in.JsonApiOrganizationSettingIn +# gooddata_api_client.models.json_api_organization_setting_in.JsonApiOrganizationSettingIn JSON:API representation of organizationSetting entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationSettingInDocument.md b/gooddata-api-client/docs/models/JsonApiOrganizationSettingInDocument.md index 122bfcaf8..3efbe7a6c 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationSettingInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationSettingInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_setting_in_document.JsonApiOrganizationSettingInDocument +# gooddata_api_client.models.json_api_organization_setting_in_document.JsonApiOrganizationSettingInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationSettingOut.md b/gooddata-api-client/docs/models/JsonApiOrganizationSettingOut.md index 7878e3624..53824fc53 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationSettingOut.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationSettingOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_setting_out.JsonApiOrganizationSettingOut +# gooddata_api_client.models.json_api_organization_setting_out.JsonApiOrganizationSettingOut JSON:API representation of organizationSetting entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutDocument.md b/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutDocument.md index d088faa30..06b573040 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_setting_out_document.JsonApiOrganizationSettingOutDocument +# gooddata_api_client.models.json_api_organization_setting_out_document.JsonApiOrganizationSettingOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutList.md b/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutList.md index c06f572ad..616f24a08 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutList.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_setting_out_list.JsonApiOrganizationSettingOutList +# gooddata_api_client.models.json_api_organization_setting_out_list.JsonApiOrganizationSettingOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiOrganizationSettingOutWithLinks**](JsonApiOrganizationSettingOutWithLinks.md) | [**JsonApiOrganizationSettingOutWithLinks**](JsonApiOrganizationSettingOutWithLinks.md) | [**JsonApiOrganizationSettingOutWithLinks**](JsonApiOrganizationSettingOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutWithLinks.md index 0eec7a9be..48ccd3375 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationSettingOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_setting_out_with_links.JsonApiOrganizationSettingOutWithLinks +# gooddata_api_client.models.json_api_organization_setting_out_with_links.JsonApiOrganizationSettingOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationSettingPatch.md b/gooddata-api-client/docs/models/JsonApiOrganizationSettingPatch.md index 185fe51c5..a0dc6e00e 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationSettingPatch.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationSettingPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_setting_patch.JsonApiOrganizationSettingPatch +# gooddata_api_client.models.json_api_organization_setting_patch.JsonApiOrganizationSettingPatch JSON:API representation of patching organizationSetting entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiOrganizationSettingPatchDocument.md b/gooddata-api-client/docs/models/JsonApiOrganizationSettingPatchDocument.md index 61d3609fb..eb47790a5 100644 --- a/gooddata-api-client/docs/models/JsonApiOrganizationSettingPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiOrganizationSettingPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_organization_setting_patch_document.JsonApiOrganizationSettingPatchDocument +# gooddata_api_client.models.json_api_organization_setting_patch_document.JsonApiOrganizationSettingPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiThemeIn.md b/gooddata-api-client/docs/models/JsonApiThemeIn.md index a0eb8c575..ee7aa40c4 100644 --- a/gooddata-api-client/docs/models/JsonApiThemeIn.md +++ b/gooddata-api-client/docs/models/JsonApiThemeIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_theme_in.JsonApiThemeIn +# gooddata_api_client.models.json_api_theme_in.JsonApiThemeIn JSON:API representation of theme entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiThemeInDocument.md b/gooddata-api-client/docs/models/JsonApiThemeInDocument.md index a7f04665e..cddefaf37 100644 --- a/gooddata-api-client/docs/models/JsonApiThemeInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiThemeInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_theme_in_document.JsonApiThemeInDocument +# gooddata_api_client.models.json_api_theme_in_document.JsonApiThemeInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiThemeOut.md b/gooddata-api-client/docs/models/JsonApiThemeOut.md index 7d3df6a6c..8b7e09006 100644 --- a/gooddata-api-client/docs/models/JsonApiThemeOut.md +++ b/gooddata-api-client/docs/models/JsonApiThemeOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_theme_out.JsonApiThemeOut +# gooddata_api_client.models.json_api_theme_out.JsonApiThemeOut JSON:API representation of theme entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiThemeOutDocument.md b/gooddata-api-client/docs/models/JsonApiThemeOutDocument.md index 46e7da536..4b537aced 100644 --- a/gooddata-api-client/docs/models/JsonApiThemeOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiThemeOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_theme_out_document.JsonApiThemeOutDocument +# gooddata_api_client.models.json_api_theme_out_document.JsonApiThemeOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiThemeOutList.md b/gooddata-api-client/docs/models/JsonApiThemeOutList.md index 5dadd8f50..4ab74472f 100644 --- a/gooddata-api-client/docs/models/JsonApiThemeOutList.md +++ b/gooddata-api-client/docs/models/JsonApiThemeOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_theme_out_list.JsonApiThemeOutList +# gooddata_api_client.models.json_api_theme_out_list.JsonApiThemeOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiThemeOutWithLinks**](JsonApiThemeOutWithLinks.md) | [**JsonApiThemeOutWithLinks**](JsonApiThemeOutWithLinks.md) | [**JsonApiThemeOutWithLinks**](JsonApiThemeOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiThemeOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiThemeOutWithLinks.md index 36691dff7..4df8dc7d6 100644 --- a/gooddata-api-client/docs/models/JsonApiThemeOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiThemeOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_theme_out_with_links.JsonApiThemeOutWithLinks +# gooddata_api_client.models.json_api_theme_out_with_links.JsonApiThemeOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiThemePatch.md b/gooddata-api-client/docs/models/JsonApiThemePatch.md index c78638994..8051427ee 100644 --- a/gooddata-api-client/docs/models/JsonApiThemePatch.md +++ b/gooddata-api-client/docs/models/JsonApiThemePatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_theme_patch.JsonApiThemePatch +# gooddata_api_client.models.json_api_theme_patch.JsonApiThemePatch JSON:API representation of patching theme entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiThemePatchDocument.md b/gooddata-api-client/docs/models/JsonApiThemePatchDocument.md index 7cf15ccb1..af0d69ec9 100644 --- a/gooddata-api-client/docs/models/JsonApiThemePatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiThemePatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_theme_patch_document.JsonApiThemePatchDocument +# gooddata_api_client.models.json_api_theme_patch_document.JsonApiThemePatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserDataFilterIn.md b/gooddata-api-client/docs/models/JsonApiUserDataFilterIn.md index 0d83d077b..d89c405c9 100644 --- a/gooddata-api-client/docs/models/JsonApiUserDataFilterIn.md +++ b/gooddata-api-client/docs/models/JsonApiUserDataFilterIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_data_filter_in.JsonApiUserDataFilterIn +# gooddata_api_client.models.json_api_user_data_filter_in.JsonApiUserDataFilterIn JSON:API representation of userDataFilter entity. @@ -86,4 +86,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserDataFilterInDocument.md b/gooddata-api-client/docs/models/JsonApiUserDataFilterInDocument.md index e039ec7a1..6b31312a1 100644 --- a/gooddata-api-client/docs/models/JsonApiUserDataFilterInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserDataFilterInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_data_filter_in_document.JsonApiUserDataFilterInDocument +# gooddata_api_client.models.json_api_user_data_filter_in_document.JsonApiUserDataFilterInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserDataFilterOut.md b/gooddata-api-client/docs/models/JsonApiUserDataFilterOut.md index 00b8b8f80..ad4f44a9a 100644 --- a/gooddata-api-client/docs/models/JsonApiUserDataFilterOut.md +++ b/gooddata-api-client/docs/models/JsonApiUserDataFilterOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_data_filter_out.JsonApiUserDataFilterOut +# gooddata_api_client.models.json_api_user_data_filter_out.JsonApiUserDataFilterOut JSON:API representation of userDataFilter entity. @@ -184,4 +184,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserDataFilterOutDocument.md b/gooddata-api-client/docs/models/JsonApiUserDataFilterOutDocument.md index fa610688a..23f45679a 100644 --- a/gooddata-api-client/docs/models/JsonApiUserDataFilterOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserDataFilterOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_data_filter_out_document.JsonApiUserDataFilterOutDocument +# gooddata_api_client.models.json_api_user_data_filter_out_document.JsonApiUserDataFilterOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiUserDataFilterOutIncludes**](JsonApiUserDataFilterOutIncludes.md) | [**JsonApiUserDataFilterOutIncludes**](JsonApiUserDataFilterOutIncludes.md) | [**JsonApiUserDataFilterOutIncludes**](JsonApiUserDataFilterOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserDataFilterOutIncludes.md b/gooddata-api-client/docs/models/JsonApiUserDataFilterOutIncludes.md index 42f66b3c3..953423354 100644 --- a/gooddata-api-client/docs/models/JsonApiUserDataFilterOutIncludes.md +++ b/gooddata-api-client/docs/models/JsonApiUserDataFilterOutIncludes.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_data_filter_out_includes.JsonApiUserDataFilterOutIncludes +# gooddata_api_client.models.json_api_user_data_filter_out_includes.JsonApiUserDataFilterOutIncludes ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -18,4 +18,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiDatasetOutWithLinks](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserDataFilterOutList.md b/gooddata-api-client/docs/models/JsonApiUserDataFilterOutList.md index cd8bcc607..c5c49d5ee 100644 --- a/gooddata-api-client/docs/models/JsonApiUserDataFilterOutList.md +++ b/gooddata-api-client/docs/models/JsonApiUserDataFilterOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_data_filter_out_list.JsonApiUserDataFilterOutList +# gooddata_api_client.models.json_api_user_data_filter_out_list.JsonApiUserDataFilterOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiUserDataFilterOutIncludes**](JsonApiUserDataFilterOutIncludes.md) | [**JsonApiUserDataFilterOutIncludes**](JsonApiUserDataFilterOutIncludes.md) | [**JsonApiUserDataFilterOutIncludes**](JsonApiUserDataFilterOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserDataFilterOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiUserDataFilterOutWithLinks.md index 6665da856..6c82cf4bd 100644 --- a/gooddata-api-client/docs/models/JsonApiUserDataFilterOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiUserDataFilterOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_data_filter_out_with_links.JsonApiUserDataFilterOutWithLinks +# gooddata_api_client.models.json_api_user_data_filter_out_with_links.JsonApiUserDataFilterOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserDataFilterPatch.md b/gooddata-api-client/docs/models/JsonApiUserDataFilterPatch.md index 9c1c16531..d9a8da5d2 100644 --- a/gooddata-api-client/docs/models/JsonApiUserDataFilterPatch.md +++ b/gooddata-api-client/docs/models/JsonApiUserDataFilterPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_data_filter_patch.JsonApiUserDataFilterPatch +# gooddata_api_client.models.json_api_user_data_filter_patch.JsonApiUserDataFilterPatch JSON:API representation of patching userDataFilter entity. @@ -86,4 +86,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserDataFilterPatchDocument.md b/gooddata-api-client/docs/models/JsonApiUserDataFilterPatchDocument.md index ffcfd03dc..0cbb19774 100644 --- a/gooddata-api-client/docs/models/JsonApiUserDataFilterPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserDataFilterPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_data_filter_patch_document.JsonApiUserDataFilterPatchDocument +# gooddata_api_client.models.json_api_user_data_filter_patch_document.JsonApiUserDataFilterPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserDataFilterPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiUserDataFilterPostOptionalId.md index afc0c9a6a..e8153cf6f 100644 --- a/gooddata-api-client/docs/models/JsonApiUserDataFilterPostOptionalId.md +++ b/gooddata-api-client/docs/models/JsonApiUserDataFilterPostOptionalId.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_data_filter_post_optional_id.JsonApiUserDataFilterPostOptionalId +# gooddata_api_client.models.json_api_user_data_filter_post_optional_id.JsonApiUserDataFilterPostOptionalId JSON:API representation of userDataFilter entity. @@ -86,4 +86,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserDataFilterPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiUserDataFilterPostOptionalIdDocument.md index 607009639..29bf3521d 100644 --- a/gooddata-api-client/docs/models/JsonApiUserDataFilterPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserDataFilterPostOptionalIdDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document.JsonApiUserDataFilterPostOptionalIdDocument +# gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document.JsonApiUserDataFilterPostOptionalIdDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserGroupIn.md b/gooddata-api-client/docs/models/JsonApiUserGroupIn.md index 6aa1d8e54..efa0cd549 100644 --- a/gooddata-api-client/docs/models/JsonApiUserGroupIn.md +++ b/gooddata-api-client/docs/models/JsonApiUserGroupIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_group_in.JsonApiUserGroupIn +# gooddata_api_client.models.json_api_user_group_in.JsonApiUserGroupIn JSON:API representation of userGroup entity. @@ -56,4 +56,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserGroupInDocument.md b/gooddata-api-client/docs/models/JsonApiUserGroupInDocument.md index 1d3a37e95..facfe1cae 100644 --- a/gooddata-api-client/docs/models/JsonApiUserGroupInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserGroupInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_group_in_document.JsonApiUserGroupInDocument +# gooddata_api_client.models.json_api_user_group_in_document.JsonApiUserGroupInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserGroupLinkage.md b/gooddata-api-client/docs/models/JsonApiUserGroupLinkage.md index d20603c45..040162344 100644 --- a/gooddata-api-client/docs/models/JsonApiUserGroupLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiUserGroupLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_group_linkage.JsonApiUserGroupLinkage +# gooddata_api_client.models.json_api_user_group_linkage.JsonApiUserGroupLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserGroupOut.md b/gooddata-api-client/docs/models/JsonApiUserGroupOut.md index c29147569..a74469bfb 100644 --- a/gooddata-api-client/docs/models/JsonApiUserGroupOut.md +++ b/gooddata-api-client/docs/models/JsonApiUserGroupOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_group_out.JsonApiUserGroupOut +# gooddata_api_client.models.json_api_user_group_out.JsonApiUserGroupOut JSON:API representation of userGroup entity. @@ -56,4 +56,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserGroupOutDocument.md b/gooddata-api-client/docs/models/JsonApiUserGroupOutDocument.md index 5287fa633..31db0cf3e 100644 --- a/gooddata-api-client/docs/models/JsonApiUserGroupOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserGroupOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_group_out_document.JsonApiUserGroupOutDocument +# gooddata_api_client.models.json_api_user_group_out_document.JsonApiUserGroupOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserGroupOutList.md b/gooddata-api-client/docs/models/JsonApiUserGroupOutList.md index 3c8ce356d..7a34f23bf 100644 --- a/gooddata-api-client/docs/models/JsonApiUserGroupOutList.md +++ b/gooddata-api-client/docs/models/JsonApiUserGroupOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_group_out_list.JsonApiUserGroupOutList +# gooddata_api_client.models.json_api_user_group_out_list.JsonApiUserGroupOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserGroupOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiUserGroupOutWithLinks.md index 7f1ff33c1..ef3d12c1b 100644 --- a/gooddata-api-client/docs/models/JsonApiUserGroupOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiUserGroupOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_group_out_with_links.JsonApiUserGroupOutWithLinks +# gooddata_api_client.models.json_api_user_group_out_with_links.JsonApiUserGroupOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserGroupPatch.md b/gooddata-api-client/docs/models/JsonApiUserGroupPatch.md index a07a26aeb..d193d9abc 100644 --- a/gooddata-api-client/docs/models/JsonApiUserGroupPatch.md +++ b/gooddata-api-client/docs/models/JsonApiUserGroupPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_group_patch.JsonApiUserGroupPatch +# gooddata_api_client.models.json_api_user_group_patch.JsonApiUserGroupPatch JSON:API representation of patching userGroup entity. @@ -56,4 +56,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserGroupPatchDocument.md b/gooddata-api-client/docs/models/JsonApiUserGroupPatchDocument.md index 7af53cfc2..04bbf54ff 100644 --- a/gooddata-api-client/docs/models/JsonApiUserGroupPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserGroupPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_group_patch_document.JsonApiUserGroupPatchDocument +# gooddata_api_client.models.json_api_user_group_patch_document.JsonApiUserGroupPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserGroupToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiUserGroupToManyLinkage.md index 0ab610283..0eb8edede 100644 --- a/gooddata-api-client/docs/models/JsonApiUserGroupToManyLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiUserGroupToManyLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_group_to_many_linkage.JsonApiUserGroupToManyLinkage +# gooddata_api_client.models.json_api_user_group_to_many_linkage.JsonApiUserGroupToManyLinkage References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiUserGroupLinkage**](JsonApiUserGroupLinkage.md) | [**JsonApiUserGroupLinkage**](JsonApiUserGroupLinkage.md) | [**JsonApiUserGroupLinkage**](JsonApiUserGroupLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserGroupToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiUserGroupToOneLinkage.md index 2c0d45e6d..c65bad016 100644 --- a/gooddata-api-client/docs/models/JsonApiUserGroupToOneLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiUserGroupToOneLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_group_to_one_linkage.JsonApiUserGroupToOneLinkage +# gooddata_api_client.models.json_api_user_group_to_one_linkage.JsonApiUserGroupToOneLinkage References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -14,4 +14,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiUserGroupLinkage](JsonApiUserGroupLinkage.md) | [**JsonApiUserGroupLinkage**](JsonApiUserGroupLinkage.md) | [**JsonApiUserGroupLinkage**](JsonApiUserGroupLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserIn.md b/gooddata-api-client/docs/models/JsonApiUserIn.md index 9d1a7ceb1..911761aef 100644 --- a/gooddata-api-client/docs/models/JsonApiUserIn.md +++ b/gooddata-api-client/docs/models/JsonApiUserIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_in.JsonApiUserIn +# gooddata_api_client.models.json_api_user_in.JsonApiUserIn JSON:API representation of user entity. @@ -59,4 +59,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserInDocument.md b/gooddata-api-client/docs/models/JsonApiUserInDocument.md index 803d7158e..9d0ad6e4a 100644 --- a/gooddata-api-client/docs/models/JsonApiUserInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_in_document.JsonApiUserInDocument +# gooddata_api_client.models.json_api_user_in_document.JsonApiUserInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserLinkage.md b/gooddata-api-client/docs/models/JsonApiUserLinkage.md index 0e0630698..fcf9688b0 100644 --- a/gooddata-api-client/docs/models/JsonApiUserLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiUserLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_linkage.JsonApiUserLinkage +# gooddata_api_client.models.json_api_user_linkage.JsonApiUserLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserOut.md b/gooddata-api-client/docs/models/JsonApiUserOut.md index 041a76628..bb8cdb07b 100644 --- a/gooddata-api-client/docs/models/JsonApiUserOut.md +++ b/gooddata-api-client/docs/models/JsonApiUserOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_out.JsonApiUserOut +# gooddata_api_client.models.json_api_user_out.JsonApiUserOut JSON:API representation of user entity. @@ -59,4 +59,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserOutDocument.md b/gooddata-api-client/docs/models/JsonApiUserOutDocument.md index 517db39cc..b9492bc93 100644 --- a/gooddata-api-client/docs/models/JsonApiUserOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_out_document.JsonApiUserOutDocument +# gooddata_api_client.models.json_api_user_out_document.JsonApiUserOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserOutList.md b/gooddata-api-client/docs/models/JsonApiUserOutList.md index 3ec030220..bed66d4d5 100644 --- a/gooddata-api-client/docs/models/JsonApiUserOutList.md +++ b/gooddata-api-client/docs/models/JsonApiUserOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_out_list.JsonApiUserOutList +# gooddata_api_client.models.json_api_user_out_list.JsonApiUserOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | [**JsonApiUserGroupOutWithLinks**](JsonApiUserGroupOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiUserOutWithLinks.md index b47430bf4..26c5811d3 100644 --- a/gooddata-api-client/docs/models/JsonApiUserOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiUserOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_out_with_links.JsonApiUserOutWithLinks +# gooddata_api_client.models.json_api_user_out_with_links.JsonApiUserOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserPatch.md b/gooddata-api-client/docs/models/JsonApiUserPatch.md index 7ed2d9b17..9e88e7bd6 100644 --- a/gooddata-api-client/docs/models/JsonApiUserPatch.md +++ b/gooddata-api-client/docs/models/JsonApiUserPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_patch.JsonApiUserPatch +# gooddata_api_client.models.json_api_user_patch.JsonApiUserPatch JSON:API representation of patching user entity. @@ -59,4 +59,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserPatchDocument.md b/gooddata-api-client/docs/models/JsonApiUserPatchDocument.md index 0e7981108..9c707cb91 100644 --- a/gooddata-api-client/docs/models/JsonApiUserPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_patch_document.JsonApiUserPatchDocument +# gooddata_api_client.models.json_api_user_patch_document.JsonApiUserPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserSettingIn.md b/gooddata-api-client/docs/models/JsonApiUserSettingIn.md index 7f45a43e9..b417bf1c7 100644 --- a/gooddata-api-client/docs/models/JsonApiUserSettingIn.md +++ b/gooddata-api-client/docs/models/JsonApiUserSettingIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_setting_in.JsonApiUserSettingIn +# gooddata_api_client.models.json_api_user_setting_in.JsonApiUserSettingIn JSON:API representation of userSetting entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserSettingInDocument.md b/gooddata-api-client/docs/models/JsonApiUserSettingInDocument.md index 385f22d0d..06b9959b2 100644 --- a/gooddata-api-client/docs/models/JsonApiUserSettingInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserSettingInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_setting_in_document.JsonApiUserSettingInDocument +# gooddata_api_client.models.json_api_user_setting_in_document.JsonApiUserSettingInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserSettingOut.md b/gooddata-api-client/docs/models/JsonApiUserSettingOut.md index 6a25d0424..ecb0f7c64 100644 --- a/gooddata-api-client/docs/models/JsonApiUserSettingOut.md +++ b/gooddata-api-client/docs/models/JsonApiUserSettingOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_setting_out.JsonApiUserSettingOut +# gooddata_api_client.models.json_api_user_setting_out.JsonApiUserSettingOut JSON:API representation of userSetting entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserSettingOutDocument.md b/gooddata-api-client/docs/models/JsonApiUserSettingOutDocument.md index 9010d0580..3fcf7e761 100644 --- a/gooddata-api-client/docs/models/JsonApiUserSettingOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiUserSettingOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_setting_out_document.JsonApiUserSettingOutDocument +# gooddata_api_client.models.json_api_user_setting_out_document.JsonApiUserSettingOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserSettingOutList.md b/gooddata-api-client/docs/models/JsonApiUserSettingOutList.md index c552b3dcc..cf9162e04 100644 --- a/gooddata-api-client/docs/models/JsonApiUserSettingOutList.md +++ b/gooddata-api-client/docs/models/JsonApiUserSettingOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_setting_out_list.JsonApiUserSettingOutList +# gooddata_api_client.models.json_api_user_setting_out_list.JsonApiUserSettingOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiUserSettingOutWithLinks**](JsonApiUserSettingOutWithLinks.md) | [**JsonApiUserSettingOutWithLinks**](JsonApiUserSettingOutWithLinks.md) | [**JsonApiUserSettingOutWithLinks**](JsonApiUserSettingOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserSettingOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiUserSettingOutWithLinks.md index 43ac59e5d..312379ed4 100644 --- a/gooddata-api-client/docs/models/JsonApiUserSettingOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiUserSettingOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_setting_out_with_links.JsonApiUserSettingOutWithLinks +# gooddata_api_client.models.json_api_user_setting_out_with_links.JsonApiUserSettingOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiUserToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiUserToOneLinkage.md index 066cce93c..7c4ecddb7 100644 --- a/gooddata-api-client/docs/models/JsonApiUserToOneLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiUserToOneLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_user_to_one_linkage.JsonApiUserToOneLinkage +# gooddata_api_client.models.json_api_user_to_one_linkage.JsonApiUserToOneLinkage References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -14,4 +14,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiUserLinkage](JsonApiUserLinkage.md) | [**JsonApiUserLinkage**](JsonApiUserLinkage.md) | [**JsonApiUserLinkage**](JsonApiUserLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectIn.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectIn.md index 76a4e1bbb..a1462a6ff 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectIn.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_in.JsonApiVisualizationObjectIn +# gooddata_api_client.models.json_api_visualization_object_in.JsonApiVisualizationObjectIn JSON:API representation of visualizationObject entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectInDocument.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectInDocument.md index 542386360..cd9d3261b 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_in_document.JsonApiVisualizationObjectInDocument +# gooddata_api_client.models.json_api_visualization_object_in_document.JsonApiVisualizationObjectInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectLinkage.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectLinkage.md index eacd56e99..cf2935b10 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_linkage.JsonApiVisualizationObjectLinkage +# gooddata_api_client.models.json_api_visualization_object_linkage.JsonApiVisualizationObjectLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectOut.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectOut.md index e664f1ce3..b57943dfc 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectOut.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_out.JsonApiVisualizationObjectOut +# gooddata_api_client.models.json_api_visualization_object_out.JsonApiVisualizationObjectOut JSON:API representation of visualizationObject entity. @@ -165,4 +165,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutDocument.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutDocument.md index 6a1aceefc..815a69383 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_out_document.JsonApiVisualizationObjectOutDocument +# gooddata_api_client.models.json_api_visualization_object_out_document.JsonApiVisualizationObjectOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutList.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutList.md index 5d3a325b1..8c1426721 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutList.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_out_list.JsonApiVisualizationObjectOutList +# gooddata_api_client.models.json_api_visualization_object_out_list.JsonApiVisualizationObjectOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | [**JsonApiMetricOutIncludes**](JsonApiMetricOutIncludes.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutWithLinks.md index f4c2b02cb..6f2f6b4a7 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_out_with_links.JsonApiVisualizationObjectOutWithLinks +# gooddata_api_client.models.json_api_visualization_object_out_with_links.JsonApiVisualizationObjectOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectPatch.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectPatch.md index 3ac00d1ec..2a3833041 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectPatch.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_patch.JsonApiVisualizationObjectPatch +# gooddata_api_client.models.json_api_visualization_object_patch.JsonApiVisualizationObjectPatch JSON:API representation of patching visualizationObject entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectPatchDocument.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectPatchDocument.md index 3be310547..f144fc486 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_patch_document.JsonApiVisualizationObjectPatchDocument +# gooddata_api_client.models.json_api_visualization_object_patch_document.JsonApiVisualizationObjectPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectPostOptionalId.md index c8543eba7..afbcb413c 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectPostOptionalId.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectPostOptionalId.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_post_optional_id.JsonApiVisualizationObjectPostOptionalId +# gooddata_api_client.models.json_api_visualization_object_post_optional_id.JsonApiVisualizationObjectPostOptionalId JSON:API representation of visualizationObject entity. @@ -54,4 +54,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectPostOptionalIdDocument.md index 9ddfc2fb4..ef36c0038 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectPostOptionalIdDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_post_optional_id_document.JsonApiVisualizationObjectPostOptionalIdDocument +# gooddata_api_client.models.json_api_visualization_object_post_optional_id_document.JsonApiVisualizationObjectPostOptionalIdDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectToManyLinkage.md index 7187ecdfa..100ac0d07 100644 --- a/gooddata-api-client/docs/models/JsonApiVisualizationObjectToManyLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectToManyLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_visualization_object_to_many_linkage.JsonApiVisualizationObjectToManyLinkage +# gooddata_api_client.models.json_api_visualization_object_to_many_linkage.JsonApiVisualizationObjectToManyLinkage References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiVisualizationObjectLinkage**](JsonApiVisualizationObjectLinkage.md) | [**JsonApiVisualizationObjectLinkage**](JsonApiVisualizationObjectLinkage.md) | [**JsonApiVisualizationObjectLinkage**](JsonApiVisualizationObjectLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterIn.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterIn.md index dd03cd21b..4daabd0c6 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterIn.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_in.JsonApiWorkspaceDataFilterIn +# gooddata_api_client.models.json_api_workspace_data_filter_in.JsonApiWorkspaceDataFilterIn JSON:API representation of workspaceDataFilter entity. @@ -58,4 +58,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterInDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterInDocument.md index 0f4b5c8a2..acb30ab51 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_in_document.JsonApiWorkspaceDataFilterInDocument +# gooddata_api_client.models.json_api_workspace_data_filter_in_document.JsonApiWorkspaceDataFilterInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterLinkage.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterLinkage.md index 12c76a9e6..b39af6249 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_linkage.JsonApiWorkspaceDataFilterLinkage +# gooddata_api_client.models.json_api_workspace_data_filter_linkage.JsonApiWorkspaceDataFilterLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOut.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOut.md index 7aa6cfd63..3b16fecf6 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOut.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_out.JsonApiWorkspaceDataFilterOut +# gooddata_api_client.models.json_api_workspace_data_filter_out.JsonApiWorkspaceDataFilterOut JSON:API representation of workspaceDataFilter entity. @@ -58,4 +58,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutDocument.md index d7df7783f..a806aa6b2 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_out_document.JsonApiWorkspaceDataFilterOutDocument +# gooddata_api_client.models.json_api_workspace_data_filter_out_document.JsonApiWorkspaceDataFilterOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiWorkspaceDataFilterSettingOutWithLinks**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | [**JsonApiWorkspaceDataFilterSettingOutWithLinks**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | [**JsonApiWorkspaceDataFilterSettingOutWithLinks**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutList.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutList.md index b1ccecb43..09299ddd6 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutList.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_out_list.JsonApiWorkspaceDataFilterOutList +# gooddata_api_client.models.json_api_workspace_data_filter_out_list.JsonApiWorkspaceDataFilterOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiWorkspaceDataFilterSettingOutWithLinks**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | [**JsonApiWorkspaceDataFilterSettingOutWithLinks**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | [**JsonApiWorkspaceDataFilterSettingOutWithLinks**](JsonApiWorkspaceDataFilterSettingOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutWithLinks.md index c5cbbdd25..51ecbef45 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_out_with_links.JsonApiWorkspaceDataFilterOutWithLinks +# gooddata_api_client.models.json_api_workspace_data_filter_out_with_links.JsonApiWorkspaceDataFilterOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterPatch.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterPatch.md index 19f57f06a..5e213e541 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterPatch.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_patch.JsonApiWorkspaceDataFilterPatch +# gooddata_api_client.models.json_api_workspace_data_filter_patch.JsonApiWorkspaceDataFilterPatch JSON:API representation of patching workspaceDataFilter entity. @@ -58,4 +58,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterPatchDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterPatchDocument.md index 849f31dae..f05a67f31 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_patch_document.JsonApiWorkspaceDataFilterPatchDocument +# gooddata_api_client.models.json_api_workspace_data_filter_patch_document.JsonApiWorkspaceDataFilterPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingLinkage.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingLinkage.md index 25744e923..18fa49777 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_setting_linkage.JsonApiWorkspaceDataFilterSettingLinkage +# gooddata_api_client.models.json_api_workspace_data_filter_setting_linkage.JsonApiWorkspaceDataFilterSettingLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOut.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOut.md index 58072cd5c..228e0a8bb 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOut.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_setting_out.JsonApiWorkspaceDataFilterSettingOut +# gooddata_api_client.models.json_api_workspace_data_filter_setting_out.JsonApiWorkspaceDataFilterSettingOut JSON:API representation of workspaceDataFilterSetting entity. @@ -70,4 +70,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutDocument.md index 40118086d..6de2f8a8e 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document.JsonApiWorkspaceDataFilterSettingOutDocument +# gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document.JsonApiWorkspaceDataFilterSettingOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiWorkspaceDataFilterOutWithLinks**](JsonApiWorkspaceDataFilterOutWithLinks.md) | [**JsonApiWorkspaceDataFilterOutWithLinks**](JsonApiWorkspaceDataFilterOutWithLinks.md) | [**JsonApiWorkspaceDataFilterOutWithLinks**](JsonApiWorkspaceDataFilterOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutList.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutList.md index 056ed3b3c..8f0784968 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutList.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list.JsonApiWorkspaceDataFilterSettingOutList +# gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list.JsonApiWorkspaceDataFilterSettingOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiWorkspaceDataFilterOutWithLinks**](JsonApiWorkspaceDataFilterOutWithLinks.md) | [**JsonApiWorkspaceDataFilterOutWithLinks**](JsonApiWorkspaceDataFilterOutWithLinks.md) | [**JsonApiWorkspaceDataFilterOutWithLinks**](JsonApiWorkspaceDataFilterOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutWithLinks.md index f6dbd80c2..6e8bc3656 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_setting_out_with_links.JsonApiWorkspaceDataFilterSettingOutWithLinks +# gooddata_api_client.models.json_api_workspace_data_filter_setting_out_with_links.JsonApiWorkspaceDataFilterSettingOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingToManyLinkage.md index 354aaf3ef..8abdd12b4 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingToManyLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingToManyLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_setting_to_many_linkage.JsonApiWorkspaceDataFilterSettingToManyLinkage +# gooddata_api_client.models.json_api_workspace_data_filter_setting_to_many_linkage.JsonApiWorkspaceDataFilterSettingToManyLinkage References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiWorkspaceDataFilterSettingLinkage**](JsonApiWorkspaceDataFilterSettingLinkage.md) | [**JsonApiWorkspaceDataFilterSettingLinkage**](JsonApiWorkspaceDataFilterSettingLinkage.md) | [**JsonApiWorkspaceDataFilterSettingLinkage**](JsonApiWorkspaceDataFilterSettingLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterToOneLinkage.md index ce7cd85ef..1b9470a2a 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterToOneLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterToOneLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_data_filter_to_one_linkage.JsonApiWorkspaceDataFilterToOneLinkage +# gooddata_api_client.models.json_api_workspace_data_filter_to_one_linkage.JsonApiWorkspaceDataFilterToOneLinkage References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -14,4 +14,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiWorkspaceDataFilterLinkage](JsonApiWorkspaceDataFilterLinkage.md) | [**JsonApiWorkspaceDataFilterLinkage**](JsonApiWorkspaceDataFilterLinkage.md) | [**JsonApiWorkspaceDataFilterLinkage**](JsonApiWorkspaceDataFilterLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceIn.md b/gooddata-api-client/docs/models/JsonApiWorkspaceIn.md index 9b5c57625..931e64450 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceIn.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_in.JsonApiWorkspaceIn +# gooddata_api_client.models.json_api_workspace_in.JsonApiWorkspaceIn JSON:API representation of workspace entity. @@ -59,4 +59,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceInDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceInDocument.md index 0664791c2..06303d2cd 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_in_document.JsonApiWorkspaceInDocument +# gooddata_api_client.models.json_api_workspace_in_document.JsonApiWorkspaceInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceLinkage.md b/gooddata-api-client/docs/models/JsonApiWorkspaceLinkage.md index a2920d516..90d58e77b 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_linkage.JsonApiWorkspaceLinkage +# gooddata_api_client.models.json_api_workspace_linkage.JsonApiWorkspaceLinkage The \\\"type\\\" and \\\"id\\\" to non-empty members. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceOut.md b/gooddata-api-client/docs/models/JsonApiWorkspaceOut.md index 7a182e6b1..7181b44c7 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceOut.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_out.JsonApiWorkspaceOut +# gooddata_api_client.models.json_api_workspace_out.JsonApiWorkspaceOut JSON:API representation of workspace entity. @@ -103,4 +103,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceOutDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceOutDocument.md index ef27b2f3f..d159207e5 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_out_document.JsonApiWorkspaceOutDocument +# gooddata_api_client.models.json_api_workspace_out_document.JsonApiWorkspaceOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiWorkspaceOutWithLinks**](JsonApiWorkspaceOutWithLinks.md) | [**JsonApiWorkspaceOutWithLinks**](JsonApiWorkspaceOutWithLinks.md) | [**JsonApiWorkspaceOutWithLinks**](JsonApiWorkspaceOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceOutList.md b/gooddata-api-client/docs/models/JsonApiWorkspaceOutList.md index 3b2d4ec8d..47b88f7d1 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceOutList.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_out_list.JsonApiWorkspaceOutList +# gooddata_api_client.models.json_api_workspace_out_list.JsonApiWorkspaceOutList A JSON:API document with a list of resources @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiWorkspaceOutWithLinks**](JsonApiWorkspaceOutWithLinks.md) | [**JsonApiWorkspaceOutWithLinks**](JsonApiWorkspaceOutWithLinks.md) | [**JsonApiWorkspaceOutWithLinks**](JsonApiWorkspaceOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiWorkspaceOutWithLinks.md index 32af13dbf..4f4db1f34 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_out_with_links.JsonApiWorkspaceOutWithLinks +# gooddata_api_client.models.json_api_workspace_out_with_links.JsonApiWorkspaceOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspacePatch.md b/gooddata-api-client/docs/models/JsonApiWorkspacePatch.md index 61e685196..bc21e5ea7 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspacePatch.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspacePatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_patch.JsonApiWorkspacePatch +# gooddata_api_client.models.json_api_workspace_patch.JsonApiWorkspacePatch JSON:API representation of patching workspace entity. @@ -59,4 +59,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspacePatchDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspacePatchDocument.md index 872f3ced9..c04041310 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspacePatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspacePatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_patch_document.JsonApiWorkspacePatchDocument +# gooddata_api_client.models.json_api_workspace_patch_document.JsonApiWorkspacePatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingIn.md b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingIn.md index b9ab1f802..70be11e6f 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingIn.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingIn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_setting_in.JsonApiWorkspaceSettingIn +# gooddata_api_client.models.json_api_workspace_setting_in.JsonApiWorkspaceSettingIn JSON:API representation of workspaceSetting entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingInDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingInDocument.md index fbb3366b1..2c75c2d8b 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingInDocument.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingInDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_setting_in_document.JsonApiWorkspaceSettingInDocument +# gooddata_api_client.models.json_api_workspace_setting_in_document.JsonApiWorkspaceSettingInDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOut.md b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOut.md index 3b261fc7d..845d2ccb8 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOut.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_setting_out.JsonApiWorkspaceSettingOut +# gooddata_api_client.models.json_api_workspace_setting_out.JsonApiWorkspaceSettingOut JSON:API representation of workspaceSetting entity. @@ -65,4 +65,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutDocument.md index 45e07ee1b..8fa30bfa8 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutDocument.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_setting_out_document.JsonApiWorkspaceSettingOutDocument +# gooddata_api_client.models.json_api_workspace_setting_out_document.JsonApiWorkspaceSettingOutDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutList.md b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutList.md index 44de5dab0..c237b4fc6 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutList.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutList.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_setting_out_list.JsonApiWorkspaceSettingOutList +# gooddata_api_client.models.json_api_workspace_setting_out_list.JsonApiWorkspaceSettingOutList A JSON:API document with a list of resources @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**JsonApiWorkspaceSettingOutWithLinks**](JsonApiWorkspaceSettingOutWithLinks.md) | [**JsonApiWorkspaceSettingOutWithLinks**](JsonApiWorkspaceSettingOutWithLinks.md) | [**JsonApiWorkspaceSettingOutWithLinks**](JsonApiWorkspaceSettingOutWithLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutWithLinks.md index 99d84c47e..5d8cad0ae 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutWithLinks.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingOutWithLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_setting_out_with_links.JsonApiWorkspaceSettingOutWithLinks +# gooddata_api_client.models.json_api_workspace_setting_out_with_links.JsonApiWorkspaceSettingOutWithLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPatch.md b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPatch.md index 784e5299c..8f7c5ed12 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPatch.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPatch.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_setting_patch.JsonApiWorkspaceSettingPatch +# gooddata_api_client.models.json_api_workspace_setting_patch.JsonApiWorkspaceSettingPatch JSON:API representation of patching workspaceSetting entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPatchDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPatchDocument.md index 3cab8612a..aeaaa91b2 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPatchDocument.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPatchDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_setting_patch_document.JsonApiWorkspaceSettingPatchDocument +# gooddata_api_client.models.json_api_workspace_setting_patch_document.JsonApiWorkspaceSettingPatchDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPostOptionalId.md index 5675ff88b..6acfe10bb 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPostOptionalId.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPostOptionalId.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_setting_post_optional_id.JsonApiWorkspaceSettingPostOptionalId +# gooddata_api_client.models.json_api_workspace_setting_post_optional_id.JsonApiWorkspaceSettingPostOptionalId JSON:API representation of workspaceSetting entity. @@ -37,4 +37,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPostOptionalIdDocument.md index 8767613ad..c1a5392df 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPostOptionalIdDocument.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceSettingPostOptionalIdDocument.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document.JsonApiWorkspaceSettingPostOptionalIdDocument +# gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document.JsonApiWorkspaceSettingPostOptionalIdDocument ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiWorkspaceToOneLinkage.md index b668a2e78..6a8acc994 100644 --- a/gooddata-api-client/docs/models/JsonApiWorkspaceToOneLinkage.md +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceToOneLinkage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.json_api_workspace_to_one_linkage.JsonApiWorkspaceToOneLinkage +# gooddata_api_client.models.json_api_workspace_to_one_linkage.JsonApiWorkspaceToOneLinkage References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. @@ -14,4 +14,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [JsonApiWorkspaceLinkage](JsonApiWorkspaceLinkage.md) | [**JsonApiWorkspaceLinkage**](JsonApiWorkspaceLinkage.md) | [**JsonApiWorkspaceLinkage**](JsonApiWorkspaceLinkage.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/LabelIdentifier.md b/gooddata-api-client/docs/models/LabelIdentifier.md index f1dcdf394..2333ddd82 100644 --- a/gooddata-api-client/docs/models/LabelIdentifier.md +++ b/gooddata-api-client/docs/models/LabelIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.label_identifier.LabelIdentifier +# gooddata_api_client.models.label_identifier.LabelIdentifier A label identifier. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ListLinks.md b/gooddata-api-client/docs/models/ListLinks.md index e546da843..e5867252a 100644 --- a/gooddata-api-client/docs/models/ListLinks.md +++ b/gooddata-api-client/docs/models/ListLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.list_links.ListLinks +# gooddata_api_client.models.list_links.ListLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -26,4 +26,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/MeasureDefinition.md b/gooddata-api-client/docs/models/MeasureDefinition.md index 5995512ca..16e44ee54 100644 --- a/gooddata-api-client/docs/models/MeasureDefinition.md +++ b/gooddata-api-client/docs/models/MeasureDefinition.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.measure_definition.MeasureDefinition +# gooddata_api_client.models.measure_definition.MeasureDefinition Abstract metric definition type @@ -17,4 +17,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [PopMeasureDefinition](PopMeasureDefinition.md) | [**PopMeasureDefinition**](PopMeasureDefinition.md) | [**PopMeasureDefinition**](PopMeasureDefinition.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/MeasureExecutionResultHeader.md b/gooddata-api-client/docs/models/MeasureExecutionResultHeader.md index dbdada421..8b7cbe387 100644 --- a/gooddata-api-client/docs/models/MeasureExecutionResultHeader.md +++ b/gooddata-api-client/docs/models/MeasureExecutionResultHeader.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.measure_execution_result_header.MeasureExecutionResultHeader +# gooddata_api_client.models.measure_execution_result_header.MeasureExecutionResultHeader ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/MeasureGroupHeaders.md b/gooddata-api-client/docs/models/MeasureGroupHeaders.md index 72b65eb63..576c7e352 100644 --- a/gooddata-api-client/docs/models/MeasureGroupHeaders.md +++ b/gooddata-api-client/docs/models/MeasureGroupHeaders.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.measure_group_headers.MeasureGroupHeaders +# gooddata_api_client.models.measure_group_headers.MeasureGroupHeaders ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -24,4 +24,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**MeasureHeaderOut**](MeasureHeaderOut.md) | [**MeasureHeaderOut**](MeasureHeaderOut.md) | [**MeasureHeaderOut**](MeasureHeaderOut.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/MeasureHeaderOut.md b/gooddata-api-client/docs/models/MeasureHeaderOut.md index 6c021f012..ff995ce27 100644 --- a/gooddata-api-client/docs/models/MeasureHeaderOut.md +++ b/gooddata-api-client/docs/models/MeasureHeaderOut.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.measure_header_out.MeasureHeaderOut +# gooddata_api_client.models.measure_header_out.MeasureHeaderOut ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/MeasureItem.md b/gooddata-api-client/docs/models/MeasureItem.md index 8d3656888..97f54cff7 100644 --- a/gooddata-api-client/docs/models/MeasureItem.md +++ b/gooddata-api-client/docs/models/MeasureItem.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.measure_item.MeasureItem +# gooddata_api_client.models.measure_item.MeasureItem ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/MeasureResultHeader.md b/gooddata-api-client/docs/models/MeasureResultHeader.md index 4cdf17848..6b700537a 100644 --- a/gooddata-api-client/docs/models/MeasureResultHeader.md +++ b/gooddata-api-client/docs/models/MeasureResultHeader.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.measure_result_header.MeasureResultHeader +# gooddata_api_client.models.measure_result_header.MeasureResultHeader Header containing the information related to metrics. @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/MeasureValueFilter.md b/gooddata-api-client/docs/models/MeasureValueFilter.md index 52497ae03..9abd39244 100644 --- a/gooddata-api-client/docs/models/MeasureValueFilter.md +++ b/gooddata-api-client/docs/models/MeasureValueFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.measure_value_filter.MeasureValueFilter +# gooddata_api_client.models.measure_value_filter.MeasureValueFilter Abstract filter definition type filtering by the value of the metric. @@ -15,4 +15,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [RangeMeasureValueFilter](RangeMeasureValueFilter.md) | [**RangeMeasureValueFilter**](RangeMeasureValueFilter.md) | [**RangeMeasureValueFilter**](RangeMeasureValueFilter.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/NegativeAttributeFilter.md b/gooddata-api-client/docs/models/NegativeAttributeFilter.md index 6c0ccaaef..14549667b 100644 --- a/gooddata-api-client/docs/models/NegativeAttributeFilter.md +++ b/gooddata-api-client/docs/models/NegativeAttributeFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.negative_attribute_filter.NegativeAttributeFilter +# gooddata_api_client.models.negative_attribute_filter.NegativeAttributeFilter Filter able to limit element values by label and related selected negated elements. @@ -29,4 +29,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ObjectLinks.md b/gooddata-api-client/docs/models/ObjectLinks.md index d07c79784..b0baa5491 100644 --- a/gooddata-api-client/docs/models/ObjectLinks.md +++ b/gooddata-api-client/docs/models/ObjectLinks.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.object_links.ObjectLinks +# gooddata_api_client.models.object_links.ObjectLinks ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ObjectLinksContainer.md b/gooddata-api-client/docs/models/ObjectLinksContainer.md index 49b6bcdd0..45611e5f9 100644 --- a/gooddata-api-client/docs/models/ObjectLinksContainer.md +++ b/gooddata-api-client/docs/models/ObjectLinksContainer.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.object_links_container.ObjectLinksContainer +# gooddata_api_client.models.object_links_container.ObjectLinksContainer ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/Paging.md b/gooddata-api-client/docs/models/Paging.md index e72c72679..d6884b5b7 100644 --- a/gooddata-api-client/docs/models/Paging.md +++ b/gooddata-api-client/docs/models/Paging.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.paging.Paging +# gooddata_api_client.models.paging.Paging Current page description. @@ -17,4 +17,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/Parameter.md b/gooddata-api-client/docs/models/Parameter.md index 5f9b8ccea..feb312918 100644 --- a/gooddata-api-client/docs/models/Parameter.md +++ b/gooddata-api-client/docs/models/Parameter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.parameter.Parameter +# gooddata_api_client.models.parameter.Parameter ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PdfExportRequest.md b/gooddata-api-client/docs/models/PdfExportRequest.md index b5cb1e2e0..3f69b2c7e 100644 --- a/gooddata-api-client/docs/models/PdfExportRequest.md +++ b/gooddata-api-client/docs/models/PdfExportRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.pdf_export_request.PdfExportRequest +# gooddata_api_client.models.pdf_export_request.PdfExportRequest Export request object describing the export properties and metadata for pdf exports. @@ -25,4 +25,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | Custom setting content in JSON format. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PdmLdmRequest.md b/gooddata-api-client/docs/models/PdmLdmRequest.md index 530a83bc4..53cab3dac 100644 --- a/gooddata-api-client/docs/models/PdmLdmRequest.md +++ b/gooddata-api-client/docs/models/PdmLdmRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.pdm_ldm_request.PdmLdmRequest +# gooddata_api_client.models.pdm_ldm_request.PdmLdmRequest PDM additions wrapper. @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**PdmSql**](PdmSql.md) | [**PdmSql**](PdmSql.md) | [**PdmSql**](PdmSql.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PdmSql.md b/gooddata-api-client/docs/models/PdmSql.md index 60c5b0029..70be33b6c 100644 --- a/gooddata-api-client/docs/models/PdmSql.md +++ b/gooddata-api-client/docs/models/PdmSql.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.pdm_sql.PdmSql +# gooddata_api_client.models.pdm_sql.PdmSql SQL dataset definition. @@ -30,4 +30,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**SqlColumn**](SqlColumn.md) | [**SqlColumn**](SqlColumn.md) | [**SqlColumn**](SqlColumn.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PermissionsForAssignee.md b/gooddata-api-client/docs/models/PermissionsForAssignee.md index b06a68ab0..34bd5d843 100644 --- a/gooddata-api-client/docs/models/PermissionsForAssignee.md +++ b/gooddata-api-client/docs/models/PermissionsForAssignee.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.permissions_for_assignee.PermissionsForAssignee +# gooddata_api_client.models.permissions_for_assignee.PermissionsForAssignee Desired levels of permissions for an assignee. @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | must be one of ["EDIT", "SHARE", "VIEW", ] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PlatformUsage.md b/gooddata-api-client/docs/models/PlatformUsage.md index e45a20bcc..58bc296c1 100644 --- a/gooddata-api-client/docs/models/PlatformUsage.md +++ b/gooddata-api-client/docs/models/PlatformUsage.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.platform_usage.PlatformUsage +# gooddata_api_client.models.platform_usage.PlatformUsage ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PlatformUsageRequest.md b/gooddata-api-client/docs/models/PlatformUsageRequest.md index 9e26aac95..4b383b150 100644 --- a/gooddata-api-client/docs/models/PlatformUsageRequest.md +++ b/gooddata-api-client/docs/models/PlatformUsageRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.platform_usage_request.PlatformUsageRequest +# gooddata_api_client.models.platform_usage_request.PlatformUsageRequest ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -24,4 +24,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | must be one of ["UserCount", "WorkspaceCount", ] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PopDataset.md b/gooddata-api-client/docs/models/PopDataset.md index cfcfb4a74..ecc08db4f 100644 --- a/gooddata-api-client/docs/models/PopDataset.md +++ b/gooddata-api-client/docs/models/PopDataset.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.pop_dataset.PopDataset +# gooddata_api_client.models.pop_dataset.PopDataset ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PopDatasetMeasureDefinition.md b/gooddata-api-client/docs/models/PopDatasetMeasureDefinition.md index 7dee31cab..afe1e26b0 100644 --- a/gooddata-api-client/docs/models/PopDatasetMeasureDefinition.md +++ b/gooddata-api-client/docs/models/PopDatasetMeasureDefinition.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.pop_dataset_measure_definition.PopDatasetMeasureDefinition +# gooddata_api_client.models.pop_dataset_measure_definition.PopDatasetMeasureDefinition Previous period type of metric. @@ -40,4 +40,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**PopDataset**](PopDataset.md) | [**PopDataset**](PopDataset.md) | [**PopDataset**](PopDataset.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PopDate.md b/gooddata-api-client/docs/models/PopDate.md index fd761fb2d..f8e90a30a 100644 --- a/gooddata-api-client/docs/models/PopDate.md +++ b/gooddata-api-client/docs/models/PopDate.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.pop_date.PopDate +# gooddata_api_client.models.pop_date.PopDate ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PopDateMeasureDefinition.md b/gooddata-api-client/docs/models/PopDateMeasureDefinition.md index 813c5c09c..b0c7847c0 100644 --- a/gooddata-api-client/docs/models/PopDateMeasureDefinition.md +++ b/gooddata-api-client/docs/models/PopDateMeasureDefinition.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.pop_date_measure_definition.PopDateMeasureDefinition +# gooddata_api_client.models.pop_date_measure_definition.PopDateMeasureDefinition Period over period type of metric. @@ -40,4 +40,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**PopDate**](PopDate.md) | [**PopDate**](PopDate.md) | [**PopDate**](PopDate.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PopMeasureDefinition.md b/gooddata-api-client/docs/models/PopMeasureDefinition.md index 8d5841dfe..085eae442 100644 --- a/gooddata-api-client/docs/models/PopMeasureDefinition.md +++ b/gooddata-api-client/docs/models/PopMeasureDefinition.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.pop_measure_definition.PopMeasureDefinition +# gooddata_api_client.models.pop_measure_definition.PopMeasureDefinition ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [PopDateMeasureDefinition](PopDateMeasureDefinition.md) | [**PopDateMeasureDefinition**](PopDateMeasureDefinition.md) | [**PopDateMeasureDefinition**](PopDateMeasureDefinition.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/PositiveAttributeFilter.md b/gooddata-api-client/docs/models/PositiveAttributeFilter.md index 114f689aa..39985722d 100644 --- a/gooddata-api-client/docs/models/PositiveAttributeFilter.md +++ b/gooddata-api-client/docs/models/PositiveAttributeFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.positive_attribute_filter.PositiveAttributeFilter +# gooddata_api_client.models.positive_attribute_filter.PositiveAttributeFilter Filter able to limit element values by label and related selected elements. @@ -29,4 +29,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/RangeMeasureValueFilter.md b/gooddata-api-client/docs/models/RangeMeasureValueFilter.md index 619b32224..6cd06dd0f 100644 --- a/gooddata-api-client/docs/models/RangeMeasureValueFilter.md +++ b/gooddata-api-client/docs/models/RangeMeasureValueFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.range_measure_value_filter.RangeMeasureValueFilter +# gooddata_api_client.models.range_measure_value_filter.RangeMeasureValueFilter Filter the result by comparing specified metric to given range of values. @@ -32,4 +32,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/RankingFilter.md b/gooddata-api-client/docs/models/RankingFilter.md index 05f163e69..02449e95f 100644 --- a/gooddata-api-client/docs/models/RankingFilter.md +++ b/gooddata-api-client/docs/models/RankingFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.ranking_filter.RankingFilter +# gooddata_api_client.models.ranking_filter.RankingFilter Filter the result on top/bottom N values according to given metric(s). @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**AfmIdentifier**](AfmIdentifier.md) | [**AfmIdentifier**](AfmIdentifier.md) | [**AfmIdentifier**](AfmIdentifier.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ReferenceIdentifier.md b/gooddata-api-client/docs/models/ReferenceIdentifier.md index 06a59dce1..897fae04b 100644 --- a/gooddata-api-client/docs/models/ReferenceIdentifier.md +++ b/gooddata-api-client/docs/models/ReferenceIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.reference_identifier.ReferenceIdentifier +# gooddata_api_client.models.reference_identifier.ReferenceIdentifier A reference identifier. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/RelativeDateFilter.md b/gooddata-api-client/docs/models/RelativeDateFilter.md index 5210372ac..f676d62b5 100644 --- a/gooddata-api-client/docs/models/RelativeDateFilter.md +++ b/gooddata-api-client/docs/models/RelativeDateFilter.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.relative_date_filter.RelativeDateFilter +# gooddata_api_client.models.relative_date_filter.RelativeDateFilter A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. @@ -31,4 +31,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ResolveSettingsRequest.md b/gooddata-api-client/docs/models/ResolveSettingsRequest.md index 87e5fec92..836ffd7a7 100644 --- a/gooddata-api-client/docs/models/ResolveSettingsRequest.md +++ b/gooddata-api-client/docs/models/ResolveSettingsRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.resolve_settings_request.ResolveSettingsRequest +# gooddata_api_client.models.resolve_settings_request.ResolveSettingsRequest A request containing setting IDs to resolve. @@ -28,4 +28,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ResolvedSetting.md b/gooddata-api-client/docs/models/ResolvedSetting.md index 059001c1d..bb642c412 100644 --- a/gooddata-api-client/docs/models/ResolvedSetting.md +++ b/gooddata-api-client/docs/models/ResolvedSetting.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.resolved_setting.ResolvedSetting +# gooddata_api_client.models.resolved_setting.ResolvedSetting Setting and its value. @@ -25,4 +25,3 @@ Input Type | Accessed Type | Description | Notes dict, frozendict.frozendict, | frozendict.frozendict, | Custom setting content in JSON format. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/RestApiIdentifier.md b/gooddata-api-client/docs/models/RestApiIdentifier.md index 6fa533692..15708c483 100644 --- a/gooddata-api-client/docs/models/RestApiIdentifier.md +++ b/gooddata-api-client/docs/models/RestApiIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.rest_api_identifier.RestApiIdentifier +# gooddata_api_client.models.rest_api_identifier.RestApiIdentifier Object identifier. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ResultCacheMetadata.md b/gooddata-api-client/docs/models/ResultCacheMetadata.md index 3cbdc5d53..6caffff57 100644 --- a/gooddata-api-client/docs/models/ResultCacheMetadata.md +++ b/gooddata-api-client/docs/models/ResultCacheMetadata.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.result_cache_metadata.ResultCacheMetadata +# gooddata_api_client.models.result_cache_metadata.ResultCacheMetadata All execution result's metadata used for calculation including ExecutionResponse @@ -17,4 +17,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ResultDimension.md b/gooddata-api-client/docs/models/ResultDimension.md index 74c04f7a3..a81a0edbf 100644 --- a/gooddata-api-client/docs/models/ResultDimension.md +++ b/gooddata-api-client/docs/models/ResultDimension.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.result_dimension.ResultDimension +# gooddata_api_client.models.result_dimension.ResultDimension ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -25,4 +25,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**ResultDimensionHeader**](ResultDimensionHeader.md) | [**ResultDimensionHeader**](ResultDimensionHeader.md) | [**ResultDimensionHeader**](ResultDimensionHeader.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ResultDimensionHeader.md b/gooddata-api-client/docs/models/ResultDimensionHeader.md index 8917b65f0..fa02fbc7e 100644 --- a/gooddata-api-client/docs/models/ResultDimensionHeader.md +++ b/gooddata-api-client/docs/models/ResultDimensionHeader.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.result_dimension_header.ResultDimensionHeader +# gooddata_api_client.models.result_dimension_header.ResultDimensionHeader ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -13,4 +13,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [AttributeHeaderOut](AttributeHeaderOut.md) | [**AttributeHeaderOut**](AttributeHeaderOut.md) | [**AttributeHeaderOut**](AttributeHeaderOut.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ResultSpec.md b/gooddata-api-client/docs/models/ResultSpec.md index 62faba689..800bd4025 100644 --- a/gooddata-api-client/docs/models/ResultSpec.md +++ b/gooddata-api-client/docs/models/ResultSpec.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.result_spec.ResultSpec +# gooddata_api_client.models.result_spec.ResultSpec Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```). @@ -39,4 +39,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**Total**](Total.md) | [**Total**](Total.md) | [**Total**](Total.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ScanRequest.md b/gooddata-api-client/docs/models/ScanRequest.md index 0cb9e0d51..237331f91 100644 --- a/gooddata-api-client/docs/models/ScanRequest.md +++ b/gooddata-api-client/docs/models/ScanRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.scan_request.ScanRequest +# gooddata_api_client.models.scan_request.ScanRequest A request containing all information critical to model scanning. @@ -33,4 +33,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ScanResultPdm.md b/gooddata-api-client/docs/models/ScanResultPdm.md index 51f199ade..283811959 100644 --- a/gooddata-api-client/docs/models/ScanResultPdm.md +++ b/gooddata-api-client/docs/models/ScanResultPdm.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.scan_result_pdm.ScanResultPdm +# gooddata_api_client.models.scan_result_pdm.ScanResultPdm Result of scan of data source physical model. @@ -27,4 +27,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**TableWarning**](TableWarning.md) | [**TableWarning**](TableWarning.md) | [**TableWarning**](TableWarning.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ScanSqlRequest.md b/gooddata-api-client/docs/models/ScanSqlRequest.md index ee13d7a82..5a5649fd3 100644 --- a/gooddata-api-client/docs/models/ScanSqlRequest.md +++ b/gooddata-api-client/docs/models/ScanSqlRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.scan_sql_request.ScanSqlRequest +# gooddata_api_client.models.scan_sql_request.ScanSqlRequest A request with SQL query to by analyzed. @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/ScanSqlResponse.md b/gooddata-api-client/docs/models/ScanSqlResponse.md index 25340c627..7045a3c8c 100644 --- a/gooddata-api-client/docs/models/ScanSqlResponse.md +++ b/gooddata-api-client/docs/models/ScanSqlResponse.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.scan_sql_response.ScanSqlResponse +# gooddata_api_client.models.scan_sql_response.ScanSqlResponse Result of scanSql. Consists of array of query columns including type. Sql query result data preview can be attached optionally @@ -55,4 +55,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | None, str, | NoneClass, str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/Settings.md b/gooddata-api-client/docs/models/Settings.md index d6e8c00ef..354c2b1a6 100644 --- a/gooddata-api-client/docs/models/Settings.md +++ b/gooddata-api-client/docs/models/Settings.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.settings.Settings +# gooddata_api_client.models.settings.Settings XLSX specific settings. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/SimpleMeasureDefinition.md b/gooddata-api-client/docs/models/SimpleMeasureDefinition.md index a5d074d8d..80600231c 100644 --- a/gooddata-api-client/docs/models/SimpleMeasureDefinition.md +++ b/gooddata-api-client/docs/models/SimpleMeasureDefinition.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.simple_measure_definition.SimpleMeasureDefinition +# gooddata_api_client.models.simple_measure_definition.SimpleMeasureDefinition ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -42,4 +42,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**FilterDefinitionForSimpleMeasure**](FilterDefinitionForSimpleMeasure.md) | [**FilterDefinitionForSimpleMeasure**](FilterDefinitionForSimpleMeasure.md) | [**FilterDefinitionForSimpleMeasure**](FilterDefinitionForSimpleMeasure.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/SortKey.md b/gooddata-api-client/docs/models/SortKey.md index 23023caee..da1a316aa 100644 --- a/gooddata-api-client/docs/models/SortKey.md +++ b/gooddata-api-client/docs/models/SortKey.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.sort_key.SortKey +# gooddata_api_client.models.sort_key.SortKey ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -14,4 +14,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [SortKeyTotal](SortKeyTotal.md) | [**SortKeyTotal**](SortKeyTotal.md) | [**SortKeyTotal**](SortKeyTotal.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/SortKeyAttribute.md b/gooddata-api-client/docs/models/SortKeyAttribute.md index 2127cbc7c..deb8e4ea2 100644 --- a/gooddata-api-client/docs/models/SortKeyAttribute.md +++ b/gooddata-api-client/docs/models/SortKeyAttribute.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.sort_key_attribute.SortKeyAttribute +# gooddata_api_client.models.sort_key_attribute.SortKeyAttribute Sorting rule for sorting by attribute value in current dimension. @@ -29,4 +29,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/SortKeyTotal.md b/gooddata-api-client/docs/models/SortKeyTotal.md index 9c5ba9b54..b688a3968 100644 --- a/gooddata-api-client/docs/models/SortKeyTotal.md +++ b/gooddata-api-client/docs/models/SortKeyTotal.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.sort_key_total.SortKeyTotal +# gooddata_api_client.models.sort_key_total.SortKeyTotal Sorting rule for sorting by total value. DataColumnLocators are only required if there is ambiguity. Locator for measureGroup is taken from the metric of the total. @@ -29,4 +29,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/SortKeyValue.md b/gooddata-api-client/docs/models/SortKeyValue.md index 8991e277e..e080b6ddc 100644 --- a/gooddata-api-client/docs/models/SortKeyValue.md +++ b/gooddata-api-client/docs/models/SortKeyValue.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.sort_key_value.SortKeyValue +# gooddata_api_client.models.sort_key_value.SortKeyValue Sorting rule for sorting by measure value. DataColumnLocators for each dimension opposite to the sorted one must be specified. @@ -28,4 +28,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/SqlColumn.md b/gooddata-api-client/docs/models/SqlColumn.md index 036ef9f93..1430a9122 100644 --- a/gooddata-api-client/docs/models/SqlColumn.md +++ b/gooddata-api-client/docs/models/SqlColumn.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.sql_column.SqlColumn +# gooddata_api_client.models.sql_column.SqlColumn A SQL query result column. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/TableWarning.md b/gooddata-api-client/docs/models/TableWarning.md index 1424586b7..ecaf1e0b6 100644 --- a/gooddata-api-client/docs/models/TableWarning.md +++ b/gooddata-api-client/docs/models/TableWarning.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.table_warning.TableWarning +# gooddata_api_client.models.table_warning.TableWarning Warnings related to single table. @@ -56,4 +56,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/TabularExportRequest.md b/gooddata-api-client/docs/models/TabularExportRequest.md index 1920ad984..28feefee0 100644 --- a/gooddata-api-client/docs/models/TabularExportRequest.md +++ b/gooddata-api-client/docs/models/TabularExportRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.tabular_export_request.TabularExportRequest +# gooddata_api_client.models.tabular_export_request.TabularExportRequest Export request object describing the export properties and overrides for tabular exports. @@ -18,4 +18,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/TestDefinitionRequest.md b/gooddata-api-client/docs/models/TestDefinitionRequest.md index 07fa5acba..18e8e063c 100644 --- a/gooddata-api-client/docs/models/TestDefinitionRequest.md +++ b/gooddata-api-client/docs/models/TestDefinitionRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.test_definition_request.TestDefinitionRequest +# gooddata_api_client.models.test_definition_request.TestDefinitionRequest A request containing all information for testing data source definition. @@ -32,4 +32,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DataSourceParameter**](DataSourceParameter.md) | [**DataSourceParameter**](DataSourceParameter.md) | [**DataSourceParameter**](DataSourceParameter.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/TestQueryDuration.md b/gooddata-api-client/docs/models/TestQueryDuration.md index 277bc4d46..8eb15abb6 100644 --- a/gooddata-api-client/docs/models/TestQueryDuration.md +++ b/gooddata-api-client/docs/models/TestQueryDuration.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.test_query_duration.TestQueryDuration +# gooddata_api_client.models.test_query_duration.TestQueryDuration A structure containing duration of the test queries run on a data source. It is omitted if an error happens. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/TestRequest.md b/gooddata-api-client/docs/models/TestRequest.md index 6a4bd6722..1efc349f5 100644 --- a/gooddata-api-client/docs/models/TestRequest.md +++ b/gooddata-api-client/docs/models/TestRequest.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.test_request.TestRequest +# gooddata_api_client.models.test_request.TestRequest A request containing all information for testing existing data source. @@ -45,4 +45,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**DataSourceParameter**](DataSourceParameter.md) | [**DataSourceParameter**](DataSourceParameter.md) | [**DataSourceParameter**](DataSourceParameter.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/TestResponse.md b/gooddata-api-client/docs/models/TestResponse.md index 0ef27e250..c5c0d5635 100644 --- a/gooddata-api-client/docs/models/TestResponse.md +++ b/gooddata-api-client/docs/models/TestResponse.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.test_response.TestResponse +# gooddata_api_client.models.test_response.TestResponse Response from data source testing. @@ -16,4 +16,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/Total.md b/gooddata-api-client/docs/models/Total.md index 0c6f94a46..13a8ee365 100644 --- a/gooddata-api-client/docs/models/Total.md +++ b/gooddata-api-client/docs/models/Total.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.total.Total +# gooddata_api_client.models.total.Total Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it's described in `TotalDimension` @@ -29,4 +29,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**TotalDimension**](TotalDimension.md) | [**TotalDimension**](TotalDimension.md) | [**TotalDimension**](TotalDimension.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/TotalDimension.md b/gooddata-api-client/docs/models/TotalDimension.md index 3a292c0ad..8138a0efc 100644 --- a/gooddata-api-client/docs/models/TotalDimension.md +++ b/gooddata-api-client/docs/models/TotalDimension.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.total_dimension.TotalDimension +# gooddata_api_client.models.total_dimension.TotalDimension A list of dimensions across which the total will be computed. Total headers for only these dimensions will be returned in the result. @@ -29,4 +29,3 @@ Class Name | Input Type | Accessed Type | Description | Notes items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/TotalExecutionResultHeader.md b/gooddata-api-client/docs/models/TotalExecutionResultHeader.md index 8842096e8..c9bd9b0e5 100644 --- a/gooddata-api-client/docs/models/TotalExecutionResultHeader.md +++ b/gooddata-api-client/docs/models/TotalExecutionResultHeader.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.total_execution_result_header.TotalExecutionResultHeader +# gooddata_api_client.models.total_execution_result_header.TotalExecutionResultHeader ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -12,4 +12,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/TotalResultHeader.md b/gooddata-api-client/docs/models/TotalResultHeader.md index cd5686ede..74fc91d94 100644 --- a/gooddata-api-client/docs/models/TotalResultHeader.md +++ b/gooddata-api-client/docs/models/TotalResultHeader.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.total_result_header.TotalResultHeader +# gooddata_api_client.models.total_result_header.TotalResultHeader Header containing the information related to a subtotal. @@ -14,4 +14,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/UserAssignee.md b/gooddata-api-client/docs/models/UserAssignee.md index f9c68d6cf..5ca9b7510 100644 --- a/gooddata-api-client/docs/models/UserAssignee.md +++ b/gooddata-api-client/docs/models/UserAssignee.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.user_assignee.UserAssignee +# gooddata_api_client.models.user_assignee.UserAssignee List of users @@ -16,4 +16,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/UserGroupAssignee.md b/gooddata-api-client/docs/models/UserGroupAssignee.md index b91bf1127..13346b20d 100644 --- a/gooddata-api-client/docs/models/UserGroupAssignee.md +++ b/gooddata-api-client/docs/models/UserGroupAssignee.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.user_group_assignee.UserGroupAssignee +# gooddata_api_client.models.user_group_assignee.UserGroupAssignee List of user groups @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/UserGroupPermission.md b/gooddata-api-client/docs/models/UserGroupPermission.md index 37f551801..b594fd9e6 100644 --- a/gooddata-api-client/docs/models/UserGroupPermission.md +++ b/gooddata-api-client/docs/models/UserGroupPermission.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.user_group_permission.UserGroupPermission +# gooddata_api_client.models.user_group_permission.UserGroupPermission List of user groups @@ -30,4 +30,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**GrantedPermission**](GrantedPermission.md) | [**GrantedPermission**](GrantedPermission.md) | [**GrantedPermission**](GrantedPermission.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/UserIdentifier.md b/gooddata-api-client/docs/models/UserIdentifier.md index 058aaf691..84b7cae25 100644 --- a/gooddata-api-client/docs/models/UserIdentifier.md +++ b/gooddata-api-client/docs/models/UserIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.user_identifier.UserIdentifier +# gooddata_api_client.models.user_identifier.UserIdentifier A user identifier. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/UserPermission.md b/gooddata-api-client/docs/models/UserPermission.md index fa1725a36..03bf2f56d 100644 --- a/gooddata-api-client/docs/models/UserPermission.md +++ b/gooddata-api-client/docs/models/UserPermission.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.user_permission.UserPermission +# gooddata_api_client.models.user_permission.UserPermission List of users @@ -31,4 +31,3 @@ Class Name | Input Type | Accessed Type | Description | Notes [**GrantedPermission**](GrantedPermission.md) | [**GrantedPermission**](GrantedPermission.md) | [**GrantedPermission**](GrantedPermission.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/docs/models/WorkspaceIdentifier.md b/gooddata-api-client/docs/models/WorkspaceIdentifier.md index 27677ebc5..c2382c2c6 100644 --- a/gooddata-api-client/docs/models/WorkspaceIdentifier.md +++ b/gooddata-api-client/docs/models/WorkspaceIdentifier.md @@ -1,4 +1,4 @@ -# gooddata_api_client.model.workspace_identifier.WorkspaceIdentifier +# gooddata_api_client.models.workspace_identifier.WorkspaceIdentifier A workspace identifier. @@ -15,4 +15,3 @@ Key | Input Type | Accessed Type | Description | Notes **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/gooddata-api-client/gooddata_api_client/__init__.py b/gooddata-api-client/gooddata_api_client/__init__.py index 648a352c0..ccba30cd4 100644 --- a/gooddata-api-client/gooddata_api_client/__init__.py +++ b/gooddata-api-client/gooddata_api_client/__init__.py @@ -1,28 +1,1046 @@ +# coding: utf-8 + # flake8: noqa """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 __version__ = "1.51.0" +# import apis into sdk package +from gooddata_api_client.api.ai_api import AIApi +from gooddata_api_client.api.api_tokens_api import APITokensApi +from gooddata_api_client.api.analytics_model_api import AnalyticsModelApi +from gooddata_api_client.api.appearance_api import AppearanceApi +from gooddata_api_client.api.attribute_hierarchies_api import AttributeHierarchiesApi +from gooddata_api_client.api.attributes_api import AttributesApi +from gooddata_api_client.api.automations_api import AutomationsApi +from gooddata_api_client.api.available_drivers_api import AvailableDriversApi +from gooddata_api_client.api.csp_directives_api import CSPDirectivesApi +from gooddata_api_client.api.computation_api import ComputationApi +from gooddata_api_client.api.context_filters_api import ContextFiltersApi +from gooddata_api_client.api.cookie_security_configuration_api import CookieSecurityConfigurationApi +from gooddata_api_client.api.dashboards_api import DashboardsApi +from gooddata_api_client.api.data_filters_api import DataFiltersApi +from gooddata_api_client.api.data_source_declarative_apis_api import DataSourceDeclarativeAPIsApi +from gooddata_api_client.api.data_source_entity_apis_api import DataSourceEntityAPIsApi +from gooddata_api_client.api.datasets_api import DatasetsApi +from gooddata_api_client.api.dependency_graph_api import DependencyGraphApi +from gooddata_api_client.api.entitlement_api import EntitlementApi +from gooddata_api_client.api.export_definitions_api import ExportDefinitionsApi +from gooddata_api_client.api.export_templates_api import ExportTemplatesApi +from gooddata_api_client.api.facts_api import FactsApi +from gooddata_api_client.api.filter_views_api import FilterViewsApi +from gooddata_api_client.api.generate_logical_data_model_api import GenerateLogicalDataModelApi +from gooddata_api_client.api.hierarchy_api import HierarchyApi +from gooddata_api_client.api.identity_providers_api import IdentityProvidersApi +from gooddata_api_client.api.image_export_api import ImageExportApi +from gooddata_api_client.api.invalidate_cache_api import InvalidateCacheApi +from gooddata_api_client.api.jwks_api import JWKSApi +from gooddata_api_client.api.ldm_declarative_apis_api import LDMDeclarativeAPIsApi +from gooddata_api_client.api.llm_endpoints_api import LLMEndpointsApi +from gooddata_api_client.api.labels_api import LabelsApi +from gooddata_api_client.api.manage_permissions_api import ManagePermissionsApi +from gooddata_api_client.api.metadata_sync_api import MetadataSyncApi +from gooddata_api_client.api.metrics_api import MetricsApi +from gooddata_api_client.api.notification_channels_api import NotificationChannelsApi +from gooddata_api_client.api.options_api import OptionsApi +from gooddata_api_client.api.organization_api import OrganizationApi +from gooddata_api_client.api.organization_declarative_apis_api import OrganizationDeclarativeAPIsApi +from gooddata_api_client.api.organization_entity_apis_api import OrganizationEntityAPIsApi +from gooddata_api_client.api.permissions_api import PermissionsApi +from gooddata_api_client.api.plugins_api import PluginsApi +from gooddata_api_client.api.raw_export_api import RawExportApi +from gooddata_api_client.api.reporting_settings_api import ReportingSettingsApi +from gooddata_api_client.api.scanning_api import ScanningApi +from gooddata_api_client.api.slides_export_api import SlidesExportApi +from gooddata_api_client.api.smart_functions_api import SmartFunctionsApi +from gooddata_api_client.api.tabular_export_api import TabularExportApi +from gooddata_api_client.api.test_connection_api import TestConnectionApi +from gooddata_api_client.api.translations_api import TranslationsApi +from gooddata_api_client.api.usage_api import UsageApi +from gooddata_api_client.api.user_groups_declarative_apis_api import UserGroupsDeclarativeAPIsApi +from gooddata_api_client.api.user_groups_entity_apis_api import UserGroupsEntityAPIsApi +from gooddata_api_client.api.user_data_filters_api import UserDataFiltersApi +from gooddata_api_client.api.user_identifiers_api import UserIdentifiersApi +from gooddata_api_client.api.user_settings_api import UserSettingsApi +from gooddata_api_client.api.user_management_api import UserManagementApi +from gooddata_api_client.api.users_declarative_apis_api import UsersDeclarativeAPIsApi +from gooddata_api_client.api.users_entity_apis_api import UsersEntityAPIsApi +from gooddata_api_client.api.visual_export_api import VisualExportApi +from gooddata_api_client.api.visualization_object_api import VisualizationObjectApi +from gooddata_api_client.api.workspaces_declarative_apis_api import WorkspacesDeclarativeAPIsApi +from gooddata_api_client.api.workspaces_entity_apis_api import WorkspacesEntityAPIsApi +from gooddata_api_client.api.workspaces_settings_api import WorkspacesSettingsApi +from gooddata_api_client.api.actions_api import ActionsApi +from gooddata_api_client.api.automation_organization_view_controller_api import AutomationOrganizationViewControllerApi +from gooddata_api_client.api.entities_api import EntitiesApi +from gooddata_api_client.api.layout_api import LayoutApi +from gooddata_api_client.api.organization_controller_api import OrganizationControllerApi +from gooddata_api_client.api.organization_model_controller_api import OrganizationModelControllerApi +from gooddata_api_client.api.user_model_controller_api import UserModelControllerApi +from gooddata_api_client.api.workspace_object_controller_api import WorkspaceObjectControllerApi + # import ApiClient +from gooddata_api_client.api_response import ApiResponse from gooddata_api_client.api_client import ApiClient - -# import Configuration from gooddata_api_client.configuration import Configuration - -# import exceptions from gooddata_api_client.exceptions import OpenApiException -from gooddata_api_client.exceptions import ApiAttributeError from gooddata_api_client.exceptions import ApiTypeError from gooddata_api_client.exceptions import ApiValueError from gooddata_api_client.exceptions import ApiKeyError +from gooddata_api_client.exceptions import ApiAttributeError from gooddata_api_client.exceptions import ApiException + +# import models into sdk package +from gooddata_api_client.models.afm import AFM +from gooddata_api_client.models.afm_filters_inner import AFMFiltersInner +from gooddata_api_client.models.absolute_date_filter import AbsoluteDateFilter +from gooddata_api_client.models.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter +from gooddata_api_client.models.abstract_measure_value_filter import AbstractMeasureValueFilter +from gooddata_api_client.models.active_object_identification import ActiveObjectIdentification +from gooddata_api_client.models.ad_hoc_automation import AdHocAutomation +from gooddata_api_client.models.afm_cancel_tokens import AfmCancelTokens +from gooddata_api_client.models.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution_response import AfmExecutionResponse +from gooddata_api_client.models.afm_identifier import AfmIdentifier +from gooddata_api_client.models.afm_local_identifier import AfmLocalIdentifier +from gooddata_api_client.models.afm_object_identifier import AfmObjectIdentifier +from gooddata_api_client.models.afm_object_identifier_attribute import AfmObjectIdentifierAttribute +from gooddata_api_client.models.afm_object_identifier_attribute_identifier import AfmObjectIdentifierAttributeIdentifier +from gooddata_api_client.models.afm_object_identifier_core import AfmObjectIdentifierCore +from gooddata_api_client.models.afm_object_identifier_core_identifier import AfmObjectIdentifierCoreIdentifier +from gooddata_api_client.models.afm_object_identifier_dataset import AfmObjectIdentifierDataset +from gooddata_api_client.models.afm_object_identifier_dataset_identifier import AfmObjectIdentifierDatasetIdentifier +from gooddata_api_client.models.afm_object_identifier_identifier import AfmObjectIdentifierIdentifier +from gooddata_api_client.models.afm_object_identifier_label import AfmObjectIdentifierLabel +from gooddata_api_client.models.afm_object_identifier_label_identifier import AfmObjectIdentifierLabelIdentifier +from gooddata_api_client.models.afm_valid_descendants_query import AfmValidDescendantsQuery +from gooddata_api_client.models.afm_valid_descendants_response import AfmValidDescendantsResponse +from gooddata_api_client.models.afm_valid_objects_query import AfmValidObjectsQuery +from gooddata_api_client.models.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.models.alert_afm import AlertAfm +from gooddata_api_client.models.alert_condition import AlertCondition +from gooddata_api_client.models.alert_condition_operand import AlertConditionOperand +from gooddata_api_client.models.alert_description import AlertDescription +from gooddata_api_client.models.alert_evaluation_row import AlertEvaluationRow +from gooddata_api_client.models.analytics_catalog_tags import AnalyticsCatalogTags +from gooddata_api_client.models.anomaly_detection_request import AnomalyDetectionRequest +from gooddata_api_client.models.anomaly_detection_result import AnomalyDetectionResult +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.models.arithmetic_measure import ArithmeticMeasure +from gooddata_api_client.models.arithmetic_measure_definition import ArithmeticMeasureDefinition +from gooddata_api_client.models.arithmetic_measure_definition_arithmetic_measure import ArithmeticMeasureDefinitionArithmeticMeasure +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.assignee_rule import AssigneeRule +from gooddata_api_client.models.attribute_elements import AttributeElements +from gooddata_api_client.models.attribute_elements_by_ref import AttributeElementsByRef +from gooddata_api_client.models.attribute_elements_by_value import AttributeElementsByValue +from gooddata_api_client.models.attribute_execution_result_header import AttributeExecutionResultHeader +from gooddata_api_client.models.attribute_filter import AttributeFilter +from gooddata_api_client.models.attribute_filter_by_date import AttributeFilterByDate +from gooddata_api_client.models.attribute_filter_elements import AttributeFilterElements +from gooddata_api_client.models.attribute_filter_parent import AttributeFilterParent +from gooddata_api_client.models.attribute_format import AttributeFormat +from gooddata_api_client.models.attribute_header import AttributeHeader +from gooddata_api_client.models.attribute_header_attribute_header import AttributeHeaderAttributeHeader +from gooddata_api_client.models.attribute_item import AttributeItem +from gooddata_api_client.models.attribute_negative_filter import AttributeNegativeFilter +from gooddata_api_client.models.attribute_positive_filter import AttributePositiveFilter +from gooddata_api_client.models.attribute_result_header import AttributeResultHeader +from gooddata_api_client.models.automation_alert import AutomationAlert +from gooddata_api_client.models.automation_alert_condition import AutomationAlertCondition +from gooddata_api_client.models.automation_dashboard_tabular_export import AutomationDashboardTabularExport +from gooddata_api_client.models.automation_external_recipient import AutomationExternalRecipient +from gooddata_api_client.models.automation_image_export import AutomationImageExport +from gooddata_api_client.models.automation_metadata import AutomationMetadata +from gooddata_api_client.models.automation_notification import AutomationNotification +from gooddata_api_client.models.automation_raw_export import AutomationRawExport +from gooddata_api_client.models.automation_schedule import AutomationSchedule +from gooddata_api_client.models.automation_slides_export import AutomationSlidesExport +from gooddata_api_client.models.automation_tabular_export import AutomationTabularExport +from gooddata_api_client.models.automation_visual_export import AutomationVisualExport +from gooddata_api_client.models.available_assignees import AvailableAssignees +from gooddata_api_client.models.bounded_filter import BoundedFilter +from gooddata_api_client.models.chat_history_interaction import ChatHistoryInteraction +from gooddata_api_client.models.chat_history_request import ChatHistoryRequest +from gooddata_api_client.models.chat_history_result import ChatHistoryResult +from gooddata_api_client.models.chat_request import ChatRequest +from gooddata_api_client.models.chat_result import ChatResult +from gooddata_api_client.models.chat_usage_response import ChatUsageResponse +from gooddata_api_client.models.clustering_request import ClusteringRequest +from gooddata_api_client.models.clustering_result import ClusteringResult +from gooddata_api_client.models.column_override import ColumnOverride +from gooddata_api_client.models.column_statistic import ColumnStatistic +from gooddata_api_client.models.column_statistic_warning import ColumnStatisticWarning +from gooddata_api_client.models.column_statistics_request import ColumnStatisticsRequest +from gooddata_api_client.models.column_statistics_request_from import ColumnStatisticsRequestFrom +from gooddata_api_client.models.column_statistics_response import ColumnStatisticsResponse +from gooddata_api_client.models.column_warning import ColumnWarning +from gooddata_api_client.models.comparison import Comparison +from gooddata_api_client.models.comparison_measure_value_filter import ComparisonMeasureValueFilter +from gooddata_api_client.models.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter +from gooddata_api_client.models.comparison_wrapper import ComparisonWrapper +from gooddata_api_client.models.content_slide_template import ContentSlideTemplate +from gooddata_api_client.models.cover_slide_template import CoverSlideTemplate +from gooddata_api_client.models.created_visualization import CreatedVisualization +from gooddata_api_client.models.created_visualization_filters_inner import CreatedVisualizationFiltersInner +from gooddata_api_client.models.created_visualizations import CreatedVisualizations +from gooddata_api_client.models.custom_label import CustomLabel +from gooddata_api_client.models.custom_metric import CustomMetric +from gooddata_api_client.models.custom_override import CustomOverride +from gooddata_api_client.models.dashboard_attribute_filter import DashboardAttributeFilter +from gooddata_api_client.models.dashboard_attribute_filter_attribute_filter import DashboardAttributeFilterAttributeFilter +from gooddata_api_client.models.dashboard_date_filter import DashboardDateFilter +from gooddata_api_client.models.dashboard_date_filter_date_filter import DashboardDateFilterDateFilter +from gooddata_api_client.models.dashboard_date_filter_date_filter_from import DashboardDateFilterDateFilterFrom +from gooddata_api_client.models.dashboard_export_settings import DashboardExportSettings +from gooddata_api_client.models.dashboard_filter import DashboardFilter +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions +from gooddata_api_client.models.dashboard_permissions_assignment import DashboardPermissionsAssignment +from gooddata_api_client.models.dashboard_slides_template import DashboardSlidesTemplate +from gooddata_api_client.models.dashboard_tabular_export_request import DashboardTabularExportRequest +from gooddata_api_client.models.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 +from gooddata_api_client.models.data_column_locator import DataColumnLocator +from gooddata_api_client.models.data_column_locators import DataColumnLocators +from gooddata_api_client.models.data_source_parameter import DataSourceParameter +from gooddata_api_client.models.data_source_permission_assignment import DataSourcePermissionAssignment +from gooddata_api_client.models.data_source_schemata import DataSourceSchemata +from gooddata_api_client.models.data_source_table_identifier import DataSourceTableIdentifier +from gooddata_api_client.models.dataset_grain import DatasetGrain +from gooddata_api_client.models.dataset_reference_identifier import DatasetReferenceIdentifier +from gooddata_api_client.models.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier +from gooddata_api_client.models.date_absolute_filter import DateAbsoluteFilter +from gooddata_api_client.models.date_filter import DateFilter +from gooddata_api_client.models.date_relative_filter import DateRelativeFilter +from gooddata_api_client.models.date_value import DateValue +from gooddata_api_client.models.declarative_aggregated_fact import DeclarativeAggregatedFact +from gooddata_api_client.models.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard +from gooddata_api_client.models.declarative_analytical_dashboard_extension import DeclarativeAnalyticalDashboardExtension +from gooddata_api_client.models.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier +from gooddata_api_client.models.declarative_analytical_dashboard_permission_assignment import DeclarativeAnalyticalDashboardPermissionAssignment +from gooddata_api_client.models.declarative_analytical_dashboard_permission_for_assignee import DeclarativeAnalyticalDashboardPermissionForAssignee +from gooddata_api_client.models.declarative_analytical_dashboard_permission_for_assignee_rule import DeclarativeAnalyticalDashboardPermissionForAssigneeRule +from gooddata_api_client.models.declarative_analytical_dashboard_permissions_inner import DeclarativeAnalyticalDashboardPermissionsInner +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics_layer import DeclarativeAnalyticsLayer +from gooddata_api_client.models.declarative_attribute import DeclarativeAttribute +from gooddata_api_client.models.declarative_attribute_hierarchy import DeclarativeAttributeHierarchy +from gooddata_api_client.models.declarative_automation import DeclarativeAutomation +from gooddata_api_client.models.declarative_color_palette import DeclarativeColorPalette +from gooddata_api_client.models.declarative_column import DeclarativeColumn +from gooddata_api_client.models.declarative_csp_directive import DeclarativeCspDirective +from gooddata_api_client.models.declarative_custom_application_setting import DeclarativeCustomApplicationSetting +from gooddata_api_client.models.declarative_dashboard_plugin import DeclarativeDashboardPlugin +from gooddata_api_client.models.declarative_data_source import DeclarativeDataSource +from gooddata_api_client.models.declarative_data_source_permission import DeclarativeDataSourcePermission +from gooddata_api_client.models.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_dataset import DeclarativeDataset +from gooddata_api_client.models.declarative_dataset_extension import DeclarativeDatasetExtension +from gooddata_api_client.models.declarative_dataset_sql import DeclarativeDatasetSql +from gooddata_api_client.models.declarative_date_dataset import DeclarativeDateDataset +from gooddata_api_client.models.declarative_export_definition import DeclarativeExportDefinition +from gooddata_api_client.models.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier +from gooddata_api_client.models.declarative_export_definition_request_payload import DeclarativeExportDefinitionRequestPayload +from gooddata_api_client.models.declarative_export_template import DeclarativeExportTemplate +from gooddata_api_client.models.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.models.declarative_fact import DeclarativeFact +from gooddata_api_client.models.declarative_filter_context import DeclarativeFilterContext +from gooddata_api_client.models.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.models.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.models.declarative_identity_provider_identifier import DeclarativeIdentityProviderIdentifier +from gooddata_api_client.models.declarative_jwk import DeclarativeJwk +from gooddata_api_client.models.declarative_jwk_specification import DeclarativeJwkSpecification +from gooddata_api_client.models.declarative_label import DeclarativeLabel +from gooddata_api_client.models.declarative_ldm import DeclarativeLdm +from gooddata_api_client.models.declarative_metric import DeclarativeMetric +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_notification_channel import DeclarativeNotificationChannel +from gooddata_api_client.models.declarative_notification_channel_destination import DeclarativeNotificationChannelDestination +from gooddata_api_client.models.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier +from gooddata_api_client.models.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization_info import DeclarativeOrganizationInfo +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.models.declarative_reference import DeclarativeReference +from gooddata_api_client.models.declarative_reference_source import DeclarativeReferenceSource +from gooddata_api_client.models.declarative_rsa_specification import DeclarativeRsaSpecification +from gooddata_api_client.models.declarative_setting import DeclarativeSetting +from gooddata_api_client.models.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission +from gooddata_api_client.models.declarative_source_fact_reference import DeclarativeSourceFactReference +from gooddata_api_client.models.declarative_table import DeclarativeTable +from gooddata_api_client.models.declarative_tables import DeclarativeTables +from gooddata_api_client.models.declarative_theme import DeclarativeTheme +from gooddata_api_client.models.declarative_user import DeclarativeUser +from gooddata_api_client.models.declarative_user_data_filter import DeclarativeUserDataFilter +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_group import DeclarativeUserGroup +from gooddata_api_client.models.declarative_user_group_identifier import DeclarativeUserGroupIdentifier +from gooddata_api_client.models.declarative_user_group_permission import DeclarativeUserGroupPermission +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from gooddata_api_client.models.declarative_user_permission import DeclarativeUserPermission +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_visualization_object import DeclarativeVisualizationObject +from gooddata_api_client.models.declarative_workspace import DeclarativeWorkspace +from gooddata_api_client.models.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter +from gooddata_api_client.models.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn +from gooddata_api_client.models.declarative_workspace_data_filter_references import DeclarativeWorkspaceDataFilterReferences +from gooddata_api_client.models.declarative_workspace_data_filter_setting import DeclarativeWorkspaceDataFilterSetting +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.default_smtp import DefaultSmtp +from gooddata_api_client.models.dependent_entities_graph import DependentEntitiesGraph +from gooddata_api_client.models.dependent_entities_node import DependentEntitiesNode +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.depends_on import DependsOn +from gooddata_api_client.models.depends_on_date_filter import DependsOnDateFilter +from gooddata_api_client.models.dim_attribute import DimAttribute +from gooddata_api_client.models.dimension import Dimension +from gooddata_api_client.models.dimension_header import DimensionHeader +from gooddata_api_client.models.element import Element +from gooddata_api_client.models.elements_request import ElementsRequest +from gooddata_api_client.models.elements_request_depends_on_inner import ElementsRequestDependsOnInner +from gooddata_api_client.models.elements_response import ElementsResponse +from gooddata_api_client.models.entitlements_request import EntitlementsRequest +from gooddata_api_client.models.entity_identifier import EntityIdentifier +from gooddata_api_client.models.execution_links import ExecutionLinks +from gooddata_api_client.models.execution_response import ExecutionResponse +from gooddata_api_client.models.execution_result import ExecutionResult +from gooddata_api_client.models.execution_result_data_source_message import ExecutionResultDataSourceMessage +from gooddata_api_client.models.execution_result_grand_total import ExecutionResultGrandTotal +from gooddata_api_client.models.execution_result_header import ExecutionResultHeader +from gooddata_api_client.models.execution_result_metadata import ExecutionResultMetadata +from gooddata_api_client.models.execution_result_paging import ExecutionResultPaging +from gooddata_api_client.models.execution_settings import ExecutionSettings +from gooddata_api_client.models.export_request import ExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.export_result import ExportResult +from gooddata_api_client.models.fact_identifier import FactIdentifier +from gooddata_api_client.models.file import File +from gooddata_api_client.models.filter_by import FilterBy +from gooddata_api_client.models.filter_definition import FilterDefinition +from gooddata_api_client.models.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure +from gooddata_api_client.models.forecast_request import ForecastRequest +from gooddata_api_client.models.forecast_result import ForecastResult +from gooddata_api_client.models.found_objects import FoundObjects +from gooddata_api_client.models.frequency import Frequency +from gooddata_api_client.models.frequency_bucket import FrequencyBucket +from gooddata_api_client.models.frequency_properties import FrequencyProperties +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.models.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.models.get_quality_issues_response import GetQualityIssuesResponse +from gooddata_api_client.models.grain_identifier import GrainIdentifier +from gooddata_api_client.models.granted_permission import GrantedPermission +from gooddata_api_client.models.granularities_formatting import GranularitiesFormatting +from gooddata_api_client.models.header_group import HeaderGroup +from gooddata_api_client.models.hierarchy_object_identification import HierarchyObjectIdentification +from gooddata_api_client.models.histogram import Histogram +from gooddata_api_client.models.histogram_bucket import HistogramBucket +from gooddata_api_client.models.histogram_properties import HistogramProperties +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_ref import IdentifierRef +from gooddata_api_client.models.identifier_ref_identifier import IdentifierRefIdentifier +from gooddata_api_client.models.image_export_request import ImageExportRequest +from gooddata_api_client.models.in_platform import InPlatform +from gooddata_api_client.models.inline_filter_definition import InlineFilterDefinition +from gooddata_api_client.models.inline_filter_definition_inline import InlineFilterDefinitionInline +from gooddata_api_client.models.inline_measure_definition import InlineMeasureDefinition +from gooddata_api_client.models.inline_measure_definition_inline import InlineMeasureDefinitionInline +from gooddata_api_client.models.intro_slide_template import IntroSlideTemplate +from gooddata_api_client.models.json_api_aggregated_fact_linkage import JsonApiAggregatedFactLinkage +from gooddata_api_client.models.json_api_aggregated_fact_out import JsonApiAggregatedFactOut +from gooddata_api_client.models.json_api_aggregated_fact_out_attributes import JsonApiAggregatedFactOutAttributes +from gooddata_api_client.models.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument +from gooddata_api_client.models.json_api_aggregated_fact_out_includes import JsonApiAggregatedFactOutIncludes +from gooddata_api_client.models.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_aggregated_fact_out_meta_origin import JsonApiAggregatedFactOutMetaOrigin +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships import JsonApiAggregatedFactOutRelationships +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships_dataset import JsonApiAggregatedFactOutRelationshipsDataset +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships_source_fact import JsonApiAggregatedFactOutRelationshipsSourceFact +from gooddata_api_client.models.json_api_aggregated_fact_out_with_links import JsonApiAggregatedFactOutWithLinks +from gooddata_api_client.models.json_api_analytical_dashboard_in import JsonApiAnalyticalDashboardIn +from gooddata_api_client.models.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_linkage import JsonApiAnalyticalDashboardLinkage +from gooddata_api_client.models.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut +from gooddata_api_client.models.json_api_analytical_dashboard_out_attributes import JsonApiAnalyticalDashboardOutAttributes +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_out_meta import JsonApiAnalyticalDashboardOutMeta +from gooddata_api_client.models.json_api_analytical_dashboard_out_meta_access_info import JsonApiAnalyticalDashboardOutMetaAccessInfo +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships import JsonApiAnalyticalDashboardOutRelationships +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_analytical_dashboards import JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_dashboard_plugins import JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_filter_contexts import JsonApiAnalyticalDashboardOutRelationshipsFilterContexts +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_visualization_objects import JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects +from gooddata_api_client.models.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.models.json_api_analytical_dashboard_patch import JsonApiAnalyticalDashboardPatch +from gooddata_api_client.models.json_api_analytical_dashboard_patch_attributes import JsonApiAnalyticalDashboardPatchAttributes +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id import JsonApiAnalyticalDashboardPostOptionalId +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.models.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.models.json_api_api_token_in import JsonApiApiTokenIn +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out import JsonApiApiTokenOut +from gooddata_api_client.models.json_api_api_token_out_attributes import JsonApiApiTokenOutAttributes +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_api_token_out_with_links import JsonApiApiTokenOutWithLinks +from gooddata_api_client.models.json_api_attribute_hierarchy_in import JsonApiAttributeHierarchyIn +from gooddata_api_client.models.json_api_attribute_hierarchy_in_attributes import JsonApiAttributeHierarchyInAttributes +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_linkage import JsonApiAttributeHierarchyLinkage +from gooddata_api_client.models.json_api_attribute_hierarchy_out import JsonApiAttributeHierarchyOut +from gooddata_api_client.models.json_api_attribute_hierarchy_out_attributes import JsonApiAttributeHierarchyOutAttributes +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_includes import JsonApiAttributeHierarchyOutIncludes +from gooddata_api_client.models.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships import JsonApiAttributeHierarchyOutRelationships +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes +from gooddata_api_client.models.json_api_attribute_hierarchy_out_with_links import JsonApiAttributeHierarchyOutWithLinks +from gooddata_api_client.models.json_api_attribute_hierarchy_patch import JsonApiAttributeHierarchyPatch +from gooddata_api_client.models.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument +from gooddata_api_client.models.json_api_attribute_linkage import JsonApiAttributeLinkage +from gooddata_api_client.models.json_api_attribute_out import JsonApiAttributeOut +from gooddata_api_client.models.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_includes import JsonApiAttributeOutIncludes +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships +from gooddata_api_client.models.json_api_attribute_out_relationships_attribute_hierarchies import JsonApiAttributeOutRelationshipsAttributeHierarchies +from gooddata_api_client.models.json_api_attribute_out_relationships_default_view import JsonApiAttributeOutRelationshipsDefaultView +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_attribute_to_one_linkage import JsonApiAttributeToOneLinkage +from gooddata_api_client.models.json_api_automation_in import JsonApiAutomationIn +from gooddata_api_client.models.json_api_automation_in_attributes import JsonApiAutomationInAttributes +from gooddata_api_client.models.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert +from gooddata_api_client.models.json_api_automation_in_attributes_dashboard_tabular_exports_inner import JsonApiAutomationInAttributesDashboardTabularExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner +from gooddata_api_client.models.json_api_automation_in_attributes_image_exports_inner import JsonApiAutomationInAttributesImageExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata +from gooddata_api_client.models.json_api_automation_in_attributes_raw_exports_inner import JsonApiAutomationInAttributesRawExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule +from gooddata_api_client.models.json_api_automation_in_attributes_slides_exports_inner import JsonApiAutomationInAttributesSlidesExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.models.json_api_automation_in_relationships import JsonApiAutomationInRelationships +from gooddata_api_client.models.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard +from gooddata_api_client.models.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions +from gooddata_api_client.models.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel +from gooddata_api_client.models.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients +from gooddata_api_client.models.json_api_automation_linkage import JsonApiAutomationLinkage +from gooddata_api_client.models.json_api_automation_out import JsonApiAutomationOut +from gooddata_api_client.models.json_api_automation_out_attributes import JsonApiAutomationOutAttributes +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_out_includes import JsonApiAutomationOutIncludes +from gooddata_api_client.models.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.models.json_api_automation_out_relationships import JsonApiAutomationOutRelationships +from gooddata_api_client.models.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults +from gooddata_api_client.models.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks +from gooddata_api_client.models.json_api_automation_patch import JsonApiAutomationPatch +from gooddata_api_client.models.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.models.json_api_automation_result_linkage import JsonApiAutomationResultLinkage +from gooddata_api_client.models.json_api_automation_result_out import JsonApiAutomationResultOut +from gooddata_api_client.models.json_api_automation_result_out_attributes import JsonApiAutomationResultOutAttributes +from gooddata_api_client.models.json_api_automation_result_out_relationships import JsonApiAutomationResultOutRelationships +from gooddata_api_client.models.json_api_automation_result_out_relationships_automation import JsonApiAutomationResultOutRelationshipsAutomation +from gooddata_api_client.models.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks +from gooddata_api_client.models.json_api_automation_to_one_linkage import JsonApiAutomationToOneLinkage +from gooddata_api_client.models.json_api_color_palette_in import JsonApiColorPaletteIn +from gooddata_api_client.models.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out import JsonApiColorPaletteOut +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_out_with_links import JsonApiColorPaletteOutWithLinks +from gooddata_api_client.models.json_api_color_palette_patch import JsonApiColorPalettePatch +from gooddata_api_client.models.json_api_color_palette_patch_attributes import JsonApiColorPalettePatchAttributes +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_in import JsonApiCookieSecurityConfigurationIn +from gooddata_api_client.models.json_api_cookie_security_configuration_in_attributes import JsonApiCookieSecurityConfigurationInAttributes +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out import JsonApiCookieSecurityConfigurationOut +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch import JsonApiCookieSecurityConfigurationPatch +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_csp_directive_in import JsonApiCspDirectiveIn +from gooddata_api_client.models.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out import JsonApiCspDirectiveOut +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_out_with_links import JsonApiCspDirectiveOutWithLinks +from gooddata_api_client.models.json_api_csp_directive_patch import JsonApiCspDirectivePatch +from gooddata_api_client.models.json_api_csp_directive_patch_attributes import JsonApiCspDirectivePatchAttributes +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_in import JsonApiCustomApplicationSettingIn +from gooddata_api_client.models.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out import JsonApiCustomApplicationSettingOut +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_out_with_links import JsonApiCustomApplicationSettingOutWithLinks +from gooddata_api_client.models.json_api_custom_application_setting_patch import JsonApiCustomApplicationSettingPatch +from gooddata_api_client.models.json_api_custom_application_setting_patch_attributes import JsonApiCustomApplicationSettingPatchAttributes +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id import JsonApiCustomApplicationSettingPostOptionalId +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in import JsonApiDashboardPluginIn +from gooddata_api_client.models.json_api_dashboard_plugin_in_attributes import JsonApiDashboardPluginInAttributes +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_linkage import JsonApiDashboardPluginLinkage +from gooddata_api_client.models.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut +from gooddata_api_client.models.json_api_dashboard_plugin_out_attributes import JsonApiDashboardPluginOutAttributes +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships +from gooddata_api_client.models.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks +from gooddata_api_client.models.json_api_dashboard_plugin_patch import JsonApiDashboardPluginPatch +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id import JsonApiDashboardPluginPostOptionalId +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.models.json_api_data_source_identifier_out import JsonApiDataSourceIdentifierOut +from gooddata_api_client.models.json_api_data_source_identifier_out_attributes import JsonApiDataSourceIdentifierOutAttributes +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta +from gooddata_api_client.models.json_api_data_source_identifier_out_with_links import JsonApiDataSourceIdentifierOutWithLinks +from gooddata_api_client.models.json_api_data_source_in import JsonApiDataSourceIn +from gooddata_api_client.models.json_api_data_source_in_attributes import JsonApiDataSourceInAttributes +from gooddata_api_client.models.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out import JsonApiDataSourceOut +from gooddata_api_client.models.json_api_data_source_out_attributes import JsonApiDataSourceOutAttributes +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_out_with_links import JsonApiDataSourceOutWithLinks +from gooddata_api_client.models.json_api_data_source_patch import JsonApiDataSourcePatch +from gooddata_api_client.models.json_api_data_source_patch_attributes import JsonApiDataSourcePatchAttributes +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.models.json_api_dataset_linkage import JsonApiDatasetLinkage +from gooddata_api_client.models.json_api_dataset_out import JsonApiDatasetOut +from gooddata_api_client.models.json_api_dataset_out_attributes import JsonApiDatasetOutAttributes +from gooddata_api_client.models.json_api_dataset_out_attributes_grain_inner import JsonApiDatasetOutAttributesGrainInner +from gooddata_api_client.models.json_api_dataset_out_attributes_reference_properties_inner import JsonApiDatasetOutAttributesReferencePropertiesInner +from gooddata_api_client.models.json_api_dataset_out_attributes_sql import JsonApiDatasetOutAttributesSql +from gooddata_api_client.models.json_api_dataset_out_attributes_workspace_data_filter_columns_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner +from gooddata_api_client.models.json_api_dataset_out_attributes_workspace_data_filter_references_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_includes import JsonApiDatasetOutIncludes +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_dataset_out_relationships import JsonApiDatasetOutRelationships +from gooddata_api_client.models.json_api_dataset_out_relationships_aggregated_facts import JsonApiDatasetOutRelationshipsAggregatedFacts +from gooddata_api_client.models.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts +from gooddata_api_client.models.json_api_dataset_out_relationships_workspace_data_filters import JsonApiDatasetOutRelationshipsWorkspaceDataFilters +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage +from gooddata_api_client.models.json_api_entitlement_out import JsonApiEntitlementOut +from gooddata_api_client.models.json_api_entitlement_out_attributes import JsonApiEntitlementOutAttributes +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_entitlement_out_with_links import JsonApiEntitlementOutWithLinks +from gooddata_api_client.models.json_api_export_definition_in import JsonApiExportDefinitionIn +from gooddata_api_client.models.json_api_export_definition_in_attributes import JsonApiExportDefinitionInAttributes +from gooddata_api_client.models.json_api_export_definition_in_attributes_request_payload import JsonApiExportDefinitionInAttributesRequestPayload +from gooddata_api_client.models.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.models.json_api_export_definition_in_relationships import JsonApiExportDefinitionInRelationships +from gooddata_api_client.models.json_api_export_definition_in_relationships_visualization_object import JsonApiExportDefinitionInRelationshipsVisualizationObject +from gooddata_api_client.models.json_api_export_definition_linkage import JsonApiExportDefinitionLinkage +from gooddata_api_client.models.json_api_export_definition_out import JsonApiExportDefinitionOut +from gooddata_api_client.models.json_api_export_definition_out_attributes import JsonApiExportDefinitionOutAttributes +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_out_includes import JsonApiExportDefinitionOutIncludes +from gooddata_api_client.models.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.models.json_api_export_definition_out_relationships import JsonApiExportDefinitionOutRelationships +from gooddata_api_client.models.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks +from gooddata_api_client.models.json_api_export_definition_patch import JsonApiExportDefinitionPatch +from gooddata_api_client.models.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.models.json_api_export_definition_post_optional_id import JsonApiExportDefinitionPostOptionalId +from gooddata_api_client.models.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.models.json_api_export_template_in import JsonApiExportTemplateIn +from gooddata_api_client.models.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes +from gooddata_api_client.models.json_api_export_template_in_attributes_dashboard_slides_template import JsonApiExportTemplateInAttributesDashboardSlidesTemplate +from gooddata_api_client.models.json_api_export_template_in_attributes_widget_slides_template import JsonApiExportTemplateInAttributesWidgetSlidesTemplate +from gooddata_api_client.models.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.models.json_api_export_template_out import JsonApiExportTemplateOut +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.models.json_api_export_template_out_with_links import JsonApiExportTemplateOutWithLinks +from gooddata_api_client.models.json_api_export_template_patch import JsonApiExportTemplatePatch +from gooddata_api_client.models.json_api_export_template_patch_attributes import JsonApiExportTemplatePatchAttributes +from gooddata_api_client.models.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.models.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId +from gooddata_api_client.models.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.models.json_api_fact_linkage import JsonApiFactLinkage +from gooddata_api_client.models.json_api_fact_out import JsonApiFactOut +from gooddata_api_client.models.json_api_fact_out_attributes import JsonApiFactOutAttributes +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_fact_out_relationships import JsonApiFactOutRelationships +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks +from gooddata_api_client.models.json_api_fact_to_one_linkage import JsonApiFactToOneLinkage +from gooddata_api_client.models.json_api_filter_context_in import JsonApiFilterContextIn +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_linkage import JsonApiFilterContextLinkage +from gooddata_api_client.models.json_api_filter_context_out import JsonApiFilterContextOut +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_out_relationships import JsonApiFilterContextOutRelationships +from gooddata_api_client.models.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks +from gooddata_api_client.models.json_api_filter_context_patch import JsonApiFilterContextPatch +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id import JsonApiFilterContextPostOptionalId +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.models.json_api_filter_view_in import JsonApiFilterViewIn +from gooddata_api_client.models.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships +from gooddata_api_client.models.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser +from gooddata_api_client.models.json_api_filter_view_out import JsonApiFilterViewOut +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_out_includes import JsonApiFilterViewOutIncludes +from gooddata_api_client.models.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.models.json_api_filter_view_out_with_links import JsonApiFilterViewOutWithLinks +from gooddata_api_client.models.json_api_filter_view_patch import JsonApiFilterViewPatch +from gooddata_api_client.models.json_api_filter_view_patch_attributes import JsonApiFilterViewPatchAttributes +from gooddata_api_client.models.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.models.json_api_identity_provider_in import JsonApiIdentityProviderIn +from gooddata_api_client.models.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_linkage import JsonApiIdentityProviderLinkage +from gooddata_api_client.models.json_api_identity_provider_out import JsonApiIdentityProviderOut +from gooddata_api_client.models.json_api_identity_provider_out_attributes import JsonApiIdentityProviderOutAttributes +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.models.json_api_identity_provider_out_with_links import JsonApiIdentityProviderOutWithLinks +from gooddata_api_client.models.json_api_identity_provider_patch import JsonApiIdentityProviderPatch +from gooddata_api_client.models.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument +from gooddata_api_client.models.json_api_identity_provider_to_one_linkage import JsonApiIdentityProviderToOneLinkage +from gooddata_api_client.models.json_api_jwk_in import JsonApiJwkIn +from gooddata_api_client.models.json_api_jwk_in_attributes import JsonApiJwkInAttributes +from gooddata_api_client.models.json_api_jwk_in_attributes_content import JsonApiJwkInAttributesContent +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_out import JsonApiJwkOut +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.models.json_api_jwk_out_with_links import JsonApiJwkOutWithLinks +from gooddata_api_client.models.json_api_jwk_patch import JsonApiJwkPatch +from gooddata_api_client.models.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from gooddata_api_client.models.json_api_label_linkage import JsonApiLabelLinkage +from gooddata_api_client.models.json_api_label_out import JsonApiLabelOut +from gooddata_api_client.models.json_api_label_out_attributes import JsonApiLabelOutAttributes +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_label_out_relationships import JsonApiLabelOutRelationships +from gooddata_api_client.models.json_api_label_out_relationships_attribute import JsonApiLabelOutRelationshipsAttribute +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.json_api_label_to_one_linkage import JsonApiLabelToOneLinkage +from gooddata_api_client.models.json_api_llm_endpoint_in import JsonApiLlmEndpointIn +from gooddata_api_client.models.json_api_llm_endpoint_in_attributes import JsonApiLlmEndpointInAttributes +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_out import JsonApiLlmEndpointOut +from gooddata_api_client.models.json_api_llm_endpoint_out_attributes import JsonApiLlmEndpointOutAttributes +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from gooddata_api_client.models.json_api_llm_endpoint_out_with_links import JsonApiLlmEndpointOutWithLinks +from gooddata_api_client.models.json_api_llm_endpoint_patch import JsonApiLlmEndpointPatch +from gooddata_api_client.models.json_api_llm_endpoint_patch_attributes import JsonApiLlmEndpointPatchAttributes +from gooddata_api_client.models.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.models.json_api_metric_in import JsonApiMetricIn +from gooddata_api_client.models.json_api_metric_in_attributes import JsonApiMetricInAttributes +from gooddata_api_client.models.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_linkage import JsonApiMetricLinkage +from gooddata_api_client.models.json_api_metric_out import JsonApiMetricOut +from gooddata_api_client.models.json_api_metric_out_attributes import JsonApiMetricOutAttributes +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_includes import JsonApiMetricOutIncludes +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_out_relationships import JsonApiMetricOutRelationships +from gooddata_api_client.models.json_api_metric_out_with_links import JsonApiMetricOutWithLinks +from gooddata_api_client.models.json_api_metric_patch import JsonApiMetricPatch +from gooddata_api_client.models.json_api_metric_patch_attributes import JsonApiMetricPatchAttributes +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.models.json_api_metric_post_optional_id import JsonApiMetricPostOptionalId +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out import JsonApiNotificationChannelIdentifierOut +from gooddata_api_client.models.json_api_notification_channel_identifier_out_attributes import JsonApiNotificationChannelIdentifierOutAttributes +from gooddata_api_client.models.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.models.json_api_notification_channel_identifier_out_with_links import JsonApiNotificationChannelIdentifierOutWithLinks +from gooddata_api_client.models.json_api_notification_channel_in import JsonApiNotificationChannelIn +from gooddata_api_client.models.json_api_notification_channel_in_attributes import JsonApiNotificationChannelInAttributes +from gooddata_api_client.models.json_api_notification_channel_in_attributes_destination import JsonApiNotificationChannelInAttributesDestination +from gooddata_api_client.models.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument +from gooddata_api_client.models.json_api_notification_channel_linkage import JsonApiNotificationChannelLinkage +from gooddata_api_client.models.json_api_notification_channel_out import JsonApiNotificationChannelOut +from gooddata_api_client.models.json_api_notification_channel_out_attributes import JsonApiNotificationChannelOutAttributes +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.models.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks +from gooddata_api_client.models.json_api_notification_channel_patch import JsonApiNotificationChannelPatch +from gooddata_api_client.models.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +from gooddata_api_client.models.json_api_notification_channel_post_optional_id import JsonApiNotificationChannelPostOptionalId +from gooddata_api_client.models.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.models.json_api_notification_channel_to_one_linkage import JsonApiNotificationChannelToOneLinkage +from gooddata_api_client.models.json_api_organization_in import JsonApiOrganizationIn +from gooddata_api_client.models.json_api_organization_in_attributes import JsonApiOrganizationInAttributes +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_in_relationships import JsonApiOrganizationInRelationships +from gooddata_api_client.models.json_api_organization_in_relationships_identity_provider import JsonApiOrganizationInRelationshipsIdentityProvider +from gooddata_api_client.models.json_api_organization_out import JsonApiOrganizationOut +from gooddata_api_client.models.json_api_organization_out_attributes import JsonApiOrganizationOutAttributes +from gooddata_api_client.models.json_api_organization_out_attributes_cache_settings import JsonApiOrganizationOutAttributesCacheSettings +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_out_includes import JsonApiOrganizationOutIncludes +from gooddata_api_client.models.json_api_organization_out_meta import JsonApiOrganizationOutMeta +from gooddata_api_client.models.json_api_organization_out_relationships import JsonApiOrganizationOutRelationships +from gooddata_api_client.models.json_api_organization_out_relationships_bootstrap_user_group import JsonApiOrganizationOutRelationshipsBootstrapUserGroup +from gooddata_api_client.models.json_api_organization_patch import JsonApiOrganizationPatch +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_setting_in import JsonApiOrganizationSettingIn +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out import JsonApiOrganizationSettingOut +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_out_with_links import JsonApiOrganizationSettingOutWithLinks +from gooddata_api_client.models.json_api_organization_setting_patch import JsonApiOrganizationSettingPatch +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_theme_in import JsonApiThemeIn +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out import JsonApiThemeOut +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_out_with_links import JsonApiThemeOutWithLinks +from gooddata_api_client.models.json_api_theme_patch import JsonApiThemePatch +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.models.json_api_user_data_filter_in import JsonApiUserDataFilterIn +from gooddata_api_client.models.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships +from gooddata_api_client.models.json_api_user_data_filter_out import JsonApiUserDataFilterOut +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_out_relationships import JsonApiUserDataFilterOutRelationships +from gooddata_api_client.models.json_api_user_data_filter_out_with_links import JsonApiUserDataFilterOutWithLinks +from gooddata_api_client.models.json_api_user_data_filter_patch import JsonApiUserDataFilterPatch +from gooddata_api_client.models.json_api_user_data_filter_patch_attributes import JsonApiUserDataFilterPatchAttributes +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id import JsonApiUserDataFilterPostOptionalId +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_group_in import JsonApiUserGroupIn +from gooddata_api_client.models.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships +from gooddata_api_client.models.json_api_user_group_in_relationships_parents import JsonApiUserGroupInRelationshipsParents +from gooddata_api_client.models.json_api_user_group_linkage import JsonApiUserGroupLinkage +from gooddata_api_client.models.json_api_user_group_out import JsonApiUserGroupOut +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.json_api_user_group_patch import JsonApiUserGroupPatch +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage +from gooddata_api_client.models.json_api_user_identifier_linkage import JsonApiUserIdentifierLinkage +from gooddata_api_client.models.json_api_user_identifier_out import JsonApiUserIdentifierOut +from gooddata_api_client.models.json_api_user_identifier_out_attributes import JsonApiUserIdentifierOutAttributes +from gooddata_api_client.models.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.models.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.models.json_api_user_identifier_to_one_linkage import JsonApiUserIdentifierToOneLinkage +from gooddata_api_client.models.json_api_user_in import JsonApiUserIn +from gooddata_api_client.models.json_api_user_in_attributes import JsonApiUserInAttributes +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_in_relationships import JsonApiUserInRelationships +from gooddata_api_client.models.json_api_user_linkage import JsonApiUserLinkage +from gooddata_api_client.models.json_api_user_out import JsonApiUserOut +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks +from gooddata_api_client.models.json_api_user_patch import JsonApiUserPatch +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_user_setting_in import JsonApiUserSettingIn +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out import JsonApiUserSettingOut +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.models.json_api_user_setting_out_with_links import JsonApiUserSettingOutWithLinks +from gooddata_api_client.models.json_api_user_to_one_linkage import JsonApiUserToOneLinkage +from gooddata_api_client.models.json_api_visualization_object_in import JsonApiVisualizationObjectIn +from gooddata_api_client.models.json_api_visualization_object_in_attributes import JsonApiVisualizationObjectInAttributes +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage +from gooddata_api_client.models.json_api_visualization_object_out import JsonApiVisualizationObjectOut +from gooddata_api_client.models.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks +from gooddata_api_client.models.json_api_visualization_object_patch import JsonApiVisualizationObjectPatch +from gooddata_api_client.models.json_api_visualization_object_patch_attributes import JsonApiVisualizationObjectPatchAttributes +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id import JsonApiVisualizationObjectPostOptionalId +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage +from gooddata_api_client.models.json_api_workspace_automation_out import JsonApiWorkspaceAutomationOut +from gooddata_api_client.models.json_api_workspace_automation_out_includes import JsonApiWorkspaceAutomationOutIncludes +from gooddata_api_client.models.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.models.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships +from gooddata_api_client.models.json_api_workspace_automation_out_relationships_workspace import JsonApiWorkspaceAutomationOutRelationshipsWorkspace +from gooddata_api_client.models.json_api_workspace_automation_out_with_links import JsonApiWorkspaceAutomationOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_in import JsonApiWorkspaceDataFilterIn +from gooddata_api_client.models.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships +from gooddata_api_client.models.json_api_workspace_data_filter_in_relationships_filter_settings import JsonApiWorkspaceDataFilterInRelationshipsFilterSettings +from gooddata_api_client.models.json_api_workspace_data_filter_linkage import JsonApiWorkspaceDataFilterLinkage +from gooddata_api_client.models.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_patch import JsonApiWorkspaceDataFilterPatch +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in import JsonApiWorkspaceDataFilterSettingIn +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter import JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter +from gooddata_api_client.models.json_api_workspace_data_filter_setting_linkage import JsonApiWorkspaceDataFilterSettingLinkage +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch import JsonApiWorkspaceDataFilterSettingPatch +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_to_one_linkage import JsonApiWorkspaceDataFilterToOneLinkage +from gooddata_api_client.models.json_api_workspace_in import JsonApiWorkspaceIn +from gooddata_api_client.models.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes +from gooddata_api_client.models.json_api_workspace_in_attributes_data_source import JsonApiWorkspaceInAttributesDataSource +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships +from gooddata_api_client.models.json_api_workspace_linkage import JsonApiWorkspaceLinkage +from gooddata_api_client.models.json_api_workspace_out import JsonApiWorkspaceOut +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta +from gooddata_api_client.models.json_api_workspace_out_meta_config import JsonApiWorkspaceOutMetaConfig +from gooddata_api_client.models.json_api_workspace_out_meta_data_model import JsonApiWorkspaceOutMetaDataModel +from gooddata_api_client.models.json_api_workspace_out_meta_hierarchy import JsonApiWorkspaceOutMetaHierarchy +from gooddata_api_client.models.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks +from gooddata_api_client.models.json_api_workspace_patch import JsonApiWorkspacePatch +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.models.json_api_workspace_setting_in import JsonApiWorkspaceSettingIn +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_out_with_links import JsonApiWorkspaceSettingOutWithLinks +from gooddata_api_client.models.json_api_workspace_setting_patch import JsonApiWorkspaceSettingPatch +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id import JsonApiWorkspaceSettingPostOptionalId +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage +from gooddata_api_client.models.key_drivers_dimension import KeyDriversDimension +from gooddata_api_client.models.key_drivers_request import KeyDriversRequest +from gooddata_api_client.models.key_drivers_response import KeyDriversResponse +from gooddata_api_client.models.key_drivers_result import KeyDriversResult +from gooddata_api_client.models.label_identifier import LabelIdentifier +from gooddata_api_client.models.list_links import ListLinks +from gooddata_api_client.models.local_identifier import LocalIdentifier +from gooddata_api_client.models.locale_request import LocaleRequest +from gooddata_api_client.models.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.models.measure_definition import MeasureDefinition +from gooddata_api_client.models.measure_execution_result_header import MeasureExecutionResultHeader +from gooddata_api_client.models.measure_group_headers import MeasureGroupHeaders +from gooddata_api_client.models.measure_header import MeasureHeader +from gooddata_api_client.models.measure_item import MeasureItem +from gooddata_api_client.models.measure_item_definition import MeasureItemDefinition +from gooddata_api_client.models.measure_result_header import MeasureResultHeader +from gooddata_api_client.models.measure_value_filter import MeasureValueFilter +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.models.memory_item_use_cases import MemoryItemUseCases +from gooddata_api_client.models.metric import Metric +from gooddata_api_client.models.metric_record import MetricRecord +from gooddata_api_client.models.negative_attribute_filter import NegativeAttributeFilter +from gooddata_api_client.models.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter +from gooddata_api_client.models.note import Note +from gooddata_api_client.models.notes import Notes +from gooddata_api_client.models.notification import Notification +from gooddata_api_client.models.notification_channel_destination import NotificationChannelDestination +from gooddata_api_client.models.notification_content import NotificationContent +from gooddata_api_client.models.notification_data import NotificationData +from gooddata_api_client.models.notification_filter import NotificationFilter +from gooddata_api_client.models.notifications import Notifications +from gooddata_api_client.models.notifications_meta import NotificationsMeta +from gooddata_api_client.models.notifications_meta_total import NotificationsMetaTotal +from gooddata_api_client.models.object_links import ObjectLinks +from gooddata_api_client.models.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.organization_automation_identifier import OrganizationAutomationIdentifier +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.organization_permission_assignment import OrganizationPermissionAssignment +from gooddata_api_client.models.over import Over +from gooddata_api_client.models.page_metadata import PageMetadata +from gooddata_api_client.models.paging import Paging +from gooddata_api_client.models.parameter import Parameter +from gooddata_api_client.models.pdf_table_style import PdfTableStyle +from gooddata_api_client.models.pdf_table_style_property import PdfTableStyleProperty +from gooddata_api_client.models.pdm_ldm_request import PdmLdmRequest +from gooddata_api_client.models.pdm_sql import PdmSql +from gooddata_api_client.models.permissions_assignment import PermissionsAssignment +from gooddata_api_client.models.permissions_for_assignee import PermissionsForAssignee +from gooddata_api_client.models.permissions_for_assignee_rule import PermissionsForAssigneeRule +from gooddata_api_client.models.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage_request import PlatformUsageRequest +from gooddata_api_client.models.pop_dataset import PopDataset +from gooddata_api_client.models.pop_dataset_measure_definition import PopDatasetMeasureDefinition +from gooddata_api_client.models.pop_dataset_measure_definition_previous_period_measure import PopDatasetMeasureDefinitionPreviousPeriodMeasure +from gooddata_api_client.models.pop_date import PopDate +from gooddata_api_client.models.pop_date_measure_definition import PopDateMeasureDefinition +from gooddata_api_client.models.pop_date_measure_definition_over_period_measure import PopDateMeasureDefinitionOverPeriodMeasure +from gooddata_api_client.models.pop_measure_definition import PopMeasureDefinition +from gooddata_api_client.models.positive_attribute_filter import PositiveAttributeFilter +from gooddata_api_client.models.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter +from gooddata_api_client.models.quality_issue import QualityIssue +from gooddata_api_client.models.quality_issue_object import QualityIssueObject +from gooddata_api_client.models.range import Range +from gooddata_api_client.models.range_measure_value_filter import RangeMeasureValueFilter +from gooddata_api_client.models.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter +from gooddata_api_client.models.range_wrapper import RangeWrapper +from gooddata_api_client.models.ranking_filter import RankingFilter +from gooddata_api_client.models.ranking_filter_ranking_filter import RankingFilterRankingFilter +from gooddata_api_client.models.raw_custom_label import RawCustomLabel +from gooddata_api_client.models.raw_custom_metric import RawCustomMetric +from gooddata_api_client.models.raw_custom_override import RawCustomOverride +from gooddata_api_client.models.raw_export_automation_request import RawExportAutomationRequest +from gooddata_api_client.models.raw_export_request import RawExportRequest +from gooddata_api_client.models.reference_identifier import ReferenceIdentifier +from gooddata_api_client.models.reference_source_column import ReferenceSourceColumn +from gooddata_api_client.models.relative import Relative +from gooddata_api_client.models.relative_bounded_date_filter import RelativeBoundedDateFilter +from gooddata_api_client.models.relative_date_filter import RelativeDateFilter +from gooddata_api_client.models.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter +from gooddata_api_client.models.relative_wrapper import RelativeWrapper +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_llm_endpoint import ResolvedLlmEndpoint +from gooddata_api_client.models.resolved_llm_endpoints import ResolvedLlmEndpoints +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.models.rest_api_identifier import RestApiIdentifier +from gooddata_api_client.models.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.models.result_dimension import ResultDimension +from gooddata_api_client.models.result_dimension_header import ResultDimensionHeader +from gooddata_api_client.models.result_spec import ResultSpec +from gooddata_api_client.models.route_result import RouteResult +from gooddata_api_client.models.rsa_specification import RsaSpecification +from gooddata_api_client.models.rule_permission import RulePermission +from gooddata_api_client.models.running_section import RunningSection +from gooddata_api_client.models.saved_visualization import SavedVisualization +from gooddata_api_client.models.scan_request import ScanRequest +from gooddata_api_client.models.scan_result_pdm import ScanResultPdm +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse +from gooddata_api_client.models.search_relationship_object import SearchRelationshipObject +from gooddata_api_client.models.search_request import SearchRequest +from gooddata_api_client.models.search_result import SearchResult +from gooddata_api_client.models.search_result_object import SearchResultObject +from gooddata_api_client.models.section_slide_template import SectionSlideTemplate +from gooddata_api_client.models.settings import Settings +from gooddata_api_client.models.simple_measure_definition import SimpleMeasureDefinition +from gooddata_api_client.models.simple_measure_definition_measure import SimpleMeasureDefinitionMeasure +from gooddata_api_client.models.skeleton import Skeleton +from gooddata_api_client.models.slides_export_request import SlidesExportRequest +from gooddata_api_client.models.smart_function_response import SmartFunctionResponse +from gooddata_api_client.models.smtp import Smtp +from gooddata_api_client.models.sort_key import SortKey +from gooddata_api_client.models.sort_key_attribute import SortKeyAttribute +from gooddata_api_client.models.sort_key_attribute_attribute import SortKeyAttributeAttribute +from gooddata_api_client.models.sort_key_total import SortKeyTotal +from gooddata_api_client.models.sort_key_total_total import SortKeyTotalTotal +from gooddata_api_client.models.sort_key_value import SortKeyValue +from gooddata_api_client.models.sort_key_value_value import SortKeyValueValue +from gooddata_api_client.models.sql_column import SqlColumn +from gooddata_api_client.models.sql_query import SqlQuery +from gooddata_api_client.models.suggestion import Suggestion +from gooddata_api_client.models.switch_identity_provider_request import SwitchIdentityProviderRequest +from gooddata_api_client.models.table import Table +from gooddata_api_client.models.table_override import TableOverride +from gooddata_api_client.models.table_warning import TableWarning +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_notification import TestNotification +from gooddata_api_client.models.test_query_duration import TestQueryDuration +from gooddata_api_client.models.test_request import TestRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.models.total import Total +from gooddata_api_client.models.total_dimension import TotalDimension +from gooddata_api_client.models.total_execution_result_header import TotalExecutionResultHeader +from gooddata_api_client.models.total_result_header import TotalResultHeader +from gooddata_api_client.models.trigger_automation_request import TriggerAutomationRequest +from gooddata_api_client.models.user_assignee import UserAssignee +from gooddata_api_client.models.user_context import UserContext +from gooddata_api_client.models.user_group_assignee import UserGroupAssignee +from gooddata_api_client.models.user_group_identifier import UserGroupIdentifier +from gooddata_api_client.models.user_group_permission import UserGroupPermission +from gooddata_api_client.models.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment +from gooddata_api_client.models.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.models.user_management_user_group_member import UserManagementUserGroupMember +from gooddata_api_client.models.user_management_user_group_members import UserManagementUserGroupMembers +from gooddata_api_client.models.user_management_user_groups import UserManagementUserGroups +from gooddata_api_client.models.user_management_user_groups_item import UserManagementUserGroupsItem +from gooddata_api_client.models.user_management_users import UserManagementUsers +from gooddata_api_client.models.user_management_users_item import UserManagementUsersItem +from gooddata_api_client.models.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment +from gooddata_api_client.models.user_permission import UserPermission +from gooddata_api_client.models.validate_by_item import ValidateByItem +from gooddata_api_client.models.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest +from gooddata_api_client.models.validate_llm_endpoint_request import ValidateLLMEndpointRequest +from gooddata_api_client.models.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.models.value import Value +from gooddata_api_client.models.visible_filter import VisibleFilter +from gooddata_api_client.models.visual_export_request import VisualExportRequest +from gooddata_api_client.models.webhook import Webhook +from gooddata_api_client.models.webhook_automation_info import WebhookAutomationInfo +from gooddata_api_client.models.webhook_message import WebhookMessage +from gooddata_api_client.models.webhook_message_data import WebhookMessageData +from gooddata_api_client.models.webhook_recipient import WebhookRecipient +from gooddata_api_client.models.widget_slides_template import WidgetSlidesTemplate +from gooddata_api_client.models.workspace_automation_identifier import WorkspaceAutomationIdentifier +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.models.workspace_data_source import WorkspaceDataSource +from gooddata_api_client.models.workspace_identifier import WorkspaceIdentifier +from gooddata_api_client.models.workspace_permission_assignment import WorkspacePermissionAssignment +from gooddata_api_client.models.workspace_user import WorkspaceUser +from gooddata_api_client.models.workspace_user_group import WorkspaceUserGroup +from gooddata_api_client.models.workspace_user_groups import WorkspaceUserGroups +from gooddata_api_client.models.workspace_users import WorkspaceUsers +from gooddata_api_client.models.xliff import Xliff diff --git a/gooddata-api-client/gooddata_api_client/api/__init__.py b/gooddata-api-client/gooddata_api_client/api/__init__.py index ec1c32836..ce6ae440b 100644 --- a/gooddata-api-client/gooddata_api_client/api/__init__.py +++ b/gooddata-api-client/gooddata_api_client/api/__init__.py @@ -1,3 +1,76 @@ -# do not import all apis into this module because that uses a lot of memory and stack frames -# if you need the ability to import all apis from one package, import them with -# from gooddata_api_client.apis import AIApi +# flake8: noqa + +# import apis into api package +from gooddata_api_client.api.ai_api import AIApi +from gooddata_api_client.api.api_tokens_api import APITokensApi +from gooddata_api_client.api.analytics_model_api import AnalyticsModelApi +from gooddata_api_client.api.appearance_api import AppearanceApi +from gooddata_api_client.api.attribute_hierarchies_api import AttributeHierarchiesApi +from gooddata_api_client.api.attributes_api import AttributesApi +from gooddata_api_client.api.automations_api import AutomationsApi +from gooddata_api_client.api.available_drivers_api import AvailableDriversApi +from gooddata_api_client.api.csp_directives_api import CSPDirectivesApi +from gooddata_api_client.api.computation_api import ComputationApi +from gooddata_api_client.api.context_filters_api import ContextFiltersApi +from gooddata_api_client.api.cookie_security_configuration_api import CookieSecurityConfigurationApi +from gooddata_api_client.api.dashboards_api import DashboardsApi +from gooddata_api_client.api.data_filters_api import DataFiltersApi +from gooddata_api_client.api.data_source_declarative_apis_api import DataSourceDeclarativeAPIsApi +from gooddata_api_client.api.data_source_entity_apis_api import DataSourceEntityAPIsApi +from gooddata_api_client.api.datasets_api import DatasetsApi +from gooddata_api_client.api.dependency_graph_api import DependencyGraphApi +from gooddata_api_client.api.entitlement_api import EntitlementApi +from gooddata_api_client.api.export_definitions_api import ExportDefinitionsApi +from gooddata_api_client.api.export_templates_api import ExportTemplatesApi +from gooddata_api_client.api.facts_api import FactsApi +from gooddata_api_client.api.filter_views_api import FilterViewsApi +from gooddata_api_client.api.generate_logical_data_model_api import GenerateLogicalDataModelApi +from gooddata_api_client.api.hierarchy_api import HierarchyApi +from gooddata_api_client.api.identity_providers_api import IdentityProvidersApi +from gooddata_api_client.api.image_export_api import ImageExportApi +from gooddata_api_client.api.invalidate_cache_api import InvalidateCacheApi +from gooddata_api_client.api.jwks_api import JWKSApi +from gooddata_api_client.api.ldm_declarative_apis_api import LDMDeclarativeAPIsApi +from gooddata_api_client.api.llm_endpoints_api import LLMEndpointsApi +from gooddata_api_client.api.labels_api import LabelsApi +from gooddata_api_client.api.manage_permissions_api import ManagePermissionsApi +from gooddata_api_client.api.metadata_sync_api import MetadataSyncApi +from gooddata_api_client.api.metrics_api import MetricsApi +from gooddata_api_client.api.notification_channels_api import NotificationChannelsApi +from gooddata_api_client.api.options_api import OptionsApi +from gooddata_api_client.api.organization_api import OrganizationApi +from gooddata_api_client.api.organization_declarative_apis_api import OrganizationDeclarativeAPIsApi +from gooddata_api_client.api.organization_entity_apis_api import OrganizationEntityAPIsApi +from gooddata_api_client.api.permissions_api import PermissionsApi +from gooddata_api_client.api.plugins_api import PluginsApi +from gooddata_api_client.api.raw_export_api import RawExportApi +from gooddata_api_client.api.reporting_settings_api import ReportingSettingsApi +from gooddata_api_client.api.scanning_api import ScanningApi +from gooddata_api_client.api.slides_export_api import SlidesExportApi +from gooddata_api_client.api.smart_functions_api import SmartFunctionsApi +from gooddata_api_client.api.tabular_export_api import TabularExportApi +from gooddata_api_client.api.test_connection_api import TestConnectionApi +from gooddata_api_client.api.translations_api import TranslationsApi +from gooddata_api_client.api.usage_api import UsageApi +from gooddata_api_client.api.user_groups_declarative_apis_api import UserGroupsDeclarativeAPIsApi +from gooddata_api_client.api.user_groups_entity_apis_api import UserGroupsEntityAPIsApi +from gooddata_api_client.api.user_data_filters_api import UserDataFiltersApi +from gooddata_api_client.api.user_identifiers_api import UserIdentifiersApi +from gooddata_api_client.api.user_settings_api import UserSettingsApi +from gooddata_api_client.api.user_management_api import UserManagementApi +from gooddata_api_client.api.users_declarative_apis_api import UsersDeclarativeAPIsApi +from gooddata_api_client.api.users_entity_apis_api import UsersEntityAPIsApi +from gooddata_api_client.api.visual_export_api import VisualExportApi +from gooddata_api_client.api.visualization_object_api import VisualizationObjectApi +from gooddata_api_client.api.workspaces_declarative_apis_api import WorkspacesDeclarativeAPIsApi +from gooddata_api_client.api.workspaces_entity_apis_api import WorkspacesEntityAPIsApi +from gooddata_api_client.api.workspaces_settings_api import WorkspacesSettingsApi +from gooddata_api_client.api.actions_api import ActionsApi +from gooddata_api_client.api.automation_organization_view_controller_api import AutomationOrganizationViewControllerApi +from gooddata_api_client.api.entities_api import EntitiesApi +from gooddata_api_client.api.layout_api import LayoutApi +from gooddata_api_client.api.organization_controller_api import OrganizationControllerApi +from gooddata_api_client.api.organization_model_controller_api import OrganizationModelControllerApi +from gooddata_api_client.api.user_model_controller_api import UserModelControllerApi +from gooddata_api_client.api.workspace_object_controller_api import WorkspaceObjectControllerApi + diff --git a/gooddata-api-client/gooddata_api_client/api/actions_api.py b/gooddata-api-client/gooddata_api_client/api/actions_api.py index d7dd1388c..c7afed95f 100644 --- a/gooddata-api-client/gooddata_api_client/api/actions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/actions_api.py @@ -1,14409 +1,28159 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens -from gooddata_api_client.model.afm_execution import AfmExecution -from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse -from gooddata_api_client.model.afm_valid_descendants_query import AfmValidDescendantsQuery -from gooddata_api_client.model.afm_valid_descendants_response import AfmValidDescendantsResponse -from gooddata_api_client.model.afm_valid_objects_query import AfmValidObjectsQuery -from gooddata_api_client.model.afm_valid_objects_response import AfmValidObjectsResponse -from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags -from gooddata_api_client.model.anomaly_detection_request import AnomalyDetectionRequest -from gooddata_api_client.model.anomaly_detection_result import AnomalyDetectionResult -from gooddata_api_client.model.api_entitlement import ApiEntitlement -from gooddata_api_client.model.available_assignees import AvailableAssignees -from gooddata_api_client.model.chat_history_request import ChatHistoryRequest -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_request import ChatRequest -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.chat_usage_response import ChatUsageResponse -from gooddata_api_client.model.clustering_request import ClusteringRequest -from gooddata_api_client.model.clustering_result import ClusteringResult -from gooddata_api_client.model.column_statistics_request import ColumnStatisticsRequest -from gooddata_api_client.model.column_statistics_response import ColumnStatisticsResponse -from gooddata_api_client.model.dashboard_permissions import DashboardPermissions -from gooddata_api_client.model.dashboard_tabular_export_request import DashboardTabularExportRequest -from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment -from gooddata_api_client.model.data_source_schemata import DataSourceSchemata -from gooddata_api_client.model.declarative_model import DeclarativeModel -from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse -from gooddata_api_client.model.elements_request import ElementsRequest -from gooddata_api_client.model.elements_response import ElementsResponse -from gooddata_api_client.model.entitlements_request import EntitlementsRequest -from gooddata_api_client.model.execution_result import ExecutionResult -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.forecast_request import ForecastRequest -from gooddata_api_client.model.forecast_result import ForecastResult -from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner -from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse -from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications -from gooddata_api_client.model.image_export_request import ImageExportRequest -from gooddata_api_client.model.key_drivers_request import KeyDriversRequest -from gooddata_api_client.model.key_drivers_response import KeyDriversResponse -from gooddata_api_client.model.key_drivers_result import KeyDriversResult -from gooddata_api_client.model.locale_request import LocaleRequest -from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner -from gooddata_api_client.model.memory_item import MemoryItem -from gooddata_api_client.model.notifications import Notifications -from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest -from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment -from gooddata_api_client.model.platform_usage import PlatformUsage -from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest -from gooddata_api_client.model.raw_export_request import RawExportRequest -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest -from gooddata_api_client.model.resolved_llm_endpoints import ResolvedLlmEndpoints -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata -from gooddata_api_client.model.scan_request import ScanRequest -from gooddata_api_client.model.scan_result_pdm import ScanResultPdm -from gooddata_api_client.model.scan_sql_request import ScanSqlRequest -from gooddata_api_client.model.scan_sql_response import ScanSqlResponse -from gooddata_api_client.model.search_request import SearchRequest -from gooddata_api_client.model.search_result import SearchResult -from gooddata_api_client.model.slides_export_request import SlidesExportRequest -from gooddata_api_client.model.smart_function_response import SmartFunctionResponse -from gooddata_api_client.model.switch_identity_provider_request import SwitchIdentityProviderRequest -from gooddata_api_client.model.tabular_export_request import TabularExportRequest -from gooddata_api_client.model.test_definition_request import TestDefinitionRequest -from gooddata_api_client.model.test_destination_request import TestDestinationRequest -from gooddata_api_client.model.test_request import TestRequest -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest -from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest -from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest -from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse -from gooddata_api_client.model.visual_export_request import VisualExportRequest -from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest -from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment -from gooddata_api_client.model.workspace_user_groups import WorkspaceUserGroups -from gooddata_api_client.model.workspace_users import WorkspaceUsers -from gooddata_api_client.model.xliff import Xliff - - -class ActionsApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictBytes, StrictInt, StrictStr, field_validator +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated +from gooddata_api_client.models.afm_cancel_tokens import AfmCancelTokens +from gooddata_api_client.models.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution_response import AfmExecutionResponse +from gooddata_api_client.models.afm_valid_descendants_query import AfmValidDescendantsQuery +from gooddata_api_client.models.afm_valid_descendants_response import AfmValidDescendantsResponse +from gooddata_api_client.models.afm_valid_objects_query import AfmValidObjectsQuery +from gooddata_api_client.models.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.models.analytics_catalog_tags import AnalyticsCatalogTags +from gooddata_api_client.models.anomaly_detection_request import AnomalyDetectionRequest +from gooddata_api_client.models.anomaly_detection_result import AnomalyDetectionResult +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.models.available_assignees import AvailableAssignees +from gooddata_api_client.models.chat_history_request import ChatHistoryRequest +from gooddata_api_client.models.chat_history_result import ChatHistoryResult +from gooddata_api_client.models.chat_request import ChatRequest +from gooddata_api_client.models.chat_result import ChatResult +from gooddata_api_client.models.chat_usage_response import ChatUsageResponse +from gooddata_api_client.models.clustering_request import ClusteringRequest +from gooddata_api_client.models.clustering_result import ClusteringResult +from gooddata_api_client.models.column_statistics_request import ColumnStatisticsRequest +from gooddata_api_client.models.column_statistics_response import ColumnStatisticsResponse +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions +from gooddata_api_client.models.dashboard_tabular_export_request import DashboardTabularExportRequest +from gooddata_api_client.models.data_source_permission_assignment import DataSourcePermissionAssignment +from gooddata_api_client.models.data_source_schemata import DataSourceSchemata +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.elements_request import ElementsRequest +from gooddata_api_client.models.elements_response import ElementsResponse +from gooddata_api_client.models.entitlements_request import EntitlementsRequest +from gooddata_api_client.models.execution_result import ExecutionResult +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.forecast_request import ForecastRequest +from gooddata_api_client.models.forecast_result import ForecastResult +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.models.get_quality_issues_response import GetQualityIssuesResponse +from gooddata_api_client.models.hierarchy_object_identification import HierarchyObjectIdentification +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.image_export_request import ImageExportRequest +from gooddata_api_client.models.key_drivers_request import KeyDriversRequest +from gooddata_api_client.models.key_drivers_response import KeyDriversResponse +from gooddata_api_client.models.key_drivers_result import KeyDriversResult +from gooddata_api_client.models.locale_request import LocaleRequest +from gooddata_api_client.models.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.models.notifications import Notifications +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.organization_permission_assignment import OrganizationPermissionAssignment +from gooddata_api_client.models.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage_request import PlatformUsageRequest +from gooddata_api_client.models.raw_export_request import RawExportRequest +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_llm_endpoints import ResolvedLlmEndpoints +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.models.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.models.scan_request import ScanRequest +from gooddata_api_client.models.scan_result_pdm import ScanResultPdm +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse +from gooddata_api_client.models.search_request import SearchRequest +from gooddata_api_client.models.search_result import SearchResult +from gooddata_api_client.models.slides_export_request import SlidesExportRequest +from gooddata_api_client.models.smart_function_response import SmartFunctionResponse +from gooddata_api_client.models.switch_identity_provider_request import SwitchIdentityProviderRequest +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_request import TestRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.models.trigger_automation_request import TriggerAutomationRequest +from gooddata_api_client.models.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest +from gooddata_api_client.models.validate_llm_endpoint_request import ValidateLLMEndpointRequest +from gooddata_api_client.models.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.models.visual_export_request import VisualExportRequest +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.models.workspace_permission_assignment import WorkspacePermissionAssignment +from gooddata_api_client.models.workspace_user_groups import WorkspaceUserGroups +from gooddata_api_client.models.workspace_users import WorkspaceUsers +from gooddata_api_client.models.xliff import Xliff + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class ActionsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.ai_chat_endpoint = _Endpoint( - settings={ - 'response_type': (ChatResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chat', - 'operation_id': 'ai_chat', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'chat_request', - ], - 'required': [ - 'workspace_id', - 'chat_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'chat_request': - (ChatRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'chat_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + + + @validate_call + def ai_chat( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ChatResult: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ai_chat_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ChatResult]: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ai_chat_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_chat_serialize( + self, + workspace_id, + chat_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if chat_request is not None: + _body_params = chat_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.ai_chat_history_endpoint = _Endpoint( - settings={ - 'response_type': (ChatHistoryResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory', - 'operation_id': 'ai_chat_history', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'chat_history_request', - ], - 'required': [ - 'workspace_id', - 'chat_history_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'chat_history_request': - (ChatHistoryRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'chat_history_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/chat', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_chat_history( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_history_request: ChatHistoryRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ChatHistoryResult: + """(BETA) Get Chat History + + (BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_history_request: (required) + :type chat_history_request: ChatHistoryRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_history_serialize( + workspace_id=workspace_id, + chat_history_request=chat_history_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatHistoryResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ai_chat_history_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_history_request: ChatHistoryRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ChatHistoryResult]: + """(BETA) Get Chat History + + (BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_history_request: (required) + :type chat_history_request: ChatHistoryRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_history_serialize( + workspace_id=workspace_id, + chat_history_request=chat_history_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatHistoryResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ai_chat_history_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_history_request: ChatHistoryRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Get Chat History + + (BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_history_request: (required) + :type chat_history_request: ChatHistoryRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_history_serialize( + workspace_id=workspace_id, + chat_history_request=chat_history_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatHistoryResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_chat_history_serialize( + self, + workspace_id, + chat_history_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if chat_history_request is not None: + _body_params = chat_history_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.ai_chat_stream_endpoint = _Endpoint( - settings={ - 'response_type': ([dict],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatStream', - 'operation_id': 'ai_chat_stream', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'chat_request', - ], - 'required': [ - 'workspace_id', - 'chat_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'chat_request': - (ChatRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'chat_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_chat_stream( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[object]: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_stream_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[object]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ai_chat_stream_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[object]]: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_stream_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[object]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ai_chat_stream_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_stream_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[object]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_chat_stream_serialize( + self, + workspace_id, + chat_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if chat_request is not None: + _body_params = chat_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'text/event-stream' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.ai_chat_usage_endpoint = _Endpoint( - settings={ - 'response_type': (ChatUsageResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage', - 'operation_id': 'ai_chat_usage', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/chatStream', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_chat_usage( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ChatUsageResponse: + """Get Chat Usage + + Returns usage statistics of chat for a user in a workspace. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_usage_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatUsageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ai_chat_usage_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ChatUsageResponse]: + """Get Chat Usage + + Returns usage statistics of chat for a user in a workspace. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_usage_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatUsageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ai_chat_usage_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Chat Usage + + Returns usage statistics of chat for a user in a workspace. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_usage_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatUsageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_chat_usage_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.ai_search_endpoint = _Endpoint( - settings={ - 'response_type': (SearchResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/search', - 'operation_id': 'ai_search', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'search_request', - ], - 'required': [ - 'workspace_id', - 'search_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'search_request': - (SearchRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'search_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_search( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + search_request: SearchRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SearchResult: + """(BETA) Semantic Search in Metadata + + (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param search_request: (required) + :type search_request: SearchRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_search_serialize( + workspace_id=workspace_id, + search_request=search_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SearchResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ai_search_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + search_request: SearchRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SearchResult]: + """(BETA) Semantic Search in Metadata + + (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param search_request: (required) + :type search_request: SearchRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_search_serialize( + workspace_id=workspace_id, + search_request=search_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SearchResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ai_search_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + search_request: SearchRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Semantic Search in Metadata + + (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param search_request: (required) + :type search_request: SearchRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_search_serialize( + workspace_id=workspace_id, + search_request=search_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SearchResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_search_serialize( + self, + workspace_id, + search_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if search_request is not None: + _body_params = search_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.all_platform_usage_endpoint = _Endpoint( - settings={ - 'response_type': ([PlatformUsage],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/collectUsage', - 'operation_id': 'all_platform_usage', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/search', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def all_platform_usage( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[PlatformUsage]: + """Info about the platform usage. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._all_platform_usage_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def all_platform_usage_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[PlatformUsage]]: + """Info about the platform usage. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._all_platform_usage_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def all_platform_usage_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Info about the platform usage. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._all_platform_usage_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _all_platform_usage_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.anomaly_detection_endpoint = _Endpoint( - settings={ - 'response_type': (SmartFunctionResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}', - 'operation_id': 'anomaly_detection', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'anomaly_detection_request', - 'skip_cache', - ], - 'required': [ - 'workspace_id', - 'result_id', - 'anomaly_detection_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'anomaly_detection_request': - (AnomalyDetectionRequest,), - 'skip_cache': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'skip_cache': 'skip-cache', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'anomaly_detection_request': 'body', - 'skip_cache': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/collectUsage', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def anomaly_detection( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + anomaly_detection_request: AnomalyDetectionRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SmartFunctionResponse: + """(EXPERIMENTAL) Smart functions - Anomaly Detection + + (EXPERIMENTAL) Computes anomaly detection. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param anomaly_detection_request: (required) + :type anomaly_detection_request: AnomalyDetectionRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_serialize( + workspace_id=workspace_id, + result_id=result_id, + anomaly_detection_request=anomaly_detection_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def anomaly_detection_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + anomaly_detection_request: AnomalyDetectionRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SmartFunctionResponse]: + """(EXPERIMENTAL) Smart functions - Anomaly Detection + + (EXPERIMENTAL) Computes anomaly detection. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param anomaly_detection_request: (required) + :type anomaly_detection_request: AnomalyDetectionRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_serialize( + workspace_id=workspace_id, + result_id=result_id, + anomaly_detection_request=anomaly_detection_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def anomaly_detection_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + anomaly_detection_request: AnomalyDetectionRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Smart functions - Anomaly Detection + + (EXPERIMENTAL) Computes anomaly detection. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param anomaly_detection_request: (required) + :type anomaly_detection_request: AnomalyDetectionRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_serialize( + workspace_id=workspace_id, + result_id=result_id, + anomaly_detection_request=anomaly_detection_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _anomaly_detection_serialize( + self, + workspace_id, + result_id, + anomaly_detection_request, + skip_cache, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + # process the form parameters + # process the body parameter + if anomaly_detection_request is not None: + _body_params = anomaly_detection_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.anomaly_detection_result_endpoint = _Endpoint( - settings={ - 'response_type': (AnomalyDetectionResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}', - 'operation_id': 'anomaly_detection_result', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'offset', - 'limit', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'offset': - (int,), - 'limit': - (int,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'offset': 'offset', - 'limit': 'limit', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'offset': 'query', - 'limit': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def anomaly_detection_result( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnomalyDetectionResult: + """(EXPERIMENTAL) Smart functions - Anomaly Detection Result + + (EXPERIMENTAL) Gets anomalies. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnomalyDetectionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def anomaly_detection_result_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnomalyDetectionResult]: + """(EXPERIMENTAL) Smart functions - Anomaly Detection Result + + (EXPERIMENTAL) Gets anomalies. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnomalyDetectionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def anomaly_detection_result_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Smart functions - Anomaly Detection Result + + (EXPERIMENTAL) Gets anomalies. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnomalyDetectionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _anomaly_detection_result_serialize( + self, + workspace_id, + result_id, + offset, + limit, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.available_assignees_endpoint = _Endpoint( - settings={ - 'response_type': (AvailableAssignees,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees', - 'operation_id': 'available_assignees', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'dashboard_id', - ], - 'required': [ - 'workspace_id', - 'dashboard_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'dashboard_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'dashboard_id': 'dashboardId', - }, - 'location_map': { - 'workspace_id': 'path', - 'dashboard_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def available_assignees( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AvailableAssignees: + """Get Available Assignees + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._available_assignees_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AvailableAssignees", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def available_assignees_with_http_info( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AvailableAssignees]: + """Get Available Assignees + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._available_assignees_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AvailableAssignees", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def available_assignees_without_preload_content( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Available Assignees + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._available_assignees_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AvailableAssignees", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _available_assignees_serialize( + self, + workspace_id, + dashboard_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if dashboard_id is not None: + _path_params['dashboardId'] = dashboard_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.cancel_executions_endpoint = _Endpoint( - settings={ - 'response_type': (AfmCancelTokens,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel', - 'operation_id': 'cancel_executions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'afm_cancel_tokens', - ], - 'required': [ - 'workspace_id', - 'afm_cancel_tokens', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'afm_cancel_tokens': - (AfmCancelTokens,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'afm_cancel_tokens': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def cancel_executions( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_cancel_tokens: AfmCancelTokens, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AfmCancelTokens: + """Applies all the given cancel tokens. + + Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_cancel_tokens: (required) + :type afm_cancel_tokens: AfmCancelTokens + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._cancel_executions_serialize( + workspace_id=workspace_id, + afm_cancel_tokens=afm_cancel_tokens, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmCancelTokens", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def cancel_executions_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_cancel_tokens: AfmCancelTokens, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AfmCancelTokens]: + """Applies all the given cancel tokens. + + Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_cancel_tokens: (required) + :type afm_cancel_tokens: AfmCancelTokens + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._cancel_executions_serialize( + workspace_id=workspace_id, + afm_cancel_tokens=afm_cancel_tokens, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmCancelTokens", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def cancel_executions_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_cancel_tokens: AfmCancelTokens, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Applies all the given cancel tokens. + + Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_cancel_tokens: (required) + :type afm_cancel_tokens: AfmCancelTokens + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._cancel_executions_serialize( + workspace_id=workspace_id, + afm_cancel_tokens=afm_cancel_tokens, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmCancelTokens", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _cancel_executions_serialize( + self, + workspace_id, + afm_cancel_tokens, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if afm_cancel_tokens is not None: + _body_params = afm_cancel_tokens + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.check_entity_overrides_endpoint = _Endpoint( - settings={ - 'response_type': ([IdentifierDuplications],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides', - 'operation_id': 'check_entity_overrides', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'hierarchy_object_identification', - ], - 'required': [ - 'workspace_id', - 'hierarchy_object_identification', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'hierarchy_object_identification': - ([HierarchyObjectIdentification],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'hierarchy_object_identification': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def check_entity_overrides( + self, + workspace_id: StrictStr, + hierarchy_object_identification: List[HierarchyObjectIdentification], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[IdentifierDuplications]: + """Finds entities with given ID in hierarchy. + + Finds entities with given ID in hierarchy (e.g. to check possible future conflicts). + + :param workspace_id: (required) + :type workspace_id: str + :param hierarchy_object_identification: (required) + :type hierarchy_object_identification: List[HierarchyObjectIdentification] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_entity_overrides_serialize( + workspace_id=workspace_id, + hierarchy_object_identification=hierarchy_object_identification, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def check_entity_overrides_with_http_info( + self, + workspace_id: StrictStr, + hierarchy_object_identification: List[HierarchyObjectIdentification], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[IdentifierDuplications]]: + """Finds entities with given ID in hierarchy. + + Finds entities with given ID in hierarchy (e.g. to check possible future conflicts). + + :param workspace_id: (required) + :type workspace_id: str + :param hierarchy_object_identification: (required) + :type hierarchy_object_identification: List[HierarchyObjectIdentification] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_entity_overrides_serialize( + workspace_id=workspace_id, + hierarchy_object_identification=hierarchy_object_identification, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def check_entity_overrides_without_preload_content( + self, + workspace_id: StrictStr, + hierarchy_object_identification: List[HierarchyObjectIdentification], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Finds entities with given ID in hierarchy. + + Finds entities with given ID in hierarchy (e.g. to check possible future conflicts). + + :param workspace_id: (required) + :type workspace_id: str + :param hierarchy_object_identification: (required) + :type hierarchy_object_identification: List[HierarchyObjectIdentification] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_entity_overrides_serialize( + workspace_id=workspace_id, + hierarchy_object_identification=hierarchy_object_identification, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _check_entity_overrides_serialize( + self, + workspace_id, + hierarchy_object_identification, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'HierarchyObjectIdentification': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if hierarchy_object_identification is not None: + _body_params = hierarchy_object_identification + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.clean_translations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations/clean', - 'operation_id': 'clean_translations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'locale_request', - ], - 'required': [ - 'workspace_id', - 'locale_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'locale_request': - (LocaleRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'locale_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def clean_translations( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Cleans up translations. + + Cleans up all translations for a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clean_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def clean_translations_with_http_info( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Cleans up translations. + + Cleans up all translations for a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clean_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def clean_translations_without_preload_content( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Cleans up translations. + + Cleans up all translations for a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clean_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _clean_translations_serialize( + self, + workspace_id, + locale_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if locale_request is not None: + _body_params = locale_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/translations/clean', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def clustering( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + clustering_request: ClusteringRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SmartFunctionResponse: + """(EXPERIMENTAL) Smart functions - Clustering + + (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param clustering_request: (required) + :type clustering_request: ClusteringRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_serialize( + workspace_id=workspace_id, + result_id=result_id, + clustering_request=clustering_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def clustering_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + clustering_request: ClusteringRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SmartFunctionResponse]: + """(EXPERIMENTAL) Smart functions - Clustering + + (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param clustering_request: (required) + :type clustering_request: ClusteringRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_serialize( + workspace_id=workspace_id, + result_id=result_id, + clustering_request=clustering_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def clustering_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + clustering_request: ClusteringRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Smart functions - Clustering + + (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param clustering_request: (required) + :type clustering_request: ClusteringRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_serialize( + workspace_id=workspace_id, + result_id=result_id, + clustering_request=clustering_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _clustering_serialize( + self, + workspace_id, + result_id, + clustering_request, + skip_cache, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + # process the form parameters + # process the body parameter + if clustering_request is not None: + _body_params = clustering_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.clustering_endpoint = _Endpoint( - settings={ - 'response_type': (SmartFunctionResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId}', - 'operation_id': 'clustering', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'clustering_request', - 'skip_cache', - ], - 'required': [ - 'workspace_id', - 'result_id', - 'clustering_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'clustering_request': - (ClusteringRequest,), - 'skip_cache': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'skip_cache': 'skip-cache', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'clustering_request': 'body', - 'skip_cache': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def clustering_result( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ClusteringResult: + """(EXPERIMENTAL) Smart functions - Clustering Result + + (EXPERIMENTAL) Gets clustering result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ClusteringResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def clustering_result_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ClusteringResult]: + """(EXPERIMENTAL) Smart functions - Clustering Result + + (EXPERIMENTAL) Gets clustering result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ClusteringResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def clustering_result_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Smart functions - Clustering Result + + (EXPERIMENTAL) Gets clustering result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ClusteringResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _clustering_result_serialize( + self, + workspace_id, + result_id, + offset, + limit, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.clustering_result_endpoint = _Endpoint( - settings={ - 'response_type': (ClusteringResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId}', - 'operation_id': 'clustering_result', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'offset', - 'limit', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'offset': - (int,), - 'limit': - (int,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'offset': 'offset', - 'limit': 'limit', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'offset': 'query', - 'limit': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def column_statistics( + self, + data_source_id: StrictStr, + column_statistics_request: ColumnStatisticsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ColumnStatisticsResponse: + """(EXPERIMENTAL) Compute column statistics + + (EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source. + + :param data_source_id: (required) + :type data_source_id: str + :param column_statistics_request: (required) + :type column_statistics_request: ColumnStatisticsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._column_statistics_serialize( + data_source_id=data_source_id, + column_statistics_request=column_statistics_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ColumnStatisticsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def column_statistics_with_http_info( + self, + data_source_id: StrictStr, + column_statistics_request: ColumnStatisticsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ColumnStatisticsResponse]: + """(EXPERIMENTAL) Compute column statistics + + (EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source. + + :param data_source_id: (required) + :type data_source_id: str + :param column_statistics_request: (required) + :type column_statistics_request: ColumnStatisticsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._column_statistics_serialize( + data_source_id=data_source_id, + column_statistics_request=column_statistics_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ColumnStatisticsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def column_statistics_without_preload_content( + self, + data_source_id: StrictStr, + column_statistics_request: ColumnStatisticsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Compute column statistics + + (EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source. + + :param data_source_id: (required) + :type data_source_id: str + :param column_statistics_request: (required) + :type column_statistics_request: ColumnStatisticsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._column_statistics_serialize( + data_source_id=data_source_id, + column_statistics_request=column_statistics_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ColumnStatisticsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _column_statistics_serialize( + self, + data_source_id, + column_statistics_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if column_statistics_request is not None: + _body_params = column_statistics_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.column_statistics_endpoint = _Endpoint( - settings={ - 'response_type': (ColumnStatisticsResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/computeColumnStatistics', - 'operation_id': 'column_statistics', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'column_statistics_request', - ], - 'required': [ - 'data_source_id', - 'column_statistics_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'column_statistics_request': - (ColumnStatisticsRequest,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'column_statistics_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/computeColumnStatistics', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def compute_label_elements_post( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + elements_request: ElementsRequest, + offset: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=0)]], Field(description="Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + limit: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]], Field(description="Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ElementsResponse: + """Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. + + Returns paged list of elements (values) of given label satisfying given filtering criteria. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param elements_request: (required) + :type elements_request: ElementsRequest + :param offset: Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type offset: int + :param limit: Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type limit: int + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_label_elements_post_serialize( + workspace_id=workspace_id, + elements_request=elements_request, + offset=offset, + limit=limit, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ElementsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def compute_label_elements_post_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + elements_request: ElementsRequest, + offset: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=0)]], Field(description="Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + limit: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]], Field(description="Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ElementsResponse]: + """Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. + + Returns paged list of elements (values) of given label satisfying given filtering criteria. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param elements_request: (required) + :type elements_request: ElementsRequest + :param offset: Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type offset: int + :param limit: Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type limit: int + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_label_elements_post_serialize( + workspace_id=workspace_id, + elements_request=elements_request, + offset=offset, + limit=limit, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ElementsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def compute_label_elements_post_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + elements_request: ElementsRequest, + offset: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=0)]], Field(description="Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + limit: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]], Field(description="Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. + + Returns paged list of elements (values) of given label satisfying given filtering criteria. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param elements_request: (required) + :type elements_request: ElementsRequest + :param offset: Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type offset: int + :param limit: Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type limit: int + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_label_elements_post_serialize( + workspace_id=workspace_id, + elements_request=elements_request, + offset=offset, + limit=limit, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ElementsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _compute_label_elements_post_serialize( + self, + workspace_id, + elements_request, + offset, + limit, + skip_cache, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + # process the form parameters + # process the body parameter + if elements_request is not None: + _body_params = elements_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.compute_label_elements_post_endpoint = _Endpoint( - settings={ - 'response_type': (ElementsResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements', - 'operation_id': 'compute_label_elements_post', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'elements_request', - 'offset', - 'limit', - 'skip_cache', - ], - 'required': [ - 'workspace_id', - 'elements_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - 'offset', - 'limit', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('offset',): { - - 'inclusive_maximum': 10000, - 'inclusive_minimum': 0, - }, - ('limit',): { - - 'inclusive_maximum': 10000, - 'inclusive_minimum': 1, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'elements_request': - (ElementsRequest,), - 'offset': - (int,), - 'limit': - (int,), - 'skip_cache': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'offset': 'offset', - 'limit': 'limit', - 'skip_cache': 'skip-cache', - }, - 'location_map': { - 'workspace_id': 'path', - 'elements_request': 'body', - 'offset': 'query', - 'limit': 'query', - 'skip_cache': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def compute_report( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + timestamp: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AfmExecutionResponse: + """Executes analytical request and returns link to the result + + AFM is a combination of attributes, measures and filters that describe a query you want to execute. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param timestamp: + :type timestamp: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_report_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + skip_cache=skip_cache, + timestamp=timestamp, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmExecutionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def compute_report_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + timestamp: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AfmExecutionResponse]: + """Executes analytical request and returns link to the result + + AFM is a combination of attributes, measures and filters that describe a query you want to execute. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param timestamp: + :type timestamp: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_report_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + skip_cache=skip_cache, + timestamp=timestamp, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmExecutionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def compute_report_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + timestamp: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Executes analytical request and returns link to the result + + AFM is a combination of attributes, measures and filters that describe a query you want to execute. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param timestamp: + :type timestamp: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_report_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + skip_cache=skip_cache, + timestamp=timestamp, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmExecutionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _compute_report_serialize( + self, + workspace_id, + afm_execution, + skip_cache, + timestamp, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + if timestamp is not None: + _header_params['timestamp'] = timestamp + # process the form parameters + # process the body parameter + if afm_execution is not None: + _body_params = afm_execution + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.compute_report_endpoint = _Endpoint( - settings={ - 'response_type': (AfmExecutionResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute', - 'operation_id': 'compute_report', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'afm_execution', - 'skip_cache', - 'timestamp', - ], - 'required': [ - 'workspace_id', - 'afm_execution', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'afm_execution': - (AfmExecution,), - 'skip_cache': - (bool,), - 'timestamp': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'skip_cache': 'skip-cache', - 'timestamp': 'timestamp', - }, - 'location_map': { - 'workspace_id': 'path', - 'afm_execution': 'body', - 'skip_cache': 'header', - 'timestamp': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def compute_valid_descendants( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_descendants_query: AfmValidDescendantsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AfmValidDescendantsResponse: + """(BETA) Valid descendants + + (BETA) Returns map of lists of attributes that can be used as descendants of the given attributes. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_descendants_query: (required) + :type afm_valid_descendants_query: AfmValidDescendantsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_descendants_serialize( + workspace_id=workspace_id, + afm_valid_descendants_query=afm_valid_descendants_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidDescendantsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def compute_valid_descendants_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_descendants_query: AfmValidDescendantsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AfmValidDescendantsResponse]: + """(BETA) Valid descendants + + (BETA) Returns map of lists of attributes that can be used as descendants of the given attributes. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_descendants_query: (required) + :type afm_valid_descendants_query: AfmValidDescendantsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_descendants_serialize( + workspace_id=workspace_id, + afm_valid_descendants_query=afm_valid_descendants_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidDescendantsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def compute_valid_descendants_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_descendants_query: AfmValidDescendantsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Valid descendants + + (BETA) Returns map of lists of attributes that can be used as descendants of the given attributes. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_descendants_query: (required) + :type afm_valid_descendants_query: AfmValidDescendantsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_descendants_serialize( + workspace_id=workspace_id, + afm_valid_descendants_query=afm_valid_descendants_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidDescendantsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _compute_valid_descendants_serialize( + self, + workspace_id, + afm_valid_descendants_query, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if afm_valid_descendants_query is not None: + _body_params = afm_valid_descendants_query + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.compute_valid_descendants_endpoint = _Endpoint( - settings={ - 'response_type': (AfmValidDescendantsResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants', - 'operation_id': 'compute_valid_descendants', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'afm_valid_descendants_query', - ], - 'required': [ - 'workspace_id', - 'afm_valid_descendants_query', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'afm_valid_descendants_query': - (AfmValidDescendantsQuery,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'afm_valid_descendants_query': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def compute_valid_objects( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_objects_query: AfmValidObjectsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AfmValidObjectsResponse: + """Valid objects + + Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_objects_query: (required) + :type afm_valid_objects_query: AfmValidObjectsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_objects_serialize( + workspace_id=workspace_id, + afm_valid_objects_query=afm_valid_objects_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidObjectsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def compute_valid_objects_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_objects_query: AfmValidObjectsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AfmValidObjectsResponse]: + """Valid objects + + Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_objects_query: (required) + :type afm_valid_objects_query: AfmValidObjectsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_objects_serialize( + workspace_id=workspace_id, + afm_valid_objects_query=afm_valid_objects_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidObjectsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def compute_valid_objects_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_objects_query: AfmValidObjectsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Valid objects + + Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_objects_query: (required) + :type afm_valid_objects_query: AfmValidObjectsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_objects_serialize( + workspace_id=workspace_id, + afm_valid_objects_query=afm_valid_objects_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidObjectsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _compute_valid_objects_serialize( + self, + workspace_id, + afm_valid_objects_query, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if afm_valid_objects_query is not None: + _body_params = afm_valid_objects_query + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.compute_valid_objects_endpoint = _Endpoint( - settings={ - 'response_type': (AfmValidObjectsResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects', - 'operation_id': 'compute_valid_objects', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'afm_valid_objects_query', - ], - 'required': [ - 'workspace_id', - 'afm_valid_objects_query', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'afm_valid_objects_query': - (AfmValidObjectsQuery,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'afm_valid_objects_query': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_dashboard_export_request( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + dashboard_tabular_export_request: DashboardTabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """(EXPERIMENTAL) Create dashboard tabular export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param dashboard_tabular_export_request: (required) + :type dashboard_tabular_export_request: DashboardTabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_dashboard_export_request_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + dashboard_tabular_export_request=dashboard_tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_dashboard_export_request_with_http_info( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + dashboard_tabular_export_request: DashboardTabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """(EXPERIMENTAL) Create dashboard tabular export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param dashboard_tabular_export_request: (required) + :type dashboard_tabular_export_request: DashboardTabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_dashboard_export_request_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + dashboard_tabular_export_request=dashboard_tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_dashboard_export_request_without_preload_content( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + dashboard_tabular_export_request: DashboardTabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Create dashboard tabular export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param dashboard_tabular_export_request: (required) + :type dashboard_tabular_export_request: DashboardTabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_dashboard_export_request_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + dashboard_tabular_export_request=dashboard_tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_dashboard_export_request_serialize( + self, + workspace_id, + dashboard_id, + dashboard_tabular_export_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if dashboard_id is not None: + _path_params['dashboardId'] = dashboard_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if dashboard_tabular_export_request is not None: + _body_params = dashboard_tabular_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.create_dashboard_export_request_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular', - 'operation_id': 'create_dashboard_export_request', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'dashboard_id', - 'dashboard_tabular_export_request', - ], - 'required': [ - 'workspace_id', - 'dashboard_id', - 'dashboard_tabular_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'dashboard_id': - (str,), - 'dashboard_tabular_export_request': - (DashboardTabularExportRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'dashboard_id': 'dashboardId', - }, - 'location_map': { - 'workspace_id': 'path', - 'dashboard_id': 'path', - 'dashboard_tabular_export_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_image_export( + self, + workspace_id: StrictStr, + image_export_request: ImageExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """(EXPERIMENTAL) Create image export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param image_export_request: (required) + :type image_export_request: ImageExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_image_export_serialize( + workspace_id=workspace_id, + image_export_request=image_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_image_export_with_http_info( + self, + workspace_id: StrictStr, + image_export_request: ImageExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """(EXPERIMENTAL) Create image export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param image_export_request: (required) + :type image_export_request: ImageExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_image_export_serialize( + workspace_id=workspace_id, + image_export_request=image_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_image_export_without_preload_content( + self, + workspace_id: StrictStr, + image_export_request: ImageExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Create image export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param image_export_request: (required) + :type image_export_request: ImageExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_image_export_serialize( + workspace_id=workspace_id, + image_export_request=image_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_image_export_serialize( + self, + workspace_id, + image_export_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if image_export_request is not None: + _body_params = image_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.create_image_export_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image', - 'operation_id': 'create_image_export', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'image_export_request', - ], - 'required': [ - 'workspace_id', - 'image_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'image_export_request': - (ImageExportRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'image_export_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/image', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_memory_item( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> MemoryItem: + """(EXPERIMENTAL) Create new memory item + + (EXPERIMENTAL) Creates a new memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_memory_item_serialize( + workspace_id=workspace_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_memory_item_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[MemoryItem]: + """(EXPERIMENTAL) Create new memory item + + (EXPERIMENTAL) Creates a new memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_memory_item_serialize( + workspace_id=workspace_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_memory_item_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Create new memory item + + (EXPERIMENTAL) Creates a new memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_memory_item_serialize( + workspace_id=workspace_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_memory_item_serialize( + self, + workspace_id, + memory_item, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if memory_item is not None: + _body_params = memory_item + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.create_memory_item_endpoint = _Endpoint( - settings={ - 'response_type': (MemoryItem,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/memory', - 'operation_id': 'create_memory_item', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'memory_item', - ], - 'required': [ - 'workspace_id', - 'memory_item', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'memory_item': - (MemoryItem,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'memory_item': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/memory', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_pdf_export( + self, + workspace_id: StrictStr, + visual_export_request: VisualExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """Create visual - pdf export request + + An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param visual_export_request: (required) + :type visual_export_request: VisualExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_pdf_export_serialize( + workspace_id=workspace_id, + visual_export_request=visual_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_pdf_export_with_http_info( + self, + workspace_id: StrictStr, + visual_export_request: VisualExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """Create visual - pdf export request + + An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param visual_export_request: (required) + :type visual_export_request: VisualExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_pdf_export_serialize( + workspace_id=workspace_id, + visual_export_request=visual_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_pdf_export_without_preload_content( + self, + workspace_id: StrictStr, + visual_export_request: VisualExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create visual - pdf export request + + An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param visual_export_request: (required) + :type visual_export_request: VisualExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_pdf_export_serialize( + workspace_id=workspace_id, + visual_export_request=visual_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_pdf_export_serialize( + self, + workspace_id, + visual_export_request, + x_gdc_debug, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + if x_gdc_debug is not None: + _header_params['X-Gdc-Debug'] = x_gdc_debug + # process the form parameters + # process the body parameter + if visual_export_request is not None: + _body_params = visual_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.create_pdf_export_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual', - 'operation_id': 'create_pdf_export', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'visual_export_request', - 'x_gdc_debug', - ], - 'required': [ - 'workspace_id', - 'visual_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'visual_export_request': - (VisualExportRequest,), - 'x_gdc_debug': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'x_gdc_debug': 'X-Gdc-Debug', - }, - 'location_map': { - 'workspace_id': 'path', - 'visual_export_request': 'body', - 'x_gdc_debug': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/visual', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_raw_export( + self, + workspace_id: StrictStr, + raw_export_request: RawExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """(EXPERIMENTAL) Create raw export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param raw_export_request: (required) + :type raw_export_request: RawExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_raw_export_serialize( + workspace_id=workspace_id, + raw_export_request=raw_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_raw_export_with_http_info( + self, + workspace_id: StrictStr, + raw_export_request: RawExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """(EXPERIMENTAL) Create raw export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param raw_export_request: (required) + :type raw_export_request: RawExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_raw_export_serialize( + workspace_id=workspace_id, + raw_export_request=raw_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_raw_export_without_preload_content( + self, + workspace_id: StrictStr, + raw_export_request: RawExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Create raw export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param raw_export_request: (required) + :type raw_export_request: RawExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_raw_export_serialize( + workspace_id=workspace_id, + raw_export_request=raw_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_raw_export_serialize( + self, + workspace_id, + raw_export_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if raw_export_request is not None: + _body_params = raw_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [ + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/raw', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_slides_export( + self, + workspace_id: StrictStr, + slides_export_request: SlidesExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """(EXPERIMENTAL) Create slides export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param slides_export_request: (required) + :type slides_export_request: SlidesExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_slides_export_serialize( + workspace_id=workspace_id, + slides_export_request=slides_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_slides_export_with_http_info( + self, + workspace_id: StrictStr, + slides_export_request: SlidesExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """(EXPERIMENTAL) Create slides export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param slides_export_request: (required) + :type slides_export_request: SlidesExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_slides_export_serialize( + workspace_id=workspace_id, + slides_export_request=slides_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_slides_export_without_preload_content( + self, + workspace_id: StrictStr, + slides_export_request: SlidesExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Create slides export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param slides_export_request: (required) + :type slides_export_request: SlidesExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_slides_export_serialize( + workspace_id=workspace_id, + slides_export_request=slides_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_slides_export_serialize( + self, + workspace_id, + slides_export_request, + x_gdc_debug, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + if x_gdc_debug is not None: + _header_params['X-Gdc-Debug'] = x_gdc_debug + # process the form parameters + # process the body parameter + if slides_export_request is not None: + _body_params = slides_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.create_raw_export_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/raw', - 'operation_id': 'create_raw_export', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'raw_export_request', - ], - 'required': [ - 'workspace_id', - 'raw_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'raw_export_request': - (RawExportRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'raw_export_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.create_slides_export_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides', - 'operation_id': 'create_slides_export', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'slides_export_request', - 'x_gdc_debug', - ], - 'required': [ - 'workspace_id', - 'slides_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'slides_export_request': - (SlidesExportRequest,), - 'x_gdc_debug': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'x_gdc_debug': 'X-Gdc-Debug', - }, - 'location_map': { - 'workspace_id': 'path', - 'slides_export_request': 'body', - 'x_gdc_debug': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.create_tabular_export_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/tabular', - 'operation_id': 'create_tabular_export', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'tabular_export_request', - ], - 'required': [ - 'workspace_id', - 'tabular_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'tabular_export_request': - (TabularExportRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'tabular_export_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.dashboard_permissions_endpoint = _Endpoint( - settings={ - 'response_type': (DashboardPermissions,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions', - 'operation_id': 'dashboard_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'dashboard_id', - ], - 'required': [ - 'workspace_id', - 'dashboard_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'dashboard_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'dashboard_id': 'dashboardId', - }, - 'location_map': { - 'workspace_id': 'path', - 'dashboard_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_organization_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/delete', - 'operation_id': 'delete_organization_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'organization_automation_management_bulk_request', - ], - 'required': [ - 'organization_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'organization_automation_management_bulk_request': - (OrganizationAutomationManagementBulkRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'organization_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/slides', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_tabular_export( + self, + workspace_id: StrictStr, + tabular_export_request: TabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """Create tabular export request + + An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param tabular_export_request: (required) + :type tabular_export_request: TabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tabular_export_serialize( + workspace_id=workspace_id, + tabular_export_request=tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_tabular_export_with_http_info( + self, + workspace_id: StrictStr, + tabular_export_request: TabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """Create tabular export request + + An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param tabular_export_request: (required) + :type tabular_export_request: TabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tabular_export_serialize( + workspace_id=workspace_id, + tabular_export_request=tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_tabular_export_without_preload_content( + self, + workspace_id: StrictStr, + tabular_export_request: TabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create tabular export request + + An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param tabular_export_request: (required) + :type tabular_export_request: TabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tabular_export_serialize( + workspace_id=workspace_id, + tabular_export_request=tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_tabular_export_serialize( + self, + workspace_id, + tabular_export_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if tabular_export_request is not None: + _body_params = tabular_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.delete_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/delete', - 'operation_id': 'delete_workspace_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'required': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'workspace_automation_management_bulk_request': - (WorkspaceAutomationManagementBulkRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'workspace_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/tabular', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def dashboard_permissions( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DashboardPermissions: + """Get Dashboard Permissions + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DashboardPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def dashboard_permissions_with_http_info( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DashboardPermissions]: + """Get Dashboard Permissions + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DashboardPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def dashboard_permissions_without_preload_content( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Dashboard Permissions + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DashboardPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _dashboard_permissions_serialize( + self, + workspace_id, + dashboard_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if dashboard_id is not None: + _path_params['dashboardId'] = dashboard_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.explain_afm_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain', - 'operation_id': 'explain_afm', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'afm_execution', - 'explain_type', - ], - 'required': [ - 'workspace_id', - 'afm_execution', - ], - 'nullable': [ - ], - 'enum': [ - 'explain_type', - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('explain_type',): { - - "MAQL": "MAQL", - "GRPC_MODEL": "GRPC_MODEL", - "GRPC_MODEL_SVG": "GRPC_MODEL_SVG", - "WDF": "WDF", - "QT": "QT", - "QT_SVG": "QT_SVG", - "OPT_QT": "OPT_QT", - "OPT_QT_SVG": "OPT_QT_SVG", - "SQL": "SQL", - "SETTINGS": "SETTINGS", - "COMPRESSED_SQL": "COMPRESSED_SQL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'afm_execution': - (AfmExecution,), - 'explain_type': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'explain_type': 'explainType', - }, - 'location_map': { - 'workspace_id': 'path', - 'afm_execution': 'body', - 'explain_type': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/sql', - 'application/zip', + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_organization_automations( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_organization_automations_with_http_info( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_organization_automations_without_preload_content( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_organization_automations_serialize( + self, + organization_automation_management_bulk_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if organization_automation_management_bulk_request is not None: + _body_params = organization_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/automations/delete', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_workspace_automations( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_workspace_automations_with_http_info( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_workspace_automations_without_preload_content( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_workspace_automations_serialize( + self, + workspace_id, + workspace_automation_management_bulk_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if workspace_automation_management_bulk_request is not None: + _body_params = workspace_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/delete', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def explain_afm( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + explain_type: Annotated[Optional[StrictStr], Field(description="Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """AFM explain resource. + + The resource provides static structures needed for investigation of a problem with given AFM. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param explain_type: Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request + :type explain_type: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._explain_afm_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + explain_type=explain_type, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def explain_afm_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + explain_type: Annotated[Optional[StrictStr], Field(description="Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """AFM explain resource. + + The resource provides static structures needed for investigation of a problem with given AFM. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param explain_type: Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request + :type explain_type: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._explain_afm_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + explain_type=explain_type, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def explain_afm_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + explain_type: Annotated[Optional[StrictStr], Field(description="Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """AFM explain resource. + + The resource provides static structures needed for investigation of a problem with given AFM. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param explain_type: Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request + :type explain_type: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._explain_afm_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + explain_type=explain_type, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _explain_afm_serialize( + self, + workspace_id, + afm_execution, + explain_type, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if explain_type is not None: + + _query_params.append(('explainType', explain_type)) + + # process the header parameters + # process the form parameters + # process the body parameter + if afm_execution is not None: + _body_params = afm_execution + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'application/sql', + 'application/zip', 'image/svg+xml' - ], - 'content_type': [ - 'application/json' ] - }, - api_client=api_client - ) - self.forecast_endpoint = _Endpoint( - settings={ - 'response_type': (SmartFunctionResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}', - 'operation_id': 'forecast', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'forecast_request', - 'skip_cache', - ], - 'required': [ - 'workspace_id', - 'result_id', - 'forecast_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'forecast_request': - (ForecastRequest,), - 'skip_cache': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'skip_cache': 'skip-cache', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'forecast_request': 'body', - 'skip_cache': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def forecast( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + forecast_request: ForecastRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SmartFunctionResponse: + """(BETA) Smart functions - Forecast + + (BETA) Computes forecasted data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param forecast_request: (required) + :type forecast_request: ForecastRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_serialize( + workspace_id=workspace_id, + result_id=result_id, + forecast_request=forecast_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def forecast_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + forecast_request: ForecastRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SmartFunctionResponse]: + """(BETA) Smart functions - Forecast + + (BETA) Computes forecasted data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param forecast_request: (required) + :type forecast_request: ForecastRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_serialize( + workspace_id=workspace_id, + result_id=result_id, + forecast_request=forecast_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def forecast_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + forecast_request: ForecastRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Smart functions - Forecast + + (BETA) Computes forecasted data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param forecast_request: (required) + :type forecast_request: ForecastRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_serialize( + workspace_id=workspace_id, + result_id=result_id, + forecast_request=forecast_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _forecast_serialize( + self, + workspace_id, + result_id, + forecast_request, + skip_cache, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + # process the form parameters + # process the body parameter + if forecast_request is not None: + _body_params = forecast_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.forecast_result_endpoint = _Endpoint( - settings={ - 'response_type': (ForecastResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}', - 'operation_id': 'forecast_result', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'offset', - 'limit', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'offset': - (int,), - 'limit': - (int,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'offset': 'offset', - 'limit': 'limit', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'offset': 'query', - 'limit': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def forecast_result( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ForecastResult: + """(BETA) Smart functions - Forecast Result + + (BETA) Gets forecast result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ForecastResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def forecast_result_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ForecastResult]: + """(BETA) Smart functions - Forecast Result + + (BETA) Gets forecast result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ForecastResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def forecast_result_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Smart functions - Forecast Result + + (BETA) Gets forecast result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ForecastResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _forecast_result_serialize( + self, + workspace_id, + result_id, + offset, + limit, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.generate_logical_model_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeModel,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel', - 'operation_id': 'generate_logical_model', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'generate_ldm_request', - ], - 'required': [ - 'data_source_id', - 'generate_ldm_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'generate_ldm_request': - (GenerateLdmRequest,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'generate_ldm_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def generate_logical_model( + self, + data_source_id: StrictStr, + generate_ldm_request: GenerateLdmRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeModel: + """Generate logical data model (LDM) from physical data model (PDM) + + Generate logical data model (LDM) from physical data model (PDM) stored in data source. + + :param data_source_id: (required) + :type data_source_id: str + :param generate_ldm_request: (required) + :type generate_ldm_request: GenerateLdmRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_logical_model_serialize( + data_source_id=data_source_id, + generate_ldm_request=generate_ldm_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def generate_logical_model_with_http_info( + self, + data_source_id: StrictStr, + generate_ldm_request: GenerateLdmRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeModel]: + """Generate logical data model (LDM) from physical data model (PDM) + + Generate logical data model (LDM) from physical data model (PDM) stored in data source. + + :param data_source_id: (required) + :type data_source_id: str + :param generate_ldm_request: (required) + :type generate_ldm_request: GenerateLdmRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_logical_model_serialize( + data_source_id=data_source_id, + generate_ldm_request=generate_ldm_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def generate_logical_model_without_preload_content( + self, + data_source_id: StrictStr, + generate_ldm_request: GenerateLdmRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Generate logical data model (LDM) from physical data model (PDM) + + Generate logical data model (LDM) from physical data model (PDM) stored in data source. + + :param data_source_id: (required) + :type data_source_id: str + :param generate_ldm_request: (required) + :type generate_ldm_request: GenerateLdmRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_logical_model_serialize( + data_source_id=data_source_id, + generate_ldm_request=generate_ldm_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _generate_logical_model_serialize( + self, + data_source_id, + generate_ldm_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if generate_ldm_request is not None: + _body_params = generate_ldm_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.get_data_source_schemata_endpoint = _Endpoint( - settings={ - 'response_type': (DataSourceSchemata,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/scanSchemata', - 'operation_id': 'get_data_source_schemata', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - ], - 'required': [ - 'data_source_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'data_source_id', - ] - }, - root_map={ - 'validations': { - ('data_source_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_data_source_schemata( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataSourceSchemata: + """Get a list of schema names of a database + + It scans a database and reads metadata. The result of the request contains a list of schema names of a database. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_schemata_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataSourceSchemata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_source_schemata_with_http_info( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataSourceSchemata]: + """Get a list of schema names of a database + + It scans a database and reads metadata. The result of the request contains a list of schema names of a database. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_schemata_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataSourceSchemata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_data_source_schemata_without_preload_content( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a list of schema names of a database + + It scans a database and reads metadata. The result of the request contains a list of schema names of a database. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_schemata_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataSourceSchemata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_data_source_schemata_serialize( + self, + data_source_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_dependent_entities_graph_endpoint = _Endpoint( - settings={ - 'response_type': (DependentEntitiesResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph', - 'operation_id': 'get_dependent_entities_graph', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/scanSchemata', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_dependent_entities_graph( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DependentEntitiesResponse: + """Computes the dependent entities graph + + Computes the dependent entities graph + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_dependent_entities_graph_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DependentEntitiesResponse]: + """Computes the dependent entities graph + + Computes the dependent entities graph + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_dependent_entities_graph_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Computes the dependent entities graph + + Computes the dependent entities graph + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_dependent_entities_graph_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_dependent_entities_graph_from_entry_points_endpoint = _Endpoint( - settings={ - 'response_type': (DependentEntitiesResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph', - 'operation_id': 'get_dependent_entities_graph_from_entry_points', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'dependent_entities_request', - ], - 'required': [ - 'workspace_id', - 'dependent_entities_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'dependent_entities_request': - (DependentEntitiesRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'dependent_entities_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_dependent_entities_graph_from_entry_points( + self, + workspace_id: StrictStr, + dependent_entities_request: DependentEntitiesRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DependentEntitiesResponse: + """Computes the dependent entities graph from given entry points + + Computes the dependent entities graph from given entry points + + :param workspace_id: (required) + :type workspace_id: str + :param dependent_entities_request: (required) + :type dependent_entities_request: DependentEntitiesRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_from_entry_points_serialize( + workspace_id=workspace_id, + dependent_entities_request=dependent_entities_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_dependent_entities_graph_from_entry_points_with_http_info( + self, + workspace_id: StrictStr, + dependent_entities_request: DependentEntitiesRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DependentEntitiesResponse]: + """Computes the dependent entities graph from given entry points + + Computes the dependent entities graph from given entry points + + :param workspace_id: (required) + :type workspace_id: str + :param dependent_entities_request: (required) + :type dependent_entities_request: DependentEntitiesRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_from_entry_points_serialize( + workspace_id=workspace_id, + dependent_entities_request=dependent_entities_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_dependent_entities_graph_from_entry_points_without_preload_content( + self, + workspace_id: StrictStr, + dependent_entities_request: DependentEntitiesRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Computes the dependent entities graph from given entry points + + Computes the dependent entities graph from given entry points + + :param workspace_id: (required) + :type workspace_id: str + :param dependent_entities_request: (required) + :type dependent_entities_request: DependentEntitiesRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_from_entry_points_serialize( + workspace_id=workspace_id, + dependent_entities_request=dependent_entities_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_dependent_entities_graph_from_entry_points_serialize( + self, + workspace_id, + dependent_entities_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if dependent_entities_request is not None: + _body_params = dependent_entities_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.get_exported_file_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}', - 'operation_id': 'get_exported_file', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_exported_file( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """Retrieve exported files + + Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_exported_file_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_exported_file_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """Retrieve exported files + + Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_exported_file_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_exported_file_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve exported files + + Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_exported_file_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_exported_file_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/pdf' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_image_export_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}', - 'operation_id': 'get_image_export', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_image_export( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_image_export_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_image_export_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_image_export_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'image/png' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_image_export_metadata_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata', - 'operation_id': 'get_image_export_metadata', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_image_export_metadata( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_image_export_metadata_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_image_export_metadata_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_image_export_metadata_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_memory_item_endpoint = _Endpoint( - settings={ - 'response_type': (MemoryItem,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', - 'operation_id': 'get_memory_item', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'memory_id', - ], - 'required': [ - 'workspace_id', - 'memory_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'memory_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'memory_id': 'memoryId', - }, - 'location_map': { - 'workspace_id': 'path', - 'memory_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_memory_item( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> MemoryItem: + """(EXPERIMENTAL) Get memory item + + (EXPERIMENTAL) Get memory item by id + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_memory_item_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[MemoryItem]: + """(EXPERIMENTAL) Get memory item + + (EXPERIMENTAL) Get memory item by id + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_memory_item_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Get memory item + + (EXPERIMENTAL) Get memory item by id + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_memory_item_serialize( + self, + workspace_id, + memory_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if memory_id is not None: + _path_params['memoryId'] = memory_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_metadata_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata', - 'operation_id': 'get_metadata', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_metadata( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Retrieve metadata context + + This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_metadata_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Retrieve metadata context + + This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_metadata_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve metadata context + + This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_metadata_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_notifications_endpoint = _Endpoint( - settings={ - 'response_type': (Notifications,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/notifications', - 'operation_id': 'get_notifications', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'is_read', - 'page', - 'size', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'page', - 'size', - 'meta_include', ] - }, - root_map={ - 'validations': { - ('page',): { - - }, - ('size',): { - - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "TOTAL": "total", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'is_read': - (bool,), - 'page': - (str,), - 'size': - (str,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'is_read': 'isRead', - 'page': 'page', - 'size': 'size', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'query', - 'is_read': 'query', - 'page': 'query', - 'size': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'multi', - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_notifications( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID to filter notifications by.")] = None, + is_read: Annotated[Optional[StrictBool], Field(description="Filter notifications by read status.")] = None, + page: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The size of the page to be returned.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Additional meta information to include in the response.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> Notifications: + """Get latest notifications. + + Get latest in-platform notifications for the current user. + + :param workspace_id: Workspace ID to filter notifications by. + :type workspace_id: str + :param is_read: Filter notifications by read status. + :type is_read: bool + :param page: Zero-based page index (0..N) + :type page: str + :param size: The size of the page to be returned. + :type size: str + :param meta_include: Additional meta information to include in the response. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notifications_serialize( + workspace_id=workspace_id, + is_read=is_read, + page=page, + size=size, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notifications", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_notifications_with_http_info( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID to filter notifications by.")] = None, + is_read: Annotated[Optional[StrictBool], Field(description="Filter notifications by read status.")] = None, + page: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The size of the page to be returned.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Additional meta information to include in the response.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[Notifications]: + """Get latest notifications. + + Get latest in-platform notifications for the current user. + + :param workspace_id: Workspace ID to filter notifications by. + :type workspace_id: str + :param is_read: Filter notifications by read status. + :type is_read: bool + :param page: Zero-based page index (0..N) + :type page: str + :param size: The size of the page to be returned. + :type size: str + :param meta_include: Additional meta information to include in the response. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notifications_serialize( + workspace_id=workspace_id, + is_read=is_read, + page=page, + size=size, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notifications", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_notifications_without_preload_content( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID to filter notifications by.")] = None, + is_read: Annotated[Optional[StrictBool], Field(description="Filter notifications by read status.")] = None, + page: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The size of the page to be returned.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Additional meta information to include in the response.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get latest notifications. + + Get latest in-platform notifications for the current user. + + :param workspace_id: Workspace ID to filter notifications by. + :type workspace_id: str + :param is_read: Filter notifications by read status. + :type is_read: bool + :param page: Zero-based page index (0..N) + :type page: str + :param size: The size of the page to be returned. + :type size: str + :param meta_include: Additional meta information to include in the response. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notifications_serialize( + workspace_id=workspace_id, + is_read=is_read, + page=page, + size=size, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notifications", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_notifications_serialize( + self, + workspace_id, + is_read, + page, + size, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if workspace_id is not None: + + _query_params.append(('workspaceId', workspace_id)) + + if is_read is not None: + + _query_params.append(('isRead', is_read)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_quality_issues_endpoint = _Endpoint( - settings={ - 'response_type': (GetQualityIssuesResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/issues', - 'operation_id': 'get_quality_issues', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/notifications', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_quality_issues( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GetQualityIssuesResponse: + """Get Quality Issues + + Returns metadata quality issues detected by the platform linter. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_quality_issues_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetQualityIssuesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_quality_issues_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GetQualityIssuesResponse]: + """Get Quality Issues + + Returns metadata quality issues detected by the platform linter. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_quality_issues_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetQualityIssuesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_quality_issues_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Quality Issues + + Returns metadata quality issues detected by the platform linter. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_quality_issues_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetQualityIssuesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_quality_issues_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_raw_export_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}', - 'operation_id': 'get_raw_export', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.apache.arrow.file', - 'application/vnd.apache.arrow.stream', + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/issues', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_raw_export( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_raw_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_raw_export_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_raw_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_raw_export_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_raw_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_raw_export_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.apache.arrow.file', + 'application/vnd.apache.arrow.stream', 'text/csv' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_slides_export_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}', - 'operation_id': 'get_slides_export', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/pdf', - 'application/vnd.openxmlformats-officedocument.presentationml.presentation' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_slides_export_metadata_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata', - 'operation_id': 'get_slides_export_metadata', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_tabular_export_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}', - 'operation_id': 'get_tabular_export', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/pdf', - 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', - 'text/csv', - 'text/html' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_translation_tags_endpoint = _Endpoint( - settings={ - 'response_type': ([str],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations', - 'operation_id': 'get_translation_tags', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.inherited_entity_conflicts_endpoint = _Endpoint( - settings={ - 'response_type': ([IdentifierDuplications],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts', - 'operation_id': 'inherited_entity_conflicts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.inherited_entity_prefixes_endpoint = _Endpoint( - settings={ - 'response_type': ([str],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes', - 'operation_id': 'inherited_entity_prefixes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.key_driver_analysis_endpoint = _Endpoint( - settings={ - 'response_type': (KeyDriversResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers', - 'operation_id': 'key_driver_analysis', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'key_drivers_request', - 'skip_cache', - ], - 'required': [ - 'workspace_id', - 'key_drivers_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'key_drivers_request': - (KeyDriversRequest,), - 'skip_cache': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'skip_cache': 'skip-cache', - }, - 'location_map': { - 'workspace_id': 'path', - 'key_drivers_request': 'body', - 'skip_cache': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.key_driver_analysis_result_endpoint = _Endpoint( - settings={ - 'response_type': (KeyDriversResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}', - 'operation_id': 'key_driver_analysis_result', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'offset', - 'limit', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'offset': - (int,), - 'limit': - (int,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'offset': 'offset', - 'limit': 'limit', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'offset': 'query', - 'limit': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.list_memory_items_endpoint = _Endpoint( - settings={ - 'response_type': ([MemoryItem],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/memory', - 'operation_id': 'list_memory_items', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.list_workspace_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (WorkspaceUserGroups,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/userGroups', - 'operation_id': 'list_workspace_user_groups', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'page', - 'size', - 'name', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'page': - (int,), - 'size': - (int,), - 'name': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'page': 'page', - 'size': 'size', - 'name': 'name', - }, - 'location_map': { - 'workspace_id': 'path', - 'page': 'query', - 'size': 'query', - 'name': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.list_workspace_users_endpoint = _Endpoint( - settings={ - 'response_type': (WorkspaceUsers,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/users', - 'operation_id': 'list_workspace_users', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'page', - 'size', - 'name', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'page': - (int,), - 'size': - (int,), - 'name': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'page': 'page', - 'size': 'size', - 'name': 'name', - }, - 'location_map': { - 'workspace_id': 'path', - 'page': 'query', - 'size': 'query', - 'name': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.manage_dashboard_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions', - 'operation_id': 'manage_dashboard_permissions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'dashboard_id', - 'manage_dashboard_permissions_request_inner', - ], - 'required': [ - 'workspace_id', - 'dashboard_id', - 'manage_dashboard_permissions_request_inner', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'dashboard_id': - (str,), - 'manage_dashboard_permissions_request_inner': - ([ManageDashboardPermissionsRequestInner],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'dashboard_id': 'dashboardId', - }, - 'location_map': { - 'workspace_id': 'path', - 'dashboard_id': 'path', - 'manage_dashboard_permissions_request_inner': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.manage_data_source_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/managePermissions', - 'operation_id': 'manage_data_source_permissions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'data_source_permission_assignment', - ], - 'required': [ - 'data_source_id', - 'data_source_permission_assignment', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'data_source_permission_assignment': - ([DataSourcePermissionAssignment],), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'data_source_permission_assignment': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.manage_organization_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/managePermissions', - 'operation_id': 'manage_organization_permissions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'organization_permission_assignment', - ], - 'required': [ - 'organization_permission_assignment', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'organization_permission_assignment': - ([OrganizationPermissionAssignment],), - }, - 'attribute_map': { - }, - 'location_map': { - 'organization_permission_assignment': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.manage_workspace_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/managePermissions', - 'operation_id': 'manage_workspace_permissions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'workspace_permission_assignment', - ], - 'required': [ - 'workspace_id', - 'workspace_permission_assignment', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'workspace_permission_assignment': - ([WorkspacePermissionAssignment],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'workspace_permission_assignment': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.mark_as_read_notification_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/notifications/{notificationId}/markAsRead', - 'operation_id': 'mark_as_read_notification', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'notification_id', - ], - 'required': [ - 'notification_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'notification_id': - (str,), - }, - 'attribute_map': { - 'notification_id': 'notificationId', - }, - 'location_map': { - 'notification_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.mark_as_read_notification_all_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/notifications/markAsRead', - 'operation_id': 'mark_as_read_notification_all', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.metadata_sync_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/metadataSync', - 'operation_id': 'metadata_sync', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.metadata_sync_organization_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/metadataSync', - 'operation_id': 'metadata_sync_organization', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.overridden_child_entities_endpoint = _Endpoint( - settings={ - 'response_type': ([IdentifierDuplications],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities', - 'operation_id': 'overridden_child_entities', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.particular_platform_usage_endpoint = _Endpoint( - settings={ - 'response_type': ([PlatformUsage],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/collectUsage', - 'operation_id': 'particular_platform_usage', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'platform_usage_request', - ], - 'required': [ - 'platform_usage_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'platform_usage_request': - (PlatformUsageRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'platform_usage_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.pause_organization_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/pause', - 'operation_id': 'pause_organization_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'organization_automation_management_bulk_request', - ], - 'required': [ - 'organization_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'organization_automation_management_bulk_request': - (OrganizationAutomationManagementBulkRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'organization_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.pause_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/pause', - 'operation_id': 'pause_workspace_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'required': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'workspace_automation_management_bulk_request': - (WorkspaceAutomationManagementBulkRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'workspace_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.register_upload_notification_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/uploadNotification', - 'operation_id': 'register_upload_notification', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - ], - 'required': [ - 'data_source_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.remove_memory_item_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', - 'operation_id': 'remove_memory_item', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'memory_id', - ], - 'required': [ - 'workspace_id', - 'memory_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'memory_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'memory_id': 'memoryId', - }, - 'location_map': { - 'workspace_id': 'path', - 'memory_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.resolve_all_entitlements_endpoint = _Endpoint( - settings={ - 'response_type': ([ApiEntitlement],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/resolveEntitlements', - 'operation_id': 'resolve_all_entitlements', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.resolve_all_settings_without_workspace_endpoint = _Endpoint( - settings={ - 'response_type': ([ResolvedSetting],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/resolveSettings', - 'operation_id': 'resolve_all_settings_without_workspace', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.resolve_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (ResolvedLlmEndpoints,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints', - 'operation_id': 'resolve_llm_endpoints', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.resolve_requested_entitlements_endpoint = _Endpoint( - settings={ - 'response_type': ([ApiEntitlement],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/resolveEntitlements', - 'operation_id': 'resolve_requested_entitlements', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'entitlements_request', - ], - 'required': [ - 'entitlements_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'entitlements_request': - (EntitlementsRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'entitlements_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.resolve_settings_without_workspace_endpoint = _Endpoint( - settings={ - 'response_type': ([ResolvedSetting],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/resolveSettings', - 'operation_id': 'resolve_settings_without_workspace', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'resolve_settings_request', - ], - 'required': [ - 'resolve_settings_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'resolve_settings_request': - (ResolveSettingsRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'resolve_settings_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.retrieve_execution_metadata_endpoint = _Endpoint( - settings={ - 'response_type': (ResultCacheMetadata,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata', - 'operation_id': 'retrieve_execution_metadata', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.retrieve_result_endpoint = _Endpoint( - settings={ - 'response_type': (ExecutionResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}', - 'operation_id': 'retrieve_result', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'offset', - 'limit', - 'excluded_total_dimensions', - 'x_gdc_cancel_token', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'offset': - ([int],), - 'limit': - ([int],), - 'excluded_total_dimensions': - ([str],), - 'x_gdc_cancel_token': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'offset': 'offset', - 'limit': 'limit', - 'excluded_total_dimensions': 'excludedTotalDimensions', - 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'offset': 'query', - 'limit': 'query', - 'excluded_total_dimensions': 'query', - 'x_gdc_cancel_token': 'header', - }, - 'collection_format_map': { - 'offset': 'csv', - 'limit': 'csv', - 'excluded_total_dimensions': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.retrieve_translations_endpoint = _Endpoint( - settings={ - 'response_type': (Xliff,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations/retrieve', - 'operation_id': 'retrieve_translations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'locale_request', - ], - 'required': [ - 'workspace_id', - 'locale_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'locale_request': - (LocaleRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'locale_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/xml' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.scan_data_source_endpoint = _Endpoint( - settings={ - 'response_type': (ScanResultPdm,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/scan', - 'operation_id': 'scan_data_source', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'scan_request', - ], - 'required': [ - 'data_source_id', - 'scan_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'data_source_id', - ] - }, - root_map={ - 'validations': { - ('data_source_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'scan_request': - (ScanRequest,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'scan_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.scan_sql_endpoint = _Endpoint( - settings={ - 'response_type': (ScanSqlResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/scanSql', - 'operation_id': 'scan_sql', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'scan_sql_request', - ], - 'required': [ - 'data_source_id', - 'scan_sql_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'data_source_id', - ] - }, - root_map={ - 'validations': { - ('data_source_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'scan_sql_request': - (ScanSqlRequest,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'scan_sql_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_translations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations/set', - 'operation_id': 'set_translations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'xliff', - ], - 'required': [ - 'workspace_id', - 'xliff', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'xliff': - (Xliff,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'xliff': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/xml' - ] - }, - api_client=api_client - ) - self.switch_active_identity_provider_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/switchActiveIdentityProvider', - 'operation_id': 'switch_active_identity_provider', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'switch_identity_provider_request', - ], - 'required': [ - 'switch_identity_provider_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'switch_identity_provider_request': - (SwitchIdentityProviderRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'switch_identity_provider_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.tags_endpoint = _Endpoint( - settings={ - 'response_type': (AnalyticsCatalogTags,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags', - 'operation_id': 'tags', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.test_data_source_endpoint = _Endpoint( - settings={ - 'response_type': (TestResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/test', - 'operation_id': 'test_data_source', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'test_request', - ], - 'required': [ - 'data_source_id', - 'test_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'data_source_id', - ] - }, - root_map={ - 'validations': { - ('data_source_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'test_request': - (TestRequest,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'test_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.test_data_source_definition_endpoint = _Endpoint( - settings={ - 'response_type': (TestResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSource/test', - 'operation_id': 'test_data_source_definition', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'test_definition_request', - ], - 'required': [ - 'test_definition_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'test_definition_request': - (TestDefinitionRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'test_definition_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.test_existing_notification_channel_endpoint = _Endpoint( - settings={ - 'response_type': (TestResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/notificationChannels/{notificationChannelId}/test', - 'operation_id': 'test_existing_notification_channel', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'notification_channel_id', - 'test_destination_request', - ], - 'required': [ - 'notification_channel_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'notification_channel_id': - (str,), - 'test_destination_request': - (TestDestinationRequest,), - }, - 'attribute_map': { - 'notification_channel_id': 'notificationChannelId', - }, - 'location_map': { - 'notification_channel_id': 'path', - 'test_destination_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.test_notification_channel_endpoint = _Endpoint( - settings={ - 'response_type': (TestResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/notificationChannels/test', - 'operation_id': 'test_notification_channel', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'test_destination_request', - ], - 'required': [ - 'test_destination_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'test_destination_request': - (TestDestinationRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'test_destination_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.trigger_automation_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/trigger', - 'operation_id': 'trigger_automation', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'trigger_automation_request', - ], - 'required': [ - 'workspace_id', - 'trigger_automation_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'trigger_automation_request': - (TriggerAutomationRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'trigger_automation_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.trigger_existing_automation_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger', - 'operation_id': 'trigger_existing_automation', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'automation_id', - ], - 'required': [ - 'workspace_id', - 'automation_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'automation_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'automation_id': 'automationId', - }, - 'location_map': { - 'workspace_id': 'path', - 'automation_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.unpause_organization_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/unpause', - 'operation_id': 'unpause_organization_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'organization_automation_management_bulk_request', - ], - 'required': [ - 'organization_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_slides_export( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_slides_export_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_slides_export_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_slides_export_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/pdf', + 'application/vnd.openxmlformats-officedocument.presentationml.presentation' ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'organization_automation_management_bulk_request': - (OrganizationAutomationManagementBulkRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'organization_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_slides_export_metadata( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_slides_export_metadata_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_slides_export_metadata_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_slides_export_metadata_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.unpause_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unpause', - 'operation_id': 'unpause_workspace_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'required': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_tabular_export( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """Retrieve exported files + + After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tabular_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_tabular_export_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """Retrieve exported files + + After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tabular_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_tabular_export_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve exported files + + After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tabular_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_tabular_export_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/pdf', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', + 'text/csv', + 'text/html' ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'workspace_automation_management_bulk_request': - (WorkspaceAutomationManagementBulkRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'workspace_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_translation_tags( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[str]: + """Get translation tags. + + Provides a list of effective translation tags. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_translation_tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_translation_tags_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[str]]: + """Get translation tags. + + Provides a list of effective translation tags. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_translation_tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_translation_tags_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get translation tags. + + Provides a list of effective translation tags. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_translation_tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_translation_tags_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.unsubscribe_all_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/unsubscribe', - 'operation_id': 'unsubscribe_all_automations', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.unsubscribe_automation_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe', - 'operation_id': 'unsubscribe_automation', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'automation_id', - ], - 'required': [ - 'workspace_id', - 'automation_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'automation_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'automation_id': 'automationId', - }, - 'location_map': { - 'workspace_id': 'path', - 'automation_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.unsubscribe_organization_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/unsubscribe', - 'operation_id': 'unsubscribe_organization_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'organization_automation_management_bulk_request', - ], - 'required': [ - 'organization_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'organization_automation_management_bulk_request': - (OrganizationAutomationManagementBulkRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'organization_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/translations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def inherited_entity_conflicts( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[IdentifierDuplications]: + """Finds identifier conflicts in workspace hierarchy. + + Finds API identifier conflicts in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_conflicts_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def inherited_entity_conflicts_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[IdentifierDuplications]]: + """Finds identifier conflicts in workspace hierarchy. + + Finds API identifier conflicts in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_conflicts_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def inherited_entity_conflicts_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Finds identifier conflicts in workspace hierarchy. + + Finds API identifier conflicts in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_conflicts_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _inherited_entity_conflicts_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.unsubscribe_selected_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', - 'operation_id': 'unsubscribe_selected_workspace_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'required': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'workspace_automation_management_bulk_request': - (WorkspaceAutomationManagementBulkRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'workspace_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def inherited_entity_prefixes( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[str]: + """Get used entity prefixes in hierarchy + + Get used entity prefixes in hierarchy of parent workspaces + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_prefixes_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def inherited_entity_prefixes_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[str]]: + """Get used entity prefixes in hierarchy + + Get used entity prefixes in hierarchy of parent workspaces + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_prefixes_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def inherited_entity_prefixes_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get used entity prefixes in hierarchy + + Get used entity prefixes in hierarchy of parent workspaces + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_prefixes_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _inherited_entity_prefixes_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.unsubscribe_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', - 'operation_id': 'unsubscribe_workspace_automations', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.update_memory_item_endpoint = _Endpoint( - settings={ - 'response_type': (MemoryItem,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', - 'operation_id': 'update_memory_item', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'memory_id', - 'memory_item', - ], - 'required': [ - 'workspace_id', - 'memory_id', - 'memory_item', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'memory_id': - (str,), - 'memory_item': - (MemoryItem,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'memory_id': 'memoryId', - }, - 'location_map': { - 'workspace_id': 'path', - 'memory_id': 'path', - 'memory_item': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def key_driver_analysis( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + key_drivers_request: KeyDriversRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> KeyDriversResponse: + """(EXPERIMENTAL) Compute key driver analysis + + (EXPERIMENTAL) Computes key driver analysis for the provided execution definition. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param key_drivers_request: (required) + :type key_drivers_request: KeyDriversRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_serialize( + workspace_id=workspace_id, + key_drivers_request=key_drivers_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def key_driver_analysis_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + key_drivers_request: KeyDriversRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[KeyDriversResponse]: + """(EXPERIMENTAL) Compute key driver analysis + + (EXPERIMENTAL) Computes key driver analysis for the provided execution definition. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param key_drivers_request: (required) + :type key_drivers_request: KeyDriversRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_serialize( + workspace_id=workspace_id, + key_drivers_request=key_drivers_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def key_driver_analysis_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + key_drivers_request: KeyDriversRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Compute key driver analysis + + (EXPERIMENTAL) Computes key driver analysis for the provided execution definition. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param key_drivers_request: (required) + :type key_drivers_request: KeyDriversRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_serialize( + workspace_id=workspace_id, + key_drivers_request=key_drivers_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _key_driver_analysis_serialize( + self, + workspace_id, + key_drivers_request, + skip_cache, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + # process the form parameters + # process the body parameter + if key_drivers_request is not None: + _body_params = key_drivers_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.validate_llm_endpoint_endpoint = _Endpoint( - settings={ - 'response_type': (ValidateLLMEndpointResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/ai/llmEndpoint/test', - 'operation_id': 'validate_llm_endpoint', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'validate_llm_endpoint_request', - ], - 'required': [ - 'validate_llm_endpoint_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'validate_llm_endpoint_request': - (ValidateLLMEndpointRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'validate_llm_endpoint_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def key_driver_analysis_result( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> KeyDriversResult: + """(EXPERIMENTAL) Get key driver analysis result + + (EXPERIMENTAL) Gets key driver analysis. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def key_driver_analysis_result_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[KeyDriversResult]: + """(EXPERIMENTAL) Get key driver analysis result + + (EXPERIMENTAL) Gets key driver analysis. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def key_driver_analysis_result_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Get key driver analysis result + + (EXPERIMENTAL) Gets key driver analysis. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _key_driver_analysis_result_serialize( + self, + workspace_id, + result_id, + offset, + limit, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.validate_llm_endpoint_by_id_endpoint = _Endpoint( - settings={ - 'response_type': (ValidateLLMEndpointResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test', - 'operation_id': 'validate_llm_endpoint_by_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'llm_endpoint_id', - 'validate_llm_endpoint_by_id_request', - ], - 'required': [ - 'llm_endpoint_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'llm_endpoint_id': - (str,), - 'validate_llm_endpoint_by_id_request': - (ValidateLLMEndpointByIdRequest,), - }, - 'attribute_map': { - 'llm_endpoint_id': 'llmEndpointId', - }, - 'location_map': { - 'llm_endpoint_id': 'path', - 'validate_llm_endpoint_by_id_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_memory_items( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[MemoryItem]: + """(EXPERIMENTAL) List all memory items + + (EXPERIMENTAL) Returns a list of memory items + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_memory_items_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[MemoryItem]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_memory_items_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[MemoryItem]]: + """(EXPERIMENTAL) List all memory items + + (EXPERIMENTAL) Returns a list of memory items + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_memory_items_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[MemoryItem]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_memory_items_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) List all memory items + + (EXPERIMENTAL) Returns a list of memory items + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_memory_items_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[MemoryItem]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_memory_items_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.workspace_resolve_all_settings_endpoint = _Endpoint( - settings={ - 'response_type': ([ResolvedSetting],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/resolveSettings', - 'operation_id': 'workspace_resolve_all_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/memory', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_workspace_user_groups( + self, + workspace_id: StrictStr, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> WorkspaceUserGroups: + """list_workspace_user_groups + + + :param workspace_id: (required) + :type workspace_id: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_workspace_user_groups_serialize( + workspace_id=workspace_id, + page=page, + size=size, + name=name, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WorkspaceUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_workspace_user_groups_with_http_info( + self, + workspace_id: StrictStr, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[WorkspaceUserGroups]: + """list_workspace_user_groups + + + :param workspace_id: (required) + :type workspace_id: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_workspace_user_groups_serialize( + workspace_id=workspace_id, + page=page, + size=size, + name=name, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WorkspaceUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_workspace_user_groups_without_preload_content( + self, + workspace_id: StrictStr, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """list_workspace_user_groups + + + :param workspace_id: (required) + :type workspace_id: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_workspace_user_groups_serialize( + workspace_id=workspace_id, + page=page, + size=size, + name=name, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WorkspaceUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_workspace_user_groups_serialize( + self, + workspace_id, + page, + size, + name, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if name is not None: + + _query_params.append(('name', name)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.workspace_resolve_settings_endpoint = _Endpoint( - settings={ - 'response_type': ([ResolvedSetting],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/resolveSettings', - 'operation_id': 'workspace_resolve_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'resolve_settings_request', - ], - 'required': [ - 'workspace_id', - 'resolve_settings_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'resolve_settings_request': - (ResolveSettingsRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'resolve_settings_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_workspace_users( + self, + workspace_id: StrictStr, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> WorkspaceUsers: + """list_workspace_users + + + :param workspace_id: (required) + :type workspace_id: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_workspace_users_serialize( + workspace_id=workspace_id, + page=page, + size=size, + name=name, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WorkspaceUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_workspace_users_with_http_info( + self, + workspace_id: StrictStr, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[WorkspaceUsers]: + """list_workspace_users + + + :param workspace_id: (required) + :type workspace_id: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_workspace_users_serialize( + workspace_id=workspace_id, + page=page, + size=size, + name=name, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WorkspaceUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_workspace_users_without_preload_content( + self, + workspace_id: StrictStr, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """list_workspace_users + + + :param workspace_id: (required) + :type workspace_id: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_workspace_users_serialize( + workspace_id=workspace_id, + page=page, + size=size, + name=name, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WorkspaceUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_workspace_users_serialize( + self, + workspace_id, + page, + size, + name, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if name is not None: + + _query_params.append(('name', name)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - def ai_chat( + + + + @validate_call + def manage_dashboard_permissions( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Manage Permissions for a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param manage_dashboard_permissions_request_inner: (required) + :type manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + manage_dashboard_permissions_request_inner=manage_dashboard_permissions_request_inner, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def manage_dashboard_permissions_with_http_info( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Manage Permissions for a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param manage_dashboard_permissions_request_inner: (required) + :type manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + manage_dashboard_permissions_request_inner=manage_dashboard_permissions_request_inner, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def manage_dashboard_permissions_without_preload_content( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Manage Permissions for a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param manage_dashboard_permissions_request_inner: (required) + :type manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + manage_dashboard_permissions_request_inner=manage_dashboard_permissions_request_inner, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _manage_dashboard_permissions_serialize( self, workspace_id, - chat_request, - **kwargs - ): - """(BETA) Chat with AI # noqa: E501 - - (BETA) Combines multiple use cases such as search, create visualizations, ... # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_chat(workspace_id, chat_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - chat_request (ChatRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ChatResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['chat_request'] = \ - chat_request - return self.ai_chat_endpoint.call_with_http_info(**kwargs) + dashboard_id, + manage_dashboard_permissions_request_inner, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'ManageDashboardPermissionsRequestInner': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if dashboard_id is not None: + _path_params['dashboardId'] = dashboard_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if manage_dashboard_permissions_request_inner is not None: + _body_params = manage_dashboard_permissions_request_inner + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def manage_data_source_permissions( + self, + data_source_id: StrictStr, + data_source_permission_assignment: List[DataSourcePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Manage Permissions for a Data Source + + Manage Permissions for a Data Source + + :param data_source_id: (required) + :type data_source_id: str + :param data_source_permission_assignment: (required) + :type data_source_permission_assignment: List[DataSourcePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_data_source_permissions_serialize( + data_source_id=data_source_id, + data_source_permission_assignment=data_source_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def manage_data_source_permissions_with_http_info( + self, + data_source_id: StrictStr, + data_source_permission_assignment: List[DataSourcePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Manage Permissions for a Data Source + + Manage Permissions for a Data Source + + :param data_source_id: (required) + :type data_source_id: str + :param data_source_permission_assignment: (required) + :type data_source_permission_assignment: List[DataSourcePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_data_source_permissions_serialize( + data_source_id=data_source_id, + data_source_permission_assignment=data_source_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def manage_data_source_permissions_without_preload_content( + self, + data_source_id: StrictStr, + data_source_permission_assignment: List[DataSourcePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Manage Permissions for a Data Source + + Manage Permissions for a Data Source + + :param data_source_id: (required) + :type data_source_id: str + :param data_source_permission_assignment: (required) + :type data_source_permission_assignment: List[DataSourcePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_data_source_permissions_serialize( + data_source_id=data_source_id, + data_source_permission_assignment=data_source_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _manage_data_source_permissions_serialize( + self, + data_source_id, + data_source_permission_assignment, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'DataSourcePermissionAssignment': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if data_source_permission_assignment is not None: + _body_params = data_source_permission_assignment + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/managePermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def manage_organization_permissions( + self, + organization_permission_assignment: List[OrganizationPermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Manage Permissions for a Organization + + Manage Permissions for a Organization + + :param organization_permission_assignment: (required) + :type organization_permission_assignment: List[OrganizationPermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_organization_permissions_serialize( + organization_permission_assignment=organization_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def manage_organization_permissions_with_http_info( + self, + organization_permission_assignment: List[OrganizationPermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Manage Permissions for a Organization + + Manage Permissions for a Organization + + :param organization_permission_assignment: (required) + :type organization_permission_assignment: List[OrganizationPermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_organization_permissions_serialize( + organization_permission_assignment=organization_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def manage_organization_permissions_without_preload_content( + self, + organization_permission_assignment: List[OrganizationPermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Manage Permissions for a Organization + + Manage Permissions for a Organization + + :param organization_permission_assignment: (required) + :type organization_permission_assignment: List[OrganizationPermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_organization_permissions_serialize( + organization_permission_assignment=organization_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _manage_organization_permissions_serialize( + self, + organization_permission_assignment, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'OrganizationPermissionAssignment': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if organization_permission_assignment is not None: + _body_params = organization_permission_assignment + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/managePermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def manage_workspace_permissions( + self, + workspace_id: StrictStr, + workspace_permission_assignment: List[WorkspacePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Manage Permissions for a Workspace + + Manage Permissions for a Workspace and its Workspace Hierarchy + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_permission_assignment: (required) + :type workspace_permission_assignment: List[WorkspacePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_workspace_permissions_serialize( + workspace_id=workspace_id, + workspace_permission_assignment=workspace_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def manage_workspace_permissions_with_http_info( + self, + workspace_id: StrictStr, + workspace_permission_assignment: List[WorkspacePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Manage Permissions for a Workspace + + Manage Permissions for a Workspace and its Workspace Hierarchy + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_permission_assignment: (required) + :type workspace_permission_assignment: List[WorkspacePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_workspace_permissions_serialize( + workspace_id=workspace_id, + workspace_permission_assignment=workspace_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def manage_workspace_permissions_without_preload_content( + self, + workspace_id: StrictStr, + workspace_permission_assignment: List[WorkspacePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Manage Permissions for a Workspace + + Manage Permissions for a Workspace and its Workspace Hierarchy + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_permission_assignment: (required) + :type workspace_permission_assignment: List[WorkspacePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_workspace_permissions_serialize( + workspace_id=workspace_id, + workspace_permission_assignment=workspace_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _manage_workspace_permissions_serialize( + self, + workspace_id, + workspace_permission_assignment, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'WorkspacePermissionAssignment': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if workspace_permission_assignment is not None: + _body_params = workspace_permission_assignment + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/managePermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def mark_as_read_notification( + self, + notification_id: Annotated[StrictStr, Field(description="Notification ID to mark as read.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Mark notification as read. + + Mark in-platform notification by its ID as read. + + :param notification_id: Notification ID to mark as read. (required) + :type notification_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_serialize( + notification_id=notification_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def mark_as_read_notification_with_http_info( + self, + notification_id: Annotated[StrictStr, Field(description="Notification ID to mark as read.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Mark notification as read. + + Mark in-platform notification by its ID as read. + + :param notification_id: Notification ID to mark as read. (required) + :type notification_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_serialize( + notification_id=notification_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def mark_as_read_notification_without_preload_content( + self, + notification_id: Annotated[StrictStr, Field(description="Notification ID to mark as read.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Mark notification as read. + + Mark in-platform notification by its ID as read. + + :param notification_id: Notification ID to mark as read. (required) + :type notification_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_serialize( + notification_id=notification_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _mark_as_read_notification_serialize( + self, + notification_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: - def ai_chat_history( + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if notification_id is not None: + _path_params['notificationId'] = notification_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/notifications/{notificationId}/markAsRead', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def mark_as_read_notification_all( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID where to mark notifications as read.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Mark all notifications as read. + + Mark all user in-platform notifications as read. + + :param workspace_id: Workspace ID where to mark notifications as read. + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_all_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def mark_as_read_notification_all_with_http_info( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID where to mark notifications as read.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Mark all notifications as read. + + Mark all user in-platform notifications as read. + + :param workspace_id: Workspace ID where to mark notifications as read. + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_all_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def mark_as_read_notification_all_without_preload_content( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID where to mark notifications as read.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Mark all notifications as read. + + Mark all user in-platform notifications as read. + + :param workspace_id: Workspace ID where to mark notifications as read. + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_all_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _mark_as_read_notification_all_serialize( self, workspace_id, - chat_history_request, - **kwargs - ): - """(BETA) Get Chat History # noqa: E501 - - (BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_chat_history(workspace_id, chat_history_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - chat_history_request (ChatHistoryRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ChatHistoryResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['chat_history_request'] = \ - chat_history_request - return self.ai_chat_history_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: - def ai_chat_stream( + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if workspace_id is not None: + + _query_params.append(('workspaceId', workspace_id)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/notifications/markAsRead', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def metadata_sync( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(BETA) Sync Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def metadata_sync_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(BETA) Sync Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def metadata_sync_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Sync Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _metadata_sync_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/metadataSync', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def metadata_sync_organization( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(BETA) Sync organization scope Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_organization_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def metadata_sync_organization_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(BETA) Sync organization scope Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_organization_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def metadata_sync_organization_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Sync organization scope Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_organization_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _metadata_sync_organization_serialize( self, - workspace_id, - chat_request, - **kwargs - ): - """(BETA) Chat with AI # noqa: E501 - - (BETA) Combines multiple use cases such as search, create visualizations, ... # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_chat_stream(workspace_id, chat_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - chat_request (ChatRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [dict] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['chat_request'] = \ - chat_request - return self.ai_chat_stream_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: - def ai_chat_usage( - self, - workspace_id, - **kwargs - ): - """Get Chat Usage # noqa: E501 - - Returns usage statistics of chat for a user in a workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_chat_usage(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ChatUsageResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.ai_chat_usage_endpoint.call_with_http_info(**kwargs) + _host = None - def ai_search( - self, - workspace_id, - search_request, - **kwargs - ): - """(BETA) Semantic Search in Metadata # noqa: E501 - - (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_search(workspace_id, search_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - search_request (SearchRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - SearchResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['search_request'] = \ - search_request - return self.ai_search_endpoint.call_with_http_info(**kwargs) + _collection_formats: Dict[str, str] = { + } - def all_platform_usage( - self, - **kwargs - ): - """Info about the platform usage. # noqa: E501 - - Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.all_platform_usage(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [PlatformUsage] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.all_platform_usage_endpoint.call_with_http_info(**kwargs) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None - def anomaly_detection( - self, - workspace_id, - result_id, - anomaly_detection_request, - **kwargs - ): - """(EXPERIMENTAL) Smart functions - Anomaly Detection # noqa: E501 - - (EXPERIMENTAL) Computes anomaly detection. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.anomaly_detection(workspace_id, result_id, anomaly_detection_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Input result ID to be used in the computation - anomaly_detection_request (AnomalyDetectionRequest): - - Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - SmartFunctionResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - kwargs['anomaly_detection_request'] = \ - anomaly_detection_request - return self.anomaly_detection_endpoint.call_with_http_info(**kwargs) + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter - def anomaly_detection_result( - self, - workspace_id, - result_id, - **kwargs - ): - """(EXPERIMENTAL) Smart functions - Anomaly Detection Result # noqa: E501 - - (EXPERIMENTAL) Gets anomalies. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.anomaly_detection_result(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - offset (int): [optional] - limit (int): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AnomalyDetectionResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.anomaly_detection_result_endpoint.call_with_http_info(**kwargs) - def available_assignees( - self, - workspace_id, - dashboard_id, - **kwargs - ): - """Get Available Assignees # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.available_assignees(workspace_id, dashboard_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - dashboard_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AvailableAssignees - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['dashboard_id'] = \ - dashboard_id - return self.available_assignees_endpoint.call_with_http_info(**kwargs) - def cancel_executions( - self, - workspace_id, - afm_cancel_tokens, - **kwargs - ): - """Applies all the given cancel tokens. # noqa: E501 - - Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.cancel_executions(workspace_id, afm_cancel_tokens, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - afm_cancel_tokens (AfmCancelTokens): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AfmCancelTokens - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['afm_cancel_tokens'] = \ - afm_cancel_tokens - return self.cancel_executions_endpoint.call_with_http_info(**kwargs) - def check_entity_overrides( - self, - workspace_id, - hierarchy_object_identification, - **kwargs - ): - """Finds entities with given ID in hierarchy. # noqa: E501 - - Finds entities with given ID in hierarchy (e.g. to check possible future conflicts). # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.check_entity_overrides(workspace_id, hierarchy_object_identification, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - hierarchy_object_identification ([HierarchyObjectIdentification]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [IdentifierDuplications] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['hierarchy_object_identification'] = \ - hierarchy_object_identification - return self.check_entity_overrides_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def clean_translations( - self, - workspace_id, - locale_request, - **kwargs - ): - """Cleans up translations. # noqa: E501 - - Cleans up all translations for a particular locale. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.clean_translations(workspace_id, locale_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - locale_request (LocaleRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['locale_request'] = \ - locale_request - return self.clean_translations_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/metadataSync', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def clustering( - self, - workspace_id, - result_id, - clustering_request, - **kwargs - ): - """(EXPERIMENTAL) Smart functions - Clustering # noqa: E501 - - (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.clustering(workspace_id, result_id, clustering_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Input result ID to be used in the computation - clustering_request (ClusteringRequest): - - Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - SmartFunctionResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - kwargs['clustering_request'] = \ - clustering_request - return self.clustering_endpoint.call_with_http_info(**kwargs) - def clustering_result( - self, - workspace_id, - result_id, - **kwargs - ): - """(EXPERIMENTAL) Smart functions - Clustering Result # noqa: E501 - - (EXPERIMENTAL) Gets clustering result. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.clustering_result(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - offset (int): [optional] - limit (int): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ClusteringResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.clustering_result_endpoint.call_with_http_info(**kwargs) - def column_statistics( - self, - data_source_id, - column_statistics_request, - **kwargs - ): - """(EXPERIMENTAL) Compute column statistics # noqa: E501 - - (EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.column_statistics(data_source_id, column_statistics_request, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - column_statistics_request (ColumnStatisticsRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ColumnStatisticsResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['column_statistics_request'] = \ - column_statistics_request - return self.column_statistics_endpoint.call_with_http_info(**kwargs) - def compute_label_elements_post( + @validate_call + def overridden_child_entities( self, - workspace_id, - elements_request, - **kwargs - ): - """Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. # noqa: E501 - - Returns paged list of elements (values) of given label satisfying given filtering criteria. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.compute_label_elements_post(workspace_id, elements_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - elements_request (ElementsRequest): - - Keyword Args: - offset (int): Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.. [optional] if omitted the server will use the default value of 0 - limit (int): Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.. [optional] if omitted the server will use the default value of 1000 - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ElementsResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['elements_request'] = \ - elements_request - return self.compute_label_elements_post_endpoint.call_with_http_info(**kwargs) - - def compute_report( + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[IdentifierDuplications]: + """Finds identifier overrides in workspace hierarchy. + + Finds API identifier overrides in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._overridden_child_entities_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def overridden_child_entities_with_http_info( self, - workspace_id, - afm_execution, - **kwargs - ): - """Executes analytical request and returns link to the result # noqa: E501 - - AFM is a combination of attributes, measures and filters that describe a query you want to execute. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.compute_report(workspace_id, afm_execution, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - afm_execution (AfmExecution): - - Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - timestamp (str): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AfmExecutionResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['afm_execution'] = \ - afm_execution - return self.compute_report_endpoint.call_with_http_info(**kwargs) - - def compute_valid_descendants( + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[IdentifierDuplications]]: + """Finds identifier overrides in workspace hierarchy. + + Finds API identifier overrides in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._overridden_child_entities_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def overridden_child_entities_without_preload_content( self, - workspace_id, - afm_valid_descendants_query, - **kwargs - ): - """(BETA) Valid descendants # noqa: E501 - - (BETA) Returns map of lists of attributes that can be used as descendants of the given attributes. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.compute_valid_descendants(workspace_id, afm_valid_descendants_query, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - afm_valid_descendants_query (AfmValidDescendantsQuery): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AfmValidDescendantsResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['afm_valid_descendants_query'] = \ - afm_valid_descendants_query - return self.compute_valid_descendants_endpoint.call_with_http_info(**kwargs) - - def compute_valid_objects( + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Finds identifier overrides in workspace hierarchy. + + Finds API identifier overrides in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._overridden_child_entities_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _overridden_child_entities_serialize( self, workspace_id, - afm_valid_objects_query, - **kwargs - ): - """Valid objects # noqa: E501 - - Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.compute_valid_objects(workspace_id, afm_valid_objects_query, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - afm_valid_objects_query (AfmValidObjectsQuery): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AfmValidObjectsResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['afm_valid_objects_query'] = \ - afm_valid_objects_query - return self.compute_valid_objects_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) - def create_dashboard_export_request( - self, - workspace_id, - dashboard_id, - dashboard_tabular_export_request, - **kwargs - ): - """(EXPERIMENTAL) Create dashboard tabular export request # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_dashboard_export_request(workspace_id, dashboard_id, dashboard_tabular_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - dashboard_id (str): - dashboard_tabular_export_request (DashboardTabularExportRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['dashboard_id'] = \ - dashboard_id - kwargs['dashboard_tabular_export_request'] = \ - dashboard_tabular_export_request - return self.create_dashboard_export_request_endpoint.call_with_http_info(**kwargs) - def create_image_export( - self, - workspace_id, - image_export_request, - **kwargs - ): - """(EXPERIMENTAL) Create image export request # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_image_export(workspace_id, image_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - image_export_request (ImageExportRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['image_export_request'] = \ - image_export_request - return self.create_image_export_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def create_memory_item( - self, - workspace_id, - memory_item, - **kwargs - ): - """(EXPERIMENTAL) Create new memory item # noqa: E501 - - (EXPERIMENTAL) Creates a new memory item and returns it # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_memory_item(workspace_id, memory_item, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - memory_item (MemoryItem): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - MemoryItem - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['memory_item'] = \ - memory_item - return self.create_memory_item_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def create_pdf_export( - self, - workspace_id, - visual_export_request, - **kwargs - ): - """Create visual - pdf export request # noqa: E501 - - An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_pdf_export(workspace_id, visual_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - visual_export_request (VisualExportRequest): - - Keyword Args: - x_gdc_debug (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['visual_export_request'] = \ - visual_export_request - return self.create_pdf_export_endpoint.call_with_http_info(**kwargs) - def create_raw_export( - self, - workspace_id, - raw_export_request, - **kwargs - ): - """(EXPERIMENTAL) Create raw export request # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_raw_export(workspace_id, raw_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - raw_export_request (RawExportRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['raw_export_request'] = \ - raw_export_request - return self.create_raw_export_endpoint.call_with_http_info(**kwargs) - def create_slides_export( - self, - workspace_id, - slides_export_request, - **kwargs - ): - """(EXPERIMENTAL) Create slides export request # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_slides_export(workspace_id, slides_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - slides_export_request (SlidesExportRequest): - - Keyword Args: - x_gdc_debug (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['slides_export_request'] = \ - slides_export_request - return self.create_slides_export_endpoint.call_with_http_info(**kwargs) - def create_tabular_export( + @validate_call + def particular_platform_usage( self, - workspace_id, - tabular_export_request, - **kwargs - ): - """Create tabular export request # noqa: E501 - - An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_tabular_export(workspace_id, tabular_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - tabular_export_request (TabularExportRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['tabular_export_request'] = \ - tabular_export_request - return self.create_tabular_export_endpoint.call_with_http_info(**kwargs) - - def dashboard_permissions( + platform_usage_request: PlatformUsageRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[PlatformUsage]: + """Info about the platform usage for particular items. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param platform_usage_request: (required) + :type platform_usage_request: PlatformUsageRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._particular_platform_usage_serialize( + platform_usage_request=platform_usage_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def particular_platform_usage_with_http_info( self, - workspace_id, - dashboard_id, - **kwargs - ): - """Get Dashboard Permissions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.dashboard_permissions(workspace_id, dashboard_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - dashboard_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DashboardPermissions - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['dashboard_id'] = \ - dashboard_id - return self.dashboard_permissions_endpoint.call_with_http_info(**kwargs) - - def delete_organization_automations( + platform_usage_request: PlatformUsageRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[PlatformUsage]]: + """Info about the platform usage for particular items. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param platform_usage_request: (required) + :type platform_usage_request: PlatformUsageRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._particular_platform_usage_serialize( + platform_usage_request=platform_usage_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def particular_platform_usage_without_preload_content( + self, + platform_usage_request: PlatformUsageRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Info about the platform usage for particular items. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param platform_usage_request: (required) + :type platform_usage_request: PlatformUsageRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._particular_platform_usage_serialize( + platform_usage_request=platform_usage_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _particular_platform_usage_serialize( + self, + platform_usage_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if platform_usage_request is not None: + _body_params = platform_usage_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/collectUsage', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def pause_organization_automations( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Pause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def pause_organization_automations_with_http_info( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Pause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def pause_organization_automations_without_preload_content( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Pause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _pause_organization_automations_serialize( self, organization_automation_management_bulk_request, - **kwargs - ): - """Delete selected automations across all workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_organization_automations(organization_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['organization_automation_management_bulk_request'] = \ - organization_automation_management_bulk_request - return self.delete_organization_automations_endpoint.call_with_http_info(**kwargs) - - def delete_workspace_automations( + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if organization_automation_management_bulk_request is not None: + _body_params = organization_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/automations/pause', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def pause_workspace_automations( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Pause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def pause_workspace_automations_with_http_info( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Pause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def pause_workspace_automations_without_preload_content( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Pause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _pause_workspace_automations_serialize( self, workspace_id, workspace_automation_management_bulk_request, - **kwargs - ): - """Delete selected automations in the workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['workspace_automation_management_bulk_request'] = \ - workspace_automation_management_bulk_request - return self.delete_workspace_automations_endpoint.call_with_http_info(**kwargs) - - def explain_afm( + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if workspace_automation_management_bulk_request is not None: + _body_params = workspace_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/pause', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def register_upload_notification( self, - workspace_id, - afm_execution, - **kwargs - ): - """AFM explain resource. # noqa: E501 - - The resource provides static structures needed for investigation of a problem with given AFM. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.explain_afm(workspace_id, afm_execution, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - afm_execution (AfmExecution): - - Keyword Args: - explain_type (str): Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['afm_execution'] = \ - afm_execution - return self.explain_afm_endpoint.call_with_http_info(**kwargs) - - def forecast( + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Register an upload notification + + Notification sets up all reports to be computed again with new data. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._register_upload_notification_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def register_upload_notification_with_http_info( self, - workspace_id, - result_id, - forecast_request, - **kwargs - ): - """(BETA) Smart functions - Forecast # noqa: E501 - - (BETA) Computes forecasted data points from the provided execution result and parameters. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.forecast(workspace_id, result_id, forecast_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Input result ID to be used in the computation - forecast_request (ForecastRequest): - - Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - SmartFunctionResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - kwargs['forecast_request'] = \ - forecast_request - return self.forecast_endpoint.call_with_http_info(**kwargs) - - def forecast_result( + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Register an upload notification + + Notification sets up all reports to be computed again with new data. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._register_upload_notification_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def register_upload_notification_without_preload_content( self, - workspace_id, - result_id, - **kwargs - ): - """(BETA) Smart functions - Forecast Result # noqa: E501 - - (BETA) Gets forecast result. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.forecast_result(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - offset (int): [optional] - limit (int): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ForecastResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.forecast_result_endpoint.call_with_http_info(**kwargs) - - def generate_logical_model( + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Register an upload notification + + Notification sets up all reports to be computed again with new data. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._register_upload_notification_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _register_upload_notification_serialize( self, data_source_id, - generate_ldm_request, - **kwargs - ): - """Generate logical data model (LDM) from physical data model (PDM) # noqa: E501 - - Generate logical data model (LDM) from physical data model (PDM) stored in data source. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.generate_logical_model(data_source_id, generate_ldm_request, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - generate_ldm_request (GenerateLdmRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeModel - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['generate_ldm_request'] = \ - generate_ldm_request - return self.generate_logical_model_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: - def get_data_source_schemata( - self, - data_source_id, - **kwargs - ): - """Get a list of schema names of a database # noqa: E501 - - It scans a database and reads metadata. The result of the request contains a list of schema names of a database. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_data_source_schemata(data_source_id, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): Data source id - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DataSourceSchemata - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - return self.get_data_source_schemata_endpoint.call_with_http_info(**kwargs) + _host = None - def get_dependent_entities_graph( - self, - workspace_id, - **kwargs - ): - """Computes the dependent entities graph # noqa: E501 - - Computes the dependent entities graph # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_dependent_entities_graph(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DependentEntitiesResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_dependent_entities_graph_endpoint.call_with_http_info(**kwargs) + _collection_formats: Dict[str, str] = { + } - def get_dependent_entities_graph_from_entry_points( - self, - workspace_id, - dependent_entities_request, - **kwargs - ): - """Computes the dependent entities graph from given entry points # noqa: E501 - - Computes the dependent entities graph from given entry points # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_dependent_entities_graph_from_entry_points(workspace_id, dependent_entities_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - dependent_entities_request (DependentEntitiesRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DependentEntitiesResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['dependent_entities_request'] = \ - dependent_entities_request - return self.get_dependent_entities_graph_from_entry_points_endpoint.call_with_http_info(**kwargs) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None - def get_exported_file( - self, - workspace_id, - export_id, - **kwargs - ): - """Retrieve exported files # noqa: E501 - - Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_exported_file(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - file_type - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_exported_file_endpoint.call_with_http_info(**kwargs) + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter - def get_image_export( - self, - workspace_id, - export_id, - **kwargs - ): - """(EXPERIMENTAL) Retrieve exported files # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_image_export(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - file_type - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_image_export_endpoint.call_with_http_info(**kwargs) - def get_image_export_metadata( - self, - workspace_id, - export_id, - **kwargs - ): - """(EXPERIMENTAL) Retrieve metadata context # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_image_export_metadata(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_image_export_metadata_endpoint.call_with_http_info(**kwargs) - def get_memory_item( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/uploadNotification', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def remove_memory_item( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(EXPERIMENTAL) Remove memory item + + (EXPERIMENTAL) Removes memory item + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def remove_memory_item_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(EXPERIMENTAL) Remove memory item + + (EXPERIMENTAL) Removes memory item + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def remove_memory_item_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Remove memory item + + (EXPERIMENTAL) Removes memory item + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _remove_memory_item_serialize( self, workspace_id, memory_id, - **kwargs - ): - """(EXPERIMENTAL) Get memory item # noqa: E501 - - (EXPERIMENTAL) Get memory item by id # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_memory_item(workspace_id, memory_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - memory_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - MemoryItem - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['memory_id'] = \ - memory_id - return self.get_memory_item_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: - def get_metadata( - self, - workspace_id, - export_id, - **kwargs - ): - """Retrieve metadata context # noqa: E501 - - This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_metadata(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_metadata_endpoint.call_with_http_info(**kwargs) + _host = None - def get_notifications( - self, - **kwargs - ): - """Get latest notifications. # noqa: E501 - - Get latest in-platform notifications for the current user. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_notifications(async_req=True) - >>> result = thread.get() - - - Keyword Args: - workspace_id (str): Workspace ID to filter notifications by.. [optional] - is_read (bool): Filter notifications by read status.. [optional] - page (str): Zero-based page index (0..N). [optional] if omitted the server will use the default value of "0" - size (str): The size of the page to be returned.. [optional] if omitted the server will use the default value of "20" - meta_include ([str]): Additional meta information to include in the response.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - Notifications - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_notifications_endpoint.call_with_http_info(**kwargs) + _collection_formats: Dict[str, str] = { + } - def get_quality_issues( - self, - workspace_id, - **kwargs - ): - """Get Quality Issues # noqa: E501 - - Returns metadata quality issues detected by the platform linter. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_quality_issues(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - GetQualityIssuesResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_quality_issues_endpoint.call_with_http_info(**kwargs) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None - def get_raw_export( - self, - workspace_id, - export_id, - **kwargs - ): - """(EXPERIMENTAL) Retrieve exported files # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_raw_export(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - file_type - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_raw_export_endpoint.call_with_http_info(**kwargs) + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if memory_id is not None: + _path_params['memoryId'] = memory_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter - def get_slides_export( - self, - workspace_id, - export_id, - **kwargs - ): - """(EXPERIMENTAL) Retrieve exported files # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_slides_export(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - file_type - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_slides_export_endpoint.call_with_http_info(**kwargs) - def get_slides_export_metadata( - self, - workspace_id, - export_id, - **kwargs - ): - """(EXPERIMENTAL) Retrieve metadata context # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_slides_export_metadata(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_slides_export_metadata_endpoint.call_with_http_info(**kwargs) - def get_tabular_export( - self, - workspace_id, - export_id, - **kwargs - ): - """Retrieve exported files # noqa: E501 - - After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_tabular_export(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - file_type - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_tabular_export_endpoint.call_with_http_info(**kwargs) - def get_translation_tags( - self, - workspace_id, - **kwargs - ): - """Get translation tags. # noqa: E501 - - Provides a list of effective translation tags. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_translation_tags(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [str] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_translation_tags_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def inherited_entity_conflicts( - self, - workspace_id, - **kwargs - ): - """Finds identifier conflicts in workspace hierarchy. # noqa: E501 - - Finds API identifier conflicts in given workspace hierarchy. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.inherited_entity_conflicts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [IdentifierDuplications] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.inherited_entity_conflicts_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def inherited_entity_prefixes( - self, - workspace_id, - **kwargs - ): - """Get used entity prefixes in hierarchy # noqa: E501 - - Get used entity prefixes in hierarchy of parent workspaces # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.inherited_entity_prefixes(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [str] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.inherited_entity_prefixes_endpoint.call_with_http_info(**kwargs) - def key_driver_analysis( - self, - workspace_id, - key_drivers_request, - **kwargs - ): - """(EXPERIMENTAL) Compute key driver analysis # noqa: E501 - - (EXPERIMENTAL) Computes key driver analysis for the provided execution definition. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.key_driver_analysis(workspace_id, key_drivers_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - key_drivers_request (KeyDriversRequest): - - Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - KeyDriversResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['key_drivers_request'] = \ - key_drivers_request - return self.key_driver_analysis_endpoint.call_with_http_info(**kwargs) - def key_driver_analysis_result( - self, - workspace_id, - result_id, - **kwargs - ): - """(EXPERIMENTAL) Get key driver analysis result # noqa: E501 - - (EXPERIMENTAL) Gets key driver analysis. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.key_driver_analysis_result(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - offset (int): [optional] - limit (int): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - KeyDriversResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.key_driver_analysis_result_endpoint.call_with_http_info(**kwargs) - def list_memory_items( + @validate_call + def resolve_all_entitlements( self, - workspace_id, - **kwargs - ): - """(EXPERIMENTAL) List all memory items # noqa: E501 - - (EXPERIMENTAL) Returns a list of memory items # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_memory_items(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [MemoryItem] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.list_memory_items_endpoint.call_with_http_info(**kwargs) - - def list_workspace_user_groups( + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ApiEntitlement]: + """Values for all public entitlements. + + Resolves values of available entitlements for the organization. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_entitlements_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def resolve_all_entitlements_with_http_info( self, - workspace_id, - **kwargs - ): - """list_workspace_user_groups # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_workspace_user_groups(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 - name (str): Filter by user name. Note that user name is case insensitive.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - WorkspaceUserGroups - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.list_workspace_user_groups_endpoint.call_with_http_info(**kwargs) - - def list_workspace_users( + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ApiEntitlement]]: + """Values for all public entitlements. + + Resolves values of available entitlements for the organization. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_entitlements_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def resolve_all_entitlements_without_preload_content( self, - workspace_id, - **kwargs - ): - """list_workspace_users # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_workspace_users(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 - name (str): Filter by user name. Note that user name is case insensitive.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - WorkspaceUsers - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.list_workspace_users_endpoint.call_with_http_info(**kwargs) - - def manage_dashboard_permissions( + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for all public entitlements. + + Resolves values of available entitlements for the organization. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_entitlements_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _resolve_all_entitlements_serialize( self, - workspace_id, - dashboard_id, - manage_dashboard_permissions_request_inner, - **kwargs - ): - """Manage Permissions for a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.manage_dashboard_permissions(workspace_id, dashboard_id, manage_dashboard_permissions_request_inner, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - dashboard_id (str): - manage_dashboard_permissions_request_inner ([ManageDashboardPermissionsRequestInner]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['dashboard_id'] = \ - dashboard_id - kwargs['manage_dashboard_permissions_request_inner'] = \ - manage_dashboard_permissions_request_inner - return self.manage_dashboard_permissions_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) - def manage_data_source_permissions( - self, - data_source_id, - data_source_permission_assignment, - **kwargs - ): - """Manage Permissions for a Data Source # noqa: E501 - - Manage Permissions for a Data Source # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.manage_data_source_permissions(data_source_id, data_source_permission_assignment, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - data_source_permission_assignment ([DataSourcePermissionAssignment]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['data_source_permission_assignment'] = \ - data_source_permission_assignment - return self.manage_data_source_permissions_endpoint.call_with_http_info(**kwargs) - def manage_organization_permissions( - self, - organization_permission_assignment, - **kwargs - ): - """Manage Permissions for a Organization # noqa: E501 - - Manage Permissions for a Organization # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.manage_organization_permissions(organization_permission_assignment, async_req=True) - >>> result = thread.get() - - Args: - organization_permission_assignment ([OrganizationPermissionAssignment]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['organization_permission_assignment'] = \ - organization_permission_assignment - return self.manage_organization_permissions_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def manage_workspace_permissions( - self, - workspace_id, - workspace_permission_assignment, - **kwargs - ): - """Manage Permissions for a Workspace # noqa: E501 - - Manage Permissions for a Workspace and its Workspace Hierarchy # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.manage_workspace_permissions(workspace_id, workspace_permission_assignment, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - workspace_permission_assignment ([WorkspacePermissionAssignment]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['workspace_permission_assignment'] = \ - workspace_permission_assignment - return self.manage_workspace_permissions_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/resolveEntitlements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def mark_as_read_notification( - self, - notification_id, - **kwargs - ): - """Mark notification as read. # noqa: E501 - - Mark in-platform notification by its ID as read. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.mark_as_read_notification(notification_id, async_req=True) - >>> result = thread.get() - - Args: - notification_id (str): Notification ID to mark as read. - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['notification_id'] = \ - notification_id - return self.mark_as_read_notification_endpoint.call_with_http_info(**kwargs) - def mark_as_read_notification_all( + + + @validate_call + def resolve_all_settings_without_workspace( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ResolvedSetting]: + """Values for all settings without workspace. + + Resolves values for all settings without workspace by current user, organization, or default settings. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_settings_without_workspace_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def resolve_all_settings_without_workspace_with_http_info( self, - **kwargs - ): - """Mark all notifications as read. # noqa: E501 - - Mark all user in-platform notifications as read. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.mark_as_read_notification_all(async_req=True) - >>> result = thread.get() - - - Keyword Args: - workspace_id (str): Workspace ID where to mark notifications as read.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.mark_as_read_notification_all_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ResolvedSetting]]: + """Values for all settings without workspace. + + Resolves values for all settings without workspace by current user, organization, or default settings. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_settings_without_workspace_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def resolve_all_settings_without_workspace_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for all settings without workspace. + + Resolves values for all settings without workspace by current user, organization, or default settings. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_settings_without_workspace_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _resolve_all_settings_without_workspace_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/resolveSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def metadata_sync( - self, - workspace_id, - **kwargs - ): - """(BETA) Sync Metadata to other services # noqa: E501 - - (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.metadata_sync(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.metadata_sync_endpoint.call_with_http_info(**kwargs) - def metadata_sync_organization( - self, - **kwargs - ): - """(BETA) Sync organization scope Metadata to other services # noqa: E501 - - (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.metadata_sync_organization(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.metadata_sync_organization_endpoint.call_with_http_info(**kwargs) - def overridden_child_entities( - self, - workspace_id, - **kwargs - ): - """Finds identifier overrides in workspace hierarchy. # noqa: E501 - - Finds API identifier overrides in given workspace hierarchy. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.overridden_child_entities(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [IdentifierDuplications] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.overridden_child_entities_endpoint.call_with_http_info(**kwargs) - def particular_platform_usage( + @validate_call + def resolve_llm_endpoints( self, - platform_usage_request, - **kwargs - ): - """Info about the platform usage for particular items. # noqa: E501 - - Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.particular_platform_usage(platform_usage_request, async_req=True) - >>> result = thread.get() - - Args: - platform_usage_request (PlatformUsageRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [PlatformUsage] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['platform_usage_request'] = \ - platform_usage_request - return self.particular_platform_usage_endpoint.call_with_http_info(**kwargs) - - def pause_organization_automations( + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ResolvedLlmEndpoints: + """Get Active LLM Endpoints for this workspace + + Returns a list of available LLM Endpoints + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_llm_endpoints_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResolvedLlmEndpoints", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def resolve_llm_endpoints_with_http_info( self, - organization_automation_management_bulk_request, - **kwargs - ): - """Pause selected automations across all workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.pause_organization_automations(organization_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['organization_automation_management_bulk_request'] = \ - organization_automation_management_bulk_request - return self.pause_organization_automations_endpoint.call_with_http_info(**kwargs) - - def pause_workspace_automations( + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ResolvedLlmEndpoints]: + """Get Active LLM Endpoints for this workspace + + Returns a list of available LLM Endpoints + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_llm_endpoints_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResolvedLlmEndpoints", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def resolve_llm_endpoints_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Active LLM Endpoints for this workspace + + Returns a list of available LLM Endpoints + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_llm_endpoints_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResolvedLlmEndpoints", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _resolve_llm_endpoints_serialize( self, workspace_id, - workspace_automation_management_bulk_request, - **kwargs - ): - """Pause selected automations in the workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.pause_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['workspace_automation_management_bulk_request'] = \ - workspace_automation_management_bulk_request - return self.pause_workspace_automations_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) - def register_upload_notification( - self, - data_source_id, - **kwargs - ): - """Register an upload notification # noqa: E501 - - Notification sets up all reports to be computed again with new data. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.register_upload_notification(data_source_id, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - return self.register_upload_notification_endpoint.call_with_http_info(**kwargs) - def remove_memory_item( - self, - workspace_id, - memory_id, - **kwargs - ): - """(EXPERIMENTAL) Remove memory item # noqa: E501 - - (EXPERIMENTAL) Removes memory item # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.remove_memory_item(workspace_id, memory_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - memory_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['memory_id'] = \ - memory_id - return self.remove_memory_item_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def resolve_all_entitlements( - self, - **kwargs - ): - """Values for all public entitlements. # noqa: E501 - - Resolves values of available entitlements for the organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.resolve_all_entitlements(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ApiEntitlement] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.resolve_all_entitlements_endpoint.call_with_http_info(**kwargs) - def resolve_all_settings_without_workspace( - self, - **kwargs - ): - """Values for all settings without workspace. # noqa: E501 - - Resolves values for all settings without workspace by current user, organization, or default settings. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.resolve_all_settings_without_workspace(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ResolvedSetting] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.resolve_all_settings_without_workspace_endpoint.call_with_http_info(**kwargs) - def resolve_llm_endpoints( - self, - workspace_id, - **kwargs - ): - """Get Active LLM Endpoints for this workspace # noqa: E501 - - Returns a list of available LLM Endpoints # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.resolve_llm_endpoints(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ResolvedLlmEndpoints - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.resolve_llm_endpoints_endpoint.call_with_http_info(**kwargs) + @validate_call def resolve_requested_entitlements( + self, + entitlements_request: EntitlementsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ApiEntitlement]: + """Values for requested public entitlements. + + Resolves values for requested entitlements in the organization. + + :param entitlements_request: (required) + :type entitlements_request: EntitlementsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_requested_entitlements_serialize( + entitlements_request=entitlements_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def resolve_requested_entitlements_with_http_info( + self, + entitlements_request: EntitlementsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ApiEntitlement]]: + """Values for requested public entitlements. + + Resolves values for requested entitlements in the organization. + + :param entitlements_request: (required) + :type entitlements_request: EntitlementsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_requested_entitlements_serialize( + entitlements_request=entitlements_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def resolve_requested_entitlements_without_preload_content( + self, + entitlements_request: EntitlementsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for requested public entitlements. + + Resolves values for requested entitlements in the organization. + + :param entitlements_request: (required) + :type entitlements_request: EntitlementsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_requested_entitlements_serialize( + entitlements_request=entitlements_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _resolve_requested_entitlements_serialize( self, entitlements_request, - **kwargs - ): - """Values for requested public entitlements. # noqa: E501 - - Resolves values for requested entitlements in the organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.resolve_requested_entitlements(entitlements_request, async_req=True) - >>> result = thread.get() - - Args: - entitlements_request (EntitlementsRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ApiEntitlement] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['entitlements_request'] = \ - entitlements_request - return self.resolve_requested_entitlements_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if entitlements_request is not None: + _body_params = entitlements_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/resolveEntitlements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def resolve_settings_without_workspace( + self, + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ResolvedSetting]: + """Values for selected settings without workspace. + + Resolves values for selected settings without workspace by current user, organization, or default settings. + + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_settings_without_workspace_serialize( + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def resolve_settings_without_workspace_with_http_info( + self, + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ResolvedSetting]]: + """Values for selected settings without workspace. + + Resolves values for selected settings without workspace by current user, organization, or default settings. + + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_settings_without_workspace_serialize( + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def resolve_settings_without_workspace_without_preload_content( + self, + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for selected settings without workspace. + + Resolves values for selected settings without workspace by current user, organization, or default settings. + + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_settings_without_workspace_serialize( + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _resolve_settings_without_workspace_serialize( self, resolve_settings_request, - **kwargs - ): - """Values for selected settings without workspace. # noqa: E501 - - Resolves values for selected settings without workspace by current user, organization, or default settings. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.resolve_settings_without_workspace(resolve_settings_request, async_req=True) - >>> result = thread.get() - - Args: - resolve_settings_request (ResolveSettingsRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ResolvedSetting] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['resolve_settings_request'] = \ - resolve_settings_request - return self.resolve_settings_without_workspace_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if resolve_settings_request is not None: + _body_params = resolve_settings_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/resolveSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def retrieve_execution_metadata( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ResultCacheMetadata: + """Get a single execution result's metadata. + + The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_execution_metadata_serialize( + workspace_id=workspace_id, + result_id=result_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResultCacheMetadata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def retrieve_execution_metadata_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ResultCacheMetadata]: + """Get a single execution result's metadata. + + The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_execution_metadata_serialize( + workspace_id=workspace_id, + result_id=result_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResultCacheMetadata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def retrieve_execution_metadata_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a single execution result's metadata. + + The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_execution_metadata_serialize( + workspace_id=workspace_id, + result_id=result_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResultCacheMetadata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _retrieve_execution_metadata_serialize( self, workspace_id, result_id, - **kwargs - ): - """Get a single execution result's metadata. # noqa: E501 - - The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.retrieve_execution_metadata(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ResultCacheMetadata - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.retrieve_execution_metadata_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def retrieve_result( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Annotated[Optional[List[StrictInt]], Field(description="Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.")] = None, + limit: Annotated[Optional[List[StrictInt]], Field(description="Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.")] = None, + excluded_total_dimensions: Annotated[Optional[List[StrictStr]], Field(description="Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.")] = None, + x_gdc_cancel_token: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExecutionResult: + """Get a single execution result + + Gets a single execution result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. + :type offset: List[int] + :param limit: Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. + :type limit: List[int] + :param excluded_total_dimensions: Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. + :type excluded_total_dimensions: List[str] + :param x_gdc_cancel_token: + :type x_gdc_cancel_token: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + excluded_total_dimensions=excluded_total_dimensions, + x_gdc_cancel_token=x_gdc_cancel_token, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ExecutionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def retrieve_result_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Annotated[Optional[List[StrictInt]], Field(description="Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.")] = None, + limit: Annotated[Optional[List[StrictInt]], Field(description="Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.")] = None, + excluded_total_dimensions: Annotated[Optional[List[StrictStr]], Field(description="Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.")] = None, + x_gdc_cancel_token: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExecutionResult]: + """Get a single execution result + + Gets a single execution result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. + :type offset: List[int] + :param limit: Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. + :type limit: List[int] + :param excluded_total_dimensions: Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. + :type excluded_total_dimensions: List[str] + :param x_gdc_cancel_token: + :type x_gdc_cancel_token: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + excluded_total_dimensions=excluded_total_dimensions, + x_gdc_cancel_token=x_gdc_cancel_token, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ExecutionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def retrieve_result_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Annotated[Optional[List[StrictInt]], Field(description="Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.")] = None, + limit: Annotated[Optional[List[StrictInt]], Field(description="Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.")] = None, + excluded_total_dimensions: Annotated[Optional[List[StrictStr]], Field(description="Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.")] = None, + x_gdc_cancel_token: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a single execution result + + Gets a single execution result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. + :type offset: List[int] + :param limit: Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. + :type limit: List[int] + :param excluded_total_dimensions: Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. + :type excluded_total_dimensions: List[str] + :param x_gdc_cancel_token: + :type x_gdc_cancel_token: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + excluded_total_dimensions=excluded_total_dimensions, + x_gdc_cancel_token=x_gdc_cancel_token, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ExecutionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _retrieve_result_serialize( self, workspace_id, result_id, - **kwargs - ): - """Get a single execution result # noqa: E501 - - Gets a single execution result. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.retrieve_result(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - offset ([int]): Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] - limit ([int]): Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] - excluded_total_dimensions ([str]): Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.. [optional] if omitted the server will use the default value of [] - x_gdc_cancel_token (str): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExecutionResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.retrieve_result_endpoint.call_with_http_info(**kwargs) + offset, + limit, + excluded_total_dimensions, + x_gdc_cancel_token, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'offset': 'csv', + 'limit': 'csv', + 'excludedTotalDimensions': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if excluded_total_dimensions is not None: + + _query_params.append(('excludedTotalDimensions', excluded_total_dimensions)) + + # process the header parameters + if x_gdc_cancel_token is not None: + _header_params['X-GDC-CANCEL-TOKEN'] = x_gdc_cancel_token + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def retrieve_translations( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> Xliff: + """Retrieve translations for entities. + + Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Xliff", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def retrieve_translations_with_http_info( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[Xliff]: + """Retrieve translations for entities. + + Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Xliff", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def retrieve_translations_without_preload_content( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve translations for entities. + + Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Xliff", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _retrieve_translations_serialize( self, workspace_id, locale_request, - **kwargs - ): - """Retrieve translations for entities. # noqa: E501 - - Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.retrieve_translations(workspace_id, locale_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - locale_request (LocaleRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - Xliff - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['locale_request'] = \ - locale_request - return self.retrieve_translations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if locale_request is not None: + _body_params = locale_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/xml' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/translations/retrieve', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def scan_data_source( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_request: ScanRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScanResultPdm: + """Scan a database to get a physical data model (PDM) + + It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_request: (required) + :type scan_request: ScanRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_data_source_serialize( + data_source_id=data_source_id, + scan_request=scan_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanResultPdm", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def scan_data_source_with_http_info( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_request: ScanRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScanResultPdm]: + """Scan a database to get a physical data model (PDM) + + It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_request: (required) + :type scan_request: ScanRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_data_source_serialize( + data_source_id=data_source_id, + scan_request=scan_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanResultPdm", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def scan_data_source_without_preload_content( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_request: ScanRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Scan a database to get a physical data model (PDM) + + It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_request: (required) + :type scan_request: ScanRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_data_source_serialize( + data_source_id=data_source_id, + scan_request=scan_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanResultPdm", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _scan_data_source_serialize( self, data_source_id, scan_request, - **kwargs - ): - """Scan a database to get a physical data model (PDM) # noqa: E501 - - It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.scan_data_source(data_source_id, scan_request, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): Data source id - scan_request (ScanRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ScanResultPdm - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['scan_request'] = \ - scan_request - return self.scan_data_source_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if scan_request is not None: + _body_params = scan_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/scan', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def scan_sql( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_sql_request: ScanSqlRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScanSqlResponse: + """Collect metadata about SQL query + + It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_sql_request: (required) + :type scan_sql_request: ScanSqlRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_sql_serialize( + data_source_id=data_source_id, + scan_sql_request=scan_sql_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanSqlResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def scan_sql_with_http_info( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_sql_request: ScanSqlRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScanSqlResponse]: + """Collect metadata about SQL query + + It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_sql_request: (required) + :type scan_sql_request: ScanSqlRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_sql_serialize( + data_source_id=data_source_id, + scan_sql_request=scan_sql_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanSqlResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def scan_sql_without_preload_content( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_sql_request: ScanSqlRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Collect metadata about SQL query + + It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_sql_request: (required) + :type scan_sql_request: ScanSqlRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_sql_serialize( + data_source_id=data_source_id, + scan_sql_request=scan_sql_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanSqlResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _scan_sql_serialize( self, data_source_id, scan_sql_request, - **kwargs - ): - """Collect metadata about SQL query # noqa: E501 - - It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.scan_sql(data_source_id, scan_sql_request, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): Data source id - scan_sql_request (ScanSqlRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ScanSqlResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['scan_sql_request'] = \ - scan_sql_request - return self.scan_sql_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if scan_sql_request is not None: + _body_params = scan_sql_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/scanSql', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_translations( + self, + workspace_id: StrictStr, + xliff: Xliff, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set translations for entities. + + Set translation for existing entities in a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param xliff: (required) + :type xliff: Xliff + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_translations_serialize( + workspace_id=workspace_id, + xliff=xliff, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_translations_with_http_info( + self, + workspace_id: StrictStr, + xliff: Xliff, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set translations for entities. + + Set translation for existing entities in a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param xliff: (required) + :type xliff: Xliff + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_translations_serialize( + workspace_id=workspace_id, + xliff=xliff, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_translations_without_preload_content( + self, + workspace_id: StrictStr, + xliff: Xliff, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set translations for entities. + + Set translation for existing entities in a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param xliff: (required) + :type xliff: Xliff + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_translations_serialize( + workspace_id=workspace_id, + xliff=xliff, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_translations_serialize( self, workspace_id, xliff, - **kwargs - ): - """Set translations for entities. # noqa: E501 - - Set translation for existing entities in a particular locale. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_translations(workspace_id, xliff, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - xliff (Xliff): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['xliff'] = \ - xliff - return self.set_translations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if xliff is not None: + _body_params = xliff + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/xml' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/translations/set', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def switch_active_identity_provider( + self, + switch_identity_provider_request: SwitchIdentityProviderRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Switch Active Identity Provider + + Switch the active identity provider for the organization. Requires MANAGE permission on the organization. + + :param switch_identity_provider_request: (required) + :type switch_identity_provider_request: SwitchIdentityProviderRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._switch_active_identity_provider_serialize( + switch_identity_provider_request=switch_identity_provider_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def switch_active_identity_provider_with_http_info( + self, + switch_identity_provider_request: SwitchIdentityProviderRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Switch Active Identity Provider + + Switch the active identity provider for the organization. Requires MANAGE permission on the organization. + + :param switch_identity_provider_request: (required) + :type switch_identity_provider_request: SwitchIdentityProviderRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._switch_active_identity_provider_serialize( + switch_identity_provider_request=switch_identity_provider_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def switch_active_identity_provider_without_preload_content( + self, + switch_identity_provider_request: SwitchIdentityProviderRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Switch Active Identity Provider + + Switch the active identity provider for the organization. Requires MANAGE permission on the organization. + + :param switch_identity_provider_request: (required) + :type switch_identity_provider_request: SwitchIdentityProviderRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._switch_active_identity_provider_serialize( + switch_identity_provider_request=switch_identity_provider_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _switch_active_identity_provider_serialize( self, switch_identity_provider_request, - **kwargs - ): - """Switch Active Identity Provider # noqa: E501 - - Switch the active identity provider for the organization. Requires MANAGE permission on the organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.switch_active_identity_provider(switch_identity_provider_request, async_req=True) - >>> result = thread.get() - - Args: - switch_identity_provider_request (SwitchIdentityProviderRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['switch_identity_provider_request'] = \ - switch_identity_provider_request - return self.switch_active_identity_provider_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if switch_identity_provider_request is not None: + _body_params = switch_identity_provider_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/switchActiveIdentityProvider', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def tags( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnalyticsCatalogTags: + """Get Analytics Catalog Tags + + Returns a list of tags for this workspace + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalyticsCatalogTags", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def tags_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnalyticsCatalogTags]: + """Get Analytics Catalog Tags + + Returns a list of tags for this workspace + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalyticsCatalogTags", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def tags_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Analytics Catalog Tags + + Returns a list of tags for this workspace + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalyticsCatalogTags", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _tags_serialize( self, workspace_id, - **kwargs - ): - """Get Analytics Catalog Tags # noqa: E501 - - Returns a list of tags for this workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.tags(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AnalyticsCatalogTags - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.tags_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def test_data_source( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + test_request: TestRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TestResponse: + """Test data source connection by data source id + + Test if it is possible to connect to a database using an existing data source definition. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param test_request: (required) + :type test_request: TestRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_serialize( + data_source_id=data_source_id, + test_request=test_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_data_source_with_http_info( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + test_request: TestRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TestResponse]: + """Test data source connection by data source id + + Test if it is possible to connect to a database using an existing data source definition. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param test_request: (required) + :type test_request: TestRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_serialize( + data_source_id=data_source_id, + test_request=test_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def test_data_source_without_preload_content( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + test_request: TestRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test data source connection by data source id + + Test if it is possible to connect to a database using an existing data source definition. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param test_request: (required) + :type test_request: TestRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_serialize( + data_source_id=data_source_id, + test_request=test_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _test_data_source_serialize( self, data_source_id, test_request, - **kwargs - ): - """Test data source connection by data source id # noqa: E501 - - Test if it is possible to connect to a database using an existing data source definition. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.test_data_source(data_source_id, test_request, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): Data source id - test_request (TestRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - TestResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['test_request'] = \ - test_request - return self.test_data_source_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if test_request is not None: + _body_params = test_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def test_data_source_definition( + self, + test_definition_request: TestDefinitionRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TestResponse: + """Test connection by data source definition + + Test if it is possible to connect to a database using a connection provided by the data source definition in the request body. + + :param test_definition_request: (required) + :type test_definition_request: TestDefinitionRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_definition_serialize( + test_definition_request=test_definition_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_data_source_definition_with_http_info( + self, + test_definition_request: TestDefinitionRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TestResponse]: + """Test connection by data source definition + + Test if it is possible to connect to a database using a connection provided by the data source definition in the request body. + + :param test_definition_request: (required) + :type test_definition_request: TestDefinitionRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_definition_serialize( + test_definition_request=test_definition_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def test_data_source_definition_without_preload_content( + self, + test_definition_request: TestDefinitionRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test connection by data source definition + + Test if it is possible to connect to a database using a connection provided by the data source definition in the request body. + + :param test_definition_request: (required) + :type test_definition_request: TestDefinitionRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_definition_serialize( + test_definition_request=test_definition_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _test_data_source_definition_serialize( self, test_definition_request, - **kwargs - ): - """Test connection by data source definition # noqa: E501 - - Test if it is possible to connect to a database using a connection provided by the data source definition in the request body. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.test_data_source_definition(test_definition_request, async_req=True) - >>> result = thread.get() - - Args: - test_definition_request (TestDefinitionRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - TestResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['test_definition_request'] = \ - test_definition_request - return self.test_data_source_definition_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if test_definition_request is not None: + _body_params = test_definition_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSource/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def test_existing_notification_channel( + self, + notification_channel_id: StrictStr, + test_destination_request: Optional[TestDestinationRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TestResponse: + """Test existing notification channel. + + Tests the existing notification channel by sending a test notification. + + :param notification_channel_id: (required) + :type notification_channel_id: str + :param test_destination_request: + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_existing_notification_channel_serialize( + notification_channel_id=notification_channel_id, + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_existing_notification_channel_with_http_info( + self, + notification_channel_id: StrictStr, + test_destination_request: Optional[TestDestinationRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TestResponse]: + """Test existing notification channel. + + Tests the existing notification channel by sending a test notification. + + :param notification_channel_id: (required) + :type notification_channel_id: str + :param test_destination_request: + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_existing_notification_channel_serialize( + notification_channel_id=notification_channel_id, + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def test_existing_notification_channel_without_preload_content( + self, + notification_channel_id: StrictStr, + test_destination_request: Optional[TestDestinationRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test existing notification channel. + + Tests the existing notification channel by sending a test notification. + + :param notification_channel_id: (required) + :type notification_channel_id: str + :param test_destination_request: + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_existing_notification_channel_serialize( + notification_channel_id=notification_channel_id, + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _test_existing_notification_channel_serialize( self, notification_channel_id, - **kwargs - ): - """Test existing notification channel. # noqa: E501 - - Tests the existing notification channel by sending a test notification. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.test_existing_notification_channel(notification_channel_id, async_req=True) - >>> result = thread.get() - - Args: - notification_channel_id (str): - - Keyword Args: - test_destination_request (TestDestinationRequest): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - TestResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['notification_channel_id'] = \ - notification_channel_id - return self.test_existing_notification_channel_endpoint.call_with_http_info(**kwargs) - + test_destination_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if notification_channel_id is not None: + _path_params['notificationChannelId'] = notification_channel_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if test_destination_request is not None: + _body_params = test_destination_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/notificationChannels/{notificationChannelId}/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def test_notification_channel( + self, + test_destination_request: TestDestinationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TestResponse: + """Test notification channel. + + Tests the notification channel by sending a test notification. + + :param test_destination_request: (required) + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_notification_channel_serialize( + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_notification_channel_with_http_info( + self, + test_destination_request: TestDestinationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TestResponse]: + """Test notification channel. + + Tests the notification channel by sending a test notification. + + :param test_destination_request: (required) + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_notification_channel_serialize( + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def test_notification_channel_without_preload_content( + self, + test_destination_request: TestDestinationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test notification channel. + + Tests the notification channel by sending a test notification. + + :param test_destination_request: (required) + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_notification_channel_serialize( + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _test_notification_channel_serialize( self, test_destination_request, - **kwargs - ): - """Test notification channel. # noqa: E501 - - Tests the notification channel by sending a test notification. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.test_notification_channel(test_destination_request, async_req=True) - >>> result = thread.get() - - Args: - test_destination_request (TestDestinationRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - TestResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['test_destination_request'] = \ - test_destination_request - return self.test_notification_channel_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if test_destination_request is not None: + _body_params = test_destination_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/notificationChannels/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def trigger_automation( + self, + workspace_id: StrictStr, + trigger_automation_request: TriggerAutomationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Trigger automation. + + Trigger the automation in the request. + + :param workspace_id: (required) + :type workspace_id: str + :param trigger_automation_request: (required) + :type trigger_automation_request: TriggerAutomationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_automation_serialize( + workspace_id=workspace_id, + trigger_automation_request=trigger_automation_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def trigger_automation_with_http_info( + self, + workspace_id: StrictStr, + trigger_automation_request: TriggerAutomationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Trigger automation. + + Trigger the automation in the request. + + :param workspace_id: (required) + :type workspace_id: str + :param trigger_automation_request: (required) + :type trigger_automation_request: TriggerAutomationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_automation_serialize( + workspace_id=workspace_id, + trigger_automation_request=trigger_automation_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def trigger_automation_without_preload_content( + self, + workspace_id: StrictStr, + trigger_automation_request: TriggerAutomationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Trigger automation. + + Trigger the automation in the request. + + :param workspace_id: (required) + :type workspace_id: str + :param trigger_automation_request: (required) + :type trigger_automation_request: TriggerAutomationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_automation_serialize( + workspace_id=workspace_id, + trigger_automation_request=trigger_automation_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _trigger_automation_serialize( self, workspace_id, trigger_automation_request, - **kwargs - ): - """Trigger automation. # noqa: E501 - - Trigger the automation in the request. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.trigger_automation(workspace_id, trigger_automation_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - trigger_automation_request (TriggerAutomationRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['trigger_automation_request'] = \ - trigger_automation_request - return self.trigger_automation_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if trigger_automation_request is not None: + _body_params = trigger_automation_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/trigger', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def trigger_existing_automation( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Trigger existing automation. + + Trigger the existing automation to execute immediately. + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_existing_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def trigger_existing_automation_with_http_info( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Trigger existing automation. + + Trigger the existing automation to execute immediately. + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_existing_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def trigger_existing_automation_without_preload_content( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Trigger existing automation. + + Trigger the existing automation to execute immediately. + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_existing_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _trigger_existing_automation_serialize( self, workspace_id, automation_id, - **kwargs - ): - """Trigger existing automation. # noqa: E501 - - Trigger the existing automation to execute immediately. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.trigger_existing_automation(workspace_id, automation_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - automation_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['automation_id'] = \ - automation_id - return self.trigger_existing_automation_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if automation_id is not None: + _path_params['automationId'] = automation_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def unpause_organization_automations( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unpause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unpause_organization_automations_with_http_info( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unpause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unpause_organization_automations_without_preload_content( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unpause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unpause_organization_automations_serialize( self, organization_automation_management_bulk_request, - **kwargs - ): - """Unpause selected automations across all workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unpause_organization_automations(organization_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['organization_automation_management_bulk_request'] = \ - organization_automation_management_bulk_request - return self.unpause_organization_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if organization_automation_management_bulk_request is not None: + _body_params = organization_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/automations/unpause', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def unpause_workspace_automations( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unpause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unpause_workspace_automations_with_http_info( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unpause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unpause_workspace_automations_without_preload_content( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unpause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unpause_workspace_automations_serialize( self, workspace_id, workspace_automation_management_bulk_request, - **kwargs - ): - """Unpause selected automations in the workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unpause_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['workspace_automation_management_bulk_request'] = \ - workspace_automation_management_bulk_request - return self.unpause_workspace_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if workspace_automation_management_bulk_request is not None: + _body_params = workspace_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/unpause', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def unsubscribe_all_automations( self, - **kwargs - ): - """Unsubscribe from all automations in all workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unsubscribe_all_automations(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.unsubscribe_all_automations_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unsubscribe from all automations in all workspaces + + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_all_automations_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unsubscribe_all_automations_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unsubscribe from all automations in all workspaces + + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_all_automations_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unsubscribe_all_automations_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsubscribe from all automations in all workspaces + + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_all_automations_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unsubscribe_all_automations_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/actions/organization/automations/unsubscribe', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def unsubscribe_automation( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unsubscribe from an automation + + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unsubscribe_automation_with_http_info( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unsubscribe from an automation + + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unsubscribe_automation_without_preload_content( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsubscribe from an automation + + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unsubscribe_automation_serialize( self, workspace_id, automation_id, - **kwargs - ): - """Unsubscribe from an automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unsubscribe_automation(workspace_id, automation_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - automation_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['automation_id'] = \ - automation_id - return self.unsubscribe_automation_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if automation_id is not None: + _path_params['automationId'] = automation_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def unsubscribe_organization_automations( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unsubscribe from selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unsubscribe_organization_automations_with_http_info( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unsubscribe from selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unsubscribe_organization_automations_without_preload_content( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsubscribe from selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unsubscribe_organization_automations_serialize( self, organization_automation_management_bulk_request, - **kwargs - ): - """Unsubscribe from selected automations across all workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unsubscribe_organization_automations(organization_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['organization_automation_management_bulk_request'] = \ - organization_automation_management_bulk_request - return self.unsubscribe_organization_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if organization_automation_management_bulk_request is not None: + _body_params = organization_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/automations/unsubscribe', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def unsubscribe_selected_workspace_automations( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unsubscribe from selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_selected_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unsubscribe_selected_workspace_automations_with_http_info( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unsubscribe from selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_selected_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unsubscribe_selected_workspace_automations_without_preload_content( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsubscribe from selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_selected_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unsubscribe_selected_workspace_automations_serialize( self, workspace_id, workspace_automation_management_bulk_request, - **kwargs - ): - """Unsubscribe from selected automations in the workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unsubscribe_selected_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['workspace_automation_management_bulk_request'] = \ - workspace_automation_management_bulk_request - return self.unsubscribe_selected_workspace_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if workspace_automation_management_bulk_request is not None: + _body_params = workspace_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def unsubscribe_workspace_automations( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unsubscribe from all automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_workspace_automations_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unsubscribe_workspace_automations_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unsubscribe from all automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_workspace_automations_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unsubscribe_workspace_automations_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsubscribe from all automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_workspace_automations_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unsubscribe_workspace_automations_serialize( self, workspace_id, - **kwargs - ): - """Unsubscribe from all automations in the workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unsubscribe_workspace_automations(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.unsubscribe_workspace_automations_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_memory_item( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> MemoryItem: + """(EXPERIMENTAL) Update memory item + + (EXPERIMENTAL) Updates memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_memory_item_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[MemoryItem]: + """(EXPERIMENTAL) Update memory item + + (EXPERIMENTAL) Updates memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_memory_item_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Update memory item + + (EXPERIMENTAL) Updates memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_memory_item_serialize( self, workspace_id, memory_id, memory_item, - **kwargs - ): - """(EXPERIMENTAL) Update memory item # noqa: E501 - - (EXPERIMENTAL) Updates memory item and returns it # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_memory_item(workspace_id, memory_id, memory_item, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - memory_id (str): - memory_item (MemoryItem): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - MemoryItem - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['memory_id'] = \ - memory_id - kwargs['memory_item'] = \ - memory_item - return self.update_memory_item_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if memory_id is not None: + _path_params['memoryId'] = memory_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if memory_item is not None: + _body_params = memory_item + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def validate_llm_endpoint( + self, + validate_llm_endpoint_request: ValidateLLMEndpointRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ValidateLLMEndpointResponse: + """Validate LLM Endpoint + + Validates LLM endpoint with provided parameters. + + :param validate_llm_endpoint_request: (required) + :type validate_llm_endpoint_request: ValidateLLMEndpointRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_serialize( + validate_llm_endpoint_request=validate_llm_endpoint_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def validate_llm_endpoint_with_http_info( + self, + validate_llm_endpoint_request: ValidateLLMEndpointRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ValidateLLMEndpointResponse]: + """Validate LLM Endpoint + + Validates LLM endpoint with provided parameters. + + :param validate_llm_endpoint_request: (required) + :type validate_llm_endpoint_request: ValidateLLMEndpointRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_serialize( + validate_llm_endpoint_request=validate_llm_endpoint_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def validate_llm_endpoint_without_preload_content( + self, + validate_llm_endpoint_request: ValidateLLMEndpointRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Validate LLM Endpoint + + Validates LLM endpoint with provided parameters. + + :param validate_llm_endpoint_request: (required) + :type validate_llm_endpoint_request: ValidateLLMEndpointRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_serialize( + validate_llm_endpoint_request=validate_llm_endpoint_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _validate_llm_endpoint_serialize( self, validate_llm_endpoint_request, - **kwargs - ): - """Validate LLM Endpoint # noqa: E501 - - Validates LLM endpoint with provided parameters. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.validate_llm_endpoint(validate_llm_endpoint_request, async_req=True) - >>> result = thread.get() - - Args: - validate_llm_endpoint_request (ValidateLLMEndpointRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ValidateLLMEndpointResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['validate_llm_endpoint_request'] = \ - validate_llm_endpoint_request - return self.validate_llm_endpoint_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if validate_llm_endpoint_request is not None: + _body_params = validate_llm_endpoint_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/ai/llmEndpoint/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def validate_llm_endpoint_by_id( + self, + llm_endpoint_id: StrictStr, + validate_llm_endpoint_by_id_request: Optional[ValidateLLMEndpointByIdRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ValidateLLMEndpointResponse: + """Validate LLM Endpoint By Id + + Validates existing LLM endpoint with provided parameters and updates it if they are valid. + + :param llm_endpoint_id: (required) + :type llm_endpoint_id: str + :param validate_llm_endpoint_by_id_request: + :type validate_llm_endpoint_by_id_request: ValidateLLMEndpointByIdRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_by_id_serialize( + llm_endpoint_id=llm_endpoint_id, + validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def validate_llm_endpoint_by_id_with_http_info( + self, + llm_endpoint_id: StrictStr, + validate_llm_endpoint_by_id_request: Optional[ValidateLLMEndpointByIdRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ValidateLLMEndpointResponse]: + """Validate LLM Endpoint By Id + + Validates existing LLM endpoint with provided parameters and updates it if they are valid. + + :param llm_endpoint_id: (required) + :type llm_endpoint_id: str + :param validate_llm_endpoint_by_id_request: + :type validate_llm_endpoint_by_id_request: ValidateLLMEndpointByIdRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_by_id_serialize( + llm_endpoint_id=llm_endpoint_id, + validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def validate_llm_endpoint_by_id_without_preload_content( + self, + llm_endpoint_id: StrictStr, + validate_llm_endpoint_by_id_request: Optional[ValidateLLMEndpointByIdRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Validate LLM Endpoint By Id + + Validates existing LLM endpoint with provided parameters and updates it if they are valid. + + :param llm_endpoint_id: (required) + :type llm_endpoint_id: str + :param validate_llm_endpoint_by_id_request: + :type validate_llm_endpoint_by_id_request: ValidateLLMEndpointByIdRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_by_id_serialize( + llm_endpoint_id=llm_endpoint_id, + validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _validate_llm_endpoint_by_id_serialize( self, llm_endpoint_id, - **kwargs - ): - """Validate LLM Endpoint By Id # noqa: E501 - - Validates existing LLM endpoint with provided parameters and updates it if they are valid. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.validate_llm_endpoint_by_id(llm_endpoint_id, async_req=True) - >>> result = thread.get() - - Args: - llm_endpoint_id (str): - - Keyword Args: - validate_llm_endpoint_by_id_request (ValidateLLMEndpointByIdRequest): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ValidateLLMEndpointResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['llm_endpoint_id'] = \ - llm_endpoint_id - return self.validate_llm_endpoint_by_id_endpoint.call_with_http_info(**kwargs) - + validate_llm_endpoint_by_id_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if llm_endpoint_id is not None: + _path_params['llmEndpointId'] = llm_endpoint_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if validate_llm_endpoint_by_id_request is not None: + _body_params = validate_llm_endpoint_by_id_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def workspace_resolve_all_settings( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ResolvedSetting]: + """Values for all settings. + + Resolves values for all settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_all_settings_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def workspace_resolve_all_settings_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ResolvedSetting]]: + """Values for all settings. + + Resolves values for all settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_all_settings_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def workspace_resolve_all_settings_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for all settings. + + Resolves values for all settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_all_settings_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _workspace_resolve_all_settings_serialize( self, workspace_id, - **kwargs - ): - """Values for all settings. # noqa: E501 - - Resolves values for all settings in a workspace by current user, workspace, organization, or default settings. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.workspace_resolve_all_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ResolvedSetting] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.workspace_resolve_all_settings_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/resolveSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def workspace_resolve_settings( + self, + workspace_id: StrictStr, + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ResolvedSetting]: + """Values for selected settings. + + Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_settings_serialize( + workspace_id=workspace_id, + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def workspace_resolve_settings_with_http_info( + self, + workspace_id: StrictStr, + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ResolvedSetting]]: + """Values for selected settings. + + Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_settings_serialize( + workspace_id=workspace_id, + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def workspace_resolve_settings_without_preload_content( + self, + workspace_id: StrictStr, + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for selected settings. + + Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_settings_serialize( + workspace_id=workspace_id, + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _workspace_resolve_settings_serialize( self, workspace_id, resolve_settings_request, - **kwargs - ): - """Values for selected settings. # noqa: E501 - - Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.workspace_resolve_settings(workspace_id, resolve_settings_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - resolve_settings_request (ResolveSettingsRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ResolvedSetting] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['resolve_settings_request'] = \ - resolve_settings_request - return self.workspace_resolve_settings_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if resolve_settings_request is not None: + _body_params = resolve_settings_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/resolveSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/ai_api.py b/gooddata-api-client/gooddata_api_client/api/ai_api.py index bbc3d0d37..cf632d6a4 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_api.py +++ b/gooddata-api-client/gooddata_api_client/api/ai_api.py @@ -1,286 +1,528 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) +from pydantic import StrictStr +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class AIApi(object): + +class AIApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.metadata_sync_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/metadataSync', - 'operation_id': 'metadata_sync', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.metadata_sync_organization_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/metadataSync', - 'operation_id': 'metadata_sync_organization', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def metadata_sync( self, - workspace_id, - **kwargs - ): - """(BETA) Sync Metadata to other services # noqa: E501 - - (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.metadata_sync(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(BETA) Sync Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def metadata_sync_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(BETA) Sync Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def metadata_sync_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Sync Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.metadata_sync_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _metadata_sync_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/metadataSync', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def metadata_sync_organization( self, - **kwargs - ): - """(BETA) Sync organization scope Metadata to other services # noqa: E501 - - (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.metadata_sync_organization(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(BETA) Sync organization scope Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_organization_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def metadata_sync_organization_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(BETA) Sync organization scope Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_organization_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def metadata_sync_organization_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Sync organization scope Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_organization_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _metadata_sync_organization_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/metadataSync', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.metadata_sync_organization_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/analytics_model_api.py b/gooddata-api-client/gooddata_api_client/api/analytics_model_api.py index 6fac04e08..2f419b67b 100644 --- a/gooddata-api-client/gooddata_api_client/api/analytics_model_api.py +++ b/gooddata-api-client/gooddata_api_client/api/analytics_model_api.py @@ -1,324 +1,598 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictStr, field_validator +from typing import List, Optional +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class AnalyticsModelApi(object): +class AnalyticsModelApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_analytics_model_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeAnalytics,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/analyticsModel', - 'operation_id': 'get_analytics_model', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'exclude', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'exclude': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'exclude': 'exclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.set_analytics_model_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/analyticsModel', - 'operation_id': 'set_analytics_model', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_analytics', - ], - 'required': [ - 'workspace_id', - 'declarative_analytics', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_analytics': - (DeclarativeAnalytics,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_analytics': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def get_analytics_model( self, - workspace_id, - **kwargs - ): - """Get analytics model # noqa: E501 - - Retrieve current analytics model of the workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_analytics_model(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeAnalytics - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeAnalytics: + """Get analytics model + + Retrieve current analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytics_model_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeAnalytics", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_analytics_model_with_http_info( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeAnalytics]: + """Get analytics model + + Retrieve current analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytics_model_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeAnalytics", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_analytics_model_without_preload_content( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get analytics model + + Retrieve current analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytics_model_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeAnalytics", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_analytics_model_endpoint.call_with_http_info(**kwargs) + return response_data.response - def set_analytics_model( + + def _get_analytics_model_serialize( self, workspace_id, - declarative_analytics, - **kwargs - ): - """Set analytics model # noqa: E501 - - Set effective analytics model of the workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_analytics_model(workspace_id, declarative_analytics, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_analytics (DeclarativeAnalytics): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/analyticsModel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def set_analytics_model( + self, + workspace_id: StrictStr, + declarative_analytics: DeclarativeAnalytics, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set analytics model + + Set effective analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_analytics: (required) + :type declarative_analytics: DeclarativeAnalytics + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_analytics_model_serialize( + workspace_id=workspace_id, + declarative_analytics=declarative_analytics, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_analytics_model_with_http_info( + self, + workspace_id: StrictStr, + declarative_analytics: DeclarativeAnalytics, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set analytics model + + Set effective analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_analytics: (required) + :type declarative_analytics: DeclarativeAnalytics + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_analytics_model_serialize( + workspace_id=workspace_id, + declarative_analytics=declarative_analytics, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def set_analytics_model_without_preload_content( + self, + workspace_id: StrictStr, + declarative_analytics: DeclarativeAnalytics, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set analytics model + + Set effective analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_analytics: (required) + :type declarative_analytics: DeclarativeAnalytics + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_analytics_model_serialize( + workspace_id=workspace_id, + declarative_analytics=declarative_analytics, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_analytics'] = \ - declarative_analytics - return self.set_analytics_model_endpoint.call_with_http_info(**kwargs) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_analytics_model_serialize( + self, + workspace_id, + declarative_analytics, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_analytics is not None: + _body_params = declarative_analytics + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/analyticsModel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/api_tokens_api.py b/gooddata-api-client/gooddata_api_client/api/api_tokens_api.py index cd8c80aa7..280c79667 100644 --- a/gooddata-api-client/gooddata_api_client/api/api_tokens_api.py +++ b/gooddata-api-client/gooddata_api_client/api/api_tokens_api.py @@ -1,663 +1,1242 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class APITokensApi(object): +class APITokensApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiApiTokenOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens', - 'operation_id': 'create_entity_api_tokens', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'json_api_api_token_in_document', - ], - 'required': [ - 'user_id', - 'json_api_api_token_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'json_api_api_token_in_document': - (JsonApiApiTokenInDocument,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - 'json_api_api_token_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens/{id}', - 'operation_id': 'delete_entity_api_tokens', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiApiTokenOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens', - 'operation_id': 'get_all_entities_api_tokens', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [ - 'user_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'user_id': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'user_id': 'userId', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'user_id': 'path', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiApiTokenOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens/{id}', - 'operation_id': 'get_entity_api_tokens', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def create_entity_api_tokens( + self, + user_id: StrictStr, + json_api_api_token_in_document: JsonApiApiTokenInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiApiTokenOutDocument: + """Post a new API token for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_api_token_in_document: (required) + :type json_api_api_token_in_document: JsonApiApiTokenInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_api_tokens_serialize( + user_id=user_id, + json_api_api_token_in_document=json_api_api_token_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_api_tokens_with_http_info( + self, + user_id: StrictStr, + json_api_api_token_in_document: JsonApiApiTokenInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiApiTokenOutDocument]: + """Post a new API token for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_api_token_in_document: (required) + :type json_api_api_token_in_document: JsonApiApiTokenInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_api_tokens_serialize( + user_id=user_id, + json_api_api_token_in_document=json_api_api_token_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_api_tokens_without_preload_content( + self, + user_id: StrictStr, + json_api_api_token_in_document: JsonApiApiTokenInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post a new API token for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_api_token_in_document: (required) + :type json_api_api_token_in_document: JsonApiApiTokenInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_api_tokens_serialize( + user_id=user_id, + json_api_api_token_in_document=json_api_api_token_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_api_tokens_serialize( self, user_id, json_api_api_token_in_document, - **kwargs - ): - """Post a new API token for the user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_api_tokens(user_id, json_api_api_token_in_document, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - json_api_api_token_in_document (JsonApiApiTokenInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiApiTokenOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['json_api_api_token_in_document'] = \ - json_api_api_token_in_document - return self.create_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_api_token_in_document is not None: + _body_params = json_api_api_token_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/users/{userId}/apiTokens', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_api_tokens( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_api_tokens_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_api_tokens_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_api_tokens_serialize( self, user_id, id, - **kwargs - ): - """Delete an API Token for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_api_tokens(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.delete_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/users/{userId}/apiTokens/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_api_tokens( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiApiTokenOutList: + """List all api tokens for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_api_tokens_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_api_tokens_with_http_info( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiApiTokenOutList]: + """List all api tokens for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_api_tokens_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_api_tokens_without_preload_content( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """List all api tokens for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_api_tokens_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_api_tokens_serialize( self, user_id, - **kwargs - ): - """List all api tokens for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_api_tokens(user_id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiApiTokenOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_api_tokens_endpoint.call_with_http_info(**kwargs) + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/apiTokens', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_api_tokens( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiApiTokenOutDocument: + """Get an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_api_tokens_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiApiTokenOutDocument]: + """Get an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_api_tokens_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_api_tokens_serialize( self, user_id, id, - **kwargs - ): - """Get an API Token for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_api_tokens(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiApiTokenOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.get_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/apiTokens/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/appearance_api.py b/gooddata-api-client/gooddata_api_client/api/appearance_api.py index 34c1e7d72..36799871f 100644 --- a/gooddata-api-client/gooddata_api_client/api/appearance_api.py +++ b/gooddata-api-client/gooddata_api_client/api/appearance_api.py @@ -1,1826 +1,3535 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - + Generated by OpenAPI Generator (https://openapi-generator.tech) -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument - - -class AppearanceApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class AppearanceApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes', - 'operation_id': 'create_entity_color_palettes', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_color_palette_in_document', - ], - 'required': [ - 'json_api_color_palette_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_color_palette_in_document': - (JsonApiColorPaletteInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_color_palette_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes', - 'operation_id': 'create_entity_themes', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_theme_in_document', - ], - 'required': [ - 'json_api_theme_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_theme_in_document': - (JsonApiThemeInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_theme_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'delete_entity_color_palettes', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'delete_entity_themes', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes', - 'operation_id': 'get_all_entities_color_palettes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes', - 'operation_id': 'get_all_entities_themes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'get_entity_color_palettes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'get_entity_themes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'patch_entity_color_palettes', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_color_palette_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_color_palette_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_color_palette_patch_document': - (JsonApiColorPalettePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_color_palette_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'patch_entity_themes', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_theme_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_theme_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_theme_patch_document': - (JsonApiThemePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_theme_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'update_entity_color_palettes', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_color_palette_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_color_palette_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_color_palette_in_document': - (JsonApiColorPaletteInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_color_palette_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'update_entity_themes', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_theme_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_theme_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_theme_in_document': - (JsonApiThemeInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_theme_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_color_palettes( + self, + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Post Color Pallettes + + + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_color_palettes_serialize( + json_api_color_palette_in_document=json_api_color_palette_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_color_palettes_with_http_info( + self, + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Post Color Pallettes + + + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_color_palettes_serialize( + json_api_color_palette_in_document=json_api_color_palette_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_color_palettes_without_preload_content( + self, + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Color Pallettes + + + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_color_palettes_serialize( + json_api_color_palette_in_document=json_api_color_palette_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_color_palettes_serialize( self, json_api_color_palette_in_document, - **kwargs - ): - """Post Color Pallettes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_color_palettes(json_api_color_palette_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_color_palette_in_document (JsonApiColorPaletteInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_color_palette_in_document'] = \ - json_api_color_palette_in_document - return self.create_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_color_palette_in_document is not None: + _body_params = json_api_color_palette_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/colorPalettes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_themes( + self, + json_api_theme_in_document: JsonApiThemeInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Post Theming + + + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_themes_serialize( + json_api_theme_in_document=json_api_theme_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_themes_with_http_info( + self, + json_api_theme_in_document: JsonApiThemeInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Post Theming + + + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_themes_serialize( + json_api_theme_in_document=json_api_theme_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_themes_without_preload_content( + self, + json_api_theme_in_document: JsonApiThemeInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Theming + + + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_themes_serialize( + json_api_theme_in_document=json_api_theme_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_themes_serialize( self, json_api_theme_in_document, - **kwargs - ): - """Post Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_themes(json_api_theme_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_theme_in_document (JsonApiThemeInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_theme_in_document'] = \ - json_api_theme_in_document - return self.create_entity_themes_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_theme_in_document is not None: + _body_params = json_api_theme_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/themes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_color_palettes( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_color_palettes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_color_palettes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_color_palettes_serialize( self, id, - **kwargs - ): - """Delete a Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_color_palettes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_themes_serialize( self, id, - **kwargs - ): - """Delete Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_themes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_themes_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_color_palettes( self, - **kwargs - ): - """Get all Color Pallettes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_color_palettes(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_color_palettes_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutList: + """Get all Color Pallettes + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_color_palettes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_color_palettes_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutList]: + """Get all Color Pallettes + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_color_palettes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_color_palettes_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Color Pallettes + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_color_palettes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_color_palettes_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/colorPalettes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_themes( self, - **kwargs - ): - """Get all Theming entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_themes(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_themes_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutList: + """Get all Theming entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_themes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_themes_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutList]: + """Get all Theming entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_themes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_themes_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Theming entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_themes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_themes_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/themes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_color_palettes( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Get Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_color_palettes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Get Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_color_palettes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_color_palettes_serialize( self, id, - **kwargs - ): - """Get Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_color_palettes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Get Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Get Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_themes_serialize( self, id, - **kwargs - ): - """Get Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_themes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_themes_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def patch_entity_color_palettes( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Patch Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_patch_document: (required) + :type json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_color_palettes_serialize( + id=id, + json_api_color_palette_patch_document=json_api_color_palette_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_color_palettes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Patch Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_patch_document: (required) + :type json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_color_palettes_serialize( + id=id, + json_api_color_palette_patch_document=json_api_color_palette_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_color_palettes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_patch_document: (required) + :type json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_color_palettes_serialize( + id=id, + json_api_color_palette_patch_document=json_api_color_palette_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_color_palettes_serialize( self, id, json_api_color_palette_patch_document, - **kwargs - ): - """Patch Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_color_palettes(id, json_api_color_palette_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_color_palette_patch_document (JsonApiColorPalettePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_color_palette_patch_document'] = \ - json_api_color_palette_patch_document - return self.patch_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_color_palette_patch_document is not None: + _body_params = json_api_color_palette_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_patch_document: JsonApiThemePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Patch Theming + + + :param id: (required) + :type id: str + :param json_api_theme_patch_document: (required) + :type json_api_theme_patch_document: JsonApiThemePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_themes_serialize( + id=id, + json_api_theme_patch_document=json_api_theme_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_patch_document: JsonApiThemePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Patch Theming + + + :param id: (required) + :type id: str + :param json_api_theme_patch_document: (required) + :type json_api_theme_patch_document: JsonApiThemePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_themes_serialize( + id=id, + json_api_theme_patch_document=json_api_theme_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_patch_document: JsonApiThemePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Theming + + + :param id: (required) + :type id: str + :param json_api_theme_patch_document: (required) + :type json_api_theme_patch_document: JsonApiThemePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_themes_serialize( + id=id, + json_api_theme_patch_document=json_api_theme_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_themes_serialize( self, id, json_api_theme_patch_document, - **kwargs - ): - """Patch Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_themes(id, json_api_theme_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_theme_patch_document (JsonApiThemePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_theme_patch_document'] = \ - json_api_theme_patch_document - return self.patch_entity_themes_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_theme_patch_document is not None: + _body_params = json_api_theme_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_color_palettes( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Put Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_color_palettes_serialize( + id=id, + json_api_color_palette_in_document=json_api_color_palette_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_color_palettes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Put Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_color_palettes_serialize( + id=id, + json_api_color_palette_in_document=json_api_color_palette_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_color_palettes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_color_palettes_serialize( + id=id, + json_api_color_palette_in_document=json_api_color_palette_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_color_palettes_serialize( self, id, json_api_color_palette_in_document, - **kwargs - ): - """Put Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_color_palettes(id, json_api_color_palette_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_color_palette_in_document (JsonApiColorPaletteInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_color_palette_in_document'] = \ - json_api_color_palette_in_document - return self.update_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_color_palette_in_document is not None: + _body_params = json_api_color_palette_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_in_document: JsonApiThemeInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Put Theming + + + :param id: (required) + :type id: str + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_themes_serialize( + id=id, + json_api_theme_in_document=json_api_theme_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_in_document: JsonApiThemeInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Put Theming + + + :param id: (required) + :type id: str + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_themes_serialize( + id=id, + json_api_theme_in_document=json_api_theme_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_in_document: JsonApiThemeInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Theming + + + :param id: (required) + :type id: str + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_themes_serialize( + id=id, + json_api_theme_in_document=json_api_theme_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_themes_serialize( self, id, json_api_theme_in_document, - **kwargs - ): - """Put Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_themes(id, json_api_theme_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_theme_in_document (JsonApiThemeInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_theme_in_document'] = \ - json_api_theme_in_document - return self.update_entity_themes_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_theme_in_document is not None: + _body_params = json_api_theme_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py b/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py index f18c58fbd..c84680c8c 100644 --- a/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py +++ b/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py @@ -1,1108 +1,2050 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.models.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList -from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class AttributeHierarchiesApi(object): +class AttributeHierarchiesApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', - 'operation_id': 'create_entity_attribute_hierarchies', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_attribute_hierarchy_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_attribute_hierarchy_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_attribute_hierarchy_in_document': - (JsonApiAttributeHierarchyInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_attribute_hierarchy_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Post Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.delete_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'delete_entity_attribute_hierarchies', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.get_all_entities_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', - 'operation_id': 'get_all_entities_attribute_hierarchies', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Post Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.get_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'get_entity_attribute_hierarchies', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.patch_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'patch_entity_attribute_hierarchies', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_attribute_hierarchy_patch_document': - (JsonApiAttributeHierarchyPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_attribute_hierarchy_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - self.update_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'update_entity_attribute_hierarchies', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_attribute_hierarchy_in_document': - (JsonApiAttributeHierarchyInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_attribute_hierarchy_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - def create_entity_attribute_hierarchies( + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_attribute_hierarchies_serialize( self, workspace_id, json_api_attribute_hierarchy_in_document, - **kwargs - ): - """Post Attribute Hierarchies # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_attribute_hierarchy_in_document is not None: + _body_params = json_api_attribute_hierarchy_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def delete_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_attribute_hierarchy_in_document'] = \ - json_api_attribute_hierarchy_in_document - return self.create_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + return response_data.response - def delete_entity_attribute_hierarchies( + + def _delete_entity_attribute_hierarchies_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_all_entities_attribute_hierarchies( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutList: + """Get all Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attribute_hierarchies_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutList]: + """Get all Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attribute_hierarchies_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_all_entities_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attribute_hierarchies_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def get_all_entities_attribute_hierarchies( + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_attribute_hierarchies_serialize( self, workspace_id, - **kwargs - ): - """Get all Attribute Hierarchies # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_attribute_hierarchies(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Get an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Get an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_attribute_hierarchies( + + def _get_entity_attribute_hierarchies_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def patch_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Patch an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_patch_document: (required) + :type json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_patch_document=json_api_attribute_hierarchy_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Patch an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_patch_document: (required) + :type json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_patch_document=json_api_attribute_hierarchy_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_patch_document: (required) + :type json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_patch_document=json_api_attribute_hierarchy_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + return response_data.response - def patch_entity_attribute_hierarchies( + + def _patch_entity_attribute_hierarchies_serialize( self, workspace_id, object_id, json_api_attribute_hierarchy_patch_document, - **kwargs - ): - """Patch an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_attribute_hierarchy_patch_document (JsonApiAttributeHierarchyPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_attribute_hierarchy_patch_document is not None: + _body_params = json_api_attribute_hierarchy_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def update_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Put an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Put an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def update_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_attribute_hierarchy_patch_document'] = \ - json_api_attribute_hierarchy_patch_document - return self.patch_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + return response_data.response - def update_entity_attribute_hierarchies( + + def _update_entity_attribute_hierarchies_serialize( self, workspace_id, object_id, json_api_attribute_hierarchy_in_document, - **kwargs - ): - """Put an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_attribute_hierarchy_in_document is not None: + _body_params = json_api_attribute_hierarchy_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_attribute_hierarchy_in_document'] = \ - json_api_attribute_hierarchy_in_document - return self.update_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/attributes_api.py b/gooddata-api-client/gooddata_api_client/api/attributes_api.py index 6ecf2a5f8..ad9129955 100644 --- a/gooddata-api-client/gooddata_api_client/api/attributes_api.py +++ b/gooddata-api-client/gooddata_api_client/api/attributes_api.py @@ -1,439 +1,775 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class AttributesApi(object): +class AttributesApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_all_entities_attributes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes', - 'operation_id': 'get_all_entities_attributes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "DATASETS": "datasets", - "LABELS": "labels", - "ATTRIBUTEHIERARCHIES": "attributeHierarchies", - "DATASET": "dataset", - "DEFAULTVIEW": "defaultView", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_attributes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}', - 'operation_id': 'get_entity_attributes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "LABELS": "labels", - "ATTRIBUTEHIERARCHIES": "attributeHierarchies", - "DATASET": "dataset", - "DEFAULTVIEW": "defaultView", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def get_all_entities_attributes( self, - workspace_id, - **kwargs - ): - """Get all Attributes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_attributes(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeOutList: + """Get all Attributes + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attributes_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_attributes_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeOutList]: + """Get all Attributes + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attributes_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_all_entities_attributes_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Attributes + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attributes_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_attributes_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_attributes( + + def _get_all_entities_attributes_serialize( self, workspace_id, - object_id, - **kwargs - ): - """Get an Attribute # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_attributes(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_entity_attributes( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeOutDocument: + """Get an Attribute + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attributes_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_attributes_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeOutDocument]: + """Get an Attribute + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attributes_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_entity_attributes_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Attribute + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attributes_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_attributes_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _get_entity_attributes_serialize( + self, + workspace_id, + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/automation_organization_view_controller_api.py b/gooddata-api-client/gooddata_api_client/api/automation_organization_view_controller_api.py index bc02803e3..faadea0f4 100644 --- a/gooddata-api-client/gooddata_api_client/api/automation_organization_view_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/automation_organization_view_controller_api.py @@ -1,226 +1,387 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class AutomationOrganizationViewControllerApi(object): +class AutomationOrganizationViewControllerApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_all_automations_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceAutomationOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organization/workspaceAutomations', - 'operation_id': 'get_all_automations_workspace_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "WORKSPACE": "workspace", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def get_all_automations_workspace_automations( self, - **kwargs - ): - """Get all Automations across all Workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_automations_workspace_automations(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceAutomationOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceAutomationOutList: + """Get all Automations across all Workspaces + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_automations_workspace_automations_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_automations_workspace_automations_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceAutomationOutList]: + """Get all Automations across all Workspaces + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_automations_workspace_automations_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def get_all_automations_workspace_automations_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Automations across all Workspaces + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_automations_workspace_automations_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _get_all_automations_workspace_automations_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/organization/workspaceAutomations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_automations_workspace_automations_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/automations_api.py b/gooddata-api-client/gooddata_api_client/api/automations_api.py index 121846d97..be59c8094 100644 --- a/gooddata-api-client/gooddata_api_client/api/automations_api.py +++ b/gooddata-api-client/gooddata_api_client/api/automations_api.py @@ -1,3366 +1,6425 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_automation import DeclarativeAutomation -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList -from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument -from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList -from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest -from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest -from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest - - -class AutomationsApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_automation import DeclarativeAutomation +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.models.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.models.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.trigger_automation_request import TriggerAutomationRequest +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class AutomationsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations', - 'operation_id': 'create_entity_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_automation_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_automation_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_automation_in_document': - (JsonApiAutomationInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_automation_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'delete_entity_automations', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_organization_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/delete', - 'operation_id': 'delete_organization_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'organization_automation_management_bulk_request', - ], - 'required': [ - 'organization_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'organization_automation_management_bulk_request': - (OrganizationAutomationManagementBulkRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'organization_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.delete_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/delete', - 'operation_id': 'delete_workspace_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'required': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'workspace_automation_management_bulk_request': - (WorkspaceAutomationManagementBulkRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'workspace_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.get_all_automations_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceAutomationOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organization/workspaceAutomations', - 'operation_id': 'get_all_automations_workspace_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "WORKSPACE": "workspace", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations', - 'operation_id': 'get_all_entities_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_automations_endpoint = _Endpoint( - settings={ - 'response_type': ([DeclarativeAutomation],), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/automations', - 'operation_id': 'get_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'exclude', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'exclude': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'exclude': 'exclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'get_entity_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'patch_entity_automations', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_automation_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_automation_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_automation_patch_document': - (JsonApiAutomationPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_automation_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.pause_organization_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/pause', - 'operation_id': 'pause_organization_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'organization_automation_management_bulk_request', - ], - 'required': [ - 'organization_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'organization_automation_management_bulk_request': - (OrganizationAutomationManagementBulkRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'organization_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.pause_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/pause', - 'operation_id': 'pause_workspace_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'required': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'workspace_automation_management_bulk_request': - (WorkspaceAutomationManagementBulkRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'workspace_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/automations', - 'operation_id': 'set_automations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_automation', - ], - 'required': [ - 'workspace_id', - 'declarative_automation', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_automation': - ([DeclarativeAutomation],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_automation': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.trigger_automation_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/trigger', - 'operation_id': 'trigger_automation', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'trigger_automation_request', - ], - 'required': [ - 'workspace_id', - 'trigger_automation_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'trigger_automation_request': - (TriggerAutomationRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'trigger_automation_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.trigger_existing_automation_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger', - 'operation_id': 'trigger_existing_automation', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'automation_id', - ], - 'required': [ - 'workspace_id', - 'automation_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'automation_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'automation_id': 'automationId', - }, - 'location_map': { - 'workspace_id': 'path', - 'automation_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.unpause_organization_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/unpause', - 'operation_id': 'unpause_organization_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'organization_automation_management_bulk_request', - ], - 'required': [ - 'organization_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'organization_automation_management_bulk_request': - (OrganizationAutomationManagementBulkRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'organization_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.unpause_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unpause', - 'operation_id': 'unpause_workspace_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'required': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'workspace_automation_management_bulk_request': - (WorkspaceAutomationManagementBulkRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'workspace_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.unsubscribe_all_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/unsubscribe', - 'operation_id': 'unsubscribe_all_automations', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.unsubscribe_automation_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe', - 'operation_id': 'unsubscribe_automation', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'automation_id', - ], - 'required': [ - 'workspace_id', - 'automation_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'automation_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'automation_id': 'automationId', - }, - 'location_map': { - 'workspace_id': 'path', - 'automation_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.unsubscribe_organization_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/unsubscribe', - 'operation_id': 'unsubscribe_organization_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'organization_automation_management_bulk_request', - ], - 'required': [ - 'organization_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'organization_automation_management_bulk_request': - (OrganizationAutomationManagementBulkRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'organization_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.unsubscribe_selected_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', - 'operation_id': 'unsubscribe_selected_workspace_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'required': [ - 'workspace_id', - 'workspace_automation_management_bulk_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'workspace_automation_management_bulk_request': - (WorkspaceAutomationManagementBulkRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'workspace_automation_management_bulk_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.unsubscribe_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', - 'operation_id': 'unsubscribe_workspace_automations', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.update_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'update_entity_automations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_automation_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_automation_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_automation_in_document': - (JsonApiAutomationInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_automation_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_automations( + self, + workspace_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Post Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_automations_serialize( + workspace_id=workspace_id, + json_api_automation_in_document=json_api_automation_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Post Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_automations_serialize( + workspace_id=workspace_id, + json_api_automation_in_document=json_api_automation_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_automations_serialize( + workspace_id=workspace_id, + json_api_automation_in_document=json_api_automation_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_automations_serialize( self, workspace_id, json_api_automation_in_document, - **kwargs - ): - """Post Automations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_automations(workspace_id, json_api_automation_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.create_entity_automations_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_automation_in_document is not None: + _body_params = json_api_automation_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_automations_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_automations(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_automations_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_organization_automations( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_organization_automations_with_http_info( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_organization_automations_without_preload_content( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_organization_automations_serialize( self, organization_automation_management_bulk_request, - **kwargs - ): - """Delete selected automations across all workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_organization_automations(organization_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['organization_automation_management_bulk_request'] = \ - organization_automation_management_bulk_request - return self.delete_organization_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if organization_automation_management_bulk_request is not None: + _body_params = organization_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/automations/delete', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_workspace_automations( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_workspace_automations_with_http_info( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_workspace_automations_without_preload_content( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_workspace_automations_serialize( self, workspace_id, workspace_automation_management_bulk_request, - **kwargs - ): - """Delete selected automations in the workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['workspace_automation_management_bulk_request'] = \ - workspace_automation_management_bulk_request - return self.delete_workspace_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if workspace_automation_management_bulk_request is not None: + _body_params = workspace_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/delete', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_automations_workspace_automations( self, - **kwargs - ): - """Get all Automations across all Workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_automations_workspace_automations(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceAutomationOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_automations_workspace_automations_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceAutomationOutList: + """Get all Automations across all Workspaces + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_automations_workspace_automations_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_automations_workspace_automations_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceAutomationOutList]: + """Get all Automations across all Workspaces + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_automations_workspace_automations_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_automations_workspace_automations_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Automations across all Workspaces + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_automations_workspace_automations_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_automations_workspace_automations_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/organization/workspaceAutomations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_automations( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutList: + """Get all Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_automations_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_automations_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutList]: + """Get all Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_automations_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_automations_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_automations_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_automations_serialize( self, workspace_id, - **kwargs - ): - """Get all Automations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_automations(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_automations_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_automations( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DeclarativeAutomation]: + """Get automations + + Retrieve automations for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_automations_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeAutomation]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_automations_with_http_info( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DeclarativeAutomation]]: + """Get automations + + Retrieve automations for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_automations_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeAutomation]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_automations_without_preload_content( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get automations + + Retrieve automations for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_automations_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeAutomation]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_automations_serialize( self, workspace_id, - **kwargs - ): - """Get automations # noqa: E501 - - Retrieve automations for the specific workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_automations(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [DeclarativeAutomation] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_automations_endpoint.call_with_http_info(**kwargs) + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/automations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Get an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Get an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_automations_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_automations(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_automations_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def patch_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_patch_document: JsonApiAutomationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Patch an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_patch_document: (required) + :type json_api_automation_patch_document: JsonApiAutomationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_patch_document=json_api_automation_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_patch_document: JsonApiAutomationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Patch an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_patch_document: (required) + :type json_api_automation_patch_document: JsonApiAutomationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_patch_document=json_api_automation_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_patch_document: JsonApiAutomationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_patch_document: (required) + :type json_api_automation_patch_document: JsonApiAutomationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_patch_document=json_api_automation_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_automations_serialize( self, workspace_id, object_id, json_api_automation_patch_document, - **kwargs - ): - """Patch an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_automation_patch_document (JsonApiAutomationPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_automation_patch_document'] = \ - json_api_automation_patch_document - return self.patch_entity_automations_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_automation_patch_document is not None: + _body_params = json_api_automation_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def pause_organization_automations( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Pause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def pause_organization_automations_with_http_info( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Pause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def pause_organization_automations_without_preload_content( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Pause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _pause_organization_automations_serialize( self, organization_automation_management_bulk_request, - **kwargs - ): - """Pause selected automations across all workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.pause_organization_automations(organization_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['organization_automation_management_bulk_request'] = \ - organization_automation_management_bulk_request - return self.pause_organization_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if organization_automation_management_bulk_request is not None: + _body_params = organization_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/automations/pause', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def pause_workspace_automations( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Pause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def pause_workspace_automations_with_http_info( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Pause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def pause_workspace_automations_without_preload_content( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Pause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._pause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _pause_workspace_automations_serialize( self, workspace_id, workspace_automation_management_bulk_request, - **kwargs - ): - """Pause selected automations in the workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.pause_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['workspace_automation_management_bulk_request'] = \ - workspace_automation_management_bulk_request - return self.pause_workspace_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if workspace_automation_management_bulk_request is not None: + _body_params = workspace_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/pause', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_automations( + self, + workspace_id: StrictStr, + declarative_automation: List[DeclarativeAutomation], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set automations + + Set automations for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_automation: (required) + :type declarative_automation: List[DeclarativeAutomation] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_automations_serialize( + workspace_id=workspace_id, + declarative_automation=declarative_automation, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_automations_with_http_info( + self, + workspace_id: StrictStr, + declarative_automation: List[DeclarativeAutomation], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set automations + + Set automations for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_automation: (required) + :type declarative_automation: List[DeclarativeAutomation] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_automations_serialize( + workspace_id=workspace_id, + declarative_automation=declarative_automation, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_automations_without_preload_content( + self, + workspace_id: StrictStr, + declarative_automation: List[DeclarativeAutomation], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set automations + + Set automations for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_automation: (required) + :type declarative_automation: List[DeclarativeAutomation] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_automations_serialize( + workspace_id=workspace_id, + declarative_automation=declarative_automation, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_automations_serialize( self, workspace_id, declarative_automation, - **kwargs - ): - """Set automations # noqa: E501 - - Set automations for the specific workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_automations(workspace_id, declarative_automation, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_automation ([DeclarativeAutomation]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_automation'] = \ - declarative_automation - return self.set_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'DeclarativeAutomation': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_automation is not None: + _body_params = declarative_automation + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/automations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def trigger_automation( + self, + workspace_id: StrictStr, + trigger_automation_request: TriggerAutomationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Trigger automation. + + Trigger the automation in the request. + + :param workspace_id: (required) + :type workspace_id: str + :param trigger_automation_request: (required) + :type trigger_automation_request: TriggerAutomationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_automation_serialize( + workspace_id=workspace_id, + trigger_automation_request=trigger_automation_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def trigger_automation_with_http_info( + self, + workspace_id: StrictStr, + trigger_automation_request: TriggerAutomationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Trigger automation. + + Trigger the automation in the request. + + :param workspace_id: (required) + :type workspace_id: str + :param trigger_automation_request: (required) + :type trigger_automation_request: TriggerAutomationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_automation_serialize( + workspace_id=workspace_id, + trigger_automation_request=trigger_automation_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def trigger_automation_without_preload_content( + self, + workspace_id: StrictStr, + trigger_automation_request: TriggerAutomationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Trigger automation. + + Trigger the automation in the request. + + :param workspace_id: (required) + :type workspace_id: str + :param trigger_automation_request: (required) + :type trigger_automation_request: TriggerAutomationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_automation_serialize( + workspace_id=workspace_id, + trigger_automation_request=trigger_automation_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _trigger_automation_serialize( self, workspace_id, trigger_automation_request, - **kwargs - ): - """Trigger automation. # noqa: E501 - - Trigger the automation in the request. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.trigger_automation(workspace_id, trigger_automation_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - trigger_automation_request (TriggerAutomationRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['trigger_automation_request'] = \ - trigger_automation_request - return self.trigger_automation_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if trigger_automation_request is not None: + _body_params = trigger_automation_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/trigger', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def trigger_existing_automation( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Trigger existing automation. + + Trigger the existing automation to execute immediately. + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_existing_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def trigger_existing_automation_with_http_info( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Trigger existing automation. + + Trigger the existing automation to execute immediately. + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_existing_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def trigger_existing_automation_without_preload_content( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Trigger existing automation. + + Trigger the existing automation to execute immediately. + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._trigger_existing_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _trigger_existing_automation_serialize( self, workspace_id, automation_id, - **kwargs - ): - """Trigger existing automation. # noqa: E501 - - Trigger the existing automation to execute immediately. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.trigger_existing_automation(workspace_id, automation_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - automation_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['automation_id'] = \ - automation_id - return self.trigger_existing_automation_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if automation_id is not None: + _path_params['automationId'] = automation_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def unpause_organization_automations( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unpause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unpause_organization_automations_with_http_info( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unpause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unpause_organization_automations_without_preload_content( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unpause selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unpause_organization_automations_serialize( self, organization_automation_management_bulk_request, - **kwargs - ): - """Unpause selected automations across all workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unpause_organization_automations(organization_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['organization_automation_management_bulk_request'] = \ - organization_automation_management_bulk_request - return self.unpause_organization_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if organization_automation_management_bulk_request is not None: + _body_params = organization_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/automations/unpause', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def unpause_workspace_automations( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unpause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unpause_workspace_automations_with_http_info( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unpause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unpause_workspace_automations_without_preload_content( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unpause selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unpause_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unpause_workspace_automations_serialize( self, workspace_id, workspace_automation_management_bulk_request, - **kwargs - ): - """Unpause selected automations in the workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unpause_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['workspace_automation_management_bulk_request'] = \ - workspace_automation_management_bulk_request - return self.unpause_workspace_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if workspace_automation_management_bulk_request is not None: + _body_params = workspace_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/unpause', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def unsubscribe_all_automations( self, - **kwargs - ): - """Unsubscribe from all automations in all workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unsubscribe_all_automations(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.unsubscribe_all_automations_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unsubscribe from all automations in all workspaces + + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_all_automations_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unsubscribe_all_automations_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unsubscribe from all automations in all workspaces + + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_all_automations_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unsubscribe_all_automations_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsubscribe from all automations in all workspaces + + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_all_automations_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unsubscribe_all_automations_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/actions/organization/automations/unsubscribe', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def unsubscribe_automation( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unsubscribe from an automation + + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unsubscribe_automation_with_http_info( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unsubscribe from an automation + + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unsubscribe_automation_without_preload_content( + self, + workspace_id: StrictStr, + automation_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsubscribe from an automation + + + :param workspace_id: (required) + :type workspace_id: str + :param automation_id: (required) + :type automation_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_automation_serialize( + workspace_id=workspace_id, + automation_id=automation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unsubscribe_automation_serialize( self, workspace_id, automation_id, - **kwargs - ): - """Unsubscribe from an automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unsubscribe_automation(workspace_id, automation_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - automation_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['automation_id'] = \ - automation_id - return self.unsubscribe_automation_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if automation_id is not None: + _path_params['automationId'] = automation_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def unsubscribe_organization_automations( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unsubscribe from selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unsubscribe_organization_automations_with_http_info( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unsubscribe from selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unsubscribe_organization_automations_without_preload_content( + self, + organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsubscribe from selected automations across all workspaces + + + :param organization_automation_management_bulk_request: (required) + :type organization_automation_management_bulk_request: OrganizationAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_organization_automations_serialize( + organization_automation_management_bulk_request=organization_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unsubscribe_organization_automations_serialize( self, organization_automation_management_bulk_request, - **kwargs - ): - """Unsubscribe from selected automations across all workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unsubscribe_organization_automations(organization_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['organization_automation_management_bulk_request'] = \ - organization_automation_management_bulk_request - return self.unsubscribe_organization_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if organization_automation_management_bulk_request is not None: + _body_params = organization_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/automations/unsubscribe', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def unsubscribe_selected_workspace_automations( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unsubscribe from selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_selected_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unsubscribe_selected_workspace_automations_with_http_info( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unsubscribe from selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_selected_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unsubscribe_selected_workspace_automations_without_preload_content( + self, + workspace_id: StrictStr, + workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsubscribe from selected automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_automation_management_bulk_request: (required) + :type workspace_automation_management_bulk_request: WorkspaceAutomationManagementBulkRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_selected_workspace_automations_serialize( + workspace_id=workspace_id, + workspace_automation_management_bulk_request=workspace_automation_management_bulk_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unsubscribe_selected_workspace_automations_serialize( self, workspace_id, workspace_automation_management_bulk_request, - **kwargs - ): - """Unsubscribe from selected automations in the workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unsubscribe_selected_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['workspace_automation_management_bulk_request'] = \ - workspace_automation_management_bulk_request - return self.unsubscribe_selected_workspace_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if workspace_automation_management_bulk_request is not None: + _body_params = workspace_automation_management_bulk_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def unsubscribe_workspace_automations( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Unsubscribe from all automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_workspace_automations_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def unsubscribe_workspace_automations_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Unsubscribe from all automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_workspace_automations_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def unsubscribe_workspace_automations_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsubscribe from all automations in the workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._unsubscribe_workspace_automations_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _unsubscribe_workspace_automations_serialize( self, workspace_id, - **kwargs - ): - """Unsubscribe from all automations in the workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.unsubscribe_workspace_automations(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.unsubscribe_workspace_automations_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Put an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_in_document=json_api_automation_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Put an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_in_document=json_api_automation_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_in_document=json_api_automation_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_automations_serialize( self, workspace_id, object_id, json_api_automation_in_document, - **kwargs - ): - """Put an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.update_entity_automations_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_automation_in_document is not None: + _body_params = json_api_automation_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/available_drivers_api.py b/gooddata-api-client/gooddata_api_client/api/available_drivers_api.py index 7b0c2d7bc..f56b14b1c 100644 --- a/gooddata-api-client/gooddata_api_client/api/available_drivers_api.py +++ b/gooddata-api-client/gooddata_api_client/api/available_drivers_api.py @@ -1,158 +1,283 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictStr +from typing import Dict -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class AvailableDriversApi(object): +class AvailableDriversApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_data_source_drivers_endpoint = _Endpoint( - settings={ - 'response_type': ({str: (str,)},), - 'auth': [], - 'endpoint_path': '/api/v1/options/availableDrivers', - 'operation_id': 'get_data_source_drivers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def get_data_source_drivers( self, - **kwargs - ): - """Get all available data source drivers # noqa: E501 - - Retrieves a list of all supported data sources along with information about the used drivers. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_data_source_drivers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - {str: (str,)} - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> Dict[str, str]: + """Get all available data source drivers + + Retrieves a list of all supported data sources along with information about the used drivers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_drivers_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Dict[str, str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_source_drivers_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[Dict[str, str]]: + """Get all available data source drivers + + Retrieves a list of all supported data sources along with information about the used drivers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_drivers_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Dict[str, str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def get_data_source_drivers_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all available data source drivers + + Retrieves a list of all supported data sources along with information about the used drivers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_drivers_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Dict[str, str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _get_data_source_drivers_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/options/availableDrivers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_data_source_drivers_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/computation_api.py b/gooddata-api-client/gooddata_api_client/api/computation_api.py index 7d2d77d14..35c1bb870 100644 --- a/gooddata-api-client/gooddata_api_client/api/computation_api.py +++ b/gooddata-api-client/gooddata_api_client/api/computation_api.py @@ -1,1654 +1,3112 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.afm_execution import AfmExecution -from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse -from gooddata_api_client.model.afm_valid_descendants_query import AfmValidDescendantsQuery -from gooddata_api_client.model.afm_valid_descendants_response import AfmValidDescendantsResponse -from gooddata_api_client.model.afm_valid_objects_query import AfmValidObjectsQuery -from gooddata_api_client.model.afm_valid_objects_response import AfmValidObjectsResponse -from gooddata_api_client.model.column_statistics_request import ColumnStatisticsRequest -from gooddata_api_client.model.column_statistics_response import ColumnStatisticsResponse -from gooddata_api_client.model.elements_request import ElementsRequest -from gooddata_api_client.model.elements_response import ElementsResponse -from gooddata_api_client.model.execution_result import ExecutionResult -from gooddata_api_client.model.key_drivers_request import KeyDriversRequest -from gooddata_api_client.model.key_drivers_response import KeyDriversResponse -from gooddata_api_client.model.key_drivers_result import KeyDriversResult -from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata - - -class ComputationApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution_response import AfmExecutionResponse +from gooddata_api_client.models.afm_valid_descendants_query import AfmValidDescendantsQuery +from gooddata_api_client.models.afm_valid_descendants_response import AfmValidDescendantsResponse +from gooddata_api_client.models.afm_valid_objects_query import AfmValidObjectsQuery +from gooddata_api_client.models.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.models.column_statistics_request import ColumnStatisticsRequest +from gooddata_api_client.models.column_statistics_response import ColumnStatisticsResponse +from gooddata_api_client.models.elements_request import ElementsRequest +from gooddata_api_client.models.elements_response import ElementsResponse +from gooddata_api_client.models.execution_result import ExecutionResult +from gooddata_api_client.models.key_drivers_request import KeyDriversRequest +from gooddata_api_client.models.key_drivers_response import KeyDriversResponse +from gooddata_api_client.models.key_drivers_result import KeyDriversResult +from gooddata_api_client.models.result_cache_metadata import ResultCacheMetadata + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class ComputationApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.column_statistics_endpoint = _Endpoint( - settings={ - 'response_type': (ColumnStatisticsResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/computeColumnStatistics', - 'operation_id': 'column_statistics', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'column_statistics_request', - ], - 'required': [ - 'data_source_id', - 'column_statistics_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'column_statistics_request': - (ColumnStatisticsRequest,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'column_statistics_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.compute_label_elements_post_endpoint = _Endpoint( - settings={ - 'response_type': (ElementsResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements', - 'operation_id': 'compute_label_elements_post', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'elements_request', - 'offset', - 'limit', - 'skip_cache', - ], - 'required': [ - 'workspace_id', - 'elements_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - 'offset', - 'limit', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('offset',): { - - 'inclusive_maximum': 10000, - 'inclusive_minimum': 0, - }, - ('limit',): { - - 'inclusive_maximum': 10000, - 'inclusive_minimum': 1, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'elements_request': - (ElementsRequest,), - 'offset': - (int,), - 'limit': - (int,), - 'skip_cache': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'offset': 'offset', - 'limit': 'limit', - 'skip_cache': 'skip-cache', - }, - 'location_map': { - 'workspace_id': 'path', - 'elements_request': 'body', - 'offset': 'query', - 'limit': 'query', - 'skip_cache': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.compute_report_endpoint = _Endpoint( - settings={ - 'response_type': (AfmExecutionResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute', - 'operation_id': 'compute_report', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'afm_execution', - 'skip_cache', - 'timestamp', - ], - 'required': [ - 'workspace_id', - 'afm_execution', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'afm_execution': - (AfmExecution,), - 'skip_cache': - (bool,), - 'timestamp': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'skip_cache': 'skip-cache', - 'timestamp': 'timestamp', - }, - 'location_map': { - 'workspace_id': 'path', - 'afm_execution': 'body', - 'skip_cache': 'header', - 'timestamp': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.compute_valid_descendants_endpoint = _Endpoint( - settings={ - 'response_type': (AfmValidDescendantsResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants', - 'operation_id': 'compute_valid_descendants', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'afm_valid_descendants_query', - ], - 'required': [ - 'workspace_id', - 'afm_valid_descendants_query', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'afm_valid_descendants_query': - (AfmValidDescendantsQuery,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'afm_valid_descendants_query': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.compute_valid_objects_endpoint = _Endpoint( - settings={ - 'response_type': (AfmValidObjectsResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects', - 'operation_id': 'compute_valid_objects', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'afm_valid_objects_query', - ], - 'required': [ - 'workspace_id', - 'afm_valid_objects_query', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'afm_valid_objects_query': - (AfmValidObjectsQuery,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'afm_valid_objects_query': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.explain_afm_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain', - 'operation_id': 'explain_afm', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'afm_execution', - 'explain_type', - ], - 'required': [ - 'workspace_id', - 'afm_execution', - ], - 'nullable': [ - ], - 'enum': [ - 'explain_type', - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('explain_type',): { - - "MAQL": "MAQL", - "GRPC_MODEL": "GRPC_MODEL", - "GRPC_MODEL_SVG": "GRPC_MODEL_SVG", - "WDF": "WDF", - "QT": "QT", - "QT_SVG": "QT_SVG", - "OPT_QT": "OPT_QT", - "OPT_QT_SVG": "OPT_QT_SVG", - "SQL": "SQL", - "SETTINGS": "SETTINGS", - "COMPRESSED_SQL": "COMPRESSED_SQL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'afm_execution': - (AfmExecution,), - 'explain_type': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'explain_type': 'explainType', - }, - 'location_map': { - 'workspace_id': 'path', - 'afm_execution': 'body', - 'explain_type': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/sql', - 'application/zip', - 'image/svg+xml' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.key_driver_analysis_endpoint = _Endpoint( - settings={ - 'response_type': (KeyDriversResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers', - 'operation_id': 'key_driver_analysis', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'key_drivers_request', - 'skip_cache', - ], - 'required': [ - 'workspace_id', - 'key_drivers_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'key_drivers_request': - (KeyDriversRequest,), - 'skip_cache': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'skip_cache': 'skip-cache', - }, - 'location_map': { - 'workspace_id': 'path', - 'key_drivers_request': 'body', - 'skip_cache': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.key_driver_analysis_result_endpoint = _Endpoint( - settings={ - 'response_type': (KeyDriversResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}', - 'operation_id': 'key_driver_analysis_result', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'offset', - 'limit', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'offset': - (int,), - 'limit': - (int,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'offset': 'offset', - 'limit': 'limit', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'offset': 'query', - 'limit': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.retrieve_execution_metadata_endpoint = _Endpoint( - settings={ - 'response_type': (ResultCacheMetadata,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata', - 'operation_id': 'retrieve_execution_metadata', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.retrieve_result_endpoint = _Endpoint( - settings={ - 'response_type': (ExecutionResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}', - 'operation_id': 'retrieve_result', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'offset', - 'limit', - 'excluded_total_dimensions', - 'x_gdc_cancel_token', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'offset': - ([int],), - 'limit': - ([int],), - 'excluded_total_dimensions': - ([str],), - 'x_gdc_cancel_token': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'offset': 'offset', - 'limit': 'limit', - 'excluded_total_dimensions': 'excludedTotalDimensions', - 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'offset': 'query', - 'limit': 'query', - 'excluded_total_dimensions': 'query', - 'x_gdc_cancel_token': 'header', - }, - 'collection_format_map': { - 'offset': 'csv', - 'limit': 'csv', - 'excluded_total_dimensions': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def column_statistics( + self, + data_source_id: StrictStr, + column_statistics_request: ColumnStatisticsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ColumnStatisticsResponse: + """(EXPERIMENTAL) Compute column statistics + + (EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source. + + :param data_source_id: (required) + :type data_source_id: str + :param column_statistics_request: (required) + :type column_statistics_request: ColumnStatisticsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._column_statistics_serialize( + data_source_id=data_source_id, + column_statistics_request=column_statistics_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ColumnStatisticsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def column_statistics_with_http_info( + self, + data_source_id: StrictStr, + column_statistics_request: ColumnStatisticsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ColumnStatisticsResponse]: + """(EXPERIMENTAL) Compute column statistics + + (EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source. + + :param data_source_id: (required) + :type data_source_id: str + :param column_statistics_request: (required) + :type column_statistics_request: ColumnStatisticsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._column_statistics_serialize( + data_source_id=data_source_id, + column_statistics_request=column_statistics_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ColumnStatisticsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def column_statistics_without_preload_content( + self, + data_source_id: StrictStr, + column_statistics_request: ColumnStatisticsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Compute column statistics + + (EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source. + + :param data_source_id: (required) + :type data_source_id: str + :param column_statistics_request: (required) + :type column_statistics_request: ColumnStatisticsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._column_statistics_serialize( + data_source_id=data_source_id, + column_statistics_request=column_statistics_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ColumnStatisticsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _column_statistics_serialize( self, data_source_id, column_statistics_request, - **kwargs - ): - """(EXPERIMENTAL) Compute column statistics # noqa: E501 - - (EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.column_statistics(data_source_id, column_statistics_request, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - column_statistics_request (ColumnStatisticsRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ColumnStatisticsResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['column_statistics_request'] = \ - column_statistics_request - return self.column_statistics_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if column_statistics_request is not None: + _body_params = column_statistics_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/computeColumnStatistics', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def compute_label_elements_post( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + elements_request: ElementsRequest, + offset: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=0)]], Field(description="Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + limit: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]], Field(description="Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ElementsResponse: + """Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. + + Returns paged list of elements (values) of given label satisfying given filtering criteria. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param elements_request: (required) + :type elements_request: ElementsRequest + :param offset: Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type offset: int + :param limit: Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type limit: int + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_label_elements_post_serialize( + workspace_id=workspace_id, + elements_request=elements_request, + offset=offset, + limit=limit, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ElementsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def compute_label_elements_post_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + elements_request: ElementsRequest, + offset: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=0)]], Field(description="Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + limit: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]], Field(description="Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ElementsResponse]: + """Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. + + Returns paged list of elements (values) of given label satisfying given filtering criteria. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param elements_request: (required) + :type elements_request: ElementsRequest + :param offset: Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type offset: int + :param limit: Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type limit: int + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_label_elements_post_serialize( + workspace_id=workspace_id, + elements_request=elements_request, + offset=offset, + limit=limit, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ElementsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def compute_label_elements_post_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + elements_request: ElementsRequest, + offset: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=0)]], Field(description="Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + limit: Annotated[Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]], Field(description="Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.")] = None, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. + + Returns paged list of elements (values) of given label satisfying given filtering criteria. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param elements_request: (required) + :type elements_request: ElementsRequest + :param offset: Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type offset: int + :param limit: Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + :type limit: int + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_label_elements_post_serialize( + workspace_id=workspace_id, + elements_request=elements_request, + offset=offset, + limit=limit, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ElementsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _compute_label_elements_post_serialize( self, workspace_id, elements_request, - **kwargs - ): - """Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. # noqa: E501 - - Returns paged list of elements (values) of given label satisfying given filtering criteria. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.compute_label_elements_post(workspace_id, elements_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - elements_request (ElementsRequest): - - Keyword Args: - offset (int): Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.. [optional] if omitted the server will use the default value of 0 - limit (int): Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.. [optional] if omitted the server will use the default value of 1000 - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ElementsResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['elements_request'] = \ - elements_request - return self.compute_label_elements_post_endpoint.call_with_http_info(**kwargs) - + offset, + limit, + skip_cache, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + # process the form parameters + # process the body parameter + if elements_request is not None: + _body_params = elements_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def compute_report( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + timestamp: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AfmExecutionResponse: + """Executes analytical request and returns link to the result + + AFM is a combination of attributes, measures and filters that describe a query you want to execute. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param timestamp: + :type timestamp: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_report_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + skip_cache=skip_cache, + timestamp=timestamp, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmExecutionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def compute_report_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + timestamp: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AfmExecutionResponse]: + """Executes analytical request and returns link to the result + + AFM is a combination of attributes, measures and filters that describe a query you want to execute. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param timestamp: + :type timestamp: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_report_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + skip_cache=skip_cache, + timestamp=timestamp, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmExecutionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def compute_report_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + timestamp: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Executes analytical request and returns link to the result + + AFM is a combination of attributes, measures and filters that describe a query you want to execute. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param timestamp: + :type timestamp: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_report_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + skip_cache=skip_cache, + timestamp=timestamp, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmExecutionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _compute_report_serialize( self, workspace_id, afm_execution, - **kwargs - ): - """Executes analytical request and returns link to the result # noqa: E501 - - AFM is a combination of attributes, measures and filters that describe a query you want to execute. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.compute_report(workspace_id, afm_execution, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - afm_execution (AfmExecution): - - Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - timestamp (str): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AfmExecutionResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['afm_execution'] = \ - afm_execution - return self.compute_report_endpoint.call_with_http_info(**kwargs) - + skip_cache, + timestamp, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + if timestamp is not None: + _header_params['timestamp'] = timestamp + # process the form parameters + # process the body parameter + if afm_execution is not None: + _body_params = afm_execution + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def compute_valid_descendants( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_descendants_query: AfmValidDescendantsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AfmValidDescendantsResponse: + """(BETA) Valid descendants + + (BETA) Returns map of lists of attributes that can be used as descendants of the given attributes. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_descendants_query: (required) + :type afm_valid_descendants_query: AfmValidDescendantsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_descendants_serialize( + workspace_id=workspace_id, + afm_valid_descendants_query=afm_valid_descendants_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidDescendantsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def compute_valid_descendants_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_descendants_query: AfmValidDescendantsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AfmValidDescendantsResponse]: + """(BETA) Valid descendants + + (BETA) Returns map of lists of attributes that can be used as descendants of the given attributes. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_descendants_query: (required) + :type afm_valid_descendants_query: AfmValidDescendantsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_descendants_serialize( + workspace_id=workspace_id, + afm_valid_descendants_query=afm_valid_descendants_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidDescendantsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def compute_valid_descendants_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_descendants_query: AfmValidDescendantsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Valid descendants + + (BETA) Returns map of lists of attributes that can be used as descendants of the given attributes. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_descendants_query: (required) + :type afm_valid_descendants_query: AfmValidDescendantsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_descendants_serialize( + workspace_id=workspace_id, + afm_valid_descendants_query=afm_valid_descendants_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidDescendantsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _compute_valid_descendants_serialize( self, workspace_id, afm_valid_descendants_query, - **kwargs - ): - """(BETA) Valid descendants # noqa: E501 - - (BETA) Returns map of lists of attributes that can be used as descendants of the given attributes. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.compute_valid_descendants(workspace_id, afm_valid_descendants_query, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - afm_valid_descendants_query (AfmValidDescendantsQuery): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AfmValidDescendantsResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['afm_valid_descendants_query'] = \ - afm_valid_descendants_query - return self.compute_valid_descendants_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if afm_valid_descendants_query is not None: + _body_params = afm_valid_descendants_query + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def compute_valid_objects( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_objects_query: AfmValidObjectsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AfmValidObjectsResponse: + """Valid objects + + Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_objects_query: (required) + :type afm_valid_objects_query: AfmValidObjectsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_objects_serialize( + workspace_id=workspace_id, + afm_valid_objects_query=afm_valid_objects_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidObjectsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def compute_valid_objects_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_objects_query: AfmValidObjectsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AfmValidObjectsResponse]: + """Valid objects + + Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_objects_query: (required) + :type afm_valid_objects_query: AfmValidObjectsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_objects_serialize( + workspace_id=workspace_id, + afm_valid_objects_query=afm_valid_objects_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidObjectsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def compute_valid_objects_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_valid_objects_query: AfmValidObjectsQuery, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Valid objects + + Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_valid_objects_query: (required) + :type afm_valid_objects_query: AfmValidObjectsQuery + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._compute_valid_objects_serialize( + workspace_id=workspace_id, + afm_valid_objects_query=afm_valid_objects_query, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AfmValidObjectsResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _compute_valid_objects_serialize( self, workspace_id, afm_valid_objects_query, - **kwargs - ): - """Valid objects # noqa: E501 - - Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.compute_valid_objects(workspace_id, afm_valid_objects_query, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - afm_valid_objects_query (AfmValidObjectsQuery): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AfmValidObjectsResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['afm_valid_objects_query'] = \ - afm_valid_objects_query - return self.compute_valid_objects_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if afm_valid_objects_query is not None: + _body_params = afm_valid_objects_query + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def explain_afm( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + explain_type: Annotated[Optional[StrictStr], Field(description="Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """AFM explain resource. + + The resource provides static structures needed for investigation of a problem with given AFM. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param explain_type: Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request + :type explain_type: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._explain_afm_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + explain_type=explain_type, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def explain_afm_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + explain_type: Annotated[Optional[StrictStr], Field(description="Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """AFM explain resource. + + The resource provides static structures needed for investigation of a problem with given AFM. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param explain_type: Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request + :type explain_type: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._explain_afm_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + explain_type=explain_type, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def explain_afm_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + afm_execution: AfmExecution, + explain_type: Annotated[Optional[StrictStr], Field(description="Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """AFM explain resource. + + The resource provides static structures needed for investigation of a problem with given AFM. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param afm_execution: (required) + :type afm_execution: AfmExecution + :param explain_type: Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request + :type explain_type: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._explain_afm_serialize( + workspace_id=workspace_id, + afm_execution=afm_execution, + explain_type=explain_type, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _explain_afm_serialize( self, workspace_id, afm_execution, - **kwargs - ): - """AFM explain resource. # noqa: E501 - - The resource provides static structures needed for investigation of a problem with given AFM. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.explain_afm(workspace_id, afm_execution, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - afm_execution (AfmExecution): - - Keyword Args: - explain_type (str): Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['afm_execution'] = \ - afm_execution - return self.explain_afm_endpoint.call_with_http_info(**kwargs) - + explain_type, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if explain_type is not None: + + _query_params.append(('explainType', explain_type)) + + # process the header parameters + # process the form parameters + # process the body parameter + if afm_execution is not None: + _body_params = afm_execution + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'application/sql', + 'application/zip', + 'image/svg+xml' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def key_driver_analysis( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + key_drivers_request: KeyDriversRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> KeyDriversResponse: + """(EXPERIMENTAL) Compute key driver analysis + + (EXPERIMENTAL) Computes key driver analysis for the provided execution definition. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param key_drivers_request: (required) + :type key_drivers_request: KeyDriversRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_serialize( + workspace_id=workspace_id, + key_drivers_request=key_drivers_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def key_driver_analysis_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + key_drivers_request: KeyDriversRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[KeyDriversResponse]: + """(EXPERIMENTAL) Compute key driver analysis + + (EXPERIMENTAL) Computes key driver analysis for the provided execution definition. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param key_drivers_request: (required) + :type key_drivers_request: KeyDriversRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_serialize( + workspace_id=workspace_id, + key_drivers_request=key_drivers_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def key_driver_analysis_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + key_drivers_request: KeyDriversRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Compute key driver analysis + + (EXPERIMENTAL) Computes key driver analysis for the provided execution definition. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param key_drivers_request: (required) + :type key_drivers_request: KeyDriversRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_serialize( + workspace_id=workspace_id, + key_drivers_request=key_drivers_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _key_driver_analysis_serialize( self, workspace_id, key_drivers_request, - **kwargs - ): - """(EXPERIMENTAL) Compute key driver analysis # noqa: E501 - - (EXPERIMENTAL) Computes key driver analysis for the provided execution definition. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.key_driver_analysis(workspace_id, key_drivers_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - key_drivers_request (KeyDriversRequest): - - Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - KeyDriversResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['key_drivers_request'] = \ - key_drivers_request - return self.key_driver_analysis_endpoint.call_with_http_info(**kwargs) - + skip_cache, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + # process the form parameters + # process the body parameter + if key_drivers_request is not None: + _body_params = key_drivers_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def key_driver_analysis_result( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> KeyDriversResult: + """(EXPERIMENTAL) Get key driver analysis result + + (EXPERIMENTAL) Gets key driver analysis. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def key_driver_analysis_result_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[KeyDriversResult]: + """(EXPERIMENTAL) Get key driver analysis result + + (EXPERIMENTAL) Gets key driver analysis. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def key_driver_analysis_result_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Get key driver analysis result + + (EXPERIMENTAL) Gets key driver analysis. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._key_driver_analysis_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "KeyDriversResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _key_driver_analysis_result_serialize( self, workspace_id, result_id, - **kwargs - ): - """(EXPERIMENTAL) Get key driver analysis result # noqa: E501 - - (EXPERIMENTAL) Gets key driver analysis. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.key_driver_analysis_result(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - offset (int): [optional] - limit (int): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - KeyDriversResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.key_driver_analysis_result_endpoint.call_with_http_info(**kwargs) + offset, + limit, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def retrieve_execution_metadata( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ResultCacheMetadata: + """Get a single execution result's metadata. + + The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_execution_metadata_serialize( + workspace_id=workspace_id, + result_id=result_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResultCacheMetadata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def retrieve_execution_metadata_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ResultCacheMetadata]: + """Get a single execution result's metadata. + + The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_execution_metadata_serialize( + workspace_id=workspace_id, + result_id=result_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResultCacheMetadata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def retrieve_execution_metadata_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a single execution result's metadata. + + The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_execution_metadata_serialize( + workspace_id=workspace_id, + result_id=result_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResultCacheMetadata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _retrieve_execution_metadata_serialize( self, workspace_id, result_id, - **kwargs - ): - """Get a single execution result's metadata. # noqa: E501 - - The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.retrieve_execution_metadata(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ResultCacheMetadata - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.retrieve_execution_metadata_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def retrieve_result( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Annotated[Optional[List[StrictInt]], Field(description="Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.")] = None, + limit: Annotated[Optional[List[StrictInt]], Field(description="Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.")] = None, + excluded_total_dimensions: Annotated[Optional[List[StrictStr]], Field(description="Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.")] = None, + x_gdc_cancel_token: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExecutionResult: + """Get a single execution result + + Gets a single execution result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. + :type offset: List[int] + :param limit: Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. + :type limit: List[int] + :param excluded_total_dimensions: Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. + :type excluded_total_dimensions: List[str] + :param x_gdc_cancel_token: + :type x_gdc_cancel_token: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + excluded_total_dimensions=excluded_total_dimensions, + x_gdc_cancel_token=x_gdc_cancel_token, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ExecutionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def retrieve_result_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Annotated[Optional[List[StrictInt]], Field(description="Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.")] = None, + limit: Annotated[Optional[List[StrictInt]], Field(description="Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.")] = None, + excluded_total_dimensions: Annotated[Optional[List[StrictStr]], Field(description="Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.")] = None, + x_gdc_cancel_token: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExecutionResult]: + """Get a single execution result + + Gets a single execution result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. + :type offset: List[int] + :param limit: Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. + :type limit: List[int] + :param excluded_total_dimensions: Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. + :type excluded_total_dimensions: List[str] + :param x_gdc_cancel_token: + :type x_gdc_cancel_token: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + excluded_total_dimensions=excluded_total_dimensions, + x_gdc_cancel_token=x_gdc_cancel_token, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ExecutionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def retrieve_result_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Annotated[Optional[List[StrictInt]], Field(description="Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.")] = None, + limit: Annotated[Optional[List[StrictInt]], Field(description="Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.")] = None, + excluded_total_dimensions: Annotated[Optional[List[StrictStr]], Field(description="Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.")] = None, + x_gdc_cancel_token: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a single execution result + + Gets a single execution result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. + :type offset: List[int] + :param limit: Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. + :type limit: List[int] + :param excluded_total_dimensions: Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. + :type excluded_total_dimensions: List[str] + :param x_gdc_cancel_token: + :type x_gdc_cancel_token: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + excluded_total_dimensions=excluded_total_dimensions, + x_gdc_cancel_token=x_gdc_cancel_token, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ExecutionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _retrieve_result_serialize( self, workspace_id, result_id, - **kwargs - ): - """Get a single execution result # noqa: E501 - - Gets a single execution result. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.retrieve_result(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - offset ([int]): Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] - limit ([int]): Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] - excluded_total_dimensions ([str]): Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.. [optional] if omitted the server will use the default value of [] - x_gdc_cancel_token (str): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExecutionResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.retrieve_result_endpoint.call_with_http_info(**kwargs) + offset, + limit, + excluded_total_dimensions, + x_gdc_cancel_token, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'offset': 'csv', + 'limit': 'csv', + 'excludedTotalDimensions': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if excluded_total_dimensions is not None: + + _query_params.append(('excludedTotalDimensions', excluded_total_dimensions)) + + # process the header parameters + if x_gdc_cancel_token is not None: + _header_params['X-GDC-CANCEL-TOKEN'] = x_gdc_cancel_token + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/context_filters_api.py b/gooddata-api-client/gooddata_api_client/api/context_filters_api.py index 49dd9c656..c9f330ae7 100644 --- a/gooddata-api-client/gooddata_api_client/api/context_filters_api.py +++ b/gooddata-api-client/gooddata_api_client/api/context_filters_api.py @@ -1,1104 +1,2051 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class ContextFiltersApi(object): +class ContextFiltersApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', - 'operation_id': 'create_entity_filter_contexts', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_filter_context_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_filter_context_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_filter_context_post_optional_id_document': - (JsonApiFilterContextPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_filter_context_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_filter_contexts( + self, + workspace_id: StrictStr, + json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Post Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_context_post_optional_id_document: (required) + :type json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_contexts_serialize( + workspace_id=workspace_id, + json_api_filter_context_post_optional_id_document=json_api_filter_context_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.delete_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'delete_entity_filter_contexts', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.get_all_entities_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', - 'operation_id': 'get_all_entities_filter_contexts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Post Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_context_post_optional_id_document: (required) + :type json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_contexts_serialize( + workspace_id=workspace_id, + json_api_filter_context_post_optional_id_document=json_api_filter_context_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.get_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'get_entity_filter_contexts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.patch_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'patch_entity_filter_contexts', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_context_patch_document': - (JsonApiFilterContextPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_context_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - self.update_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'update_entity_filter_contexts', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_context_in_document': - (JsonApiFilterContextInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_context_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_context_post_optional_id_document: (required) + :type json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_contexts_serialize( + workspace_id=workspace_id, + json_api_filter_context_post_optional_id_document=json_api_filter_context_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - def create_entity_filter_contexts( + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_filter_contexts_serialize( self, workspace_id, json_api_filter_context_post_optional_id_document, - **kwargs - ): - """Post Context Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_filter_context_post_optional_id_document (JsonApiFilterContextPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_context_post_optional_id_document is not None: + _body_params = json_api_filter_context_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def delete_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_filter_context_post_optional_id_document'] = \ - json_api_filter_context_post_optional_id_document - return self.create_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + return response_data.response - def delete_entity_filter_contexts( + + def _delete_entity_filter_contexts_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_filter_contexts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_all_entities_filter_contexts( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutList: + """Get all Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_contexts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutList]: + """Get all Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_contexts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_all_entities_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_contexts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - def get_all_entities_filter_contexts( + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_filter_contexts_serialize( self, workspace_id, - **kwargs - ): - """Get all Context Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_filter_contexts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Get a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Get a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_filter_contexts( + + def _get_entity_filter_contexts_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_filter_contexts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def patch_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Patch a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_patch_document: (required) + :type json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_patch_document=json_api_filter_context_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Patch a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_patch_document: (required) + :type json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_patch_document=json_api_filter_context_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_patch_document: (required) + :type json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_patch_document=json_api_filter_context_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + return response_data.response - def patch_entity_filter_contexts( + + def _patch_entity_filter_contexts_serialize( self, workspace_id, object_id, json_api_filter_context_patch_document, - **kwargs - ): - """Patch a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_context_patch_document (JsonApiFilterContextPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_context_patch_document is not None: + _body_params = json_api_filter_context_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def update_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_in_document: JsonApiFilterContextInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Put a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_in_document: (required) + :type json_api_filter_context_in_document: JsonApiFilterContextInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_in_document=json_api_filter_context_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_in_document: JsonApiFilterContextInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Put a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_in_document: (required) + :type json_api_filter_context_in_document: JsonApiFilterContextInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_in_document=json_api_filter_context_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def update_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_in_document: JsonApiFilterContextInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_in_document: (required) + :type json_api_filter_context_in_document: JsonApiFilterContextInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_in_document=json_api_filter_context_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_context_patch_document'] = \ - json_api_filter_context_patch_document - return self.patch_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + return response_data.response - def update_entity_filter_contexts( + + def _update_entity_filter_contexts_serialize( self, workspace_id, object_id, json_api_filter_context_in_document, - **kwargs - ): - """Put a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_context_in_document (JsonApiFilterContextInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_context_in_document is not None: + _body_params = json_api_filter_context_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_context_in_document'] = \ - json_api_filter_context_in_document - return self.update_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/cookie_security_configuration_api.py b/gooddata-api-client/gooddata_api_client/api/cookie_security_configuration_api.py index d98cb6022..5567247d2 100644 --- a/gooddata-api-client/gooddata_api_client/api/cookie_security_configuration_api.py +++ b/gooddata-api-client/gooddata_api_client/api/cookie_security_configuration_api.py @@ -1,495 +1,920 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from pydantic import Field, StrictStr, field_validator +from typing import Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class CookieSecurityConfigurationApi(object): + +class CookieSecurityConfigurationApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_entity_cookie_security_configurations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'get_entity_cookie_security_configurations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_cookie_security_configurations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'patch_entity_cookie_security_configurations', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_cookie_security_configuration_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_cookie_security_configuration_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_cookie_security_configuration_patch_document': - (JsonApiCookieSecurityConfigurationPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_cookie_security_configuration_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_cookie_security_configurations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'update_entity_cookie_security_configurations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_cookie_security_configuration_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_cookie_security_configuration_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_cookie_security_configuration_in_document': - (JsonApiCookieSecurityConfigurationInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_cookie_security_configuration_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def get_entity_cookie_security_configurations( self, - id, - **kwargs - ): - """Get CookieSecurityConfiguration # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_cookie_security_configurations(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCookieSecurityConfigurationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCookieSecurityConfigurationOutDocument: + """Get CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_cookie_security_configurations_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_cookie_security_configurations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCookieSecurityConfigurationOutDocument]: + """Get CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_cookie_security_configurations_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_entity_cookie_security_configurations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_cookie_security_configurations_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + return response_data.response - def patch_entity_cookie_security_configurations( + + def _get_entity_cookie_security_configurations_serialize( self, id, - json_api_cookie_security_configuration_patch_document, - **kwargs - ): - """Patch CookieSecurityConfiguration # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_cookie_security_configuration_patch_document (JsonApiCookieSecurityConfigurationPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCookieSecurityConfigurationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def patch_entity_cookie_security_configurations( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCookieSecurityConfigurationOutDocument: + """Patch CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_patch_document: (required) + :type json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_patch_document=json_api_cookie_security_configuration_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_cookie_security_configurations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCookieSecurityConfigurationOutDocument]: + """Patch CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_patch_document: (required) + :type json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_patch_document=json_api_cookie_security_configuration_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def patch_entity_cookie_security_configurations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_patch_document: (required) + :type json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_patch_document=json_api_cookie_security_configuration_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _patch_entity_cookie_security_configurations_serialize( + self, + id, + json_api_cookie_security_configuration_patch_document, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_cookie_security_configuration_patch_document is not None: + _body_params = json_api_cookie_security_configuration_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_cookie_security_configuration_patch_document'] = \ - json_api_cookie_security_configuration_patch_document - return self.patch_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + + + + @validate_call def update_entity_cookie_security_configurations( self, - id, - json_api_cookie_security_configuration_in_document, - **kwargs - ): - """Put CookieSecurityConfiguration # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_cookie_security_configuration_in_document (JsonApiCookieSecurityConfigurationInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCookieSecurityConfigurationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCookieSecurityConfigurationOutDocument: + """Put CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_in_document: (required) + :type json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_in_document=json_api_cookie_security_configuration_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_cookie_security_configurations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCookieSecurityConfigurationOutDocument]: + """Put CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_in_document: (required) + :type json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_in_document=json_api_cookie_security_configuration_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def update_entity_cookie_security_configurations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_in_document: (required) + :type json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_in_document=json_api_cookie_security_configuration_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_cookie_security_configuration_in_document'] = \ - json_api_cookie_security_configuration_in_document - return self.update_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _update_entity_cookie_security_configurations_serialize( + self, + id, + json_api_cookie_security_configuration_in_document, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_cookie_security_configuration_in_document is not None: + _body_params = json_api_cookie_security_configuration_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/csp_directives_api.py b/gooddata-api-client/gooddata_api_client/api/csp_directives_api.py index 865fb9ce1..8ca85b0b9 100644 --- a/gooddata-api-client/gooddata_api_client/api/csp_directives_api.py +++ b/gooddata-api-client/gooddata_api_client/api/csp_directives_api.py @@ -1,938 +1,1805 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class CSPDirectivesApi(object): + +class CSPDirectivesApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives', - 'operation_id': 'create_entity_csp_directives', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_csp_directive_in_document', - ], - 'required': [ - 'json_api_csp_directive_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_csp_directive_in_document': - (JsonApiCspDirectiveInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_csp_directive_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'delete_entity_csp_directives', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives', - 'operation_id': 'get_all_entities_csp_directives', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'get_entity_csp_directives', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'patch_entity_csp_directives', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_csp_directive_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_csp_directive_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_csp_directive_patch_document': - (JsonApiCspDirectivePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_csp_directive_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'update_entity_csp_directives', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_csp_directive_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_csp_directive_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_csp_directive_in_document': - (JsonApiCspDirectiveInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_csp_directive_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_csp_directives( + self, + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Post CSP Directives + + Context Security Police Directive + + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_csp_directives_serialize( + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_csp_directives_with_http_info( + self, + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Post CSP Directives + + Context Security Police Directive + + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_csp_directives_serialize( + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_csp_directives_without_preload_content( + self, + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post CSP Directives + + Context Security Police Directive + + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_csp_directives_serialize( + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_csp_directives_serialize( self, json_api_csp_directive_in_document, - **kwargs - ): - """Post CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_csp_directives(json_api_csp_directive_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_csp_directive_in_document'] = \ - json_api_csp_directive_in_document - return self.create_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_csp_directive_in_document is not None: + _body_params = json_api_csp_directive_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/cspDirectives', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_csp_directives_serialize( self, id, - **kwargs - ): - """Delete CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_csp_directives(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_csp_directives( self, - **kwargs - ): - """Get CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_csp_directives(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_csp_directives_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutList: + """Get CSP Directives + + Context Security Police Directive + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_csp_directives_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_csp_directives_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutList]: + """Get CSP Directives + + Context Security Police Directive + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_csp_directives_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_csp_directives_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get CSP Directives + + Context Security Police Directive + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_csp_directives_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_csp_directives_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/cspDirectives', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Get CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Get CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_csp_directives_serialize( self, id, - **kwargs - ): - """Get CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_csp_directives(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def patch_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Patch CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_patch_document: (required) + :type json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_patch_document=json_api_csp_directive_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Patch CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_patch_document: (required) + :type json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_patch_document=json_api_csp_directive_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_patch_document: (required) + :type json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_patch_document=json_api_csp_directive_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_csp_directives_serialize( self, id, json_api_csp_directive_patch_document, - **kwargs - ): - """Patch CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_csp_directive_patch_document (JsonApiCspDirectivePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_csp_directive_patch_document'] = \ - json_api_csp_directive_patch_document - return self.patch_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_csp_directive_patch_document is not None: + _body_params = json_api_csp_directive_patch_document + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Put CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Put CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_csp_directives_serialize( self, id, json_api_csp_directive_in_document, - **kwargs - ): - """Put CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_csp_directives(id, json_api_csp_directive_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_csp_directive_in_document'] = \ - json_api_csp_directive_in_document - return self.update_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_csp_directive_in_document is not None: + _body_params = json_api_csp_directive_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/dashboards_api.py b/gooddata-api-client/gooddata_api_client/api/dashboards_api.py index 359ba474a..b131801e5 100644 --- a/gooddata-api-client/gooddata_api_client/api/dashboards_api.py +++ b/gooddata-api-client/gooddata_api_client/api/dashboards_api.py @@ -1,1145 +1,2051 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class DashboardsApi(object): +class DashboardsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', - 'operation_id': 'create_entity_analytical_dashboards', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_analytical_dashboard_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_analytical_dashboard_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_analytical_dashboard_post_optional_id_document': - (JsonApiAnalyticalDashboardPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_analytical_dashboard_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Post Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_analytical_dashboard_post_optional_id_document: (required) + :type json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + json_api_analytical_dashboard_post_optional_id_document=json_api_analytical_dashboard_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.delete_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'delete_entity_analytical_dashboards', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.get_all_entities_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', - 'operation_id': 'get_all_entities_analytical_dashboards', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Post Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_analytical_dashboard_post_optional_id_document: (required) + :type json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + json_api_analytical_dashboard_post_optional_id_document=json_api_analytical_dashboard_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.get_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'get_entity_analytical_dashboards', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.patch_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'patch_entity_analytical_dashboards', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_analytical_dashboard_patch_document': - (JsonApiAnalyticalDashboardPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_analytical_dashboard_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - self.update_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'update_entity_analytical_dashboards', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_analytical_dashboard_in_document': - (JsonApiAnalyticalDashboardInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_analytical_dashboard_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_analytical_dashboard_post_optional_id_document: (required) + :type json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + json_api_analytical_dashboard_post_optional_id_document=json_api_analytical_dashboard_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - def create_entity_analytical_dashboards( + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_analytical_dashboards_serialize( self, workspace_id, json_api_analytical_dashboard_post_optional_id_document, - **kwargs - ): - """Post Dashboards # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_analytical_dashboard_post_optional_id_document (JsonApiAnalyticalDashboardPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_analytical_dashboard_post_optional_id_document is not None: + _body_params = json_api_analytical_dashboard_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def delete_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_analytical_dashboard_post_optional_id_document'] = \ - json_api_analytical_dashboard_post_optional_id_document - return self.create_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + return response_data.response - def delete_entity_analytical_dashboards( + + def _delete_entity_analytical_dashboards_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_analytical_dashboards(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_all_entities_analytical_dashboards( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutList: + """Get all Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_analytical_dashboards_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutList]: + """Get all Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_analytical_dashboards_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_all_entities_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_analytical_dashboards_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - def get_all_entities_analytical_dashboards( + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_analytical_dashboards_serialize( self, workspace_id, - **kwargs - ): - """Get all Dashboards # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_analytical_dashboards(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Get a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Get a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_analytical_dashboards( + + def _get_entity_analytical_dashboards_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_analytical_dashboards(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def patch_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Patch a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_patch_document: (required) + :type json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_patch_document=json_api_analytical_dashboard_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Patch a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_patch_document: (required) + :type json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_patch_document=json_api_analytical_dashboard_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_patch_document: (required) + :type json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_patch_document=json_api_analytical_dashboard_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + return response_data.response - def patch_entity_analytical_dashboards( + + def _patch_entity_analytical_dashboards_serialize( self, workspace_id, object_id, json_api_analytical_dashboard_patch_document, - **kwargs - ): - """Patch a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_analytical_dashboard_patch_document (JsonApiAnalyticalDashboardPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_analytical_dashboard_patch_document is not None: + _body_params = json_api_analytical_dashboard_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def update_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Put Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_in_document: (required) + :type json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_in_document=json_api_analytical_dashboard_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Put Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_in_document: (required) + :type json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_in_document=json_api_analytical_dashboard_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def update_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_in_document: (required) + :type json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_in_document=json_api_analytical_dashboard_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_analytical_dashboard_patch_document'] = \ - json_api_analytical_dashboard_patch_document - return self.patch_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + return response_data.response - def update_entity_analytical_dashboards( + + def _update_entity_analytical_dashboards_serialize( self, workspace_id, object_id, json_api_analytical_dashboard_in_document, - **kwargs - ): - """Put Dashboards # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_analytical_dashboard_in_document (JsonApiAnalyticalDashboardInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_analytical_dashboard_in_document is not None: + _body_params = json_api_analytical_dashboard_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_analytical_dashboard_in_document'] = \ - json_api_analytical_dashboard_in_document - return self.update_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/data_filters_api.py b/gooddata-api-client/gooddata_api_client/api/data_filters_api.py index c1f2df288..6bbf033c2 100644 --- a/gooddata-api-client/gooddata_api_client/api/data_filters_api.py +++ b/gooddata-api-client/gooddata_api_client/api/data_filters_api.py @@ -1,3506 +1,6585 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList -from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument - - -class DataFiltersApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class DataFiltersApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'create_entity_user_data_filters', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_user_data_filter_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_user_data_filter_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_user_data_filter_post_optional_id_document': - (JsonApiUserDataFilterPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_user_data_filter_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', - 'operation_id': 'create_entity_workspace_data_filter_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_workspace_data_filter_setting_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_workspace_data_filter_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_workspace_data_filter_setting_in_document': - (JsonApiWorkspaceDataFilterSettingInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_workspace_data_filter_setting_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', - 'operation_id': 'create_entity_workspace_data_filters', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_workspace_data_filter_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_workspace_data_filter_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_workspace_data_filter_in_document': - (JsonApiWorkspaceDataFilterInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_workspace_data_filter_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'delete_entity_user_data_filters', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'delete_entity_workspace_data_filter_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'delete_entity_workspace_data_filters', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'get_all_entities_user_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', - 'operation_id': 'get_all_entities_workspace_data_filter_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', - 'operation_id': 'get_all_entities_workspace_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'get_entity_user_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'get_entity_workspace_data_filter_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'get_entity_workspace_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_workspace_data_filters_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeWorkspaceDataFilters,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaceDataFilters', - 'operation_id': 'get_workspace_data_filters_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'patch_entity_user_data_filters', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_user_data_filter_patch_document': - (JsonApiUserDataFilterPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_user_data_filter_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'patch_entity_workspace_data_filter_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_setting_patch_document': - (JsonApiWorkspaceDataFilterSettingPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_setting_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'patch_entity_workspace_data_filters', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_patch_document': - (JsonApiWorkspaceDataFilterPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.set_workspace_data_filters_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaceDataFilters', - 'operation_id': 'set_workspace_data_filters_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_workspace_data_filters', - ], - 'required': [ - 'declarative_workspace_data_filters', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_workspace_data_filters': - (DeclarativeWorkspaceDataFilters,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_workspace_data_filters': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.update_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'update_entity_user_data_filters', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_user_data_filter_in_document': - (JsonApiUserDataFilterInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_user_data_filter_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'update_entity_workspace_data_filter_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_setting_in_document': - (JsonApiWorkspaceDataFilterSettingInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_setting_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'update_entity_workspace_data_filters', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_in_document': - (JsonApiWorkspaceDataFilterInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_user_data_filters( + self, + workspace_id: StrictStr, + json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Post User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_user_data_filter_post_optional_id_document: (required) + :type json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_data_filters_serialize( + workspace_id=workspace_id, + json_api_user_data_filter_post_optional_id_document=json_api_user_data_filter_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Post User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_user_data_filter_post_optional_id_document: (required) + :type json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_data_filters_serialize( + workspace_id=workspace_id, + json_api_user_data_filter_post_optional_id_document=json_api_user_data_filter_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_user_data_filter_post_optional_id_document: (required) + :type json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_data_filters_serialize( + workspace_id=workspace_id, + json_api_user_data_filter_post_optional_id_document=json_api_user_data_filter_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_user_data_filters_serialize( self, workspace_id, json_api_user_data_filter_post_optional_id_document, - **kwargs - ): - """Post User Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_user_data_filter_post_optional_id_document (JsonApiUserDataFilterPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_user_data_filter_post_optional_id_document'] = \ - json_api_user_data_filter_post_optional_id_document - return self.create_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_data_filter_post_optional_id_document is not None: + _body_params = json_api_user_data_filter_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Post Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Post Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspace_data_filter_settings_serialize( self, workspace_id, json_api_workspace_data_filter_setting_in_document, - **kwargs - ): - """Post Settings for Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_data_filter_setting_in_document'] = \ - json_api_workspace_data_filter_setting_in_document - return self.create_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_setting_in_document is not None: + _body_params = json_api_workspace_data_filter_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Post Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Post Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspace_data_filters_serialize( self, workspace_id, json_api_workspace_data_filter_in_document, - **kwargs - ): - """Post Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_data_filter_in_document'] = \ - json_api_workspace_data_filter_in_document - return self.create_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_in_document is not None: + _body_params = json_api_workspace_data_filter_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_user_data_filters_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_user_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_workspace_data_filter_settings_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Settings for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_workspace_data_filters_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_user_data_filters( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutList: + """Get all User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutList]: + """Get all User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_user_data_filters_serialize( self, workspace_id, - **kwargs - ): - """Get all User Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_data_filters(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutList: + """Get all Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutList]: + """Get all Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_workspace_data_filter_settings_serialize( self, workspace_id, - **kwargs - ): - """Get all Settings for Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_data_filter_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_workspace_data_filters( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutList: + """Get all Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutList]: + """Get all Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_workspace_data_filters_serialize( self, workspace_id, - **kwargs - ): - """Get all Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_data_filters(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Get a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Get a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_data_filters_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Get a Setting for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Get a Setting for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Setting for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_workspace_data_filter_settings_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Setting for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Get a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Get a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_workspace_data_filters_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_workspace_data_filters_layout( self, - **kwargs - ): - """Get workspace data filters for all workspaces # noqa: E501 - - Retrieve all workspaces and related workspace data filters (and their settings / values). # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_workspace_data_filters_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeWorkspaceDataFilters - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_workspace_data_filters_layout_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeWorkspaceDataFilters: + """Get workspace data filters for all workspaces + + Retrieve all workspaces and related workspace data filters (and their settings / values). + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_data_filters_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_workspace_data_filters_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeWorkspaceDataFilters]: + """Get workspace data filters for all workspaces + + Retrieve all workspaces and related workspace data filters (and their settings / values). + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_data_filters_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_workspace_data_filters_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get workspace data filters for all workspaces + + Retrieve all workspaces and related workspace data filters (and their settings / values). + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_data_filters_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_workspace_data_filters_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaceDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Patch a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_patch_document: (required) + :type json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_patch_document=json_api_user_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Patch a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_patch_document: (required) + :type json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_patch_document=json_api_user_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_patch_document: (required) + :type json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_patch_document=json_api_user_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_user_data_filters_serialize( self, workspace_id, object_id, json_api_user_data_filter_patch_document, - **kwargs - ): - """Patch a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_user_data_filter_patch_document (JsonApiUserDataFilterPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_user_data_filter_patch_document'] = \ - json_api_user_data_filter_patch_document - return self.patch_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_data_filter_patch_document is not None: + _body_params = json_api_user_data_filter_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Patch a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_patch_document: (required) + :type json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_patch_document=json_api_workspace_data_filter_setting_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Patch a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_patch_document: (required) + :type json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_patch_document=json_api_workspace_data_filter_setting_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_patch_document: (required) + :type json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_patch_document=json_api_workspace_data_filter_setting_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspace_data_filter_settings_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, - **kwargs - ): - """Patch a Settings for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_setting_patch_document (JsonApiWorkspaceDataFilterSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_setting_patch_document'] = \ - json_api_workspace_data_filter_setting_patch_document - return self.patch_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_setting_patch_document is not None: + _body_params = json_api_workspace_data_filter_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Patch a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_patch_document: (required) + :type json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_patch_document=json_api_workspace_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Patch a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_patch_document: (required) + :type json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_patch_document=json_api_workspace_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_patch_document: (required) + :type json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_patch_document=json_api_workspace_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspace_data_filters_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_patch_document, - **kwargs - ): - """Patch a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_patch_document (JsonApiWorkspaceDataFilterPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_patch_document'] = \ - json_api_workspace_data_filter_patch_document - return self.patch_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_patch_document is not None: + _body_params = json_api_workspace_data_filter_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_workspace_data_filters_layout( + self, + declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set all workspace data filters + + Sets workspace data filters in all workspaces in entire organization. + + :param declarative_workspace_data_filters: (required) + :type declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_data_filters_layout_serialize( + declarative_workspace_data_filters=declarative_workspace_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_workspace_data_filters_layout_with_http_info( + self, + declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set all workspace data filters + + Sets workspace data filters in all workspaces in entire organization. + + :param declarative_workspace_data_filters: (required) + :type declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_data_filters_layout_serialize( + declarative_workspace_data_filters=declarative_workspace_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_workspace_data_filters_layout_without_preload_content( + self, + declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set all workspace data filters + + Sets workspace data filters in all workspaces in entire organization. + + :param declarative_workspace_data_filters: (required) + :type declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_data_filters_layout_serialize( + declarative_workspace_data_filters=declarative_workspace_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_workspace_data_filters_layout_serialize( self, declarative_workspace_data_filters, - **kwargs - ): - """Set all workspace data filters # noqa: E501 - - Sets workspace data filters in all workspaces in entire organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_workspace_data_filters_layout(declarative_workspace_data_filters, async_req=True) - >>> result = thread.get() - - Args: - declarative_workspace_data_filters (DeclarativeWorkspaceDataFilters): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_workspace_data_filters'] = \ - declarative_workspace_data_filters - return self.set_workspace_data_filters_layout_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_workspace_data_filters is not None: + _body_params = declarative_workspace_data_filters + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaceDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Put a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_in_document: (required) + :type json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_in_document=json_api_user_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Put a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_in_document: (required) + :type json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_in_document=json_api_user_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_in_document: (required) + :type json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_in_document=json_api_user_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_user_data_filters_serialize( self, workspace_id, object_id, json_api_user_data_filter_in_document, - **kwargs - ): - """Put a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_user_data_filter_in_document (JsonApiUserDataFilterInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_user_data_filter_in_document'] = \ - json_api_user_data_filter_in_document - return self.update_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_data_filter_in_document is not None: + _body_params = json_api_user_data_filter_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Put a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Put a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_workspace_data_filter_settings_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, - **kwargs - ): - """Put a Settings for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_setting_in_document'] = \ - json_api_workspace_data_filter_setting_in_document - return self.update_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_setting_in_document is not None: + _body_params = json_api_workspace_data_filter_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Put a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Put a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_workspace_data_filters_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_in_document, - **kwargs - ): - """Put a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_in_document'] = \ - json_api_workspace_data_filter_in_document - return self.update_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_in_document is not None: + _body_params = json_api_workspace_data_filter_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/data_source_declarative_apis_api.py b/gooddata-api-client/gooddata_api_client/api/data_source_declarative_apis_api.py index a63d928ef..677ec724d 100644 --- a/gooddata-api-client/gooddata_api_client/api/data_source_declarative_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/data_source_declarative_apis_api.py @@ -1,290 +1,548 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class DataSourceDeclarativeAPIsApi(object): +class DataSourceDeclarativeAPIsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_data_sources_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeDataSources,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/dataSources', - 'operation_id': 'get_data_sources_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.put_data_sources_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/dataSources', - 'operation_id': 'put_data_sources_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_data_sources', - ], - 'required': [ - 'declarative_data_sources', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_data_sources': - (DeclarativeDataSources,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_data_sources': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def get_data_sources_layout( self, - **kwargs - ): - """Get all data sources # noqa: E501 - - Retrieve all data sources including related physical model. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_data_sources_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeDataSources - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeDataSources: + """Get all data sources + + Retrieve all data sources including related physical model. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_sources_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSources", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_sources_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeDataSources]: + """Get all data sources + + Retrieve all data sources including related physical model. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_sources_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSources", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def get_data_sources_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all data sources + + Retrieve all data sources including related physical model. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_sources_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSources", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _get_data_sources_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/dataSources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_data_sources_layout_endpoint.call_with_http_info(**kwargs) + + + + @validate_call def put_data_sources_layout( self, - declarative_data_sources, - **kwargs - ): - """Put all data sources # noqa: E501 - - Set all data sources including related physical model. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_data_sources_layout(declarative_data_sources, async_req=True) - >>> result = thread.get() - - Args: - declarative_data_sources (DeclarativeDataSources): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + declarative_data_sources: DeclarativeDataSources, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Put all data sources + + Set all data sources including related physical model. + + :param declarative_data_sources: (required) + :type declarative_data_sources: DeclarativeDataSources + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_data_sources_layout_serialize( + declarative_data_sources=declarative_data_sources, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_data_sources_layout_with_http_info( + self, + declarative_data_sources: DeclarativeDataSources, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Put all data sources + + Set all data sources including related physical model. + + :param declarative_data_sources: (required) + :type declarative_data_sources: DeclarativeDataSources + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_data_sources_layout_serialize( + declarative_data_sources=declarative_data_sources, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def put_data_sources_layout_without_preload_content( + self, + declarative_data_sources: DeclarativeDataSources, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put all data sources + + Set all data sources including related physical model. + + :param declarative_data_sources: (required) + :type declarative_data_sources: DeclarativeDataSources + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_data_sources_layout_serialize( + declarative_data_sources=declarative_data_sources, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _put_data_sources_layout_serialize( + self, + declarative_data_sources, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_data_sources is not None: + _body_params = declarative_data_sources + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/dataSources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_data_sources'] = \ - declarative_data_sources - return self.put_data_sources_layout_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/data_source_entity_apis_api.py b/gooddata-api-client/gooddata_api_client/api/data_source_entity_apis_api.py index d2784a1b8..70048805b 100644 --- a/gooddata-api-client/gooddata_api_client/api/data_source_entity_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/data_source_entity_apis_api.py @@ -1,1302 +1,2464 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument - - -class DataSourceEntityAPIsApi(object): +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class DataSourceEntityAPIsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources', - 'operation_id': 'create_entity_data_sources', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_data_source_in_document', - 'meta_include', - ], - 'required': [ - 'json_api_data_source_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_data_source_in_document': - (JsonApiDataSourceInDocument,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'json_api_data_source_in_document': 'body', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'delete_entity_data_sources', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_data_source_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceIdentifierOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers', - 'operation_id': 'get_all_entities_data_source_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources', - 'operation_id': 'get_all_entities_data_sources', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_data_source_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceIdentifierOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers/{id}', - 'operation_id': 'get_entity_data_source_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'get_entity_data_sources', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'patch_entity_data_sources', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_data_source_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_data_source_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_data_source_patch_document': - (JsonApiDataSourcePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_data_source_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'update_entity_data_sources', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_data_source_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_data_source_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_data_source_in_document': - (JsonApiDataSourceInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_data_source_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_data_sources( + self, + json_api_data_source_in_document: JsonApiDataSourceInDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Post Data Sources + + Data Source - represents data source for the workspace + + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_data_sources_serialize( + json_api_data_source_in_document=json_api_data_source_in_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_data_sources_with_http_info( + self, + json_api_data_source_in_document: JsonApiDataSourceInDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Post Data Sources + + Data Source - represents data source for the workspace + + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_data_sources_serialize( + json_api_data_source_in_document=json_api_data_source_in_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_data_sources_without_preload_content( + self, + json_api_data_source_in_document: JsonApiDataSourceInDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Data Sources + + Data Source - represents data source for the workspace + + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_data_sources_serialize( + json_api_data_source_in_document=json_api_data_source_in_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_data_sources_serialize( self, json_api_data_source_in_document, - **kwargs - ): - """Post Data Sources # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_data_sources(json_api_data_source_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_data_source_in_document (JsonApiDataSourceInDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_data_source_in_document'] = \ - json_api_data_source_in_document - return self.create_entity_data_sources_endpoint.call_with_http_info(**kwargs) - + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_data_source_in_document is not None: + _body_params = json_api_data_source_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/dataSources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_data_sources( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_data_sources_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_data_sources_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_data_sources_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_data_sources_serialize( self, id, - **kwargs - ): - """Delete Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_data_sources(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_data_sources_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_data_source_identifiers( self, - **kwargs - ): - """Get all Data Source Identifiers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_data_source_identifiers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceIdentifierOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceIdentifierOutList: + """Get all Data Source Identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_source_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_data_source_identifiers_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceIdentifierOutList]: + """Get all Data Source Identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_source_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_data_source_identifiers_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Data Source Identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_source_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_data_source_identifiers_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSourceIdentifiers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_data_sources( self, - **kwargs - ): - """Get Data Source entities # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_data_sources(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutList: + """Get Data Source entities + + Data Source - represents data source for the workspace + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_sources_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_data_sources_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutList]: + """Get Data Source entities + + Data Source - represents data source for the workspace + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_sources_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_data_sources_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Data Source entities + + Data Source - represents data source for the workspace + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_sources_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_data_sources_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_data_source_identifiers( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceIdentifierOutDocument: + """Get Data Source Identifier + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_source_identifiers_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_data_source_identifiers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceIdentifierOutDocument]: + """Get Data Source Identifier + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_source_identifiers_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_data_source_identifiers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Data Source Identifier + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_source_identifiers_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_data_source_identifiers_serialize( self, id, - **kwargs - ): - """Get Data Source Identifier # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_data_source_identifiers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceIdentifierOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + filter, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSourceIdentifiers/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_data_sources( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Get Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_sources_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Get Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_sources_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_sources_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_data_sources_serialize( self, id, - **kwargs - ): - """Get Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_data_sources(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_data_sources_endpoint.call_with_http_info(**kwargs) + filter, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def patch_entity_data_sources( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_patch_document: JsonApiDataSourcePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Patch Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_patch_document: (required) + :type json_api_data_source_patch_document: JsonApiDataSourcePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_data_sources_serialize( + id=id, + json_api_data_source_patch_document=json_api_data_source_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_patch_document: JsonApiDataSourcePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Patch Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_patch_document: (required) + :type json_api_data_source_patch_document: JsonApiDataSourcePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_data_sources_serialize( + id=id, + json_api_data_source_patch_document=json_api_data_source_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_patch_document: JsonApiDataSourcePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_patch_document: (required) + :type json_api_data_source_patch_document: JsonApiDataSourcePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_data_sources_serialize( + id=id, + json_api_data_source_patch_document=json_api_data_source_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_data_sources_serialize( self, id, json_api_data_source_patch_document, - **kwargs - ): - """Patch Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_data_sources(id, json_api_data_source_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_data_source_patch_document (JsonApiDataSourcePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_data_source_patch_document'] = \ - json_api_data_source_patch_document - return self.patch_entity_data_sources_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_data_source_patch_document is not None: + _body_params = json_api_data_source_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_data_sources( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_in_document: JsonApiDataSourceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Put Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_data_sources_serialize( + id=id, + json_api_data_source_in_document=json_api_data_source_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_in_document: JsonApiDataSourceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Put Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_data_sources_serialize( + id=id, + json_api_data_source_in_document=json_api_data_source_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_in_document: JsonApiDataSourceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_data_sources_serialize( + id=id, + json_api_data_source_in_document=json_api_data_source_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_data_sources_serialize( self, id, json_api_data_source_in_document, - **kwargs - ): - """Put Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_data_sources(id, json_api_data_source_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_data_source_in_document (JsonApiDataSourceInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_data_source_in_document'] = \ - json_api_data_source_in_document - return self.update_entity_data_sources_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_data_source_in_document is not None: + _body_params = json_api_data_source_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/datasets_api.py b/gooddata-api-client/gooddata_api_client/api/datasets_api.py index e312f7c76..06ad68aa7 100644 --- a/gooddata-api-client/gooddata_api_client/api/datasets_api.py +++ b/gooddata-api-client/gooddata_api_client/api/datasets_api.py @@ -1,441 +1,775 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class DatasetsApi(object): +class DatasetsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_all_entities_datasets_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDatasetOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets', - 'operation_id': 'get_all_entities_datasets', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "FACTS": "facts", - "AGGREGATEDFACTS": "aggregatedFacts", - "DATASETS": "datasets", - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "REFERENCES": "references", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_datasets_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDatasetOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', - 'operation_id': 'get_entity_datasets', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "FACTS": "facts", - "AGGREGATEDFACTS": "aggregatedFacts", - "DATASETS": "datasets", - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "REFERENCES": "references", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def get_all_entities_datasets( self, - workspace_id, - **kwargs - ): - """Get all Datasets # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_datasets(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDatasetOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDatasetOutList: + """Get all Datasets + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_datasets_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_datasets_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDatasetOutList]: + """Get all Datasets + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_datasets_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_all_entities_datasets_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Datasets + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_datasets_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_datasets_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_datasets( + + def _get_all_entities_datasets_serialize( self, workspace_id, - object_id, - **kwargs - ): - """Get a Dataset # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_datasets(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDatasetOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/datasets', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_entity_datasets( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDatasetOutDocument: + """Get a Dataset + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_datasets_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_datasets_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDatasetOutDocument]: + """Get a Dataset + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_datasets_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_entity_datasets_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Dataset + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_datasets_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_datasets_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _get_entity_datasets_serialize( + self, + workspace_id, + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/dependency_graph_api.py b/gooddata-api-client/gooddata_api_client/api/dependency_graph_api.py index 90226ee00..2deed314f 100644 --- a/gooddata-api-client/gooddata_api_client/api/dependency_graph_api.py +++ b/gooddata-api-client/gooddata_api_client/api/dependency_graph_api.py @@ -1,315 +1,587 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictStr +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class DependencyGraphApi(object): +class DependencyGraphApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_dependent_entities_graph_endpoint = _Endpoint( - settings={ - 'response_type': (DependentEntitiesResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph', - 'operation_id': 'get_dependent_entities_graph', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_dependent_entities_graph_from_entry_points_endpoint = _Endpoint( - settings={ - 'response_type': (DependentEntitiesResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph', - 'operation_id': 'get_dependent_entities_graph_from_entry_points', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'dependent_entities_request', - ], - 'required': [ - 'workspace_id', - 'dependent_entities_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'dependent_entities_request': - (DependentEntitiesRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'dependent_entities_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def get_dependent_entities_graph( self, - workspace_id, - **kwargs - ): - """Computes the dependent entities graph # noqa: E501 - - Computes the dependent entities graph # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_dependent_entities_graph(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DependentEntitiesResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DependentEntitiesResponse: + """Computes the dependent entities graph + + Computes the dependent entities graph + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_dependent_entities_graph_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DependentEntitiesResponse]: + """Computes the dependent entities graph + + Computes the dependent entities graph + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_dependent_entities_graph_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Computes the dependent entities graph + + Computes the dependent entities graph + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_dependent_entities_graph_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_dependent_entities_graph_from_entry_points( + + def _get_dependent_entities_graph_serialize( self, workspace_id, - dependent_entities_request, - **kwargs - ): - """Computes the dependent entities graph from given entry points # noqa: E501 - - Computes the dependent entities graph from given entry points # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_dependent_entities_graph_from_entry_points(workspace_id, dependent_entities_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - dependent_entities_request (DependentEntitiesRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DependentEntitiesResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_dependent_entities_graph_from_entry_points( + self, + workspace_id: StrictStr, + dependent_entities_request: DependentEntitiesRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DependentEntitiesResponse: + """Computes the dependent entities graph from given entry points + + Computes the dependent entities graph from given entry points + + :param workspace_id: (required) + :type workspace_id: str + :param dependent_entities_request: (required) + :type dependent_entities_request: DependentEntitiesRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_from_entry_points_serialize( + workspace_id=workspace_id, + dependent_entities_request=dependent_entities_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_dependent_entities_graph_from_entry_points_with_http_info( + self, + workspace_id: StrictStr, + dependent_entities_request: DependentEntitiesRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DependentEntitiesResponse]: + """Computes the dependent entities graph from given entry points + + Computes the dependent entities graph from given entry points + + :param workspace_id: (required) + :type workspace_id: str + :param dependent_entities_request: (required) + :type dependent_entities_request: DependentEntitiesRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_from_entry_points_serialize( + workspace_id=workspace_id, + dependent_entities_request=dependent_entities_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def get_dependent_entities_graph_from_entry_points_without_preload_content( + self, + workspace_id: StrictStr, + dependent_entities_request: DependentEntitiesRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Computes the dependent entities graph from given entry points + + Computes the dependent entities graph from given entry points + + :param workspace_id: (required) + :type workspace_id: str + :param dependent_entities_request: (required) + :type dependent_entities_request: DependentEntitiesRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_dependent_entities_graph_from_entry_points_serialize( + workspace_id=workspace_id, + dependent_entities_request=dependent_entities_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DependentEntitiesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _get_dependent_entities_graph_from_entry_points_serialize( + self, + workspace_id, + dependent_entities_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if dependent_entities_request is not None: + _body_params = dependent_entities_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['dependent_entities_request'] = \ - dependent_entities_request - return self.get_dependent_entities_graph_from_entry_points_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/entities_api.py b/gooddata-api-client/gooddata_api_client/api/entities_api.py index fe0dff92e..7633acd1a 100644 --- a/gooddata-api-client/gooddata_api_client/api/entities_api.py +++ b/gooddata-api-client/gooddata_api_client/api/entities_api.py @@ -1,33121 +1,62943 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument -from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList -from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList -from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList -from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList -from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument -from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument -from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument -from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList -from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument -from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument -from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList -from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList -from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument -from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList -from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList -from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList -from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument -from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList -from gooddata_api_client.model.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument -from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList -from gooddata_api_client.model.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument -from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument -from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument -from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList -from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument - - -class EntitiesApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Any, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument +from gooddata_api_client.models.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.models.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.models.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.models.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.models.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.models.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.models.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.models.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.models.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.models.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.models.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from gooddata_api_client.models.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.models.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.models.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +from gooddata_api_client.models.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.models.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class EntitiesApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', - 'operation_id': 'create_entity_analytical_dashboards', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_analytical_dashboard_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_analytical_dashboard_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_analytical_dashboard_post_optional_id_document': - (JsonApiAnalyticalDashboardPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_analytical_dashboard_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + + + @validate_call + def create_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Post Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_analytical_dashboard_post_optional_id_document: (required) + :type json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + json_api_analytical_dashboard_post_optional_id_document=json_api_analytical_dashboard_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Post Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_analytical_dashboard_post_optional_id_document: (required) + :type json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + json_api_analytical_dashboard_post_optional_id_document=json_api_analytical_dashboard_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_analytical_dashboard_post_optional_id_document: (required) + :type json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + json_api_analytical_dashboard_post_optional_id_document=json_api_analytical_dashboard_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_analytical_dashboards_serialize( + self, + workspace_id, + json_api_analytical_dashboard_post_optional_id_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_analytical_dashboard_post_optional_id_document is not None: + _body_params = json_api_analytical_dashboard_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiApiTokenOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens', - 'operation_id': 'create_entity_api_tokens', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'json_api_api_token_in_document', - ], - 'required': [ - 'user_id', - 'json_api_api_token_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'json_api_api_token_in_document': - (JsonApiApiTokenInDocument,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - 'json_api_api_token_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_api_tokens( + self, + user_id: StrictStr, + json_api_api_token_in_document: JsonApiApiTokenInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiApiTokenOutDocument: + """Post a new API token for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_api_token_in_document: (required) + :type json_api_api_token_in_document: JsonApiApiTokenInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_api_tokens_serialize( + user_id=user_id, + json_api_api_token_in_document=json_api_api_token_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_api_tokens_with_http_info( + self, + user_id: StrictStr, + json_api_api_token_in_document: JsonApiApiTokenInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiApiTokenOutDocument]: + """Post a new API token for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_api_token_in_document: (required) + :type json_api_api_token_in_document: JsonApiApiTokenInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_api_tokens_serialize( + user_id=user_id, + json_api_api_token_in_document=json_api_api_token_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_api_tokens_without_preload_content( + self, + user_id: StrictStr, + json_api_api_token_in_document: JsonApiApiTokenInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post a new API token for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_api_token_in_document: (required) + :type json_api_api_token_in_document: JsonApiApiTokenInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_api_tokens_serialize( + user_id=user_id, + json_api_api_token_in_document=json_api_api_token_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_api_tokens_serialize( + self, + user_id, + json_api_api_token_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_api_token_in_document is not None: + _body_params = json_api_api_token_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', - 'operation_id': 'create_entity_attribute_hierarchies', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_attribute_hierarchy_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_attribute_hierarchy_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_attribute_hierarchy_in_document': - (JsonApiAttributeHierarchyInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_attribute_hierarchy_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/users/{userId}/apiTokens', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Post Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Post Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_attribute_hierarchies_serialize( + self, + workspace_id, + json_api_attribute_hierarchy_in_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_attribute_hierarchy_in_document is not None: + _body_params = json_api_attribute_hierarchy_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations', - 'operation_id': 'create_entity_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_automation_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_automation_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_automation_in_document': - (JsonApiAutomationInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_automation_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_automations( + self, + workspace_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Post Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_automations_serialize( + workspace_id=workspace_id, + json_api_automation_in_document=json_api_automation_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Post Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_automations_serialize( + workspace_id=workspace_id, + json_api_automation_in_document=json_api_automation_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_automations_serialize( + workspace_id=workspace_id, + json_api_automation_in_document=json_api_automation_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_automations_serialize( + self, + workspace_id, + json_api_automation_in_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_automation_in_document is not None: + _body_params = json_api_automation_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes', - 'operation_id': 'create_entity_color_palettes', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_color_palette_in_document', - ], - 'required': [ - 'json_api_color_palette_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_color_palette_in_document': - (JsonApiColorPaletteInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_color_palette_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_color_palettes( + self, + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Post Color Pallettes + + + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_color_palettes_serialize( + json_api_color_palette_in_document=json_api_color_palette_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_color_palettes_with_http_info( + self, + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Post Color Pallettes + + + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_color_palettes_serialize( + json_api_color_palette_in_document=json_api_color_palette_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_color_palettes_without_preload_content( + self, + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Color Pallettes + + + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_color_palettes_serialize( + json_api_color_palette_in_document=json_api_color_palette_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_color_palettes_serialize( + self, + json_api_color_palette_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_color_palette_in_document is not None: + _body_params = json_api_color_palette_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives', - 'operation_id': 'create_entity_csp_directives', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_csp_directive_in_document', - ], - 'required': [ - 'json_api_csp_directive_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_csp_directive_in_document': - (JsonApiCspDirectiveInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_csp_directive_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/colorPalettes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_csp_directives( + self, + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Post CSP Directives + + Context Security Police Directive + + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_csp_directives_serialize( + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_csp_directives_with_http_info( + self, + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Post CSP Directives + + Context Security Police Directive + + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_csp_directives_serialize( + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_csp_directives_without_preload_content( + self, + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post CSP Directives + + Context Security Police Directive + + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_csp_directives_serialize( + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_csp_directives_serialize( + self, + json_api_csp_directive_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_csp_directive_in_document is not None: + _body_params = json_api_csp_directive_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', - 'operation_id': 'create_entity_custom_application_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_custom_application_setting_post_optional_id_document', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_custom_application_setting_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_custom_application_setting_post_optional_id_document': - (JsonApiCustomApplicationSettingPostOptionalIdDocument,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_custom_application_setting_post_optional_id_document': 'body', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/cspDirectives', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_custom_application_settings( + self, + workspace_id: StrictStr, + json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Post Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_custom_application_setting_post_optional_id_document: (required) + :type json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + json_api_custom_application_setting_post_optional_id_document=json_api_custom_application_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Post Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_custom_application_setting_post_optional_id_document: (required) + :type json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + json_api_custom_application_setting_post_optional_id_document=json_api_custom_application_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_custom_application_setting_post_optional_id_document: (required) + :type json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + json_api_custom_application_setting_post_optional_id_document=json_api_custom_application_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_custom_application_settings_serialize( + self, + workspace_id, + json_api_custom_application_setting_post_optional_id_document, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_custom_application_setting_post_optional_id_document is not None: + _body_params = json_api_custom_application_setting_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', - 'operation_id': 'create_entity_dashboard_plugins', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_dashboard_plugin_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_dashboard_plugin_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_dashboard_plugin_post_optional_id_document': - (JsonApiDashboardPluginPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_dashboard_plugin_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Post Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_dashboard_plugin_post_optional_id_document: (required) + :type json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + json_api_dashboard_plugin_post_optional_id_document=json_api_dashboard_plugin_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Post Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_dashboard_plugin_post_optional_id_document: (required) + :type json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + json_api_dashboard_plugin_post_optional_id_document=json_api_dashboard_plugin_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_dashboard_plugin_post_optional_id_document: (required) + :type json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + json_api_dashboard_plugin_post_optional_id_document=json_api_dashboard_plugin_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_dashboard_plugins_serialize( + self, + workspace_id, + json_api_dashboard_plugin_post_optional_id_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_dashboard_plugin_post_optional_id_document is not None: + _body_params = json_api_dashboard_plugin_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources', - 'operation_id': 'create_entity_data_sources', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_data_source_in_document', - 'meta_include', - ], - 'required': [ - 'json_api_data_source_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_data_source_in_document': - (JsonApiDataSourceInDocument,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'json_api_data_source_in_document': 'body', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_data_sources( + self, + json_api_data_source_in_document: JsonApiDataSourceInDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Post Data Sources + + Data Source - represents data source for the workspace + + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_data_sources_serialize( + json_api_data_source_in_document=json_api_data_source_in_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_data_sources_with_http_info( + self, + json_api_data_source_in_document: JsonApiDataSourceInDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Post Data Sources + + Data Source - represents data source for the workspace + + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_data_sources_serialize( + json_api_data_source_in_document=json_api_data_source_in_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_data_sources_without_preload_content( + self, + json_api_data_source_in_document: JsonApiDataSourceInDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Data Sources + + Data Source - represents data source for the workspace + + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_data_sources_serialize( + json_api_data_source_in_document=json_api_data_source_in_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_data_sources_serialize( + self, + json_api_data_source_in_document, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_data_source_in_document is not None: + _body_params = json_api_data_source_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', - 'operation_id': 'create_entity_export_definitions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_export_definition_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_export_definition_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_export_definition_post_optional_id_document': - (JsonApiExportDefinitionPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_export_definition_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/dataSources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_export_definitions( + self, + workspace_id: StrictStr, + json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Post Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_export_definition_post_optional_id_document: (required) + :type json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_definitions_serialize( + workspace_id=workspace_id, + json_api_export_definition_post_optional_id_document=json_api_export_definition_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Post Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_export_definition_post_optional_id_document: (required) + :type json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_definitions_serialize( + workspace_id=workspace_id, + json_api_export_definition_post_optional_id_document=json_api_export_definition_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_export_definition_post_optional_id_document: (required) + :type json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_definitions_serialize( + workspace_id=workspace_id, + json_api_export_definition_post_optional_id_document=json_api_export_definition_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_export_definitions_serialize( + self, + workspace_id, + json_api_export_definition_post_optional_id_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_definition_post_optional_id_document is not None: + _body_params = json_api_export_definition_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates', - 'operation_id': 'create_entity_export_templates', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_export_template_post_optional_id_document', - ], - 'required': [ - 'json_api_export_template_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_export_template_post_optional_id_document': - (JsonApiExportTemplatePostOptionalIdDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_export_template_post_optional_id_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_export_templates( + self, + json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """Post Export Template entities + + + :param json_api_export_template_post_optional_id_document: (required) + :type json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_templates_serialize( + json_api_export_template_post_optional_id_document=json_api_export_template_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_export_templates_with_http_info( + self, + json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """Post Export Template entities + + + :param json_api_export_template_post_optional_id_document: (required) + :type json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_templates_serialize( + json_api_export_template_post_optional_id_document=json_api_export_template_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_export_templates_without_preload_content( + self, + json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Export Template entities + + + :param json_api_export_template_post_optional_id_document: (required) + :type json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_templates_serialize( + json_api_export_template_post_optional_id_document=json_api_export_template_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_export_templates_serialize( + self, + json_api_export_template_post_optional_id_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_template_post_optional_id_document is not None: + _body_params = json_api_export_template_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', - 'operation_id': 'create_entity_filter_contexts', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_filter_context_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_filter_context_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_filter_context_post_optional_id_document': - (JsonApiFilterContextPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_filter_context_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/exportTemplates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_filter_contexts( + self, + workspace_id: StrictStr, + json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Post Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_context_post_optional_id_document: (required) + :type json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_contexts_serialize( + workspace_id=workspace_id, + json_api_filter_context_post_optional_id_document=json_api_filter_context_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Post Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_context_post_optional_id_document: (required) + :type json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_contexts_serialize( + workspace_id=workspace_id, + json_api_filter_context_post_optional_id_document=json_api_filter_context_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_context_post_optional_id_document: (required) + :type json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_contexts_serialize( + workspace_id=workspace_id, + json_api_filter_context_post_optional_id_document=json_api_filter_context_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_filter_contexts_serialize( + self, + workspace_id, + json_api_filter_context_post_optional_id_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_context_post_optional_id_document is not None: + _body_params = json_api_filter_context_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', - 'operation_id': 'create_entity_filter_views', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_filter_view_in_document', - 'include', - ], - 'required': [ - 'workspace_id', - 'json_api_filter_view_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_filter_view_in_document': - (JsonApiFilterViewInDocument,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_filter_view_in_document': 'body', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_filter_views( + self, + workspace_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Post Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_views_serialize( + workspace_id=workspace_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Post Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_views_serialize( + workspace_id=workspace_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_views_serialize( + workspace_id=workspace_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_filter_views_serialize( + self, + workspace_id, + json_api_filter_view_in_document, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_view_in_document is not None: + _body_params = json_api_filter_view_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders', - 'operation_id': 'create_entity_identity_providers', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_identity_provider_in_document', - ], - 'required': [ - 'json_api_identity_provider_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_identity_provider_in_document': - (JsonApiIdentityProviderInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_identity_provider_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_identity_providers( + self, + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Post Identity Providers + + + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_identity_providers_serialize( + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_identity_providers_with_http_info( + self, + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Post Identity Providers + + + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_identity_providers_serialize( + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_identity_providers_without_preload_content( + self, + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Identity Providers + + + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_identity_providers_serialize( + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_identity_providers_serialize( + self, + json_api_identity_provider_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_identity_provider_in_document is not None: + _body_params = json_api_identity_provider_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks', - 'operation_id': 'create_entity_jwks', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_jwk_in_document', - ], - 'required': [ - 'json_api_jwk_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_jwk_in_document': - (JsonApiJwkInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_jwk_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/identityProviders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_jwks( + self, + json_api_jwk_in_document: JsonApiJwkInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Post Jwks + + Creates JSON web key - used to verify JSON web tokens (Jwts) + + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_jwks_serialize( + json_api_jwk_in_document=json_api_jwk_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_jwks_with_http_info( + self, + json_api_jwk_in_document: JsonApiJwkInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Post Jwks + + Creates JSON web key - used to verify JSON web tokens (Jwts) + + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_jwks_serialize( + json_api_jwk_in_document=json_api_jwk_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_jwks_without_preload_content( + self, + json_api_jwk_in_document: JsonApiJwkInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Jwks + + Creates JSON web key - used to verify JSON web tokens (Jwts) + + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_jwks_serialize( + json_api_jwk_in_document=json_api_jwk_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_jwks_serialize( + self, + json_api_jwk_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_jwk_in_document is not None: + _body_params = json_api_jwk_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints', - 'operation_id': 'create_entity_llm_endpoints', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_llm_endpoint_in_document', - ], - 'required': [ - 'json_api_llm_endpoint_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_llm_endpoint_in_document': - (JsonApiLlmEndpointInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_llm_endpoint_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/jwks', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_llm_endpoints( + self, + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """Post LLM endpoint entities + + + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_llm_endpoints_serialize( + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_llm_endpoints_with_http_info( + self, + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """Post LLM endpoint entities + + + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_llm_endpoints_serialize( + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_llm_endpoints_without_preload_content( + self, + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post LLM endpoint entities + + + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_llm_endpoints_serialize( + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_llm_endpoints_serialize( + self, + json_api_llm_endpoint_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_llm_endpoint_in_document is not None: + _body_params = json_api_llm_endpoint_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', - 'operation_id': 'create_entity_metrics', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_metric_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_metric_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_metric_post_optional_id_document': - (JsonApiMetricPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_metric_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/llmEndpoints', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_metrics( + self, + workspace_id: StrictStr, + json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Post Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_metric_post_optional_id_document: (required) + :type json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_metrics_serialize( + workspace_id=workspace_id, + json_api_metric_post_optional_id_document=json_api_metric_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Post Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_metric_post_optional_id_document: (required) + :type json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_metrics_serialize( + workspace_id=workspace_id, + json_api_metric_post_optional_id_document=json_api_metric_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_metric_post_optional_id_document: (required) + :type json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_metrics_serialize( + workspace_id=workspace_id, + json_api_metric_post_optional_id_document=json_api_metric_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_metrics_serialize( + self, + workspace_id, + json_api_metric_post_optional_id_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_metric_post_optional_id_document is not None: + _body_params = json_api_metric_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels', - 'operation_id': 'create_entity_notification_channels', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_notification_channel_post_optional_id_document', - ], - 'required': [ - 'json_api_notification_channel_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_notification_channel_post_optional_id_document': - (JsonApiNotificationChannelPostOptionalIdDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_notification_channel_post_optional_id_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_notification_channels( + self, + json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Post Notification Channel entities + + + :param json_api_notification_channel_post_optional_id_document: (required) + :type json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_notification_channels_serialize( + json_api_notification_channel_post_optional_id_document=json_api_notification_channel_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_notification_channels_with_http_info( + self, + json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Post Notification Channel entities + + + :param json_api_notification_channel_post_optional_id_document: (required) + :type json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_notification_channels_serialize( + json_api_notification_channel_post_optional_id_document=json_api_notification_channel_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_notification_channels_without_preload_content( + self, + json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Notification Channel entities + + + :param json_api_notification_channel_post_optional_id_document: (required) + :type json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_notification_channels_serialize( + json_api_notification_channel_post_optional_id_document=json_api_notification_channel_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_notification_channels_serialize( + self, + json_api_notification_channel_post_optional_id_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_notification_channel_post_optional_id_document is not None: + _body_params = json_api_notification_channel_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings', - 'operation_id': 'create_entity_organization_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_organization_setting_in_document', - ], - 'required': [ - 'json_api_organization_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_organization_setting_in_document': - (JsonApiOrganizationSettingInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_organization_setting_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/notificationChannels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_organization_settings( + self, + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Post Organization Setting entities + + + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_organization_settings_serialize( + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_organization_settings_with_http_info( + self, + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Post Organization Setting entities + + + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_organization_settings_serialize( + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_organization_settings_without_preload_content( + self, + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Organization Setting entities + + + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_organization_settings_serialize( + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_organization_settings_serialize( + self, + json_api_organization_setting_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_setting_in_document is not None: + _body_params = json_api_organization_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes', - 'operation_id': 'create_entity_themes', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_theme_in_document', - ], - 'required': [ - 'json_api_theme_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_theme_in_document': - (JsonApiThemeInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_theme_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/organizationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_themes( + self, + json_api_theme_in_document: JsonApiThemeInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Post Theming + + + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_themes_serialize( + json_api_theme_in_document=json_api_theme_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_themes_with_http_info( + self, + json_api_theme_in_document: JsonApiThemeInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Post Theming + + + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_themes_serialize( + json_api_theme_in_document=json_api_theme_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_themes_without_preload_content( + self, + json_api_theme_in_document: JsonApiThemeInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Theming + + + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_themes_serialize( + json_api_theme_in_document=json_api_theme_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_themes_serialize( + self, + json_api_theme_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_theme_in_document is not None: + _body_params = json_api_theme_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'create_entity_user_data_filters', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_user_data_filter_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_user_data_filter_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_user_data_filter_post_optional_id_document': - (JsonApiUserDataFilterPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_user_data_filter_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/themes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_user_data_filters( + self, + workspace_id: StrictStr, + json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Post User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_user_data_filter_post_optional_id_document: (required) + :type json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_data_filters_serialize( + workspace_id=workspace_id, + json_api_user_data_filter_post_optional_id_document=json_api_user_data_filter_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Post User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_user_data_filter_post_optional_id_document: (required) + :type json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_data_filters_serialize( + workspace_id=workspace_id, + json_api_user_data_filter_post_optional_id_document=json_api_user_data_filter_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_user_data_filter_post_optional_id_document: (required) + :type json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_data_filters_serialize( + workspace_id=workspace_id, + json_api_user_data_filter_post_optional_id_document=json_api_user_data_filter_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_user_data_filters_serialize( + self, + workspace_id, + json_api_user_data_filter_post_optional_id_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_data_filter_post_optional_id_document is not None: + _body_params = json_api_user_data_filter_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups', - 'operation_id': 'create_entity_user_groups', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_user_group_in_document', - 'include', - ], - 'required': [ - 'json_api_user_group_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_user_group_in_document': - (JsonApiUserGroupInDocument,), - 'include': - ([str],), - }, - 'attribute_map': { - 'include': 'include', - }, - 'location_map': { - 'json_api_user_group_in_document': 'body', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_user_groups( + self, + json_api_user_group_in_document: JsonApiUserGroupInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Post User Group entities + + User Group - creates tree-like structure for categorizing users + + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_groups_serialize( + json_api_user_group_in_document=json_api_user_group_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_user_groups_with_http_info( + self, + json_api_user_group_in_document: JsonApiUserGroupInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Post User Group entities + + User Group - creates tree-like structure for categorizing users + + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_groups_serialize( + json_api_user_group_in_document=json_api_user_group_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_user_groups_without_preload_content( + self, + json_api_user_group_in_document: JsonApiUserGroupInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post User Group entities + + User Group - creates tree-like structure for categorizing users + + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_groups_serialize( + json_api_user_group_in_document=json_api_user_group_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_user_groups_serialize( + self, + json_api_user_group_in_document, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_group_in_document is not None: + _body_params = json_api_user_group_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', - 'operation_id': 'create_entity_user_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'json_api_user_setting_in_document', - ], - 'required': [ - 'user_id', - 'json_api_user_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'json_api_user_setting_in_document': - (JsonApiUserSettingInDocument,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - 'json_api_user_setting_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_user_settings( + self, + user_id: StrictStr, + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutDocument: + """Post new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_settings_serialize( + user_id=user_id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutDocument]: + """Post new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_settings_serialize( + user_id=user_id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_settings_serialize( + user_id=user_id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_user_settings_serialize( + self, + user_id, + json_api_user_setting_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_setting_in_document is not None: + _body_params = json_api_user_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users', - 'operation_id': 'create_entity_users', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_user_in_document', - 'include', - ], - 'required': [ - 'json_api_user_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_user_in_document': - (JsonApiUserInDocument,), - 'include': - ([str],), - }, - 'attribute_map': { - 'include': 'include', - }, - 'location_map': { - 'json_api_user_in_document': 'body', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/users/{userId}/userSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_users( + self, + json_api_user_in_document: JsonApiUserInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Post User entities + + User - represents entity interacting with platform + + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_users_serialize( + json_api_user_in_document=json_api_user_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_users_with_http_info( + self, + json_api_user_in_document: JsonApiUserInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Post User entities + + User - represents entity interacting with platform + + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_users_serialize( + json_api_user_in_document=json_api_user_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_users_without_preload_content( + self, + json_api_user_in_document: JsonApiUserInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post User entities + + User - represents entity interacting with platform + + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_users_serialize( + json_api_user_in_document=json_api_user_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_users_serialize( + self, + json_api_user_in_document, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_in_document is not None: + _body_params = json_api_user_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', - 'operation_id': 'create_entity_visualization_objects', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_visualization_object_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_visualization_object_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_visualization_object_post_optional_id_document': - (JsonApiVisualizationObjectPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_visualization_object_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_visualization_objects( + self, + workspace_id: StrictStr, + json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Post Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_visualization_object_post_optional_id_document: (required) + :type json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_visualization_objects_serialize( + workspace_id=workspace_id, + json_api_visualization_object_post_optional_id_document=json_api_visualization_object_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Post Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_visualization_object_post_optional_id_document: (required) + :type json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_visualization_objects_serialize( + workspace_id=workspace_id, + json_api_visualization_object_post_optional_id_document=json_api_visualization_object_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_visualization_object_post_optional_id_document: (required) + :type json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_visualization_objects_serialize( + workspace_id=workspace_id, + json_api_visualization_object_post_optional_id_document=json_api_visualization_object_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_visualization_objects_serialize( + self, + workspace_id, + json_api_visualization_object_post_optional_id_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_visualization_object_post_optional_id_document is not None: + _body_params = json_api_visualization_object_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', - 'operation_id': 'create_entity_workspace_data_filter_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_workspace_data_filter_setting_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_workspace_data_filter_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_workspace_data_filter_setting_in_document': - (JsonApiWorkspaceDataFilterSettingInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_workspace_data_filter_setting_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Post Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Post Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspace_data_filter_settings_serialize( + self, + workspace_id, + json_api_workspace_data_filter_setting_in_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_setting_in_document is not None: + _body_params = json_api_workspace_data_filter_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', - 'operation_id': 'create_entity_workspace_data_filters', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_workspace_data_filter_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_workspace_data_filter_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_workspace_data_filter_in_document': - (JsonApiWorkspaceDataFilterInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_workspace_data_filter_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Post Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Post Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspace_data_filters_serialize( + self, + workspace_id, + json_api_workspace_data_filter_in_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_in_document is not None: + _body_params = json_api_workspace_data_filter_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', - 'operation_id': 'create_entity_workspace_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_workspace_setting_post_optional_id_document', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_workspace_setting_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_workspace_setting_post_optional_id_document': - (JsonApiWorkspaceSettingPostOptionalIdDocument,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_workspace_setting_post_optional_id_document': 'body', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_workspace_settings( + self, + workspace_id: StrictStr, + json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Post Settings for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_setting_post_optional_id_document: (required) + :type json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_setting_post_optional_id_document=json_api_workspace_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Post Settings for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_setting_post_optional_id_document: (required) + :type json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_setting_post_optional_id_document=json_api_workspace_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Settings for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_setting_post_optional_id_document: (required) + :type json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_setting_post_optional_id_document=json_api_workspace_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspace_settings_serialize( + self, + workspace_id, + json_api_workspace_setting_post_optional_id_document, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_setting_post_optional_id_document is not None: + _body_params = json_api_workspace_setting_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.create_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces', - 'operation_id': 'create_entity_workspaces', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_workspace_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'json_api_workspace_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - ('meta_include',): { - - "CONFIG": "config", - "PERMISSIONS": "permissions", - "HIERARCHY": "hierarchy", - "DATAMODELDATASETS": "dataModelDatasets", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_workspace_in_document': - (JsonApiWorkspaceInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'json_api_workspace_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_workspaces( + self, + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Post Workspace entities + + Space of the shared interest + + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspaces_serialize( + json_api_workspace_in_document=json_api_workspace_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspaces_with_http_info( + self, + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Post Workspace entities + + Space of the shared interest + + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspaces_serialize( + json_api_workspace_in_document=json_api_workspace_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_workspaces_without_preload_content( + self, + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Workspace entities + + Space of the shared interest + + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspaces_serialize( + json_api_workspace_in_document=json_api_workspace_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspaces_serialize( + self, + json_api_workspace_in_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_in_document is not None: + _body_params = json_api_workspace_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.delete_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'delete_entity_analytical_dashboards', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens/{id}', - 'operation_id': 'delete_entity_api_tokens', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'delete_entity_attribute_hierarchies', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'delete_entity_automations', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'delete_entity_color_palettes', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'delete_entity_csp_directives', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'delete_entity_custom_application_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'delete_entity_dashboard_plugins', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'delete_entity_data_sources', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'delete_entity_export_definitions', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'delete_entity_export_templates', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'delete_entity_filter_contexts', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'delete_entity_filter_views', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'delete_entity_identity_providers', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'delete_entity_jwks', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'delete_entity_llm_endpoints', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'delete_entity_metrics', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'delete_entity_notification_channels', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'delete_entity_organization_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'delete_entity_themes', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'delete_entity_user_data_filters', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'delete_entity_user_groups', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'delete_entity_user_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'delete_entity_users', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'delete_entity_visualization_objects', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'delete_entity_workspace_data_filter_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'delete_entity_workspace_data_filters', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'delete_entity_workspace_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'delete_entity_workspaces', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_automations_workspace_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceAutomationOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organization/workspaceAutomations', - 'operation_id': 'get_all_automations_workspace_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "WORKSPACE": "workspace", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_aggregated_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAggregatedFactOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts', - 'operation_id': 'get_all_entities_aggregated_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "DATASETS": "datasets", - "FACTS": "facts", - "DATASET": "dataset", - "SOURCEFACT": "sourceFact", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', - 'operation_id': 'get_all_entities_analytical_dashboards', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiApiTokenOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens', - 'operation_id': 'get_all_entities_api_tokens', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [ - 'user_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'user_id': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'user_id': 'userId', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'user_id': 'path', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', - 'operation_id': 'get_all_entities_attribute_hierarchies', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_attributes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes', - 'operation_id': 'get_all_entities_attributes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "DATASETS": "datasets", - "LABELS": "labels", - "ATTRIBUTEHIERARCHIES": "attributeHierarchies", - "DATASET": "dataset", - "DEFAULTVIEW": "defaultView", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations', - 'operation_id': 'get_all_entities_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes', - 'operation_id': 'get_all_entities_color_palettes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives', - 'operation_id': 'get_all_entities_csp_directives', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', - 'operation_id': 'get_all_entities_custom_application_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', - 'operation_id': 'get_all_entities_dashboard_plugins', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_data_source_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceIdentifierOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers', - 'operation_id': 'get_all_entities_data_source_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources', - 'operation_id': 'get_all_entities_data_sources', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_datasets_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDatasetOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets', - 'operation_id': 'get_all_entities_datasets', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "FACTS": "facts", - "AGGREGATEDFACTS": "aggregatedFacts", - "DATASETS": "datasets", - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "REFERENCES": "references", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_entitlements_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiEntitlementOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/entitlements', - 'operation_id': 'get_all_entities_entitlements', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', - 'operation_id': 'get_all_entities_export_definitions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates', - 'operation_id': 'get_all_entities_export_templates', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFactOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts', - 'operation_id': 'get_all_entities_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "DATASETS": "datasets", - "DATASET": "dataset", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', - 'operation_id': 'get_all_entities_filter_contexts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', - 'operation_id': 'get_all_entities_filter_views', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders', - 'operation_id': 'get_all_entities_identity_providers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks', - 'operation_id': 'get_all_entities_jwks', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_labels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLabelOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels', - 'operation_id': 'get_all_entities_labels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "ATTRIBUTE": "attribute", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints', - 'operation_id': 'get_all_entities_llm_endpoints', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', - 'operation_id': 'get_all_entities_metrics', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_notification_channel_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelIdentifierOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers', - 'operation_id': 'get_all_entities_notification_channel_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels', - 'operation_id': 'get_all_entities_notification_channels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings', - 'operation_id': 'get_all_entities_organization_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes', - 'operation_id': 'get_all_entities_themes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'get_all_entities_user_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups', - 'operation_id': 'get_all_entities_user_groups', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserIdentifierOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userIdentifiers', - 'operation_id': 'get_all_entities_user_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', - 'operation_id': 'get_all_entities_user_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [ - 'user_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'user_id': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'user_id': 'userId', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'user_id': 'path', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users', - 'operation_id': 'get_all_entities_users', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', - 'operation_id': 'get_all_entities_visualization_objects', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', - 'operation_id': 'get_all_entities_workspace_data_filter_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', - 'operation_id': 'get_all_entities_workspace_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', - 'operation_id': 'get_all_entities_workspace_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces', - 'operation_id': 'get_all_entities_workspaces', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - ('meta_include',): { - - "CONFIG": "config", - "PERMISSIONS": "permissions", - "HIERARCHY": "hierarchy", - "DATAMODELDATASETS": "dataModelDatasets", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_options_endpoint = _Endpoint( - settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), - 'auth': [], - 'endpoint_path': '/api/v1/options', - 'operation_id': 'get_all_options', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_data_source_drivers_endpoint = _Endpoint( - settings={ - 'response_type': ({str: (str,)},), - 'auth': [], - 'endpoint_path': '/api/v1/options/availableDrivers', - 'operation_id': 'get_data_source_drivers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_aggregated_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAggregatedFactOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}', - 'operation_id': 'get_entity_aggregated_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "FACTS": "facts", - "DATASET": "dataset", - "SOURCEFACT": "sourceFact", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'get_entity_analytical_dashboards', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiApiTokenOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens/{id}', - 'operation_id': 'get_entity_api_tokens', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'get_entity_attribute_hierarchies', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_attributes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}', - 'operation_id': 'get_entity_attributes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "LABELS": "labels", - "ATTRIBUTEHIERARCHIES": "attributeHierarchies", - "DATASET": "dataset", - "DEFAULTVIEW": "defaultView", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'get_entity_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'get_entity_color_palettes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_cookie_security_configurations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'get_entity_cookie_security_configurations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'get_entity_csp_directives', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'get_entity_custom_application_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'get_entity_dashboard_plugins', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_data_source_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceIdentifierOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers/{id}', - 'operation_id': 'get_entity_data_source_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'get_entity_data_sources', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_datasets_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDatasetOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', - 'operation_id': 'get_entity_datasets', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "FACTS": "facts", - "AGGREGATEDFACTS": "aggregatedFacts", - "DATASETS": "datasets", - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "REFERENCES": "references", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_entitlements_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiEntitlementOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/entitlements/{id}', - 'operation_id': 'get_entity_entitlements', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'get_entity_export_definitions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'get_entity_export_templates', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFactOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}', - 'operation_id': 'get_entity_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "DATASET": "dataset", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'get_entity_filter_contexts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'get_entity_filter_views', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'get_entity_identity_providers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'get_entity_jwks', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_labels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLabelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}', - 'operation_id': 'get_entity_labels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "ATTRIBUTE": "attribute", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'get_entity_llm_endpoints', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'get_entity_metrics', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_notification_channel_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelIdentifierOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers/{id}', - 'operation_id': 'get_entity_notification_channel_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'get_entity_notification_channels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'get_entity_organization_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_organizations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'get_entity_organizations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'get_entity_themes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'get_entity_user_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'get_entity_user_groups', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserIdentifierOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userIdentifiers/{id}', - 'operation_id': 'get_entity_user_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'get_entity_user_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'get_entity_users', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'get_entity_visualization_objects', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'get_entity_workspace_data_filter_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'get_entity_workspace_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'get_entity_workspace_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'get_entity_workspaces', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - ('meta_include',): { - - "CONFIG": "config", - "PERMISSIONS": "permissions", - "HIERARCHY": "hierarchy", - "DATAMODELDATASETS": "dataModelDatasets", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_organization_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/organization', - 'operation_id': 'get_organization', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all" - }, - }, - 'openapi_types': { - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'patch_entity_analytical_dashboards', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_analytical_dashboard_patch_document': - (JsonApiAnalyticalDashboardPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_analytical_dashboard_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'patch_entity_attribute_hierarchies', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_attribute_hierarchy_patch_document': - (JsonApiAttributeHierarchyPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_attribute_hierarchy_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'patch_entity_automations', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_automation_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_automation_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_automation_patch_document': - (JsonApiAutomationPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_automation_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'patch_entity_color_palettes', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_color_palette_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_color_palette_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_color_palette_patch_document': - (JsonApiColorPalettePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_color_palette_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_cookie_security_configurations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'patch_entity_cookie_security_configurations', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_cookie_security_configuration_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_cookie_security_configuration_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_cookie_security_configuration_patch_document': - (JsonApiCookieSecurityConfigurationPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_cookie_security_configuration_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'patch_entity_csp_directives', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_csp_directive_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_csp_directive_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_csp_directive_patch_document': - (JsonApiCspDirectivePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_csp_directive_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'patch_entity_custom_application_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_patch_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_custom_application_setting_patch_document': - (JsonApiCustomApplicationSettingPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_custom_application_setting_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'patch_entity_dashboard_plugins', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_dashboard_plugin_patch_document': - (JsonApiDashboardPluginPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_dashboard_plugin_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'patch_entity_data_sources', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_data_source_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_data_source_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_data_source_patch_document': - (JsonApiDataSourcePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_data_source_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'patch_entity_export_definitions', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_export_definition_patch_document': - (JsonApiExportDefinitionPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_export_definition_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'patch_entity_export_templates', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_export_template_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_export_template_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_export_template_patch_document': - (JsonApiExportTemplatePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_export_template_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_analytical_dashboards_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_api_tokens( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_api_tokens_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_api_tokens_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_api_tokens_serialize( + self, + user_id, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/users/{userId}/apiTokens/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_attribute_hierarchies_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_automations_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_color_palettes( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_color_palettes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_color_palettes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_color_palettes_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_csp_directives_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_custom_application_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_custom_application_settings_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_dashboard_plugins_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_data_sources( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_data_sources_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_data_sources_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_data_sources_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_data_sources_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_export_definitions_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_export_templates_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_filter_contexts_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_filter_views_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_identity_providers_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Jwk + + Deletes JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Jwk + + Deletes JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Jwk + + Deletes JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_jwks_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_llm_endpoints( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """delete_entity_llm_endpoints + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_llm_endpoints_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """delete_entity_llm_endpoints + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_llm_endpoints_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """delete_entity_llm_endpoints + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_llm_endpoints_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_metrics( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_metrics_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_notification_channels( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_notification_channels_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_notification_channels_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_notification_channels_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_organization_settings( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_organization_settings_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_themes_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_user_data_filters_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_groups_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_groups_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_groups_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_user_groups_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_user_settings( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_user_settings_serialize( + self, + user_id, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/users/{userId}/userSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_users( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_users_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_users_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_users_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_users_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_users_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_users_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_visualization_objects_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_workspace_data_filter_settings_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_workspace_data_filters_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_workspace_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_workspace_settings_serialize( + self, + workspace_id, + object_id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_workspaces( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspaces_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspaces_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspaces_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_workspaces_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspaces_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_workspaces_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_automations_workspace_automations( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceAutomationOutList: + """Get all Automations across all Workspaces + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_automations_workspace_automations_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_automations_workspace_automations_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceAutomationOutList]: + """Get all Automations across all Workspaces + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_automations_workspace_automations_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_automations_workspace_automations_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Automations across all Workspaces + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_automations_workspace_automations_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_automations_workspace_automations_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'patch_entity_filter_contexts', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_context_patch_document': - (JsonApiFilterContextPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_context_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/organization/workspaceAutomations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_aggregated_facts( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAggregatedFactOutList: + """get_all_entities_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_aggregated_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_aggregated_facts_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAggregatedFactOutList]: + """get_all_entities_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_aggregated_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_aggregated_facts_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_all_entities_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_aggregated_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_aggregated_facts_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'patch_entity_filter_views', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_view_patch_document': - (JsonApiFilterViewPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_view_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_analytical_dashboards( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutList: + """Get all Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_analytical_dashboards_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutList]: + """Get all Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_analytical_dashboards_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_analytical_dashboards_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_analytical_dashboards_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'patch_entity_identity_providers', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_identity_provider_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_identity_provider_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_identity_provider_patch_document': - (JsonApiIdentityProviderPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_identity_provider_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_api_tokens( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiApiTokenOutList: + """List all api tokens for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_api_tokens_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_api_tokens_with_http_info( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiApiTokenOutList]: + """List all api tokens for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_api_tokens_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_api_tokens_without_preload_content( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """List all api tokens for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_api_tokens_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_api_tokens_serialize( + self, + user_id, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'patch_entity_jwks', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_jwk_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_jwk_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_jwk_patch_document': - (JsonApiJwkPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_jwk_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/apiTokens', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_attribute_hierarchies( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutList: + """Get all Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attribute_hierarchies_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutList]: + """Get all Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attribute_hierarchies_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attribute_hierarchies_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_attribute_hierarchies_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'patch_entity_llm_endpoints', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_llm_endpoint_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_llm_endpoint_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_llm_endpoint_patch_document': - (JsonApiLlmEndpointPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_llm_endpoint_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_attributes( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeOutList: + """Get all Attributes + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attributes_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_attributes_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeOutList]: + """Get all Attributes + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attributes_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_attributes_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Attributes + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attributes_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_attributes_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'patch_entity_metrics', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_metric_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_metric_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_metric_patch_document': - (JsonApiMetricPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_metric_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_automations( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutList: + """Get all Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_automations_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_automations_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutList]: + """Get all Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_automations_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_automations_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_automations_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_automations_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'patch_entity_notification_channels', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_notification_channel_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_notification_channel_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_notification_channel_patch_document': - (JsonApiNotificationChannelPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_notification_channel_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_color_palettes( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutList: + """Get all Color Pallettes + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_color_palettes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_color_palettes_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutList]: + """Get all Color Pallettes + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_color_palettes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_color_palettes_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Color Pallettes + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_color_palettes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_color_palettes_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'patch_entity_organization_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_setting_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_organization_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_setting_patch_document': - (JsonApiOrganizationSettingPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_setting_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/colorPalettes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_csp_directives( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutList: + """Get CSP Directives + + Context Security Police Directive + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_csp_directives_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_csp_directives_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutList]: + """Get CSP Directives + + Context Security Police Directive + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_csp_directives_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_csp_directives_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get CSP Directives + + Context Security Police Directive + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_csp_directives_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_csp_directives_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_organizations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'patch_entity_organizations', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_organization_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_patch_document': - (JsonApiOrganizationPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/cspDirectives', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_custom_application_settings( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutList: + """Get all Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_custom_application_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutList]: + """Get all Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_custom_application_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_custom_application_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_custom_application_settings_serialize( + self, + workspace_id, + origin, + filter, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'patch_entity_themes', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_theme_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_theme_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_theme_patch_document': - (JsonApiThemePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_theme_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_dashboard_plugins( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutList: + """Get all Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_dashboard_plugins_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutList]: + """Get all Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_dashboard_plugins_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_dashboard_plugins_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_dashboard_plugins_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'patch_entity_user_data_filters', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_user_data_filter_patch_document': - (JsonApiUserDataFilterPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_user_data_filter_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_data_source_identifiers( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceIdentifierOutList: + """Get all Data Source Identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_source_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_data_source_identifiers_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceIdentifierOutList]: + """Get all Data Source Identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_source_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_data_source_identifiers_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Data Source Identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_source_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_data_source_identifiers_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'patch_entity_user_groups', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_group_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_group_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_group_patch_document': - (JsonApiUserGroupPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_group_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSourceIdentifiers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_data_sources( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutList: + """Get Data Source entities + + Data Source - represents data source for the workspace + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_sources_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_data_sources_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutList]: + """Get Data Source entities + + Data Source - represents data source for the workspace + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_sources_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_data_sources_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Data Source entities + + Data Source - represents data source for the workspace + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_sources_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_data_sources_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'patch_entity_users', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_patch_document': - (JsonApiUserPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_datasets( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDatasetOutList: + """Get all Datasets + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_datasets_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_datasets_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDatasetOutList]: + """Get all Datasets + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_datasets_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_datasets_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Datasets + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_datasets_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_datasets_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'patch_entity_visualization_objects', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_visualization_object_patch_document': - (JsonApiVisualizationObjectPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_visualization_object_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/datasets', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_entitlements( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiEntitlementOutList: + """Get Entitlements + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_entitlements_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_entitlements_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiEntitlementOutList]: + """Get Entitlements + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_entitlements_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_entitlements_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Entitlements + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_entitlements_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_entitlements_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'patch_entity_workspace_data_filter_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_setting_patch_document': - (JsonApiWorkspaceDataFilterSettingPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_setting_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/entitlements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_export_definitions( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutList: + """Get all Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_definitions_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutList]: + """Get all Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_definitions_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_definitions_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_export_definitions_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'patch_entity_workspace_data_filters', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_patch_document': - (JsonApiWorkspaceDataFilterPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_export_templates( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutList: + """GET all Export Template entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_templates_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_export_templates_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutList]: + """GET all Export Template entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_templates_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_export_templates_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """GET all Export Template entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_templates_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_export_templates_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'patch_entity_workspace_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_patch_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_setting_patch_document': - (JsonApiWorkspaceSettingPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_setting_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/exportTemplates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_facts( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFactOutList: + """Get all Facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_facts_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFactOutList]: + """Get all Facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_facts_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_facts_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'patch_entity_workspaces', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_workspace_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_workspace_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_workspace_patch_document': - (JsonApiWorkspacePatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_workspace_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/facts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_filter_contexts( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutList: + """Get all Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_contexts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutList]: + """Get all Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_contexts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_contexts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_filter_contexts_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'update_entity_analytical_dashboards', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_analytical_dashboard_in_document': - (JsonApiAnalyticalDashboardInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_analytical_dashboard_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_filter_views( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutList: + """Get all Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_views_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_filter_views_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutList]: + """Get all Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_views_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_views_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_filter_views_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'update_entity_attribute_hierarchies', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_attribute_hierarchy_in_document': - (JsonApiAttributeHierarchyInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_attribute_hierarchy_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_identity_providers( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutList: + """Get all Identity Providers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_identity_providers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_identity_providers_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutList]: + """Get all Identity Providers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_identity_providers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_identity_providers_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Identity Providers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_identity_providers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_identity_providers_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'update_entity_automations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_automation_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_automation_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_automation_in_document': - (JsonApiAutomationInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_automation_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/identityProviders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_jwks( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutList: + """Get all Jwks + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_jwks_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_jwks_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutList]: + """Get all Jwks + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_jwks_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_jwks_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Jwks + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_jwks_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_jwks_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'update_entity_color_palettes', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_color_palette_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_color_palette_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_color_palette_in_document': - (JsonApiColorPaletteInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_color_palette_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/jwks', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_labels( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLabelOutList: + """Get all Labels + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_labels_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_labels_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLabelOutList]: + """Get all Labels + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_labels_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_labels_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Labels + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_labels_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_labels_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_cookie_security_configurations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'update_entity_cookie_security_configurations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_cookie_security_configuration_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_cookie_security_configuration_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_cookie_security_configuration_in_document': - (JsonApiCookieSecurityConfigurationInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_cookie_security_configuration_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/labels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_llm_endpoints( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutList: + """Get all LLM endpoint entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_llm_endpoints_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_llm_endpoints_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutList]: + """Get all LLM endpoint entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_llm_endpoints_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_llm_endpoints_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all LLM endpoint entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_llm_endpoints_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_llm_endpoints_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'update_entity_csp_directives', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_csp_directive_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_csp_directive_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_csp_directive_in_document': - (JsonApiCspDirectiveInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_csp_directive_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/llmEndpoints', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_metrics( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutList: + """Get all Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_metrics_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_metrics_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutList]: + """Get all Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_metrics_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_metrics_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_metrics_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_metrics_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'update_entity_custom_application_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_in_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_custom_application_setting_in_document': - (JsonApiCustomApplicationSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_custom_application_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_notification_channel_identifiers( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelIdentifierOutList: + """get_all_entities_notification_channel_identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channel_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_notification_channel_identifiers_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelIdentifierOutList]: + """get_all_entities_notification_channel_identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channel_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_notification_channel_identifiers_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_all_entities_notification_channel_identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channel_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_notification_channel_identifiers_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'update_entity_dashboard_plugins', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_dashboard_plugin_in_document': - (JsonApiDashboardPluginInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_dashboard_plugin_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannelIdentifiers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_notification_channels( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutList: + """Get all Notification Channel entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channels_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_notification_channels_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutList]: + """Get all Notification Channel entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channels_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_notification_channels_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Notification Channel entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channels_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_notification_channels_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'update_entity_data_sources', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_data_source_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_data_source_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_data_source_in_document': - (JsonApiDataSourceInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_data_source_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_organization_settings( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutList: + """Get Organization entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_organization_settings_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_organization_settings_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutList]: + """Get Organization entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_organization_settings_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_organization_settings_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Organization entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_organization_settings_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_organization_settings_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'update_entity_export_definitions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_export_definition_in_document': - (JsonApiExportDefinitionInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_export_definition_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/organizationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_themes( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutList: + """Get all Theming entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_themes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_themes_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutList]: + """Get all Theming entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_themes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_themes_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Theming entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_themes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_themes_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'update_entity_export_templates', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_export_template_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_export_template_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_export_template_in_document': - (JsonApiExportTemplateInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_export_template_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/themes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_user_data_filters( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutList: + """Get all User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutList]: + """Get all User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_user_data_filters_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'update_entity_filter_contexts', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_context_in_document': - (JsonApiFilterContextInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_context_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_user_groups( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutList: + """Get UserGroup entities + + User Group - creates tree-like structure for categorizing users + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_groups_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_groups_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutList]: + """Get UserGroup entities + + User Group - creates tree-like structure for categorizing users + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_groups_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_user_groups_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserGroup entities + + User Group - creates tree-like structure for categorizing users + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_groups_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_user_groups_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'update_entity_filter_views', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_view_in_document': - (JsonApiFilterViewInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_view_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_user_identifiers( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserIdentifierOutList: + """Get UserIdentifier entities + + UserIdentifier - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_identifiers_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserIdentifierOutList]: + """Get UserIdentifier entities + + UserIdentifier - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_user_identifiers_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserIdentifier entities + + UserIdentifier - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_user_identifiers_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'update_entity_identity_providers', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_identity_provider_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_identity_provider_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_identity_provider_in_document': - (JsonApiIdentityProviderInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_identity_provider_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userIdentifiers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_user_settings( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutList: + """List all settings for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_settings_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_settings_with_http_info( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutList]: + """List all settings for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_settings_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_user_settings_without_preload_content( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """List all settings for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_settings_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_user_settings_serialize( + self, + user_id, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'update_entity_jwks', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_jwk_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_jwk_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_jwk_in_document': - (JsonApiJwkInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_jwk_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/userSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_users( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutList: + """Get User entities + + User - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_users_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_users_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutList]: + """Get User entities + + User - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_users_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_users_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get User entities + + User - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_users_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_users_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'update_entity_llm_endpoints', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_llm_endpoint_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_llm_endpoint_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_llm_endpoint_in_document': - (JsonApiLlmEndpointInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_llm_endpoint_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_visualization_objects( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutList: + """Get all Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_visualization_objects_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutList]: + """Get all Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_visualization_objects_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_visualization_objects_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_visualization_objects_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'update_entity_metrics', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_metric_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_metric_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_metric_in_document': - (JsonApiMetricInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_metric_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutList: + """Get all Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutList]: + """Get all Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_workspace_data_filter_settings_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'update_entity_notification_channels', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_notification_channel_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_notification_channel_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_notification_channel_in_document': - (JsonApiNotificationChannelInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_notification_channel_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_workspace_data_filters( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutList: + """Get all Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutList]: + """Get all Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_workspace_data_filters_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'update_entity_organization_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_setting_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_organization_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_setting_in_document': - (JsonApiOrganizationSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_workspace_settings( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutList: + """Get all Setting for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutList]: + """Get all Setting for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Setting for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_workspace_settings_serialize( + self, + workspace_id, + origin, + filter, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_organizations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'update_entity_organizations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_organization_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_in_document': - (JsonApiOrganizationInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_workspaces( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutList: + """Get Workspace entities + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspaces_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspaces_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutList]: + """Get Workspace entities + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspaces_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_workspaces_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Workspace entities + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspaces_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_workspaces_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'update_entity_themes', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_theme_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_theme_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_theme_in_document': - (JsonApiThemeInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_theme_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_options( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> object: + """Links for all configuration options + + Retrieves links for all options for different configurations. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_options_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_options_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[object]: + """Links for all configuration options + + Retrieves links for all options for different configurations. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_options_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_options_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Links for all configuration options + + Retrieves links for all options for different configurations. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_options_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_options_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' ] - }, - api_client=api_client - ) - self.update_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'update_entity_user_data_filters', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/options', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_data_source_drivers( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> Dict[str, str]: + """Get all available data source drivers + + Retrieves a list of all supported data sources along with information about the used drivers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_drivers_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Dict[str, str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_source_drivers_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[Dict[str, str]]: + """Get all available data source drivers + + Retrieves a list of all supported data sources along with information about the used drivers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_drivers_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Dict[str, str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_data_source_drivers_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all available data source drivers + + Retrieves a list of all supported data sources along with information about the used drivers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_drivers_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Dict[str, str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_data_source_drivers_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_user_data_filter_in_document': - (JsonApiUserDataFilterInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_user_data_filter_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/options/availableDrivers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_aggregated_facts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAggregatedFactOutDocument: + """get_entity_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_aggregated_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_aggregated_facts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAggregatedFactOutDocument]: + """get_entity_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_aggregated_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_aggregated_facts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_entity_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_aggregated_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_aggregated_facts_serialize( + self, + workspace_id, + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'update_entity_user_groups', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_group_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_group_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_group_in_document': - (JsonApiUserGroupInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_group_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Get a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Get a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_analytical_dashboards_serialize( + self, + workspace_id, + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'update_entity_user_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'json_api_user_setting_in_document', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - 'json_api_user_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'json_api_user_setting_in_document': - (JsonApiUserSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'json_api_user_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_api_tokens( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiApiTokenOutDocument: + """Get an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_api_tokens_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiApiTokenOutDocument]: + """Get an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_api_tokens_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_api_tokens_serialize( + self, + user_id, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'update_entity_users', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_in_document': - (JsonApiUserInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/apiTokens/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Get an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Get an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_attribute_hierarchies_serialize( + self, + workspace_id, + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'update_entity_visualization_objects', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_visualization_object_in_document': - (JsonApiVisualizationObjectInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_visualization_object_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_attributes( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeOutDocument: + """Get an Attribute + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attributes_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_attributes_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeOutDocument]: + """Get an Attribute + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attributes_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_attributes_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Attribute + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attributes_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_attributes_serialize( + self, + workspace_id, + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'update_entity_workspace_data_filter_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_setting_in_document': - (JsonApiWorkspaceDataFilterSettingInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_setting_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Get an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Get an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_automations_serialize( + self, + workspace_id, + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'update_entity_workspace_data_filters', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_in_document': - (JsonApiWorkspaceDataFilterInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_color_palettes( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Get Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_color_palettes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Get Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_color_palettes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_color_palettes_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'update_entity_workspace_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_in_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_setting_in_document': - (JsonApiWorkspaceSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_cookie_security_configurations( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCookieSecurityConfigurationOutDocument: + """Get CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_cookie_security_configurations_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_cookie_security_configurations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCookieSecurityConfigurationOutDocument]: + """Get CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_cookie_security_configurations_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_cookie_security_configurations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_cookie_security_configurations_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_cookie_security_configurations_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'update_entity_workspaces', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_workspace_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_workspace_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_workspace_in_document': - (JsonApiWorkspaceInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_workspace_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Get CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Get CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_csp_directives_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - def create_entity_analytical_dashboards( - self, - workspace_id, - json_api_analytical_dashboard_post_optional_id_document, - **kwargs - ): - """Post Dashboards # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_analytical_dashboard_post_optional_id_document (JsonApiAnalyticalDashboardPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_analytical_dashboard_post_optional_id_document'] = \ - json_api_analytical_dashboard_post_optional_id_document - return self.create_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - def create_entity_api_tokens( + + + @validate_call + def get_entity_custom_application_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Get a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Get a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_custom_application_settings_without_preload_content( self, - user_id, - json_api_api_token_in_document, - **kwargs - ): - """Post a new API token for the user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_api_tokens(user_id, json_api_api_token_in_document, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - json_api_api_token_in_document (JsonApiApiTokenInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiApiTokenOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['json_api_api_token_in_document'] = \ - json_api_api_token_in_document - return self.create_entity_api_tokens_endpoint.call_with_http_info(**kwargs) - - def create_entity_attribute_hierarchies( + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_custom_application_settings_serialize( self, workspace_id, - json_api_attribute_hierarchy_in_document, - **kwargs - ): - """Post Attribute Hierarchies # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_attribute_hierarchy_in_document'] = \ - json_api_attribute_hierarchy_in_document - return self.create_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + object_id, + filter, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def create_entity_automations( - self, - workspace_id, - json_api_automation_in_document, - **kwargs - ): - """Post Automations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_automations(workspace_id, json_api_automation_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.create_entity_automations_endpoint.call_with_http_info(**kwargs) - def create_entity_color_palettes( - self, - json_api_color_palette_in_document, - **kwargs - ): - """Post Color Pallettes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_color_palettes(json_api_color_palette_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_color_palette_in_document (JsonApiColorPaletteInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_color_palette_in_document'] = \ - json_api_color_palette_in_document - return self.create_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def create_entity_csp_directives( - self, - json_api_csp_directive_in_document, - **kwargs - ): - """Post CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_csp_directives(json_api_csp_directive_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_csp_directive_in_document'] = \ - json_api_csp_directive_in_document - return self.create_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def create_entity_custom_application_settings( - self, - workspace_id, - json_api_custom_application_setting_post_optional_id_document, - **kwargs - ): - """Post Custom Application Settings # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_custom_application_setting_post_optional_id_document (JsonApiCustomApplicationSettingPostOptionalIdDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_custom_application_setting_post_optional_id_document'] = \ - json_api_custom_application_setting_post_optional_id_document - return self.create_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_dashboard_plugins( - self, - workspace_id, - json_api_dashboard_plugin_post_optional_id_document, - **kwargs - ): - """Post Plugins # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_dashboard_plugin_post_optional_id_document (JsonApiDashboardPluginPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_dashboard_plugin_post_optional_id_document'] = \ - json_api_dashboard_plugin_post_optional_id_document - return self.create_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def create_entity_data_sources( - self, - json_api_data_source_in_document, - **kwargs - ): - """Post Data Sources # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_data_sources(json_api_data_source_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_data_source_in_document (JsonApiDataSourceInDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_data_source_in_document'] = \ - json_api_data_source_in_document - return self.create_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def create_entity_export_definitions( + @validate_call + def get_entity_dashboard_plugins( self, - workspace_id, - json_api_export_definition_post_optional_id_document, - **kwargs - ): - """Post Export Definitions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_export_definition_post_optional_id_document (JsonApiExportDefinitionPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_export_definition_post_optional_id_document'] = \ - json_api_export_definition_post_optional_id_document - return self.create_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - - def create_entity_export_templates( + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Get a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_dashboard_plugins_with_http_info( self, - json_api_export_template_post_optional_id_document, - **kwargs - ): - """Post Export Template entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_export_template_post_optional_id_document'] = \ - json_api_export_template_post_optional_id_document - return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) - - def create_entity_filter_contexts( + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Get a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_dashboard_plugins_without_preload_content( self, - workspace_id, - json_api_filter_context_post_optional_id_document, - **kwargs - ): - """Post Context Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_filter_context_post_optional_id_document (JsonApiFilterContextPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_filter_context_post_optional_id_document'] = \ - json_api_filter_context_post_optional_id_document - return self.create_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - - def create_entity_filter_views( + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_dashboard_plugins_serialize( self, workspace_id, - json_api_filter_view_in_document, - **kwargs - ): - """Post Filter views # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.create_entity_filter_views_endpoint.call_with_http_info(**kwargs) + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def create_entity_identity_providers( - self, - json_api_identity_provider_in_document, - **kwargs - ): - """Post Identity Providers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_identity_providers(json_api_identity_provider_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_identity_provider_in_document'] = \ - json_api_identity_provider_in_document - return self.create_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def create_entity_jwks( - self, - json_api_jwk_in_document, - **kwargs - ): - """Post Jwks # noqa: E501 - - Creates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_jwks(json_api_jwk_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_jwk_in_document (JsonApiJwkInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.create_entity_jwks_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def create_entity_llm_endpoints( - self, - json_api_llm_endpoint_in_document, - **kwargs - ): - """Post LLM endpoint entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_llm_endpoints(json_api_llm_endpoint_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_llm_endpoint_in_document (JsonApiLlmEndpointInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_llm_endpoint_in_document'] = \ - json_api_llm_endpoint_in_document - return self.create_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def create_entity_metrics( - self, - workspace_id, - json_api_metric_post_optional_id_document, - **kwargs - ): - """Post Metrics # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_metric_post_optional_id_document (JsonApiMetricPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_metric_post_optional_id_document'] = \ - json_api_metric_post_optional_id_document - return self.create_entity_metrics_endpoint.call_with_http_info(**kwargs) - def create_entity_notification_channels( - self, - json_api_notification_channel_post_optional_id_document, - **kwargs - ): - """Post Notification Channel entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_notification_channel_post_optional_id_document (JsonApiNotificationChannelPostOptionalIdDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_notification_channel_post_optional_id_document'] = \ - json_api_notification_channel_post_optional_id_document - return self.create_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def create_entity_organization_settings( - self, - json_api_organization_setting_in_document, - **kwargs - ): - """Post Organization Setting entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_organization_settings(json_api_organization_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_organization_setting_in_document'] = \ - json_api_organization_setting_in_document - return self.create_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_themes( + @validate_call + def get_entity_data_source_identifiers( self, - json_api_theme_in_document, - **kwargs - ): - """Post Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_themes(json_api_theme_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_theme_in_document (JsonApiThemeInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_theme_in_document'] = \ - json_api_theme_in_document - return self.create_entity_themes_endpoint.call_with_http_info(**kwargs) - - def create_entity_user_data_filters( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceIdentifierOutDocument: + """Get Data Source Identifier + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_source_identifiers_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_data_source_identifiers_with_http_info( self, - workspace_id, - json_api_user_data_filter_post_optional_id_document, - **kwargs - ): - """Post User Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_user_data_filter_post_optional_id_document (JsonApiUserDataFilterPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_user_data_filter_post_optional_id_document'] = \ - json_api_user_data_filter_post_optional_id_document - return self.create_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - - def create_entity_user_groups( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceIdentifierOutDocument]: + """Get Data Source Identifier + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_source_identifiers_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_data_source_identifiers_without_preload_content( self, - json_api_user_group_in_document, - **kwargs - ): - """Post User Group entities # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_user_groups(json_api_user_group_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_user_group_in_document (JsonApiUserGroupInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_group_in_document'] = \ - json_api_user_group_in_document - return self.create_entity_user_groups_endpoint.call_with_http_info(**kwargs) - - def create_entity_user_settings( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Data Source Identifier + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_source_identifiers_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_data_source_identifiers_serialize( self, - user_id, - json_api_user_setting_in_document, - **kwargs - ): - """Post new user settings for the user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_user_settings(user_id, json_api_user_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - json_api_user_setting_in_document (JsonApiUserSettingInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['json_api_user_setting_in_document'] = \ - json_api_user_setting_in_document - return self.create_entity_user_settings_endpoint.call_with_http_info(**kwargs) + id, + filter, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def create_entity_users( - self, - json_api_user_in_document, - **kwargs - ): - """Post User entities # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_users(json_api_user_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_user_in_document (JsonApiUserInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_in_document'] = \ - json_api_user_in_document - return self.create_entity_users_endpoint.call_with_http_info(**kwargs) - def create_entity_visualization_objects( - self, - workspace_id, - json_api_visualization_object_post_optional_id_document, - **kwargs - ): - """Post Visualization Objects # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_visualization_object_post_optional_id_document (JsonApiVisualizationObjectPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_visualization_object_post_optional_id_document'] = \ - json_api_visualization_object_post_optional_id_document - return self.create_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def create_entity_workspace_data_filter_settings( - self, - workspace_id, - json_api_workspace_data_filter_setting_in_document, - **kwargs - ): - """Post Settings for Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_data_filter_setting_in_document'] = \ - json_api_workspace_data_filter_setting_in_document - return self.create_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSourceIdentifiers/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def create_entity_workspace_data_filters( - self, - workspace_id, - json_api_workspace_data_filter_in_document, - **kwargs - ): - """Post Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_data_filter_in_document'] = \ - json_api_workspace_data_filter_in_document - return self.create_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def create_entity_workspace_settings( - self, - workspace_id, - json_api_workspace_setting_post_optional_id_document, - **kwargs - ): - """Post Settings for Workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_setting_post_optional_id_document (JsonApiWorkspaceSettingPostOptionalIdDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_setting_post_optional_id_document'] = \ - json_api_workspace_setting_post_optional_id_document - return self.create_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_workspaces( - self, - json_api_workspace_in_document, - **kwargs - ): - """Post Workspace entities # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspaces(json_api_workspace_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_workspace_in_document (JsonApiWorkspaceInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_workspace_in_document'] = \ - json_api_workspace_in_document - return self.create_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def delete_entity_analytical_dashboards( + @validate_call + def get_entity_data_sources( self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_analytical_dashboards(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - - def delete_entity_api_tokens( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Get Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_sources_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Get Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_sources_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_sources_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_data_sources_serialize( self, - user_id, id, - **kwargs - ): - """Delete an API Token for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_api_tokens(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.delete_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + filter, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_attribute_hierarchies( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def delete_entity_automations( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_automations(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_automations_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def delete_entity_color_palettes( - self, - id, - **kwargs - ): - """Delete a Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_color_palettes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def delete_entity_csp_directives( - self, - id, - **kwargs - ): - """Delete CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_csp_directives(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def delete_entity_custom_application_settings( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_custom_application_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_dashboard_plugins( + + @validate_call + def get_entity_datasets( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDatasetOutDocument: + """Get a Dataset + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_datasets_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_datasets_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDatasetOutDocument]: + """Get a Dataset + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_datasets_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_datasets_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Dataset + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_datasets_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_datasets_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_dashboard_plugins(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_data_sources( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_entitlements( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiEntitlementOutDocument: + """Get Entitlement + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_entitlements_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_entitlements_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiEntitlementOutDocument]: + """Get Entitlement + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_entitlements_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_entitlements_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Entitlement + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_entitlements_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_entitlements_serialize( self, id, - **kwargs - ): - """Delete Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_data_sources(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_data_sources_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_export_definitions( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/entitlements/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Get an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Get an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_export_definitions_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_export_definitions(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_export_templates( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """GET Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """GET Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """GET Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_export_templates_serialize( self, id, - **kwargs - ): - """Delete Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_export_templates(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_filter_contexts( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_filter_contexts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - def delete_entity_filter_views( + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_facts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFactOutDocument: + """Get a Fact + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_facts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFactOutDocument]: + """Get a Fact + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_facts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Fact + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_facts_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_filter_views(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_identity_providers( - self, - id, - **kwargs - ): - """Delete Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_identity_providers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def delete_entity_jwks( - self, - id, - **kwargs - ): - """Delete Jwk # noqa: E501 - - Deletes JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_jwks(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_jwks_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def delete_entity_llm_endpoints( - self, - id, - **kwargs - ): - """delete_entity_llm_endpoints # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_llm_endpoints(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def delete_entity_metrics( + + + + @validate_call + def get_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Get a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Get a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_filter_contexts_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_metrics(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_metrics_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_notification_channels( - self, - id, - **kwargs - ): - """Delete Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_notification_channels(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def delete_entity_organization_settings( - self, - id, - **kwargs - ): - """Delete Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_organization_settings(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def delete_entity_themes( - self, - id, - **kwargs - ): - """Delete Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_themes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_themes_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def delete_entity_user_data_filters( + + + + @validate_call + def get_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Get Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Get Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_filter_views_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_user_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_user_groups( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Get Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Get Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_identity_providers_serialize( self, id, - **kwargs - ): - """Delete UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_user_groups(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_user_groups_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_user_settings( - self, - user_id, - id, - **kwargs - ): - """Delete a setting for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_user_settings(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.delete_entity_user_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_users( - self, - id, - **kwargs - ): - """Delete User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_users(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_users_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def delete_entity_visualization_objects( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_visualization_objects(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def delete_entity_workspace_data_filter_settings( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Settings for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_data_filters( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_settings( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspaces( + @validate_call + def get_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Get Jwk + + Returns JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Get Jwk + + Returns JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Jwk + + Returns JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_jwks_serialize( self, id, - **kwargs - ): - """Delete Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspaces(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_workspaces_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_all_automations_workspace_automations( - self, - **kwargs - ): - """Get all Automations across all Workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_automations_workspace_automations(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceAutomationOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_automations_workspace_automations_endpoint.call_with_http_info(**kwargs) - def get_all_entities_aggregated_facts( - self, - workspace_id, - **kwargs - ): - """get_all_entities_aggregated_facts # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_aggregated_facts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAggregatedFactOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_aggregated_facts_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def get_all_entities_analytical_dashboards( - self, - workspace_id, - **kwargs - ): - """Get all Dashboards # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_analytical_dashboards(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_all_entities_api_tokens( - self, - user_id, - **kwargs - ): - """List all api tokens for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_api_tokens(user_id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiApiTokenOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_api_tokens_endpoint.call_with_http_info(**kwargs) - def get_all_entities_attribute_hierarchies( - self, - workspace_id, - **kwargs - ): - """Get all Attribute Hierarchies # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_attribute_hierarchies(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def get_all_entities_attributes( - self, - workspace_id, - **kwargs - ): - """Get all Attributes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_attributes(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_attributes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_automations( + @validate_call + def get_entity_labels( self, - workspace_id, - **kwargs - ): - """Get all Automations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_automations(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_automations_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_color_palettes( + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLabelOutDocument: + """Get a Label + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_labels_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_labels_with_http_info( self, - **kwargs - ): - """Get all Color Pallettes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_color_palettes(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_color_palettes_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_csp_directives( + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLabelOutDocument]: + """Get a Label + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_labels_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_labels_without_preload_content( self, - **kwargs - ): - """Get CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_csp_directives(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_csp_directives_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_custom_application_settings( + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Label + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_labels_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_labels_serialize( self, workspace_id, - **kwargs - ): - """Get all Custom Application Settings # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_custom_application_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_all_entities_dashboard_plugins( - self, - workspace_id, - **kwargs - ): - """Get all Plugins # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_dashboard_plugins(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def get_all_entities_data_source_identifiers( - self, - **kwargs - ): - """Get all Data Source Identifiers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_data_source_identifiers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceIdentifierOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def get_all_entities_data_sources( - self, - **kwargs - ): - """Get Data Source entities # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_data_sources(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_all_entities_datasets( - self, - workspace_id, - **kwargs - ): - """Get all Datasets # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_datasets(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDatasetOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_datasets_endpoint.call_with_http_info(**kwargs) - def get_all_entities_entitlements( - self, - **kwargs - ): - """Get Entitlements # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_entitlements(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiEntitlementOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) - def get_all_entities_export_definitions( - self, - workspace_id, - **kwargs - ): - """Get all Export Definitions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_export_definitions(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_export_definitions_endpoint.call_with_http_info(**kwargs) - def get_all_entities_export_templates( + @validate_call + def get_entity_llm_endpoints( self, - **kwargs - ): - """GET all Export Template entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_export_templates(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_facts( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """Get LLM endpoint entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_llm_endpoints_with_http_info( self, - workspace_id, - **kwargs - ): - """Get all Facts # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_facts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFactOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_facts_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_filter_contexts( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """Get LLM endpoint entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_llm_endpoints_without_preload_content( self, - workspace_id, - **kwargs - ): - """Get all Context Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_filter_contexts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_filter_views( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get LLM endpoint entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_llm_endpoints_serialize( self, - workspace_id, - **kwargs - ): - """Get all Filter views # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_filter_views(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_filter_views_endpoint.call_with_http_info(**kwargs) + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_all_entities_identity_providers( - self, - **kwargs - ): - """Get all Identity Providers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_identity_providers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_identity_providers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_jwks( - self, - **kwargs - ): - """Get all Jwks # noqa: E501 - - Returns all JSON web keys - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_jwks(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_jwks_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def get_all_entities_labels( - self, - workspace_id, - **kwargs - ): - """Get all Labels # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_labels(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLabelOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_labels_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_all_entities_llm_endpoints( - self, - **kwargs - ): - """Get all LLM endpoint entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_llm_endpoints(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def get_all_entities_metrics( - self, - workspace_id, - **kwargs - ): - """Get all Metrics # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_metrics(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_metrics_endpoint.call_with_http_info(**kwargs) - def get_all_entities_notification_channel_identifiers( - self, - **kwargs - ): - """get_all_entities_notification_channel_identifiers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_notification_channel_identifiers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelIdentifierOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_notification_channels( + @validate_call + def get_entity_metrics( self, - **kwargs - ): - """Get all Notification Channel entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_notification_channels(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channels_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_organization_settings( + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Get a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_metrics_with_http_info( self, - **kwargs - ): - """Get Organization entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_organization_settings(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_organization_settings_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_themes( + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Get a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_metrics_without_preload_content( self, - **kwargs - ): - """Get all Theming entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_themes(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_themes_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_user_data_filters( + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_metrics_serialize( self, workspace_id, - **kwargs - ): - """Get all User Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_data_filters(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_all_entities_user_groups( - self, - **kwargs - ): - """Get UserGroup entities # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_groups(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_groups_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_identifiers( - self, - **kwargs - ): - """Get UserIdentifier entities # noqa: E501 - - UserIdentifier - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_identifiers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserIdentifierOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_identifiers_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def get_all_entities_user_settings( - self, - user_id, - **kwargs - ): - """List all settings for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_settings(user_id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_user_settings_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_all_entities_users( - self, - **kwargs - ): - """Get User entities # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_users(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_users_endpoint.call_with_http_info(**kwargs) - def get_all_entities_visualization_objects( - self, - workspace_id, - **kwargs - ): - """Get all Visualization Objects # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_visualization_objects(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspace_data_filter_settings( - self, - workspace_id, - **kwargs - ): - """Get all Settings for Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_data_filter_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspace_data_filters( + @validate_call + def get_entity_notification_channel_identifiers( self, - workspace_id, - **kwargs - ): - """Get all Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_data_filters(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_workspace_settings( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelIdentifierOutDocument: + """get_entity_notification_channel_identifiers + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channel_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_notification_channel_identifiers_with_http_info( self, - workspace_id, - **kwargs - ): - """Get all Setting for Workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_workspaces( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelIdentifierOutDocument]: + """get_entity_notification_channel_identifiers + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channel_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_notification_channel_identifiers_without_preload_content( self, - **kwargs - ): - """Get Workspace entities # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspaces(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_workspaces_endpoint.call_with_http_info(**kwargs) - - def get_all_options( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_entity_notification_channel_identifiers + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channel_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_notification_channel_identifiers_serialize( self, - **kwargs - ): - """Links for all configuration options # noqa: E501 - - Retrieves links for all options for different configurations. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_options(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_options_endpoint.call_with_http_info(**kwargs) + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_data_source_drivers( - self, - **kwargs - ): - """Get all available data source drivers # noqa: E501 - - Retrieves a list of all supported data sources along with information about the used drivers. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_data_source_drivers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - {str: (str,)} - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_data_source_drivers_endpoint.call_with_http_info(**kwargs) - def get_entity_aggregated_facts( - self, - workspace_id, - object_id, - **kwargs - ): - """get_entity_aggregated_facts # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_aggregated_facts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAggregatedFactOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_aggregated_facts_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def get_entity_analytical_dashboards( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_analytical_dashboards(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannelIdentifiers/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_entity_api_tokens( - self, - user_id, - id, - **kwargs - ): - """Get an API Token for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_api_tokens(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiApiTokenOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.get_entity_api_tokens_endpoint.call_with_http_info(**kwargs) - def get_entity_attribute_hierarchies( - self, - workspace_id, - object_id, - **kwargs - ): - """Get an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def get_entity_attributes( - self, - workspace_id, - object_id, - **kwargs - ): - """Get an Attribute # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_attributes(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_attributes_endpoint.call_with_http_info(**kwargs) - def get_entity_automations( + @validate_call + def get_entity_notification_channels( self, - workspace_id, - object_id, - **kwargs - ): - """Get an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_automations(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_automations_endpoint.call_with_http_info(**kwargs) - - def get_entity_color_palettes( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Get Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_notification_channels_with_http_info( self, - id, - **kwargs - ): - """Get Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_color_palettes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - - def get_entity_cookie_security_configurations( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Get Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_notification_channels_without_preload_content( self, - id, - **kwargs - ): - """Get CookieSecurityConfiguration # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_cookie_security_configurations(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCookieSecurityConfigurationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) - - def get_entity_csp_directives( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_notification_channels_serialize( self, id, - **kwargs - ): - """Get CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_csp_directives(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_entity_custom_application_settings( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_custom_application_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def get_entity_dashboard_plugins( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_dashboard_plugins(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def get_entity_data_source_identifiers( - self, - id, - **kwargs - ): - """Get Data Source Identifier # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_data_source_identifiers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceIdentifierOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_entity_data_sources( - self, - id, - **kwargs - ): - """Get Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_data_sources(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def get_entity_datasets( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Dataset # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_datasets(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDatasetOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_datasets_endpoint.call_with_http_info(**kwargs) - def get_entity_entitlements( - self, - id, - **kwargs - ): - """Get Entitlement # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_entitlements(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiEntitlementOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_entitlements_endpoint.call_with_http_info(**kwargs) - def get_entity_export_definitions( + @validate_call + def get_entity_organization_settings( self, - workspace_id, - object_id, - **kwargs - ): - """Get an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_export_definitions(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - - def get_entity_export_templates( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Get Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Get Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_organization_settings_serialize( self, id, - **kwargs - ): - """GET Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_export_templates(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_export_templates_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_entity_facts( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Fact # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_facts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFactOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_facts_endpoint.call_with_http_info(**kwargs) - def get_entity_filter_contexts( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_filter_contexts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def get_entity_filter_views( - self, - workspace_id, - object_id, - **kwargs - ): - """Get Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_filter_views(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_filter_views_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_entity_identity_providers( - self, - id, - **kwargs - ): - """Get Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_identity_providers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def get_entity_jwks( - self, - id, - **kwargs - ): - """Get Jwk # noqa: E501 - - Returns JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_jwks(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_jwks_endpoint.call_with_http_info(**kwargs) - def get_entity_labels( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Label # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_labels(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLabelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_labels_endpoint.call_with_http_info(**kwargs) - def get_entity_llm_endpoints( + @validate_call + def get_entity_organizations( self, - id, - **kwargs - ): - """Get LLM endpoint entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_llm_endpoints(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - - def get_entity_metrics( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationOutDocument: + """Get Organizations + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organizations_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_organizations_with_http_info( self, - workspace_id, - object_id, - **kwargs - ): - """Get a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_metrics(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_metrics_endpoint.call_with_http_info(**kwargs) - - def get_entity_notification_channel_identifiers( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationOutDocument]: + """Get Organizations + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organizations_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_organizations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Organizations + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organizations_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_organizations_serialize( self, id, - **kwargs - ): - """get_entity_notification_channel_identifiers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_notification_channel_identifiers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelIdentifierOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) + filter, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/admin/organizations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_entity_notification_channels( - self, - id, - **kwargs - ): - """Get Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_notification_channels(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def get_entity_organization_settings( - self, - id, - **kwargs - ): - """Get Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_organization_settings(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def get_entity_organizations( - self, - id, - **kwargs - ): - """Get Organizations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_organizations(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_organizations_endpoint.call_with_http_info(**kwargs) + @validate_call def get_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Get Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Get Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_themes_serialize( self, id, - **kwargs - ): - """Get Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_themes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_themes_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Get a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Get a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_data_filters_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Get UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_groups_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Get UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_groups_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_groups_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_groups_serialize( self, id, - **kwargs - ): - """Get UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_groups(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_user_groups_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_user_identifiers( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserIdentifierOutDocument: + """Get UserIdentifier entity + + UserIdentifier - represents basic information about entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_identifiers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserIdentifierOutDocument]: + """Get UserIdentifier entity + + UserIdentifier - represents basic information about entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_user_identifiers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserIdentifier entity + + UserIdentifier - represents basic information about entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_identifiers_serialize( self, id, - **kwargs - ): - """Get UserIdentifier entity # noqa: E501 - - UserIdentifier - represents basic information about entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_identifiers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserIdentifierOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_user_identifiers_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userIdentifiers/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_user_settings( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutDocument: + """Get a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutDocument]: + """Get a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_settings_serialize( self, user_id, id, - **kwargs - ): - """Get a setting for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_settings(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.get_entity_user_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/userSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_users( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Get User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_users_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_users_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Get User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_users_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_users_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_users_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_users_serialize( self, id, - **kwargs - ): - """Get User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_users(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_users_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Get a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Get a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_visualization_objects_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_visualization_objects(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Get a Setting for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Get a Setting for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Setting for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_workspace_data_filter_settings_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Setting for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Get a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Get a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_workspace_data_filters_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_workspace_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Get a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Get a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_workspace_settings_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + filter, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_workspaces( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Get Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspaces_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspaces_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Get Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspaces_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_workspaces_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspaces_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_workspaces_serialize( self, id, - **kwargs - ): - """Get Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspaces(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_workspaces_endpoint.call_with_http_info(**kwargs) + filter, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_organization( self, - **kwargs - ): - """Get current organization info # noqa: E501 - - Gets a basic information about organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_organization(async_req=True) - >>> result = thread.get() - - - Keyword Args: - meta_include ([str]): Return list of permissions available to logged user.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_organization_endpoint.call_with_http_info(**kwargs) + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Return list of permissions available to logged user.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Get current organization info + + Gets a basic information about organization. + + :param meta_include: Return list of permissions available to logged user. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_serialize( + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '302': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_organization_with_http_info( + self, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Return list of permissions available to logged user.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Get current organization info + + Gets a basic information about organization. + + :param meta_include: Return list of permissions available to logged user. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_serialize( + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '302': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_organization_without_preload_content( + self, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Return list of permissions available to logged user.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get current organization info + + Gets a basic information about organization. + + :param meta_include: Return list of permissions available to logged user. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_serialize( + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '302': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_organization_serialize( + self, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/organization', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Patch a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_patch_document: (required) + :type json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_patch_document=json_api_analytical_dashboard_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Patch a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_patch_document: (required) + :type json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_patch_document=json_api_analytical_dashboard_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_patch_document: (required) + :type json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_patch_document=json_api_analytical_dashboard_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_analytical_dashboards_serialize( self, workspace_id, object_id, json_api_analytical_dashboard_patch_document, - **kwargs - ): - """Patch a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_analytical_dashboard_patch_document (JsonApiAnalyticalDashboardPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_analytical_dashboard_patch_document'] = \ - json_api_analytical_dashboard_patch_document - return self.patch_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_analytical_dashboard_patch_document is not None: + _body_params = json_api_analytical_dashboard_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Patch an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_patch_document: (required) + :type json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_patch_document=json_api_attribute_hierarchy_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Patch an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_patch_document: (required) + :type json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_patch_document=json_api_attribute_hierarchy_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_patch_document: (required) + :type json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_patch_document=json_api_attribute_hierarchy_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_attribute_hierarchies_serialize( self, workspace_id, object_id, json_api_attribute_hierarchy_patch_document, - **kwargs - ): - """Patch an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_attribute_hierarchy_patch_document (JsonApiAttributeHierarchyPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_attribute_hierarchy_patch_document'] = \ - json_api_attribute_hierarchy_patch_document - return self.patch_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_attribute_hierarchy_patch_document is not None: + _body_params = json_api_attribute_hierarchy_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_patch_document: JsonApiAutomationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Patch an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_patch_document: (required) + :type json_api_automation_patch_document: JsonApiAutomationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_patch_document=json_api_automation_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_patch_document: JsonApiAutomationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Patch an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_patch_document: (required) + :type json_api_automation_patch_document: JsonApiAutomationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_patch_document=json_api_automation_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_patch_document: JsonApiAutomationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_patch_document: (required) + :type json_api_automation_patch_document: JsonApiAutomationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_patch_document=json_api_automation_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_automations_serialize( self, workspace_id, object_id, json_api_automation_patch_document, - **kwargs - ): - """Patch an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_automation_patch_document (JsonApiAutomationPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_automation_patch_document'] = \ - json_api_automation_patch_document - return self.patch_entity_automations_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_automation_patch_document is not None: + _body_params = json_api_automation_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_color_palettes( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Patch Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_patch_document: (required) + :type json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_color_palettes_serialize( + id=id, + json_api_color_palette_patch_document=json_api_color_palette_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_color_palettes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Patch Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_patch_document: (required) + :type json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_color_palettes_serialize( + id=id, + json_api_color_palette_patch_document=json_api_color_palette_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_color_palettes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_patch_document: (required) + :type json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_color_palettes_serialize( + id=id, + json_api_color_palette_patch_document=json_api_color_palette_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_color_palettes_serialize( self, id, json_api_color_palette_patch_document, - **kwargs - ): - """Patch Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_color_palettes(id, json_api_color_palette_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_color_palette_patch_document (JsonApiColorPalettePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_color_palette_patch_document'] = \ - json_api_color_palette_patch_document - return self.patch_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_color_palette_patch_document is not None: + _body_params = json_api_color_palette_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_cookie_security_configurations( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCookieSecurityConfigurationOutDocument: + """Patch CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_patch_document: (required) + :type json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_patch_document=json_api_cookie_security_configuration_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_cookie_security_configurations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCookieSecurityConfigurationOutDocument]: + """Patch CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_patch_document: (required) + :type json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_patch_document=json_api_cookie_security_configuration_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_cookie_security_configurations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_patch_document: (required) + :type json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_patch_document=json_api_cookie_security_configuration_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_cookie_security_configurations_serialize( self, id, json_api_cookie_security_configuration_patch_document, - **kwargs - ): - """Patch CookieSecurityConfiguration # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_cookie_security_configuration_patch_document (JsonApiCookieSecurityConfigurationPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCookieSecurityConfigurationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_cookie_security_configuration_patch_document'] = \ - json_api_cookie_security_configuration_patch_document - return self.patch_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_cookie_security_configuration_patch_document is not None: + _body_params = json_api_cookie_security_configuration_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Patch CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_patch_document: (required) + :type json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_patch_document=json_api_csp_directive_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Patch CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_patch_document: (required) + :type json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_patch_document=json_api_csp_directive_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_patch_document: (required) + :type json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_patch_document=json_api_csp_directive_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_csp_directives_serialize( self, id, json_api_csp_directive_patch_document, - **kwargs - ): - """Patch CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_csp_directive_patch_document (JsonApiCspDirectivePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_csp_directive_patch_document'] = \ - json_api_csp_directive_patch_document - return self.patch_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_csp_directive_patch_document is not None: + _body_params = json_api_csp_directive_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_custom_application_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Patch a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_patch_document: (required) + :type json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_patch_document=json_api_custom_application_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Patch a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_patch_document: (required) + :type json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_patch_document=json_api_custom_application_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_patch_document: (required) + :type json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_patch_document=json_api_custom_application_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_custom_application_settings_serialize( self, workspace_id, object_id, json_api_custom_application_setting_patch_document, - **kwargs - ): - """Patch a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_custom_application_setting_patch_document (JsonApiCustomApplicationSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_custom_application_setting_patch_document'] = \ - json_api_custom_application_setting_patch_document - return self.patch_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_custom_application_setting_patch_document is not None: + _body_params = json_api_custom_application_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Patch a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_patch_document: (required) + :type json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_patch_document=json_api_dashboard_plugin_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Patch a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_patch_document: (required) + :type json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_patch_document=json_api_dashboard_plugin_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_patch_document: (required) + :type json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_patch_document=json_api_dashboard_plugin_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_dashboard_plugins_serialize( self, workspace_id, object_id, json_api_dashboard_plugin_patch_document, - **kwargs - ): - """Patch a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_dashboard_plugin_patch_document (JsonApiDashboardPluginPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_dashboard_plugin_patch_document'] = \ - json_api_dashboard_plugin_patch_document - return self.patch_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_dashboard_plugin_patch_document is not None: + _body_params = json_api_dashboard_plugin_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_data_sources( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_patch_document: JsonApiDataSourcePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Patch Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_patch_document: (required) + :type json_api_data_source_patch_document: JsonApiDataSourcePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_data_sources_serialize( + id=id, + json_api_data_source_patch_document=json_api_data_source_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_patch_document: JsonApiDataSourcePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Patch Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_patch_document: (required) + :type json_api_data_source_patch_document: JsonApiDataSourcePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_data_sources_serialize( + id=id, + json_api_data_source_patch_document=json_api_data_source_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_patch_document: JsonApiDataSourcePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_patch_document: (required) + :type json_api_data_source_patch_document: JsonApiDataSourcePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_data_sources_serialize( + id=id, + json_api_data_source_patch_document=json_api_data_source_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_data_sources_serialize( self, id, json_api_data_source_patch_document, - **kwargs - ): - """Patch Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_data_sources(id, json_api_data_source_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_data_source_patch_document (JsonApiDataSourcePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_data_source_patch_document'] = \ - json_api_data_source_patch_document - return self.patch_entity_data_sources_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_data_source_patch_document is not None: + _body_params = json_api_data_source_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Patch an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_patch_document: (required) + :type json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_patch_document=json_api_export_definition_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Patch an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_patch_document: (required) + :type json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_patch_document=json_api_export_definition_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_patch_document: (required) + :type json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_patch_document=json_api_export_definition_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_export_definitions_serialize( self, workspace_id, object_id, json_api_export_definition_patch_document, - **kwargs - ): - """Patch an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_export_definition_patch_document (JsonApiExportDefinitionPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_export_definition_patch_document'] = \ - json_api_export_definition_patch_document - return self.patch_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_definition_patch_document is not None: + _body_params = json_api_export_definition_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """Patch Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_patch_document: (required) + :type json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_templates_serialize( + id=id, + json_api_export_template_patch_document=json_api_export_template_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """Patch Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_patch_document: (required) + :type json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_templates_serialize( + id=id, + json_api_export_template_patch_document=json_api_export_template_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_patch_document: (required) + :type json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_templates_serialize( + id=id, + json_api_export_template_patch_document=json_api_export_template_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_export_templates_serialize( self, id, json_api_export_template_patch_document, - **kwargs - ): - """Patch Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_export_templates(id, json_api_export_template_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_export_template_patch_document (JsonApiExportTemplatePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_export_template_patch_document'] = \ - json_api_export_template_patch_document - return self.patch_entity_export_templates_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_template_patch_document is not None: + _body_params = json_api_export_template_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Patch a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_patch_document: (required) + :type json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_patch_document=json_api_filter_context_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Patch a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_patch_document: (required) + :type json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_patch_document=json_api_filter_context_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_patch_document: (required) + :type json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_patch_document=json_api_filter_context_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_filter_contexts_serialize( self, workspace_id, object_id, json_api_filter_context_patch_document, - **kwargs - ): - """Patch a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_context_patch_document (JsonApiFilterContextPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_context_patch_document'] = \ - json_api_filter_context_patch_document - return self.patch_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_context_patch_document is not None: + _body_params = json_api_filter_context_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Patch Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_patch_document: (required) + :type json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_patch_document=json_api_filter_view_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Patch Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_patch_document: (required) + :type json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_patch_document=json_api_filter_view_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_patch_document: (required) + :type json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_patch_document=json_api_filter_view_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_filter_views_serialize( self, workspace_id, object_id, json_api_filter_view_patch_document, - **kwargs - ): - """Patch Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_view_patch_document (JsonApiFilterViewPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_view_patch_document'] = \ - json_api_filter_view_patch_document - return self.patch_entity_filter_views_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_view_patch_document is not None: + _body_params = json_api_filter_view_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Patch Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_patch_document: (required) + :type json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_patch_document=json_api_identity_provider_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Patch Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_patch_document: (required) + :type json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_patch_document=json_api_identity_provider_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_patch_document: (required) + :type json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_patch_document=json_api_identity_provider_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_identity_providers_serialize( self, id, json_api_identity_provider_patch_document, - **kwargs - ): - """Patch Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_identity_provider_patch_document (JsonApiIdentityProviderPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_identity_provider_patch_document'] = \ - json_api_identity_provider_patch_document - return self.patch_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_identity_provider_patch_document is not None: + _body_params = json_api_identity_provider_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_patch_document: JsonApiJwkPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Patch Jwk + + Patches JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_patch_document: (required) + :type json_api_jwk_patch_document: JsonApiJwkPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_jwks_serialize( + id=id, + json_api_jwk_patch_document=json_api_jwk_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_patch_document: JsonApiJwkPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Patch Jwk + + Patches JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_patch_document: (required) + :type json_api_jwk_patch_document: JsonApiJwkPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_jwks_serialize( + id=id, + json_api_jwk_patch_document=json_api_jwk_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_patch_document: JsonApiJwkPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Jwk + + Patches JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_patch_document: (required) + :type json_api_jwk_patch_document: JsonApiJwkPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_jwks_serialize( + id=id, + json_api_jwk_patch_document=json_api_jwk_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_jwks_serialize( self, id, json_api_jwk_patch_document, - **kwargs - ): - """Patch Jwk # noqa: E501 - - Patches JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_jwks(id, json_api_jwk_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_jwk_patch_document (JsonApiJwkPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_jwk_patch_document'] = \ - json_api_jwk_patch_document - return self.patch_entity_jwks_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_jwk_patch_document is not None: + _body_params = json_api_jwk_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_llm_endpoints( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """Patch LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_patch_document: (required) + :type json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_patch_document=json_api_llm_endpoint_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_llm_endpoints_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """Patch LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_patch_document: (required) + :type json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_patch_document=json_api_llm_endpoint_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_llm_endpoints_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_patch_document: (required) + :type json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_patch_document=json_api_llm_endpoint_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_llm_endpoints_serialize( self, id, json_api_llm_endpoint_patch_document, - **kwargs - ): - """Patch LLM endpoint entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_llm_endpoint_patch_document (JsonApiLlmEndpointPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_llm_endpoint_patch_document'] = \ - json_api_llm_endpoint_patch_document - return self.patch_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_llm_endpoint_patch_document is not None: + _body_params = json_api_llm_endpoint_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_metrics( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_patch_document: JsonApiMetricPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Patch a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_patch_document: (required) + :type json_api_metric_patch_document: JsonApiMetricPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_patch_document=json_api_metric_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_patch_document: JsonApiMetricPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Patch a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_patch_document: (required) + :type json_api_metric_patch_document: JsonApiMetricPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_patch_document=json_api_metric_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_patch_document: JsonApiMetricPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_patch_document: (required) + :type json_api_metric_patch_document: JsonApiMetricPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_patch_document=json_api_metric_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_metrics_serialize( self, workspace_id, object_id, json_api_metric_patch_document, - **kwargs - ): - """Patch a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_metric_patch_document (JsonApiMetricPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_metric_patch_document'] = \ - json_api_metric_patch_document - return self.patch_entity_metrics_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_metric_patch_document is not None: + _body_params = json_api_metric_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_notification_channels( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Patch Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_patch_document: (required) + :type json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_patch_document=json_api_notification_channel_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_notification_channels_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Patch Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_patch_document: (required) + :type json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_patch_document=json_api_notification_channel_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_notification_channels_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_patch_document: (required) + :type json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_patch_document=json_api_notification_channel_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_notification_channels_serialize( self, id, json_api_notification_channel_patch_document, - **kwargs - ): - """Patch Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_notification_channels(id, json_api_notification_channel_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_notification_channel_patch_document (JsonApiNotificationChannelPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_notification_channel_patch_document'] = \ - json_api_notification_channel_patch_document - return self.patch_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_notification_channel_patch_document is not None: + _body_params = json_api_notification_channel_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_organization_settings( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Patch Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_patch_document: (required) + :type json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_patch_document=json_api_organization_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Patch Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_patch_document: (required) + :type json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_patch_document=json_api_organization_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_patch_document: (required) + :type json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_patch_document=json_api_organization_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_organization_settings_serialize( self, id, json_api_organization_setting_patch_document, - **kwargs - ): - """Patch Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_organization_settings(id, json_api_organization_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_setting_patch_document (JsonApiOrganizationSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_setting_patch_document'] = \ - json_api_organization_setting_patch_document - return self.patch_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_setting_patch_document is not None: + _body_params = json_api_organization_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_organizations( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_patch_document: JsonApiOrganizationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationOutDocument: + """Patch Organization + + + :param id: (required) + :type id: str + :param json_api_organization_patch_document: (required) + :type json_api_organization_patch_document: JsonApiOrganizationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organizations_serialize( + id=id, + json_api_organization_patch_document=json_api_organization_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_organizations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_patch_document: JsonApiOrganizationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationOutDocument]: + """Patch Organization + + + :param id: (required) + :type id: str + :param json_api_organization_patch_document: (required) + :type json_api_organization_patch_document: JsonApiOrganizationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organizations_serialize( + id=id, + json_api_organization_patch_document=json_api_organization_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_organizations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_patch_document: JsonApiOrganizationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Organization + + + :param id: (required) + :type id: str + :param json_api_organization_patch_document: (required) + :type json_api_organization_patch_document: JsonApiOrganizationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organizations_serialize( + id=id, + json_api_organization_patch_document=json_api_organization_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_organizations_serialize( self, id, json_api_organization_patch_document, - **kwargs - ): - """Patch Organization # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_organizations(id, json_api_organization_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_patch_document (JsonApiOrganizationPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_patch_document'] = \ - json_api_organization_patch_document - return self.patch_entity_organizations_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_patch_document is not None: + _body_params = json_api_organization_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/admin/organizations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_patch_document: JsonApiThemePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Patch Theming + + + :param id: (required) + :type id: str + :param json_api_theme_patch_document: (required) + :type json_api_theme_patch_document: JsonApiThemePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_themes_serialize( + id=id, + json_api_theme_patch_document=json_api_theme_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_patch_document: JsonApiThemePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Patch Theming + + + :param id: (required) + :type id: str + :param json_api_theme_patch_document: (required) + :type json_api_theme_patch_document: JsonApiThemePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_themes_serialize( + id=id, + json_api_theme_patch_document=json_api_theme_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_patch_document: JsonApiThemePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Theming + + + :param id: (required) + :type id: str + :param json_api_theme_patch_document: (required) + :type json_api_theme_patch_document: JsonApiThemePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_themes_serialize( + id=id, + json_api_theme_patch_document=json_api_theme_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_themes_serialize( self, id, json_api_theme_patch_document, - **kwargs - ): - """Patch Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_themes(id, json_api_theme_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_theme_patch_document (JsonApiThemePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_theme_patch_document'] = \ - json_api_theme_patch_document - return self.patch_entity_themes_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_theme_patch_document is not None: + _body_params = json_api_theme_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Patch a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_patch_document: (required) + :type json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_patch_document=json_api_user_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Patch a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_patch_document: (required) + :type json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_patch_document=json_api_user_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_patch_document: (required) + :type json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_patch_document=json_api_user_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_user_data_filters_serialize( self, workspace_id, object_id, json_api_user_data_filter_patch_document, - **kwargs - ): - """Patch a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_user_data_filter_patch_document (JsonApiUserDataFilterPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_user_data_filter_patch_document'] = \ - json_api_user_data_filter_patch_document - return self.patch_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_data_filter_patch_document is not None: + _body_params = json_api_user_data_filter_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_patch_document: JsonApiUserGroupPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Patch UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_patch_document: (required) + :type json_api_user_group_patch_document: JsonApiUserGroupPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_groups_serialize( + id=id, + json_api_user_group_patch_document=json_api_user_group_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_patch_document: JsonApiUserGroupPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Patch UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_patch_document: (required) + :type json_api_user_group_patch_document: JsonApiUserGroupPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_groups_serialize( + id=id, + json_api_user_group_patch_document=json_api_user_group_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_patch_document: JsonApiUserGroupPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_patch_document: (required) + :type json_api_user_group_patch_document: JsonApiUserGroupPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_groups_serialize( + id=id, + json_api_user_group_patch_document=json_api_user_group_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_user_groups_serialize( self, id, json_api_user_group_patch_document, - **kwargs - ): - """Patch UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_user_groups(id, json_api_user_group_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_group_patch_document (JsonApiUserGroupPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_group_patch_document'] = \ - json_api_user_group_patch_document - return self.patch_entity_user_groups_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_group_patch_document is not None: + _body_params = json_api_user_group_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_users( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_patch_document: JsonApiUserPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Patch User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_patch_document: (required) + :type json_api_user_patch_document: JsonApiUserPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_users_serialize( + id=id, + json_api_user_patch_document=json_api_user_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_users_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_patch_document: JsonApiUserPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Patch User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_patch_document: (required) + :type json_api_user_patch_document: JsonApiUserPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_users_serialize( + id=id, + json_api_user_patch_document=json_api_user_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_users_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_patch_document: JsonApiUserPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_patch_document: (required) + :type json_api_user_patch_document: JsonApiUserPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_users_serialize( + id=id, + json_api_user_patch_document=json_api_user_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_users_serialize( self, id, json_api_user_patch_document, - **kwargs - ): - """Patch User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_users(id, json_api_user_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_patch_document (JsonApiUserPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_patch_document'] = \ - json_api_user_patch_document - return self.patch_entity_users_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_patch_document is not None: + _body_params = json_api_user_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Patch a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_patch_document: (required) + :type json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_patch_document=json_api_visualization_object_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Patch a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_patch_document: (required) + :type json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_patch_document=json_api_visualization_object_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_patch_document: (required) + :type json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_patch_document=json_api_visualization_object_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_visualization_objects_serialize( self, workspace_id, object_id, json_api_visualization_object_patch_document, - **kwargs - ): - """Patch a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_visualization_object_patch_document (JsonApiVisualizationObjectPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_visualization_object_patch_document'] = \ - json_api_visualization_object_patch_document - return self.patch_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_visualization_object_patch_document is not None: + _body_params = json_api_visualization_object_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Patch a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_patch_document: (required) + :type json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_patch_document=json_api_workspace_data_filter_setting_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Patch a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_patch_document: (required) + :type json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_patch_document=json_api_workspace_data_filter_setting_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_patch_document: (required) + :type json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_patch_document=json_api_workspace_data_filter_setting_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspace_data_filter_settings_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, - **kwargs - ): - """Patch a Settings for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_setting_patch_document (JsonApiWorkspaceDataFilterSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_setting_patch_document'] = \ - json_api_workspace_data_filter_setting_patch_document - return self.patch_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_setting_patch_document is not None: + _body_params = json_api_workspace_data_filter_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Patch a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_patch_document: (required) + :type json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_patch_document=json_api_workspace_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Patch a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_patch_document: (required) + :type json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_patch_document=json_api_workspace_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_patch_document: (required) + :type json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_patch_document=json_api_workspace_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspace_data_filters_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_patch_document, - **kwargs - ): - """Patch a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_patch_document (JsonApiWorkspaceDataFilterPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_patch_document'] = \ - json_api_workspace_data_filter_patch_document - return self.patch_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_patch_document is not None: + _body_params = json_api_workspace_data_filter_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_workspace_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Patch a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_patch_document: (required) + :type json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_patch_document=json_api_workspace_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Patch a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_patch_document: (required) + :type json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_patch_document=json_api_workspace_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_patch_document: (required) + :type json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_patch_document=json_api_workspace_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspace_settings_serialize( self, workspace_id, object_id, json_api_workspace_setting_patch_document, - **kwargs - ): - """Patch a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_setting_patch_document (JsonApiWorkspaceSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_setting_patch_document'] = \ - json_api_workspace_setting_patch_document - return self.patch_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_setting_patch_document is not None: + _body_params = json_api_workspace_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_workspaces( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_patch_document: JsonApiWorkspacePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Patch Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_patch_document: (required) + :type json_api_workspace_patch_document: JsonApiWorkspacePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspaces_serialize( + id=id, + json_api_workspace_patch_document=json_api_workspace_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspaces_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_patch_document: JsonApiWorkspacePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Patch Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_patch_document: (required) + :type json_api_workspace_patch_document: JsonApiWorkspacePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspaces_serialize( + id=id, + json_api_workspace_patch_document=json_api_workspace_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_workspaces_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_patch_document: JsonApiWorkspacePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_patch_document: (required) + :type json_api_workspace_patch_document: JsonApiWorkspacePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspaces_serialize( + id=id, + json_api_workspace_patch_document=json_api_workspace_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspaces_serialize( self, id, json_api_workspace_patch_document, - **kwargs - ): - """Patch Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspaces(id, json_api_workspace_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_workspace_patch_document (JsonApiWorkspacePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_workspace_patch_document'] = \ - json_api_workspace_patch_document - return self.patch_entity_workspaces_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_patch_document is not None: + _body_params = json_api_workspace_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Put Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_in_document: (required) + :type json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_in_document=json_api_analytical_dashboard_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Put Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_in_document: (required) + :type json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_in_document=json_api_analytical_dashboard_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_in_document: (required) + :type json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_in_document=json_api_analytical_dashboard_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_analytical_dashboards_serialize( self, workspace_id, object_id, json_api_analytical_dashboard_in_document, - **kwargs - ): - """Put Dashboards # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_analytical_dashboard_in_document (JsonApiAnalyticalDashboardInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_analytical_dashboard_in_document'] = \ - json_api_analytical_dashboard_in_document - return self.update_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_analytical_dashboard_in_document is not None: + _body_params = json_api_analytical_dashboard_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Put an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Put an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_attribute_hierarchies_serialize( self, workspace_id, object_id, json_api_attribute_hierarchy_in_document, - **kwargs - ): - """Put an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_attribute_hierarchy_in_document'] = \ - json_api_attribute_hierarchy_in_document - return self.update_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_attribute_hierarchy_in_document is not None: + _body_params = json_api_attribute_hierarchy_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Put an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_in_document=json_api_automation_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Put an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_in_document=json_api_automation_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_in_document=json_api_automation_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_automations_serialize( self, workspace_id, object_id, json_api_automation_in_document, - **kwargs - ): - """Put an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.update_entity_automations_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_automation_in_document is not None: + _body_params = json_api_automation_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_color_palettes( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Put Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_color_palettes_serialize( + id=id, + json_api_color_palette_in_document=json_api_color_palette_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_color_palettes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Put Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_color_palettes_serialize( + id=id, + json_api_color_palette_in_document=json_api_color_palette_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_color_palettes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_color_palettes_serialize( + id=id, + json_api_color_palette_in_document=json_api_color_palette_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_color_palettes_serialize( self, id, json_api_color_palette_in_document, - **kwargs - ): - """Put Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_color_palettes(id, json_api_color_palette_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_color_palette_in_document (JsonApiColorPaletteInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_color_palette_in_document'] = \ - json_api_color_palette_in_document - return self.update_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_color_palette_in_document is not None: + _body_params = json_api_color_palette_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_cookie_security_configurations( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCookieSecurityConfigurationOutDocument: + """Put CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_in_document: (required) + :type json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_in_document=json_api_cookie_security_configuration_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_cookie_security_configurations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCookieSecurityConfigurationOutDocument]: + """Put CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_in_document: (required) + :type json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_in_document=json_api_cookie_security_configuration_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_cookie_security_configurations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_in_document: (required) + :type json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_in_document=json_api_cookie_security_configuration_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_cookie_security_configurations_serialize( self, id, json_api_cookie_security_configuration_in_document, - **kwargs - ): - """Put CookieSecurityConfiguration # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_cookie_security_configuration_in_document (JsonApiCookieSecurityConfigurationInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCookieSecurityConfigurationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_cookie_security_configuration_in_document'] = \ - json_api_cookie_security_configuration_in_document - return self.update_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_cookie_security_configuration_in_document is not None: + _body_params = json_api_cookie_security_configuration_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Put CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Put CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_csp_directives_serialize( self, id, json_api_csp_directive_in_document, - **kwargs - ): - """Put CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_csp_directives(id, json_api_csp_directive_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_csp_directive_in_document'] = \ - json_api_csp_directive_in_document - return self.update_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_csp_directive_in_document is not None: + _body_params = json_api_csp_directive_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_custom_application_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Put a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_in_document: (required) + :type json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_in_document=json_api_custom_application_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Put a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_in_document: (required) + :type json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_in_document=json_api_custom_application_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_in_document: (required) + :type json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_in_document=json_api_custom_application_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_custom_application_settings_serialize( self, workspace_id, object_id, json_api_custom_application_setting_in_document, - **kwargs - ): - """Put a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_custom_application_setting_in_document (JsonApiCustomApplicationSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_custom_application_setting_in_document'] = \ - json_api_custom_application_setting_in_document - return self.update_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_custom_application_setting_in_document is not None: + _body_params = json_api_custom_application_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Put a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_in_document: (required) + :type json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_in_document=json_api_dashboard_plugin_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Put a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_in_document: (required) + :type json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_in_document=json_api_dashboard_plugin_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_in_document: (required) + :type json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_in_document=json_api_dashboard_plugin_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_dashboard_plugins_serialize( self, workspace_id, object_id, json_api_dashboard_plugin_in_document, - **kwargs - ): - """Put a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_dashboard_plugin_in_document (JsonApiDashboardPluginInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_dashboard_plugin_in_document'] = \ - json_api_dashboard_plugin_in_document - return self.update_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_dashboard_plugin_in_document is not None: + _body_params = json_api_dashboard_plugin_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_data_sources( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_in_document: JsonApiDataSourceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Put Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_data_sources_serialize( + id=id, + json_api_data_source_in_document=json_api_data_source_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_in_document: JsonApiDataSourceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Put Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_data_sources_serialize( + id=id, + json_api_data_source_in_document=json_api_data_source_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_in_document: JsonApiDataSourceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_data_sources_serialize( + id=id, + json_api_data_source_in_document=json_api_data_source_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_data_sources_serialize( self, id, json_api_data_source_in_document, - **kwargs - ): - """Put Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_data_sources(id, json_api_data_source_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_data_source_in_document (JsonApiDataSourceInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_data_source_in_document'] = \ - json_api_data_source_in_document - return self.update_entity_data_sources_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_data_source_in_document is not None: + _body_params = json_api_data_source_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_in_document: JsonApiExportDefinitionInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Put an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_in_document: (required) + :type json_api_export_definition_in_document: JsonApiExportDefinitionInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_in_document=json_api_export_definition_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_in_document: JsonApiExportDefinitionInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Put an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_in_document: (required) + :type json_api_export_definition_in_document: JsonApiExportDefinitionInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_in_document=json_api_export_definition_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_in_document: JsonApiExportDefinitionInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_in_document: (required) + :type json_api_export_definition_in_document: JsonApiExportDefinitionInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_in_document=json_api_export_definition_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_export_definitions_serialize( self, workspace_id, object_id, json_api_export_definition_in_document, - **kwargs - ): - """Put an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_export_definition_in_document (JsonApiExportDefinitionInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_export_definition_in_document'] = \ - json_api_export_definition_in_document - return self.update_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_definition_in_document is not None: + _body_params = json_api_export_definition_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_in_document: JsonApiExportTemplateInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """PUT Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_in_document: (required) + :type json_api_export_template_in_document: JsonApiExportTemplateInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_templates_serialize( + id=id, + json_api_export_template_in_document=json_api_export_template_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_in_document: JsonApiExportTemplateInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """PUT Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_in_document: (required) + :type json_api_export_template_in_document: JsonApiExportTemplateInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_templates_serialize( + id=id, + json_api_export_template_in_document=json_api_export_template_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_in_document: JsonApiExportTemplateInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """PUT Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_in_document: (required) + :type json_api_export_template_in_document: JsonApiExportTemplateInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_templates_serialize( + id=id, + json_api_export_template_in_document=json_api_export_template_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_export_templates_serialize( self, id, json_api_export_template_in_document, - **kwargs - ): - """PUT Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_export_templates(id, json_api_export_template_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_export_template_in_document (JsonApiExportTemplateInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_export_template_in_document'] = \ - json_api_export_template_in_document - return self.update_entity_export_templates_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_template_in_document is not None: + _body_params = json_api_export_template_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_in_document: JsonApiFilterContextInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Put a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_in_document: (required) + :type json_api_filter_context_in_document: JsonApiFilterContextInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_in_document=json_api_filter_context_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_in_document: JsonApiFilterContextInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Put a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_in_document: (required) + :type json_api_filter_context_in_document: JsonApiFilterContextInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_in_document=json_api_filter_context_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_in_document: JsonApiFilterContextInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_in_document: (required) + :type json_api_filter_context_in_document: JsonApiFilterContextInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_in_document=json_api_filter_context_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_filter_contexts_serialize( self, workspace_id, object_id, json_api_filter_context_in_document, - **kwargs - ): - """Put a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_context_in_document (JsonApiFilterContextInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_context_in_document'] = \ - json_api_filter_context_in_document - return self.update_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_context_in_document is not None: + _body_params = json_api_filter_context_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Put Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Put Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_filter_views_serialize( self, workspace_id, object_id, json_api_filter_view_in_document, - **kwargs - ): - """Put Filter views # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.update_entity_filter_views_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_view_in_document is not None: + _body_params = json_api_filter_view_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Put Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Put Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_identity_providers_serialize( self, id, json_api_identity_provider_in_document, - **kwargs - ): - """Put Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_identity_providers(id, json_api_identity_provider_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_identity_provider_in_document'] = \ - json_api_identity_provider_in_document - return self.update_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_identity_provider_in_document is not None: + _body_params = json_api_identity_provider_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_in_document: JsonApiJwkInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Put Jwk + + Updates JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_jwks_serialize( + id=id, + json_api_jwk_in_document=json_api_jwk_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_in_document: JsonApiJwkInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Put Jwk + + Updates JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_jwks_serialize( + id=id, + json_api_jwk_in_document=json_api_jwk_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_in_document: JsonApiJwkInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Jwk + + Updates JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_jwks_serialize( + id=id, + json_api_jwk_in_document=json_api_jwk_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_jwks_serialize( self, id, json_api_jwk_in_document, - **kwargs - ): - """Put Jwk # noqa: E501 - - Updates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_jwks(id, json_api_jwk_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_jwk_in_document (JsonApiJwkInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.update_entity_jwks_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_jwk_in_document is not None: + _body_params = json_api_jwk_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_llm_endpoints( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """PUT LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_llm_endpoints_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """PUT LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_llm_endpoints_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """PUT LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_llm_endpoints_serialize( self, id, json_api_llm_endpoint_in_document, - **kwargs - ): - """PUT LLM endpoint entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_llm_endpoint_in_document (JsonApiLlmEndpointInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_llm_endpoint_in_document'] = \ - json_api_llm_endpoint_in_document - return self.update_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_llm_endpoint_in_document is not None: + _body_params = json_api_llm_endpoint_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_metrics( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_in_document: JsonApiMetricInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Put a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_in_document: (required) + :type json_api_metric_in_document: JsonApiMetricInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_in_document=json_api_metric_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_in_document: JsonApiMetricInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Put a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_in_document: (required) + :type json_api_metric_in_document: JsonApiMetricInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_in_document=json_api_metric_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_in_document: JsonApiMetricInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_in_document: (required) + :type json_api_metric_in_document: JsonApiMetricInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_in_document=json_api_metric_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_metrics_serialize( self, workspace_id, object_id, json_api_metric_in_document, - **kwargs - ): - """Put a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_metric_in_document (JsonApiMetricInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_metric_in_document'] = \ - json_api_metric_in_document - return self.update_entity_metrics_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_metric_in_document is not None: + _body_params = json_api_metric_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_notification_channels( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Put Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_in_document: (required) + :type json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_in_document=json_api_notification_channel_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_notification_channels_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Put Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_in_document: (required) + :type json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_in_document=json_api_notification_channel_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_notification_channels_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_in_document: (required) + :type json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_in_document=json_api_notification_channel_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_notification_channels_serialize( self, id, json_api_notification_channel_in_document, - **kwargs - ): - """Put Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_notification_channels(id, json_api_notification_channel_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_notification_channel_in_document (JsonApiNotificationChannelInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_notification_channel_in_document'] = \ - json_api_notification_channel_in_document - return self.update_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_notification_channel_in_document is not None: + _body_params = json_api_notification_channel_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_organization_settings( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Put Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Put Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_organization_settings_serialize( self, id, json_api_organization_setting_in_document, - **kwargs - ): - """Put Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_organization_settings(id, json_api_organization_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_setting_in_document'] = \ - json_api_organization_setting_in_document - return self.update_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_setting_in_document is not None: + _body_params = json_api_organization_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_organizations( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_in_document: JsonApiOrganizationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationOutDocument: + """Put Organization + + + :param id: (required) + :type id: str + :param json_api_organization_in_document: (required) + :type json_api_organization_in_document: JsonApiOrganizationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organizations_serialize( + id=id, + json_api_organization_in_document=json_api_organization_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_organizations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_in_document: JsonApiOrganizationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationOutDocument]: + """Put Organization + + + :param id: (required) + :type id: str + :param json_api_organization_in_document: (required) + :type json_api_organization_in_document: JsonApiOrganizationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organizations_serialize( + id=id, + json_api_organization_in_document=json_api_organization_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_organizations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_in_document: JsonApiOrganizationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Organization + + + :param id: (required) + :type id: str + :param json_api_organization_in_document: (required) + :type json_api_organization_in_document: JsonApiOrganizationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organizations_serialize( + id=id, + json_api_organization_in_document=json_api_organization_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_organizations_serialize( self, id, json_api_organization_in_document, - **kwargs - ): - """Put Organization # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_organizations(id, json_api_organization_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_in_document (JsonApiOrganizationInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_in_document'] = \ - json_api_organization_in_document - return self.update_entity_organizations_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_in_document is not None: + _body_params = json_api_organization_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/admin/organizations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_in_document: JsonApiThemeInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Put Theming + + + :param id: (required) + :type id: str + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_themes_serialize( + id=id, + json_api_theme_in_document=json_api_theme_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_in_document: JsonApiThemeInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Put Theming + + + :param id: (required) + :type id: str + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_themes_serialize( + id=id, + json_api_theme_in_document=json_api_theme_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_in_document: JsonApiThemeInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Theming + + + :param id: (required) + :type id: str + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_themes_serialize( + id=id, + json_api_theme_in_document=json_api_theme_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_themes_serialize( self, id, json_api_theme_in_document, - **kwargs - ): - """Put Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_themes(id, json_api_theme_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_theme_in_document (JsonApiThemeInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_theme_in_document'] = \ - json_api_theme_in_document - return self.update_entity_themes_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_theme_in_document is not None: + _body_params = json_api_theme_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Put a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_in_document: (required) + :type json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_in_document=json_api_user_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Put a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_in_document: (required) + :type json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_in_document=json_api_user_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_in_document: (required) + :type json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_in_document=json_api_user_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_user_data_filters_serialize( self, workspace_id, object_id, json_api_user_data_filter_in_document, - **kwargs - ): - """Put a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_user_data_filter_in_document (JsonApiUserDataFilterInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_user_data_filter_in_document'] = \ - json_api_user_data_filter_in_document - return self.update_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_data_filter_in_document is not None: + _body_params = json_api_user_data_filter_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_in_document: JsonApiUserGroupInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Put UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_groups_serialize( + id=id, + json_api_user_group_in_document=json_api_user_group_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_in_document: JsonApiUserGroupInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Put UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_groups_serialize( + id=id, + json_api_user_group_in_document=json_api_user_group_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_in_document: JsonApiUserGroupInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_groups_serialize( + id=id, + json_api_user_group_in_document=json_api_user_group_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_user_groups_serialize( self, id, json_api_user_group_in_document, - **kwargs - ): - """Put UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_user_groups(id, json_api_user_group_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_group_in_document (JsonApiUserGroupInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_group_in_document'] = \ - json_api_user_group_in_document - return self.update_entity_user_groups_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_group_in_document is not None: + _body_params = json_api_user_group_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_user_settings( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutDocument: + """Put new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_settings_serialize( + user_id=user_id, + id=id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutDocument]: + """Put new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_settings_serialize( + user_id=user_id, + id=id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_settings_serialize( + user_id=user_id, + id=id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_user_settings_serialize( self, user_id, id, json_api_user_setting_in_document, - **kwargs - ): - """Put new user settings for the user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - json_api_user_setting_in_document (JsonApiUserSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - kwargs['json_api_user_setting_in_document'] = \ - json_api_user_setting_in_document - return self.update_entity_user_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_setting_in_document is not None: + _body_params = json_api_user_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/users/{userId}/userSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_users( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_in_document: JsonApiUserInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Put User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_users_serialize( + id=id, + json_api_user_in_document=json_api_user_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_users_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_in_document: JsonApiUserInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Put User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_users_serialize( + id=id, + json_api_user_in_document=json_api_user_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_users_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_in_document: JsonApiUserInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_users_serialize( + id=id, + json_api_user_in_document=json_api_user_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_users_serialize( self, id, json_api_user_in_document, - **kwargs - ): - """Put User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_users(id, json_api_user_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_in_document (JsonApiUserInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_in_document'] = \ - json_api_user_in_document - return self.update_entity_users_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_in_document is not None: + _body_params = json_api_user_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Put a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_in_document: (required) + :type json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_in_document=json_api_visualization_object_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Put a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_in_document: (required) + :type json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_in_document=json_api_visualization_object_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_in_document: (required) + :type json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_in_document=json_api_visualization_object_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_visualization_objects_serialize( self, workspace_id, object_id, json_api_visualization_object_in_document, - **kwargs - ): - """Put a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_visualization_object_in_document (JsonApiVisualizationObjectInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_visualization_object_in_document'] = \ - json_api_visualization_object_in_document - return self.update_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_visualization_object_in_document is not None: + _body_params = json_api_visualization_object_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Put a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Put a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_workspace_data_filter_settings_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, - **kwargs - ): - """Put a Settings for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_setting_in_document'] = \ - json_api_workspace_data_filter_setting_in_document - return self.update_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_setting_in_document is not None: + _body_params = json_api_workspace_data_filter_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Put a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Put a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_workspace_data_filters_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_in_document, - **kwargs - ): - """Put a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_in_document'] = \ - json_api_workspace_data_filter_in_document - return self.update_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_in_document is not None: + _body_params = json_api_workspace_data_filter_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_workspace_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Put a Setting for a Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_in_document: (required) + :type json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_in_document=json_api_workspace_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Put a Setting for a Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_in_document: (required) + :type json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_in_document=json_api_workspace_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Setting for a Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_in_document: (required) + :type json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_in_document=json_api_workspace_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_workspace_settings_serialize( self, workspace_id, object_id, json_api_workspace_setting_in_document, - **kwargs - ): - """Put a Setting for a Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_setting_in_document (JsonApiWorkspaceSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_setting_in_document'] = \ - json_api_workspace_setting_in_document - return self.update_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_setting_in_document is not None: + _body_params = json_api_workspace_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_workspaces( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Put Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspaces_serialize( + id=id, + json_api_workspace_in_document=json_api_workspace_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspaces_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Put Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspaces_serialize( + id=id, + json_api_workspace_in_document=json_api_workspace_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_workspaces_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspaces_serialize( + id=id, + json_api_workspace_in_document=json_api_workspace_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_workspaces_serialize( self, id, json_api_workspace_in_document, - **kwargs - ): - """Put Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspaces(id, json_api_workspace_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_workspace_in_document (JsonApiWorkspaceInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_workspace_in_document'] = \ - json_api_workspace_in_document - return self.update_entity_workspaces_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_in_document is not None: + _body_params = json_api_workspace_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/entitlement_api.py b/gooddata-api-client/gooddata_api_client/api/entitlement_api.py index abaa854a3..2d1424368 100644 --- a/gooddata-api-client/gooddata_api_client/api/entitlement_api.py +++ b/gooddata-api-client/gooddata_api_client/api/entitlement_api.py @@ -1,603 +1,1170 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.models.entitlements_request import EntitlementsRequest +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.api_entitlement import ApiEntitlement -from gooddata_api_client.model.entitlements_request import EntitlementsRequest -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class EntitlementApi(object): +class EntitlementApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_all_entities_entitlements_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiEntitlementOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/entitlements', - 'operation_id': 'get_all_entities_entitlements', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ + + + @validate_call + def get_all_entities_entitlements( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiEntitlementOutList: + """Get Entitlements + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_entitlements_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_entitlements_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiEntitlementOutList]: + """Get Entitlements + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_entitlements_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_entitlements_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Entitlements + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_entitlements_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_entitlements_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_entitlements_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiEntitlementOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/entitlements/{id}', - 'operation_id': 'get_entity_entitlements', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/entitlements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_entitlements( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiEntitlementOutDocument: + """Get Entitlement + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_entitlements_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_entitlements_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiEntitlementOutDocument]: + """Get Entitlement + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_entitlements_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_entitlements_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Entitlement + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_entitlements_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_entitlements_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.resolve_all_entitlements_endpoint = _Endpoint( - settings={ - 'response_type': ([ApiEntitlement],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/resolveEntitlements', - 'operation_id': 'resolve_all_entitlements', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.resolve_requested_entitlements_endpoint = _Endpoint( - settings={ - 'response_type': ([ApiEntitlement],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/resolveEntitlements', - 'operation_id': 'resolve_requested_entitlements', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'entitlements_request', - ], - 'required': [ - 'entitlements_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'entitlements_request': - (EntitlementsRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'entitlements_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/entitlements/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def resolve_all_entitlements( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ApiEntitlement]: + """Values for all public entitlements. + + Resolves values of available entitlements for the organization. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_entitlements_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def resolve_all_entitlements_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ApiEntitlement]]: + """Values for all public entitlements. + + Resolves values of available entitlements for the organization. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_entitlements_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def resolve_all_entitlements_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for all public entitlements. + + Resolves values of available entitlements for the organization. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_entitlements_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _resolve_all_entitlements_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/resolveEntitlements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - def get_all_entities_entitlements( + + + + @validate_call + def resolve_requested_entitlements( self, - **kwargs - ): - """Get Entitlements # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_entitlements(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiEntitlementOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) + entitlements_request: EntitlementsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ApiEntitlement]: + """Values for requested public entitlements. - def get_entity_entitlements( + Resolves values for requested entitlements in the organization. + + :param entitlements_request: (required) + :type entitlements_request: EntitlementsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_requested_entitlements_serialize( + entitlements_request=entitlements_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def resolve_requested_entitlements_with_http_info( self, - id, - **kwargs - ): - """Get Entitlement # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_entitlements(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiEntitlementOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_entitlements_endpoint.call_with_http_info(**kwargs) + entitlements_request: EntitlementsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ApiEntitlement]]: + """Values for requested public entitlements. - def resolve_all_entitlements( + Resolves values for requested entitlements in the organization. + + :param entitlements_request: (required) + :type entitlements_request: EntitlementsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_requested_entitlements_serialize( + entitlements_request=entitlements_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def resolve_requested_entitlements_without_preload_content( self, - **kwargs - ): - """Values for all public entitlements. # noqa: E501 - - Resolves values of available entitlements for the organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.resolve_all_entitlements(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ApiEntitlement] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.resolve_all_entitlements_endpoint.call_with_http_info(**kwargs) + entitlements_request: EntitlementsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for requested public entitlements. - def resolve_requested_entitlements( + Resolves values for requested entitlements in the organization. + + :param entitlements_request: (required) + :type entitlements_request: EntitlementsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_requested_entitlements_serialize( + entitlements_request=entitlements_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ApiEntitlement]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _resolve_requested_entitlements_serialize( self, entitlements_request, - **kwargs - ): - """Values for requested public entitlements. # noqa: E501 - - Resolves values for requested entitlements in the organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.resolve_requested_entitlements(entitlements_request, async_req=True) - >>> result = thread.get() - - Args: - entitlements_request (EntitlementsRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ApiEntitlement] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['entitlements_request'] = \ - entitlements_request - return self.resolve_requested_entitlements_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if entitlements_request is not None: + _body_params = entitlements_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/resolveEntitlements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py b/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py index 374bb9649..c40847371 100644 --- a/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py @@ -1,1134 +1,2051 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.models.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.models.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList -from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument -from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class ExportDefinitionsApi(object): +class ExportDefinitionsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', - 'operation_id': 'create_entity_export_definitions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_export_definition_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_export_definition_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_export_definition_post_optional_id_document': - (JsonApiExportDefinitionPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_export_definition_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_export_definitions( + self, + workspace_id: StrictStr, + json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Post Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_export_definition_post_optional_id_document: (required) + :type json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_definitions_serialize( + workspace_id=workspace_id, + json_api_export_definition_post_optional_id_document=json_api_export_definition_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.delete_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'delete_entity_export_definitions', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.get_all_entities_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', - 'operation_id': 'get_all_entities_export_definitions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Post Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_export_definition_post_optional_id_document: (required) + :type json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_definitions_serialize( + workspace_id=workspace_id, + json_api_export_definition_post_optional_id_document=json_api_export_definition_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.get_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'get_entity_export_definitions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.patch_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'patch_entity_export_definitions', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_export_definition_patch_document': - (JsonApiExportDefinitionPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_export_definition_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - self.update_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'update_entity_export_definitions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_export_definition_in_document': - (JsonApiExportDefinitionInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_export_definition_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_export_definition_post_optional_id_document: (required) + :type json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_definitions_serialize( + workspace_id=workspace_id, + json_api_export_definition_post_optional_id_document=json_api_export_definition_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - def create_entity_export_definitions( + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_export_definitions_serialize( self, workspace_id, json_api_export_definition_post_optional_id_document, - **kwargs - ): - """Post Export Definitions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_export_definition_post_optional_id_document (JsonApiExportDefinitionPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_definition_post_optional_id_document is not None: + _body_params = json_api_export_definition_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def delete_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_export_definition_post_optional_id_document'] = \ - json_api_export_definition_post_optional_id_document - return self.create_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + return response_data.response - def delete_entity_export_definitions( + + def _delete_entity_export_definitions_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_export_definitions(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_all_entities_export_definitions( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutList: + """Get all Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_definitions_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutList]: + """Get all Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_definitions_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_all_entities_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_definitions_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - def get_all_entities_export_definitions( + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_export_definitions_serialize( self, workspace_id, - **kwargs - ): - """Get all Export Definitions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_export_definitions(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Get an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Get an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_export_definitions_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_export_definitions( + + def _get_entity_export_definitions_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_export_definitions(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def patch_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Patch an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_patch_document: (required) + :type json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_patch_document=json_api_export_definition_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Patch an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_patch_document: (required) + :type json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_patch_document=json_api_export_definition_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_patch_document: (required) + :type json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_patch_document=json_api_export_definition_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + return response_data.response - def patch_entity_export_definitions( + + def _patch_entity_export_definitions_serialize( self, workspace_id, object_id, json_api_export_definition_patch_document, - **kwargs - ): - """Patch an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_export_definition_patch_document (JsonApiExportDefinitionPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_definition_patch_document is not None: + _body_params = json_api_export_definition_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def update_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_in_document: JsonApiExportDefinitionInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Put an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_in_document: (required) + :type json_api_export_definition_in_document: JsonApiExportDefinitionInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_in_document=json_api_export_definition_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_in_document: JsonApiExportDefinitionInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Put an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_in_document: (required) + :type json_api_export_definition_in_document: JsonApiExportDefinitionInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_in_document=json_api_export_definition_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def update_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_in_document: JsonApiExportDefinitionInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_in_document: (required) + :type json_api_export_definition_in_document: JsonApiExportDefinitionInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_in_document=json_api_export_definition_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_export_definition_patch_document'] = \ - json_api_export_definition_patch_document - return self.patch_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + return response_data.response - def update_entity_export_definitions( + + def _update_entity_export_definitions_serialize( self, workspace_id, object_id, json_api_export_definition_in_document, - **kwargs - ): - """Put an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_export_definition_in_document (JsonApiExportDefinitionInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_definition_in_document is not None: + _body_params = json_api_export_definition_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_export_definition_in_document'] = \ - json_api_export_definition_in_document - return self.update_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/export_templates_api.py b/gooddata-api-client/gooddata_api_client/api/export_templates_api.py index d8f125af0..6d9cf85d7 100644 --- a/gooddata-api-client/gooddata_api_client/api/export_templates_api.py +++ b/gooddata-api-client/gooddata_api_client/api/export_templates_api.py @@ -1,933 +1,1788 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument -from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList -from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument -from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.models.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.models.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class ExportTemplatesApi(object): + +class ExportTemplatesApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates', - 'operation_id': 'create_entity_export_templates', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_export_template_post_optional_id_document', - ], - 'required': [ - 'json_api_export_template_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_export_template_post_optional_id_document': - (JsonApiExportTemplatePostOptionalIdDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_export_template_post_optional_id_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'delete_entity_export_templates', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates', - 'operation_id': 'get_all_entities_export_templates', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'get_entity_export_templates', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'patch_entity_export_templates', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_export_template_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_export_template_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_export_template_patch_document': - (JsonApiExportTemplatePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_export_template_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'update_entity_export_templates', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_export_template_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_export_template_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_export_template_in_document': - (JsonApiExportTemplateInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_export_template_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_export_templates( + self, + json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """Post Export Template entities + + + :param json_api_export_template_post_optional_id_document: (required) + :type json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_templates_serialize( + json_api_export_template_post_optional_id_document=json_api_export_template_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_export_templates_with_http_info( + self, + json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """Post Export Template entities + + + :param json_api_export_template_post_optional_id_document: (required) + :type json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_templates_serialize( + json_api_export_template_post_optional_id_document=json_api_export_template_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_export_templates_without_preload_content( + self, + json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Export Template entities + + + :param json_api_export_template_post_optional_id_document: (required) + :type json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_templates_serialize( + json_api_export_template_post_optional_id_document=json_api_export_template_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_export_templates_serialize( self, json_api_export_template_post_optional_id_document, - **kwargs - ): - """Post Export Template entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_export_template_post_optional_id_document'] = \ - json_api_export_template_post_optional_id_document - return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_template_post_optional_id_document is not None: + _body_params = json_api_export_template_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/exportTemplates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_export_templates_serialize( self, id, - **kwargs - ): - """Delete Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_export_templates(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_export_templates( self, - **kwargs - ): - """GET all Export Template entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_export_templates(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutList: + """GET all Export Template entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_templates_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_export_templates_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutList]: + """GET all Export Template entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_templates_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_export_templates_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """GET all Export Template entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_templates_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_export_templates_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/exportTemplates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """GET Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """GET Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """GET Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_export_templates_serialize( self, id, - **kwargs - ): - """GET Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_export_templates(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_export_templates_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def patch_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """Patch Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_patch_document: (required) + :type json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_templates_serialize( + id=id, + json_api_export_template_patch_document=json_api_export_template_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """Patch Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_patch_document: (required) + :type json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_templates_serialize( + id=id, + json_api_export_template_patch_document=json_api_export_template_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_patch_document: (required) + :type json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_templates_serialize( + id=id, + json_api_export_template_patch_document=json_api_export_template_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_export_templates_serialize( self, id, json_api_export_template_patch_document, - **kwargs - ): - """Patch Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_export_templates(id, json_api_export_template_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_export_template_patch_document (JsonApiExportTemplatePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_export_template_patch_document'] = \ - json_api_export_template_patch_document - return self.patch_entity_export_templates_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_template_patch_document is not None: + _body_params = json_api_export_template_patch_document + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_in_document: JsonApiExportTemplateInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """PUT Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_in_document: (required) + :type json_api_export_template_in_document: JsonApiExportTemplateInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_templates_serialize( + id=id, + json_api_export_template_in_document=json_api_export_template_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_in_document: JsonApiExportTemplateInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """PUT Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_in_document: (required) + :type json_api_export_template_in_document: JsonApiExportTemplateInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_templates_serialize( + id=id, + json_api_export_template_in_document=json_api_export_template_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_in_document: JsonApiExportTemplateInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """PUT Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_in_document: (required) + :type json_api_export_template_in_document: JsonApiExportTemplateInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_templates_serialize( + id=id, + json_api_export_template_in_document=json_api_export_template_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_export_templates_serialize( self, id, json_api_export_template_in_document, - **kwargs - ): - """PUT Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_export_templates(id, json_api_export_template_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_export_template_in_document (JsonApiExportTemplateInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_export_template_in_document'] = \ - json_api_export_template_in_document - return self.update_entity_export_templates_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_template_in_document is not None: + _body_params = json_api_export_template_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/facts_api.py b/gooddata-api-client/gooddata_api_client/api/facts_api.py index 0c52ab35b..c29dd9069 100644 --- a/gooddata-api-client/gooddata_api_client/api/facts_api.py +++ b/gooddata-api-client/gooddata_api_client/api/facts_api.py @@ -1,433 +1,775 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class FactsApi(object): +class FactsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_all_entities_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFactOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts', - 'operation_id': 'get_all_entities_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "DATASETS": "datasets", - "DATASET": "dataset", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFactOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}', - 'operation_id': 'get_entity_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "DATASET": "dataset", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def get_all_entities_facts( self, - workspace_id, - **kwargs - ): - """Get all Facts # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_facts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFactOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFactOutList: + """Get all Facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_facts_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFactOutList]: + """Get all Facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_all_entities_facts_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_facts_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_facts( + + def _get_all_entities_facts_serialize( self, workspace_id, - object_id, - **kwargs - ): - """Get a Fact # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_facts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFactOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/facts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_entity_facts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFactOutDocument: + """Get a Fact + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_facts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFactOutDocument]: + """Get a Fact + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_entity_facts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Fact + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_facts_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _get_entity_facts_serialize( + self, + workspace_id, + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/filter_views_api.py b/gooddata-api-client/gooddata_api_client/api/filter_views_api.py index 38dc1af63..f55c14da9 100644 --- a/gooddata-api-client/gooddata_api_client/api/filter_views_api.py +++ b/gooddata-api-client/gooddata_api_client/api/filter_views_api.py @@ -1,1357 +1,2575 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.models.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument -from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList -from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class FilterViewsApi(object): +class FilterViewsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', - 'operation_id': 'create_entity_filter_views', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_filter_view_in_document', - 'include', - ], - 'required': [ - 'workspace_id', - 'json_api_filter_view_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_filter_view_in_document': - (JsonApiFilterViewInDocument,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_filter_view_in_document': 'body', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'delete_entity_filter_views', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', - 'operation_id': 'get_all_entities_filter_views', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'get_entity_filter_views', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': ([DeclarativeFilterView],), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/filterViews', - 'operation_id': 'get_filter_views', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'exclude', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'exclude': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'exclude': 'exclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'patch_entity_filter_views', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_view_patch_document': - (JsonApiFilterViewPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_view_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.set_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/filterViews', - 'operation_id': 'set_filter_views', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_filter_view', - ], - 'required': [ - 'workspace_id', - 'declarative_filter_view', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_filter_view': - ([DeclarativeFilterView],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_filter_view': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.update_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'update_entity_filter_views', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_view_in_document': - (JsonApiFilterViewInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_view_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_filter_views( + self, + workspace_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Post Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_views_serialize( + workspace_id=workspace_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Post Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_views_serialize( + workspace_id=workspace_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_views_serialize( + workspace_id=workspace_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_filter_views_serialize( self, workspace_id, json_api_filter_view_in_document, - **kwargs - ): - """Post Filter views # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.create_entity_filter_views_endpoint.call_with_http_info(**kwargs) - + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_view_in_document is not None: + _body_params = json_api_filter_view_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_filter_views_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_filter_views(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_filter_views( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutList: + """Get all Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_views_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_filter_views_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutList]: + """Get all Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_views_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_views_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_filter_views_serialize( self, workspace_id, - **kwargs - ): - """Get all Filter views # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_filter_views(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_filter_views_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Get Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Get Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_filter_views_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_filter_views(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_filter_views_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_filter_views( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DeclarativeFilterView]: + """Get filter views + + Retrieve filter views for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_filter_views_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeFilterView]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_filter_views_with_http_info( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DeclarativeFilterView]]: + """Get filter views + + Retrieve filter views for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_filter_views_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeFilterView]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get filter views + + Retrieve filter views for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_filter_views_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeFilterView]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_filter_views_serialize( self, workspace_id, - **kwargs - ): - """Get filter views # noqa: E501 - - Retrieve filter views for the specific workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_filter_views(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [DeclarativeFilterView] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_filter_views_endpoint.call_with_http_info(**kwargs) + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/filterViews', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Patch Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_patch_document: (required) + :type json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_patch_document=json_api_filter_view_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Patch Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_patch_document: (required) + :type json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_patch_document=json_api_filter_view_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_patch_document: (required) + :type json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_patch_document=json_api_filter_view_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_filter_views_serialize( self, workspace_id, object_id, json_api_filter_view_patch_document, - **kwargs - ): - """Patch Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_view_patch_document (JsonApiFilterViewPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_view_patch_document'] = \ - json_api_filter_view_patch_document - return self.patch_entity_filter_views_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_view_patch_document is not None: + _body_params = json_api_filter_view_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_filter_views( + self, + workspace_id: StrictStr, + declarative_filter_view: List[DeclarativeFilterView], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set filter views + + Set filter views for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_filter_view: (required) + :type declarative_filter_view: List[DeclarativeFilterView] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_filter_views_serialize( + workspace_id=workspace_id, + declarative_filter_view=declarative_filter_view, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_filter_views_with_http_info( + self, + workspace_id: StrictStr, + declarative_filter_view: List[DeclarativeFilterView], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set filter views + + Set filter views for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_filter_view: (required) + :type declarative_filter_view: List[DeclarativeFilterView] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_filter_views_serialize( + workspace_id=workspace_id, + declarative_filter_view=declarative_filter_view, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + declarative_filter_view: List[DeclarativeFilterView], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set filter views + + Set filter views for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_filter_view: (required) + :type declarative_filter_view: List[DeclarativeFilterView] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_filter_views_serialize( + workspace_id=workspace_id, + declarative_filter_view=declarative_filter_view, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_filter_views_serialize( self, workspace_id, declarative_filter_view, - **kwargs - ): - """Set filter views # noqa: E501 - - Set filter views for the specific workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_filter_views(workspace_id, declarative_filter_view, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_filter_view ([DeclarativeFilterView]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_filter_view'] = \ - declarative_filter_view - return self.set_filter_views_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'DeclarativeFilterView': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_filter_view is not None: + _body_params = declarative_filter_view + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/filterViews', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Put Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Put Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_filter_views_serialize( self, workspace_id, object_id, json_api_filter_view_in_document, - **kwargs - ): - """Put Filter views # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.update_entity_filter_views_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_view_in_document is not None: + _body_params = json_api_filter_view_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/generate_logical_data_model_api.py b/gooddata-api-client/gooddata_api_client/api/generate_logical_data_model_api.py index edd7e6116..38dc7bbd3 100644 --- a/gooddata-api-client/gooddata_api_client/api/generate_logical_data_model_api.py +++ b/gooddata-api-client/gooddata_api_client/api/generate_logical_data_model_api.py @@ -1,183 +1,327 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictStr +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_model import DeclarativeModel -from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class GenerateLogicalDataModelApi(object): +class GenerateLogicalDataModelApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.generate_logical_model_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeModel,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel', - 'operation_id': 'generate_logical_model', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'generate_ldm_request', - ], - 'required': [ - 'data_source_id', - 'generate_ldm_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'generate_ldm_request': - (GenerateLdmRequest,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'generate_ldm_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def generate_logical_model( self, - data_source_id, - generate_ldm_request, - **kwargs - ): - """Generate logical data model (LDM) from physical data model (PDM) # noqa: E501 - - Generate logical data model (LDM) from physical data model (PDM) stored in data source. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.generate_logical_model(data_source_id, generate_ldm_request, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - generate_ldm_request (GenerateLdmRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeModel - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + data_source_id: StrictStr, + generate_ldm_request: GenerateLdmRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeModel: + """Generate logical data model (LDM) from physical data model (PDM) + + Generate logical data model (LDM) from physical data model (PDM) stored in data source. + + :param data_source_id: (required) + :type data_source_id: str + :param generate_ldm_request: (required) + :type generate_ldm_request: GenerateLdmRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_logical_model_serialize( + data_source_id=data_source_id, + generate_ldm_request=generate_ldm_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def generate_logical_model_with_http_info( + self, + data_source_id: StrictStr, + generate_ldm_request: GenerateLdmRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeModel]: + """Generate logical data model (LDM) from physical data model (PDM) + + Generate logical data model (LDM) from physical data model (PDM) stored in data source. + + :param data_source_id: (required) + :type data_source_id: str + :param generate_ldm_request: (required) + :type generate_ldm_request: GenerateLdmRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_logical_model_serialize( + data_source_id=data_source_id, + generate_ldm_request=generate_ldm_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def generate_logical_model_without_preload_content( + self, + data_source_id: StrictStr, + generate_ldm_request: GenerateLdmRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Generate logical data model (LDM) from physical data model (PDM) + + Generate logical data model (LDM) from physical data model (PDM) stored in data source. + + :param data_source_id: (required) + :type data_source_id: str + :param generate_ldm_request: (required) + :type generate_ldm_request: GenerateLdmRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_logical_model_serialize( + data_source_id=data_source_id, + generate_ldm_request=generate_ldm_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _generate_logical_model_serialize( + self, + data_source_id, + generate_ldm_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if generate_ldm_request is not None: + _body_params = generate_ldm_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['generate_ldm_request'] = \ - generate_ldm_request - return self.generate_logical_model_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/hierarchy_api.py b/gooddata-api-client/gooddata_api_client/api/hierarchy_api.py index ea52a0287..94d90139b 100644 --- a/gooddata-api-client/gooddata_api_client/api/hierarchy_api.py +++ b/gooddata-api-client/gooddata_api_client/api/hierarchy_api.py @@ -1,579 +1,1109 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictStr +from typing import List +from gooddata_api_client.models.hierarchy_object_identification import HierarchyObjectIdentification +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class HierarchyApi(object): +class HierarchyApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.check_entity_overrides_endpoint = _Endpoint( - settings={ - 'response_type': ([IdentifierDuplications],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides', - 'operation_id': 'check_entity_overrides', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'hierarchy_object_identification', - ], - 'required': [ - 'workspace_id', - 'hierarchy_object_identification', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'hierarchy_object_identification': - ([HierarchyObjectIdentification],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'hierarchy_object_identification': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.inherited_entity_conflicts_endpoint = _Endpoint( - settings={ - 'response_type': ([IdentifierDuplications],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts', - 'operation_id': 'inherited_entity_conflicts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.inherited_entity_prefixes_endpoint = _Endpoint( - settings={ - 'response_type': ([str],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes', - 'operation_id': 'inherited_entity_prefixes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.overridden_child_entities_endpoint = _Endpoint( - settings={ - 'response_type': ([IdentifierDuplications],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities', - 'operation_id': 'overridden_child_entities', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def check_entity_overrides( + self, + workspace_id: StrictStr, + hierarchy_object_identification: List[HierarchyObjectIdentification], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[IdentifierDuplications]: + """Finds entities with given ID in hierarchy. + + Finds entities with given ID in hierarchy (e.g. to check possible future conflicts). + + :param workspace_id: (required) + :type workspace_id: str + :param hierarchy_object_identification: (required) + :type hierarchy_object_identification: List[HierarchyObjectIdentification] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_entity_overrides_serialize( + workspace_id=workspace_id, + hierarchy_object_identification=hierarchy_object_identification, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def check_entity_overrides_with_http_info( + self, + workspace_id: StrictStr, + hierarchy_object_identification: List[HierarchyObjectIdentification], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[IdentifierDuplications]]: + """Finds entities with given ID in hierarchy. + + Finds entities with given ID in hierarchy (e.g. to check possible future conflicts). + + :param workspace_id: (required) + :type workspace_id: str + :param hierarchy_object_identification: (required) + :type hierarchy_object_identification: List[HierarchyObjectIdentification] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_entity_overrides_serialize( + workspace_id=workspace_id, + hierarchy_object_identification=hierarchy_object_identification, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def check_entity_overrides_without_preload_content( + self, + workspace_id: StrictStr, + hierarchy_object_identification: List[HierarchyObjectIdentification], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Finds entities with given ID in hierarchy. + + Finds entities with given ID in hierarchy (e.g. to check possible future conflicts). + + :param workspace_id: (required) + :type workspace_id: str + :param hierarchy_object_identification: (required) + :type hierarchy_object_identification: List[HierarchyObjectIdentification] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_entity_overrides_serialize( + workspace_id=workspace_id, + hierarchy_object_identification=hierarchy_object_identification, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _check_entity_overrides_serialize( self, workspace_id, hierarchy_object_identification, - **kwargs - ): - """Finds entities with given ID in hierarchy. # noqa: E501 - - Finds entities with given ID in hierarchy (e.g. to check possible future conflicts). # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.check_entity_overrides(workspace_id, hierarchy_object_identification, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - hierarchy_object_identification ([HierarchyObjectIdentification]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [IdentifierDuplications] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['hierarchy_object_identification'] = \ - hierarchy_object_identification - return self.check_entity_overrides_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'HierarchyObjectIdentification': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if hierarchy_object_identification is not None: + _body_params = hierarchy_object_identification + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def inherited_entity_conflicts( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[IdentifierDuplications]: + """Finds identifier conflicts in workspace hierarchy. + + Finds API identifier conflicts in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_conflicts_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def inherited_entity_conflicts_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[IdentifierDuplications]]: + """Finds identifier conflicts in workspace hierarchy. + + Finds API identifier conflicts in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_conflicts_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def inherited_entity_conflicts_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Finds identifier conflicts in workspace hierarchy. + + Finds API identifier conflicts in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_conflicts_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _inherited_entity_conflicts_serialize( self, workspace_id, - **kwargs - ): - """Finds identifier conflicts in workspace hierarchy. # noqa: E501 - - Finds API identifier conflicts in given workspace hierarchy. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.inherited_entity_conflicts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [IdentifierDuplications] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.inherited_entity_conflicts_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def inherited_entity_prefixes( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[str]: + """Get used entity prefixes in hierarchy + + Get used entity prefixes in hierarchy of parent workspaces + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_prefixes_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def inherited_entity_prefixes_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[str]]: + """Get used entity prefixes in hierarchy + + Get used entity prefixes in hierarchy of parent workspaces + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_prefixes_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def inherited_entity_prefixes_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get used entity prefixes in hierarchy + + Get used entity prefixes in hierarchy of parent workspaces + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inherited_entity_prefixes_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _inherited_entity_prefixes_serialize( self, workspace_id, - **kwargs - ): - """Get used entity prefixes in hierarchy # noqa: E501 - - Get used entity prefixes in hierarchy of parent workspaces # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.inherited_entity_prefixes(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [str] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.inherited_entity_prefixes_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def overridden_child_entities( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[IdentifierDuplications]: + """Finds identifier overrides in workspace hierarchy. + + Finds API identifier overrides in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._overridden_child_entities_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def overridden_child_entities_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[IdentifierDuplications]]: + """Finds identifier overrides in workspace hierarchy. + + Finds API identifier overrides in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._overridden_child_entities_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def overridden_child_entities_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Finds identifier overrides in workspace hierarchy. + + Finds API identifier overrides in given workspace hierarchy. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._overridden_child_entities_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[IdentifierDuplications]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _overridden_child_entities_serialize( self, workspace_id, - **kwargs - ): - """Finds identifier overrides in workspace hierarchy. # noqa: E501 - - Finds API identifier overrides in given workspace hierarchy. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.overridden_child_entities(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [IdentifierDuplications] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.overridden_child_entities_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/identity_providers_api.py b/gooddata-api-client/gooddata_api_client/api/identity_providers_api.py index ecb434656..d689f2998 100644 --- a/gooddata-api-client/gooddata_api_client/api/identity_providers_api.py +++ b/gooddata-api-client/gooddata_api_client/api/identity_providers_api.py @@ -1,1184 +1,2300 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.models.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList -from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class IdentityProvidersApi(object): +class IdentityProvidersApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders', - 'operation_id': 'create_entity_identity_providers', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_identity_provider_in_document', - ], - 'required': [ - 'json_api_identity_provider_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_identity_provider_in_document': - (JsonApiIdentityProviderInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_identity_provider_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'delete_entity_identity_providers', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders', - 'operation_id': 'get_all_entities_identity_providers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'get_entity_identity_providers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_identity_providers_layout_endpoint = _Endpoint( - settings={ - 'response_type': ([DeclarativeIdentityProvider],), - 'auth': [], - 'endpoint_path': '/api/v1/layout/identityProviders', - 'operation_id': 'get_identity_providers_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'patch_entity_identity_providers', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_identity_provider_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_identity_provider_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_identity_provider_patch_document': - (JsonApiIdentityProviderPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_identity_provider_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.set_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/identityProviders', - 'operation_id': 'set_identity_providers', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_identity_provider', - ], - 'required': [ - 'declarative_identity_provider', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_identity_provider': - ([DeclarativeIdentityProvider],), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_identity_provider': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.update_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'update_entity_identity_providers', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_identity_provider_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_identity_provider_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_identity_provider_in_document': - (JsonApiIdentityProviderInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_identity_provider_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_identity_providers( + self, + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Post Identity Providers + + + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_identity_providers_serialize( + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_identity_providers_with_http_info( + self, + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Post Identity Providers + + + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_identity_providers_serialize( + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_identity_providers_without_preload_content( + self, + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Identity Providers + + + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_identity_providers_serialize( + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_identity_providers_serialize( self, json_api_identity_provider_in_document, - **kwargs - ): - """Post Identity Providers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_identity_providers(json_api_identity_provider_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_identity_provider_in_document'] = \ - json_api_identity_provider_in_document - return self.create_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_identity_provider_in_document is not None: + _body_params = json_api_identity_provider_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/identityProviders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_identity_providers_serialize( self, id, - **kwargs - ): - """Delete Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_identity_providers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_identity_providers( self, - **kwargs - ): - """Get all Identity Providers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_identity_providers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_identity_providers_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutList: + """Get all Identity Providers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_identity_providers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_identity_providers_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutList]: + """Get all Identity Providers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_identity_providers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_identity_providers_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Identity Providers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_identity_providers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_identity_providers_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/identityProviders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Get Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Get Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_identity_providers_serialize( self, id, - **kwargs - ): - """Get Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_identity_providers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_identity_providers_layout( self, - **kwargs - ): - """Get all identity providers layout # noqa: E501 - - Gets complete layout of identity providers. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_identity_providers_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [DeclarativeIdentityProvider] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_identity_providers_layout_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DeclarativeIdentityProvider]: + """Get all identity providers layout + + Gets complete layout of identity providers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_identity_providers_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeIdentityProvider]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_identity_providers_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DeclarativeIdentityProvider]]: + """Get all identity providers layout + + Gets complete layout of identity providers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_identity_providers_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeIdentityProvider]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_identity_providers_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all identity providers layout + + Gets complete layout of identity providers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_identity_providers_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeIdentityProvider]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_identity_providers_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/identityProviders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def patch_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Patch Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_patch_document: (required) + :type json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_patch_document=json_api_identity_provider_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Patch Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_patch_document: (required) + :type json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_patch_document=json_api_identity_provider_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_patch_document: (required) + :type json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_patch_document=json_api_identity_provider_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_identity_providers_serialize( self, id, json_api_identity_provider_patch_document, - **kwargs - ): - """Patch Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_identity_provider_patch_document (JsonApiIdentityProviderPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_identity_provider_patch_document'] = \ - json_api_identity_provider_patch_document - return self.patch_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_identity_provider_patch_document is not None: + _body_params = json_api_identity_provider_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_identity_providers( + self, + declarative_identity_provider: List[DeclarativeIdentityProvider], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set all identity providers + + Sets identity providers in organization. + + :param declarative_identity_provider: (required) + :type declarative_identity_provider: List[DeclarativeIdentityProvider] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_identity_providers_serialize( + declarative_identity_provider=declarative_identity_provider, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_identity_providers_with_http_info( + self, + declarative_identity_provider: List[DeclarativeIdentityProvider], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set all identity providers + + Sets identity providers in organization. + + :param declarative_identity_provider: (required) + :type declarative_identity_provider: List[DeclarativeIdentityProvider] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_identity_providers_serialize( + declarative_identity_provider=declarative_identity_provider, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_identity_providers_without_preload_content( + self, + declarative_identity_provider: List[DeclarativeIdentityProvider], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set all identity providers + + Sets identity providers in organization. + + :param declarative_identity_provider: (required) + :type declarative_identity_provider: List[DeclarativeIdentityProvider] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_identity_providers_serialize( + declarative_identity_provider=declarative_identity_provider, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_identity_providers_serialize( self, declarative_identity_provider, - **kwargs - ): - """Set all identity providers # noqa: E501 - - Sets identity providers in organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_identity_providers(declarative_identity_provider, async_req=True) - >>> result = thread.get() - - Args: - declarative_identity_provider ([DeclarativeIdentityProvider]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_identity_provider'] = \ - declarative_identity_provider - return self.set_identity_providers_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'DeclarativeIdentityProvider': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_identity_provider is not None: + _body_params = declarative_identity_provider + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/identityProviders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Put Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Put Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_identity_providers_serialize( self, id, json_api_identity_provider_in_document, - **kwargs - ): - """Put Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_identity_providers(id, json_api_identity_provider_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_identity_provider_in_document'] = \ - json_api_identity_provider_in_document - return self.update_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_identity_provider_in_document is not None: + _body_params = json_api_identity_provider_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/image_export_api.py b/gooddata-api-client/gooddata_api_client/api/image_export_api.py index bf670ba89..1eb517c03 100644 --- a/gooddata-api-client/gooddata_api_client/api/image_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/image_export_api.py @@ -1,468 +1,881 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner -from gooddata_api_client.model.image_export_request import ImageExportRequest +from pydantic import StrictBytes, StrictStr +from typing import Tuple, Union +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.image_export_request import ImageExportRequest +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class ImageExportApi(object): + +class ImageExportApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_image_export_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image', - 'operation_id': 'create_image_export', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'image_export_request', - ], - 'required': [ - 'workspace_id', - 'image_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'image_export_request': - (ImageExportRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'image_export_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.get_image_export_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}', - 'operation_id': 'get_image_export', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'image/png' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_image_export_metadata_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata', - 'operation_id': 'get_image_export_metadata', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def create_image_export( self, - workspace_id, - image_export_request, - **kwargs - ): - """(EXPERIMENTAL) Create image export request # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_image_export(workspace_id, image_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - image_export_request (ImageExportRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + image_export_request: ImageExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """(EXPERIMENTAL) Create image export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param image_export_request: (required) + :type image_export_request: ImageExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_image_export_serialize( + workspace_id=workspace_id, + image_export_request=image_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_image_export_with_http_info( + self, + workspace_id: StrictStr, + image_export_request: ImageExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """(EXPERIMENTAL) Create image export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param image_export_request: (required) + :type image_export_request: ImageExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_image_export_serialize( + workspace_id=workspace_id, + image_export_request=image_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def create_image_export_without_preload_content( + self, + workspace_id: StrictStr, + image_export_request: ImageExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Create image export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param image_export_request: (required) + :type image_export_request: ImageExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_image_export_serialize( + workspace_id=workspace_id, + image_export_request=image_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _create_image_export_serialize( + self, + workspace_id, + image_export_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if image_export_request is not None: + _body_params = image_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/image', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['image_export_request'] = \ - image_export_request - return self.create_image_export_endpoint.call_with_http_info(**kwargs) + + + + @validate_call def get_image_export( self, - workspace_id, - export_id, - **kwargs - ): - """(EXPERIMENTAL) Retrieve exported files # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_image_export(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - file_type - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_image_export_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_image_export_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_image_export_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_image_export_metadata( + + def _get_image_export_serialize( self, workspace_id, export_id, - **kwargs - ): - """(EXPERIMENTAL) Retrieve metadata context # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_image_export_metadata(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'image/png' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_image_export_metadata( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_image_export_metadata_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_image_export_metadata_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_image_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_image_export_metadata_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _get_image_export_metadata_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/invalidate_cache_api.py b/gooddata-api-client/gooddata_api_client/api/invalidate_cache_api.py index beed031e8..0b999fd02 100644 --- a/gooddata-api-client/gooddata_api_client/api/invalidate_cache_api.py +++ b/gooddata-api-client/gooddata_api_client/api/invalidate_cache_api.py @@ -1,168 +1,290 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) +from pydantic import StrictStr +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class InvalidateCacheApi(object): + +class InvalidateCacheApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.register_upload_notification_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/uploadNotification', - 'operation_id': 'register_upload_notification', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - ], - 'required': [ - 'data_source_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def register_upload_notification( self, - data_source_id, - **kwargs - ): - """Register an upload notification # noqa: E501 - - Notification sets up all reports to be computed again with new data. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.register_upload_notification(data_source_id, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Register an upload notification + + Notification sets up all reports to be computed again with new data. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._register_upload_notification_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def register_upload_notification_with_http_info( + self, + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Register an upload notification + + Notification sets up all reports to be computed again with new data. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._register_upload_notification_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def register_upload_notification_without_preload_content( + self, + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Register an upload notification + + Notification sets up all reports to be computed again with new data. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._register_upload_notification_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _register_upload_notification_serialize( + self, + data_source_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/uploadNotification', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - return self.register_upload_notification_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/jwks_api.py b/gooddata-api-client/gooddata_api_client/api/jwks_api.py index 3ff22db27..afd965a45 100644 --- a/gooddata-api-client/gooddata_api_client/api/jwks_api.py +++ b/gooddata-api-client/gooddata_api_client/api/jwks_api.py @@ -1,938 +1,1805 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument -from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList -from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.models.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class JWKSApi(object): + +class JWKSApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks', - 'operation_id': 'create_entity_jwks', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_jwk_in_document', - ], - 'required': [ - 'json_api_jwk_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_jwk_in_document': - (JsonApiJwkInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_jwk_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'delete_entity_jwks', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks', - 'operation_id': 'get_all_entities_jwks', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'get_entity_jwks', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'patch_entity_jwks', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_jwk_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_jwk_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_jwk_patch_document': - (JsonApiJwkPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_jwk_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'update_entity_jwks', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_jwk_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_jwk_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_jwk_in_document': - (JsonApiJwkInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_jwk_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_jwks( + self, + json_api_jwk_in_document: JsonApiJwkInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Post Jwks + + Creates JSON web key - used to verify JSON web tokens (Jwts) + + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_jwks_serialize( + json_api_jwk_in_document=json_api_jwk_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_jwks_with_http_info( + self, + json_api_jwk_in_document: JsonApiJwkInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Post Jwks + + Creates JSON web key - used to verify JSON web tokens (Jwts) + + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_jwks_serialize( + json_api_jwk_in_document=json_api_jwk_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_jwks_without_preload_content( + self, + json_api_jwk_in_document: JsonApiJwkInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Jwks + + Creates JSON web key - used to verify JSON web tokens (Jwts) + + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_jwks_serialize( + json_api_jwk_in_document=json_api_jwk_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_jwks_serialize( self, json_api_jwk_in_document, - **kwargs - ): - """Post Jwks # noqa: E501 - - Creates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_jwks(json_api_jwk_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_jwk_in_document (JsonApiJwkInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.create_entity_jwks_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_jwk_in_document is not None: + _body_params = json_api_jwk_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/jwks', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Jwk + + Deletes JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Jwk + + Deletes JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Jwk + + Deletes JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_jwks_serialize( self, id, - **kwargs - ): - """Delete Jwk # noqa: E501 - - Deletes JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_jwks(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_jwks_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_jwks( self, - **kwargs - ): - """Get all Jwks # noqa: E501 - - Returns all JSON web keys - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_jwks(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_jwks_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutList: + """Get all Jwks + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_jwks_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_jwks_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutList]: + """Get all Jwks + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_jwks_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_jwks_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Jwks + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_jwks_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_jwks_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/jwks', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Get Jwk + + Returns JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Get Jwk + + Returns JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Jwk + + Returns JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_jwks_serialize( self, id, - **kwargs - ): - """Get Jwk # noqa: E501 - - Returns JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_jwks(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_jwks_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def patch_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_patch_document: JsonApiJwkPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Patch Jwk + + Patches JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_patch_document: (required) + :type json_api_jwk_patch_document: JsonApiJwkPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_jwks_serialize( + id=id, + json_api_jwk_patch_document=json_api_jwk_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_patch_document: JsonApiJwkPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Patch Jwk + + Patches JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_patch_document: (required) + :type json_api_jwk_patch_document: JsonApiJwkPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_jwks_serialize( + id=id, + json_api_jwk_patch_document=json_api_jwk_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_patch_document: JsonApiJwkPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Jwk + + Patches JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_patch_document: (required) + :type json_api_jwk_patch_document: JsonApiJwkPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_jwks_serialize( + id=id, + json_api_jwk_patch_document=json_api_jwk_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_jwks_serialize( self, id, json_api_jwk_patch_document, - **kwargs - ): - """Patch Jwk # noqa: E501 - - Patches JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_jwks(id, json_api_jwk_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_jwk_patch_document (JsonApiJwkPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_jwk_patch_document'] = \ - json_api_jwk_patch_document - return self.patch_entity_jwks_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_jwk_patch_document is not None: + _body_params = json_api_jwk_patch_document + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_in_document: JsonApiJwkInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Put Jwk + + Updates JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_jwks_serialize( + id=id, + json_api_jwk_in_document=json_api_jwk_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_in_document: JsonApiJwkInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Put Jwk + + Updates JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_jwks_serialize( + id=id, + json_api_jwk_in_document=json_api_jwk_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_in_document: JsonApiJwkInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Jwk + + Updates JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_jwks_serialize( + id=id, + json_api_jwk_in_document=json_api_jwk_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_jwks_serialize( self, id, json_api_jwk_in_document, - **kwargs - ): - """Put Jwk # noqa: E501 - - Updates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_jwks(id, json_api_jwk_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_jwk_in_document (JsonApiJwkInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.update_entity_jwks_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_jwk_in_document is not None: + _body_params = json_api_jwk_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/labels_api.py b/gooddata-api-client/gooddata_api_client/api/labels_api.py index dfd65712f..2d820b3bd 100644 --- a/gooddata-api-client/gooddata_api_client/api/labels_api.py +++ b/gooddata-api-client/gooddata_api_client/api/labels_api.py @@ -1,433 +1,775 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class LabelsApi(object): +class LabelsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_all_entities_labels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLabelOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels', - 'operation_id': 'get_all_entities_labels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "ATTRIBUTE": "attribute", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_labels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLabelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}', - 'operation_id': 'get_entity_labels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "ATTRIBUTE": "attribute", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def get_all_entities_labels( self, - workspace_id, - **kwargs - ): - """Get all Labels # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_labels(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLabelOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLabelOutList: + """Get all Labels + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_labels_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_labels_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLabelOutList]: + """Get all Labels + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_labels_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_all_entities_labels_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Labels + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_labels_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_labels_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_labels( + + def _get_all_entities_labels_serialize( self, workspace_id, - object_id, - **kwargs - ): - """Get a Label # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_labels(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLabelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/labels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_entity_labels( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLabelOutDocument: + """Get a Label + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_labels_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_labels_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLabelOutDocument]: + """Get a Label + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_labels_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_entity_labels_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Label + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_labels_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_labels_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _get_entity_labels_serialize( + self, + workspace_id, + object_id, + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/layout_api.py b/gooddata-api-client/gooddata_api_client/api/layout_api.py index 0771997a4..0a4452dd6 100644 --- a/gooddata-api-client/gooddata_api_client/api/layout_api.py +++ b/gooddata-api-client/gooddata_api_client/api/layout_api.py @@ -1,5628 +1,11219 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics -from gooddata_api_client.model.declarative_automation import DeclarativeAutomation -from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources -from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates -from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView -from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider -from gooddata_api_client.model.declarative_model import DeclarativeModel -from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization -from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions -from gooddata_api_client.model.declarative_users import DeclarativeUsers -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces - - -class LayoutApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import StrictBool, StrictStr, field_validator +from typing import List, Optional +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_automation import DeclarativeAutomation +from gooddata_api_client.models.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.models.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.models.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class LayoutApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_analytics_model_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeAnalytics,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/analyticsModel', - 'operation_id': 'get_analytics_model', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'exclude', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'exclude': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'exclude': 'exclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_automations_endpoint = _Endpoint( - settings={ - 'response_type': ([DeclarativeAutomation],), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/automations', - 'operation_id': 'get_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'exclude', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'exclude': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'exclude': 'exclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_data_source_permissions_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeDataSourcePermissions,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/dataSources/{dataSourceId}/permissions', - 'operation_id': 'get_data_source_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - ], - 'required': [ - 'data_source_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_data_sources_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeDataSources,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/dataSources', - 'operation_id': 'get_data_sources_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_export_templates_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeExportTemplates,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/exportTemplates', - 'operation_id': 'get_export_templates_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': ([DeclarativeFilterView],), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/filterViews', - 'operation_id': 'get_filter_views', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'exclude', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'exclude': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'exclude': 'exclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_identity_providers_layout_endpoint = _Endpoint( - settings={ - 'response_type': ([DeclarativeIdentityProvider],), - 'auth': [], - 'endpoint_path': '/api/v1/layout/identityProviders', - 'operation_id': 'get_identity_providers_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_logical_model_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeModel,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/logicalModel', - 'operation_id': 'get_logical_model', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'include_parents', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'include_parents': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include_parents': 'includeParents', - }, - 'location_map': { - 'workspace_id': 'path', - 'include_parents': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_notification_channels_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeNotificationChannels,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/notificationChannels', - 'operation_id': 'get_notification_channels_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_organization_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeOrganization,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/organization', - 'operation_id': 'get_organization_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'exclude', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'exclude': - ([str],), - }, - 'attribute_map': { - 'exclude': 'exclude', - }, - 'location_map': { - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_organization_permissions_endpoint = _Endpoint( - settings={ - 'response_type': ([DeclarativeOrganizationPermission],), - 'auth': [], - 'endpoint_path': '/api/v1/layout/organization/permissions', - 'operation_id': 'get_organization_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUserDataFilters,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'get_user_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_user_group_permissions_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUserGroupPermissions,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/userGroups/{userGroupId}/permissions', - 'operation_id': 'get_user_group_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_group_id', - ], - 'required': [ - 'user_group_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_group_id': - (str,), - }, - 'attribute_map': { - 'user_group_id': 'userGroupId', - }, - 'location_map': { - 'user_group_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_user_groups_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUserGroups,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/userGroups', - 'operation_id': 'get_user_groups_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_user_permissions_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUserPermissions,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/users/{userId}/permissions', - 'operation_id': 'get_user_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - ], - 'required': [ - 'user_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_users_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUsers,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/users', - 'operation_id': 'get_users_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_users_user_groups_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUsersUserGroups,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/usersAndUserGroups', - 'operation_id': 'get_users_user_groups_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_workspace_data_filters_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeWorkspaceDataFilters,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaceDataFilters', - 'operation_id': 'get_workspace_data_filters_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_workspace_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeWorkspaceModel,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}', - 'operation_id': 'get_workspace_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'exclude', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'exclude': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'exclude': 'exclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_workspace_permissions_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeWorkspacePermissions,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/permissions', - 'operation_id': 'get_workspace_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_workspaces_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeWorkspaces,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces', - 'operation_id': 'get_workspaces_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'exclude', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'exclude': - ([str],), - }, - 'attribute_map': { - 'exclude': 'exclude', - }, - 'location_map': { - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.put_data_sources_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/dataSources', - 'operation_id': 'put_data_sources_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_data_sources', - ], - 'required': [ - 'declarative_data_sources', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_data_sources': - (DeclarativeDataSources,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_data_sources': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.put_user_groups_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/userGroups', - 'operation_id': 'put_user_groups_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_user_groups', - ], - 'required': [ - 'declarative_user_groups', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_user_groups': - (DeclarativeUserGroups,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_user_groups': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.put_users_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/users', - 'operation_id': 'put_users_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_users', - ], - 'required': [ - 'declarative_users', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_users': - (DeclarativeUsers,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_users': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.put_users_user_groups_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/usersAndUserGroups', - 'operation_id': 'put_users_user_groups_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_users_user_groups', - ], - 'required': [ - 'declarative_users_user_groups', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_users_user_groups': - (DeclarativeUsersUserGroups,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_users_user_groups': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.put_workspace_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}', - 'operation_id': 'put_workspace_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_workspace_model', - ], - 'required': [ - 'workspace_id', - 'declarative_workspace_model', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_workspace_model': - (DeclarativeWorkspaceModel,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_workspace_model': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_analytics_model_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/analyticsModel', - 'operation_id': 'set_analytics_model', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_analytics', - ], - 'required': [ - 'workspace_id', - 'declarative_analytics', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_analytics': - (DeclarativeAnalytics,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_analytics': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/automations', - 'operation_id': 'set_automations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_automation', - ], - 'required': [ - 'workspace_id', - 'declarative_automation', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_automation': - ([DeclarativeAutomation],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_automation': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_data_source_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/dataSources/{dataSourceId}/permissions', - 'operation_id': 'set_data_source_permissions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'declarative_data_source_permissions', - ], - 'required': [ - 'data_source_id', - 'declarative_data_source_permissions', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'declarative_data_source_permissions': - (DeclarativeDataSourcePermissions,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'declarative_data_source_permissions': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/exportTemplates', - 'operation_id': 'set_export_templates', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_export_templates', - ], - 'required': [ - 'declarative_export_templates', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_export_templates': - (DeclarativeExportTemplates,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_export_templates': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/filterViews', - 'operation_id': 'set_filter_views', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_filter_view', - ], - 'required': [ - 'workspace_id', - 'declarative_filter_view', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_filter_view': - ([DeclarativeFilterView],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_filter_view': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/identityProviders', - 'operation_id': 'set_identity_providers', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_identity_provider', - ], - 'required': [ - 'declarative_identity_provider', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_identity_provider': - ([DeclarativeIdentityProvider],), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_identity_provider': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_logical_model_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/logicalModel', - 'operation_id': 'set_logical_model', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_model', - ], - 'required': [ - 'workspace_id', - 'declarative_model', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_model': - (DeclarativeModel,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_model': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/notificationChannels', - 'operation_id': 'set_notification_channels', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_notification_channels', - ], - 'required': [ - 'declarative_notification_channels', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_notification_channels': - (DeclarativeNotificationChannels,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_notification_channels': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_organization_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/organization', - 'operation_id': 'set_organization_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_organization', - ], - 'required': [ - 'declarative_organization', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_organization': - (DeclarativeOrganization,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_organization': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_organization_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/organization/permissions', - 'operation_id': 'set_organization_permissions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_organization_permission', - ], - 'required': [ - 'declarative_organization_permission', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_organization_permission': - ([DeclarativeOrganizationPermission],), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_organization_permission': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'set_user_data_filters', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_user_data_filters', - ], - 'required': [ - 'workspace_id', - 'declarative_user_data_filters', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_user_data_filters': - (DeclarativeUserDataFilters,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_user_data_filters': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_user_group_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/userGroups/{userGroupId}/permissions', - 'operation_id': 'set_user_group_permissions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_group_id', - 'declarative_user_group_permissions', - ], - 'required': [ - 'user_group_id', - 'declarative_user_group_permissions', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_group_id': - (str,), - 'declarative_user_group_permissions': - (DeclarativeUserGroupPermissions,), - }, - 'attribute_map': { - 'user_group_id': 'userGroupId', - }, - 'location_map': { - 'user_group_id': 'path', - 'declarative_user_group_permissions': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_user_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/users/{userId}/permissions', - 'operation_id': 'set_user_permissions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'declarative_user_permissions', - ], - 'required': [ - 'user_id', - 'declarative_user_permissions', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'declarative_user_permissions': - (DeclarativeUserPermissions,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - 'declarative_user_permissions': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_workspace_data_filters_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaceDataFilters', - 'operation_id': 'set_workspace_data_filters_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_workspace_data_filters', - ], - 'required': [ - 'declarative_workspace_data_filters', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_workspace_data_filters': - (DeclarativeWorkspaceDataFilters,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_workspace_data_filters': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_workspace_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/permissions', - 'operation_id': 'set_workspace_permissions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_workspace_permissions', - ], - 'required': [ - 'workspace_id', - 'declarative_workspace_permissions', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_workspace_permissions': - (DeclarativeWorkspacePermissions,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_workspace_permissions': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_workspaces_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces', - 'operation_id': 'set_workspaces_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_workspaces', - ], - 'required': [ - 'declarative_workspaces', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_workspaces': - (DeclarativeWorkspaces,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_workspaces': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def get_analytics_model( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeAnalytics: + """Get analytics model + + Retrieve current analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytics_model_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeAnalytics", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_analytics_model_with_http_info( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeAnalytics]: + """Get analytics model + + Retrieve current analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytics_model_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeAnalytics", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_analytics_model_without_preload_content( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get analytics model + + Retrieve current analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytics_model_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeAnalytics", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_analytics_model_serialize( self, workspace_id, - **kwargs - ): - """Get analytics model # noqa: E501 - - Retrieve current analytics model of the workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_analytics_model(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeAnalytics - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_analytics_model_endpoint.call_with_http_info(**kwargs) + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/analyticsModel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_automations( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DeclarativeAutomation]: + """Get automations + + Retrieve automations for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_automations_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeAutomation]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_automations_with_http_info( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DeclarativeAutomation]]: + """Get automations + + Retrieve automations for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_automations_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeAutomation]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_automations_without_preload_content( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get automations + + Retrieve automations for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_automations_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeAutomation]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_automations_serialize( self, workspace_id, - **kwargs - ): - """Get automations # noqa: E501 - - Retrieve automations for the specific workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_automations(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [DeclarativeAutomation] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_automations_endpoint.call_with_http_info(**kwargs) + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/automations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_data_source_permissions( + self, + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeDataSourcePermissions: + """Get permissions for the data source + + Retrieve current set of permissions of the data source in a declarative form. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_permissions_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSourcePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_source_permissions_with_http_info( + self, + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeDataSourcePermissions]: + """Get permissions for the data source + + Retrieve current set of permissions of the data source in a declarative form. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_permissions_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSourcePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_data_source_permissions_without_preload_content( + self, + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get permissions for the data source + + Retrieve current set of permissions of the data source in a declarative form. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_permissions_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSourcePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_data_source_permissions_serialize( self, data_source_id, - **kwargs - ): - """Get permissions for the data source # noqa: E501 - - Retrieve current set of permissions of the data source in a declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_data_source_permissions(data_source_id, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeDataSourcePermissions - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - return self.get_data_source_permissions_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/dataSources/{dataSourceId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_data_sources_layout( self, - **kwargs - ): - """Get all data sources # noqa: E501 - - Retrieve all data sources including related physical model. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_data_sources_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeDataSources - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_data_sources_layout_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeDataSources: + """Get all data sources + + Retrieve all data sources including related physical model. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_sources_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSources", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_sources_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeDataSources]: + """Get all data sources + + Retrieve all data sources including related physical model. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_sources_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSources", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_data_sources_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all data sources + + Retrieve all data sources including related physical model. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_sources_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSources", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_data_sources_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/dataSources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_export_templates_layout( self, - **kwargs - ): - """Get all export templates layout # noqa: E501 - - Gets complete layout of export templates. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_export_templates_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeExportTemplates - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_export_templates_layout_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeExportTemplates: + """Get all export templates layout + + Gets complete layout of export templates. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_templates_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeExportTemplates", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_export_templates_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeExportTemplates]: + """Get all export templates layout + + Gets complete layout of export templates. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_templates_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeExportTemplates", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_export_templates_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all export templates layout + + Gets complete layout of export templates. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_templates_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeExportTemplates", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_export_templates_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/exportTemplates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_filter_views( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DeclarativeFilterView]: + """Get filter views + + Retrieve filter views for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_filter_views_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeFilterView]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_filter_views_with_http_info( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DeclarativeFilterView]]: + """Get filter views + + Retrieve filter views for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_filter_views_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeFilterView]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get filter views + + Retrieve filter views for the specific workspace + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_filter_views_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeFilterView]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_filter_views_serialize( self, workspace_id, - **kwargs - ): - """Get filter views # noqa: E501 - - Retrieve filter views for the specific workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_filter_views(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [DeclarativeFilterView] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_filter_views_endpoint.call_with_http_info(**kwargs) + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/filterViews', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_identity_providers_layout( self, - **kwargs - ): - """Get all identity providers layout # noqa: E501 - - Gets complete layout of identity providers. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_identity_providers_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [DeclarativeIdentityProvider] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_identity_providers_layout_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DeclarativeIdentityProvider]: + """Get all identity providers layout + + Gets complete layout of identity providers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_identity_providers_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeIdentityProvider]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_identity_providers_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DeclarativeIdentityProvider]]: + """Get all identity providers layout + + Gets complete layout of identity providers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_identity_providers_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeIdentityProvider]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_identity_providers_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all identity providers layout + + Gets complete layout of identity providers. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_identity_providers_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeIdentityProvider]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_identity_providers_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/identityProviders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_logical_model( + self, + workspace_id: StrictStr, + include_parents: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeModel: + """Get logical model + + Retrieve current logical model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param include_parents: + :type include_parents: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_logical_model_serialize( + workspace_id=workspace_id, + include_parents=include_parents, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_logical_model_with_http_info( + self, + workspace_id: StrictStr, + include_parents: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeModel]: + """Get logical model + + Retrieve current logical model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param include_parents: + :type include_parents: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_logical_model_serialize( + workspace_id=workspace_id, + include_parents=include_parents, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_logical_model_without_preload_content( + self, + workspace_id: StrictStr, + include_parents: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get logical model + + Retrieve current logical model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param include_parents: + :type include_parents: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_logical_model_serialize( + workspace_id=workspace_id, + include_parents=include_parents, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_logical_model_serialize( self, workspace_id, - **kwargs - ): - """Get logical model # noqa: E501 - - Retrieve current logical model of the workspace in declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_logical_model(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - include_parents (bool): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeModel - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_logical_model_endpoint.call_with_http_info(**kwargs) + include_parents, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include_parents is not None: + + _query_params.append(('includeParents', include_parents)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/logicalModel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_notification_channels_layout( self, - **kwargs - ): - """Get all notification channels layout # noqa: E501 - - Gets complete layout of notification channels. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_notification_channels_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeNotificationChannels - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_notification_channels_layout_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeNotificationChannels: + """Get all notification channels layout + + Gets complete layout of notification channels. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notification_channels_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeNotificationChannels", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_notification_channels_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeNotificationChannels]: + """Get all notification channels layout + + Gets complete layout of notification channels. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notification_channels_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeNotificationChannels", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_notification_channels_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all notification channels layout + + Gets complete layout of notification channels. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notification_channels_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeNotificationChannels", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_notification_channels_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/notificationChannels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_organization_layout( self, - **kwargs - ): - """Get organization layout # noqa: E501 - - Retrieve complete layout of organization, workspaces, user-groups, etc. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_organization_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeOrganization - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_organization_layout_endpoint.call_with_http_info(**kwargs) + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeOrganization: + """Get organization layout + + Retrieve complete layout of organization, workspaces, user-groups, etc. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeOrganization", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_organization_layout_with_http_info( + self, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeOrganization]: + """Get organization layout + + Retrieve complete layout of organization, workspaces, user-groups, etc. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeOrganization", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_organization_layout_without_preload_content( + self, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get organization layout + + Retrieve complete layout of organization, workspaces, user-groups, etc. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeOrganization", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_organization_layout_serialize( + self, + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/organization', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_organization_permissions( self, - **kwargs - ): - """Get organization permissions # noqa: E501 - - Retrieve organization permissions # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_organization_permissions(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [DeclarativeOrganizationPermission] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_organization_permissions_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DeclarativeOrganizationPermission]: + """Get organization permissions + + Retrieve organization permissions + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_permissions_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeOrganizationPermission]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_organization_permissions_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DeclarativeOrganizationPermission]]: + """Get organization permissions + + Retrieve organization permissions + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_permissions_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeOrganizationPermission]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_organization_permissions_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get organization permissions + + Retrieve organization permissions + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_permissions_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeOrganizationPermission]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_organization_permissions_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/organization/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_user_data_filters( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUserDataFilters: + """Get user data filters + + Retrieve current user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_data_filters_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUserDataFilters]: + """Get user data filters + + Retrieve current user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_data_filters_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get user data filters + + Retrieve current user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_data_filters_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_data_filters_serialize( self, workspace_id, - **kwargs - ): - """Get user data filters # noqa: E501 - - Retrieve current user data filters assigned to the workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_user_data_filters(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUserDataFilters - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_user_data_filters_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/userDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_user_group_permissions( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUserGroupPermissions: + """Get permissions for the user-group + + Retrieve current set of permissions of the user-group in a declarative form. + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_permissions_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroupPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_group_permissions_with_http_info( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUserGroupPermissions]: + """Get permissions for the user-group + + Retrieve current set of permissions of the user-group in a declarative form. + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_permissions_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroupPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_group_permissions_without_preload_content( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get permissions for the user-group + + Retrieve current set of permissions of the user-group in a declarative form. + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_permissions_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroupPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_group_permissions_serialize( self, user_group_id, - **kwargs - ): - """Get permissions for the user-group # noqa: E501 - - Retrieve current set of permissions of the user-group in a declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_user_group_permissions(user_group_id, async_req=True) - >>> result = thread.get() - - Args: - user_group_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUserGroupPermissions - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_group_id'] = \ - user_group_id - return self.get_user_group_permissions_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/userGroups/{userGroupId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_user_groups_layout( self, - **kwargs - ): - """Get all user groups # noqa: E501 - - Retrieve all user-groups eventually with parent group. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_user_groups_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUserGroups - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_user_groups_layout_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUserGroups: + """Get all user groups + + Retrieve all user-groups eventually with parent group. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_groups_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUserGroups]: + """Get all user groups + + Retrieve all user-groups eventually with parent group. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_groups_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all user groups + + Retrieve all user-groups eventually with parent group. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_groups_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_user_permissions( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUserPermissions: + """Get permissions for the user + + Retrieve current set of permissions of the user in a declarative form. + + :param user_id: (required) + :type user_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_permissions_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_permissions_with_http_info( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUserPermissions]: + """Get permissions for the user + + Retrieve current set of permissions of the user in a declarative form. + + :param user_id: (required) + :type user_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_permissions_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_permissions_without_preload_content( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get permissions for the user + + Retrieve current set of permissions of the user in a declarative form. + + :param user_id: (required) + :type user_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_permissions_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_permissions_serialize( self, user_id, - **kwargs - ): - """Get permissions for the user # noqa: E501 - - Retrieve current set of permissions of the user in a declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_user_permissions(user_id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUserPermissions - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_user_permissions_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/users/{userId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_users_layout( self, - **kwargs - ): - """Get all users # noqa: E501 - - Retrieve all users including authentication properties. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_users_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUsers - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_users_layout_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUsers: + """Get all users + + Retrieve all users including authentication properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_users_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUsers]: + """Get all users + + Retrieve all users including authentication properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_users_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all users + + Retrieve all users including authentication properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_users_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_users_user_groups_layout( self, - **kwargs - ): - """Get all users and user groups # noqa: E501 - - Retrieve all users and user groups with theirs properties. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_users_user_groups_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUsersUserGroups - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_users_user_groups_layout_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUsersUserGroups: + """Get all users and user groups + + Retrieve all users and user groups with theirs properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsersUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_users_user_groups_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUsersUserGroups]: + """Get all users and user groups + + Retrieve all users and user groups with theirs properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsersUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_users_user_groups_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all users and user groups + + Retrieve all users and user groups with theirs properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsersUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_users_user_groups_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/usersAndUserGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_workspace_data_filters_layout( self, - **kwargs - ): - """Get workspace data filters for all workspaces # noqa: E501 - - Retrieve all workspaces and related workspace data filters (and their settings / values). # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_workspace_data_filters_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeWorkspaceDataFilters - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_workspace_data_filters_layout_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeWorkspaceDataFilters: + """Get workspace data filters for all workspaces + + Retrieve all workspaces and related workspace data filters (and their settings / values). + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_data_filters_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_workspace_data_filters_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeWorkspaceDataFilters]: + """Get workspace data filters for all workspaces + + Retrieve all workspaces and related workspace data filters (and their settings / values). + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_data_filters_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_workspace_data_filters_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get workspace data filters for all workspaces + + Retrieve all workspaces and related workspace data filters (and their settings / values). + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_data_filters_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_workspace_data_filters_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaceDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_workspace_layout( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeWorkspaceModel: + """Get workspace layout + + Retrieve current model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_layout_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_workspace_layout_with_http_info( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeWorkspaceModel]: + """Get workspace layout + + Retrieve current model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_layout_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_workspace_layout_without_preload_content( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get workspace layout + + Retrieve current model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_layout_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_workspace_layout_serialize( self, workspace_id, - **kwargs - ): - """Get workspace layout # noqa: E501 - - Retrieve current model of the workspace in declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_workspace_layout(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeWorkspaceModel - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_workspace_layout_endpoint.call_with_http_info(**kwargs) + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_workspace_permissions( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeWorkspacePermissions: + """Get permissions for the workspace + + Retrieve current set of permissions of the workspace in a declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_permissions_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspacePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_workspace_permissions_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeWorkspacePermissions]: + """Get permissions for the workspace + + Retrieve current set of permissions of the workspace in a declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_permissions_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspacePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_workspace_permissions_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get permissions for the workspace + + Retrieve current set of permissions of the workspace in a declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_permissions_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspacePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_workspace_permissions_serialize( self, workspace_id, - **kwargs - ): - """Get permissions for the workspace # noqa: E501 - - Retrieve current set of permissions of the workspace in a declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_workspace_permissions(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeWorkspacePermissions - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_workspace_permissions_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_workspaces_layout( self, - **kwargs - ): - """Get all workspaces layout # noqa: E501 - - Gets complete layout of workspaces, their hierarchy, models. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_workspaces_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeWorkspaces - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_workspaces_layout_endpoint.call_with_http_info(**kwargs) + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeWorkspaces: + """Get all workspaces layout + + Gets complete layout of workspaces, their hierarchy, models. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspaces_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaces", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_workspaces_layout_with_http_info( + self, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeWorkspaces]: + """Get all workspaces layout + + Gets complete layout of workspaces, their hierarchy, models. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspaces_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaces", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_workspaces_layout_without_preload_content( + self, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all workspaces layout + + Gets complete layout of workspaces, their hierarchy, models. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspaces_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaces", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_workspaces_layout_serialize( + self, + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def put_data_sources_layout( + self, + declarative_data_sources: DeclarativeDataSources, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Put all data sources + + Set all data sources including related physical model. + + :param declarative_data_sources: (required) + :type declarative_data_sources: DeclarativeDataSources + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_data_sources_layout_serialize( + declarative_data_sources=declarative_data_sources, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_data_sources_layout_with_http_info( + self, + declarative_data_sources: DeclarativeDataSources, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Put all data sources + + Set all data sources including related physical model. + + :param declarative_data_sources: (required) + :type declarative_data_sources: DeclarativeDataSources + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_data_sources_layout_serialize( + declarative_data_sources=declarative_data_sources, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_data_sources_layout_without_preload_content( + self, + declarative_data_sources: DeclarativeDataSources, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put all data sources + + Set all data sources including related physical model. + + :param declarative_data_sources: (required) + :type declarative_data_sources: DeclarativeDataSources + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_data_sources_layout_serialize( + declarative_data_sources=declarative_data_sources, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_data_sources_layout_serialize( self, declarative_data_sources, - **kwargs - ): - """Put all data sources # noqa: E501 - - Set all data sources including related physical model. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_data_sources_layout(declarative_data_sources, async_req=True) - >>> result = thread.get() - - Args: - declarative_data_sources (DeclarativeDataSources): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_data_sources'] = \ - declarative_data_sources - return self.put_data_sources_layout_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_data_sources is not None: + _body_params = declarative_data_sources + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/dataSources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def put_user_groups_layout( + self, + declarative_user_groups: DeclarativeUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Put all user groups + + Define all user groups with their parents eventually. + + :param declarative_user_groups: (required) + :type declarative_user_groups: DeclarativeUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_user_groups_layout_serialize( + declarative_user_groups=declarative_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_user_groups_layout_with_http_info( + self, + declarative_user_groups: DeclarativeUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Put all user groups + + Define all user groups with their parents eventually. + + :param declarative_user_groups: (required) + :type declarative_user_groups: DeclarativeUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_user_groups_layout_serialize( + declarative_user_groups=declarative_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_user_groups_layout_without_preload_content( + self, + declarative_user_groups: DeclarativeUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put all user groups + + Define all user groups with their parents eventually. + + :param declarative_user_groups: (required) + :type declarative_user_groups: DeclarativeUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_user_groups_layout_serialize( + declarative_user_groups=declarative_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_user_groups_layout_serialize( self, declarative_user_groups, - **kwargs - ): - """Put all user groups # noqa: E501 - - Define all user groups with their parents eventually. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_user_groups_layout(declarative_user_groups, async_req=True) - >>> result = thread.get() - - Args: - declarative_user_groups (DeclarativeUserGroups): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_user_groups'] = \ - declarative_user_groups - return self.put_user_groups_layout_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_user_groups is not None: + _body_params = declarative_user_groups + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def put_users_layout( + self, + declarative_users: DeclarativeUsers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Put all users + + Set all users and their authentication properties. + + :param declarative_users: (required) + :type declarative_users: DeclarativeUsers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_layout_serialize( + declarative_users=declarative_users, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_users_layout_with_http_info( + self, + declarative_users: DeclarativeUsers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Put all users + + Set all users and their authentication properties. + + :param declarative_users: (required) + :type declarative_users: DeclarativeUsers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_layout_serialize( + declarative_users=declarative_users, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_users_layout_without_preload_content( + self, + declarative_users: DeclarativeUsers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put all users + + Set all users and their authentication properties. + + :param declarative_users: (required) + :type declarative_users: DeclarativeUsers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_layout_serialize( + declarative_users=declarative_users, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_users_layout_serialize( self, declarative_users, - **kwargs - ): - """Put all users # noqa: E501 - - Set all users and their authentication properties. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_users_layout(declarative_users, async_req=True) - >>> result = thread.get() - - Args: - declarative_users (DeclarativeUsers): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_users'] = \ - declarative_users - return self.put_users_layout_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_users is not None: + _body_params = declarative_users + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def put_users_user_groups_layout( + self, + declarative_users_user_groups: DeclarativeUsersUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Put all users and user groups + + Define all users and user groups with theirs properties. + + :param declarative_users_user_groups: (required) + :type declarative_users_user_groups: DeclarativeUsersUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_user_groups_layout_serialize( + declarative_users_user_groups=declarative_users_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_users_user_groups_layout_with_http_info( + self, + declarative_users_user_groups: DeclarativeUsersUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Put all users and user groups + + Define all users and user groups with theirs properties. + + :param declarative_users_user_groups: (required) + :type declarative_users_user_groups: DeclarativeUsersUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_user_groups_layout_serialize( + declarative_users_user_groups=declarative_users_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_users_user_groups_layout_without_preload_content( + self, + declarative_users_user_groups: DeclarativeUsersUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put all users and user groups + + Define all users and user groups with theirs properties. + + :param declarative_users_user_groups: (required) + :type declarative_users_user_groups: DeclarativeUsersUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_user_groups_layout_serialize( + declarative_users_user_groups=declarative_users_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_users_user_groups_layout_serialize( self, declarative_users_user_groups, - **kwargs - ): - """Put all users and user groups # noqa: E501 - - Define all users and user groups with theirs properties. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_users_user_groups_layout(declarative_users_user_groups, async_req=True) - >>> result = thread.get() - - Args: - declarative_users_user_groups (DeclarativeUsersUserGroups): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_users_user_groups'] = \ - declarative_users_user_groups - return self.put_users_user_groups_layout_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_users_user_groups is not None: + _body_params = declarative_users_user_groups + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/usersAndUserGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def put_workspace_layout( + self, + workspace_id: StrictStr, + declarative_workspace_model: DeclarativeWorkspaceModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set workspace layout + + Set complete layout of workspace, like model, authorization, etc. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_model: (required) + :type declarative_workspace_model: DeclarativeWorkspaceModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_workspace_layout_serialize( + workspace_id=workspace_id, + declarative_workspace_model=declarative_workspace_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_workspace_layout_with_http_info( + self, + workspace_id: StrictStr, + declarative_workspace_model: DeclarativeWorkspaceModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set workspace layout + + Set complete layout of workspace, like model, authorization, etc. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_model: (required) + :type declarative_workspace_model: DeclarativeWorkspaceModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_workspace_layout_serialize( + workspace_id=workspace_id, + declarative_workspace_model=declarative_workspace_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_workspace_layout_without_preload_content( + self, + workspace_id: StrictStr, + declarative_workspace_model: DeclarativeWorkspaceModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set workspace layout + + Set complete layout of workspace, like model, authorization, etc. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_model: (required) + :type declarative_workspace_model: DeclarativeWorkspaceModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_workspace_layout_serialize( + workspace_id=workspace_id, + declarative_workspace_model=declarative_workspace_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_workspace_layout_serialize( self, workspace_id, declarative_workspace_model, - **kwargs - ): - """Set workspace layout # noqa: E501 - - Set complete layout of workspace, like model, authorization, etc. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_workspace_layout(workspace_id, declarative_workspace_model, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_workspace_model (DeclarativeWorkspaceModel): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_workspace_model'] = \ - declarative_workspace_model - return self.put_workspace_layout_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_workspace_model is not None: + _body_params = declarative_workspace_model + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_analytics_model( + self, + workspace_id: StrictStr, + declarative_analytics: DeclarativeAnalytics, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set analytics model + + Set effective analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_analytics: (required) + :type declarative_analytics: DeclarativeAnalytics + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_analytics_model_serialize( + workspace_id=workspace_id, + declarative_analytics=declarative_analytics, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_analytics_model_with_http_info( + self, + workspace_id: StrictStr, + declarative_analytics: DeclarativeAnalytics, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set analytics model + + Set effective analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_analytics: (required) + :type declarative_analytics: DeclarativeAnalytics + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_analytics_model_serialize( + workspace_id=workspace_id, + declarative_analytics=declarative_analytics, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_analytics_model_without_preload_content( + self, + workspace_id: StrictStr, + declarative_analytics: DeclarativeAnalytics, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set analytics model + + Set effective analytics model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_analytics: (required) + :type declarative_analytics: DeclarativeAnalytics + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_analytics_model_serialize( + workspace_id=workspace_id, + declarative_analytics=declarative_analytics, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_analytics_model_serialize( self, workspace_id, declarative_analytics, - **kwargs - ): - """Set analytics model # noqa: E501 - - Set effective analytics model of the workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_analytics_model(workspace_id, declarative_analytics, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_analytics (DeclarativeAnalytics): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_analytics'] = \ - declarative_analytics - return self.set_analytics_model_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_analytics is not None: + _body_params = declarative_analytics + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/analyticsModel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_automations( + self, + workspace_id: StrictStr, + declarative_automation: List[DeclarativeAutomation], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set automations + + Set automations for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_automation: (required) + :type declarative_automation: List[DeclarativeAutomation] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_automations_serialize( + workspace_id=workspace_id, + declarative_automation=declarative_automation, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_automations_with_http_info( + self, + workspace_id: StrictStr, + declarative_automation: List[DeclarativeAutomation], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set automations + + Set automations for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_automation: (required) + :type declarative_automation: List[DeclarativeAutomation] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_automations_serialize( + workspace_id=workspace_id, + declarative_automation=declarative_automation, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_automations_without_preload_content( + self, + workspace_id: StrictStr, + declarative_automation: List[DeclarativeAutomation], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set automations + + Set automations for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_automation: (required) + :type declarative_automation: List[DeclarativeAutomation] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_automations_serialize( + workspace_id=workspace_id, + declarative_automation=declarative_automation, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_automations_serialize( self, workspace_id, declarative_automation, - **kwargs - ): - """Set automations # noqa: E501 - - Set automations for the specific workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_automations(workspace_id, declarative_automation, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_automation ([DeclarativeAutomation]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_automation'] = \ - declarative_automation - return self.set_automations_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'DeclarativeAutomation': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_automation is not None: + _body_params = declarative_automation + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/automations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_data_source_permissions( + self, + data_source_id: StrictStr, + declarative_data_source_permissions: DeclarativeDataSourcePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set data source permissions. + + set data source permissions. + + :param data_source_id: (required) + :type data_source_id: str + :param declarative_data_source_permissions: (required) + :type declarative_data_source_permissions: DeclarativeDataSourcePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_data_source_permissions_serialize( + data_source_id=data_source_id, + declarative_data_source_permissions=declarative_data_source_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_data_source_permissions_with_http_info( + self, + data_source_id: StrictStr, + declarative_data_source_permissions: DeclarativeDataSourcePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set data source permissions. + + set data source permissions. + + :param data_source_id: (required) + :type data_source_id: str + :param declarative_data_source_permissions: (required) + :type declarative_data_source_permissions: DeclarativeDataSourcePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_data_source_permissions_serialize( + data_source_id=data_source_id, + declarative_data_source_permissions=declarative_data_source_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_data_source_permissions_without_preload_content( + self, + data_source_id: StrictStr, + declarative_data_source_permissions: DeclarativeDataSourcePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set data source permissions. + + set data source permissions. + + :param data_source_id: (required) + :type data_source_id: str + :param declarative_data_source_permissions: (required) + :type declarative_data_source_permissions: DeclarativeDataSourcePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_data_source_permissions_serialize( + data_source_id=data_source_id, + declarative_data_source_permissions=declarative_data_source_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_data_source_permissions_serialize( self, data_source_id, declarative_data_source_permissions, - **kwargs - ): - """Set data source permissions. # noqa: E501 - - set data source permissions. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_data_source_permissions(data_source_id, declarative_data_source_permissions, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - declarative_data_source_permissions (DeclarativeDataSourcePermissions): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['declarative_data_source_permissions'] = \ - declarative_data_source_permissions - return self.set_data_source_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_data_source_permissions is not None: + _body_params = declarative_data_source_permissions + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/dataSources/{dataSourceId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_export_templates( + self, + declarative_export_templates: DeclarativeExportTemplates, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set all export templates + + Sets export templates in organization. + + :param declarative_export_templates: (required) + :type declarative_export_templates: DeclarativeExportTemplates + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_export_templates_serialize( + declarative_export_templates=declarative_export_templates, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_export_templates_with_http_info( + self, + declarative_export_templates: DeclarativeExportTemplates, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set all export templates + + Sets export templates in organization. + + :param declarative_export_templates: (required) + :type declarative_export_templates: DeclarativeExportTemplates + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_export_templates_serialize( + declarative_export_templates=declarative_export_templates, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_export_templates_without_preload_content( + self, + declarative_export_templates: DeclarativeExportTemplates, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set all export templates + + Sets export templates in organization. + + :param declarative_export_templates: (required) + :type declarative_export_templates: DeclarativeExportTemplates + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_export_templates_serialize( + declarative_export_templates=declarative_export_templates, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_export_templates_serialize( self, declarative_export_templates, - **kwargs - ): - """Set all export templates # noqa: E501 - - Sets export templates in organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_export_templates(declarative_export_templates, async_req=True) - >>> result = thread.get() - - Args: - declarative_export_templates (DeclarativeExportTemplates): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_export_templates'] = \ - declarative_export_templates - return self.set_export_templates_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_export_templates is not None: + _body_params = declarative_export_templates + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/exportTemplates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_filter_views( + self, + workspace_id: StrictStr, + declarative_filter_view: List[DeclarativeFilterView], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set filter views + + Set filter views for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_filter_view: (required) + :type declarative_filter_view: List[DeclarativeFilterView] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_filter_views_serialize( + workspace_id=workspace_id, + declarative_filter_view=declarative_filter_view, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_filter_views_with_http_info( + self, + workspace_id: StrictStr, + declarative_filter_view: List[DeclarativeFilterView], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set filter views + + Set filter views for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_filter_view: (required) + :type declarative_filter_view: List[DeclarativeFilterView] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_filter_views_serialize( + workspace_id=workspace_id, + declarative_filter_view=declarative_filter_view, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + declarative_filter_view: List[DeclarativeFilterView], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set filter views + + Set filter views for the specific workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_filter_view: (required) + :type declarative_filter_view: List[DeclarativeFilterView] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_filter_views_serialize( + workspace_id=workspace_id, + declarative_filter_view=declarative_filter_view, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_filter_views_serialize( self, workspace_id, declarative_filter_view, - **kwargs - ): - """Set filter views # noqa: E501 - - Set filter views for the specific workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_filter_views(workspace_id, declarative_filter_view, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_filter_view ([DeclarativeFilterView]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_filter_view'] = \ - declarative_filter_view - return self.set_filter_views_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'DeclarativeFilterView': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_filter_view is not None: + _body_params = declarative_filter_view + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/filterViews', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_identity_providers( + self, + declarative_identity_provider: List[DeclarativeIdentityProvider], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set all identity providers + + Sets identity providers in organization. + + :param declarative_identity_provider: (required) + :type declarative_identity_provider: List[DeclarativeIdentityProvider] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_identity_providers_serialize( + declarative_identity_provider=declarative_identity_provider, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_identity_providers_with_http_info( + self, + declarative_identity_provider: List[DeclarativeIdentityProvider], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set all identity providers + + Sets identity providers in organization. + + :param declarative_identity_provider: (required) + :type declarative_identity_provider: List[DeclarativeIdentityProvider] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_identity_providers_serialize( + declarative_identity_provider=declarative_identity_provider, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_identity_providers_without_preload_content( + self, + declarative_identity_provider: List[DeclarativeIdentityProvider], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set all identity providers + + Sets identity providers in organization. + + :param declarative_identity_provider: (required) + :type declarative_identity_provider: List[DeclarativeIdentityProvider] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_identity_providers_serialize( + declarative_identity_provider=declarative_identity_provider, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_identity_providers_serialize( self, declarative_identity_provider, - **kwargs - ): - """Set all identity providers # noqa: E501 - - Sets identity providers in organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_identity_providers(declarative_identity_provider, async_req=True) - >>> result = thread.get() - - Args: - declarative_identity_provider ([DeclarativeIdentityProvider]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_identity_provider'] = \ - declarative_identity_provider - return self.set_identity_providers_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'DeclarativeIdentityProvider': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_identity_provider is not None: + _body_params = declarative_identity_provider + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/identityProviders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_logical_model( + self, + workspace_id: StrictStr, + declarative_model: DeclarativeModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set logical model + + Set effective logical model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_model: (required) + :type declarative_model: DeclarativeModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_logical_model_serialize( + workspace_id=workspace_id, + declarative_model=declarative_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_logical_model_with_http_info( + self, + workspace_id: StrictStr, + declarative_model: DeclarativeModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set logical model + + Set effective logical model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_model: (required) + :type declarative_model: DeclarativeModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_logical_model_serialize( + workspace_id=workspace_id, + declarative_model=declarative_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_logical_model_without_preload_content( + self, + workspace_id: StrictStr, + declarative_model: DeclarativeModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set logical model + + Set effective logical model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_model: (required) + :type declarative_model: DeclarativeModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_logical_model_serialize( + workspace_id=workspace_id, + declarative_model=declarative_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_logical_model_serialize( self, workspace_id, declarative_model, - **kwargs - ): - """Set logical model # noqa: E501 - - Set effective logical model of the workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_logical_model(workspace_id, declarative_model, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_model (DeclarativeModel): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_model'] = \ - declarative_model - return self.set_logical_model_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_model is not None: + _body_params = declarative_model + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/logicalModel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_notification_channels( + self, + declarative_notification_channels: DeclarativeNotificationChannels, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set all notification channels + + Sets notification channels in organization. + + :param declarative_notification_channels: (required) + :type declarative_notification_channels: DeclarativeNotificationChannels + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_notification_channels_serialize( + declarative_notification_channels=declarative_notification_channels, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_notification_channels_with_http_info( + self, + declarative_notification_channels: DeclarativeNotificationChannels, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set all notification channels + + Sets notification channels in organization. + + :param declarative_notification_channels: (required) + :type declarative_notification_channels: DeclarativeNotificationChannels + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_notification_channels_serialize( + declarative_notification_channels=declarative_notification_channels, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_notification_channels_without_preload_content( + self, + declarative_notification_channels: DeclarativeNotificationChannels, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set all notification channels + + Sets notification channels in organization. + + :param declarative_notification_channels: (required) + :type declarative_notification_channels: DeclarativeNotificationChannels + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_notification_channels_serialize( + declarative_notification_channels=declarative_notification_channels, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_notification_channels_serialize( self, declarative_notification_channels, - **kwargs - ): - """Set all notification channels # noqa: E501 - - Sets notification channels in organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_notification_channels(declarative_notification_channels, async_req=True) - >>> result = thread.get() - - Args: - declarative_notification_channels (DeclarativeNotificationChannels): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_notification_channels'] = \ - declarative_notification_channels - return self.set_notification_channels_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_notification_channels is not None: + _body_params = declarative_notification_channels + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/notificationChannels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_organization_layout( + self, + declarative_organization: DeclarativeOrganization, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set organization layout + + Sets complete layout of organization, like workspaces, user-groups, etc. + + :param declarative_organization: (required) + :type declarative_organization: DeclarativeOrganization + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_layout_serialize( + declarative_organization=declarative_organization, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_organization_layout_with_http_info( + self, + declarative_organization: DeclarativeOrganization, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set organization layout + + Sets complete layout of organization, like workspaces, user-groups, etc. + + :param declarative_organization: (required) + :type declarative_organization: DeclarativeOrganization + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_layout_serialize( + declarative_organization=declarative_organization, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_organization_layout_without_preload_content( + self, + declarative_organization: DeclarativeOrganization, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set organization layout + + Sets complete layout of organization, like workspaces, user-groups, etc. + + :param declarative_organization: (required) + :type declarative_organization: DeclarativeOrganization + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_layout_serialize( + declarative_organization=declarative_organization, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_organization_layout_serialize( self, declarative_organization, - **kwargs - ): - """Set organization layout # noqa: E501 - - Sets complete layout of organization, like workspaces, user-groups, etc. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_organization_layout(declarative_organization, async_req=True) - >>> result = thread.get() - - Args: - declarative_organization (DeclarativeOrganization): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_organization'] = \ - declarative_organization - return self.set_organization_layout_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_organization is not None: + _body_params = declarative_organization + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/organization', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_organization_permissions( + self, + declarative_organization_permission: List[DeclarativeOrganizationPermission], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set organization permissions + + Sets organization permissions + + :param declarative_organization_permission: (required) + :type declarative_organization_permission: List[DeclarativeOrganizationPermission] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_permissions_serialize( + declarative_organization_permission=declarative_organization_permission, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_organization_permissions_with_http_info( + self, + declarative_organization_permission: List[DeclarativeOrganizationPermission], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set organization permissions + + Sets organization permissions + + :param declarative_organization_permission: (required) + :type declarative_organization_permission: List[DeclarativeOrganizationPermission] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_permissions_serialize( + declarative_organization_permission=declarative_organization_permission, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_organization_permissions_without_preload_content( + self, + declarative_organization_permission: List[DeclarativeOrganizationPermission], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set organization permissions + + Sets organization permissions + + :param declarative_organization_permission: (required) + :type declarative_organization_permission: List[DeclarativeOrganizationPermission] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_permissions_serialize( + declarative_organization_permission=declarative_organization_permission, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_organization_permissions_serialize( self, declarative_organization_permission, - **kwargs - ): - """Set organization permissions # noqa: E501 - - Sets organization permissions # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_organization_permissions(declarative_organization_permission, async_req=True) - >>> result = thread.get() - - Args: - declarative_organization_permission ([DeclarativeOrganizationPermission]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_organization_permission'] = \ - declarative_organization_permission - return self.set_organization_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'DeclarativeOrganizationPermission': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_organization_permission is not None: + _body_params = declarative_organization_permission + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/organization/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_user_data_filters( + self, + workspace_id: StrictStr, + declarative_user_data_filters: DeclarativeUserDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set user data filters + + Set user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_user_data_filters: (required) + :type declarative_user_data_filters: DeclarativeUserDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_data_filters_serialize( + workspace_id=workspace_id, + declarative_user_data_filters=declarative_user_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + declarative_user_data_filters: DeclarativeUserDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set user data filters + + Set user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_user_data_filters: (required) + :type declarative_user_data_filters: DeclarativeUserDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_data_filters_serialize( + workspace_id=workspace_id, + declarative_user_data_filters=declarative_user_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + declarative_user_data_filters: DeclarativeUserDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set user data filters + + Set user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_user_data_filters: (required) + :type declarative_user_data_filters: DeclarativeUserDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_data_filters_serialize( + workspace_id=workspace_id, + declarative_user_data_filters=declarative_user_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_user_data_filters_serialize( self, workspace_id, declarative_user_data_filters, - **kwargs - ): - """Set user data filters # noqa: E501 - - Set user data filters assigned to the workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_user_data_filters(workspace_id, declarative_user_data_filters, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_user_data_filters (DeclarativeUserDataFilters): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_user_data_filters'] = \ - declarative_user_data_filters - return self.set_user_data_filters_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_user_data_filters is not None: + _body_params = declarative_user_data_filters + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/userDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_user_group_permissions( + self, + user_group_id: StrictStr, + declarative_user_group_permissions: DeclarativeUserGroupPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set permissions for the user-group + + Set effective permissions for the user-group + + :param user_group_id: (required) + :type user_group_id: str + :param declarative_user_group_permissions: (required) + :type declarative_user_group_permissions: DeclarativeUserGroupPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_group_permissions_serialize( + user_group_id=user_group_id, + declarative_user_group_permissions=declarative_user_group_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_user_group_permissions_with_http_info( + self, + user_group_id: StrictStr, + declarative_user_group_permissions: DeclarativeUserGroupPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set permissions for the user-group + + Set effective permissions for the user-group + + :param user_group_id: (required) + :type user_group_id: str + :param declarative_user_group_permissions: (required) + :type declarative_user_group_permissions: DeclarativeUserGroupPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_group_permissions_serialize( + user_group_id=user_group_id, + declarative_user_group_permissions=declarative_user_group_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_user_group_permissions_without_preload_content( + self, + user_group_id: StrictStr, + declarative_user_group_permissions: DeclarativeUserGroupPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set permissions for the user-group + + Set effective permissions for the user-group + + :param user_group_id: (required) + :type user_group_id: str + :param declarative_user_group_permissions: (required) + :type declarative_user_group_permissions: DeclarativeUserGroupPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_group_permissions_serialize( + user_group_id=user_group_id, + declarative_user_group_permissions=declarative_user_group_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_user_group_permissions_serialize( self, user_group_id, declarative_user_group_permissions, - **kwargs - ): - """Set permissions for the user-group # noqa: E501 - - Set effective permissions for the user-group # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_user_group_permissions(user_group_id, declarative_user_group_permissions, async_req=True) - >>> result = thread.get() - - Args: - user_group_id (str): - declarative_user_group_permissions (DeclarativeUserGroupPermissions): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_group_id'] = \ - user_group_id - kwargs['declarative_user_group_permissions'] = \ - declarative_user_group_permissions - return self.set_user_group_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_user_group_permissions is not None: + _body_params = declarative_user_group_permissions + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/userGroups/{userGroupId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_user_permissions( + self, + user_id: StrictStr, + declarative_user_permissions: DeclarativeUserPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set permissions for the user + + Set effective permissions for the user + + :param user_id: (required) + :type user_id: str + :param declarative_user_permissions: (required) + :type declarative_user_permissions: DeclarativeUserPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_permissions_serialize( + user_id=user_id, + declarative_user_permissions=declarative_user_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_user_permissions_with_http_info( + self, + user_id: StrictStr, + declarative_user_permissions: DeclarativeUserPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set permissions for the user + + Set effective permissions for the user + + :param user_id: (required) + :type user_id: str + :param declarative_user_permissions: (required) + :type declarative_user_permissions: DeclarativeUserPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_permissions_serialize( + user_id=user_id, + declarative_user_permissions=declarative_user_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_user_permissions_without_preload_content( + self, + user_id: StrictStr, + declarative_user_permissions: DeclarativeUserPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set permissions for the user + + Set effective permissions for the user + + :param user_id: (required) + :type user_id: str + :param declarative_user_permissions: (required) + :type declarative_user_permissions: DeclarativeUserPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_permissions_serialize( + user_id=user_id, + declarative_user_permissions=declarative_user_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_user_permissions_serialize( self, user_id, declarative_user_permissions, - **kwargs - ): - """Set permissions for the user # noqa: E501 - - Set effective permissions for the user # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_user_permissions(user_id, declarative_user_permissions, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - declarative_user_permissions (DeclarativeUserPermissions): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['declarative_user_permissions'] = \ - declarative_user_permissions - return self.set_user_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_user_permissions is not None: + _body_params = declarative_user_permissions + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/users/{userId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_workspace_data_filters_layout( + self, + declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set all workspace data filters + + Sets workspace data filters in all workspaces in entire organization. + + :param declarative_workspace_data_filters: (required) + :type declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_data_filters_layout_serialize( + declarative_workspace_data_filters=declarative_workspace_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_workspace_data_filters_layout_with_http_info( + self, + declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set all workspace data filters + + Sets workspace data filters in all workspaces in entire organization. + + :param declarative_workspace_data_filters: (required) + :type declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_data_filters_layout_serialize( + declarative_workspace_data_filters=declarative_workspace_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_workspace_data_filters_layout_without_preload_content( + self, + declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set all workspace data filters + + Sets workspace data filters in all workspaces in entire organization. + + :param declarative_workspace_data_filters: (required) + :type declarative_workspace_data_filters: DeclarativeWorkspaceDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_data_filters_layout_serialize( + declarative_workspace_data_filters=declarative_workspace_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_workspace_data_filters_layout_serialize( self, declarative_workspace_data_filters, - **kwargs - ): - """Set all workspace data filters # noqa: E501 - - Sets workspace data filters in all workspaces in entire organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_workspace_data_filters_layout(declarative_workspace_data_filters, async_req=True) - >>> result = thread.get() - - Args: - declarative_workspace_data_filters (DeclarativeWorkspaceDataFilters): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_workspace_data_filters'] = \ - declarative_workspace_data_filters - return self.set_workspace_data_filters_layout_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_workspace_data_filters is not None: + _body_params = declarative_workspace_data_filters + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaceDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_workspace_permissions( + self, + workspace_id: StrictStr, + declarative_workspace_permissions: DeclarativeWorkspacePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set permissions for the workspace + + Set effective permissions for the workspace + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_permissions: (required) + :type declarative_workspace_permissions: DeclarativeWorkspacePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_permissions_serialize( + workspace_id=workspace_id, + declarative_workspace_permissions=declarative_workspace_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_workspace_permissions_with_http_info( + self, + workspace_id: StrictStr, + declarative_workspace_permissions: DeclarativeWorkspacePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set permissions for the workspace + + Set effective permissions for the workspace + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_permissions: (required) + :type declarative_workspace_permissions: DeclarativeWorkspacePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_permissions_serialize( + workspace_id=workspace_id, + declarative_workspace_permissions=declarative_workspace_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_workspace_permissions_without_preload_content( + self, + workspace_id: StrictStr, + declarative_workspace_permissions: DeclarativeWorkspacePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set permissions for the workspace + + Set effective permissions for the workspace + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_permissions: (required) + :type declarative_workspace_permissions: DeclarativeWorkspacePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_permissions_serialize( + workspace_id=workspace_id, + declarative_workspace_permissions=declarative_workspace_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_workspace_permissions_serialize( self, workspace_id, declarative_workspace_permissions, - **kwargs - ): - """Set permissions for the workspace # noqa: E501 - - Set effective permissions for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_workspace_permissions(workspace_id, declarative_workspace_permissions, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_workspace_permissions (DeclarativeWorkspacePermissions): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_workspace_permissions'] = \ - declarative_workspace_permissions - return self.set_workspace_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_workspace_permissions is not None: + _body_params = declarative_workspace_permissions + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_workspaces_layout( + self, + declarative_workspaces: DeclarativeWorkspaces, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set all workspaces layout + + Sets complete layout of workspaces, their hierarchy, models. + + :param declarative_workspaces: (required) + :type declarative_workspaces: DeclarativeWorkspaces + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspaces_layout_serialize( + declarative_workspaces=declarative_workspaces, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_workspaces_layout_with_http_info( + self, + declarative_workspaces: DeclarativeWorkspaces, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set all workspaces layout + + Sets complete layout of workspaces, their hierarchy, models. + + :param declarative_workspaces: (required) + :type declarative_workspaces: DeclarativeWorkspaces + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspaces_layout_serialize( + declarative_workspaces=declarative_workspaces, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_workspaces_layout_without_preload_content( + self, + declarative_workspaces: DeclarativeWorkspaces, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set all workspaces layout + + Sets complete layout of workspaces, their hierarchy, models. + + :param declarative_workspaces: (required) + :type declarative_workspaces: DeclarativeWorkspaces + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspaces_layout_serialize( + declarative_workspaces=declarative_workspaces, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_workspaces_layout_serialize( self, declarative_workspaces, - **kwargs - ): - """Set all workspaces layout # noqa: E501 - - Sets complete layout of workspaces, their hierarchy, models. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_workspaces_layout(declarative_workspaces, async_req=True) - >>> result = thread.get() - - Args: - declarative_workspaces (DeclarativeWorkspaces): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_workspaces'] = \ - declarative_workspaces - return self.set_workspaces_layout_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_workspaces is not None: + _body_params = declarative_workspaces + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/ldm_declarative_apis_api.py b/gooddata-api-client/gooddata_api_client/api/ldm_declarative_apis_api.py index e141191d1..396b5e48f 100644 --- a/gooddata-api-client/gooddata_api_client/api/ldm_declarative_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/ldm_declarative_apis_api.py @@ -1,318 +1,597 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictBool, StrictStr +from typing import Optional +from gooddata_api_client.models.declarative_model import DeclarativeModel -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class LDMDeclarativeAPIsApi(object): +class LDMDeclarativeAPIsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_logical_model_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeModel,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/logicalModel', - 'operation_id': 'get_logical_model', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'include_parents', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'include_parents': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include_parents': 'includeParents', - }, - 'location_map': { - 'workspace_id': 'path', - 'include_parents': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.set_logical_model_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/logicalModel', - 'operation_id': 'set_logical_model', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_model', - ], - 'required': [ - 'workspace_id', - 'declarative_model', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_model': - (DeclarativeModel,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_model': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def get_logical_model( self, - workspace_id, - **kwargs - ): - """Get logical model # noqa: E501 - - Retrieve current logical model of the workspace in declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_logical_model(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - include_parents (bool): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeModel - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + include_parents: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeModel: + """Get logical model + + Retrieve current logical model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param include_parents: + :type include_parents: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_logical_model_serialize( + workspace_id=workspace_id, + include_parents=include_parents, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_logical_model_with_http_info( + self, + workspace_id: StrictStr, + include_parents: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeModel]: + """Get logical model + + Retrieve current logical model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param include_parents: + :type include_parents: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_logical_model_serialize( + workspace_id=workspace_id, + include_parents=include_parents, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_logical_model_without_preload_content( + self, + workspace_id: StrictStr, + include_parents: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get logical model + + Retrieve current logical model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param include_parents: + :type include_parents: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_logical_model_serialize( + workspace_id=workspace_id, + include_parents=include_parents, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_logical_model_endpoint.call_with_http_info(**kwargs) + return response_data.response - def set_logical_model( + + def _get_logical_model_serialize( self, workspace_id, - declarative_model, - **kwargs - ): - """Set logical model # noqa: E501 - - Set effective logical model of the workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_logical_model(workspace_id, declarative_model, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_model (DeclarativeModel): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + include_parents, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include_parents is not None: + + _query_params.append(('includeParents', include_parents)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/logicalModel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def set_logical_model( + self, + workspace_id: StrictStr, + declarative_model: DeclarativeModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set logical model + + Set effective logical model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_model: (required) + :type declarative_model: DeclarativeModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_logical_model_serialize( + workspace_id=workspace_id, + declarative_model=declarative_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_logical_model_with_http_info( + self, + workspace_id: StrictStr, + declarative_model: DeclarativeModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set logical model + + Set effective logical model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_model: (required) + :type declarative_model: DeclarativeModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_logical_model_serialize( + workspace_id=workspace_id, + declarative_model=declarative_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def set_logical_model_without_preload_content( + self, + workspace_id: StrictStr, + declarative_model: DeclarativeModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set logical model + + Set effective logical model of the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_model: (required) + :type declarative_model: DeclarativeModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_logical_model_serialize( + workspace_id=workspace_id, + declarative_model=declarative_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_model'] = \ - declarative_model - return self.set_logical_model_endpoint.call_with_http_info(**kwargs) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_logical_model_serialize( + self, + workspace_id, + declarative_model, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_model is not None: + _body_params = declarative_model + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/logicalModel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/llm_endpoints_api.py b/gooddata-api-client/gooddata_api_client/api/llm_endpoints_api.py index 833edfedc..e50fed3b3 100644 --- a/gooddata-api-client/gooddata_api_client/api/llm_endpoints_api.py +++ b/gooddata-api-client/gooddata_api_client/api/llm_endpoints_api.py @@ -1,932 +1,1787 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList -from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from gooddata_api_client.models.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class LLMEndpointsApi(object): + +class LLMEndpointsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints', - 'operation_id': 'create_entity_llm_endpoints', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_llm_endpoint_in_document', - ], - 'required': [ - 'json_api_llm_endpoint_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_llm_endpoint_in_document': - (JsonApiLlmEndpointInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_llm_endpoint_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'delete_entity_llm_endpoints', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints', - 'operation_id': 'get_all_entities_llm_endpoints', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'get_entity_llm_endpoints', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'patch_entity_llm_endpoints', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_llm_endpoint_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_llm_endpoint_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_llm_endpoint_patch_document': - (JsonApiLlmEndpointPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_llm_endpoint_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'update_entity_llm_endpoints', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_llm_endpoint_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_llm_endpoint_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_llm_endpoint_in_document': - (JsonApiLlmEndpointInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_llm_endpoint_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_llm_endpoints( + self, + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """Post LLM endpoint entities + + + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_llm_endpoints_serialize( + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_llm_endpoints_with_http_info( + self, + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """Post LLM endpoint entities + + + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_llm_endpoints_serialize( + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_llm_endpoints_without_preload_content( + self, + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post LLM endpoint entities + + + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_llm_endpoints_serialize( + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_llm_endpoints_serialize( self, json_api_llm_endpoint_in_document, - **kwargs - ): - """Post LLM endpoint entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_llm_endpoints(json_api_llm_endpoint_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_llm_endpoint_in_document (JsonApiLlmEndpointInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_llm_endpoint_in_document'] = \ - json_api_llm_endpoint_in_document - return self.create_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_llm_endpoint_in_document is not None: + _body_params = json_api_llm_endpoint_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/llmEndpoints', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_llm_endpoints( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """delete_entity_llm_endpoints + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_llm_endpoints_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """delete_entity_llm_endpoints + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_llm_endpoints_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """delete_entity_llm_endpoints + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_llm_endpoints_serialize( self, id, - **kwargs - ): - """delete_entity_llm_endpoints # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_llm_endpoints(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_llm_endpoints( self, - **kwargs - ): - """Get all LLM endpoint entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_llm_endpoints(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_llm_endpoints_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutList: + """Get all LLM endpoint entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_llm_endpoints_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_llm_endpoints_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutList]: + """Get all LLM endpoint entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_llm_endpoints_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_llm_endpoints_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all LLM endpoint entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_llm_endpoints_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_llm_endpoints_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/llmEndpoints', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_llm_endpoints( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """Get LLM endpoint entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_llm_endpoints_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """Get LLM endpoint entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_llm_endpoints_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get LLM endpoint entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_llm_endpoints_serialize( self, id, - **kwargs - ): - """Get LLM endpoint entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_llm_endpoints(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def patch_entity_llm_endpoints( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """Patch LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_patch_document: (required) + :type json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_patch_document=json_api_llm_endpoint_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_llm_endpoints_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """Patch LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_patch_document: (required) + :type json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_patch_document=json_api_llm_endpoint_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_llm_endpoints_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_patch_document: (required) + :type json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_patch_document=json_api_llm_endpoint_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_llm_endpoints_serialize( self, id, json_api_llm_endpoint_patch_document, - **kwargs - ): - """Patch LLM endpoint entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_llm_endpoint_patch_document (JsonApiLlmEndpointPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_llm_endpoint_patch_document'] = \ - json_api_llm_endpoint_patch_document - return self.patch_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_llm_endpoint_patch_document is not None: + _body_params = json_api_llm_endpoint_patch_document + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_llm_endpoints( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """PUT LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_llm_endpoints_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """PUT LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_llm_endpoints_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """PUT LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_llm_endpoints_serialize( self, id, json_api_llm_endpoint_in_document, - **kwargs - ): - """PUT LLM endpoint entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_llm_endpoint_in_document (JsonApiLlmEndpointInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_llm_endpoint_in_document'] = \ - json_api_llm_endpoint_in_document - return self.update_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_llm_endpoint_in_document is not None: + _body_params = json_api_llm_endpoint_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/manage_permissions_api.py b/gooddata-api-client/gooddata_api_client/api/manage_permissions_api.py index e3a612827..98a8cd385 100644 --- a/gooddata-api-client/gooddata_api_client/api/manage_permissions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/manage_permissions_api.py @@ -1,454 +1,863 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictStr +from typing import List +from gooddata_api_client.models.data_source_permission_assignment import DataSourcePermissionAssignment +from gooddata_api_client.models.declarative_data_source_permissions import DeclarativeDataSourcePermissions -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment -from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class ManagePermissionsApi(object): +class ManagePermissionsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_data_source_permissions_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeDataSourcePermissions,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/dataSources/{dataSourceId}/permissions', - 'operation_id': 'get_data_source_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - ], - 'required': [ - 'data_source_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.manage_data_source_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/managePermissions', - 'operation_id': 'manage_data_source_permissions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'data_source_permission_assignment', - ], - 'required': [ - 'data_source_id', - 'data_source_permission_assignment', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'data_source_permission_assignment': - ([DataSourcePermissionAssignment],), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'data_source_permission_assignment': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_data_source_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/dataSources/{dataSourceId}/permissions', - 'operation_id': 'set_data_source_permissions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'declarative_data_source_permissions', - ], - 'required': [ - 'data_source_id', - 'declarative_data_source_permissions', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'declarative_data_source_permissions': - (DeclarativeDataSourcePermissions,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'declarative_data_source_permissions': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def get_data_source_permissions( self, - data_source_id, - **kwargs - ): - """Get permissions for the data source # noqa: E501 - - Retrieve current set of permissions of the data source in a declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_data_source_permissions(data_source_id, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeDataSourcePermissions - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeDataSourcePermissions: + """Get permissions for the data source + + Retrieve current set of permissions of the data source in a declarative form. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_permissions_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSourcePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_source_permissions_with_http_info( + self, + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeDataSourcePermissions]: + """Get permissions for the data source + + Retrieve current set of permissions of the data source in a declarative form. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_permissions_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSourcePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def get_data_source_permissions_without_preload_content( + self, + data_source_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get permissions for the data source + + Retrieve current set of permissions of the data source in a declarative form. + + :param data_source_id: (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_permissions_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeDataSourcePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _get_data_source_permissions_serialize( + self, + data_source_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/dataSources/{dataSourceId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - return self.get_data_source_permissions_endpoint.call_with_http_info(**kwargs) + + + + @validate_call def manage_data_source_permissions( self, - data_source_id, - data_source_permission_assignment, - **kwargs - ): - """Manage Permissions for a Data Source # noqa: E501 - - Manage Permissions for a Data Source # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.manage_data_source_permissions(data_source_id, data_source_permission_assignment, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - data_source_permission_assignment ([DataSourcePermissionAssignment]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + data_source_id: StrictStr, + data_source_permission_assignment: List[DataSourcePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Manage Permissions for a Data Source + + Manage Permissions for a Data Source + + :param data_source_id: (required) + :type data_source_id: str + :param data_source_permission_assignment: (required) + :type data_source_permission_assignment: List[DataSourcePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_data_source_permissions_serialize( + data_source_id=data_source_id, + data_source_permission_assignment=data_source_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def manage_data_source_permissions_with_http_info( + self, + data_source_id: StrictStr, + data_source_permission_assignment: List[DataSourcePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Manage Permissions for a Data Source + + Manage Permissions for a Data Source + + :param data_source_id: (required) + :type data_source_id: str + :param data_source_permission_assignment: (required) + :type data_source_permission_assignment: List[DataSourcePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_data_source_permissions_serialize( + data_source_id=data_source_id, + data_source_permission_assignment=data_source_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def manage_data_source_permissions_without_preload_content( + self, + data_source_id: StrictStr, + data_source_permission_assignment: List[DataSourcePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Manage Permissions for a Data Source + + Manage Permissions for a Data Source + + :param data_source_id: (required) + :type data_source_id: str + :param data_source_permission_assignment: (required) + :type data_source_permission_assignment: List[DataSourcePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_data_source_permissions_serialize( + data_source_id=data_source_id, + data_source_permission_assignment=data_source_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _manage_data_source_permissions_serialize( + self, + data_source_id, + data_source_permission_assignment, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'DataSourcePermissionAssignment': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if data_source_permission_assignment is not None: + _body_params = data_source_permission_assignment + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/managePermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['data_source_permission_assignment'] = \ - data_source_permission_assignment - return self.manage_data_source_permissions_endpoint.call_with_http_info(**kwargs) + + + + @validate_call def set_data_source_permissions( self, - data_source_id, - declarative_data_source_permissions, - **kwargs - ): - """Set data source permissions. # noqa: E501 - - set data source permissions. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_data_source_permissions(data_source_id, declarative_data_source_permissions, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - declarative_data_source_permissions (DeclarativeDataSourcePermissions): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + data_source_id: StrictStr, + declarative_data_source_permissions: DeclarativeDataSourcePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set data source permissions. + + set data source permissions. + + :param data_source_id: (required) + :type data_source_id: str + :param declarative_data_source_permissions: (required) + :type declarative_data_source_permissions: DeclarativeDataSourcePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_data_source_permissions_serialize( + data_source_id=data_source_id, + declarative_data_source_permissions=declarative_data_source_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_data_source_permissions_with_http_info( + self, + data_source_id: StrictStr, + declarative_data_source_permissions: DeclarativeDataSourcePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set data source permissions. + + set data source permissions. + + :param data_source_id: (required) + :type data_source_id: str + :param declarative_data_source_permissions: (required) + :type declarative_data_source_permissions: DeclarativeDataSourcePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_data_source_permissions_serialize( + data_source_id=data_source_id, + declarative_data_source_permissions=declarative_data_source_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def set_data_source_permissions_without_preload_content( + self, + data_source_id: StrictStr, + declarative_data_source_permissions: DeclarativeDataSourcePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set data source permissions. + + set data source permissions. + + :param data_source_id: (required) + :type data_source_id: str + :param declarative_data_source_permissions: (required) + :type declarative_data_source_permissions: DeclarativeDataSourcePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_data_source_permissions_serialize( + data_source_id=data_source_id, + declarative_data_source_permissions=declarative_data_source_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _set_data_source_permissions_serialize( + self, + data_source_id, + declarative_data_source_permissions, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_data_source_permissions is not None: + _body_params = declarative_data_source_permissions + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/dataSources/{dataSourceId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['declarative_data_source_permissions'] = \ - declarative_data_source_permissions - return self.set_data_source_permissions_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/metadata_sync_api.py b/gooddata-api-client/gooddata_api_client/api/metadata_sync_api.py index 4020a745c..5d1cbf6bf 100644 --- a/gooddata-api-client/gooddata_api_client/api/metadata_sync_api.py +++ b/gooddata-api-client/gooddata_api_client/api/metadata_sync_api.py @@ -1,286 +1,528 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) +from pydantic import StrictStr +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class MetadataSyncApi(object): + +class MetadataSyncApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.metadata_sync_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/metadataSync', - 'operation_id': 'metadata_sync', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.metadata_sync_organization_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/metadataSync', - 'operation_id': 'metadata_sync_organization', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def metadata_sync( self, - workspace_id, - **kwargs - ): - """(BETA) Sync Metadata to other services # noqa: E501 - - (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.metadata_sync(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(BETA) Sync Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def metadata_sync_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(BETA) Sync Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def metadata_sync_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Sync Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.metadata_sync_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _metadata_sync_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/metadataSync', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def metadata_sync_organization( self, - **kwargs - ): - """(BETA) Sync organization scope Metadata to other services # noqa: E501 - - (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.metadata_sync_organization(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(BETA) Sync organization scope Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_organization_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def metadata_sync_organization_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(BETA) Sync organization scope Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_organization_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def metadata_sync_organization_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Sync organization scope Metadata to other services + + (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metadata_sync_organization_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _metadata_sync_organization_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/metadataSync', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.metadata_sync_organization_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/metrics_api.py b/gooddata-api-client/gooddata_api_client/api/metrics_api.py index 79f9d22b4..e81b5e8df 100644 --- a/gooddata-api-client/gooddata_api_client/api/metrics_api.py +++ b/gooddata-api-client/gooddata_api_client/api/metrics_api.py @@ -1,1129 +1,2051 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class MetricsApi(object): +class MetricsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', - 'operation_id': 'create_entity_metrics', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_metric_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_metric_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_metric_post_optional_id_document': - (JsonApiMetricPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_metric_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_metrics( + self, + workspace_id: StrictStr, + json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Post Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_metric_post_optional_id_document: (required) + :type json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_metrics_serialize( + workspace_id=workspace_id, + json_api_metric_post_optional_id_document=json_api_metric_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.delete_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'delete_entity_metrics', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.get_all_entities_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', - 'operation_id': 'get_all_entities_metrics', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Post Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_metric_post_optional_id_document: (required) + :type json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_metrics_serialize( + workspace_id=workspace_id, + json_api_metric_post_optional_id_document=json_api_metric_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.get_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'get_entity_metrics', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.patch_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'patch_entity_metrics', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_metric_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_metric_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_metric_patch_document': - (JsonApiMetricPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_metric_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - self.update_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'update_entity_metrics', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_metric_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_metric_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_metric_in_document': - (JsonApiMetricInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_metric_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_metric_post_optional_id_document: (required) + :type json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_metrics_serialize( + workspace_id=workspace_id, + json_api_metric_post_optional_id_document=json_api_metric_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - def create_entity_metrics( + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_metrics_serialize( self, workspace_id, json_api_metric_post_optional_id_document, - **kwargs - ): - """Post Metrics # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_metric_post_optional_id_document (JsonApiMetricPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_metric_post_optional_id_document is not None: + _body_params = json_api_metric_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_metrics( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def delete_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_metric_post_optional_id_document'] = \ - json_api_metric_post_optional_id_document - return self.create_entity_metrics_endpoint.call_with_http_info(**kwargs) + return response_data.response - def delete_entity_metrics( + + def _delete_entity_metrics_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_metrics(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_all_entities_metrics( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutList: + """Get all Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_metrics_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_metrics_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutList]: + """Get all Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_metrics_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_all_entities_metrics_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_metrics_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_metrics_endpoint.call_with_http_info(**kwargs) - def get_all_entities_metrics( + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_metrics_serialize( self, workspace_id, - **kwargs - ): - """Get all Metrics # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_metrics(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_metrics( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Get a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Get a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_metrics_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_metrics( + + def _get_entity_metrics_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_metrics(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def patch_entity_metrics( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_patch_document: JsonApiMetricPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Patch a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_patch_document: (required) + :type json_api_metric_patch_document: JsonApiMetricPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_patch_document=json_api_metric_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_patch_document: JsonApiMetricPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Patch a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_patch_document: (required) + :type json_api_metric_patch_document: JsonApiMetricPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_patch_document=json_api_metric_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_patch_document: JsonApiMetricPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_patch_document: (required) + :type json_api_metric_patch_document: JsonApiMetricPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_patch_document=json_api_metric_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_metrics_endpoint.call_with_http_info(**kwargs) + return response_data.response - def patch_entity_metrics( + + def _patch_entity_metrics_serialize( self, workspace_id, object_id, json_api_metric_patch_document, - **kwargs - ): - """Patch a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_metric_patch_document (JsonApiMetricPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_metric_patch_document is not None: + _body_params = json_api_metric_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def update_entity_metrics( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_in_document: JsonApiMetricInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Put a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_in_document: (required) + :type json_api_metric_in_document: JsonApiMetricInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_in_document=json_api_metric_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_in_document: JsonApiMetricInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Put a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_in_document: (required) + :type json_api_metric_in_document: JsonApiMetricInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_in_document=json_api_metric_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def update_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_in_document: JsonApiMetricInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_in_document: (required) + :type json_api_metric_in_document: JsonApiMetricInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_in_document=json_api_metric_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_metric_patch_document'] = \ - json_api_metric_patch_document - return self.patch_entity_metrics_endpoint.call_with_http_info(**kwargs) + return response_data.response - def update_entity_metrics( + + def _update_entity_metrics_serialize( self, workspace_id, object_id, json_api_metric_in_document, - **kwargs - ): - """Put a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_metric_in_document (JsonApiMetricInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_metric_in_document is not None: + _body_params = json_api_metric_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_metric_in_document'] = \ - json_api_metric_in_document - return self.update_entity_metrics_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/notification_channels_api.py b/gooddata-api-client/gooddata_api_client/api/notification_channels_api.py index b542a3ae7..0528d6c6b 100644 --- a/gooddata-api-client/gooddata_api_client/api/notification_channels_api.py +++ b/gooddata-api-client/gooddata_api_client/api/notification_channels_api.py @@ -1,2443 +1,4820 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates -from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels -from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument -from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList -from gooddata_api_client.model.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument -from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList -from gooddata_api_client.model.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument -from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument -from gooddata_api_client.model.notifications import Notifications -from gooddata_api_client.model.test_destination_request import TestDestinationRequest -from gooddata_api_client.model.test_response import TestResponse - - -class NotificationChannelsApi(object): +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.models.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.models.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.models.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.models.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +from gooddata_api_client.models.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.models.notifications import Notifications +from gooddata_api_client.models.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_response import TestResponse + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class NotificationChannelsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels', - 'operation_id': 'create_entity_notification_channels', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_notification_channel_post_optional_id_document', - ], - 'required': [ - 'json_api_notification_channel_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_notification_channel_post_optional_id_document': - (JsonApiNotificationChannelPostOptionalIdDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_notification_channel_post_optional_id_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'delete_entity_notification_channels', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_notification_channel_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelIdentifierOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers', - 'operation_id': 'get_all_entities_notification_channel_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels', - 'operation_id': 'get_all_entities_notification_channels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_notification_channel_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelIdentifierOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers/{id}', - 'operation_id': 'get_entity_notification_channel_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'get_entity_notification_channels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_export_templates_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeExportTemplates,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/exportTemplates', - 'operation_id': 'get_export_templates_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_notification_channels_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeNotificationChannels,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/notificationChannels', - 'operation_id': 'get_notification_channels_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_notifications_endpoint = _Endpoint( - settings={ - 'response_type': (Notifications,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/notifications', - 'operation_id': 'get_notifications', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'is_read', - 'page', - 'size', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'page', - 'size', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('page',): { - - }, - ('size',): { - - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "TOTAL": "total", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'is_read': - (bool,), - 'page': - (str,), - 'size': - (str,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'is_read': 'isRead', - 'page': 'page', - 'size': 'size', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'query', - 'is_read': 'query', - 'page': 'query', - 'size': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.mark_as_read_notification_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/notifications/{notificationId}/markAsRead', - 'operation_id': 'mark_as_read_notification', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'notification_id', - ], - 'required': [ - 'notification_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'notification_id': - (str,), - }, - 'attribute_map': { - 'notification_id': 'notificationId', - }, - 'location_map': { - 'notification_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.mark_as_read_notification_all_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/notifications/markAsRead', - 'operation_id': 'mark_as_read_notification_all', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'patch_entity_notification_channels', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_notification_channel_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_notification_channel_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_notification_channel_patch_document': - (JsonApiNotificationChannelPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_notification_channel_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.set_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/exportTemplates', - 'operation_id': 'set_export_templates', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_export_templates', - ], - 'required': [ - 'declarative_export_templates', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_export_templates': - (DeclarativeExportTemplates,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_export_templates': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/notificationChannels', - 'operation_id': 'set_notification_channels', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_notification_channels', - ], - 'required': [ - 'declarative_notification_channels', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_notification_channels': - (DeclarativeNotificationChannels,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_notification_channels': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.test_existing_notification_channel_endpoint = _Endpoint( - settings={ - 'response_type': (TestResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/notificationChannels/{notificationChannelId}/test', - 'operation_id': 'test_existing_notification_channel', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'notification_channel_id', - 'test_destination_request', - ], - 'required': [ - 'notification_channel_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'notification_channel_id': - (str,), - 'test_destination_request': - (TestDestinationRequest,), - }, - 'attribute_map': { - 'notification_channel_id': 'notificationChannelId', - }, - 'location_map': { - 'notification_channel_id': 'path', - 'test_destination_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.test_notification_channel_endpoint = _Endpoint( - settings={ - 'response_type': (TestResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/notificationChannels/test', - 'operation_id': 'test_notification_channel', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'test_destination_request', - ], - 'required': [ - 'test_destination_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'test_destination_request': - (TestDestinationRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'test_destination_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.update_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'update_entity_notification_channels', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_notification_channel_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_notification_channel_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_notification_channel_in_document': - (JsonApiNotificationChannelInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_notification_channel_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_notification_channels( + self, + json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Post Notification Channel entities + + + :param json_api_notification_channel_post_optional_id_document: (required) + :type json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_notification_channels_serialize( + json_api_notification_channel_post_optional_id_document=json_api_notification_channel_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_notification_channels_with_http_info( + self, + json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Post Notification Channel entities + + + :param json_api_notification_channel_post_optional_id_document: (required) + :type json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_notification_channels_serialize( + json_api_notification_channel_post_optional_id_document=json_api_notification_channel_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_notification_channels_without_preload_content( + self, + json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Notification Channel entities + + + :param json_api_notification_channel_post_optional_id_document: (required) + :type json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_notification_channels_serialize( + json_api_notification_channel_post_optional_id_document=json_api_notification_channel_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_notification_channels_serialize( self, json_api_notification_channel_post_optional_id_document, - **kwargs - ): - """Post Notification Channel entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_notification_channel_post_optional_id_document (JsonApiNotificationChannelPostOptionalIdDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_notification_channel_post_optional_id_document'] = \ - json_api_notification_channel_post_optional_id_document - return self.create_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_notification_channel_post_optional_id_document is not None: + _body_params = json_api_notification_channel_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/notificationChannels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_notification_channels( self, - id, - **kwargs - ): - """Delete Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_notification_channels(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Notification Channel entity - def get_all_entities_notification_channel_identifiers( + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_notification_channels_with_http_info( self, - **kwargs - ): - """get_all_entities_notification_channel_identifiers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_notification_channel_identifiers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelIdentifierOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Notification Channel entity - def get_all_entities_notification_channels( + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_notification_channels_without_preload_content( self, - **kwargs - ): - """Get all Notification Channel entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_notification_channels(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channels_endpoint.call_with_http_info(**kwargs) + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Notification Channel entity - def get_entity_notification_channel_identifiers( + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_notification_channels_serialize( self, id, - **kwargs - ): - """get_entity_notification_channel_identifiers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_notification_channel_identifiers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelIdentifierOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: - def get_entity_notification_channels( + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_notification_channel_identifiers( self, - id, - **kwargs - ): - """Get Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_notification_channels(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelIdentifierOutList: + """get_all_entities_notification_channel_identifiers - def get_export_templates_layout( + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channel_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_notification_channel_identifiers_with_http_info( self, - **kwargs - ): - """Get all export templates layout # noqa: E501 - - Gets complete layout of export templates. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_export_templates_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeExportTemplates - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_export_templates_layout_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelIdentifierOutList]: + """get_all_entities_notification_channel_identifiers - def get_notification_channels_layout( + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channel_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_notification_channel_identifiers_without_preload_content( self, - **kwargs - ): - """Get all notification channels layout # noqa: E501 - - Gets complete layout of notification channels. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_notification_channels_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeNotificationChannels - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_notification_channels_layout_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_all_entities_notification_channel_identifiers - def get_notifications( + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channel_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_notification_channel_identifiers_serialize( self, - **kwargs - ): - """Get latest notifications. # noqa: E501 - - Get latest in-platform notifications for the current user. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_notifications(async_req=True) - >>> result = thread.get() - - - Keyword Args: - workspace_id (str): Workspace ID to filter notifications by.. [optional] - is_read (bool): Filter notifications by read status.. [optional] - page (str): Zero-based page index (0..N). [optional] if omitted the server will use the default value of "0" - size (str): The size of the page to be returned.. [optional] if omitted the server will use the default value of "20" - meta_include ([str]): Additional meta information to include in the response.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - Notifications - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_notifications_endpoint.call_with_http_info(**kwargs) + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: - def mark_as_read_notification( + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannelIdentifiers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_notification_channels( self, - notification_id, - **kwargs - ): - """Mark notification as read. # noqa: E501 - - Mark in-platform notification by its ID as read. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.mark_as_read_notification(notification_id, async_req=True) - >>> result = thread.get() - - Args: - notification_id (str): Notification ID to mark as read. - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['notification_id'] = \ - notification_id - return self.mark_as_read_notification_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutList: + """Get all Notification Channel entities - def mark_as_read_notification_all( + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channels_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_notification_channels_with_http_info( self, - **kwargs - ): - """Mark all notifications as read. # noqa: E501 - - Mark all user in-platform notifications as read. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.mark_as_read_notification_all(async_req=True) - >>> result = thread.get() - - - Keyword Args: - workspace_id (str): Workspace ID where to mark notifications as read.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.mark_as_read_notification_all_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutList]: + """Get all Notification Channel entities - def patch_entity_notification_channels( + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channels_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_notification_channels_without_preload_content( self, - id, - json_api_notification_channel_patch_document, - **kwargs - ): - """Patch Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_notification_channels(id, json_api_notification_channel_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_notification_channel_patch_document (JsonApiNotificationChannelPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_notification_channel_patch_document'] = \ - json_api_notification_channel_patch_document - return self.patch_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Notification Channel entities - def set_export_templates( + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channels_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_notification_channels_serialize( self, - declarative_export_templates, - **kwargs - ): - """Set all export templates # noqa: E501 - - Sets export templates in organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_export_templates(declarative_export_templates, async_req=True) - >>> result = thread.get() - - Args: - declarative_export_templates (DeclarativeExportTemplates): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_export_templates'] = \ - declarative_export_templates - return self.set_export_templates_endpoint.call_with_http_info(**kwargs) + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: - def set_notification_channels( + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_notification_channel_identifiers( self, - declarative_notification_channels, - **kwargs - ): - """Set all notification channels # noqa: E501 - - Sets notification channels in organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_notification_channels(declarative_notification_channels, async_req=True) - >>> result = thread.get() - - Args: - declarative_notification_channels (DeclarativeNotificationChannels): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_notification_channels'] = \ - declarative_notification_channels - return self.set_notification_channels_endpoint.call_with_http_info(**kwargs) + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelIdentifierOutDocument: + """get_entity_notification_channel_identifiers - def test_existing_notification_channel( + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channel_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_notification_channel_identifiers_with_http_info( self, - notification_channel_id, - **kwargs - ): - """Test existing notification channel. # noqa: E501 - - Tests the existing notification channel by sending a test notification. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.test_existing_notification_channel(notification_channel_id, async_req=True) - >>> result = thread.get() - - Args: - notification_channel_id (str): - - Keyword Args: - test_destination_request (TestDestinationRequest): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - TestResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['notification_channel_id'] = \ - notification_channel_id - return self.test_existing_notification_channel_endpoint.call_with_http_info(**kwargs) + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelIdentifierOutDocument]: + """get_entity_notification_channel_identifiers - def test_notification_channel( + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channel_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_notification_channel_identifiers_without_preload_content( self, - test_destination_request, - **kwargs - ): - """Test notification channel. # noqa: E501 - - Tests the notification channel by sending a test notification. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.test_notification_channel(test_destination_request, async_req=True) - >>> result = thread.get() - - Args: - test_destination_request (TestDestinationRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - TestResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['test_destination_request'] = \ - test_destination_request - return self.test_notification_channel_endpoint.call_with_http_info(**kwargs) + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_entity_notification_channel_identifiers - def update_entity_notification_channels( + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channel_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_notification_channel_identifiers_serialize( self, id, - json_api_notification_channel_in_document, - **kwargs - ): - """Put Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_notification_channels(id, json_api_notification_channel_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_notification_channel_in_document (JsonApiNotificationChannelInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_notification_channel_in_document'] = \ - json_api_notification_channel_in_document - return self.update_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannelIdentifiers/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_notification_channels( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Get Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_notification_channels_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Get Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_notification_channels_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_notification_channels_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_export_templates_layout( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeExportTemplates: + """Get all export templates layout + + Gets complete layout of export templates. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_templates_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeExportTemplates", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_export_templates_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeExportTemplates]: + """Get all export templates layout + + Gets complete layout of export templates. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_templates_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeExportTemplates", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_export_templates_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all export templates layout + + Gets complete layout of export templates. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_templates_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeExportTemplates", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_export_templates_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/exportTemplates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_notification_channels_layout( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeNotificationChannels: + """Get all notification channels layout + + Gets complete layout of notification channels. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notification_channels_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeNotificationChannels", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_notification_channels_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeNotificationChannels]: + """Get all notification channels layout + + Gets complete layout of notification channels. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notification_channels_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeNotificationChannels", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_notification_channels_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all notification channels layout + + Gets complete layout of notification channels. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notification_channels_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeNotificationChannels", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_notification_channels_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/notificationChannels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_notifications( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID to filter notifications by.")] = None, + is_read: Annotated[Optional[StrictBool], Field(description="Filter notifications by read status.")] = None, + page: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The size of the page to be returned.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Additional meta information to include in the response.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> Notifications: + """Get latest notifications. + + Get latest in-platform notifications for the current user. + + :param workspace_id: Workspace ID to filter notifications by. + :type workspace_id: str + :param is_read: Filter notifications by read status. + :type is_read: bool + :param page: Zero-based page index (0..N) + :type page: str + :param size: The size of the page to be returned. + :type size: str + :param meta_include: Additional meta information to include in the response. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notifications_serialize( + workspace_id=workspace_id, + is_read=is_read, + page=page, + size=size, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notifications", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_notifications_with_http_info( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID to filter notifications by.")] = None, + is_read: Annotated[Optional[StrictBool], Field(description="Filter notifications by read status.")] = None, + page: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The size of the page to be returned.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Additional meta information to include in the response.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[Notifications]: + """Get latest notifications. + + Get latest in-platform notifications for the current user. + + :param workspace_id: Workspace ID to filter notifications by. + :type workspace_id: str + :param is_read: Filter notifications by read status. + :type is_read: bool + :param page: Zero-based page index (0..N) + :type page: str + :param size: The size of the page to be returned. + :type size: str + :param meta_include: Additional meta information to include in the response. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notifications_serialize( + workspace_id=workspace_id, + is_read=is_read, + page=page, + size=size, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notifications", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_notifications_without_preload_content( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID to filter notifications by.")] = None, + is_read: Annotated[Optional[StrictBool], Field(description="Filter notifications by read status.")] = None, + page: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The size of the page to be returned.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Additional meta information to include in the response.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get latest notifications. + + Get latest in-platform notifications for the current user. + + :param workspace_id: Workspace ID to filter notifications by. + :type workspace_id: str + :param is_read: Filter notifications by read status. + :type is_read: bool + :param page: Zero-based page index (0..N) + :type page: str + :param size: The size of the page to be returned. + :type size: str + :param meta_include: Additional meta information to include in the response. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_notifications_serialize( + workspace_id=workspace_id, + is_read=is_read, + page=page, + size=size, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notifications", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_notifications_serialize( + self, + workspace_id, + is_read, + page, + size, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if workspace_id is not None: + + _query_params.append(('workspaceId', workspace_id)) + + if is_read is not None: + + _query_params.append(('isRead', is_read)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/notifications', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def mark_as_read_notification( + self, + notification_id: Annotated[StrictStr, Field(description="Notification ID to mark as read.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Mark notification as read. + + Mark in-platform notification by its ID as read. + + :param notification_id: Notification ID to mark as read. (required) + :type notification_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_serialize( + notification_id=notification_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def mark_as_read_notification_with_http_info( + self, + notification_id: Annotated[StrictStr, Field(description="Notification ID to mark as read.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Mark notification as read. + + Mark in-platform notification by its ID as read. + + :param notification_id: Notification ID to mark as read. (required) + :type notification_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_serialize( + notification_id=notification_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def mark_as_read_notification_without_preload_content( + self, + notification_id: Annotated[StrictStr, Field(description="Notification ID to mark as read.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Mark notification as read. + + Mark in-platform notification by its ID as read. + + :param notification_id: Notification ID to mark as read. (required) + :type notification_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_serialize( + notification_id=notification_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _mark_as_read_notification_serialize( + self, + notification_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if notification_id is not None: + _path_params['notificationId'] = notification_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/notifications/{notificationId}/markAsRead', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def mark_as_read_notification_all( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID where to mark notifications as read.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Mark all notifications as read. + + Mark all user in-platform notifications as read. + + :param workspace_id: Workspace ID where to mark notifications as read. + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_all_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def mark_as_read_notification_all_with_http_info( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID where to mark notifications as read.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Mark all notifications as read. + + Mark all user in-platform notifications as read. + + :param workspace_id: Workspace ID where to mark notifications as read. + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_all_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def mark_as_read_notification_all_without_preload_content( + self, + workspace_id: Annotated[Optional[StrictStr], Field(description="Workspace ID where to mark notifications as read.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Mark all notifications as read. + + Mark all user in-platform notifications as read. + + :param workspace_id: Workspace ID where to mark notifications as read. + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._mark_as_read_notification_all_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _mark_as_read_notification_all_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if workspace_id is not None: + + _query_params.append(('workspaceId', workspace_id)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/notifications/markAsRead', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def patch_entity_notification_channels( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Patch Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_patch_document: (required) + :type json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_patch_document=json_api_notification_channel_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_notification_channels_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Patch Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_patch_document: (required) + :type json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_patch_document=json_api_notification_channel_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_notification_channels_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_patch_document: (required) + :type json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_patch_document=json_api_notification_channel_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_notification_channels_serialize( + self, + id, + json_api_notification_channel_patch_document, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_notification_channel_patch_document is not None: + _body_params = json_api_notification_channel_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def set_export_templates( + self, + declarative_export_templates: DeclarativeExportTemplates, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set all export templates + + Sets export templates in organization. + + :param declarative_export_templates: (required) + :type declarative_export_templates: DeclarativeExportTemplates + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_export_templates_serialize( + declarative_export_templates=declarative_export_templates, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_export_templates_with_http_info( + self, + declarative_export_templates: DeclarativeExportTemplates, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set all export templates + + Sets export templates in organization. + + :param declarative_export_templates: (required) + :type declarative_export_templates: DeclarativeExportTemplates + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_export_templates_serialize( + declarative_export_templates=declarative_export_templates, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_export_templates_without_preload_content( + self, + declarative_export_templates: DeclarativeExportTemplates, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set all export templates + + Sets export templates in organization. + + :param declarative_export_templates: (required) + :type declarative_export_templates: DeclarativeExportTemplates + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_export_templates_serialize( + declarative_export_templates=declarative_export_templates, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_export_templates_serialize( + self, + declarative_export_templates, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_export_templates is not None: + _body_params = declarative_export_templates + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/exportTemplates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def set_notification_channels( + self, + declarative_notification_channels: DeclarativeNotificationChannels, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set all notification channels + + Sets notification channels in organization. + + :param declarative_notification_channels: (required) + :type declarative_notification_channels: DeclarativeNotificationChannels + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_notification_channels_serialize( + declarative_notification_channels=declarative_notification_channels, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_notification_channels_with_http_info( + self, + declarative_notification_channels: DeclarativeNotificationChannels, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set all notification channels + + Sets notification channels in organization. + + :param declarative_notification_channels: (required) + :type declarative_notification_channels: DeclarativeNotificationChannels + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_notification_channels_serialize( + declarative_notification_channels=declarative_notification_channels, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_notification_channels_without_preload_content( + self, + declarative_notification_channels: DeclarativeNotificationChannels, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set all notification channels + + Sets notification channels in organization. + + :param declarative_notification_channels: (required) + :type declarative_notification_channels: DeclarativeNotificationChannels + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_notification_channels_serialize( + declarative_notification_channels=declarative_notification_channels, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_notification_channels_serialize( + self, + declarative_notification_channels, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_notification_channels is not None: + _body_params = declarative_notification_channels + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/notificationChannels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def test_existing_notification_channel( + self, + notification_channel_id: StrictStr, + test_destination_request: Optional[TestDestinationRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TestResponse: + """Test existing notification channel. + + Tests the existing notification channel by sending a test notification. + + :param notification_channel_id: (required) + :type notification_channel_id: str + :param test_destination_request: + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_existing_notification_channel_serialize( + notification_channel_id=notification_channel_id, + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_existing_notification_channel_with_http_info( + self, + notification_channel_id: StrictStr, + test_destination_request: Optional[TestDestinationRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TestResponse]: + """Test existing notification channel. + + Tests the existing notification channel by sending a test notification. + + :param notification_channel_id: (required) + :type notification_channel_id: str + :param test_destination_request: + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_existing_notification_channel_serialize( + notification_channel_id=notification_channel_id, + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def test_existing_notification_channel_without_preload_content( + self, + notification_channel_id: StrictStr, + test_destination_request: Optional[TestDestinationRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test existing notification channel. + + Tests the existing notification channel by sending a test notification. + + :param notification_channel_id: (required) + :type notification_channel_id: str + :param test_destination_request: + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_existing_notification_channel_serialize( + notification_channel_id=notification_channel_id, + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _test_existing_notification_channel_serialize( + self, + notification_channel_id, + test_destination_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if notification_channel_id is not None: + _path_params['notificationChannelId'] = notification_channel_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if test_destination_request is not None: + _body_params = test_destination_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/notificationChannels/{notificationChannelId}/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def test_notification_channel( + self, + test_destination_request: TestDestinationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TestResponse: + """Test notification channel. + + Tests the notification channel by sending a test notification. + + :param test_destination_request: (required) + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_notification_channel_serialize( + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_notification_channel_with_http_info( + self, + test_destination_request: TestDestinationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TestResponse]: + """Test notification channel. + + Tests the notification channel by sending a test notification. + + :param test_destination_request: (required) + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_notification_channel_serialize( + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def test_notification_channel_without_preload_content( + self, + test_destination_request: TestDestinationRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test notification channel. + + Tests the notification channel by sending a test notification. + + :param test_destination_request: (required) + :type test_destination_request: TestDestinationRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_notification_channel_serialize( + test_destination_request=test_destination_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _test_notification_channel_serialize( + self, + test_destination_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if test_destination_request is not None: + _body_params = test_destination_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/notificationChannels/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_entity_notification_channels( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Put Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_in_document: (required) + :type json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_in_document=json_api_notification_channel_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_notification_channels_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Put Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_in_document: (required) + :type json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_in_document=json_api_notification_channel_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_notification_channels_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_in_document: (required) + :type json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_in_document=json_api_notification_channel_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_notification_channels_serialize( + self, + id, + json_api_notification_channel_in_document, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_notification_channel_in_document is not None: + _body_params = json_api_notification_channel_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/options_api.py b/gooddata-api-client/gooddata_api_client/api/options_api.py index be170edaa..ca814bfca 100644 --- a/gooddata-api-client/gooddata_api_client/api/options_api.py +++ b/gooddata-api-client/gooddata_api_client/api/options_api.py @@ -1,158 +1,282 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from typing import Any, Dict -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class OptionsApi(object): +class OptionsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_all_options_endpoint = _Endpoint( - settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), - 'auth': [], - 'endpoint_path': '/api/v1/options', - 'operation_id': 'get_all_options', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def get_all_options( self, - **kwargs - ): - """Links for all configuration options # noqa: E501 - - Retrieves links for all options for different configurations. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_options(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> object: + """Links for all configuration options + + Retrieves links for all options for different configurations. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_options_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_options_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[object]: + """Links for all configuration options + + Retrieves links for all options for different configurations. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_options_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def get_all_options_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Links for all configuration options + + Retrieves links for all options for different configurations. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_options_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _get_all_options_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/options', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_options_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/organization_api.py b/gooddata-api-client/gooddata_api_client/api/organization_api.py index cf97d961c..0e864a4e1 100644 --- a/gooddata-api-client/gooddata_api_client/api/organization_api.py +++ b/gooddata-api-client/gooddata_api_client/api/organization_api.py @@ -1,170 +1,303 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.switch_identity_provider_request import SwitchIdentityProviderRequest +from gooddata_api_client.models.switch_identity_provider_request import SwitchIdentityProviderRequest +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class OrganizationApi(object): + +class OrganizationApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.switch_active_identity_provider_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/switchActiveIdentityProvider', - 'operation_id': 'switch_active_identity_provider', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'switch_identity_provider_request', - ], - 'required': [ - 'switch_identity_provider_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'switch_identity_provider_request': - (SwitchIdentityProviderRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'switch_identity_provider_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def switch_active_identity_provider( self, - switch_identity_provider_request, - **kwargs - ): - """Switch Active Identity Provider # noqa: E501 - - Switch the active identity provider for the organization. Requires MANAGE permission on the organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.switch_active_identity_provider(switch_identity_provider_request, async_req=True) - >>> result = thread.get() - - Args: - switch_identity_provider_request (SwitchIdentityProviderRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + switch_identity_provider_request: SwitchIdentityProviderRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Switch Active Identity Provider + + Switch the active identity provider for the organization. Requires MANAGE permission on the organization. + + :param switch_identity_provider_request: (required) + :type switch_identity_provider_request: SwitchIdentityProviderRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._switch_active_identity_provider_serialize( + switch_identity_provider_request=switch_identity_provider_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def switch_active_identity_provider_with_http_info( + self, + switch_identity_provider_request: SwitchIdentityProviderRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Switch Active Identity Provider + + Switch the active identity provider for the organization. Requires MANAGE permission on the organization. + + :param switch_identity_provider_request: (required) + :type switch_identity_provider_request: SwitchIdentityProviderRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._switch_active_identity_provider_serialize( + switch_identity_provider_request=switch_identity_provider_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def switch_active_identity_provider_without_preload_content( + self, + switch_identity_provider_request: SwitchIdentityProviderRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Switch Active Identity Provider + + Switch the active identity provider for the organization. Requires MANAGE permission on the organization. + + :param switch_identity_provider_request: (required) + :type switch_identity_provider_request: SwitchIdentityProviderRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._switch_active_identity_provider_serialize( + switch_identity_provider_request=switch_identity_provider_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _switch_active_identity_provider_serialize( + self, + switch_identity_provider_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if switch_identity_provider_request is not None: + _body_params = switch_identity_provider_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/switchActiveIdentityProvider', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['switch_identity_provider_request'] = \ - switch_identity_provider_request - return self.switch_active_identity_provider_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/organization_controller_api.py b/gooddata-api-client/gooddata_api_client/api/organization_controller_api.py index 751a9da71..a3fc60322 100644 --- a/gooddata-api-client/gooddata_api_client/api/organization_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/organization_controller_api.py @@ -1,1024 +1,1873 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated +from pydantic import Field, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument - - -class OrganizationControllerApi(object): +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class OrganizationControllerApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_entity_cookie_security_configurations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'get_entity_cookie_security_configurations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + + + @validate_call + def get_entity_cookie_security_configurations( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCookieSecurityConfigurationOutDocument: + """Get CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_cookie_security_configurations_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.get_entity_organizations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'get_entity_organizations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.patch_entity_cookie_security_configurations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'patch_entity_cookie_security_configurations', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_cookie_security_configuration_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_cookie_security_configuration_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_cookie_security_configuration_patch_document': - (JsonApiCookieSecurityConfigurationPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_cookie_security_configuration_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_cookie_security_configurations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCookieSecurityConfigurationOutDocument]: + """Get CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_cookie_security_configurations_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.patch_entity_organizations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'patch_entity_organizations', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_organization_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_patch_document': - (JsonApiOrganizationPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.update_entity_cookie_security_configurations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'update_entity_cookie_security_configurations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_cookie_security_configuration_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_cookie_security_configuration_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_cookie_security_configuration_in_document': - (JsonApiCookieSecurityConfigurationInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_cookie_security_configuration_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - self.update_entity_organizations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'update_entity_organizations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_organization_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_in_document': - (JsonApiOrganizationInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + + + @validate_call + def get_entity_cookie_security_configurations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_cookie_security_configurations_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_cookie_security_configurations_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - def get_entity_cookie_security_configurations( + + + + @validate_call + def get_entity_organizations( self, - id, - **kwargs - ): - """Get CookieSecurityConfiguration # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_cookie_security_configurations(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCookieSecurityConfigurationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationOutDocument: + """Get Organizations + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organizations_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_organizations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationOutDocument]: + """Get Organizations + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organizations_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_entity_organizations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Organizations + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organizations_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_organizations( + + def _get_entity_organizations_serialize( self, id, - **kwargs - ): - """Get Organizations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_organizations(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/admin/organizations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def patch_entity_cookie_security_configurations( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCookieSecurityConfigurationOutDocument: + """Patch CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_patch_document: (required) + :type json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_patch_document=json_api_cookie_security_configuration_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_cookie_security_configurations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCookieSecurityConfigurationOutDocument]: + """Patch CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_patch_document: (required) + :type json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_patch_document=json_api_cookie_security_configuration_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def patch_entity_cookie_security_configurations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_patch_document: (required) + :type json_api_cookie_security_configuration_patch_document: JsonApiCookieSecurityConfigurationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_patch_document=json_api_cookie_security_configuration_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_organizations_endpoint.call_with_http_info(**kwargs) + return response_data.response - def patch_entity_cookie_security_configurations( + + def _patch_entity_cookie_security_configurations_serialize( self, id, json_api_cookie_security_configuration_patch_document, - **kwargs - ): - """Patch CookieSecurityConfiguration # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_cookie_security_configuration_patch_document (JsonApiCookieSecurityConfigurationPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCookieSecurityConfigurationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_cookie_security_configuration_patch_document is not None: + _body_params = json_api_cookie_security_configuration_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def patch_entity_organizations( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_patch_document: JsonApiOrganizationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationOutDocument: + """Patch Organization + + + :param id: (required) + :type id: str + :param json_api_organization_patch_document: (required) + :type json_api_organization_patch_document: JsonApiOrganizationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organizations_serialize( + id=id, + json_api_organization_patch_document=json_api_organization_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_organizations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_patch_document: JsonApiOrganizationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationOutDocument]: + """Patch Organization + + + :param id: (required) + :type id: str + :param json_api_organization_patch_document: (required) + :type json_api_organization_patch_document: JsonApiOrganizationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organizations_serialize( + id=id, + json_api_organization_patch_document=json_api_organization_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def patch_entity_organizations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_patch_document: JsonApiOrganizationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Organization + + + :param id: (required) + :type id: str + :param json_api_organization_patch_document: (required) + :type json_api_organization_patch_document: JsonApiOrganizationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organizations_serialize( + id=id, + json_api_organization_patch_document=json_api_organization_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_cookie_security_configuration_patch_document'] = \ - json_api_cookie_security_configuration_patch_document - return self.patch_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) - def patch_entity_organizations( + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_organizations_serialize( self, id, json_api_organization_patch_document, - **kwargs - ): - """Patch Organization # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_organizations(id, json_api_organization_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_patch_document (JsonApiOrganizationPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_patch_document is not None: + _body_params = json_api_organization_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/admin/organizations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def update_entity_cookie_security_configurations( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCookieSecurityConfigurationOutDocument: + """Put CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_in_document: (required) + :type json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_in_document=json_api_cookie_security_configuration_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_cookie_security_configurations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCookieSecurityConfigurationOutDocument]: + """Put CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_in_document: (required) + :type json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_in_document=json_api_cookie_security_configuration_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def update_entity_cookie_security_configurations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put CookieSecurityConfiguration + + + :param id: (required) + :type id: str + :param json_api_cookie_security_configuration_in_document: (required) + :type json_api_cookie_security_configuration_in_document: JsonApiCookieSecurityConfigurationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_cookie_security_configurations_serialize( + id=id, + json_api_cookie_security_configuration_in_document=json_api_cookie_security_configuration_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_patch_document'] = \ - json_api_organization_patch_document - return self.patch_entity_organizations_endpoint.call_with_http_info(**kwargs) - def update_entity_cookie_security_configurations( + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCookieSecurityConfigurationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_cookie_security_configurations_serialize( self, id, json_api_cookie_security_configuration_in_document, - **kwargs - ): - """Put CookieSecurityConfiguration # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_cookie_security_configuration_in_document (JsonApiCookieSecurityConfigurationInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCookieSecurityConfigurationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_cookie_security_configuration_in_document is not None: + _body_params = json_api_cookie_security_configuration_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_entity_organizations( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_in_document: JsonApiOrganizationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationOutDocument: + """Put Organization + + + :param id: (required) + :type id: str + :param json_api_organization_in_document: (required) + :type json_api_organization_in_document: JsonApiOrganizationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organizations_serialize( + id=id, + json_api_organization_in_document=json_api_organization_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_organizations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_in_document: JsonApiOrganizationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationOutDocument]: + """Put Organization + + + :param id: (required) + :type id: str + :param json_api_organization_in_document: (required) + :type json_api_organization_in_document: JsonApiOrganizationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organizations_serialize( + id=id, + json_api_organization_in_document=json_api_organization_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def update_entity_organizations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_in_document: JsonApiOrganizationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Organization + + + :param id: (required) + :type id: str + :param json_api_organization_in_document: (required) + :type json_api_organization_in_document: JsonApiOrganizationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organizations_serialize( + id=id, + json_api_organization_in_document=json_api_organization_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_cookie_security_configuration_in_document'] = \ - json_api_cookie_security_configuration_in_document - return self.update_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + return response_data.response - def update_entity_organizations( + + def _update_entity_organizations_serialize( self, id, json_api_organization_in_document, - **kwargs - ): - """Put Organization # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_organizations(id, json_api_organization_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_in_document (JsonApiOrganizationInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_in_document is not None: + _body_params = json_api_organization_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/admin/organizations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_in_document'] = \ - json_api_organization_in_document - return self.update_entity_organizations_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/organization_declarative_apis_api.py b/gooddata-api-client/gooddata_api_client/api/organization_declarative_apis_api.py index 8478f9bd3..9c4eda995 100644 --- a/gooddata-api-client/gooddata_api_client/api/organization_declarative_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/organization_declarative_apis_api.py @@ -1,302 +1,568 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictStr, field_validator +from typing import List, Optional +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class OrganizationDeclarativeAPIsApi(object): +class OrganizationDeclarativeAPIsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_organization_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeOrganization,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/organization', - 'operation_id': 'get_organization_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'exclude', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'exclude': - ([str],), - }, - 'attribute_map': { - 'exclude': 'exclude', - }, - 'location_map': { - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.set_organization_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/organization', - 'operation_id': 'set_organization_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_organization', - ], - 'required': [ - 'declarative_organization', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_organization': - (DeclarativeOrganization,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_organization': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def get_organization_layout( self, - **kwargs - ): - """Get organization layout # noqa: E501 - - Retrieve complete layout of organization, workspaces, user-groups, etc. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_organization_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeOrganization - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeOrganization: + """Get organization layout + + Retrieve complete layout of organization, workspaces, user-groups, etc. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeOrganization", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_organization_layout_with_http_info( + self, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeOrganization]: + """Get organization layout + + Retrieve complete layout of organization, workspaces, user-groups, etc. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeOrganization", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def get_organization_layout_without_preload_content( + self, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get organization layout + + Retrieve complete layout of organization, workspaces, user-groups, etc. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeOrganization", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _get_organization_layout_serialize( + self, + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/organization', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_organization_layout_endpoint.call_with_http_info(**kwargs) + + + + @validate_call def set_organization_layout( self, - declarative_organization, - **kwargs - ): - """Set organization layout # noqa: E501 - - Sets complete layout of organization, like workspaces, user-groups, etc. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_organization_layout(declarative_organization, async_req=True) - >>> result = thread.get() - - Args: - declarative_organization (DeclarativeOrganization): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + declarative_organization: DeclarativeOrganization, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set organization layout + + Sets complete layout of organization, like workspaces, user-groups, etc. + + :param declarative_organization: (required) + :type declarative_organization: DeclarativeOrganization + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_layout_serialize( + declarative_organization=declarative_organization, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_organization_layout_with_http_info( + self, + declarative_organization: DeclarativeOrganization, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set organization layout + + Sets complete layout of organization, like workspaces, user-groups, etc. + + :param declarative_organization: (required) + :type declarative_organization: DeclarativeOrganization + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_layout_serialize( + declarative_organization=declarative_organization, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def set_organization_layout_without_preload_content( + self, + declarative_organization: DeclarativeOrganization, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set organization layout + + Sets complete layout of organization, like workspaces, user-groups, etc. + + :param declarative_organization: (required) + :type declarative_organization: DeclarativeOrganization + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_layout_serialize( + declarative_organization=declarative_organization, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _set_organization_layout_serialize( + self, + declarative_organization, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_organization is not None: + _body_params = declarative_organization + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/organization', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_organization'] = \ - declarative_organization - return self.set_organization_layout_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/organization_entity_apis_api.py b/gooddata-api-client/gooddata_api_client/api/organization_entity_apis_api.py index f9a79997b..5ef1cea29 100644 --- a/gooddata-api-client/gooddata_api_client/api/organization_entity_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/organization_entity_apis_api.py @@ -1,1596 +1,2996 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - + Generated by OpenAPI Generator (https://openapi-generator.tech) -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument - - -class OrganizationEntityAPIsApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class OrganizationEntityAPIsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings', - 'operation_id': 'create_entity_organization_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_organization_setting_in_document', - ], - 'required': [ - 'json_api_organization_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_organization_setting_in_document': - (JsonApiOrganizationSettingInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_organization_setting_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'delete_entity_organization_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings', - 'operation_id': 'get_all_entities_organization_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'get_entity_organization_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_organizations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'get_entity_organizations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_organization_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/organization', - 'operation_id': 'get_organization', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all" - }, - }, - 'openapi_types': { - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'patch_entity_organization_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_setting_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_organization_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_setting_patch_document': - (JsonApiOrganizationSettingPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_setting_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_organizations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'patch_entity_organizations', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_organization_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_patch_document': - (JsonApiOrganizationPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'update_entity_organization_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_setting_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_organization_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_setting_in_document': - (JsonApiOrganizationSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_organizations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'update_entity_organizations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_organization_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_in_document': - (JsonApiOrganizationInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_organization_settings( + self, + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Post Organization Setting entities + + + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_organization_settings_serialize( + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_organization_settings_with_http_info( + self, + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Post Organization Setting entities + + + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_organization_settings_serialize( + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_organization_settings_without_preload_content( + self, + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Organization Setting entities + + + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_organization_settings_serialize( + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_organization_settings_serialize( self, json_api_organization_setting_in_document, - **kwargs - ): - """Post Organization Setting entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_organization_settings(json_api_organization_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_organization_setting_in_document'] = \ - json_api_organization_setting_in_document - return self.create_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_setting_in_document is not None: + _body_params = json_api_organization_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/organizationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_organization_settings( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_organization_settings_serialize( self, id, - **kwargs - ): - """Delete Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_organization_settings(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_organization_settings( self, - **kwargs - ): - """Get Organization entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_organization_settings(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_organization_settings_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutList: + """Get Organization entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_organization_settings_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_organization_settings_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutList]: + """Get Organization entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_organization_settings_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_organization_settings_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Organization entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_organization_settings_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_organization_settings_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/organizationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_organization_settings( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Get Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Get Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_organization_settings_serialize( self, id, - **kwargs - ): - """Get Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_organization_settings(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_organizations( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationOutDocument: + """Get Organizations + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organizations_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_organizations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationOutDocument]: + """Get Organizations + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organizations_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_organizations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Organizations + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organizations_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_organizations_serialize( self, id, - **kwargs - ): - """Get Organizations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_organizations(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_organizations_endpoint.call_with_http_info(**kwargs) + filter, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/admin/organizations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_organization( self, - **kwargs - ): - """Get current organization info # noqa: E501 - - Gets a basic information about organization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_organization(async_req=True) - >>> result = thread.get() - - - Keyword Args: - meta_include ([str]): Return list of permissions available to logged user.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_organization_endpoint.call_with_http_info(**kwargs) + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Return list of permissions available to logged user.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Get current organization info + + Gets a basic information about organization. + + :param meta_include: Return list of permissions available to logged user. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_serialize( + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '302': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_organization_with_http_info( + self, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Return list of permissions available to logged user.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Get current organization info + + Gets a basic information about organization. + + :param meta_include: Return list of permissions available to logged user. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_serialize( + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '302': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_organization_without_preload_content( + self, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Return list of permissions available to logged user.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get current organization info + + Gets a basic information about organization. + + :param meta_include: Return list of permissions available to logged user. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_serialize( + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '302': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_organization_serialize( + self, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/organization', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_organization_settings( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Patch Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_patch_document: (required) + :type json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_patch_document=json_api_organization_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Patch Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_patch_document: (required) + :type json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_patch_document=json_api_organization_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_patch_document: (required) + :type json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_patch_document=json_api_organization_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_organization_settings_serialize( self, id, json_api_organization_setting_patch_document, - **kwargs - ): - """Patch Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_organization_settings(id, json_api_organization_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_setting_patch_document (JsonApiOrganizationSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_setting_patch_document'] = \ - json_api_organization_setting_patch_document - return self.patch_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_setting_patch_document is not None: + _body_params = json_api_organization_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_organizations( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_patch_document: JsonApiOrganizationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationOutDocument: + """Patch Organization + + + :param id: (required) + :type id: str + :param json_api_organization_patch_document: (required) + :type json_api_organization_patch_document: JsonApiOrganizationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organizations_serialize( + id=id, + json_api_organization_patch_document=json_api_organization_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_organizations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_patch_document: JsonApiOrganizationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationOutDocument]: + """Patch Organization + + + :param id: (required) + :type id: str + :param json_api_organization_patch_document: (required) + :type json_api_organization_patch_document: JsonApiOrganizationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organizations_serialize( + id=id, + json_api_organization_patch_document=json_api_organization_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_organizations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_patch_document: JsonApiOrganizationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Organization + + + :param id: (required) + :type id: str + :param json_api_organization_patch_document: (required) + :type json_api_organization_patch_document: JsonApiOrganizationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organizations_serialize( + id=id, + json_api_organization_patch_document=json_api_organization_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_organizations_serialize( self, id, json_api_organization_patch_document, - **kwargs - ): - """Patch Organization # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_organizations(id, json_api_organization_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_patch_document (JsonApiOrganizationPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_patch_document'] = \ - json_api_organization_patch_document - return self.patch_entity_organizations_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_patch_document is not None: + _body_params = json_api_organization_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/admin/organizations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_organization_settings( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Put Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Put Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_organization_settings_serialize( self, id, json_api_organization_setting_in_document, - **kwargs - ): - """Put Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_organization_settings(id, json_api_organization_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_setting_in_document'] = \ - json_api_organization_setting_in_document - return self.update_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_setting_in_document is not None: + _body_params = json_api_organization_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_organizations( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_in_document: JsonApiOrganizationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationOutDocument: + """Put Organization + + + :param id: (required) + :type id: str + :param json_api_organization_in_document: (required) + :type json_api_organization_in_document: JsonApiOrganizationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organizations_serialize( + id=id, + json_api_organization_in_document=json_api_organization_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_organizations_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_in_document: JsonApiOrganizationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationOutDocument]: + """Put Organization + + + :param id: (required) + :type id: str + :param json_api_organization_in_document: (required) + :type json_api_organization_in_document: JsonApiOrganizationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organizations_serialize( + id=id, + json_api_organization_in_document=json_api_organization_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_organizations_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_in_document: JsonApiOrganizationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Organization + + + :param id: (required) + :type id: str + :param json_api_organization_in_document: (required) + :type json_api_organization_in_document: JsonApiOrganizationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organizations_serialize( + id=id, + json_api_organization_in_document=json_api_organization_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_organizations_serialize( self, id, json_api_organization_in_document, - **kwargs - ): - """Put Organization # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_organizations(id, json_api_organization_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_in_document (JsonApiOrganizationInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_in_document'] = \ - json_api_organization_in_document - return self.update_entity_organizations_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_in_document is not None: + _body_params = json_api_organization_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/admin/organizations/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py b/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py index f0093d969..56cb85d5d 100644 --- a/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py @@ -1,13241 +1,25665 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList -from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument -from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList -from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument -from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList -from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument -from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList -from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument -from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList -from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument -from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument -from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList -from gooddata_api_client.model.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument -from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList -from gooddata_api_client.model.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument -from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument -from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument -from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument - - -class OrganizationModelControllerApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.models.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.models.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.models.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.models.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from gooddata_api_client.models.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.models.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.models.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +from gooddata_api_client.models.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.models.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class OrganizationModelControllerApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes', - 'operation_id': 'create_entity_color_palettes', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_color_palette_in_document', - ], - 'required': [ - 'json_api_color_palette_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_color_palette_in_document': - (JsonApiColorPaletteInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_color_palette_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives', - 'operation_id': 'create_entity_csp_directives', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_csp_directive_in_document', - ], - 'required': [ - 'json_api_csp_directive_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_csp_directive_in_document': - (JsonApiCspDirectiveInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_csp_directive_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources', - 'operation_id': 'create_entity_data_sources', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_data_source_in_document', - 'meta_include', - ], - 'required': [ - 'json_api_data_source_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_data_source_in_document': - (JsonApiDataSourceInDocument,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'json_api_data_source_in_document': 'body', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates', - 'operation_id': 'create_entity_export_templates', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_export_template_post_optional_id_document', - ], - 'required': [ - 'json_api_export_template_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_export_template_post_optional_id_document': - (JsonApiExportTemplatePostOptionalIdDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_export_template_post_optional_id_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders', - 'operation_id': 'create_entity_identity_providers', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_identity_provider_in_document', - ], - 'required': [ - 'json_api_identity_provider_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_identity_provider_in_document': - (JsonApiIdentityProviderInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_identity_provider_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks', - 'operation_id': 'create_entity_jwks', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_jwk_in_document', - ], - 'required': [ - 'json_api_jwk_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_jwk_in_document': - (JsonApiJwkInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_jwk_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints', - 'operation_id': 'create_entity_llm_endpoints', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_llm_endpoint_in_document', - ], - 'required': [ - 'json_api_llm_endpoint_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_llm_endpoint_in_document': - (JsonApiLlmEndpointInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_llm_endpoint_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels', - 'operation_id': 'create_entity_notification_channels', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_notification_channel_post_optional_id_document', - ], - 'required': [ - 'json_api_notification_channel_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_notification_channel_post_optional_id_document': - (JsonApiNotificationChannelPostOptionalIdDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_notification_channel_post_optional_id_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings', - 'operation_id': 'create_entity_organization_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_organization_setting_in_document', - ], - 'required': [ - 'json_api_organization_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_organization_setting_in_document': - (JsonApiOrganizationSettingInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_organization_setting_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes', - 'operation_id': 'create_entity_themes', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_theme_in_document', - ], - 'required': [ - 'json_api_theme_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_theme_in_document': - (JsonApiThemeInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_theme_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups', - 'operation_id': 'create_entity_user_groups', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_user_group_in_document', - 'include', - ], - 'required': [ - 'json_api_user_group_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_user_group_in_document': - (JsonApiUserGroupInDocument,), - 'include': - ([str],), - }, - 'attribute_map': { - 'include': 'include', - }, - 'location_map': { - 'json_api_user_group_in_document': 'body', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users', - 'operation_id': 'create_entity_users', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_user_in_document', - 'include', - ], - 'required': [ - 'json_api_user_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_user_in_document': - (JsonApiUserInDocument,), - 'include': - ([str],), - }, - 'attribute_map': { - 'include': 'include', - }, - 'location_map': { - 'json_api_user_in_document': 'body', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces', - 'operation_id': 'create_entity_workspaces', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_workspace_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'json_api_workspace_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - ('meta_include',): { - - "CONFIG": "config", - "PERMISSIONS": "permissions", - "HIERARCHY": "hierarchy", - "DATAMODELDATASETS": "dataModelDatasets", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_workspace_in_document': - (JsonApiWorkspaceInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'json_api_workspace_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'delete_entity_color_palettes', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'delete_entity_csp_directives', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'delete_entity_data_sources', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'delete_entity_export_templates', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'delete_entity_identity_providers', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'delete_entity_jwks', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'delete_entity_llm_endpoints', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'delete_entity_notification_channels', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'delete_entity_organization_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'delete_entity_themes', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'delete_entity_user_groups', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'delete_entity_users', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'delete_entity_workspaces', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes', - 'operation_id': 'get_all_entities_color_palettes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives', - 'operation_id': 'get_all_entities_csp_directives', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_data_source_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceIdentifierOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers', - 'operation_id': 'get_all_entities_data_source_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources', - 'operation_id': 'get_all_entities_data_sources', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_entitlements_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiEntitlementOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/entitlements', - 'operation_id': 'get_all_entities_entitlements', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates', - 'operation_id': 'get_all_entities_export_templates', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders', - 'operation_id': 'get_all_entities_identity_providers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks', - 'operation_id': 'get_all_entities_jwks', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints', - 'operation_id': 'get_all_entities_llm_endpoints', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_notification_channel_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelIdentifierOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers', - 'operation_id': 'get_all_entities_notification_channel_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels', - 'operation_id': 'get_all_entities_notification_channels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings', - 'operation_id': 'get_all_entities_organization_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes', - 'operation_id': 'get_all_entities_themes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups', - 'operation_id': 'get_all_entities_user_groups', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserIdentifierOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userIdentifiers', - 'operation_id': 'get_all_entities_user_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users', - 'operation_id': 'get_all_entities_users', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces', - 'operation_id': 'get_all_entities_workspaces', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - ('meta_include',): { - - "CONFIG": "config", - "PERMISSIONS": "permissions", - "HIERARCHY": "hierarchy", - "DATAMODELDATASETS": "dataModelDatasets", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'get_entity_color_palettes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'get_entity_csp_directives', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_data_source_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceIdentifierOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers/{id}', - 'operation_id': 'get_entity_data_source_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'get_entity_data_sources', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_entitlements_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiEntitlementOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/entitlements/{id}', - 'operation_id': 'get_entity_entitlements', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'get_entity_export_templates', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'get_entity_identity_providers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'get_entity_jwks', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'get_entity_llm_endpoints', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_notification_channel_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelIdentifierOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers/{id}', - 'operation_id': 'get_entity_notification_channel_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'get_entity_notification_channels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'get_entity_organization_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'get_entity_themes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'get_entity_user_groups', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserIdentifierOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userIdentifiers/{id}', - 'operation_id': 'get_entity_user_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'get_entity_users', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'get_entity_workspaces', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - ('meta_include',): { - - "CONFIG": "config", - "PERMISSIONS": "permissions", - "HIERARCHY": "hierarchy", - "DATAMODELDATASETS": "dataModelDatasets", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'patch_entity_color_palettes', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_color_palette_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_color_palette_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_color_palette_patch_document': - (JsonApiColorPalettePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_color_palette_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'patch_entity_csp_directives', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_csp_directive_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_csp_directive_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_csp_directive_patch_document': - (JsonApiCspDirectivePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_csp_directive_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'patch_entity_data_sources', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_data_source_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_data_source_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_data_source_patch_document': - (JsonApiDataSourcePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_data_source_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'patch_entity_export_templates', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_export_template_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_export_template_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_export_template_patch_document': - (JsonApiExportTemplatePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_export_template_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + + + @validate_call + def create_entity_color_palettes( + self, + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Post Color Pallettes + + + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_color_palettes_serialize( + json_api_color_palette_in_document=json_api_color_palette_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_color_palettes_with_http_info( + self, + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Post Color Pallettes + + + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_color_palettes_serialize( + json_api_color_palette_in_document=json_api_color_palette_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_color_palettes_without_preload_content( + self, + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Color Pallettes + + + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_color_palettes_serialize( + json_api_color_palette_in_document=json_api_color_palette_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_color_palettes_serialize( + self, + json_api_color_palette_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_color_palette_in_document is not None: + _body_params = json_api_color_palette_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'patch_entity_identity_providers', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_identity_provider_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_identity_provider_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_identity_provider_patch_document': - (JsonApiIdentityProviderPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_identity_provider_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/colorPalettes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_csp_directives( + self, + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Post CSP Directives + + Context Security Police Directive + + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_csp_directives_serialize( + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_csp_directives_with_http_info( + self, + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Post CSP Directives + + Context Security Police Directive + + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_csp_directives_serialize( + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_csp_directives_without_preload_content( + self, + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post CSP Directives + + Context Security Police Directive + + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_csp_directives_serialize( + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_csp_directives_serialize( + self, + json_api_csp_directive_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_csp_directive_in_document is not None: + _body_params = json_api_csp_directive_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'patch_entity_jwks', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_jwk_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_jwk_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_jwk_patch_document': - (JsonApiJwkPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_jwk_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/cspDirectives', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_data_sources( + self, + json_api_data_source_in_document: JsonApiDataSourceInDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Post Data Sources + + Data Source - represents data source for the workspace + + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_data_sources_serialize( + json_api_data_source_in_document=json_api_data_source_in_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_data_sources_with_http_info( + self, + json_api_data_source_in_document: JsonApiDataSourceInDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Post Data Sources + + Data Source - represents data source for the workspace + + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_data_sources_serialize( + json_api_data_source_in_document=json_api_data_source_in_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_data_sources_without_preload_content( + self, + json_api_data_source_in_document: JsonApiDataSourceInDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Data Sources + + Data Source - represents data source for the workspace + + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_data_sources_serialize( + json_api_data_source_in_document=json_api_data_source_in_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_data_sources_serialize( + self, + json_api_data_source_in_document, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_data_source_in_document is not None: + _body_params = json_api_data_source_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'patch_entity_llm_endpoints', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_llm_endpoint_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_llm_endpoint_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_llm_endpoint_patch_document': - (JsonApiLlmEndpointPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_llm_endpoint_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/dataSources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_export_templates( + self, + json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """Post Export Template entities + + + :param json_api_export_template_post_optional_id_document: (required) + :type json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_templates_serialize( + json_api_export_template_post_optional_id_document=json_api_export_template_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_export_templates_with_http_info( + self, + json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """Post Export Template entities + + + :param json_api_export_template_post_optional_id_document: (required) + :type json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_templates_serialize( + json_api_export_template_post_optional_id_document=json_api_export_template_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_export_templates_without_preload_content( + self, + json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Export Template entities + + + :param json_api_export_template_post_optional_id_document: (required) + :type json_api_export_template_post_optional_id_document: JsonApiExportTemplatePostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_templates_serialize( + json_api_export_template_post_optional_id_document=json_api_export_template_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_export_templates_serialize( + self, + json_api_export_template_post_optional_id_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_template_post_optional_id_document is not None: + _body_params = json_api_export_template_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'patch_entity_notification_channels', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_notification_channel_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_notification_channel_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_notification_channel_patch_document': - (JsonApiNotificationChannelPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_notification_channel_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/exportTemplates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_identity_providers( + self, + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Post Identity Providers + + + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_identity_providers_serialize( + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_identity_providers_with_http_info( + self, + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Post Identity Providers + + + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_identity_providers_serialize( + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_identity_providers_without_preload_content( + self, + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Identity Providers + + + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_identity_providers_serialize( + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_identity_providers_serialize( + self, + json_api_identity_provider_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_identity_provider_in_document is not None: + _body_params = json_api_identity_provider_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'patch_entity_organization_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_setting_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_organization_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_setting_patch_document': - (JsonApiOrganizationSettingPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_setting_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/identityProviders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_jwks( + self, + json_api_jwk_in_document: JsonApiJwkInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Post Jwks + + Creates JSON web key - used to verify JSON web tokens (Jwts) + + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_jwks_serialize( + json_api_jwk_in_document=json_api_jwk_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_jwks_with_http_info( + self, + json_api_jwk_in_document: JsonApiJwkInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Post Jwks + + Creates JSON web key - used to verify JSON web tokens (Jwts) + + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_jwks_serialize( + json_api_jwk_in_document=json_api_jwk_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_jwks_without_preload_content( + self, + json_api_jwk_in_document: JsonApiJwkInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Jwks + + Creates JSON web key - used to verify JSON web tokens (Jwts) + + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_jwks_serialize( + json_api_jwk_in_document=json_api_jwk_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_jwks_serialize( + self, + json_api_jwk_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_jwk_in_document is not None: + _body_params = json_api_jwk_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'patch_entity_themes', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_theme_patch_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_theme_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_theme_patch_document': - (JsonApiThemePatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_theme_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/jwks', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_llm_endpoints( + self, + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """Post LLM endpoint entities + + + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_llm_endpoints_serialize( + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_llm_endpoints_with_http_info( + self, + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """Post LLM endpoint entities + + + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_llm_endpoints_serialize( + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_llm_endpoints_without_preload_content( + self, + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post LLM endpoint entities + + + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_llm_endpoints_serialize( + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_llm_endpoints_serialize( + self, + json_api_llm_endpoint_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_llm_endpoint_in_document is not None: + _body_params = json_api_llm_endpoint_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'patch_entity_user_groups', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_group_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_group_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_group_patch_document': - (JsonApiUserGroupPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_group_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/llmEndpoints', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_notification_channels( + self, + json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Post Notification Channel entities + + + :param json_api_notification_channel_post_optional_id_document: (required) + :type json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_notification_channels_serialize( + json_api_notification_channel_post_optional_id_document=json_api_notification_channel_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_notification_channels_with_http_info( + self, + json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Post Notification Channel entities + + + :param json_api_notification_channel_post_optional_id_document: (required) + :type json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_notification_channels_serialize( + json_api_notification_channel_post_optional_id_document=json_api_notification_channel_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_notification_channels_without_preload_content( + self, + json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Notification Channel entities + + + :param json_api_notification_channel_post_optional_id_document: (required) + :type json_api_notification_channel_post_optional_id_document: JsonApiNotificationChannelPostOptionalIdDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_notification_channels_serialize( + json_api_notification_channel_post_optional_id_document=json_api_notification_channel_post_optional_id_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_notification_channels_serialize( + self, + json_api_notification_channel_post_optional_id_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_notification_channel_post_optional_id_document is not None: + _body_params = json_api_notification_channel_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'patch_entity_users', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_patch_document': - (JsonApiUserPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/notificationChannels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_organization_settings( + self, + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Post Organization Setting entities + + + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_organization_settings_serialize( + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_organization_settings_with_http_info( + self, + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Post Organization Setting entities + + + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_organization_settings_serialize( + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_organization_settings_without_preload_content( + self, + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Organization Setting entities + + + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_organization_settings_serialize( + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_organization_settings_serialize( + self, + json_api_organization_setting_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_setting_in_document is not None: + _body_params = json_api_organization_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.patch_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'patch_entity_workspaces', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_workspace_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_workspace_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_workspace_patch_document': - (JsonApiWorkspacePatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_workspace_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/organizationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_themes( + self, + json_api_theme_in_document: JsonApiThemeInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Post Theming + + + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_themes_serialize( + json_api_theme_in_document=json_api_theme_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_themes_with_http_info( + self, + json_api_theme_in_document: JsonApiThemeInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Post Theming + + + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_themes_serialize( + json_api_theme_in_document=json_api_theme_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_themes_without_preload_content( + self, + json_api_theme_in_document: JsonApiThemeInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Theming + + + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_themes_serialize( + json_api_theme_in_document=json_api_theme_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_themes_serialize( + self, + json_api_theme_in_document, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_theme_in_document is not None: + _body_params = json_api_theme_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_color_palettes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'update_entity_color_palettes', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_color_palette_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_color_palette_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_color_palette_in_document': - (JsonApiColorPaletteInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_color_palette_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/themes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_user_groups( + self, + json_api_user_group_in_document: JsonApiUserGroupInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Post User Group entities + + User Group - creates tree-like structure for categorizing users + + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_groups_serialize( + json_api_user_group_in_document=json_api_user_group_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_user_groups_with_http_info( + self, + json_api_user_group_in_document: JsonApiUserGroupInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Post User Group entities + + User Group - creates tree-like structure for categorizing users + + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_groups_serialize( + json_api_user_group_in_document=json_api_user_group_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_user_groups_without_preload_content( + self, + json_api_user_group_in_document: JsonApiUserGroupInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post User Group entities + + User Group - creates tree-like structure for categorizing users + + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_groups_serialize( + json_api_user_group_in_document=json_api_user_group_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_user_groups_serialize( + self, + json_api_user_group_in_document, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_group_in_document is not None: + _body_params = json_api_user_group_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'update_entity_csp_directives', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_csp_directive_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_csp_directive_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_csp_directive_in_document': - (JsonApiCspDirectiveInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_csp_directive_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_users( + self, + json_api_user_in_document: JsonApiUserInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Post User entities + + User - represents entity interacting with platform + + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_users_serialize( + json_api_user_in_document=json_api_user_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_users_with_http_info( + self, + json_api_user_in_document: JsonApiUserInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Post User entities + + User - represents entity interacting with platform + + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_users_serialize( + json_api_user_in_document=json_api_user_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_users_without_preload_content( + self, + json_api_user_in_document: JsonApiUserInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post User entities + + User - represents entity interacting with platform + + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_users_serialize( + json_api_user_in_document=json_api_user_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_users_serialize( + self, + json_api_user_in_document, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_in_document is not None: + _body_params = json_api_user_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'update_entity_data_sources', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_data_source_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_data_source_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_data_source_in_document': - (JsonApiDataSourceInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_data_source_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_entity_workspaces( + self, + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Post Workspace entities + + Space of the shared interest + + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspaces_serialize( + json_api_workspace_in_document=json_api_workspace_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspaces_with_http_info( + self, + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Post Workspace entities + + Space of the shared interest + + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspaces_serialize( + json_api_workspace_in_document=json_api_workspace_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_workspaces_without_preload_content( + self, + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Workspace entities + + Space of the shared interest + + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspaces_serialize( + json_api_workspace_in_document=json_api_workspace_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspaces_serialize( + self, + json_api_workspace_in_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_in_document is not None: + _body_params = json_api_workspace_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'update_entity_export_templates', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_export_template_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_export_template_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_export_template_in_document': - (JsonApiExportTemplateInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_export_template_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_color_palettes( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_color_palettes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_color_palettes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_color_palettes_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_csp_directives_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_data_sources( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_data_sources_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_data_sources_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_data_sources_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_data_sources_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_export_templates_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_identity_providers_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Jwk + + Deletes JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Jwk + + Deletes JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Jwk + + Deletes JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_jwks_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_llm_endpoints( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """delete_entity_llm_endpoints + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_llm_endpoints_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """delete_entity_llm_endpoints + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_llm_endpoints_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """delete_entity_llm_endpoints + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_llm_endpoints_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_notification_channels( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_notification_channels_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_notification_channels_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_notification_channels_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_organization_settings( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_organization_settings_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_themes_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_groups_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_groups_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_groups_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_user_groups_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_users( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_users_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_users_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_users_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_users_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_users_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_users_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_workspaces( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspaces_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspaces_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspaces_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_workspaces_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspaces_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_workspaces_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_color_palettes( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutList: + """Get all Color Pallettes + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_color_palettes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_color_palettes_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutList]: + """Get all Color Pallettes + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_color_palettes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_color_palettes_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Color Pallettes + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_color_palettes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_color_palettes_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'update_entity_identity_providers', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_identity_provider_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_identity_provider_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_identity_provider_in_document': - (JsonApiIdentityProviderInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_identity_provider_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/colorPalettes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_csp_directives( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutList: + """Get CSP Directives + + Context Security Police Directive + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_csp_directives_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_csp_directives_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutList]: + """Get CSP Directives + + Context Security Police Directive + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_csp_directives_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_csp_directives_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get CSP Directives + + Context Security Police Directive + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_csp_directives_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_csp_directives_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'update_entity_jwks', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_jwk_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_jwk_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_jwk_in_document': - (JsonApiJwkInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_jwk_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/cspDirectives', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_data_source_identifiers( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceIdentifierOutList: + """Get all Data Source Identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_source_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_data_source_identifiers_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceIdentifierOutList]: + """Get all Data Source Identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_source_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_data_source_identifiers_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Data Source Identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_source_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_data_source_identifiers_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'update_entity_llm_endpoints', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_llm_endpoint_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_llm_endpoint_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_llm_endpoint_in_document': - (JsonApiLlmEndpointInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_llm_endpoint_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSourceIdentifiers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_data_sources( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutList: + """Get Data Source entities + + Data Source - represents data source for the workspace + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_sources_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_data_sources_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutList]: + """Get Data Source entities + + Data Source - represents data source for the workspace + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_sources_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_data_sources_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Data Source entities + + Data Source - represents data source for the workspace + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_data_sources_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_data_sources_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'update_entity_notification_channels', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_notification_channel_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_notification_channel_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_notification_channel_in_document': - (JsonApiNotificationChannelInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_notification_channel_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_entitlements( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiEntitlementOutList: + """Get Entitlements + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_entitlements_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_entitlements_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiEntitlementOutList]: + """Get Entitlements + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_entitlements_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_entitlements_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Entitlements + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_entitlements_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_entitlements_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/entitlements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_export_templates( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutList: + """GET all Export Template entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_templates_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_export_templates_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutList]: + """GET all Export Template entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_templates_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_export_templates_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """GET all Export Template entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_templates_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_export_templates_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'update_entity_organization_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_setting_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_organization_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/exportTemplates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_identity_providers( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutList: + """Get all Identity Providers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_identity_providers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_identity_providers_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutList]: + """Get all Identity Providers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_identity_providers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_identity_providers_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Identity Providers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_identity_providers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_identity_providers_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_setting_in_document': - (JsonApiOrganizationSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/identityProviders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_jwks( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutList: + """Get all Jwks + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_jwks_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_jwks_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutList]: + """Get all Jwks + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_jwks_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_jwks_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Jwks + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_jwks_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_jwks_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/jwks', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_llm_endpoints( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutList: + """Get all LLM endpoint entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_llm_endpoints_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_llm_endpoints_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutList]: + """Get all LLM endpoint entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_llm_endpoints_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_llm_endpoints_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all LLM endpoint entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_llm_endpoints_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_llm_endpoints_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'update_entity_themes', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_theme_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_theme_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/llmEndpoints', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_notification_channel_identifiers( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelIdentifierOutList: + """get_all_entities_notification_channel_identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channel_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_notification_channel_identifiers_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelIdentifierOutList]: + """get_all_entities_notification_channel_identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channel_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_notification_channel_identifiers_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_all_entities_notification_channel_identifiers + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channel_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_notification_channel_identifiers_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_theme_in_document': - (JsonApiThemeInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_theme_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannelIdentifiers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_notification_channels( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutList: + """Get all Notification Channel entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channels_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_notification_channels_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutList]: + """Get all Notification Channel entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channels_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_notification_channels_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Notification Channel entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_notification_channels_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_notification_channels_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_organization_settings( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutList: + """Get Organization entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_organization_settings_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_organization_settings_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutList]: + """Get Organization entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_organization_settings_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_organization_settings_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Organization entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_organization_settings_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_organization_settings_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'update_entity_user_groups', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_group_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_group_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/organizationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_themes( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutList: + """Get all Theming entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_themes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_themes_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutList]: + """Get all Theming entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_themes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_themes_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Theming entities + + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_themes_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_themes_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_group_in_document': - (JsonApiUserGroupInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_group_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/themes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_user_groups( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutList: + """Get UserGroup entities + + User Group - creates tree-like structure for categorizing users + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_groups_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_groups_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutList]: + """Get UserGroup entities + + User Group - creates tree-like structure for categorizing users + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_groups_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_user_groups_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserGroup entities + + User Group - creates tree-like structure for categorizing users + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_groups_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_user_groups_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_user_identifiers( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserIdentifierOutList: + """Get UserIdentifier entities + + UserIdentifier - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_identifiers_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserIdentifierOutList]: + """Get UserIdentifier entities + + UserIdentifier - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_user_identifiers_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserIdentifier entities + + UserIdentifier - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_user_identifiers_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'update_entity_users', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_in_document': - (JsonApiUserInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userIdentifiers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_users( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutList: + """Get User entities + + User - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_users_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_users_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutList]: + """Get User entities + + User - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_users_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_users_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get User entities + + User - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_users_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_users_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client - ) - self.update_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'update_entity_workspaces', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_workspace_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_workspace_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_workspace_in_document': - (JsonApiWorkspaceInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_workspace_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_workspaces( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutList: + """Get Workspace entities + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspaces_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspaces_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutList]: + """Get Workspace entities + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspaces_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_workspaces_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Workspace entities + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspaces_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_workspaces_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - def create_entity_color_palettes( - self, - json_api_color_palette_in_document, - **kwargs - ): - """Post Color Pallettes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_color_palettes(json_api_color_palette_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_color_palette_in_document (JsonApiColorPaletteInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_color_palette_in_document'] = \ - json_api_color_palette_in_document - return self.create_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def create_entity_csp_directives( - self, - json_api_csp_directive_in_document, - **kwargs - ): - """Post CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_csp_directives(json_api_csp_directive_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_csp_directive_in_document'] = \ - json_api_csp_directive_in_document - return self.create_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def create_entity_data_sources( - self, - json_api_data_source_in_document, - **kwargs - ): - """Post Data Sources # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_data_sources(json_api_data_source_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_data_source_in_document (JsonApiDataSourceInDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_data_source_in_document'] = \ - json_api_data_source_in_document - return self.create_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def create_entity_export_templates( + @validate_call + def get_entity_color_palettes( self, - json_api_export_template_post_optional_id_document, - **kwargs - ): - """Post Export Template entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_export_template_post_optional_id_document'] = \ - json_api_export_template_post_optional_id_document - return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) - - def create_entity_identity_providers( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Get Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_color_palettes_with_http_info( self, - json_api_identity_provider_in_document, - **kwargs - ): - """Post Identity Providers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_identity_providers(json_api_identity_provider_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_identity_provider_in_document'] = \ - json_api_identity_provider_in_document - return self.create_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - - def create_entity_jwks( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Get Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_color_palettes_without_preload_content( self, - json_api_jwk_in_document, - **kwargs - ): - """Post Jwks # noqa: E501 - - Creates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_jwks(json_api_jwk_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_jwk_in_document (JsonApiJwkInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.create_entity_jwks_endpoint.call_with_http_info(**kwargs) - - def create_entity_llm_endpoints( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Color Pallette + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_color_palettes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_color_palettes_serialize( self, - json_api_llm_endpoint_in_document, - **kwargs - ): - """Post LLM endpoint entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_llm_endpoints(json_api_llm_endpoint_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_llm_endpoint_in_document (JsonApiLlmEndpointInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_llm_endpoint_in_document'] = \ - json_api_llm_endpoint_in_document - return self.create_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def create_entity_notification_channels( - self, - json_api_notification_channel_post_optional_id_document, - **kwargs - ): - """Post Notification Channel entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_notification_channel_post_optional_id_document (JsonApiNotificationChannelPostOptionalIdDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_notification_channel_post_optional_id_document'] = \ - json_api_notification_channel_post_optional_id_document - return self.create_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def create_entity_organization_settings( - self, - json_api_organization_setting_in_document, - **kwargs - ): - """Post Organization Setting entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_organization_settings(json_api_organization_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_organization_setting_in_document'] = \ - json_api_organization_setting_in_document - return self.create_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def create_entity_themes( - self, - json_api_theme_in_document, - **kwargs - ): - """Post Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_themes(json_api_theme_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_theme_in_document (JsonApiThemeInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_theme_in_document'] = \ - json_api_theme_in_document - return self.create_entity_themes_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def create_entity_user_groups( - self, - json_api_user_group_in_document, - **kwargs - ): - """Post User Group entities # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_user_groups(json_api_user_group_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_user_group_in_document (JsonApiUserGroupInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_group_in_document'] = \ - json_api_user_group_in_document - return self.create_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def create_entity_users( - self, - json_api_user_in_document, - **kwargs - ): - """Post User entities # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_users(json_api_user_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_user_in_document (JsonApiUserInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_in_document'] = \ - json_api_user_in_document - return self.create_entity_users_endpoint.call_with_http_info(**kwargs) - def create_entity_workspaces( - self, - json_api_workspace_in_document, - **kwargs - ): - """Post Workspace entities # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspaces(json_api_workspace_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_workspace_in_document (JsonApiWorkspaceInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_workspace_in_document'] = \ - json_api_workspace_in_document - return self.create_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def delete_entity_color_palettes( + @validate_call + def get_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Get CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Get CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_csp_directives_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_csp_directives_serialize( self, id, - **kwargs - ): - """Delete a Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_color_palettes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_csp_directives( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_data_source_identifiers( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceIdentifierOutDocument: + """Get Data Source Identifier + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_source_identifiers_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_data_source_identifiers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceIdentifierOutDocument]: + """Get Data Source Identifier + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_source_identifiers_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_data_source_identifiers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Data Source Identifier + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_source_identifiers_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_data_source_identifiers_serialize( self, id, - **kwargs - ): - """Delete CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_csp_directives(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + filter, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_data_sources( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSourceIdentifiers/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_data_sources( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Get Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_sources_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Get Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_sources_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_data_sources_serialize( + id=id, + filter=filter, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_data_sources_serialize( self, id, - **kwargs - ): - """Delete Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_data_sources(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_data_sources_endpoint.call_with_http_info(**kwargs) + filter, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_export_templates( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_entitlements( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiEntitlementOutDocument: + """Get Entitlement + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_entitlements_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_entitlements_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiEntitlementOutDocument]: + """Get Entitlement + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_entitlements_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_entitlements_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Entitlement + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_entitlements_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiEntitlementOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_entitlements_serialize( self, id, - **kwargs - ): - """Delete Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_export_templates(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_identity_providers( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/entitlements/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """GET Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """GET Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """GET Export Template entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_templates_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_export_templates_serialize( self, id, - **kwargs - ): - """Delete Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_identity_providers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_jwks( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Get Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Get Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Identity Provider + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_identity_providers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_identity_providers_serialize( self, id, - **kwargs - ): - """Delete Jwk # noqa: E501 - - Deletes JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_jwks(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_jwks_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_llm_endpoints( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Get Jwk + + Returns JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Get Jwk + + Returns JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Jwk + + Returns JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_jwks_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_jwks_serialize( self, id, - **kwargs - ): - """delete_entity_llm_endpoints # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_llm_endpoints(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_notification_channels( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_llm_endpoints( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """Get LLM endpoint entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_llm_endpoints_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """Get LLM endpoint entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_llm_endpoints_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get LLM endpoint entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_llm_endpoints_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_llm_endpoints_serialize( self, id, - **kwargs - ): - """Delete Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_notification_channels(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_organization_settings( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_notification_channel_identifiers( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelIdentifierOutDocument: + """get_entity_notification_channel_identifiers + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channel_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_notification_channel_identifiers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelIdentifierOutDocument]: + """get_entity_notification_channel_identifiers + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channel_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_notification_channel_identifiers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_entity_notification_channel_identifiers + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channel_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_notification_channel_identifiers_serialize( self, id, - **kwargs - ): - """Delete Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_organization_settings(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_themes( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannelIdentifiers/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_notification_channels( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Get Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_notification_channels_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Get Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_notification_channels_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Notification Channel entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_notification_channels_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_notification_channels_serialize( self, id, - **kwargs - ): - """Delete Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_themes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_themes_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_user_groups( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_organization_settings( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Get Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Get Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Organization entity + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_organization_settings_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_organization_settings_serialize( self, id, - **kwargs - ): - """Delete UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_user_groups(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_user_groups_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_users( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Get Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Get Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Theming + + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_themes_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_themes_serialize( self, id, - **kwargs - ): - """Delete User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_users(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_users_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def delete_entity_workspaces( + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Get UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_groups_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Get UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_groups_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_groups_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_groups_serialize( self, id, - **kwargs - ): - """Delete Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspaces(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_workspaces_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_all_entities_color_palettes( - self, - **kwargs - ): - """Get all Color Pallettes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_color_palettes(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_csp_directives( - self, - **kwargs - ): - """Get CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_csp_directives(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_csp_directives_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def get_all_entities_data_source_identifiers( - self, - **kwargs - ): - """Get all Data Source Identifiers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_data_source_identifiers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceIdentifierOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_all_entities_data_sources( - self, - **kwargs - ): - """Get Data Source entities # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_data_sources(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) - def get_all_entities_entitlements( - self, - **kwargs - ): - """Get Entitlements # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_entitlements(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiEntitlementOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) - def get_all_entities_export_templates( - self, - **kwargs - ): - """GET all Export Template entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_export_templates(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) - def get_all_entities_identity_providers( + @validate_call + def get_entity_user_identifiers( self, - **kwargs - ): - """Get all Identity Providers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_identity_providers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_identity_providers_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_jwks( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserIdentifierOutDocument: + """Get UserIdentifier entity + + UserIdentifier - represents basic information about entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_identifiers_with_http_info( self, - **kwargs - ): - """Get all Jwks # noqa: E501 - - Returns all JSON web keys - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_jwks(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_jwks_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_llm_endpoints( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserIdentifierOutDocument]: + """Get UserIdentifier entity + + UserIdentifier - represents basic information about entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_user_identifiers_without_preload_content( self, - **kwargs - ): - """Get all LLM endpoint entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_llm_endpoints(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_llm_endpoints_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_notification_channel_identifiers( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserIdentifier entity + + UserIdentifier - represents basic information about entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_identifiers_serialize( self, - **kwargs - ): - """get_all_entities_notification_channel_identifiers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_notification_channel_identifiers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelIdentifierOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_all_entities_notification_channels( - self, - **kwargs - ): - """Get all Notification Channel entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_notification_channels(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channels_endpoint.call_with_http_info(**kwargs) - def get_all_entities_organization_settings( - self, - **kwargs - ): - """Get Organization entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_organization_settings(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_organization_settings_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def get_all_entities_themes( - self, - **kwargs - ): - """Get all Theming entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_themes(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_themes_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userIdentifiers/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_all_entities_user_groups( - self, - **kwargs - ): - """Get UserGroup entities # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_groups(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_groups_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_identifiers( - self, - **kwargs - ): - """Get UserIdentifier entities # noqa: E501 - - UserIdentifier - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_identifiers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserIdentifierOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_identifiers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_users( - self, - **kwargs - ): - """Get User entities # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_users(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_users_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspaces( + @validate_call + def get_entity_users( self, - **kwargs - ): - """Get Workspace entities # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspaces(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_workspaces_endpoint.call_with_http_info(**kwargs) - - def get_entity_color_palettes( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Get User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_users_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_users_with_http_info( self, - id, - **kwargs - ): - """Get Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_color_palettes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - - def get_entity_csp_directives( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Get User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_users_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_users_without_preload_content( self, - id, - **kwargs - ): - """Get CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_csp_directives(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - - def get_entity_data_source_identifiers( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_users_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_users_serialize( self, id, - **kwargs - ): - """Get Data Source Identifier # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_data_source_identifiers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceIdentifierOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_entity_data_sources( - self, - id, - **kwargs - ): - """Get Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_data_sources(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def get_entity_entitlements( - self, - id, - **kwargs - ): - """Get Entitlement # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_entitlements(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiEntitlementOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_entitlements_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def get_entity_export_templates( - self, - id, - **kwargs - ): - """GET Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_export_templates(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_export_templates_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_entity_identity_providers( - self, - id, - **kwargs - ): - """Get Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_identity_providers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def get_entity_jwks( - self, - id, - **kwargs - ): - """Get Jwk # noqa: E501 - - Returns JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_jwks(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_jwks_endpoint.call_with_http_info(**kwargs) - def get_entity_llm_endpoints( - self, - id, - **kwargs - ): - """Get LLM endpoint entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_llm_endpoints(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def get_entity_notification_channel_identifiers( + @validate_call + def get_entity_workspaces( self, - id, - **kwargs - ): - """get_entity_notification_channel_identifiers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_notification_channel_identifiers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelIdentifierOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) - - def get_entity_notification_channels( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Get Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspaces_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspaces_with_http_info( self, - id, - **kwargs - ): - """Get Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_notification_channels(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - - def get_entity_organization_settings( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Get Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspaces_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_workspaces_without_preload_content( self, - id, - **kwargs - ): - """Get Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_organization_settings(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - - def get_entity_themes( + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspaces_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_workspaces_serialize( self, id, - **kwargs - ): - """Get Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_themes(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_themes_endpoint.call_with_http_info(**kwargs) + filter, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_entity_user_groups( - self, - id, - **kwargs - ): - """Get UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_groups(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def get_entity_user_identifiers( - self, - id, - **kwargs - ): - """Get UserIdentifier entity # noqa: E501 - - UserIdentifier - represents basic information about entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_identifiers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserIdentifierOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_user_identifiers_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_entity_users( - self, - id, - **kwargs - ): - """Get User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_users(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_users_endpoint.call_with_http_info(**kwargs) - def get_entity_workspaces( - self, - id, - **kwargs - ): - """Get Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspaces(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_workspaces_endpoint.call_with_http_info(**kwargs) + + @validate_call def patch_entity_color_palettes( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Patch Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_patch_document: (required) + :type json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_color_palettes_serialize( + id=id, + json_api_color_palette_patch_document=json_api_color_palette_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_color_palettes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Patch Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_patch_document: (required) + :type json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_color_palettes_serialize( + id=id, + json_api_color_palette_patch_document=json_api_color_palette_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_color_palettes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_patch_document: (required) + :type json_api_color_palette_patch_document: JsonApiColorPalettePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_color_palettes_serialize( + id=id, + json_api_color_palette_patch_document=json_api_color_palette_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_color_palettes_serialize( self, id, json_api_color_palette_patch_document, - **kwargs - ): - """Patch Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_color_palettes(id, json_api_color_palette_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_color_palette_patch_document (JsonApiColorPalettePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_color_palette_patch_document'] = \ - json_api_color_palette_patch_document - return self.patch_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_color_palette_patch_document is not None: + _body_params = json_api_color_palette_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Patch CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_patch_document: (required) + :type json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_patch_document=json_api_csp_directive_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Patch CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_patch_document: (required) + :type json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_patch_document=json_api_csp_directive_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_patch_document: (required) + :type json_api_csp_directive_patch_document: JsonApiCspDirectivePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_patch_document=json_api_csp_directive_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_csp_directives_serialize( self, id, json_api_csp_directive_patch_document, - **kwargs - ): - """Patch CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_csp_directive_patch_document (JsonApiCspDirectivePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_csp_directive_patch_document'] = \ - json_api_csp_directive_patch_document - return self.patch_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_csp_directive_patch_document is not None: + _body_params = json_api_csp_directive_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_data_sources( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_patch_document: JsonApiDataSourcePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Patch Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_patch_document: (required) + :type json_api_data_source_patch_document: JsonApiDataSourcePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_data_sources_serialize( + id=id, + json_api_data_source_patch_document=json_api_data_source_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_patch_document: JsonApiDataSourcePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Patch Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_patch_document: (required) + :type json_api_data_source_patch_document: JsonApiDataSourcePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_data_sources_serialize( + id=id, + json_api_data_source_patch_document=json_api_data_source_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_patch_document: JsonApiDataSourcePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_patch_document: (required) + :type json_api_data_source_patch_document: JsonApiDataSourcePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_data_sources_serialize( + id=id, + json_api_data_source_patch_document=json_api_data_source_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_data_sources_serialize( self, id, json_api_data_source_patch_document, - **kwargs - ): - """Patch Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_data_sources(id, json_api_data_source_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_data_source_patch_document (JsonApiDataSourcePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_data_source_patch_document'] = \ - json_api_data_source_patch_document - return self.patch_entity_data_sources_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_data_source_patch_document is not None: + _body_params = json_api_data_source_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """Patch Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_patch_document: (required) + :type json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_templates_serialize( + id=id, + json_api_export_template_patch_document=json_api_export_template_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """Patch Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_patch_document: (required) + :type json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_templates_serialize( + id=id, + json_api_export_template_patch_document=json_api_export_template_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_patch_document: (required) + :type json_api_export_template_patch_document: JsonApiExportTemplatePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_templates_serialize( + id=id, + json_api_export_template_patch_document=json_api_export_template_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_export_templates_serialize( self, id, json_api_export_template_patch_document, - **kwargs - ): - """Patch Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_export_templates(id, json_api_export_template_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_export_template_patch_document (JsonApiExportTemplatePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_export_template_patch_document'] = \ - json_api_export_template_patch_document - return self.patch_entity_export_templates_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_template_patch_document is not None: + _body_params = json_api_export_template_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Patch Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_patch_document: (required) + :type json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_patch_document=json_api_identity_provider_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Patch Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_patch_document: (required) + :type json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_patch_document=json_api_identity_provider_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_patch_document: (required) + :type json_api_identity_provider_patch_document: JsonApiIdentityProviderPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_patch_document=json_api_identity_provider_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_identity_providers_serialize( self, id, json_api_identity_provider_patch_document, - **kwargs - ): - """Patch Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_identity_provider_patch_document (JsonApiIdentityProviderPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_identity_provider_patch_document'] = \ - json_api_identity_provider_patch_document - return self.patch_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_identity_provider_patch_document is not None: + _body_params = json_api_identity_provider_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_patch_document: JsonApiJwkPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Patch Jwk + + Patches JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_patch_document: (required) + :type json_api_jwk_patch_document: JsonApiJwkPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_jwks_serialize( + id=id, + json_api_jwk_patch_document=json_api_jwk_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_patch_document: JsonApiJwkPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Patch Jwk + + Patches JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_patch_document: (required) + :type json_api_jwk_patch_document: JsonApiJwkPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_jwks_serialize( + id=id, + json_api_jwk_patch_document=json_api_jwk_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_patch_document: JsonApiJwkPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Jwk + + Patches JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_patch_document: (required) + :type json_api_jwk_patch_document: JsonApiJwkPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_jwks_serialize( + id=id, + json_api_jwk_patch_document=json_api_jwk_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_jwks_serialize( self, id, json_api_jwk_patch_document, - **kwargs - ): - """Patch Jwk # noqa: E501 - - Patches JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_jwks(id, json_api_jwk_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_jwk_patch_document (JsonApiJwkPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_jwk_patch_document'] = \ - json_api_jwk_patch_document - return self.patch_entity_jwks_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_jwk_patch_document is not None: + _body_params = json_api_jwk_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_llm_endpoints( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """Patch LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_patch_document: (required) + :type json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_patch_document=json_api_llm_endpoint_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_llm_endpoints_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """Patch LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_patch_document: (required) + :type json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_patch_document=json_api_llm_endpoint_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_llm_endpoints_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_patch_document: (required) + :type json_api_llm_endpoint_patch_document: JsonApiLlmEndpointPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_patch_document=json_api_llm_endpoint_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_llm_endpoints_serialize( self, id, json_api_llm_endpoint_patch_document, - **kwargs - ): - """Patch LLM endpoint entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_llm_endpoints(id, json_api_llm_endpoint_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_llm_endpoint_patch_document (JsonApiLlmEndpointPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_llm_endpoint_patch_document'] = \ - json_api_llm_endpoint_patch_document - return self.patch_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_llm_endpoint_patch_document is not None: + _body_params = json_api_llm_endpoint_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_notification_channels( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Patch Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_patch_document: (required) + :type json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_patch_document=json_api_notification_channel_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_notification_channels_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Patch Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_patch_document: (required) + :type json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_patch_document=json_api_notification_channel_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_notification_channels_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_patch_document: (required) + :type json_api_notification_channel_patch_document: JsonApiNotificationChannelPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_patch_document=json_api_notification_channel_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_notification_channels_serialize( self, id, json_api_notification_channel_patch_document, - **kwargs - ): - """Patch Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_notification_channels(id, json_api_notification_channel_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_notification_channel_patch_document (JsonApiNotificationChannelPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_notification_channel_patch_document'] = \ - json_api_notification_channel_patch_document - return self.patch_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_notification_channel_patch_document is not None: + _body_params = json_api_notification_channel_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_organization_settings( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Patch Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_patch_document: (required) + :type json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_patch_document=json_api_organization_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Patch Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_patch_document: (required) + :type json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_patch_document=json_api_organization_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_patch_document: (required) + :type json_api_organization_setting_patch_document: JsonApiOrganizationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_patch_document=json_api_organization_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_organization_settings_serialize( self, id, json_api_organization_setting_patch_document, - **kwargs - ): - """Patch Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_organization_settings(id, json_api_organization_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_setting_patch_document (JsonApiOrganizationSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_setting_patch_document'] = \ - json_api_organization_setting_patch_document - return self.patch_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_setting_patch_document is not None: + _body_params = json_api_organization_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_patch_document: JsonApiThemePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Patch Theming + + + :param id: (required) + :type id: str + :param json_api_theme_patch_document: (required) + :type json_api_theme_patch_document: JsonApiThemePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_themes_serialize( + id=id, + json_api_theme_patch_document=json_api_theme_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_patch_document: JsonApiThemePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Patch Theming + + + :param id: (required) + :type id: str + :param json_api_theme_patch_document: (required) + :type json_api_theme_patch_document: JsonApiThemePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_themes_serialize( + id=id, + json_api_theme_patch_document=json_api_theme_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_patch_document: JsonApiThemePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Theming + + + :param id: (required) + :type id: str + :param json_api_theme_patch_document: (required) + :type json_api_theme_patch_document: JsonApiThemePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_themes_serialize( + id=id, + json_api_theme_patch_document=json_api_theme_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_themes_serialize( self, id, json_api_theme_patch_document, - **kwargs - ): - """Patch Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_themes(id, json_api_theme_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_theme_patch_document (JsonApiThemePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_theme_patch_document'] = \ - json_api_theme_patch_document - return self.patch_entity_themes_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_theme_patch_document is not None: + _body_params = json_api_theme_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_patch_document: JsonApiUserGroupPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Patch UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_patch_document: (required) + :type json_api_user_group_patch_document: JsonApiUserGroupPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_groups_serialize( + id=id, + json_api_user_group_patch_document=json_api_user_group_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_patch_document: JsonApiUserGroupPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Patch UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_patch_document: (required) + :type json_api_user_group_patch_document: JsonApiUserGroupPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_groups_serialize( + id=id, + json_api_user_group_patch_document=json_api_user_group_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_patch_document: JsonApiUserGroupPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_patch_document: (required) + :type json_api_user_group_patch_document: JsonApiUserGroupPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_groups_serialize( + id=id, + json_api_user_group_patch_document=json_api_user_group_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_user_groups_serialize( self, id, json_api_user_group_patch_document, - **kwargs - ): - """Patch UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_user_groups(id, json_api_user_group_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_group_patch_document (JsonApiUserGroupPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_group_patch_document'] = \ - json_api_user_group_patch_document - return self.patch_entity_user_groups_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_group_patch_document is not None: + _body_params = json_api_user_group_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_users( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_patch_document: JsonApiUserPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Patch User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_patch_document: (required) + :type json_api_user_patch_document: JsonApiUserPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_users_serialize( + id=id, + json_api_user_patch_document=json_api_user_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_users_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_patch_document: JsonApiUserPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Patch User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_patch_document: (required) + :type json_api_user_patch_document: JsonApiUserPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_users_serialize( + id=id, + json_api_user_patch_document=json_api_user_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_users_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_patch_document: JsonApiUserPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_patch_document: (required) + :type json_api_user_patch_document: JsonApiUserPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_users_serialize( + id=id, + json_api_user_patch_document=json_api_user_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_users_serialize( self, id, json_api_user_patch_document, - **kwargs - ): - """Patch User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_users(id, json_api_user_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_patch_document (JsonApiUserPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_patch_document'] = \ - json_api_user_patch_document - return self.patch_entity_users_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_patch_document is not None: + _body_params = json_api_user_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_workspaces( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_patch_document: JsonApiWorkspacePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Patch Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_patch_document: (required) + :type json_api_workspace_patch_document: JsonApiWorkspacePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspaces_serialize( + id=id, + json_api_workspace_patch_document=json_api_workspace_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspaces_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_patch_document: JsonApiWorkspacePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Patch Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_patch_document: (required) + :type json_api_workspace_patch_document: JsonApiWorkspacePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspaces_serialize( + id=id, + json_api_workspace_patch_document=json_api_workspace_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_workspaces_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_patch_document: JsonApiWorkspacePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_patch_document: (required) + :type json_api_workspace_patch_document: JsonApiWorkspacePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspaces_serialize( + id=id, + json_api_workspace_patch_document=json_api_workspace_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspaces_serialize( self, id, json_api_workspace_patch_document, - **kwargs - ): - """Patch Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspaces(id, json_api_workspace_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_workspace_patch_document (JsonApiWorkspacePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_workspace_patch_document'] = \ - json_api_workspace_patch_document - return self.patch_entity_workspaces_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_patch_document is not None: + _body_params = json_api_workspace_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_color_palettes( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiColorPaletteOutDocument: + """Put Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_color_palettes_serialize( + id=id, + json_api_color_palette_in_document=json_api_color_palette_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_color_palettes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiColorPaletteOutDocument]: + """Put Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_color_palettes_serialize( + id=id, + json_api_color_palette_in_document=json_api_color_palette_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_color_palettes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_color_palette_in_document: JsonApiColorPaletteInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Color Pallette + + + :param id: (required) + :type id: str + :param json_api_color_palette_in_document: (required) + :type json_api_color_palette_in_document: JsonApiColorPaletteInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_color_palettes_serialize( + id=id, + json_api_color_palette_in_document=json_api_color_palette_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiColorPaletteOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_color_palettes_serialize( self, id, json_api_color_palette_in_document, - **kwargs - ): - """Put Color Pallette # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_color_palettes(id, json_api_color_palette_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_color_palette_in_document (JsonApiColorPaletteInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_color_palette_in_document'] = \ - json_api_color_palette_in_document - return self.update_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_color_palette_in_document is not None: + _body_params = json_api_color_palette_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/colorPalettes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_csp_directives( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCspDirectiveOutDocument: + """Put CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_csp_directives_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCspDirectiveOutDocument]: + """Put CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_csp_directives_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put CSP Directives + + Context Security Police Directive + + :param id: (required) + :type id: str + :param json_api_csp_directive_in_document: (required) + :type json_api_csp_directive_in_document: JsonApiCspDirectiveInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_csp_directives_serialize( + id=id, + json_api_csp_directive_in_document=json_api_csp_directive_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCspDirectiveOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_csp_directives_serialize( self, id, json_api_csp_directive_in_document, - **kwargs - ): - """Put CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_csp_directives(id, json_api_csp_directive_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_csp_directive_in_document'] = \ - json_api_csp_directive_in_document - return self.update_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_csp_directive_in_document is not None: + _body_params = json_api_csp_directive_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/cspDirectives/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_data_sources( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_in_document: JsonApiDataSourceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDataSourceOutDocument: + """Put Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_data_sources_serialize( + id=id, + json_api_data_source_in_document=json_api_data_source_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_data_sources_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_in_document: JsonApiDataSourceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDataSourceOutDocument]: + """Put Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_data_sources_serialize( + id=id, + json_api_data_source_in_document=json_api_data_source_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_data_sources_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_data_source_in_document: JsonApiDataSourceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Data Source entity + + Data Source - represents data source for the workspace + + :param id: (required) + :type id: str + :param json_api_data_source_in_document: (required) + :type json_api_data_source_in_document: JsonApiDataSourceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_data_sources_serialize( + id=id, + json_api_data_source_in_document=json_api_data_source_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDataSourceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_data_sources_serialize( self, id, json_api_data_source_in_document, - **kwargs - ): - """Put Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_data_sources(id, json_api_data_source_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_data_source_in_document (JsonApiDataSourceInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_data_source_in_document'] = \ - json_api_data_source_in_document - return self.update_entity_data_sources_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_data_source_in_document is not None: + _body_params = json_api_data_source_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/dataSources/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_export_templates( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_in_document: JsonApiExportTemplateInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportTemplateOutDocument: + """PUT Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_in_document: (required) + :type json_api_export_template_in_document: JsonApiExportTemplateInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_templates_serialize( + id=id, + json_api_export_template_in_document=json_api_export_template_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_export_templates_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_in_document: JsonApiExportTemplateInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportTemplateOutDocument]: + """PUT Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_in_document: (required) + :type json_api_export_template_in_document: JsonApiExportTemplateInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_templates_serialize( + id=id, + json_api_export_template_in_document=json_api_export_template_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_export_templates_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_export_template_in_document: JsonApiExportTemplateInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """PUT Export Template entity + + + :param id: (required) + :type id: str + :param json_api_export_template_in_document: (required) + :type json_api_export_template_in_document: JsonApiExportTemplateInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_templates_serialize( + id=id, + json_api_export_template_in_document=json_api_export_template_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportTemplateOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_export_templates_serialize( self, id, json_api_export_template_in_document, - **kwargs - ): - """PUT Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_export_templates(id, json_api_export_template_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_export_template_in_document (JsonApiExportTemplateInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_export_template_in_document'] = \ - json_api_export_template_in_document - return self.update_entity_export_templates_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_template_in_document is not None: + _body_params = json_api_export_template_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/exportTemplates/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_identity_providers( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiIdentityProviderOutDocument: + """Put Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_identity_providers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiIdentityProviderOutDocument]: + """Put Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_identity_providers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Identity Provider + + + :param id: (required) + :type id: str + :param json_api_identity_provider_in_document: (required) + :type json_api_identity_provider_in_document: JsonApiIdentityProviderInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_identity_providers_serialize( + id=id, + json_api_identity_provider_in_document=json_api_identity_provider_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiIdentityProviderOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_identity_providers_serialize( self, id, json_api_identity_provider_in_document, - **kwargs - ): - """Put Identity Provider # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_identity_providers(id, json_api_identity_provider_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_identity_provider_in_document'] = \ - json_api_identity_provider_in_document - return self.update_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_identity_provider_in_document is not None: + _body_params = json_api_identity_provider_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/identityProviders/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_jwks( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_in_document: JsonApiJwkInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiJwkOutDocument: + """Put Jwk + + Updates JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_jwks_serialize( + id=id, + json_api_jwk_in_document=json_api_jwk_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_jwks_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_in_document: JsonApiJwkInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiJwkOutDocument]: + """Put Jwk + + Updates JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_jwks_serialize( + id=id, + json_api_jwk_in_document=json_api_jwk_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_jwks_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_jwk_in_document: JsonApiJwkInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Jwk + + Updates JSON web key - used to verify JSON web tokens (Jwts) + + :param id: (required) + :type id: str + :param json_api_jwk_in_document: (required) + :type json_api_jwk_in_document: JsonApiJwkInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_jwks_serialize( + id=id, + json_api_jwk_in_document=json_api_jwk_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiJwkOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_jwks_serialize( self, id, json_api_jwk_in_document, - **kwargs - ): - """Put Jwk # noqa: E501 - - Updates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_jwks(id, json_api_jwk_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_jwk_in_document (JsonApiJwkInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.update_entity_jwks_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_jwk_in_document is not None: + _body_params = json_api_jwk_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/jwks/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_llm_endpoints( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLlmEndpointOutDocument: + """PUT LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_llm_endpoints_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLlmEndpointOutDocument]: + """PUT LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_llm_endpoints_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """PUT LLM endpoint entity + + + :param id: (required) + :type id: str + :param json_api_llm_endpoint_in_document: (required) + :type json_api_llm_endpoint_in_document: JsonApiLlmEndpointInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_llm_endpoints_serialize( + id=id, + json_api_llm_endpoint_in_document=json_api_llm_endpoint_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLlmEndpointOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_llm_endpoints_serialize( self, id, json_api_llm_endpoint_in_document, - **kwargs - ): - """PUT LLM endpoint entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_llm_endpoints(id, json_api_llm_endpoint_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_llm_endpoint_in_document (JsonApiLlmEndpointInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_llm_endpoint_in_document'] = \ - json_api_llm_endpoint_in_document - return self.update_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_llm_endpoint_in_document is not None: + _body_params = json_api_llm_endpoint_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/llmEndpoints/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_notification_channels( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiNotificationChannelOutDocument: + """Put Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_in_document: (required) + :type json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_in_document=json_api_notification_channel_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_notification_channels_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiNotificationChannelOutDocument]: + """Put Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_in_document: (required) + :type json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_in_document=json_api_notification_channel_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_notification_channels_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Notification Channel entity + + + :param id: (required) + :type id: str + :param json_api_notification_channel_in_document: (required) + :type json_api_notification_channel_in_document: JsonApiNotificationChannelInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_notification_channels_serialize( + id=id, + json_api_notification_channel_in_document=json_api_notification_channel_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiNotificationChannelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_notification_channels_serialize( self, id, json_api_notification_channel_in_document, - **kwargs - ): - """Put Notification Channel entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_notification_channels(id, json_api_notification_channel_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_notification_channel_in_document (JsonApiNotificationChannelInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_notification_channel_in_document'] = \ - json_api_notification_channel_in_document - return self.update_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_notification_channel_in_document is not None: + _body_params = json_api_notification_channel_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/notificationChannels/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_organization_settings( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiOrganizationSettingOutDocument: + """Put Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_organization_settings_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiOrganizationSettingOutDocument]: + """Put Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_organization_settings_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Organization entity + + + :param id: (required) + :type id: str + :param json_api_organization_setting_in_document: (required) + :type json_api_organization_setting_in_document: JsonApiOrganizationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_organization_settings_serialize( + id=id, + json_api_organization_setting_in_document=json_api_organization_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiOrganizationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_organization_settings_serialize( self, id, json_api_organization_setting_in_document, - **kwargs - ): - """Put Organization entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_organization_settings(id, json_api_organization_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_setting_in_document'] = \ - json_api_organization_setting_in_document - return self.update_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_organization_setting_in_document is not None: + _body_params = json_api_organization_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/organizationSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_themes( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_in_document: JsonApiThemeInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiThemeOutDocument: + """Put Theming + + + :param id: (required) + :type id: str + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_themes_serialize( + id=id, + json_api_theme_in_document=json_api_theme_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_themes_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_in_document: JsonApiThemeInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiThemeOutDocument]: + """Put Theming + + + :param id: (required) + :type id: str + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_themes_serialize( + id=id, + json_api_theme_in_document=json_api_theme_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_themes_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_theme_in_document: JsonApiThemeInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Theming + + + :param id: (required) + :type id: str + :param json_api_theme_in_document: (required) + :type json_api_theme_in_document: JsonApiThemeInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_themes_serialize( + id=id, + json_api_theme_in_document=json_api_theme_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiThemeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_themes_serialize( self, id, json_api_theme_in_document, - **kwargs - ): - """Put Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_themes(id, json_api_theme_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_theme_in_document (JsonApiThemeInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_theme_in_document'] = \ - json_api_theme_in_document - return self.update_entity_themes_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_theme_in_document is not None: + _body_params = json_api_theme_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/themes/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_in_document: JsonApiUserGroupInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Put UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_groups_serialize( + id=id, + json_api_user_group_in_document=json_api_user_group_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_in_document: JsonApiUserGroupInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Put UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_groups_serialize( + id=id, + json_api_user_group_in_document=json_api_user_group_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_in_document: JsonApiUserGroupInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_groups_serialize( + id=id, + json_api_user_group_in_document=json_api_user_group_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_user_groups_serialize( self, id, json_api_user_group_in_document, - **kwargs - ): - """Put UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_user_groups(id, json_api_user_group_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_group_in_document (JsonApiUserGroupInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_group_in_document'] = \ - json_api_user_group_in_document - return self.update_entity_user_groups_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_group_in_document is not None: + _body_params = json_api_user_group_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_users( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_in_document: JsonApiUserInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Put User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_users_serialize( + id=id, + json_api_user_in_document=json_api_user_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_users_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_in_document: JsonApiUserInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Put User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_users_serialize( + id=id, + json_api_user_in_document=json_api_user_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_users_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_in_document: JsonApiUserInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_users_serialize( + id=id, + json_api_user_in_document=json_api_user_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_users_serialize( self, id, json_api_user_in_document, - **kwargs - ): - """Put User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_users(id, json_api_user_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_in_document (JsonApiUserInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_in_document'] = \ - json_api_user_in_document - return self.update_entity_users_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_in_document is not None: + _body_params = json_api_user_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_workspaces( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Put Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspaces_serialize( + id=id, + json_api_workspace_in_document=json_api_workspace_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspaces_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Put Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspaces_serialize( + id=id, + json_api_workspace_in_document=json_api_workspace_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_workspaces_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspaces_serialize( + id=id, + json_api_workspace_in_document=json_api_workspace_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_workspaces_serialize( self, id, json_api_workspace_in_document, - **kwargs - ): - """Put Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspaces(id, json_api_workspace_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_workspace_in_document (JsonApiWorkspaceInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_workspace_in_document'] = \ - json_api_workspace_in_document - return self.update_entity_workspaces_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_in_document is not None: + _body_params = json_api_workspace_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/permissions_api.py b/gooddata-api-client/gooddata_api_client/api/permissions_api.py index 7baeb5e83..82c283ca7 100644 --- a/gooddata-api-client/gooddata_api_client/api/permissions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/permissions_api.py @@ -1,1963 +1,3852 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - + Generated by OpenAPI Generator (https://openapi-generator.tech) -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.available_assignees import AvailableAssignees -from gooddata_api_client.model.dashboard_permissions import DashboardPermissions -from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment -from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions -from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner -from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment -from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment - - -class PermissionsApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import StrictStr +from typing import List +from gooddata_api_client.models.available_assignees import AvailableAssignees +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions +from gooddata_api_client.models.data_source_permission_assignment import DataSourcePermissionAssignment +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.models.organization_permission_assignment import OrganizationPermissionAssignment +from gooddata_api_client.models.workspace_permission_assignment import WorkspacePermissionAssignment + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class PermissionsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.available_assignees_endpoint = _Endpoint( - settings={ - 'response_type': (AvailableAssignees,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees', - 'operation_id': 'available_assignees', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'dashboard_id', - ], - 'required': [ - 'workspace_id', - 'dashboard_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'dashboard_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'dashboard_id': 'dashboardId', - }, - 'location_map': { - 'workspace_id': 'path', - 'dashboard_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.dashboard_permissions_endpoint = _Endpoint( - settings={ - 'response_type': (DashboardPermissions,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions', - 'operation_id': 'dashboard_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'dashboard_id', - ], - 'required': [ - 'workspace_id', - 'dashboard_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'dashboard_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'dashboard_id': 'dashboardId', - }, - 'location_map': { - 'workspace_id': 'path', - 'dashboard_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_organization_permissions_endpoint = _Endpoint( - settings={ - 'response_type': ([DeclarativeOrganizationPermission],), - 'auth': [], - 'endpoint_path': '/api/v1/layout/organization/permissions', - 'operation_id': 'get_organization_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_user_group_permissions_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUserGroupPermissions,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/userGroups/{userGroupId}/permissions', - 'operation_id': 'get_user_group_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_group_id', - ], - 'required': [ - 'user_group_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_group_id': - (str,), - }, - 'attribute_map': { - 'user_group_id': 'userGroupId', - }, - 'location_map': { - 'user_group_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_user_permissions_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUserPermissions,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/users/{userId}/permissions', - 'operation_id': 'get_user_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - ], - 'required': [ - 'user_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_workspace_permissions_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeWorkspacePermissions,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/permissions', - 'operation_id': 'get_workspace_permissions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.manage_dashboard_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions', - 'operation_id': 'manage_dashboard_permissions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'dashboard_id', - 'manage_dashboard_permissions_request_inner', - ], - 'required': [ - 'workspace_id', - 'dashboard_id', - 'manage_dashboard_permissions_request_inner', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'dashboard_id': - (str,), - 'manage_dashboard_permissions_request_inner': - ([ManageDashboardPermissionsRequestInner],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'dashboard_id': 'dashboardId', - }, - 'location_map': { - 'workspace_id': 'path', - 'dashboard_id': 'path', - 'manage_dashboard_permissions_request_inner': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.manage_data_source_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/managePermissions', - 'operation_id': 'manage_data_source_permissions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'data_source_permission_assignment', - ], - 'required': [ - 'data_source_id', - 'data_source_permission_assignment', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'data_source_permission_assignment': - ([DataSourcePermissionAssignment],), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'data_source_permission_assignment': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.manage_organization_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/managePermissions', - 'operation_id': 'manage_organization_permissions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'organization_permission_assignment', - ], - 'required': [ - 'organization_permission_assignment', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'organization_permission_assignment': - ([OrganizationPermissionAssignment],), - }, - 'attribute_map': { - }, - 'location_map': { - 'organization_permission_assignment': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.manage_workspace_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/managePermissions', - 'operation_id': 'manage_workspace_permissions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'workspace_permission_assignment', - ], - 'required': [ - 'workspace_id', - 'workspace_permission_assignment', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'workspace_permission_assignment': - ([WorkspacePermissionAssignment],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'workspace_permission_assignment': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_organization_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/organization/permissions', - 'operation_id': 'set_organization_permissions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_organization_permission', - ], - 'required': [ - 'declarative_organization_permission', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_organization_permission': - ([DeclarativeOrganizationPermission],), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_organization_permission': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_user_group_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/userGroups/{userGroupId}/permissions', - 'operation_id': 'set_user_group_permissions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_group_id', - 'declarative_user_group_permissions', - ], - 'required': [ - 'user_group_id', - 'declarative_user_group_permissions', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_group_id': - (str,), - 'declarative_user_group_permissions': - (DeclarativeUserGroupPermissions,), - }, - 'attribute_map': { - 'user_group_id': 'userGroupId', - }, - 'location_map': { - 'user_group_id': 'path', - 'declarative_user_group_permissions': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_user_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/users/{userId}/permissions', - 'operation_id': 'set_user_permissions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'declarative_user_permissions', - ], - 'required': [ - 'user_id', - 'declarative_user_permissions', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'declarative_user_permissions': - (DeclarativeUserPermissions,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - 'declarative_user_permissions': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_workspace_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/permissions', - 'operation_id': 'set_workspace_permissions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_workspace_permissions', - ], - 'required': [ - 'workspace_id', - 'declarative_workspace_permissions', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_workspace_permissions': - (DeclarativeWorkspacePermissions,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_workspace_permissions': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def available_assignees( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AvailableAssignees: + """Get Available Assignees + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._available_assignees_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AvailableAssignees", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def available_assignees_with_http_info( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AvailableAssignees]: + """Get Available Assignees + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._available_assignees_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AvailableAssignees", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def available_assignees_without_preload_content( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Available Assignees + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._available_assignees_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AvailableAssignees", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _available_assignees_serialize( self, workspace_id, dashboard_id, - **kwargs - ): - """Get Available Assignees # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.available_assignees(workspace_id, dashboard_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - dashboard_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AvailableAssignees - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['dashboard_id'] = \ - dashboard_id - return self.available_assignees_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if dashboard_id is not None: + _path_params['dashboardId'] = dashboard_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def dashboard_permissions( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DashboardPermissions: + """Get Dashboard Permissions + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DashboardPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def dashboard_permissions_with_http_info( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DashboardPermissions]: + """Get Dashboard Permissions + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DashboardPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def dashboard_permissions_without_preload_content( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Dashboard Permissions + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DashboardPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _dashboard_permissions_serialize( self, workspace_id, dashboard_id, - **kwargs - ): - """Get Dashboard Permissions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.dashboard_permissions(workspace_id, dashboard_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - dashboard_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DashboardPermissions - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['dashboard_id'] = \ - dashboard_id - return self.dashboard_permissions_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if dashboard_id is not None: + _path_params['dashboardId'] = dashboard_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_organization_permissions( self, - **kwargs - ): - """Get organization permissions # noqa: E501 - - Retrieve organization permissions # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_organization_permissions(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [DeclarativeOrganizationPermission] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_organization_permissions_endpoint.call_with_http_info(**kwargs) + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DeclarativeOrganizationPermission]: + """Get organization permissions + + Retrieve organization permissions + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_permissions_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeOrganizationPermission]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_organization_permissions_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DeclarativeOrganizationPermission]]: + """Get organization permissions + + Retrieve organization permissions + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_permissions_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeOrganizationPermission]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_organization_permissions_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get organization permissions + + Retrieve organization permissions + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_permissions_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DeclarativeOrganizationPermission]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_organization_permissions_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/organization/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_user_group_permissions( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUserGroupPermissions: + """Get permissions for the user-group + + Retrieve current set of permissions of the user-group in a declarative form. + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_permissions_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroupPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_group_permissions_with_http_info( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUserGroupPermissions]: + """Get permissions for the user-group + + Retrieve current set of permissions of the user-group in a declarative form. + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_permissions_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroupPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_group_permissions_without_preload_content( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get permissions for the user-group + + Retrieve current set of permissions of the user-group in a declarative form. + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_permissions_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroupPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_group_permissions_serialize( self, user_group_id, - **kwargs - ): - """Get permissions for the user-group # noqa: E501 - - Retrieve current set of permissions of the user-group in a declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_user_group_permissions(user_group_id, async_req=True) - >>> result = thread.get() - - Args: - user_group_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUserGroupPermissions - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_group_id'] = \ - user_group_id - return self.get_user_group_permissions_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/userGroups/{userGroupId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_user_permissions( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUserPermissions: + """Get permissions for the user + + Retrieve current set of permissions of the user in a declarative form. + + :param user_id: (required) + :type user_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_permissions_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_permissions_with_http_info( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUserPermissions]: + """Get permissions for the user + + Retrieve current set of permissions of the user in a declarative form. + + :param user_id: (required) + :type user_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_permissions_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_permissions_without_preload_content( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get permissions for the user + + Retrieve current set of permissions of the user in a declarative form. + + :param user_id: (required) + :type user_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_permissions_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserPermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_permissions_serialize( self, user_id, - **kwargs - ): - """Get permissions for the user # noqa: E501 - - Retrieve current set of permissions of the user in a declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_user_permissions(user_id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUserPermissions - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_user_permissions_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/users/{userId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_workspace_permissions( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeWorkspacePermissions: + """Get permissions for the workspace + + Retrieve current set of permissions of the workspace in a declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_permissions_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspacePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_workspace_permissions_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeWorkspacePermissions]: + """Get permissions for the workspace + + Retrieve current set of permissions of the workspace in a declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_permissions_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspacePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_workspace_permissions_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get permissions for the workspace + + Retrieve current set of permissions of the workspace in a declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_permissions_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspacePermissions", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_workspace_permissions_serialize( self, workspace_id, - **kwargs - ): - """Get permissions for the workspace # noqa: E501 - - Retrieve current set of permissions of the workspace in a declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_workspace_permissions(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeWorkspacePermissions - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_workspace_permissions_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def manage_dashboard_permissions( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Manage Permissions for a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param manage_dashboard_permissions_request_inner: (required) + :type manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + manage_dashboard_permissions_request_inner=manage_dashboard_permissions_request_inner, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def manage_dashboard_permissions_with_http_info( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Manage Permissions for a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param manage_dashboard_permissions_request_inner: (required) + :type manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + manage_dashboard_permissions_request_inner=manage_dashboard_permissions_request_inner, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def manage_dashboard_permissions_without_preload_content( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Manage Permissions for a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param manage_dashboard_permissions_request_inner: (required) + :type manage_dashboard_permissions_request_inner: List[ManageDashboardPermissionsRequestInner] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_dashboard_permissions_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + manage_dashboard_permissions_request_inner=manage_dashboard_permissions_request_inner, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _manage_dashboard_permissions_serialize( self, workspace_id, dashboard_id, manage_dashboard_permissions_request_inner, - **kwargs - ): - """Manage Permissions for a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.manage_dashboard_permissions(workspace_id, dashboard_id, manage_dashboard_permissions_request_inner, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - dashboard_id (str): - manage_dashboard_permissions_request_inner ([ManageDashboardPermissionsRequestInner]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['dashboard_id'] = \ - dashboard_id - kwargs['manage_dashboard_permissions_request_inner'] = \ - manage_dashboard_permissions_request_inner - return self.manage_dashboard_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'ManageDashboardPermissionsRequestInner': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if dashboard_id is not None: + _path_params['dashboardId'] = dashboard_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if manage_dashboard_permissions_request_inner is not None: + _body_params = manage_dashboard_permissions_request_inner + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def manage_data_source_permissions( + self, + data_source_id: StrictStr, + data_source_permission_assignment: List[DataSourcePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Manage Permissions for a Data Source + + Manage Permissions for a Data Source + + :param data_source_id: (required) + :type data_source_id: str + :param data_source_permission_assignment: (required) + :type data_source_permission_assignment: List[DataSourcePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_data_source_permissions_serialize( + data_source_id=data_source_id, + data_source_permission_assignment=data_source_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def manage_data_source_permissions_with_http_info( + self, + data_source_id: StrictStr, + data_source_permission_assignment: List[DataSourcePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Manage Permissions for a Data Source + + Manage Permissions for a Data Source + + :param data_source_id: (required) + :type data_source_id: str + :param data_source_permission_assignment: (required) + :type data_source_permission_assignment: List[DataSourcePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_data_source_permissions_serialize( + data_source_id=data_source_id, + data_source_permission_assignment=data_source_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def manage_data_source_permissions_without_preload_content( + self, + data_source_id: StrictStr, + data_source_permission_assignment: List[DataSourcePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Manage Permissions for a Data Source + + Manage Permissions for a Data Source + + :param data_source_id: (required) + :type data_source_id: str + :param data_source_permission_assignment: (required) + :type data_source_permission_assignment: List[DataSourcePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_data_source_permissions_serialize( + data_source_id=data_source_id, + data_source_permission_assignment=data_source_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _manage_data_source_permissions_serialize( self, data_source_id, data_source_permission_assignment, - **kwargs - ): - """Manage Permissions for a Data Source # noqa: E501 - - Manage Permissions for a Data Source # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.manage_data_source_permissions(data_source_id, data_source_permission_assignment, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): - data_source_permission_assignment ([DataSourcePermissionAssignment]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['data_source_permission_assignment'] = \ - data_source_permission_assignment - return self.manage_data_source_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'DataSourcePermissionAssignment': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if data_source_permission_assignment is not None: + _body_params = data_source_permission_assignment + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/managePermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def manage_organization_permissions( + self, + organization_permission_assignment: List[OrganizationPermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Manage Permissions for a Organization + + Manage Permissions for a Organization + + :param organization_permission_assignment: (required) + :type organization_permission_assignment: List[OrganizationPermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_organization_permissions_serialize( + organization_permission_assignment=organization_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def manage_organization_permissions_with_http_info( + self, + organization_permission_assignment: List[OrganizationPermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Manage Permissions for a Organization + + Manage Permissions for a Organization + + :param organization_permission_assignment: (required) + :type organization_permission_assignment: List[OrganizationPermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_organization_permissions_serialize( + organization_permission_assignment=organization_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def manage_organization_permissions_without_preload_content( + self, + organization_permission_assignment: List[OrganizationPermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Manage Permissions for a Organization + + Manage Permissions for a Organization + + :param organization_permission_assignment: (required) + :type organization_permission_assignment: List[OrganizationPermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_organization_permissions_serialize( + organization_permission_assignment=organization_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _manage_organization_permissions_serialize( self, organization_permission_assignment, - **kwargs - ): - """Manage Permissions for a Organization # noqa: E501 - - Manage Permissions for a Organization # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.manage_organization_permissions(organization_permission_assignment, async_req=True) - >>> result = thread.get() - - Args: - organization_permission_assignment ([OrganizationPermissionAssignment]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['organization_permission_assignment'] = \ - organization_permission_assignment - return self.manage_organization_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'OrganizationPermissionAssignment': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if organization_permission_assignment is not None: + _body_params = organization_permission_assignment + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/organization/managePermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def manage_workspace_permissions( + self, + workspace_id: StrictStr, + workspace_permission_assignment: List[WorkspacePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Manage Permissions for a Workspace + + Manage Permissions for a Workspace and its Workspace Hierarchy + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_permission_assignment: (required) + :type workspace_permission_assignment: List[WorkspacePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_workspace_permissions_serialize( + workspace_id=workspace_id, + workspace_permission_assignment=workspace_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def manage_workspace_permissions_with_http_info( + self, + workspace_id: StrictStr, + workspace_permission_assignment: List[WorkspacePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Manage Permissions for a Workspace + + Manage Permissions for a Workspace and its Workspace Hierarchy + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_permission_assignment: (required) + :type workspace_permission_assignment: List[WorkspacePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_workspace_permissions_serialize( + workspace_id=workspace_id, + workspace_permission_assignment=workspace_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def manage_workspace_permissions_without_preload_content( + self, + workspace_id: StrictStr, + workspace_permission_assignment: List[WorkspacePermissionAssignment], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Manage Permissions for a Workspace + + Manage Permissions for a Workspace and its Workspace Hierarchy + + :param workspace_id: (required) + :type workspace_id: str + :param workspace_permission_assignment: (required) + :type workspace_permission_assignment: List[WorkspacePermissionAssignment] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_workspace_permissions_serialize( + workspace_id=workspace_id, + workspace_permission_assignment=workspace_permission_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _manage_workspace_permissions_serialize( self, workspace_id, workspace_permission_assignment, - **kwargs - ): - """Manage Permissions for a Workspace # noqa: E501 - - Manage Permissions for a Workspace and its Workspace Hierarchy # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.manage_workspace_permissions(workspace_id, workspace_permission_assignment, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - workspace_permission_assignment ([WorkspacePermissionAssignment]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['workspace_permission_assignment'] = \ - workspace_permission_assignment - return self.manage_workspace_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'WorkspacePermissionAssignment': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if workspace_permission_assignment is not None: + _body_params = workspace_permission_assignment + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/managePermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_organization_permissions( + self, + declarative_organization_permission: List[DeclarativeOrganizationPermission], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set organization permissions + + Sets organization permissions + + :param declarative_organization_permission: (required) + :type declarative_organization_permission: List[DeclarativeOrganizationPermission] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_permissions_serialize( + declarative_organization_permission=declarative_organization_permission, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_organization_permissions_with_http_info( + self, + declarative_organization_permission: List[DeclarativeOrganizationPermission], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set organization permissions + + Sets organization permissions + + :param declarative_organization_permission: (required) + :type declarative_organization_permission: List[DeclarativeOrganizationPermission] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_permissions_serialize( + declarative_organization_permission=declarative_organization_permission, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_organization_permissions_without_preload_content( + self, + declarative_organization_permission: List[DeclarativeOrganizationPermission], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set organization permissions + + Sets organization permissions + + :param declarative_organization_permission: (required) + :type declarative_organization_permission: List[DeclarativeOrganizationPermission] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_organization_permissions_serialize( + declarative_organization_permission=declarative_organization_permission, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_organization_permissions_serialize( self, declarative_organization_permission, - **kwargs - ): - """Set organization permissions # noqa: E501 - - Sets organization permissions # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_organization_permissions(declarative_organization_permission, async_req=True) - >>> result = thread.get() - - Args: - declarative_organization_permission ([DeclarativeOrganizationPermission]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_organization_permission'] = \ - declarative_organization_permission - return self.set_organization_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'DeclarativeOrganizationPermission': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_organization_permission is not None: + _body_params = declarative_organization_permission + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/organization/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_user_group_permissions( + self, + user_group_id: StrictStr, + declarative_user_group_permissions: DeclarativeUserGroupPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set permissions for the user-group + + Set effective permissions for the user-group + + :param user_group_id: (required) + :type user_group_id: str + :param declarative_user_group_permissions: (required) + :type declarative_user_group_permissions: DeclarativeUserGroupPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_group_permissions_serialize( + user_group_id=user_group_id, + declarative_user_group_permissions=declarative_user_group_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_user_group_permissions_with_http_info( + self, + user_group_id: StrictStr, + declarative_user_group_permissions: DeclarativeUserGroupPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set permissions for the user-group + + Set effective permissions for the user-group + + :param user_group_id: (required) + :type user_group_id: str + :param declarative_user_group_permissions: (required) + :type declarative_user_group_permissions: DeclarativeUserGroupPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_group_permissions_serialize( + user_group_id=user_group_id, + declarative_user_group_permissions=declarative_user_group_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_user_group_permissions_without_preload_content( + self, + user_group_id: StrictStr, + declarative_user_group_permissions: DeclarativeUserGroupPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set permissions for the user-group + + Set effective permissions for the user-group + + :param user_group_id: (required) + :type user_group_id: str + :param declarative_user_group_permissions: (required) + :type declarative_user_group_permissions: DeclarativeUserGroupPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_group_permissions_serialize( + user_group_id=user_group_id, + declarative_user_group_permissions=declarative_user_group_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_user_group_permissions_serialize( self, user_group_id, declarative_user_group_permissions, - **kwargs - ): - """Set permissions for the user-group # noqa: E501 - - Set effective permissions for the user-group # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_user_group_permissions(user_group_id, declarative_user_group_permissions, async_req=True) - >>> result = thread.get() - - Args: - user_group_id (str): - declarative_user_group_permissions (DeclarativeUserGroupPermissions): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_group_id'] = \ - user_group_id - kwargs['declarative_user_group_permissions'] = \ - declarative_user_group_permissions - return self.set_user_group_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_user_group_permissions is not None: + _body_params = declarative_user_group_permissions + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/userGroups/{userGroupId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_user_permissions( + self, + user_id: StrictStr, + declarative_user_permissions: DeclarativeUserPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set permissions for the user + + Set effective permissions for the user + + :param user_id: (required) + :type user_id: str + :param declarative_user_permissions: (required) + :type declarative_user_permissions: DeclarativeUserPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_permissions_serialize( + user_id=user_id, + declarative_user_permissions=declarative_user_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_user_permissions_with_http_info( + self, + user_id: StrictStr, + declarative_user_permissions: DeclarativeUserPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set permissions for the user + + Set effective permissions for the user + + :param user_id: (required) + :type user_id: str + :param declarative_user_permissions: (required) + :type declarative_user_permissions: DeclarativeUserPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_permissions_serialize( + user_id=user_id, + declarative_user_permissions=declarative_user_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_user_permissions_without_preload_content( + self, + user_id: StrictStr, + declarative_user_permissions: DeclarativeUserPermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set permissions for the user + + Set effective permissions for the user + + :param user_id: (required) + :type user_id: str + :param declarative_user_permissions: (required) + :type declarative_user_permissions: DeclarativeUserPermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_permissions_serialize( + user_id=user_id, + declarative_user_permissions=declarative_user_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_user_permissions_serialize( self, user_id, declarative_user_permissions, - **kwargs - ): - """Set permissions for the user # noqa: E501 - - Set effective permissions for the user # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_user_permissions(user_id, declarative_user_permissions, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - declarative_user_permissions (DeclarativeUserPermissions): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['declarative_user_permissions'] = \ - declarative_user_permissions - return self.set_user_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_user_permissions is not None: + _body_params = declarative_user_permissions + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/users/{userId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_workspace_permissions( + self, + workspace_id: StrictStr, + declarative_workspace_permissions: DeclarativeWorkspacePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set permissions for the workspace + + Set effective permissions for the workspace + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_permissions: (required) + :type declarative_workspace_permissions: DeclarativeWorkspacePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_permissions_serialize( + workspace_id=workspace_id, + declarative_workspace_permissions=declarative_workspace_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_workspace_permissions_with_http_info( + self, + workspace_id: StrictStr, + declarative_workspace_permissions: DeclarativeWorkspacePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set permissions for the workspace + + Set effective permissions for the workspace + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_permissions: (required) + :type declarative_workspace_permissions: DeclarativeWorkspacePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_permissions_serialize( + workspace_id=workspace_id, + declarative_workspace_permissions=declarative_workspace_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_workspace_permissions_without_preload_content( + self, + workspace_id: StrictStr, + declarative_workspace_permissions: DeclarativeWorkspacePermissions, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set permissions for the workspace + + Set effective permissions for the workspace + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_permissions: (required) + :type declarative_workspace_permissions: DeclarativeWorkspacePermissions + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspace_permissions_serialize( + workspace_id=workspace_id, + declarative_workspace_permissions=declarative_workspace_permissions, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_workspace_permissions_serialize( self, workspace_id, declarative_workspace_permissions, - **kwargs - ): - """Set permissions for the workspace # noqa: E501 - - Set effective permissions for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_workspace_permissions(workspace_id, declarative_workspace_permissions, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_workspace_permissions (DeclarativeWorkspacePermissions): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_workspace_permissions'] = \ - declarative_workspace_permissions - return self.set_workspace_permissions_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_workspace_permissions is not None: + _body_params = declarative_workspace_permissions + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/plugins_api.py b/gooddata-api-client/gooddata_api_client/api/plugins_api.py index ce7fe6df7..926a7de22 100644 --- a/gooddata-api-client/gooddata_api_client/api/plugins_api.py +++ b/gooddata-api-client/gooddata_api_client/api/plugins_api.py @@ -1,1104 +1,2051 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class PluginsApi(object): +class PluginsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', - 'operation_id': 'create_entity_dashboard_plugins', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_dashboard_plugin_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_dashboard_plugin_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_dashboard_plugin_post_optional_id_document': - (JsonApiDashboardPluginPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_dashboard_plugin_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Post Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_dashboard_plugin_post_optional_id_document: (required) + :type json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + json_api_dashboard_plugin_post_optional_id_document=json_api_dashboard_plugin_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.delete_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'delete_entity_dashboard_plugins', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.get_all_entities_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', - 'operation_id': 'get_all_entities_dashboard_plugins', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Post Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_dashboard_plugin_post_optional_id_document: (required) + :type json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + json_api_dashboard_plugin_post_optional_id_document=json_api_dashboard_plugin_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.get_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'get_entity_dashboard_plugins', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.patch_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'patch_entity_dashboard_plugins', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_dashboard_plugin_patch_document': - (JsonApiDashboardPluginPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_dashboard_plugin_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - self.update_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'update_entity_dashboard_plugins', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_dashboard_plugin_in_document': - (JsonApiDashboardPluginInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_dashboard_plugin_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_dashboard_plugin_post_optional_id_document: (required) + :type json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + json_api_dashboard_plugin_post_optional_id_document=json_api_dashboard_plugin_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - def create_entity_dashboard_plugins( + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_dashboard_plugins_serialize( self, workspace_id, json_api_dashboard_plugin_post_optional_id_document, - **kwargs - ): - """Post Plugins # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_dashboard_plugin_post_optional_id_document (JsonApiDashboardPluginPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_dashboard_plugin_post_optional_id_document is not None: + _body_params = json_api_dashboard_plugin_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def delete_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_dashboard_plugin_post_optional_id_document'] = \ - json_api_dashboard_plugin_post_optional_id_document - return self.create_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + return response_data.response - def delete_entity_dashboard_plugins( + + def _delete_entity_dashboard_plugins_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_dashboard_plugins(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_all_entities_dashboard_plugins( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutList: + """Get all Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_dashboard_plugins_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutList]: + """Get all Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_dashboard_plugins_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_all_entities_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_dashboard_plugins_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def get_all_entities_dashboard_plugins( + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_dashboard_plugins_serialize( self, workspace_id, - **kwargs - ): - """Get all Plugins # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_dashboard_plugins(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Get a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Get a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_dashboard_plugins( + + def _get_entity_dashboard_plugins_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_dashboard_plugins(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def patch_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Patch a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_patch_document: (required) + :type json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_patch_document=json_api_dashboard_plugin_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Patch a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_patch_document: (required) + :type json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_patch_document=json_api_dashboard_plugin_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_patch_document: (required) + :type json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_patch_document=json_api_dashboard_plugin_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + return response_data.response - def patch_entity_dashboard_plugins( + + def _patch_entity_dashboard_plugins_serialize( self, workspace_id, object_id, json_api_dashboard_plugin_patch_document, - **kwargs - ): - """Patch a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_dashboard_plugin_patch_document (JsonApiDashboardPluginPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_dashboard_plugin_patch_document is not None: + _body_params = json_api_dashboard_plugin_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def update_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Put a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_in_document: (required) + :type json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_in_document=json_api_dashboard_plugin_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Put a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_in_document: (required) + :type json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_in_document=json_api_dashboard_plugin_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def update_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_in_document: (required) + :type json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_in_document=json_api_dashboard_plugin_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_dashboard_plugin_patch_document'] = \ - json_api_dashboard_plugin_patch_document - return self.patch_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + return response_data.response - def update_entity_dashboard_plugins( + + def _update_entity_dashboard_plugins_serialize( self, workspace_id, object_id, json_api_dashboard_plugin_in_document, - **kwargs - ): - """Put a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_dashboard_plugin_in_document (JsonApiDashboardPluginInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_dashboard_plugin_in_document is not None: + _body_params = json_api_dashboard_plugin_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_dashboard_plugin_in_document'] = \ - json_api_dashboard_plugin_in_document - return self.update_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/raw_export_api.py b/gooddata-api-client/gooddata_api_client/api/raw_export_api.py index 7066a0f4d..36e40907a 100644 --- a/gooddata-api-client/gooddata_api_client/api/raw_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/raw_export_api.py @@ -1,327 +1,608 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictBytes, StrictStr +from typing import Tuple, Union +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.raw_export_request import RawExportRequest -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.raw_export_request import RawExportRequest +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class RawExportApi(object): +class RawExportApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_raw_export_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/raw', - 'operation_id': 'create_raw_export', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'raw_export_request', - ], - 'required': [ - 'workspace_id', - 'raw_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'raw_export_request': - (RawExportRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'raw_export_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.get_raw_export_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}', - 'operation_id': 'get_raw_export', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.apache.arrow.file', - 'application/vnd.apache.arrow.stream', - 'text/csv' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def create_raw_export( self, - workspace_id, - raw_export_request, - **kwargs - ): - """(EXPERIMENTAL) Create raw export request # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_raw_export(workspace_id, raw_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - raw_export_request (RawExportRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + raw_export_request: RawExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """(EXPERIMENTAL) Create raw export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param raw_export_request: (required) + :type raw_export_request: RawExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_raw_export_serialize( + workspace_id=workspace_id, + raw_export_request=raw_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_raw_export_with_http_info( + self, + workspace_id: StrictStr, + raw_export_request: RawExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """(EXPERIMENTAL) Create raw export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param raw_export_request: (required) + :type raw_export_request: RawExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_raw_export_serialize( + workspace_id=workspace_id, + raw_export_request=raw_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def create_raw_export_without_preload_content( + self, + workspace_id: StrictStr, + raw_export_request: RawExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Create raw export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param raw_export_request: (required) + :type raw_export_request: RawExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_raw_export_serialize( + workspace_id=workspace_id, + raw_export_request=raw_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['raw_export_request'] = \ - raw_export_request - return self.create_raw_export_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_raw_export( + + def _create_raw_export_serialize( self, workspace_id, - export_id, - **kwargs - ): - """(EXPERIMENTAL) Retrieve exported files # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_raw_export(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - file_type - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + raw_export_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if raw_export_request is not None: + _body_params = raw_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/raw', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_raw_export( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_raw_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_raw_export_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_raw_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_raw_export_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_raw_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_raw_export_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.apache.arrow.file', + 'application/vnd.apache.arrow.stream', + 'text/csv' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_raw_export_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/reporting_settings_api.py b/gooddata-api-client/gooddata_api_client/api/reporting_settings_api.py index f1a09a934..2551db9ca 100644 --- a/gooddata-api-client/gooddata_api_client/api/reporting_settings_api.py +++ b/gooddata-api-client/gooddata_api_client/api/reporting_settings_api.py @@ -1,293 +1,557 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from typing import List +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class ReportingSettingsApi(object): +class ReportingSettingsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.resolve_all_settings_without_workspace_endpoint = _Endpoint( - settings={ - 'response_type': ([ResolvedSetting],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/resolveSettings', - 'operation_id': 'resolve_all_settings_without_workspace', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.resolve_settings_without_workspace_endpoint = _Endpoint( - settings={ - 'response_type': ([ResolvedSetting],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/resolveSettings', - 'operation_id': 'resolve_settings_without_workspace', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'resolve_settings_request', - ], - 'required': [ - 'resolve_settings_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'resolve_settings_request': - (ResolveSettingsRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'resolve_settings_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def resolve_all_settings_without_workspace( self, - **kwargs - ): - """Values for all settings without workspace. # noqa: E501 - - Resolves values for all settings without workspace by current user, organization, or default settings. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.resolve_all_settings_without_workspace(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ResolvedSetting] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ResolvedSetting]: + """Values for all settings without workspace. + + Resolves values for all settings without workspace by current user, organization, or default settings. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_settings_without_workspace_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def resolve_all_settings_without_workspace_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ResolvedSetting]]: + """Values for all settings without workspace. + + Resolves values for all settings without workspace by current user, organization, or default settings. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_settings_without_workspace_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def resolve_all_settings_without_workspace_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for all settings without workspace. + + Resolves values for all settings without workspace by current user, organization, or default settings. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_all_settings_without_workspace_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.resolve_all_settings_without_workspace_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _resolve_all_settings_without_workspace_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/resolveSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def resolve_settings_without_workspace( self, - resolve_settings_request, - **kwargs - ): - """Values for selected settings without workspace. # noqa: E501 - - Resolves values for selected settings without workspace by current user, organization, or default settings. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.resolve_settings_without_workspace(resolve_settings_request, async_req=True) - >>> result = thread.get() - - Args: - resolve_settings_request (ResolveSettingsRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ResolvedSetting] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ResolvedSetting]: + """Values for selected settings without workspace. + + Resolves values for selected settings without workspace by current user, organization, or default settings. + + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_settings_without_workspace_serialize( + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def resolve_settings_without_workspace_with_http_info( + self, + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ResolvedSetting]]: + """Values for selected settings without workspace. + + Resolves values for selected settings without workspace by current user, organization, or default settings. + + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_settings_without_workspace_serialize( + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def resolve_settings_without_workspace_without_preload_content( + self, + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for selected settings without workspace. + + Resolves values for selected settings without workspace by current user, organization, or default settings. + + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_settings_without_workspace_serialize( + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _resolve_settings_without_workspace_serialize( + self, + resolve_settings_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if resolve_settings_request is not None: + _body_params = resolve_settings_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/resolveSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['resolve_settings_request'] = \ - resolve_settings_request - return self.resolve_settings_without_workspace_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/scanning_api.py b/gooddata-api-client/gooddata_api_client/api/scanning_api.py index 6ec4bd866..a76de300b 100644 --- a/gooddata-api-client/gooddata_api_client/api/scanning_api.py +++ b/gooddata-api-client/gooddata_api_client/api/scanning_api.py @@ -1,482 +1,879 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.data_source_schemata import DataSourceSchemata -from gooddata_api_client.model.scan_request import ScanRequest -from gooddata_api_client.model.scan_result_pdm import ScanResultPdm -from gooddata_api_client.model.scan_sql_request import ScanSqlRequest -from gooddata_api_client.model.scan_sql_response import ScanSqlResponse +from pydantic import Field, field_validator +from typing_extensions import Annotated +from gooddata_api_client.models.data_source_schemata import DataSourceSchemata +from gooddata_api_client.models.scan_request import ScanRequest +from gooddata_api_client.models.scan_result_pdm import ScanResultPdm +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class ScanningApi(object): + +class ScanningApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_data_source_schemata_endpoint = _Endpoint( - settings={ - 'response_type': (DataSourceSchemata,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/scanSchemata', - 'operation_id': 'get_data_source_schemata', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - ], - 'required': [ - 'data_source_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'data_source_id', - ] - }, - root_map={ - 'validations': { - ('data_source_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.scan_data_source_endpoint = _Endpoint( - settings={ - 'response_type': (ScanResultPdm,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/scan', - 'operation_id': 'scan_data_source', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'scan_request', - ], - 'required': [ - 'data_source_id', - 'scan_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'data_source_id', - ] - }, - root_map={ - 'validations': { - ('data_source_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'scan_request': - (ScanRequest,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'scan_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.scan_sql_endpoint = _Endpoint( - settings={ - 'response_type': (ScanSqlResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/scanSql', - 'operation_id': 'scan_sql', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'scan_sql_request', - ], - 'required': [ - 'data_source_id', - 'scan_sql_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'data_source_id', - ] - }, - root_map={ - 'validations': { - ('data_source_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'scan_sql_request': - (ScanSqlRequest,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'scan_sql_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def get_data_source_schemata( self, - data_source_id, - **kwargs - ): - """Get a list of schema names of a database # noqa: E501 - - It scans a database and reads metadata. The result of the request contains a list of schema names of a database. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_data_source_schemata(data_source_id, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): Data source id - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DataSourceSchemata - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataSourceSchemata: + """Get a list of schema names of a database + + It scans a database and reads metadata. The result of the request contains a list of schema names of a database. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_schemata_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataSourceSchemata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_source_schemata_with_http_info( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataSourceSchemata]: + """Get a list of schema names of a database + + It scans a database and reads metadata. The result of the request contains a list of schema names of a database. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_schemata_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataSourceSchemata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_data_source_schemata_without_preload_content( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a list of schema names of a database + + It scans a database and reads metadata. The result of the request contains a list of schema names of a database. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_source_schemata_serialize( + data_source_id=data_source_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataSourceSchemata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - return self.get_data_source_schemata_endpoint.call_with_http_info(**kwargs) + return response_data.response - def scan_data_source( + + def _get_data_source_schemata_serialize( self, data_source_id, - scan_request, - **kwargs - ): - """Scan a database to get a physical data model (PDM) # noqa: E501 - - It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.scan_data_source(data_source_id, scan_request, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): Data source id - scan_request (ScanRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ScanResultPdm - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/scanSchemata', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def scan_data_source( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_request: ScanRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScanResultPdm: + """Scan a database to get a physical data model (PDM) + + It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_request: (required) + :type scan_request: ScanRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_data_source_serialize( + data_source_id=data_source_id, + scan_request=scan_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanResultPdm", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def scan_data_source_with_http_info( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_request: ScanRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScanResultPdm]: + """Scan a database to get a physical data model (PDM) + + It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_request: (required) + :type scan_request: ScanRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_data_source_serialize( + data_source_id=data_source_id, + scan_request=scan_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanResultPdm", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def scan_data_source_without_preload_content( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_request: ScanRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Scan a database to get a physical data model (PDM) + + It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_request: (required) + :type scan_request: ScanRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_data_source_serialize( + data_source_id=data_source_id, + scan_request=scan_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanResultPdm", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _scan_data_source_serialize( + self, + data_source_id, + scan_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if scan_request is not None: + _body_params = scan_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/scan', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['scan_request'] = \ - scan_request - return self.scan_data_source_endpoint.call_with_http_info(**kwargs) + + + + @validate_call def scan_sql( self, - data_source_id, - scan_sql_request, - **kwargs - ): - """Collect metadata about SQL query # noqa: E501 - - It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.scan_sql(data_source_id, scan_sql_request, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): Data source id - scan_sql_request (ScanSqlRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ScanSqlResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_sql_request: ScanSqlRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScanSqlResponse: + """Collect metadata about SQL query + + It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_sql_request: (required) + :type scan_sql_request: ScanSqlRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_sql_serialize( + data_source_id=data_source_id, + scan_sql_request=scan_sql_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanSqlResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def scan_sql_with_http_info( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_sql_request: ScanSqlRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScanSqlResponse]: + """Collect metadata about SQL query + + It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_sql_request: (required) + :type scan_sql_request: ScanSqlRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_sql_serialize( + data_source_id=data_source_id, + scan_sql_request=scan_sql_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanSqlResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def scan_sql_without_preload_content( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + scan_sql_request: ScanSqlRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Collect metadata about SQL query + + It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param scan_sql_request: (required) + :type scan_sql_request: ScanSqlRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._scan_sql_serialize( + data_source_id=data_source_id, + scan_sql_request=scan_sql_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanSqlResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['scan_sql_request'] = \ - scan_sql_request - return self.scan_sql_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _scan_sql_serialize( + self, + data_source_id, + scan_sql_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if scan_sql_request is not None: + _body_params = scan_sql_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/scanSql', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/slides_export_api.py b/gooddata-api-client/gooddata_api_client/api/slides_export_api.py index 3cc37b6a5..7304ebbd3 100644 --- a/gooddata-api-client/gooddata_api_client/api/slides_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/slides_export_api.py @@ -1,475 +1,897 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner -from gooddata_api_client.model.slides_export_request import SlidesExportRequest +from pydantic import StrictBool, StrictBytes, StrictStr +from typing import Optional, Tuple, Union +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.slides_export_request import SlidesExportRequest +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class SlidesExportApi(object): + +class SlidesExportApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_slides_export_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides', - 'operation_id': 'create_slides_export', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'slides_export_request', - 'x_gdc_debug', - ], - 'required': [ - 'workspace_id', - 'slides_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'slides_export_request': - (SlidesExportRequest,), - 'x_gdc_debug': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'x_gdc_debug': 'X-Gdc-Debug', - }, - 'location_map': { - 'workspace_id': 'path', - 'slides_export_request': 'body', - 'x_gdc_debug': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.get_slides_export_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}', - 'operation_id': 'get_slides_export', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/pdf', - 'application/vnd.openxmlformats-officedocument.presentationml.presentation' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_slides_export_metadata_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata', - 'operation_id': 'get_slides_export_metadata', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def create_slides_export( self, - workspace_id, - slides_export_request, - **kwargs - ): - """(EXPERIMENTAL) Create slides export request # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_slides_export(workspace_id, slides_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - slides_export_request (SlidesExportRequest): - - Keyword Args: - x_gdc_debug (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + slides_export_request: SlidesExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """(EXPERIMENTAL) Create slides export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param slides_export_request: (required) + :type slides_export_request: SlidesExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_slides_export_serialize( + workspace_id=workspace_id, + slides_export_request=slides_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_slides_export_with_http_info( + self, + workspace_id: StrictStr, + slides_export_request: SlidesExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """(EXPERIMENTAL) Create slides export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param slides_export_request: (required) + :type slides_export_request: SlidesExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_slides_export_serialize( + workspace_id=workspace_id, + slides_export_request=slides_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def create_slides_export_without_preload_content( + self, + workspace_id: StrictStr, + slides_export_request: SlidesExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Create slides export request + + Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param slides_export_request: (required) + :type slides_export_request: SlidesExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_slides_export_serialize( + workspace_id=workspace_id, + slides_export_request=slides_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _create_slides_export_serialize( + self, + workspace_id, + slides_export_request, + x_gdc_debug, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + if x_gdc_debug is not None: + _header_params['X-Gdc-Debug'] = x_gdc_debug + # process the form parameters + # process the body parameter + if slides_export_request is not None: + _body_params = slides_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/slides', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['slides_export_request'] = \ - slides_export_request - return self.create_slides_export_endpoint.call_with_http_info(**kwargs) + + + + @validate_call def get_slides_export( self, - workspace_id, - export_id, - **kwargs - ): - """(EXPERIMENTAL) Retrieve exported files # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_slides_export(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - file_type - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_slides_export_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_slides_export_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Retrieve exported files + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "List[GetImageExport202ResponseInner]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_slides_export_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_slides_export_metadata( + + def _get_slides_export_serialize( self, workspace_id, export_id, - **kwargs - ): - """(EXPERIMENTAL) Retrieve metadata context # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_slides_export_metadata(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/pdf', + 'application/vnd.openxmlformats-officedocument.presentationml.presentation' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_slides_export_metadata( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_slides_export_metadata_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_slides_export_metadata_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Retrieve metadata context + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_slides_export_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_slides_export_metadata_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _get_slides_export_metadata_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py b/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py index 0940f523d..47d18a5c1 100644 --- a/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py @@ -1,3213 +1,6088 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - + Generated by OpenAPI Generator (https://openapi-generator.tech) -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags -from gooddata_api_client.model.anomaly_detection_request import AnomalyDetectionRequest -from gooddata_api_client.model.anomaly_detection_result import AnomalyDetectionResult -from gooddata_api_client.model.chat_history_request import ChatHistoryRequest -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_request import ChatRequest -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.chat_usage_response import ChatUsageResponse -from gooddata_api_client.model.clustering_request import ClusteringRequest -from gooddata_api_client.model.clustering_result import ClusteringResult -from gooddata_api_client.model.forecast_request import ForecastRequest -from gooddata_api_client.model.forecast_result import ForecastResult -from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse -from gooddata_api_client.model.memory_item import MemoryItem -from gooddata_api_client.model.resolved_llm_endpoints import ResolvedLlmEndpoints -from gooddata_api_client.model.search_request import SearchRequest -from gooddata_api_client.model.search_result import SearchResult -from gooddata_api_client.model.smart_function_response import SmartFunctionResponse -from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest -from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest -from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse - - -class SmartFunctionsApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Any, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.analytics_catalog_tags import AnalyticsCatalogTags +from gooddata_api_client.models.anomaly_detection_request import AnomalyDetectionRequest +from gooddata_api_client.models.anomaly_detection_result import AnomalyDetectionResult +from gooddata_api_client.models.chat_history_request import ChatHistoryRequest +from gooddata_api_client.models.chat_history_result import ChatHistoryResult +from gooddata_api_client.models.chat_request import ChatRequest +from gooddata_api_client.models.chat_result import ChatResult +from gooddata_api_client.models.chat_usage_response import ChatUsageResponse +from gooddata_api_client.models.clustering_request import ClusteringRequest +from gooddata_api_client.models.clustering_result import ClusteringResult +from gooddata_api_client.models.forecast_request import ForecastRequest +from gooddata_api_client.models.forecast_result import ForecastResult +from gooddata_api_client.models.get_quality_issues_response import GetQualityIssuesResponse +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.models.resolved_llm_endpoints import ResolvedLlmEndpoints +from gooddata_api_client.models.search_request import SearchRequest +from gooddata_api_client.models.search_result import SearchResult +from gooddata_api_client.models.smart_function_response import SmartFunctionResponse +from gooddata_api_client.models.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest +from gooddata_api_client.models.validate_llm_endpoint_request import ValidateLLMEndpointRequest +from gooddata_api_client.models.validate_llm_endpoint_response import ValidateLLMEndpointResponse + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class SmartFunctionsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.ai_chat_endpoint = _Endpoint( - settings={ - 'response_type': (ChatResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chat', - 'operation_id': 'ai_chat', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'chat_request', - ], - 'required': [ - 'workspace_id', - 'chat_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'chat_request': - (ChatRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'chat_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.ai_chat_history_endpoint = _Endpoint( - settings={ - 'response_type': (ChatHistoryResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory', - 'operation_id': 'ai_chat_history', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'chat_history_request', - ], - 'required': [ - 'workspace_id', - 'chat_history_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'chat_history_request': - (ChatHistoryRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'chat_history_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.ai_chat_stream_endpoint = _Endpoint( - settings={ - 'response_type': ([dict],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatStream', - 'operation_id': 'ai_chat_stream', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'chat_request', - ], - 'required': [ - 'workspace_id', - 'chat_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'chat_request': - (ChatRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'chat_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/event-stream' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.ai_chat_usage_endpoint = _Endpoint( - settings={ - 'response_type': (ChatUsageResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage', - 'operation_id': 'ai_chat_usage', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.ai_search_endpoint = _Endpoint( - settings={ - 'response_type': (SearchResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/search', - 'operation_id': 'ai_search', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'search_request', - ], - 'required': [ - 'workspace_id', - 'search_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'search_request': - (SearchRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'search_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.anomaly_detection_endpoint = _Endpoint( - settings={ - 'response_type': (SmartFunctionResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}', - 'operation_id': 'anomaly_detection', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'anomaly_detection_request', - 'skip_cache', - ], - 'required': [ - 'workspace_id', - 'result_id', - 'anomaly_detection_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'anomaly_detection_request': - (AnomalyDetectionRequest,), - 'skip_cache': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'skip_cache': 'skip-cache', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'anomaly_detection_request': 'body', - 'skip_cache': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.anomaly_detection_result_endpoint = _Endpoint( - settings={ - 'response_type': (AnomalyDetectionResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}', - 'operation_id': 'anomaly_detection_result', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'offset', - 'limit', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'offset': - (int,), - 'limit': - (int,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'offset': 'offset', - 'limit': 'limit', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'offset': 'query', - 'limit': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.clustering_endpoint = _Endpoint( - settings={ - 'response_type': (SmartFunctionResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId}', - 'operation_id': 'clustering', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'clustering_request', - 'skip_cache', - ], - 'required': [ - 'workspace_id', - 'result_id', - 'clustering_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'clustering_request': - (ClusteringRequest,), - 'skip_cache': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'skip_cache': 'skip-cache', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'clustering_request': 'body', - 'skip_cache': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.clustering_result_endpoint = _Endpoint( - settings={ - 'response_type': (ClusteringResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId}', - 'operation_id': 'clustering_result', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'offset', - 'limit', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'offset': - (int,), - 'limit': - (int,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'offset': 'offset', - 'limit': 'limit', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'offset': 'query', - 'limit': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.create_memory_item_endpoint = _Endpoint( - settings={ - 'response_type': (MemoryItem,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/memory', - 'operation_id': 'create_memory_item', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'memory_item', - ], - 'required': [ - 'workspace_id', - 'memory_item', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'memory_item': - (MemoryItem,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'memory_item': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.forecast_endpoint = _Endpoint( - settings={ - 'response_type': (SmartFunctionResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}', - 'operation_id': 'forecast', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'forecast_request', - 'skip_cache', - ], - 'required': [ - 'workspace_id', - 'result_id', - 'forecast_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'forecast_request': - (ForecastRequest,), - 'skip_cache': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'skip_cache': 'skip-cache', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'forecast_request': 'body', - 'skip_cache': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.forecast_result_endpoint = _Endpoint( - settings={ - 'response_type': (ForecastResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}', - 'operation_id': 'forecast_result', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'result_id', - 'offset', - 'limit', - ], - 'required': [ - 'workspace_id', - 'result_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'result_id': - (str,), - 'offset': - (int,), - 'limit': - (int,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'result_id': 'resultId', - 'offset': 'offset', - 'limit': 'limit', - }, - 'location_map': { - 'workspace_id': 'path', - 'result_id': 'path', - 'offset': 'query', - 'limit': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_memory_item_endpoint = _Endpoint( - settings={ - 'response_type': (MemoryItem,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', - 'operation_id': 'get_memory_item', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'memory_id', - ], - 'required': [ - 'workspace_id', - 'memory_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'memory_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'memory_id': 'memoryId', - }, - 'location_map': { - 'workspace_id': 'path', - 'memory_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_quality_issues_endpoint = _Endpoint( - settings={ - 'response_type': (GetQualityIssuesResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/issues', - 'operation_id': 'get_quality_issues', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.list_memory_items_endpoint = _Endpoint( - settings={ - 'response_type': ([MemoryItem],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/memory', - 'operation_id': 'list_memory_items', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.remove_memory_item_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', - 'operation_id': 'remove_memory_item', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'memory_id', - ], - 'required': [ - 'workspace_id', - 'memory_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'memory_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'memory_id': 'memoryId', - }, - 'location_map': { - 'workspace_id': 'path', - 'memory_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.resolve_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (ResolvedLlmEndpoints,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints', - 'operation_id': 'resolve_llm_endpoints', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.tags_endpoint = _Endpoint( - settings={ - 'response_type': (AnalyticsCatalogTags,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags', - 'operation_id': 'tags', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.update_memory_item_endpoint = _Endpoint( - settings={ - 'response_type': (MemoryItem,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', - 'operation_id': 'update_memory_item', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'memory_id', - 'memory_item', - ], - 'required': [ - 'workspace_id', - 'memory_id', - 'memory_item', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'memory_id': - (str,), - 'memory_item': - (MemoryItem,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'memory_id': 'memoryId', - }, - 'location_map': { - 'workspace_id': 'path', - 'memory_id': 'path', - 'memory_item': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.validate_llm_endpoint_endpoint = _Endpoint( - settings={ - 'response_type': (ValidateLLMEndpointResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/ai/llmEndpoint/test', - 'operation_id': 'validate_llm_endpoint', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'validate_llm_endpoint_request', - ], - 'required': [ - 'validate_llm_endpoint_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'validate_llm_endpoint_request': - (ValidateLLMEndpointRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'validate_llm_endpoint_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.validate_llm_endpoint_by_id_endpoint = _Endpoint( - settings={ - 'response_type': (ValidateLLMEndpointResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test', - 'operation_id': 'validate_llm_endpoint_by_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'llm_endpoint_id', - 'validate_llm_endpoint_by_id_request', - ], - 'required': [ - 'llm_endpoint_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'llm_endpoint_id': - (str,), - 'validate_llm_endpoint_by_id_request': - (ValidateLLMEndpointByIdRequest,), - }, - 'attribute_map': { - 'llm_endpoint_id': 'llmEndpointId', - }, - 'location_map': { - 'llm_endpoint_id': 'path', - 'validate_llm_endpoint_by_id_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def ai_chat( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ChatResult: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ai_chat_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ChatResult]: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ai_chat_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_chat_serialize( self, workspace_id, chat_request, - **kwargs - ): - """(BETA) Chat with AI # noqa: E501 - - (BETA) Combines multiple use cases such as search, create visualizations, ... # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_chat(workspace_id, chat_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - chat_request (ChatRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ChatResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['chat_request'] = \ - chat_request - return self.ai_chat_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if chat_request is not None: + _body_params = chat_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/chat', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def ai_chat_history( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_history_request: ChatHistoryRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ChatHistoryResult: + """(BETA) Get Chat History + + (BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_history_request: (required) + :type chat_history_request: ChatHistoryRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_history_serialize( + workspace_id=workspace_id, + chat_history_request=chat_history_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatHistoryResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ai_chat_history_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_history_request: ChatHistoryRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ChatHistoryResult]: + """(BETA) Get Chat History + + (BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_history_request: (required) + :type chat_history_request: ChatHistoryRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_history_serialize( + workspace_id=workspace_id, + chat_history_request=chat_history_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatHistoryResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ai_chat_history_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_history_request: ChatHistoryRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Get Chat History + + (BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_history_request: (required) + :type chat_history_request: ChatHistoryRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_history_serialize( + workspace_id=workspace_id, + chat_history_request=chat_history_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatHistoryResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_chat_history_serialize( self, workspace_id, chat_history_request, - **kwargs - ): - """(BETA) Get Chat History # noqa: E501 - - (BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_chat_history(workspace_id, chat_history_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - chat_history_request (ChatHistoryRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ChatHistoryResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['chat_history_request'] = \ - chat_history_request - return self.ai_chat_history_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if chat_history_request is not None: + _body_params = chat_history_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def ai_chat_stream( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[object]: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_stream_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[object]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ai_chat_stream_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[object]]: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_stream_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[object]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ai_chat_stream_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + chat_request: ChatRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Chat with AI + + (BETA) Combines multiple use cases such as search, create visualizations, ... + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param chat_request: (required) + :type chat_request: ChatRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_stream_serialize( + workspace_id=workspace_id, + chat_request=chat_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[object]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_chat_stream_serialize( self, workspace_id, chat_request, - **kwargs - ): - """(BETA) Chat with AI # noqa: E501 - - (BETA) Combines multiple use cases such as search, create visualizations, ... # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_chat_stream(workspace_id, chat_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - chat_request (ChatRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [dict] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['chat_request'] = \ - chat_request - return self.ai_chat_stream_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if chat_request is not None: + _body_params = chat_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'text/event-stream' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/chatStream', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def ai_chat_usage( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ChatUsageResponse: + """Get Chat Usage + + Returns usage statistics of chat for a user in a workspace. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_usage_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatUsageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ai_chat_usage_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ChatUsageResponse]: + """Get Chat Usage + + Returns usage statistics of chat for a user in a workspace. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_usage_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatUsageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ai_chat_usage_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Chat Usage + + Returns usage statistics of chat for a user in a workspace. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_chat_usage_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatUsageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_chat_usage_serialize( self, workspace_id, - **kwargs - ): - """Get Chat Usage # noqa: E501 - - Returns usage statistics of chat for a user in a workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_chat_usage(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ChatUsageResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.ai_chat_usage_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def ai_search( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + search_request: SearchRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SearchResult: + """(BETA) Semantic Search in Metadata + + (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param search_request: (required) + :type search_request: SearchRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_search_serialize( + workspace_id=workspace_id, + search_request=search_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SearchResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ai_search_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + search_request: SearchRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SearchResult]: + """(BETA) Semantic Search in Metadata + + (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param search_request: (required) + :type search_request: SearchRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_search_serialize( + workspace_id=workspace_id, + search_request=search_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SearchResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ai_search_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + search_request: SearchRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Semantic Search in Metadata + + (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param search_request: (required) + :type search_request: SearchRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_search_serialize( + workspace_id=workspace_id, + search_request=search_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SearchResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_search_serialize( self, workspace_id, search_request, - **kwargs - ): - """(BETA) Semantic Search in Metadata # noqa: E501 - - (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_search(workspace_id, search_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - search_request (SearchRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - SearchResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['search_request'] = \ - search_request - return self.ai_search_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if search_request is not None: + _body_params = search_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/search', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def anomaly_detection( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + anomaly_detection_request: AnomalyDetectionRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SmartFunctionResponse: + """(EXPERIMENTAL) Smart functions - Anomaly Detection + + (EXPERIMENTAL) Computes anomaly detection. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param anomaly_detection_request: (required) + :type anomaly_detection_request: AnomalyDetectionRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_serialize( + workspace_id=workspace_id, + result_id=result_id, + anomaly_detection_request=anomaly_detection_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def anomaly_detection_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + anomaly_detection_request: AnomalyDetectionRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SmartFunctionResponse]: + """(EXPERIMENTAL) Smart functions - Anomaly Detection + + (EXPERIMENTAL) Computes anomaly detection. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param anomaly_detection_request: (required) + :type anomaly_detection_request: AnomalyDetectionRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_serialize( + workspace_id=workspace_id, + result_id=result_id, + anomaly_detection_request=anomaly_detection_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def anomaly_detection_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + anomaly_detection_request: AnomalyDetectionRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Smart functions - Anomaly Detection + + (EXPERIMENTAL) Computes anomaly detection. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param anomaly_detection_request: (required) + :type anomaly_detection_request: AnomalyDetectionRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_serialize( + workspace_id=workspace_id, + result_id=result_id, + anomaly_detection_request=anomaly_detection_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _anomaly_detection_serialize( self, workspace_id, result_id, anomaly_detection_request, - **kwargs - ): - """(EXPERIMENTAL) Smart functions - Anomaly Detection # noqa: E501 - - (EXPERIMENTAL) Computes anomaly detection. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.anomaly_detection(workspace_id, result_id, anomaly_detection_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Input result ID to be used in the computation - anomaly_detection_request (AnomalyDetectionRequest): - - Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - SmartFunctionResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - kwargs['anomaly_detection_request'] = \ - anomaly_detection_request - return self.anomaly_detection_endpoint.call_with_http_info(**kwargs) - + skip_cache, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + # process the form parameters + # process the body parameter + if anomaly_detection_request is not None: + _body_params = anomaly_detection_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def anomaly_detection_result( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnomalyDetectionResult: + """(EXPERIMENTAL) Smart functions - Anomaly Detection Result + + (EXPERIMENTAL) Gets anomalies. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnomalyDetectionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def anomaly_detection_result_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnomalyDetectionResult]: + """(EXPERIMENTAL) Smart functions - Anomaly Detection Result + + (EXPERIMENTAL) Gets anomalies. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnomalyDetectionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def anomaly_detection_result_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Smart functions - Anomaly Detection Result + + (EXPERIMENTAL) Gets anomalies. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._anomaly_detection_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnomalyDetectionResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _anomaly_detection_result_serialize( self, workspace_id, result_id, - **kwargs - ): - """(EXPERIMENTAL) Smart functions - Anomaly Detection Result # noqa: E501 - - (EXPERIMENTAL) Gets anomalies. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.anomaly_detection_result(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - offset (int): [optional] - limit (int): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AnomalyDetectionResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.anomaly_detection_result_endpoint.call_with_http_info(**kwargs) + offset, + limit, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def clustering( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + clustering_request: ClusteringRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SmartFunctionResponse: + """(EXPERIMENTAL) Smart functions - Clustering + + (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param clustering_request: (required) + :type clustering_request: ClusteringRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_serialize( + workspace_id=workspace_id, + result_id=result_id, + clustering_request=clustering_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def clustering_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + clustering_request: ClusteringRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SmartFunctionResponse]: + """(EXPERIMENTAL) Smart functions - Clustering + + (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param clustering_request: (required) + :type clustering_request: ClusteringRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_serialize( + workspace_id=workspace_id, + result_id=result_id, + clustering_request=clustering_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def clustering_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + clustering_request: ClusteringRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Smart functions - Clustering + + (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param clustering_request: (required) + :type clustering_request: ClusteringRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_serialize( + workspace_id=workspace_id, + result_id=result_id, + clustering_request=clustering_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _clustering_serialize( self, workspace_id, result_id, clustering_request, - **kwargs - ): - """(EXPERIMENTAL) Smart functions - Clustering # noqa: E501 - - (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.clustering(workspace_id, result_id, clustering_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Input result ID to be used in the computation - clustering_request (ClusteringRequest): - - Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - SmartFunctionResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - kwargs['clustering_request'] = \ - clustering_request - return self.clustering_endpoint.call_with_http_info(**kwargs) - + skip_cache, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + # process the form parameters + # process the body parameter + if clustering_request is not None: + _body_params = clustering_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def clustering_result( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ClusteringResult: + """(EXPERIMENTAL) Smart functions - Clustering Result + + (EXPERIMENTAL) Gets clustering result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ClusteringResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def clustering_result_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ClusteringResult]: + """(EXPERIMENTAL) Smart functions - Clustering Result + + (EXPERIMENTAL) Gets clustering result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ClusteringResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def clustering_result_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Smart functions - Clustering Result + + (EXPERIMENTAL) Gets clustering result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clustering_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ClusteringResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _clustering_result_serialize( self, workspace_id, result_id, - **kwargs - ): - """(EXPERIMENTAL) Smart functions - Clustering Result # noqa: E501 - - (EXPERIMENTAL) Gets clustering result. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.clustering_result(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - offset (int): [optional] - limit (int): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ClusteringResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.clustering_result_endpoint.call_with_http_info(**kwargs) + offset, + limit, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def create_memory_item( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> MemoryItem: + """(EXPERIMENTAL) Create new memory item + + (EXPERIMENTAL) Creates a new memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_memory_item_serialize( + workspace_id=workspace_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_memory_item_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[MemoryItem]: + """(EXPERIMENTAL) Create new memory item + + (EXPERIMENTAL) Creates a new memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_memory_item_serialize( + workspace_id=workspace_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_memory_item_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Create new memory item + + (EXPERIMENTAL) Creates a new memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_memory_item_serialize( + workspace_id=workspace_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_memory_item_serialize( self, workspace_id, memory_item, - **kwargs - ): - """(EXPERIMENTAL) Create new memory item # noqa: E501 - - (EXPERIMENTAL) Creates a new memory item and returns it # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_memory_item(workspace_id, memory_item, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - memory_item (MemoryItem): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - MemoryItem - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['memory_item'] = \ - memory_item - return self.create_memory_item_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if memory_item is not None: + _body_params = memory_item + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/memory', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def forecast( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + forecast_request: ForecastRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SmartFunctionResponse: + """(BETA) Smart functions - Forecast + + (BETA) Computes forecasted data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param forecast_request: (required) + :type forecast_request: ForecastRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_serialize( + workspace_id=workspace_id, + result_id=result_id, + forecast_request=forecast_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def forecast_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + forecast_request: ForecastRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SmartFunctionResponse]: + """(BETA) Smart functions - Forecast + + (BETA) Computes forecasted data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param forecast_request: (required) + :type forecast_request: ForecastRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_serialize( + workspace_id=workspace_id, + result_id=result_id, + forecast_request=forecast_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def forecast_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Input result ID to be used in the computation")], + forecast_request: ForecastRequest, + skip_cache: Annotated[Optional[StrictBool], Field(description="Ignore all caches during execution of current request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Smart functions - Forecast + + (BETA) Computes forecasted data points from the provided execution result and parameters. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Input result ID to be used in the computation (required) + :type result_id: str + :param forecast_request: (required) + :type forecast_request: ForecastRequest + :param skip_cache: Ignore all caches during execution of current request. + :type skip_cache: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_serialize( + workspace_id=workspace_id, + result_id=result_id, + forecast_request=forecast_request, + skip_cache=skip_cache, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SmartFunctionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _forecast_serialize( self, workspace_id, result_id, forecast_request, - **kwargs - ): - """(BETA) Smart functions - Forecast # noqa: E501 - - (BETA) Computes forecasted data points from the provided execution result and parameters. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.forecast(workspace_id, result_id, forecast_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Input result ID to be used in the computation - forecast_request (ForecastRequest): - - Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - SmartFunctionResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - kwargs['forecast_request'] = \ - forecast_request - return self.forecast_endpoint.call_with_http_info(**kwargs) - + skip_cache, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + # process the header parameters + if skip_cache is not None: + _header_params['skip-cache'] = skip_cache + # process the form parameters + # process the body parameter + if forecast_request is not None: + _body_params = forecast_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def forecast_result( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ForecastResult: + """(BETA) Smart functions - Forecast Result + + (BETA) Gets forecast result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ForecastResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def forecast_result_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ForecastResult]: + """(BETA) Smart functions - Forecast Result + + (BETA) Gets forecast result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ForecastResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def forecast_result_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + result_id: Annotated[StrictStr, Field(description="Result ID")], + offset: Optional[StrictInt] = None, + limit: Optional[StrictInt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(BETA) Smart functions - Forecast Result + + (BETA) Gets forecast result. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param result_id: Result ID (required) + :type result_id: str + :param offset: + :type offset: int + :param limit: + :type limit: int + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._forecast_result_serialize( + workspace_id=workspace_id, + result_id=result_id, + offset=offset, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ForecastResult", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _forecast_result_serialize( self, workspace_id, result_id, - **kwargs - ): - """(BETA) Smart functions - Forecast Result # noqa: E501 - - (BETA) Gets forecast result. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.forecast_result(workspace_id, result_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - result_id (str): Result ID - - Keyword Args: - offset (int): [optional] - limit (int): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ForecastResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['result_id'] = \ - result_id - return self.forecast_result_endpoint.call_with_http_info(**kwargs) + offset, + limit, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if result_id is not None: + _path_params['resultId'] = result_id + # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_memory_item( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> MemoryItem: + """(EXPERIMENTAL) Get memory item + + (EXPERIMENTAL) Get memory item by id + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_memory_item_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[MemoryItem]: + """(EXPERIMENTAL) Get memory item + + (EXPERIMENTAL) Get memory item by id + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_memory_item_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Get memory item + + (EXPERIMENTAL) Get memory item by id + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_memory_item_serialize( self, workspace_id, memory_id, - **kwargs - ): - """(EXPERIMENTAL) Get memory item # noqa: E501 - - (EXPERIMENTAL) Get memory item by id # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_memory_item(workspace_id, memory_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - memory_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - MemoryItem - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['memory_id'] = \ - memory_id - return self.get_memory_item_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if memory_id is not None: + _path_params['memoryId'] = memory_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_quality_issues( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GetQualityIssuesResponse: + """Get Quality Issues + + Returns metadata quality issues detected by the platform linter. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_quality_issues_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetQualityIssuesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_quality_issues_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GetQualityIssuesResponse]: + """Get Quality Issues + + Returns metadata quality issues detected by the platform linter. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_quality_issues_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetQualityIssuesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_quality_issues_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Quality Issues + + Returns metadata quality issues detected by the platform linter. + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_quality_issues_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetQualityIssuesResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_quality_issues_serialize( self, workspace_id, - **kwargs - ): - """Get Quality Issues # noqa: E501 - - Returns metadata quality issues detected by the platform linter. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_quality_issues(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - GetQualityIssuesResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_quality_issues_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/issues', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def list_memory_items( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[MemoryItem]: + """(EXPERIMENTAL) List all memory items + + (EXPERIMENTAL) Returns a list of memory items + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_memory_items_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[MemoryItem]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_memory_items_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[MemoryItem]]: + """(EXPERIMENTAL) List all memory items + + (EXPERIMENTAL) Returns a list of memory items + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_memory_items_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[MemoryItem]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_memory_items_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) List all memory items + + (EXPERIMENTAL) Returns a list of memory items + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_memory_items_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[MemoryItem]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_memory_items_serialize( self, workspace_id, - **kwargs - ): - """(EXPERIMENTAL) List all memory items # noqa: E501 - - (EXPERIMENTAL) Returns a list of memory items # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_memory_items(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [MemoryItem] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.list_memory_items_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/memory', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def remove_memory_item( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """(EXPERIMENTAL) Remove memory item + + (EXPERIMENTAL) Removes memory item + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def remove_memory_item_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """(EXPERIMENTAL) Remove memory item + + (EXPERIMENTAL) Removes memory item + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def remove_memory_item_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Remove memory item + + (EXPERIMENTAL) Removes memory item + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _remove_memory_item_serialize( self, workspace_id, memory_id, - **kwargs - ): - """(EXPERIMENTAL) Remove memory item # noqa: E501 - - (EXPERIMENTAL) Removes memory item # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.remove_memory_item(workspace_id, memory_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - memory_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['memory_id'] = \ - memory_id - return self.remove_memory_item_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if memory_id is not None: + _path_params['memoryId'] = memory_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def resolve_llm_endpoints( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ResolvedLlmEndpoints: + """Get Active LLM Endpoints for this workspace + + Returns a list of available LLM Endpoints + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_llm_endpoints_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResolvedLlmEndpoints", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def resolve_llm_endpoints_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ResolvedLlmEndpoints]: + """Get Active LLM Endpoints for this workspace + + Returns a list of available LLM Endpoints + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_llm_endpoints_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResolvedLlmEndpoints", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def resolve_llm_endpoints_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Active LLM Endpoints for this workspace + + Returns a list of available LLM Endpoints + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._resolve_llm_endpoints_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResolvedLlmEndpoints", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _resolve_llm_endpoints_serialize( self, workspace_id, - **kwargs - ): - """Get Active LLM Endpoints for this workspace # noqa: E501 - - Returns a list of available LLM Endpoints # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.resolve_llm_endpoints(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ResolvedLlmEndpoints - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.resolve_llm_endpoints_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def tags( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnalyticsCatalogTags: + """Get Analytics Catalog Tags + + Returns a list of tags for this workspace + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalyticsCatalogTags", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def tags_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnalyticsCatalogTags]: + """Get Analytics Catalog Tags + + Returns a list of tags for this workspace + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalyticsCatalogTags", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def tags_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Analytics Catalog Tags + + Returns a list of tags for this workspace + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalyticsCatalogTags", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _tags_serialize( self, workspace_id, - **kwargs - ): - """Get Analytics Catalog Tags # noqa: E501 - - Returns a list of tags for this workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.tags(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - AnalyticsCatalogTags - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.tags_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_memory_item( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> MemoryItem: + """(EXPERIMENTAL) Update memory item + + (EXPERIMENTAL) Updates memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_memory_item_with_http_info( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[MemoryItem]: + """(EXPERIMENTAL) Update memory item + + (EXPERIMENTAL) Updates memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_memory_item_without_preload_content( + self, + workspace_id: Annotated[str, Field(strict=True, description="Workspace identifier")], + memory_id: StrictStr, + memory_item: MemoryItem, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Update memory item + + (EXPERIMENTAL) Updates memory item and returns it + + :param workspace_id: Workspace identifier (required) + :type workspace_id: str + :param memory_id: (required) + :type memory_id: str + :param memory_item: (required) + :type memory_item: MemoryItem + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_memory_item_serialize( + workspace_id=workspace_id, + memory_id=memory_id, + memory_item=memory_item, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "MemoryItem", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_memory_item_serialize( self, workspace_id, memory_id, memory_item, - **kwargs - ): - """(EXPERIMENTAL) Update memory item # noqa: E501 - - (EXPERIMENTAL) Updates memory item and returns it # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_memory_item(workspace_id, memory_id, memory_item, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - memory_id (str): - memory_item (MemoryItem): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - MemoryItem - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['memory_id'] = \ - memory_id - kwargs['memory_item'] = \ - memory_item - return self.update_memory_item_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if memory_id is not None: + _path_params['memoryId'] = memory_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if memory_item is not None: + _body_params = memory_item + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/actions/workspaces/{workspaceId}/ai/memory/{memoryId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def validate_llm_endpoint( + self, + validate_llm_endpoint_request: ValidateLLMEndpointRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ValidateLLMEndpointResponse: + """Validate LLM Endpoint + + Validates LLM endpoint with provided parameters. + + :param validate_llm_endpoint_request: (required) + :type validate_llm_endpoint_request: ValidateLLMEndpointRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_serialize( + validate_llm_endpoint_request=validate_llm_endpoint_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def validate_llm_endpoint_with_http_info( + self, + validate_llm_endpoint_request: ValidateLLMEndpointRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ValidateLLMEndpointResponse]: + """Validate LLM Endpoint + + Validates LLM endpoint with provided parameters. + + :param validate_llm_endpoint_request: (required) + :type validate_llm_endpoint_request: ValidateLLMEndpointRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_serialize( + validate_llm_endpoint_request=validate_llm_endpoint_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def validate_llm_endpoint_without_preload_content( + self, + validate_llm_endpoint_request: ValidateLLMEndpointRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Validate LLM Endpoint + + Validates LLM endpoint with provided parameters. + + :param validate_llm_endpoint_request: (required) + :type validate_llm_endpoint_request: ValidateLLMEndpointRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_serialize( + validate_llm_endpoint_request=validate_llm_endpoint_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _validate_llm_endpoint_serialize( self, validate_llm_endpoint_request, - **kwargs - ): - """Validate LLM Endpoint # noqa: E501 - - Validates LLM endpoint with provided parameters. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.validate_llm_endpoint(validate_llm_endpoint_request, async_req=True) - >>> result = thread.get() - - Args: - validate_llm_endpoint_request (ValidateLLMEndpointRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ValidateLLMEndpointResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['validate_llm_endpoint_request'] = \ - validate_llm_endpoint_request - return self.validate_llm_endpoint_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if validate_llm_endpoint_request is not None: + _body_params = validate_llm_endpoint_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/ai/llmEndpoint/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def validate_llm_endpoint_by_id( + self, + llm_endpoint_id: StrictStr, + validate_llm_endpoint_by_id_request: Optional[ValidateLLMEndpointByIdRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ValidateLLMEndpointResponse: + """Validate LLM Endpoint By Id + + Validates existing LLM endpoint with provided parameters and updates it if they are valid. + + :param llm_endpoint_id: (required) + :type llm_endpoint_id: str + :param validate_llm_endpoint_by_id_request: + :type validate_llm_endpoint_by_id_request: ValidateLLMEndpointByIdRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_by_id_serialize( + llm_endpoint_id=llm_endpoint_id, + validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def validate_llm_endpoint_by_id_with_http_info( + self, + llm_endpoint_id: StrictStr, + validate_llm_endpoint_by_id_request: Optional[ValidateLLMEndpointByIdRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ValidateLLMEndpointResponse]: + """Validate LLM Endpoint By Id + + Validates existing LLM endpoint with provided parameters and updates it if they are valid. + + :param llm_endpoint_id: (required) + :type llm_endpoint_id: str + :param validate_llm_endpoint_by_id_request: + :type validate_llm_endpoint_by_id_request: ValidateLLMEndpointByIdRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_by_id_serialize( + llm_endpoint_id=llm_endpoint_id, + validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def validate_llm_endpoint_by_id_without_preload_content( + self, + llm_endpoint_id: StrictStr, + validate_llm_endpoint_by_id_request: Optional[ValidateLLMEndpointByIdRequest] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Validate LLM Endpoint By Id + + Validates existing LLM endpoint with provided parameters and updates it if they are valid. + + :param llm_endpoint_id: (required) + :type llm_endpoint_id: str + :param validate_llm_endpoint_by_id_request: + :type validate_llm_endpoint_by_id_request: ValidateLLMEndpointByIdRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_llm_endpoint_by_id_serialize( + llm_endpoint_id=llm_endpoint_id, + validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ValidateLLMEndpointResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _validate_llm_endpoint_by_id_serialize( self, llm_endpoint_id, - **kwargs - ): - """Validate LLM Endpoint By Id # noqa: E501 - - Validates existing LLM endpoint with provided parameters and updates it if they are valid. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.validate_llm_endpoint_by_id(llm_endpoint_id, async_req=True) - >>> result = thread.get() - - Args: - llm_endpoint_id (str): - - Keyword Args: - validate_llm_endpoint_by_id_request (ValidateLLMEndpointByIdRequest): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ValidateLLMEndpointResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['llm_endpoint_id'] = \ - llm_endpoint_id - return self.validate_llm_endpoint_by_id_endpoint.call_with_http_info(**kwargs) + validate_llm_endpoint_by_id_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if llm_endpoint_id is not None: + _path_params['llmEndpointId'] = llm_endpoint_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if validate_llm_endpoint_by_id_request is not None: + _body_params = validate_llm_endpoint_by_id_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/tabular_export_api.py b/gooddata-api-client/gooddata_api_client/api/tabular_export_api.py index 445bfaf4e..df21092b1 100644 --- a/gooddata-api-client/gooddata_api_client/api/tabular_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/tabular_export_api.py @@ -1,482 +1,913 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.dashboard_tabular_export_request import DashboardTabularExportRequest -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from pydantic import StrictBytes, StrictStr +from typing import Tuple, Union +from gooddata_api_client.models.dashboard_tabular_export_request import DashboardTabularExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class TabularExportApi(object): + +class TabularExportApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_dashboard_export_request_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular', - 'operation_id': 'create_dashboard_export_request', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'dashboard_id', - 'dashboard_tabular_export_request', - ], - 'required': [ - 'workspace_id', - 'dashboard_id', - 'dashboard_tabular_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'dashboard_id': - (str,), - 'dashboard_tabular_export_request': - (DashboardTabularExportRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'dashboard_id': 'dashboardId', - }, - 'location_map': { - 'workspace_id': 'path', - 'dashboard_id': 'path', - 'dashboard_tabular_export_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client + + + @validate_call + def create_dashboard_export_request( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + dashboard_tabular_export_request: DashboardTabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """(EXPERIMENTAL) Create dashboard tabular export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param dashboard_tabular_export_request: (required) + :type dashboard_tabular_export_request: DashboardTabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_dashboard_export_request_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + dashboard_tabular_export_request=dashboard_tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.create_tabular_export_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/tabular', - 'operation_id': 'create_tabular_export', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'tabular_export_request', - ], - 'required': [ - 'workspace_id', - 'tabular_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'tabular_export_request': - (TabularExportRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'tabular_export_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.get_tabular_export_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}', - 'operation_id': 'get_tabular_export', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/pdf', - 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', - 'text/csv', - 'text/html' - ], - 'content_type': [], - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_dashboard_export_request_with_http_info( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + dashboard_tabular_export_request: DashboardTabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """(EXPERIMENTAL) Create dashboard tabular export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param dashboard_tabular_export_request: (required) + :type dashboard_tabular_export_request: DashboardTabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_dashboard_export_request_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + dashboard_tabular_export_request=dashboard_tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - def create_dashboard_export_request( + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_dashboard_export_request_without_preload_content( + self, + workspace_id: StrictStr, + dashboard_id: StrictStr, + dashboard_tabular_export_request: DashboardTabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(EXPERIMENTAL) Create dashboard tabular export request + + Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param dashboard_id: (required) + :type dashboard_id: str + :param dashboard_tabular_export_request: (required) + :type dashboard_tabular_export_request: DashboardTabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_dashboard_export_request_serialize( + workspace_id=workspace_id, + dashboard_id=dashboard_id, + dashboard_tabular_export_request=dashboard_tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_dashboard_export_request_serialize( self, workspace_id, dashboard_id, dashboard_tabular_export_request, - **kwargs - ): - """(EXPERIMENTAL) Create dashboard tabular export request # noqa: E501 - - Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_dashboard_export_request(workspace_id, dashboard_id, dashboard_tabular_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - dashboard_id (str): - dashboard_tabular_export_request (DashboardTabularExportRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if dashboard_id is not None: + _path_params['dashboardId'] = dashboard_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if dashboard_tabular_export_request is not None: + _body_params = dashboard_tabular_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def create_tabular_export( + self, + workspace_id: StrictStr, + tabular_export_request: TabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """Create tabular export request + + An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param tabular_export_request: (required) + :type tabular_export_request: TabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tabular_export_serialize( + workspace_id=workspace_id, + tabular_export_request=tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_tabular_export_with_http_info( + self, + workspace_id: StrictStr, + tabular_export_request: TabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """Create tabular export request + + An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param tabular_export_request: (required) + :type tabular_export_request: TabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tabular_export_serialize( + workspace_id=workspace_id, + tabular_export_request=tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def create_tabular_export_without_preload_content( + self, + workspace_id: StrictStr, + tabular_export_request: TabularExportRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create tabular export request + + An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param tabular_export_request: (required) + :type tabular_export_request: TabularExportRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tabular_export_serialize( + workspace_id=workspace_id, + tabular_export_request=tabular_export_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['dashboard_id'] = \ - dashboard_id - kwargs['dashboard_tabular_export_request'] = \ - dashboard_tabular_export_request - return self.create_dashboard_export_request_endpoint.call_with_http_info(**kwargs) + return response_data.response - def create_tabular_export( + + def _create_tabular_export_serialize( self, workspace_id, tabular_export_request, - **kwargs - ): - """Create tabular export request # noqa: E501 - - An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_tabular_export(workspace_id, tabular_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - tabular_export_request (TabularExportRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if tabular_export_request is not None: + _body_params = tabular_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/tabular', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_tabular_export( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """Retrieve exported files + + After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tabular_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_tabular_export_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """Retrieve exported files + + After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tabular_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_tabular_export_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve exported files + + After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tabular_export_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['tabular_export_request'] = \ - tabular_export_request - return self.create_tabular_export_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_tabular_export( + + def _get_tabular_export_serialize( self, workspace_id, export_id, - **kwargs - ): - """Retrieve exported files # noqa: E501 - - After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_tabular_export(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - file_type - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/pdf', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', + 'text/csv', + 'text/html' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_tabular_export_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/test_connection_api.py b/gooddata-api-client/gooddata_api_client/api/test_connection_api.py index b8533b90c..e9e876d2c 100644 --- a/gooddata-api-client/gooddata_api_client/api/test_connection_api.py +++ b/gooddata-api-client/gooddata_api_client/api/test_connection_api.py @@ -1,324 +1,602 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, field_validator +from typing_extensions import Annotated +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_request import TestRequest +from gooddata_api_client.models.test_response import TestResponse -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.test_definition_request import TestDefinitionRequest -from gooddata_api_client.model.test_request import TestRequest -from gooddata_api_client.model.test_response import TestResponse +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class TestConnectionApi(object): +class TestConnectionApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.test_data_source_endpoint = _Endpoint( - settings={ - 'response_type': (TestResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/test', - 'operation_id': 'test_data_source', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'data_source_id', - 'test_request', - ], - 'required': [ - 'data_source_id', - 'test_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'data_source_id', - ] - }, - root_map={ - 'validations': { - ('data_source_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'data_source_id': - (str,), - 'test_request': - (TestRequest,), - }, - 'attribute_map': { - 'data_source_id': 'dataSourceId', - }, - 'location_map': { - 'data_source_id': 'path', - 'test_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.test_data_source_definition_endpoint = _Endpoint( - settings={ - 'response_type': (TestResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSource/test', - 'operation_id': 'test_data_source_definition', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'test_definition_request', - ], - 'required': [ - 'test_definition_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'test_definition_request': - (TestDefinitionRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'test_definition_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def test_data_source( self, - data_source_id, - test_request, - **kwargs - ): - """Test data source connection by data source id # noqa: E501 - - Test if it is possible to connect to a database using an existing data source definition. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.test_data_source(data_source_id, test_request, async_req=True) - >>> result = thread.get() - - Args: - data_source_id (str): Data source id - test_request (TestRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - TestResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + test_request: TestRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TestResponse: + """Test data source connection by data source id + + Test if it is possible to connect to a database using an existing data source definition. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param test_request: (required) + :type test_request: TestRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_serialize( + data_source_id=data_source_id, + test_request=test_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_data_source_with_http_info( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + test_request: TestRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TestResponse]: + """Test data source connection by data source id + + Test if it is possible to connect to a database using an existing data source definition. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param test_request: (required) + :type test_request: TestRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_serialize( + data_source_id=data_source_id, + test_request=test_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def test_data_source_without_preload_content( + self, + data_source_id: Annotated[str, Field(strict=True, description="Data source id")], + test_request: TestRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test data source connection by data source id + + Test if it is possible to connect to a database using an existing data source definition. + + :param data_source_id: Data source id (required) + :type data_source_id: str + :param test_request: (required) + :type test_request: TestRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_serialize( + data_source_id=data_source_id, + test_request=test_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - kwargs['test_request'] = \ - test_request - return self.test_data_source_endpoint.call_with_http_info(**kwargs) + return response_data.response + + def _test_data_source_serialize( + self, + data_source_id, + test_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_source_id is not None: + _path_params['dataSourceId'] = data_source_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if test_request is not None: + _body_params = test_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSources/{dataSourceId}/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def test_data_source_definition( self, - test_definition_request, - **kwargs - ): - """Test connection by data source definition # noqa: E501 - - Test if it is possible to connect to a database using a connection provided by the data source definition in the request body. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.test_data_source_definition(test_definition_request, async_req=True) - >>> result = thread.get() - - Args: - test_definition_request (TestDefinitionRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - TestResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + test_definition_request: TestDefinitionRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TestResponse: + """Test connection by data source definition + + Test if it is possible to connect to a database using a connection provided by the data source definition in the request body. + + :param test_definition_request: (required) + :type test_definition_request: TestDefinitionRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_definition_serialize( + test_definition_request=test_definition_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_data_source_definition_with_http_info( + self, + test_definition_request: TestDefinitionRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TestResponse]: + """Test connection by data source definition + + Test if it is possible to connect to a database using a connection provided by the data source definition in the request body. + + :param test_definition_request: (required) + :type test_definition_request: TestDefinitionRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_definition_serialize( + test_definition_request=test_definition_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def test_data_source_definition_without_preload_content( + self, + test_definition_request: TestDefinitionRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test connection by data source definition + + Test if it is possible to connect to a database using a connection provided by the data source definition in the request body. + + :param test_definition_request: (required) + :type test_definition_request: TestDefinitionRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_data_source_definition_serialize( + test_definition_request=test_definition_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TestResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _test_data_source_definition_serialize( + self, + test_definition_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if test_definition_request is not None: + _body_params = test_definition_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/dataSource/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['test_definition_request'] = \ - test_definition_request - return self.test_data_source_definition_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/translations_api.py b/gooddata-api-client/gooddata_api_client/api/translations_api.py index 267a4919c..8262f5cc6 100644 --- a/gooddata-api-client/gooddata_api_client/api/translations_api.py +++ b/gooddata-api-client/gooddata_api_client/api/translations_api.py @@ -1,597 +1,1150 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictStr +from typing import List +from gooddata_api_client.models.locale_request import LocaleRequest +from gooddata_api_client.models.xliff import Xliff -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.locale_request import LocaleRequest -from gooddata_api_client.model.xliff import Xliff +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class TranslationsApi(object): +class TranslationsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.clean_translations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations/clean', - 'operation_id': 'clean_translations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'locale_request', - ], - 'required': [ - 'workspace_id', - 'locale_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'locale_request': - (LocaleRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'locale_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.get_translation_tags_endpoint = _Endpoint( - settings={ - 'response_type': ([str],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations', - 'operation_id': 'get_translation_tags', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.retrieve_translations_endpoint = _Endpoint( - settings={ - 'response_type': (Xliff,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations/retrieve', - 'operation_id': 'retrieve_translations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'locale_request', - ], - 'required': [ - 'workspace_id', - 'locale_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'locale_request': - (LocaleRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'locale_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/xml' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.set_translations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations/set', - 'operation_id': 'set_translations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'xliff', - ], - 'required': [ - 'workspace_id', - 'xliff', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'xliff': - (Xliff,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'xliff': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/xml' - ] - }, - api_client=api_client - ) + + @validate_call def clean_translations( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Cleans up translations. + + Cleans up all translations for a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clean_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def clean_translations_with_http_info( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Cleans up translations. + + Cleans up all translations for a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clean_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def clean_translations_without_preload_content( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Cleans up translations. + + Cleans up all translations for a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clean_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _clean_translations_serialize( self, workspace_id, locale_request, - **kwargs - ): - """Cleans up translations. # noqa: E501 - - Cleans up all translations for a particular locale. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.clean_translations(workspace_id, locale_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - locale_request (LocaleRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['locale_request'] = \ - locale_request - return self.clean_translations_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if locale_request is not None: + _body_params = locale_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/translations/clean', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_translation_tags( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[str]: + """Get translation tags. + + Provides a list of effective translation tags. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_translation_tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_translation_tags_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[str]]: + """Get translation tags. + + Provides a list of effective translation tags. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_translation_tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_translation_tags_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get translation tags. + + Provides a list of effective translation tags. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_translation_tags_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[str]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_translation_tags_serialize( self, workspace_id, - **kwargs - ): - """Get translation tags. # noqa: E501 - - Provides a list of effective translation tags. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_translation_tags(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [str] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_translation_tags_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/translations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def retrieve_translations( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> Xliff: + """Retrieve translations for entities. + + Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Xliff", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def retrieve_translations_with_http_info( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[Xliff]: + """Retrieve translations for entities. + + Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Xliff", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def retrieve_translations_without_preload_content( + self, + workspace_id: StrictStr, + locale_request: LocaleRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve translations for entities. + + Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value. + + :param workspace_id: (required) + :type workspace_id: str + :param locale_request: (required) + :type locale_request: LocaleRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_translations_serialize( + workspace_id=workspace_id, + locale_request=locale_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Xliff", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _retrieve_translations_serialize( self, workspace_id, locale_request, - **kwargs - ): - """Retrieve translations for entities. # noqa: E501 - - Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.retrieve_translations(workspace_id, locale_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - locale_request (LocaleRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - Xliff - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['locale_request'] = \ - locale_request - return self.retrieve_translations_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if locale_request is not None: + _body_params = locale_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/xml' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/translations/retrieve', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_translations( + self, + workspace_id: StrictStr, + xliff: Xliff, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set translations for entities. + + Set translation for existing entities in a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param xliff: (required) + :type xliff: Xliff + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_translations_serialize( + workspace_id=workspace_id, + xliff=xliff, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_translations_with_http_info( + self, + workspace_id: StrictStr, + xliff: Xliff, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set translations for entities. + + Set translation for existing entities in a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param xliff: (required) + :type xliff: Xliff + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_translations_serialize( + workspace_id=workspace_id, + xliff=xliff, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_translations_without_preload_content( + self, + workspace_id: StrictStr, + xliff: Xliff, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set translations for entities. + + Set translation for existing entities in a particular locale. + + :param workspace_id: (required) + :type workspace_id: str + :param xliff: (required) + :type xliff: Xliff + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_translations_serialize( + workspace_id=workspace_id, + xliff=xliff, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_translations_serialize( self, workspace_id, xliff, - **kwargs - ): - """Set translations for entities. # noqa: E501 - - Set translation for existing entities in a particular locale. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_translations(workspace_id, xliff, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - xliff (Xliff): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['xliff'] = \ - xliff - return self.set_translations_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if xliff is not None: + _body_params = xliff + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/xml' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/translations/set', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/usage_api.py b/gooddata-api-client/gooddata_api_client/api/usage_api.py index 45d593cc3..a2583cbff 100644 --- a/gooddata-api-client/gooddata_api_client/api/usage_api.py +++ b/gooddata-api-client/gooddata_api_client/api/usage_api.py @@ -1,293 +1,557 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from typing import List +from gooddata_api_client.models.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage_request import PlatformUsageRequest -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.platform_usage import PlatformUsage -from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class UsageApi(object): +class UsageApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.all_platform_usage_endpoint = _Endpoint( - settings={ - 'response_type': ([PlatformUsage],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/collectUsage', - 'operation_id': 'all_platform_usage', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.particular_platform_usage_endpoint = _Endpoint( - settings={ - 'response_type': ([PlatformUsage],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/collectUsage', - 'operation_id': 'particular_platform_usage', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'platform_usage_request', - ], - 'required': [ - 'platform_usage_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'platform_usage_request': - (PlatformUsageRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'platform_usage_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def all_platform_usage( self, - **kwargs - ): - """Info about the platform usage. # noqa: E501 - - Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.all_platform_usage(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [PlatformUsage] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[PlatformUsage]: + """Info about the platform usage. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._all_platform_usage_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def all_platform_usage_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[PlatformUsage]]: + """Info about the platform usage. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._all_platform_usage_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def all_platform_usage_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Info about the platform usage. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._all_platform_usage_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.all_platform_usage_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _all_platform_usage_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/collectUsage', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def particular_platform_usage( self, - platform_usage_request, - **kwargs - ): - """Info about the platform usage for particular items. # noqa: E501 - - Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.particular_platform_usage(platform_usage_request, async_req=True) - >>> result = thread.get() - - Args: - platform_usage_request (PlatformUsageRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [PlatformUsage] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + platform_usage_request: PlatformUsageRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[PlatformUsage]: + """Info about the platform usage for particular items. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param platform_usage_request: (required) + :type platform_usage_request: PlatformUsageRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._particular_platform_usage_serialize( + platform_usage_request=platform_usage_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def particular_platform_usage_with_http_info( + self, + platform_usage_request: PlatformUsageRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[PlatformUsage]]: + """Info about the platform usage for particular items. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param platform_usage_request: (required) + :type platform_usage_request: PlatformUsageRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._particular_platform_usage_serialize( + platform_usage_request=platform_usage_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def particular_platform_usage_without_preload_content( + self, + platform_usage_request: PlatformUsageRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Info about the platform usage for particular items. + + Provides information about platform usage, like amount of users, workspaces, ... _NOTE_: The `admin` user is always excluded from this amount. + + :param platform_usage_request: (required) + :type platform_usage_request: PlatformUsageRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._particular_platform_usage_serialize( + platform_usage_request=platform_usage_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[PlatformUsage]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _particular_platform_usage_serialize( + self, + platform_usage_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if platform_usage_request is not None: + _body_params = platform_usage_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/collectUsage', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['platform_usage_request'] = \ - platform_usage_request - return self.particular_platform_usage_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/user_data_filters_api.py b/gooddata-api-client/gooddata_api_client/api/user_data_filters_api.py index c66c89ec5..e0c1c3bae 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_data_filters_api.py +++ b/gooddata-api-client/gooddata_api_client/api/user_data_filters_api.py @@ -1,312 +1,579 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictStr +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class UserDataFiltersApi(object): +class UserDataFiltersApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUserDataFilters,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'get_user_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.set_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'set_user_data_filters', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_user_data_filters', - ], - 'required': [ - 'workspace_id', - 'declarative_user_data_filters', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_user_data_filters': - (DeclarativeUserDataFilters,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_user_data_filters': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def get_user_data_filters( self, - workspace_id, - **kwargs - ): - """Get user data filters # noqa: E501 - - Retrieve current user data filters assigned to the workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_user_data_filters(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUserDataFilters - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUserDataFilters: + """Get user data filters + + Retrieve current user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_data_filters_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUserDataFilters]: + """Get user data filters + + Retrieve current user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_data_filters_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get user data filters + + Retrieve current user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_data_filters_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserDataFilters", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_user_data_filters_endpoint.call_with_http_info(**kwargs) + return response_data.response - def set_user_data_filters( + + def _get_user_data_filters_serialize( self, workspace_id, - declarative_user_data_filters, - **kwargs - ): - """Set user data filters # noqa: E501 - - Set user data filters assigned to the workspace. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_user_data_filters(workspace_id, declarative_user_data_filters, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_user_data_filters (DeclarativeUserDataFilters): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}/userDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def set_user_data_filters( + self, + workspace_id: StrictStr, + declarative_user_data_filters: DeclarativeUserDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set user data filters + + Set user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_user_data_filters: (required) + :type declarative_user_data_filters: DeclarativeUserDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_data_filters_serialize( + workspace_id=workspace_id, + declarative_user_data_filters=declarative_user_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + declarative_user_data_filters: DeclarativeUserDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set user data filters + + Set user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_user_data_filters: (required) + :type declarative_user_data_filters: DeclarativeUserDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_data_filters_serialize( + workspace_id=workspace_id, + declarative_user_data_filters=declarative_user_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def set_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + declarative_user_data_filters: DeclarativeUserDataFilters, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set user data filters + + Set user data filters assigned to the workspace. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_user_data_filters: (required) + :type declarative_user_data_filters: DeclarativeUserDataFilters + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_user_data_filters_serialize( + workspace_id=workspace_id, + declarative_user_data_filters=declarative_user_data_filters, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_user_data_filters'] = \ - declarative_user_data_filters - return self.set_user_data_filters_endpoint.call_with_http_info(**kwargs) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_user_data_filters_serialize( + self, + workspace_id, + declarative_user_data_filters, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_user_data_filters is not None: + _body_params = declarative_user_data_filters + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}/userDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/user_groups_declarative_apis_api.py b/gooddata-api-client/gooddata_api_client/api/user_groups_declarative_apis_api.py index b81ca5d89..3e0da55e8 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_groups_declarative_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/user_groups_declarative_apis_api.py @@ -1,542 +1,1060 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class UserGroupsDeclarativeAPIsApi(object): +class UserGroupsDeclarativeAPIsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_user_groups_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUserGroups,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/userGroups', - 'operation_id': 'get_user_groups_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_users_user_groups_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUsersUserGroups,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/usersAndUserGroups', - 'operation_id': 'get_users_user_groups_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.put_user_groups_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/userGroups', - 'operation_id': 'put_user_groups_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_user_groups', - ], - 'required': [ - 'declarative_user_groups', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_user_groups': - (DeclarativeUserGroups,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_user_groups': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ + + + @validate_call + def get_user_groups_layout( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUserGroups: + """Get all user groups + + Retrieve all user-groups eventually with parent group. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_groups_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUserGroups]: + """Get all user groups + + Retrieve all user-groups eventually with parent group. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_groups_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all user groups + + Retrieve all user-groups eventually with parent group. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_groups_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.put_users_user_groups_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/usersAndUserGroups', - 'operation_id': 'put_users_user_groups_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_users_user_groups', - ], - 'required': [ - 'declarative_users_user_groups', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_users_user_groups': - (DeclarativeUsersUserGroups,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_users_user_groups': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_users_user_groups_layout( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUsersUserGroups: + """Get all users and user groups + + Retrieve all users and user groups with theirs properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsersUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_users_user_groups_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUsersUserGroups]: + """Get all users and user groups + + Retrieve all users and user groups with theirs properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsersUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_users_user_groups_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all users and user groups + + Retrieve all users and user groups with theirs properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_user_groups_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsersUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_users_user_groups_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/usersAndUserGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - def get_user_groups_layout( + + + + @validate_call + def put_user_groups_layout( self, - **kwargs - ): - """Get all user groups # noqa: E501 - - Retrieve all user-groups eventually with parent group. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_user_groups_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUserGroups - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_user_groups_layout_endpoint.call_with_http_info(**kwargs) + declarative_user_groups: DeclarativeUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Put all user groups - def get_users_user_groups_layout( + Define all user groups with their parents eventually. + + :param declarative_user_groups: (required) + :type declarative_user_groups: DeclarativeUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_user_groups_layout_serialize( + declarative_user_groups=declarative_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_user_groups_layout_with_http_info( self, - **kwargs - ): - """Get all users and user groups # noqa: E501 - - Retrieve all users and user groups with theirs properties. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_users_user_groups_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUsersUserGroups - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_users_user_groups_layout_endpoint.call_with_http_info(**kwargs) + declarative_user_groups: DeclarativeUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Put all user groups - def put_user_groups_layout( + Define all user groups with their parents eventually. + + :param declarative_user_groups: (required) + :type declarative_user_groups: DeclarativeUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_user_groups_layout_serialize( + declarative_user_groups=declarative_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_user_groups_layout_without_preload_content( + self, + declarative_user_groups: DeclarativeUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put all user groups + + Define all user groups with their parents eventually. + + :param declarative_user_groups: (required) + :type declarative_user_groups: DeclarativeUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_user_groups_layout_serialize( + declarative_user_groups=declarative_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_user_groups_layout_serialize( self, declarative_user_groups, - **kwargs - ): - """Put all user groups # noqa: E501 - - Define all user groups with their parents eventually. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_user_groups_layout(declarative_user_groups, async_req=True) - >>> result = thread.get() - - Args: - declarative_user_groups (DeclarativeUserGroups): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_user_groups'] = \ - declarative_user_groups - return self.put_user_groups_layout_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_user_groups is not None: + _body_params = declarative_user_groups + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def put_users_user_groups_layout( + self, + declarative_users_user_groups: DeclarativeUsersUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Put all users and user groups + + Define all users and user groups with theirs properties. + + :param declarative_users_user_groups: (required) + :type declarative_users_user_groups: DeclarativeUsersUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_user_groups_layout_serialize( + declarative_users_user_groups=declarative_users_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_users_user_groups_layout_with_http_info( + self, + declarative_users_user_groups: DeclarativeUsersUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Put all users and user groups + + Define all users and user groups with theirs properties. + + :param declarative_users_user_groups: (required) + :type declarative_users_user_groups: DeclarativeUsersUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_user_groups_layout_serialize( + declarative_users_user_groups=declarative_users_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_users_user_groups_layout_without_preload_content( + self, + declarative_users_user_groups: DeclarativeUsersUserGroups, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put all users and user groups + + Define all users and user groups with theirs properties. + + :param declarative_users_user_groups: (required) + :type declarative_users_user_groups: DeclarativeUsersUserGroups + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_user_groups_layout_serialize( + declarative_users_user_groups=declarative_users_user_groups, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_users_user_groups_layout_serialize( self, declarative_users_user_groups, - **kwargs - ): - """Put all users and user groups # noqa: E501 - - Define all users and user groups with theirs properties. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_users_user_groups_layout(declarative_users_user_groups, async_req=True) - >>> result = thread.get() - - Args: - declarative_users_user_groups (DeclarativeUsersUserGroups): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_users_user_groups'] = \ - declarative_users_user_groups - return self.put_users_user_groups_layout_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_users_user_groups is not None: + _body_params = declarative_users_user_groups + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/usersAndUserGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/user_groups_entity_apis_api.py b/gooddata-api-client/gooddata_api_client/api/user_groups_entity_apis_api.py index 89892b9a8..daa1abfc4 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_groups_entity_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/user_groups_entity_apis_api.py @@ -1,1008 +1,1895 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class UserGroupsEntityAPIsApi(object): + +class UserGroupsEntityAPIsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups', - 'operation_id': 'create_entity_user_groups', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_user_group_in_document', - 'include', - ], - 'required': [ - 'json_api_user_group_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_user_group_in_document': - (JsonApiUserGroupInDocument,), - 'include': - ([str],), - }, - 'attribute_map': { - 'include': 'include', - }, - 'location_map': { - 'json_api_user_group_in_document': 'body', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'delete_entity_user_groups', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups', - 'operation_id': 'get_all_entities_user_groups', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'get_entity_user_groups', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'patch_entity_user_groups', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_group_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_group_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_group_patch_document': - (JsonApiUserGroupPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_group_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'update_entity_user_groups', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_group_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_group_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_group_in_document': - (JsonApiUserGroupInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_group_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_user_groups( + self, + json_api_user_group_in_document: JsonApiUserGroupInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Post User Group entities + + User Group - creates tree-like structure for categorizing users + + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_groups_serialize( + json_api_user_group_in_document=json_api_user_group_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_user_groups_with_http_info( + self, + json_api_user_group_in_document: JsonApiUserGroupInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Post User Group entities + + User Group - creates tree-like structure for categorizing users + + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_groups_serialize( + json_api_user_group_in_document=json_api_user_group_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_user_groups_without_preload_content( + self, + json_api_user_group_in_document: JsonApiUserGroupInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post User Group entities + + User Group - creates tree-like structure for categorizing users + + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_groups_serialize( + json_api_user_group_in_document=json_api_user_group_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_user_groups_serialize( self, json_api_user_group_in_document, - **kwargs - ): - """Post User Group entities # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_user_groups(json_api_user_group_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_user_group_in_document (JsonApiUserGroupInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_group_in_document'] = \ - json_api_user_group_in_document - return self.create_entity_user_groups_endpoint.call_with_http_info(**kwargs) + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_group_in_document is not None: + _body_params = json_api_user_group_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_groups_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_groups_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_groups_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_user_groups_serialize( self, id, - **kwargs - ): - """Delete UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_user_groups(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_user_groups_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_user_groups( self, - **kwargs - ): - """Get UserGroup entities # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_groups(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_groups_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutList: + """Get UserGroup entities + + User Group - creates tree-like structure for categorizing users + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_groups_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_groups_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutList]: + """Get UserGroup entities + + User Group - creates tree-like structure for categorizing users + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_groups_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_user_groups_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserGroup entities + + User Group - creates tree-like structure for categorizing users + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_groups_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_user_groups_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Get UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_groups_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Get UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_groups_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_groups_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_groups_serialize( self, id, - **kwargs - ): - """Get UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_groups(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_user_groups_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def patch_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_patch_document: JsonApiUserGroupPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Patch UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_patch_document: (required) + :type json_api_user_group_patch_document: JsonApiUserGroupPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_groups_serialize( + id=id, + json_api_user_group_patch_document=json_api_user_group_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_patch_document: JsonApiUserGroupPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Patch UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_patch_document: (required) + :type json_api_user_group_patch_document: JsonApiUserGroupPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_groups_serialize( + id=id, + json_api_user_group_patch_document=json_api_user_group_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_patch_document: JsonApiUserGroupPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_patch_document: (required) + :type json_api_user_group_patch_document: JsonApiUserGroupPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_groups_serialize( + id=id, + json_api_user_group_patch_document=json_api_user_group_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_user_groups_serialize( self, id, json_api_user_group_patch_document, - **kwargs - ): - """Patch UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_user_groups(id, json_api_user_group_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_group_patch_document (JsonApiUserGroupPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_group_patch_document'] = \ - json_api_user_group_patch_document - return self.patch_entity_user_groups_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_group_patch_document is not None: + _body_params = json_api_user_group_patch_document + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_user_groups( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_in_document: JsonApiUserGroupInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserGroupOutDocument: + """Put UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_groups_serialize( + id=id, + json_api_user_group_in_document=json_api_user_group_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_user_groups_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_in_document: JsonApiUserGroupInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserGroupOutDocument]: + """Put UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_groups_serialize( + id=id, + json_api_user_group_in_document=json_api_user_group_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_user_groups_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_group_in_document: JsonApiUserGroupInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put UserGroup entity + + User Group - creates tree-like structure for categorizing users + + :param id: (required) + :type id: str + :param json_api_user_group_in_document: (required) + :type json_api_user_group_in_document: JsonApiUserGroupInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_groups_serialize( + id=id, + json_api_user_group_in_document=json_api_user_group_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserGroupOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_user_groups_serialize( self, id, json_api_user_group_in_document, - **kwargs - ): - """Put UserGroup entity # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_user_groups(id, json_api_user_group_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_group_in_document (JsonApiUserGroupInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_group_in_document'] = \ - json_api_user_group_in_document - return self.update_entity_user_groups_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_group_in_document is not None: + _body_params = json_api_user_group_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/userGroups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/user_identifiers_api.py b/gooddata-api-client/gooddata_api_client/api/user_identifiers_api.py index 64dd4a105..590a04245 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_identifiers_api.py +++ b/gooddata-api-client/gooddata_api_client/api/user_identifiers_api.py @@ -1,348 +1,650 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.models.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument -from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class UserIdentifiersApi(object): +class UserIdentifiersApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_all_entities_user_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserIdentifierOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userIdentifiers', - 'operation_id': 'get_all_entities_user_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserIdentifierOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userIdentifiers/{id}', - 'operation_id': 'get_entity_user_identifiers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def get_all_entities_user_identifiers( self, - **kwargs - ): - """Get UserIdentifier entities # noqa: E501 - - UserIdentifier - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_identifiers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserIdentifierOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserIdentifierOutList: + """Get UserIdentifier entities + + UserIdentifier - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_identifiers_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserIdentifierOutList]: + """Get UserIdentifier entities + + UserIdentifier - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_all_entities_user_identifiers_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserIdentifier entities + + UserIdentifier - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_identifiers_serialize( + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_identifiers_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _get_all_entities_user_identifiers_serialize( + self, + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userIdentifiers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_user_identifiers( self, - id, - **kwargs - ): - """Get UserIdentifier entity # noqa: E501 - - UserIdentifier - represents basic information about entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_identifiers(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserIdentifierOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserIdentifierOutDocument: + """Get UserIdentifier entity + + UserIdentifier - represents basic information about entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_identifiers_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserIdentifierOutDocument]: + """Get UserIdentifier entity + + UserIdentifier - represents basic information about entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_entity_user_identifiers_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get UserIdentifier entity + + UserIdentifier - represents basic information about entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_identifiers_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserIdentifierOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_identifiers_serialize( + self, + id, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/userIdentifiers/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_user_identifiers_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/user_management_api.py b/gooddata-api-client/gooddata_api_client/api/user_management_api.py index 9ce5cb9a9..c81418043 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_management_api.py +++ b/gooddata-api-client/gooddata_api_client/api/user_management_api.py @@ -1,1691 +1,3389 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated +from pydantic import Field, StrictInt, StrictStr +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.permissions_assignment import PermissionsAssignment +from gooddata_api_client.models.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.models.user_management_user_group_members import UserManagementUserGroupMembers +from gooddata_api_client.models.user_management_user_groups import UserManagementUserGroups +from gooddata_api_client.models.user_management_users import UserManagementUsers -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier -from gooddata_api_client.model.permissions_assignment import PermissionsAssignment -from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments -from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers -from gooddata_api_client.model.user_management_user_groups import UserManagementUserGroups -from gooddata_api_client.model.user_management_users import UserManagementUsers - - -class UserManagementApi(object): +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class UserManagementApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.add_group_members_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers', - 'operation_id': 'add_group_members', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_group_id', - 'user_management_user_group_members', - ], - 'required': [ - 'user_group_id', - 'user_management_user_group_members', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_group_id': - (str,), - 'user_management_user_group_members': - (UserManagementUserGroupMembers,), - }, - 'attribute_map': { - 'user_group_id': 'userGroupId', - }, - 'location_map': { - 'user_group_id': 'path', - 'user_management_user_group_members': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.assign_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/assignPermissions', - 'operation_id': 'assign_permissions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'permissions_assignment', - ], - 'required': [ - 'permissions_assignment', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'permissions_assignment': - (PermissionsAssignment,), - }, - 'attribute_map': { - }, - 'location_map': { - 'permissions_assignment': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.get_group_members_endpoint = _Endpoint( - settings={ - 'response_type': (UserManagementUserGroupMembers,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/userGroups/{userGroupId}/members', - 'operation_id': 'get_group_members', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_group_id', - ], - 'required': [ - 'user_group_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_group_id': - (str,), - }, - 'attribute_map': { - 'user_group_id': 'userGroupId', - }, - 'location_map': { - 'user_group_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.list_permissions_for_user_endpoint = _Endpoint( - settings={ - 'response_type': (UserManagementPermissionAssignments,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/users/{userId}/permissions', - 'operation_id': 'list_permissions_for_user', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - ], - 'required': [ - 'user_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.list_permissions_for_user_group_endpoint = _Endpoint( - settings={ - 'response_type': (UserManagementPermissionAssignments,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions', - 'operation_id': 'list_permissions_for_user_group', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_group_id', - ], - 'required': [ - 'user_group_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_group_id': - (str,), - }, - 'attribute_map': { - 'user_group_id': 'userGroupId', - }, - 'location_map': { - 'user_group_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.list_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (UserManagementUserGroups,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/userGroups', - 'operation_id': 'list_user_groups', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'page', - 'size', - 'name', - 'workspace', - 'data_source', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'page': - (int,), - 'size': - (int,), - 'name': - (str,), - 'workspace': - (str,), - 'data_source': - (str,), - }, - 'attribute_map': { - 'page': 'page', - 'size': 'size', - 'name': 'name', - 'workspace': 'workspace', - 'data_source': 'dataSource', - }, - 'location_map': { - 'page': 'query', - 'size': 'query', - 'name': 'query', - 'workspace': 'query', - 'data_source': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.list_users_endpoint = _Endpoint( - settings={ - 'response_type': (UserManagementUsers,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/users', - 'operation_id': 'list_users', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'page', - 'size', - 'name', - 'workspace', - 'group', - 'data_source', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'page': - (int,), - 'size': - (int,), - 'name': - (str,), - 'workspace': - (str,), - 'group': - (str,), - 'data_source': - (str,), - }, - 'attribute_map': { - 'page': 'page', - 'size': 'size', - 'name': 'name', - 'workspace': 'workspace', - 'group': 'group', - 'data_source': 'dataSource', - }, - 'location_map': { - 'page': 'query', - 'size': 'query', - 'name': 'query', - 'workspace': 'query', - 'group': 'query', - 'data_source': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.manage_permissions_for_user_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/users/{userId}/permissions', - 'operation_id': 'manage_permissions_for_user', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'user_management_permission_assignments', - ], - 'required': [ - 'user_id', - 'user_management_permission_assignments', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'user_management_permission_assignments': - (UserManagementPermissionAssignments,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - 'user_management_permission_assignments': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.manage_permissions_for_user_group_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions', - 'operation_id': 'manage_permissions_for_user_group', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_group_id', - 'user_management_permission_assignments', - ], - 'required': [ - 'user_group_id', - 'user_management_permission_assignments', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_group_id': - (str,), - 'user_management_permission_assignments': - (UserManagementPermissionAssignments,), - }, - 'attribute_map': { - 'user_group_id': 'userGroupId', - }, - 'location_map': { - 'user_group_id': 'path', - 'user_management_permission_assignments': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.remove_group_members_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers', - 'operation_id': 'remove_group_members', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_group_id', - 'user_management_user_group_members', - ], - 'required': [ - 'user_group_id', - 'user_management_user_group_members', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_group_id': - (str,), - 'user_management_user_group_members': - (UserManagementUserGroupMembers,), - }, - 'attribute_map': { - 'user_group_id': 'userGroupId', - }, - 'location_map': { - 'user_group_id': 'path', - 'user_management_user_group_members': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.remove_users_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/removeUsersUserGroups', - 'operation_id': 'remove_users_user_groups', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'assignee_identifier', - ], - 'required': [ - 'assignee_identifier', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'assignee_identifier': - ([AssigneeIdentifier],), - }, - 'attribute_map': { - }, - 'location_map': { - 'assignee_identifier': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.revoke_permissions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/userManagement/revokePermissions', - 'operation_id': 'revoke_permissions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'permissions_assignment', - ], - 'required': [ - 'permissions_assignment', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'permissions_assignment': - (PermissionsAssignment,), - }, - 'attribute_map': { - }, - 'location_map': { - 'permissions_assignment': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def add_group_members( + self, + user_group_id: StrictStr, + user_management_user_group_members: UserManagementUserGroupMembers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """add_group_members + + + :param user_group_id: (required) + :type user_group_id: str + :param user_management_user_group_members: (required) + :type user_management_user_group_members: UserManagementUserGroupMembers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_group_members_serialize( + user_group_id=user_group_id, + user_management_user_group_members=user_management_user_group_members, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def add_group_members_with_http_info( + self, + user_group_id: StrictStr, + user_management_user_group_members: UserManagementUserGroupMembers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """add_group_members + + + :param user_group_id: (required) + :type user_group_id: str + :param user_management_user_group_members: (required) + :type user_management_user_group_members: UserManagementUserGroupMembers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_group_members_serialize( + user_group_id=user_group_id, + user_management_user_group_members=user_management_user_group_members, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def add_group_members_without_preload_content( + self, + user_group_id: StrictStr, + user_management_user_group_members: UserManagementUserGroupMembers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """add_group_members + + + :param user_group_id: (required) + :type user_group_id: str + :param user_management_user_group_members: (required) + :type user_management_user_group_members: UserManagementUserGroupMembers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_group_members_serialize( + user_group_id=user_group_id, + user_management_user_group_members=user_management_user_group_members, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _add_group_members_serialize( self, user_group_id, user_management_user_group_members, - **kwargs - ): - """add_group_members # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.add_group_members(user_group_id, user_management_user_group_members, async_req=True) - >>> result = thread.get() - - Args: - user_group_id (str): - user_management_user_group_members (UserManagementUserGroupMembers): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_group_id'] = \ - user_group_id - kwargs['user_management_user_group_members'] = \ - user_management_user_group_members - return self.add_group_members_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if user_management_user_group_members is not None: + _body_params = user_management_user_group_members + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def assign_permissions( + self, + permissions_assignment: PermissionsAssignment, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """assign_permissions + + + :param permissions_assignment: (required) + :type permissions_assignment: PermissionsAssignment + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_permissions_serialize( + permissions_assignment=permissions_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def assign_permissions_with_http_info( + self, + permissions_assignment: PermissionsAssignment, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """assign_permissions + + + :param permissions_assignment: (required) + :type permissions_assignment: PermissionsAssignment + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_permissions_serialize( + permissions_assignment=permissions_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def assign_permissions_without_preload_content( + self, + permissions_assignment: PermissionsAssignment, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """assign_permissions + + + :param permissions_assignment: (required) + :type permissions_assignment: PermissionsAssignment + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_permissions_serialize( + permissions_assignment=permissions_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _assign_permissions_serialize( self, permissions_assignment, - **kwargs - ): - """assign_permissions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.assign_permissions(permissions_assignment, async_req=True) - >>> result = thread.get() - - Args: - permissions_assignment (PermissionsAssignment): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['permissions_assignment'] = \ - permissions_assignment - return self.assign_permissions_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if permissions_assignment is not None: + _body_params = permissions_assignment + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/userManagement/assignPermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_group_members( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserManagementUserGroupMembers: + """get_group_members + + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_group_members_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementUserGroupMembers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_group_members_with_http_info( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserManagementUserGroupMembers]: + """get_group_members + + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_group_members_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementUserGroupMembers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_group_members_without_preload_content( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_group_members + + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_group_members_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementUserGroupMembers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_group_members_serialize( self, user_group_id, - **kwargs - ): - """get_group_members # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_group_members(user_group_id, async_req=True) - >>> result = thread.get() - - Args: - user_group_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - UserManagementUserGroupMembers - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_group_id'] = \ - user_group_id - return self.get_group_members_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/userManagement/userGroups/{userGroupId}/members', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def list_permissions_for_user( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserManagementPermissionAssignments: + """list_permissions_for_user + + + :param user_id: (required) + :type user_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_permissions_for_user_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementPermissionAssignments", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_permissions_for_user_with_http_info( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserManagementPermissionAssignments]: + """list_permissions_for_user + + + :param user_id: (required) + :type user_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_permissions_for_user_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementPermissionAssignments", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_permissions_for_user_without_preload_content( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """list_permissions_for_user + + + :param user_id: (required) + :type user_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_permissions_for_user_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementPermissionAssignments", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_permissions_for_user_serialize( self, user_id, - **kwargs - ): - """list_permissions_for_user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_permissions_for_user(user_id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - UserManagementPermissionAssignments - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.list_permissions_for_user_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/userManagement/users/{userId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def list_permissions_for_user_group( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserManagementPermissionAssignments: + """list_permissions_for_user_group + + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_permissions_for_user_group_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementPermissionAssignments", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_permissions_for_user_group_with_http_info( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserManagementPermissionAssignments]: + """list_permissions_for_user_group + + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_permissions_for_user_group_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementPermissionAssignments", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_permissions_for_user_group_without_preload_content( + self, + user_group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """list_permissions_for_user_group + + + :param user_group_id: (required) + :type user_group_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_permissions_for_user_group_serialize( + user_group_id=user_group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementPermissionAssignments", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_permissions_for_user_group_serialize( self, user_group_id, - **kwargs - ): - """list_permissions_for_user_group # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_permissions_for_user_group(user_group_id, async_req=True) - >>> result = thread.get() - - Args: - user_group_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - UserManagementPermissionAssignments - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_group_id'] = \ - user_group_id - return self.list_permissions_for_user_group_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def list_user_groups( self, - **kwargs - ): - """list_user_groups # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_user_groups(async_req=True) - >>> result = thread.get() - - - Keyword Args: - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 - name (str): Filter by user name. Note that user name is case insensitive.. [optional] - workspace (str): Filter by workspaceId.. [optional] - data_source (str): Filter by dataSourceId.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - UserManagementUserGroups - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.list_user_groups_endpoint.call_with_http_info(**kwargs) + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + workspace: Annotated[Optional[StrictStr], Field(description="Filter by workspaceId.")] = None, + data_source: Annotated[Optional[StrictStr], Field(description="Filter by dataSourceId.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserManagementUserGroups: + """list_user_groups + + + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param workspace: Filter by workspaceId. + :type workspace: str + :param data_source: Filter by dataSourceId. + :type data_source: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_user_groups_serialize( + page=page, + size=size, + name=name, + workspace=workspace, + data_source=data_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_user_groups_with_http_info( + self, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + workspace: Annotated[Optional[StrictStr], Field(description="Filter by workspaceId.")] = None, + data_source: Annotated[Optional[StrictStr], Field(description="Filter by dataSourceId.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserManagementUserGroups]: + """list_user_groups + + + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param workspace: Filter by workspaceId. + :type workspace: str + :param data_source: Filter by dataSourceId. + :type data_source: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_user_groups_serialize( + page=page, + size=size, + name=name, + workspace=workspace, + data_source=data_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_user_groups_without_preload_content( + self, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + workspace: Annotated[Optional[StrictStr], Field(description="Filter by workspaceId.")] = None, + data_source: Annotated[Optional[StrictStr], Field(description="Filter by dataSourceId.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """list_user_groups + + + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param workspace: Filter by workspaceId. + :type workspace: str + :param data_source: Filter by dataSourceId. + :type data_source: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_user_groups_serialize( + page=page, + size=size, + name=name, + workspace=workspace, + data_source=data_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementUserGroups", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_user_groups_serialize( + self, + page, + size, + name, + workspace, + data_source, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if name is not None: + + _query_params.append(('name', name)) + + if workspace is not None: + + _query_params.append(('workspace', workspace)) + + if data_source is not None: + + _query_params.append(('dataSource', data_source)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/userManagement/userGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def list_users( self, - **kwargs - ): - """list_users # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_users(async_req=True) - >>> result = thread.get() - - - Keyword Args: - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 - name (str): Filter by user name. Note that user name is case insensitive.. [optional] - workspace (str): Filter by workspaceId.. [optional] - group (str): Filter by userGroupId.. [optional] - data_source (str): Filter by dataSourceId.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - UserManagementUsers - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.list_users_endpoint.call_with_http_info(**kwargs) + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + workspace: Annotated[Optional[StrictStr], Field(description="Filter by workspaceId.")] = None, + group: Annotated[Optional[StrictStr], Field(description="Filter by userGroupId.")] = None, + data_source: Annotated[Optional[StrictStr], Field(description="Filter by dataSourceId.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserManagementUsers: + """list_users + + + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param workspace: Filter by workspaceId. + :type workspace: str + :param group: Filter by userGroupId. + :type group: str + :param data_source: Filter by dataSourceId. + :type data_source: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_users_serialize( + page=page, + size=size, + name=name, + workspace=workspace, + group=group, + data_source=data_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_users_with_http_info( + self, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + workspace: Annotated[Optional[StrictStr], Field(description="Filter by workspaceId.")] = None, + group: Annotated[Optional[StrictStr], Field(description="Filter by userGroupId.")] = None, + data_source: Annotated[Optional[StrictStr], Field(description="Filter by dataSourceId.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserManagementUsers]: + """list_users + + + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param workspace: Filter by workspaceId. + :type workspace: str + :param group: Filter by userGroupId. + :type group: str + :param data_source: Filter by dataSourceId. + :type data_source: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_users_serialize( + page=page, + size=size, + name=name, + workspace=workspace, + group=group, + data_source=data_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_users_without_preload_content( + self, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Filter by user name. Note that user name is case insensitive.")] = None, + workspace: Annotated[Optional[StrictStr], Field(description="Filter by workspaceId.")] = None, + group: Annotated[Optional[StrictStr], Field(description="Filter by userGroupId.")] = None, + data_source: Annotated[Optional[StrictStr], Field(description="Filter by dataSourceId.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """list_users + + + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned. + :type size: int + :param name: Filter by user name. Note that user name is case insensitive. + :type name: str + :param workspace: Filter by workspaceId. + :type workspace: str + :param group: Filter by userGroupId. + :type group: str + :param data_source: Filter by dataSourceId. + :type data_source: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_users_serialize( + page=page, + size=size, + name=name, + workspace=workspace, + group=group, + data_source=data_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserManagementUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_users_serialize( + self, + page, + size, + name, + workspace, + group, + data_source, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if name is not None: + + _query_params.append(('name', name)) + + if workspace is not None: + + _query_params.append(('workspace', workspace)) + + if group is not None: + + _query_params.append(('group', group)) + + if data_source is not None: + + _query_params.append(('dataSource', data_source)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/userManagement/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def manage_permissions_for_user( + self, + user_id: StrictStr, + user_management_permission_assignments: UserManagementPermissionAssignments, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """manage_permissions_for_user + + + :param user_id: (required) + :type user_id: str + :param user_management_permission_assignments: (required) + :type user_management_permission_assignments: UserManagementPermissionAssignments + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_permissions_for_user_serialize( + user_id=user_id, + user_management_permission_assignments=user_management_permission_assignments, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def manage_permissions_for_user_with_http_info( + self, + user_id: StrictStr, + user_management_permission_assignments: UserManagementPermissionAssignments, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """manage_permissions_for_user + + + :param user_id: (required) + :type user_id: str + :param user_management_permission_assignments: (required) + :type user_management_permission_assignments: UserManagementPermissionAssignments + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_permissions_for_user_serialize( + user_id=user_id, + user_management_permission_assignments=user_management_permission_assignments, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def manage_permissions_for_user_without_preload_content( + self, + user_id: StrictStr, + user_management_permission_assignments: UserManagementPermissionAssignments, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """manage_permissions_for_user + + + :param user_id: (required) + :type user_id: str + :param user_management_permission_assignments: (required) + :type user_management_permission_assignments: UserManagementPermissionAssignments + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_permissions_for_user_serialize( + user_id=user_id, + user_management_permission_assignments=user_management_permission_assignments, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _manage_permissions_for_user_serialize( self, user_id, user_management_permission_assignments, - **kwargs - ): - """manage_permissions_for_user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.manage_permissions_for_user(user_id, user_management_permission_assignments, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - user_management_permission_assignments (UserManagementPermissionAssignments): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['user_management_permission_assignments'] = \ - user_management_permission_assignments - return self.manage_permissions_for_user_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if user_management_permission_assignments is not None: + _body_params = user_management_permission_assignments + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/userManagement/users/{userId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def manage_permissions_for_user_group( + self, + user_group_id: StrictStr, + user_management_permission_assignments: UserManagementPermissionAssignments, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """manage_permissions_for_user_group + + + :param user_group_id: (required) + :type user_group_id: str + :param user_management_permission_assignments: (required) + :type user_management_permission_assignments: UserManagementPermissionAssignments + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_permissions_for_user_group_serialize( + user_group_id=user_group_id, + user_management_permission_assignments=user_management_permission_assignments, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def manage_permissions_for_user_group_with_http_info( + self, + user_group_id: StrictStr, + user_management_permission_assignments: UserManagementPermissionAssignments, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """manage_permissions_for_user_group + + + :param user_group_id: (required) + :type user_group_id: str + :param user_management_permission_assignments: (required) + :type user_management_permission_assignments: UserManagementPermissionAssignments + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_permissions_for_user_group_serialize( + user_group_id=user_group_id, + user_management_permission_assignments=user_management_permission_assignments, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def manage_permissions_for_user_group_without_preload_content( + self, + user_group_id: StrictStr, + user_management_permission_assignments: UserManagementPermissionAssignments, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """manage_permissions_for_user_group + + + :param user_group_id: (required) + :type user_group_id: str + :param user_management_permission_assignments: (required) + :type user_management_permission_assignments: UserManagementPermissionAssignments + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._manage_permissions_for_user_group_serialize( + user_group_id=user_group_id, + user_management_permission_assignments=user_management_permission_assignments, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _manage_permissions_for_user_group_serialize( self, user_group_id, user_management_permission_assignments, - **kwargs - ): - """manage_permissions_for_user_group # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.manage_permissions_for_user_group(user_group_id, user_management_permission_assignments, async_req=True) - >>> result = thread.get() - - Args: - user_group_id (str): - user_management_permission_assignments (UserManagementPermissionAssignments): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_group_id'] = \ - user_group_id - kwargs['user_management_permission_assignments'] = \ - user_management_permission_assignments - return self.manage_permissions_for_user_group_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if user_management_permission_assignments is not None: + _body_params = user_management_permission_assignments + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def remove_group_members( + self, + user_group_id: StrictStr, + user_management_user_group_members: UserManagementUserGroupMembers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """remove_group_members + + + :param user_group_id: (required) + :type user_group_id: str + :param user_management_user_group_members: (required) + :type user_management_user_group_members: UserManagementUserGroupMembers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_group_members_serialize( + user_group_id=user_group_id, + user_management_user_group_members=user_management_user_group_members, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def remove_group_members_with_http_info( + self, + user_group_id: StrictStr, + user_management_user_group_members: UserManagementUserGroupMembers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """remove_group_members + + + :param user_group_id: (required) + :type user_group_id: str + :param user_management_user_group_members: (required) + :type user_management_user_group_members: UserManagementUserGroupMembers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_group_members_serialize( + user_group_id=user_group_id, + user_management_user_group_members=user_management_user_group_members, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def remove_group_members_without_preload_content( + self, + user_group_id: StrictStr, + user_management_user_group_members: UserManagementUserGroupMembers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """remove_group_members + + + :param user_group_id: (required) + :type user_group_id: str + :param user_management_user_group_members: (required) + :type user_management_user_group_members: UserManagementUserGroupMembers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_group_members_serialize( + user_group_id=user_group_id, + user_management_user_group_members=user_management_user_group_members, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _remove_group_members_serialize( self, user_group_id, user_management_user_group_members, - **kwargs - ): - """remove_group_members # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.remove_group_members(user_group_id, user_management_user_group_members, async_req=True) - >>> result = thread.get() - - Args: - user_group_id (str): - user_management_user_group_members (UserManagementUserGroupMembers): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_group_id'] = \ - user_group_id - kwargs['user_management_user_group_members'] = \ - user_management_user_group_members - return self.remove_group_members_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if user_management_user_group_members is not None: + _body_params = user_management_user_group_members + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def remove_users_user_groups( + self, + assignee_identifier: List[AssigneeIdentifier], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """remove_users_user_groups + + + :param assignee_identifier: (required) + :type assignee_identifier: List[AssigneeIdentifier] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_users_user_groups_serialize( + assignee_identifier=assignee_identifier, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def remove_users_user_groups_with_http_info( + self, + assignee_identifier: List[AssigneeIdentifier], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """remove_users_user_groups + + + :param assignee_identifier: (required) + :type assignee_identifier: List[AssigneeIdentifier] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_users_user_groups_serialize( + assignee_identifier=assignee_identifier, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def remove_users_user_groups_without_preload_content( + self, + assignee_identifier: List[AssigneeIdentifier], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """remove_users_user_groups + + + :param assignee_identifier: (required) + :type assignee_identifier: List[AssigneeIdentifier] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_users_user_groups_serialize( + assignee_identifier=assignee_identifier, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _remove_users_user_groups_serialize( self, assignee_identifier, - **kwargs - ): - """remove_users_user_groups # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.remove_users_user_groups(assignee_identifier, async_req=True) - >>> result = thread.get() - - Args: - assignee_identifier ([AssigneeIdentifier]): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['assignee_identifier'] = \ - assignee_identifier - return self.remove_users_user_groups_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'AssigneeIdentifier': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if assignee_identifier is not None: + _body_params = assignee_identifier + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/userManagement/removeUsersUserGroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def revoke_permissions( + self, + permissions_assignment: PermissionsAssignment, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """revoke_permissions + + + :param permissions_assignment: (required) + :type permissions_assignment: PermissionsAssignment + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._revoke_permissions_serialize( + permissions_assignment=permissions_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def revoke_permissions_with_http_info( + self, + permissions_assignment: PermissionsAssignment, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """revoke_permissions + + + :param permissions_assignment: (required) + :type permissions_assignment: PermissionsAssignment + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._revoke_permissions_serialize( + permissions_assignment=permissions_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def revoke_permissions_without_preload_content( + self, + permissions_assignment: PermissionsAssignment, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """revoke_permissions + + + :param permissions_assignment: (required) + :type permissions_assignment: PermissionsAssignment + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._revoke_permissions_serialize( + permissions_assignment=permissions_assignment, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _revoke_permissions_serialize( self, permissions_assignment, - **kwargs - ): - """revoke_permissions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.revoke_permissions(permissions_assignment, async_req=True) - >>> result = thread.get() - - Args: - permissions_assignment (PermissionsAssignment): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['permissions_assignment'] = \ - permissions_assignment - return self.revoke_permissions_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if permissions_assignment is not None: + _body_params = permissions_assignment + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/userManagement/revokePermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/user_model_controller_api.py b/gooddata-api-client/gooddata_api_client/api/user_model_controller_api.py index 9cace524e..feb12f189 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_model_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/user_model_controller_api.py @@ -1,1453 +1,2762 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList - - -class UserModelControllerApi(object): +class UserModelControllerApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiApiTokenOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens', - 'operation_id': 'create_entity_api_tokens', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'json_api_api_token_in_document', - ], - 'required': [ - 'user_id', - 'json_api_api_token_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'json_api_api_token_in_document': - (JsonApiApiTokenInDocument,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - 'json_api_api_token_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', - 'operation_id': 'create_entity_user_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'json_api_user_setting_in_document', - ], - 'required': [ - 'user_id', - 'json_api_user_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'json_api_user_setting_in_document': - (JsonApiUserSettingInDocument,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - 'json_api_user_setting_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens/{id}', - 'operation_id': 'delete_entity_api_tokens', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'delete_entity_user_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiApiTokenOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens', - 'operation_id': 'get_all_entities_api_tokens', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [ - 'user_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'user_id': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'user_id': 'userId', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'user_id': 'path', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', - 'operation_id': 'get_all_entities_user_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [ - 'user_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'user_id': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'user_id': 'userId', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'user_id': 'path', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiApiTokenOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens/{id}', - 'operation_id': 'get_entity_api_tokens', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'get_entity_user_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.update_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'update_entity_user_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'json_api_user_setting_in_document', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - 'json_api_user_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'json_api_user_setting_in_document': - (JsonApiUserSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'json_api_user_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_api_tokens( + self, + user_id: StrictStr, + json_api_api_token_in_document: JsonApiApiTokenInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiApiTokenOutDocument: + """Post a new API token for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_api_token_in_document: (required) + :type json_api_api_token_in_document: JsonApiApiTokenInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_api_tokens_serialize( + user_id=user_id, + json_api_api_token_in_document=json_api_api_token_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_api_tokens_with_http_info( + self, + user_id: StrictStr, + json_api_api_token_in_document: JsonApiApiTokenInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiApiTokenOutDocument]: + """Post a new API token for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_api_token_in_document: (required) + :type json_api_api_token_in_document: JsonApiApiTokenInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_api_tokens_serialize( + user_id=user_id, + json_api_api_token_in_document=json_api_api_token_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_api_tokens_without_preload_content( + self, + user_id: StrictStr, + json_api_api_token_in_document: JsonApiApiTokenInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post a new API token for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_api_token_in_document: (required) + :type json_api_api_token_in_document: JsonApiApiTokenInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_api_tokens_serialize( + user_id=user_id, + json_api_api_token_in_document=json_api_api_token_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_api_tokens_serialize( self, user_id, json_api_api_token_in_document, - **kwargs - ): - """Post a new API token for the user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_api_tokens(user_id, json_api_api_token_in_document, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - json_api_api_token_in_document (JsonApiApiTokenInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiApiTokenOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['json_api_api_token_in_document'] = \ - json_api_api_token_in_document - return self.create_entity_api_tokens_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_api_token_in_document is not None: + _body_params = json_api_api_token_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/users/{userId}/apiTokens', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_user_settings( + self, + user_id: StrictStr, + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutDocument: + """Post new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_settings_serialize( + user_id=user_id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutDocument]: + """Post new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_settings_serialize( + user_id=user_id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_settings_serialize( + user_id=user_id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_user_settings_serialize( self, user_id, json_api_user_setting_in_document, - **kwargs - ): - """Post new user settings for the user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_user_settings(user_id, json_api_user_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - json_api_user_setting_in_document (JsonApiUserSettingInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['json_api_user_setting_in_document'] = \ - json_api_user_setting_in_document - return self.create_entity_user_settings_endpoint.call_with_http_info(**kwargs) - + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_setting_in_document is not None: + _body_params = json_api_user_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/users/{userId}/userSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_api_tokens( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_api_tokens_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_api_tokens_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_api_tokens_serialize( self, user_id, id, - **kwargs - ): - """Delete an API Token for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_api_tokens(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.delete_entity_api_tokens_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/users/{userId}/apiTokens/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_user_settings( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_user_settings_serialize( self, user_id, id, - **kwargs - ): - """Delete a setting for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_user_settings(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.delete_entity_user_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/users/{userId}/userSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_api_tokens( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiApiTokenOutList: + """List all api tokens for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_api_tokens_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_api_tokens_with_http_info( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiApiTokenOutList]: + """List all api tokens for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_api_tokens_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_api_tokens_without_preload_content( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """List all api tokens for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_api_tokens_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_api_tokens_serialize( self, user_id, - **kwargs - ): - """List all api tokens for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_api_tokens(user_id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiApiTokenOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_api_tokens_endpoint.call_with_http_info(**kwargs) + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/apiTokens', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_user_settings( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutList: + """List all settings for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_settings_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_settings_with_http_info( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutList]: + """List all settings for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_settings_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_user_settings_without_preload_content( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """List all settings for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_settings_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_user_settings_serialize( self, user_id, - **kwargs - ): - """List all settings for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_settings(user_id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_user_settings_endpoint.call_with_http_info(**kwargs) + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/userSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_api_tokens( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiApiTokenOutDocument: + """Get an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_api_tokens_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiApiTokenOutDocument]: + """Get an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_api_tokens_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an API Token for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_api_tokens_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiApiTokenOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_api_tokens_serialize( self, user_id, id, - **kwargs - ): - """Get an API Token for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_api_tokens(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiApiTokenOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.get_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/apiTokens/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_user_settings( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutDocument: + """Get a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutDocument]: + """Get a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_settings_serialize( self, user_id, id, - **kwargs - ): - """Get a setting for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_settings(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.get_entity_user_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/userSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_user_settings( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutDocument: + """Put new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_settings_serialize( + user_id=user_id, + id=id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutDocument]: + """Put new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_settings_serialize( + user_id=user_id, + id=id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_settings_serialize( + user_id=user_id, + id=id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_user_settings_serialize( self, user_id, id, json_api_user_setting_in_document, - **kwargs - ): - """Put new user settings for the user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - json_api_user_setting_in_document (JsonApiUserSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - kwargs['json_api_user_setting_in_document'] = \ - json_api_user_setting_in_document - return self.update_entity_user_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_setting_in_document is not None: + _body_params = json_api_user_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/users/{userId}/userSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/user_settings_api.py b/gooddata-api-client/gooddata_api_client/api/user_settings_api.py index 7be5321b0..b21786e1a 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_settings_api.py +++ b/gooddata-api-client/gooddata_api_client/api/user_settings_api.py @@ -1,828 +1,1559 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class UserSettingsApi(object): +class UserSettingsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', - 'operation_id': 'create_entity_user_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'json_api_user_setting_in_document', - ], - 'required': [ - 'user_id', - 'json_api_user_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'json_api_user_setting_in_document': - (JsonApiUserSettingInDocument,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - 'json_api_user_setting_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'delete_entity_user_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', - 'operation_id': 'get_all_entities_user_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'filter', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [ - 'user_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'user_id': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'user_id': 'userId', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'user_id': 'path', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'get_entity_user_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.update_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'update_entity_user_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'json_api_user_setting_in_document', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - 'json_api_user_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'json_api_user_setting_in_document': - (JsonApiUserSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'json_api_user_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_user_settings( + self, + user_id: StrictStr, + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutDocument: + """Post new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_settings_serialize( + user_id=user_id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutDocument]: + """Post new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_settings_serialize( + user_id=user_id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_settings_serialize( + user_id=user_id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_user_settings_serialize( self, user_id, json_api_user_setting_in_document, - **kwargs - ): - """Post new user settings for the user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_user_settings(user_id, json_api_user_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - json_api_user_setting_in_document (JsonApiUserSettingInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['json_api_user_setting_in_document'] = \ - json_api_user_setting_in_document - return self.create_entity_user_settings_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_setting_in_document is not None: + _body_params = json_api_user_setting_in_document + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/users/{userId}/userSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_user_settings( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_user_settings_serialize( self, user_id, id, - **kwargs - ): - """Delete a setting for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_user_settings(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.delete_entity_user_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/users/{userId}/userSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_user_settings( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutList: + """List all settings for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_settings_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_settings_with_http_info( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutList]: + """List all settings for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_settings_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_user_settings_without_preload_content( + self, + user_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """List all settings for a user + + + :param user_id: (required) + :type user_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_settings_serialize( + user_id=user_id, + filter=filter, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_user_settings_serialize( self, user_id, - **kwargs - ): - """List all settings for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_settings(user_id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_user_settings_endpoint.call_with_http_info(**kwargs) + filter, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/userSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_user_settings( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutDocument: + """Get a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutDocument]: + """Get a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a setting for a user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_settings_serialize( + user_id=user_id, + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_settings_serialize( self, user_id, id, - **kwargs - ): - """Get a setting for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_settings(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.get_entity_user_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{userId}/userSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def update_entity_user_settings( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserSettingOutDocument: + """Put new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_settings_serialize( + user_id=user_id, + id=id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_user_settings_with_http_info( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserSettingOutDocument]: + """Put new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_settings_serialize( + user_id=user_id, + id=id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_user_settings_without_preload_content( + self, + user_id: StrictStr, + id: Annotated[str, Field(strict=True)], + json_api_user_setting_in_document: JsonApiUserSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put new user settings for the user + + + :param user_id: (required) + :type user_id: str + :param id: (required) + :type id: str + :param json_api_user_setting_in_document: (required) + :type json_api_user_setting_in_document: JsonApiUserSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_settings_serialize( + user_id=user_id, + id=id, + json_api_user_setting_in_document=json_api_user_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_user_settings_serialize( self, user_id, id, json_api_user_setting_in_document, - **kwargs - ): - """Put new user settings for the user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - json_api_user_setting_in_document (JsonApiUserSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - kwargs['json_api_user_setting_in_document'] = \ - json_api_user_setting_in_document - return self.update_entity_user_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_setting_in_document is not None: + _body_params = json_api_user_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/users/{userId}/userSettings/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/users_declarative_apis_api.py b/gooddata-api-client/gooddata_api_client/api/users_declarative_apis_api.py index 3ca6ae84a..886c883ba 100644 --- a/gooddata-api-client/gooddata_api_client/api/users_declarative_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/users_declarative_apis_api.py @@ -1,290 +1,548 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from gooddata_api_client.models.declarative_users import DeclarativeUsers -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class UsersDeclarativeAPIsApi(object): +class UsersDeclarativeAPIsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_users_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeUsers,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/users', - 'operation_id': 'get_users_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.put_users_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/users', - 'operation_id': 'put_users_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_users', - ], - 'required': [ - 'declarative_users', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_users': - (DeclarativeUsers,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_users': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def get_users_layout( self, - **kwargs - ): - """Get all users # noqa: E501 - - Retrieve all users including authentication properties. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_users_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeUsers - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeUsers: + """Get all users + + Retrieve all users including authentication properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_users_layout_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeUsers]: + """Get all users + + Retrieve all users including authentication properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def get_users_layout_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all users + + Retrieve all users including authentication properties. + + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_users_layout_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeUsers", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _get_users_layout_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_users_layout_endpoint.call_with_http_info(**kwargs) + + + + @validate_call def put_users_layout( self, - declarative_users, - **kwargs - ): - """Put all users # noqa: E501 - - Set all users and their authentication properties. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_users_layout(declarative_users, async_req=True) - >>> result = thread.get() - - Args: - declarative_users (DeclarativeUsers): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + declarative_users: DeclarativeUsers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Put all users + + Set all users and their authentication properties. + + :param declarative_users: (required) + :type declarative_users: DeclarativeUsers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_layout_serialize( + declarative_users=declarative_users, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_users_layout_with_http_info( + self, + declarative_users: DeclarativeUsers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Put all users + + Set all users and their authentication properties. + + :param declarative_users: (required) + :type declarative_users: DeclarativeUsers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_layout_serialize( + declarative_users=declarative_users, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def put_users_layout_without_preload_content( + self, + declarative_users: DeclarativeUsers, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put all users + + Set all users and their authentication properties. + + :param declarative_users: (required) + :type declarative_users: DeclarativeUsers + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_users_layout_serialize( + declarative_users=declarative_users, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _put_users_layout_serialize( + self, + declarative_users, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_users is not None: + _body_params = declarative_users + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_users'] = \ - declarative_users - return self.put_users_layout_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/users_entity_apis_api.py b/gooddata-api-client/gooddata_api_client/api/users_entity_apis_api.py index 209d2baf7..c7ff458cf 100644 --- a/gooddata-api-client/gooddata_api_client/api/users_entity_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/users_entity_apis_api.py @@ -1,1003 +1,1895 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class UsersEntityAPIsApi(object): + +class UsersEntityAPIsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users', - 'operation_id': 'create_entity_users', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_user_in_document', - 'include', - ], - 'required': [ - 'json_api_user_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_user_in_document': - (JsonApiUserInDocument,), - 'include': - ([str],), - }, - 'attribute_map': { - 'include': 'include', - }, - 'location_map': { - 'json_api_user_in_document': 'body', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'delete_entity_users', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users', - 'operation_id': 'get_all_entities_users', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'get_entity_users', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'patch_entity_users', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_patch_document': - (JsonApiUserPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'update_entity_users', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_in_document': - (JsonApiUserInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_users( + self, + json_api_user_in_document: JsonApiUserInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Post User entities + + User - represents entity interacting with platform + + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_users_serialize( + json_api_user_in_document=json_api_user_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_users_with_http_info( + self, + json_api_user_in_document: JsonApiUserInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Post User entities + + User - represents entity interacting with platform + + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_users_serialize( + json_api_user_in_document=json_api_user_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_users_without_preload_content( + self, + json_api_user_in_document: JsonApiUserInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post User entities + + User - represents entity interacting with platform + + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_users_serialize( + json_api_user_in_document=json_api_user_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_users_serialize( self, json_api_user_in_document, - **kwargs - ): - """Post User entities # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_users(json_api_user_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_user_in_document (JsonApiUserInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_in_document'] = \ - json_api_user_in_document - return self.create_entity_users_endpoint.call_with_http_info(**kwargs) + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_in_document is not None: + _body_params = json_api_user_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_users( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_users_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_users_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_users_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_users_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_users_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_users_serialize( self, id, - **kwargs - ): - """Delete User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_users(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_users_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_users( self, - **kwargs - ): - """Get User entities # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_users(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_users_endpoint.call_with_http_info(**kwargs) + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutList: + """Get User entities + + User - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_users_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_users_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutList]: + """Get User entities + + User - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_users_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_users_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get User entities + + User - represents entity interacting with platform + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_users_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_users_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_users( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Get User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_users_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_users_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Get User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_users_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_users_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_users_serialize( + id=id, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_users_serialize( self, id, - **kwargs - ): - """Get User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_users(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_users_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def patch_entity_users( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_patch_document: JsonApiUserPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Patch User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_patch_document: (required) + :type json_api_user_patch_document: JsonApiUserPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_users_serialize( + id=id, + json_api_user_patch_document=json_api_user_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_users_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_patch_document: JsonApiUserPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Patch User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_patch_document: (required) + :type json_api_user_patch_document: JsonApiUserPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_users_serialize( + id=id, + json_api_user_patch_document=json_api_user_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_users_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_patch_document: JsonApiUserPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_patch_document: (required) + :type json_api_user_patch_document: JsonApiUserPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_users_serialize( + id=id, + json_api_user_patch_document=json_api_user_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_users_serialize( self, id, json_api_user_patch_document, - **kwargs - ): - """Patch User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_users(id, json_api_user_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_patch_document (JsonApiUserPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_patch_document'] = \ - json_api_user_patch_document - return self.patch_entity_users_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_patch_document is not None: + _body_params = json_api_user_patch_document + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_users( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_in_document: JsonApiUserInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserOutDocument: + """Put User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_users_serialize( + id=id, + json_api_user_in_document=json_api_user_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_users_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_in_document: JsonApiUserInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserOutDocument]: + """Put User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_users_serialize( + id=id, + json_api_user_in_document=json_api_user_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_users_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_user_in_document: JsonApiUserInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put User entity + + User - represents entity interacting with platform + + :param id: (required) + :type id: str + :param json_api_user_in_document: (required) + :type json_api_user_in_document: JsonApiUserInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_users_serialize( + id=id, + json_api_user_in_document=json_api_user_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_users_serialize( self, id, json_api_user_in_document, - **kwargs - ): - """Put User entity # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_users(id, json_api_user_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_user_in_document (JsonApiUserInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_in_document'] = \ - json_api_user_in_document - return self.update_entity_users_endpoint.call_with_http_info(**kwargs) + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_in_document is not None: + _body_params = json_api_user_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/users/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/visual_export_api.py b/gooddata-api-client/gooddata_api_client/api/visual_export_api.py index cbfdf040f..c0e91ac93 100644 --- a/gooddata-api-client/gooddata_api_client/api/visual_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/visual_export_api.py @@ -1,473 +1,896 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + Do not edit the class manually. +""" # noqa: E501 -import re # noqa: F401 -import sys # noqa: F401 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.visual_export_request import VisualExportRequest +from pydantic import StrictBool, StrictBytes, StrictStr +from typing import Optional, Tuple, Union +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.visual_export_request import VisualExportRequest +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class VisualExportApi(object): + +class VisualExportApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_pdf_export_endpoint = _Endpoint( - settings={ - 'response_type': (ExportResponse,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual', - 'operation_id': 'create_pdf_export', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'visual_export_request', - 'x_gdc_debug', - ], - 'required': [ - 'workspace_id', - 'visual_export_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'visual_export_request': - (VisualExportRequest,), - 'x_gdc_debug': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'x_gdc_debug': 'X-Gdc-Debug', - }, - 'location_map': { - 'workspace_id': 'path', - 'visual_export_request': 'body', - 'x_gdc_debug': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.get_exported_file_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}', - 'operation_id': 'get_exported_file', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/pdf' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_metadata_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata', - 'operation_id': 'get_metadata', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'export_id', - ], - 'required': [ - 'workspace_id', - 'export_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'export_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'export_id': 'exportId', - }, - 'location_map': { - 'workspace_id': 'path', - 'export_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) + + @validate_call def create_pdf_export( self, - workspace_id, - visual_export_request, - **kwargs - ): - """Create visual - pdf export request # noqa: E501 - - An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_pdf_export(workspace_id, visual_export_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - visual_export_request (VisualExportRequest): - - Keyword Args: - x_gdc_debug (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ExportResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + visual_export_request: VisualExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ExportResponse: + """Create visual - pdf export request + + An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param visual_export_request: (required) + :type visual_export_request: VisualExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_pdf_export_serialize( + workspace_id=workspace_id, + visual_export_request=visual_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_pdf_export_with_http_info( + self, + workspace_id: StrictStr, + visual_export_request: VisualExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ExportResponse]: + """Create visual - pdf export request + + An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param visual_export_request: (required) + :type visual_export_request: VisualExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_pdf_export_serialize( + workspace_id=workspace_id, + visual_export_request=visual_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + + @validate_call + def create_pdf_export_without_preload_content( + self, + workspace_id: StrictStr, + visual_export_request: VisualExportRequest, + x_gdc_debug: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create visual - pdf export request + + An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + + :param workspace_id: (required) + :type workspace_id: str + :param visual_export_request: (required) + :type visual_export_request: VisualExportRequest + :param x_gdc_debug: + :type x_gdc_debug: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_pdf_export_serialize( + workspace_id=workspace_id, + visual_export_request=visual_export_request, + x_gdc_debug=x_gdc_debug, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ExportResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + return response_data.response + + + def _create_pdf_export_serialize( + self, + workspace_id, + visual_export_request, + x_gdc_debug, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + if x_gdc_debug is not None: + _header_params['X-Gdc-Debug'] = x_gdc_debug + # process the form parameters + # process the body parameter + if visual_export_request is not None: + _body_params = visual_export_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/visual', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['visual_export_request'] = \ - visual_export_request - return self.create_pdf_export_endpoint.call_with_http_info(**kwargs) + + + + @validate_call def get_exported_file( self, - workspace_id, - export_id, - **kwargs - ): - """Retrieve exported files # noqa: E501 - - Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_exported_file(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - file_type - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """Retrieve exported files + + Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_exported_file_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_exported_file_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """Retrieve exported files + + Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_exported_file_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_exported_file_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve exported files + + Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_exported_file_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '202': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_exported_file_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_metadata( + + def _get_exported_file_serialize( self, workspace_id, export_id, - **kwargs - ): - """Retrieve metadata context # noqa: E501 - - This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_metadata(workspace_id, export_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - export_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/pdf' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_metadata( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Retrieve metadata context + + This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_metadata_with_http_info( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Retrieve metadata context + + This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_metadata_without_preload_content( + self, + workspace_id: StrictStr, + export_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve metadata context + + This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. + + :param workspace_id: (required) + :type workspace_id: str + :param export_id: (required) + :type export_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_metadata_serialize( + workspace_id=workspace_id, + export_id=export_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['export_id'] = \ - export_id - return self.get_metadata_endpoint.call_with_http_info(**kwargs) + return response_data.response + + + def _get_metadata_serialize( + self, + workspace_id, + export_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if export_id is not None: + _path_params['exportId'] = export_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py b/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py index 9f6d97c68..53b56c318 100644 --- a/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py +++ b/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py @@ -1,1129 +1,2051 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class VisualizationObjectApi(object): +class VisualizationObjectApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', - 'operation_id': 'create_entity_visualization_objects', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_visualization_object_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_visualization_object_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_visualization_object_post_optional_id_document': - (JsonApiVisualizationObjectPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_visualization_object_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_visualization_objects( + self, + workspace_id: StrictStr, + json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Post Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_visualization_object_post_optional_id_document: (required) + :type json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_visualization_objects_serialize( + workspace_id=workspace_id, + json_api_visualization_object_post_optional_id_document=json_api_visualization_object_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.delete_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'delete_entity_visualization_objects', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.get_all_entities_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', - 'operation_id': 'get_all_entities_visualization_objects', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Post Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_visualization_object_post_optional_id_document: (required) + :type json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_visualization_objects_serialize( + workspace_id=workspace_id, + json_api_visualization_object_post_optional_id_document=json_api_visualization_object_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.get_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'get_entity_visualization_objects', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.patch_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'patch_entity_visualization_objects', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_visualization_object_patch_document': - (JsonApiVisualizationObjectPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_visualization_object_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - self.update_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'update_entity_visualization_objects', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_visualization_object_in_document': - (JsonApiVisualizationObjectInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_visualization_object_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_visualization_object_post_optional_id_document: (required) + :type json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_visualization_objects_serialize( + workspace_id=workspace_id, + json_api_visualization_object_post_optional_id_document=json_api_visualization_object_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - def create_entity_visualization_objects( + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_visualization_objects_serialize( self, workspace_id, json_api_visualization_object_post_optional_id_document, - **kwargs - ): - """Post Visualization Objects # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_visualization_object_post_optional_id_document (JsonApiVisualizationObjectPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_visualization_object_post_optional_id_document is not None: + _body_params = json_api_visualization_object_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def delete_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_visualization_object_post_optional_id_document'] = \ - json_api_visualization_object_post_optional_id_document - return self.create_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + return response_data.response - def delete_entity_visualization_objects( + + def _delete_entity_visualization_objects_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_visualization_objects(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def get_all_entities_visualization_objects( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutList: + """Get all Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_visualization_objects_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutList]: + """Get all Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_visualization_objects_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def get_all_entities_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_visualization_objects_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - def get_all_entities_visualization_objects( + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_visualization_objects_serialize( self, workspace_id, - **kwargs - ): - """Get all Visualization Objects # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_visualization_objects(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Get a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Get a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_visualization_objects( + + def _get_entity_visualization_objects_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_visualization_objects(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def patch_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Patch a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_patch_document: (required) + :type json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_patch_document=json_api_visualization_object_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Patch a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_patch_document: (required) + :type json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_patch_document=json_api_visualization_object_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_patch_document: (required) + :type json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_patch_document=json_api_visualization_object_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + return response_data.response - def patch_entity_visualization_objects( + + def _patch_entity_visualization_objects_serialize( self, workspace_id, object_id, json_api_visualization_object_patch_document, - **kwargs - ): - """Patch a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_visualization_object_patch_document (JsonApiVisualizationObjectPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_visualization_object_patch_document is not None: + _body_params = json_api_visualization_object_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def update_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Put a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_in_document: (required) + :type json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_in_document=json_api_visualization_object_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Put a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_in_document: (required) + :type json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_in_document=json_api_visualization_object_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def update_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_in_document: (required) + :type json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_in_document=json_api_visualization_object_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_visualization_object_patch_document'] = \ - json_api_visualization_object_patch_document - return self.patch_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + return response_data.response - def update_entity_visualization_objects( + + def _update_entity_visualization_objects_serialize( self, workspace_id, object_id, json_api_visualization_object_in_document, - **kwargs - ): - """Put a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_visualization_object_in_document (JsonApiVisualizationObjectInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_visualization_object_in_document is not None: + _body_params = json_api_visualization_object_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_visualization_object_in_document'] = \ - json_api_visualization_object_in_document - return self.update_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py index 2ac5b9fd3..5f15d7efe 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py @@ -1,16954 +1,31666 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - + Generated by OpenAPI Generator (https://openapi-generator.tech) -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument -from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList -from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList -from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList -from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList -from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument -from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument -from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList -from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList -from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument - - -class WorkspaceObjectControllerApi(object): + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument +from gooddata_api_client.models.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.models.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.models.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.models.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.models.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.models.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class WorkspaceObjectControllerApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', - 'operation_id': 'create_entity_analytical_dashboards', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_analytical_dashboard_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_analytical_dashboard_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_analytical_dashboard_post_optional_id_document': - (JsonApiAnalyticalDashboardPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_analytical_dashboard_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', - 'operation_id': 'create_entity_attribute_hierarchies', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_attribute_hierarchy_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_attribute_hierarchy_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_attribute_hierarchy_in_document': - (JsonApiAttributeHierarchyInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_attribute_hierarchy_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations', - 'operation_id': 'create_entity_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_automation_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_automation_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_automation_in_document': - (JsonApiAutomationInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_automation_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', - 'operation_id': 'create_entity_custom_application_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_custom_application_setting_post_optional_id_document', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_custom_application_setting_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_custom_application_setting_post_optional_id_document': - (JsonApiCustomApplicationSettingPostOptionalIdDocument,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_custom_application_setting_post_optional_id_document': 'body', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', - 'operation_id': 'create_entity_dashboard_plugins', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_dashboard_plugin_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_dashboard_plugin_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_dashboard_plugin_post_optional_id_document': - (JsonApiDashboardPluginPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_dashboard_plugin_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', - 'operation_id': 'create_entity_export_definitions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_export_definition_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_export_definition_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_export_definition_post_optional_id_document': - (JsonApiExportDefinitionPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_export_definition_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', - 'operation_id': 'create_entity_filter_contexts', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_filter_context_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_filter_context_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_filter_context_post_optional_id_document': - (JsonApiFilterContextPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_filter_context_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', - 'operation_id': 'create_entity_filter_views', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_filter_view_in_document', - 'include', - ], - 'required': [ - 'workspace_id', - 'json_api_filter_view_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_filter_view_in_document': - (JsonApiFilterViewInDocument,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_filter_view_in_document': 'body', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', - 'operation_id': 'create_entity_metrics', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_metric_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_metric_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_metric_post_optional_id_document': - (JsonApiMetricPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_metric_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'create_entity_user_data_filters', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_user_data_filter_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_user_data_filter_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_user_data_filter_post_optional_id_document': - (JsonApiUserDataFilterPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_user_data_filter_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', - 'operation_id': 'create_entity_visualization_objects', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_visualization_object_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_visualization_object_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_visualization_object_post_optional_id_document': - (JsonApiVisualizationObjectPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_visualization_object_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', - 'operation_id': 'create_entity_workspace_data_filter_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_workspace_data_filter_setting_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_workspace_data_filter_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_workspace_data_filter_setting_in_document': - (JsonApiWorkspaceDataFilterSettingInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_workspace_data_filter_setting_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', - 'operation_id': 'create_entity_workspace_data_filters', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_workspace_data_filter_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_workspace_data_filter_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_workspace_data_filter_in_document': - (JsonApiWorkspaceDataFilterInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_workspace_data_filter_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', - 'operation_id': 'create_entity_workspace_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_workspace_setting_post_optional_id_document', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_workspace_setting_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_workspace_setting_post_optional_id_document': - (JsonApiWorkspaceSettingPostOptionalIdDocument,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_workspace_setting_post_optional_id_document': 'body', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'delete_entity_analytical_dashboards', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'delete_entity_attribute_hierarchies', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'delete_entity_automations', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'delete_entity_custom_application_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'delete_entity_dashboard_plugins', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'delete_entity_export_definitions', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'delete_entity_filter_contexts', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'delete_entity_filter_views', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'delete_entity_metrics', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'delete_entity_user_data_filters', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'delete_entity_visualization_objects', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'delete_entity_workspace_data_filter_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'delete_entity_workspace_data_filters', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'delete_entity_workspace_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_aggregated_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAggregatedFactOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts', - 'operation_id': 'get_all_entities_aggregated_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "DATASETS": "datasets", - "FACTS": "facts", - "DATASET": "dataset", - "SOURCEFACT": "sourceFact", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', - 'operation_id': 'get_all_entities_analytical_dashboards', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', - 'operation_id': 'get_all_entities_attribute_hierarchies', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_attributes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes', - 'operation_id': 'get_all_entities_attributes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "DATASETS": "datasets", - "LABELS": "labels", - "ATTRIBUTEHIERARCHIES": "attributeHierarchies", - "DATASET": "dataset", - "DEFAULTVIEW": "defaultView", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations', - 'operation_id': 'get_all_entities_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', - 'operation_id': 'get_all_entities_custom_application_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', - 'operation_id': 'get_all_entities_dashboard_plugins', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_datasets_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDatasetOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets', - 'operation_id': 'get_all_entities_datasets', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "FACTS": "facts", - "AGGREGATEDFACTS": "aggregatedFacts", - "DATASETS": "datasets", - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "REFERENCES": "references", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', - 'operation_id': 'get_all_entities_export_definitions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFactOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts', - 'operation_id': 'get_all_entities_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "DATASETS": "datasets", - "DATASET": "dataset", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', - 'operation_id': 'get_all_entities_filter_contexts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', - 'operation_id': 'get_all_entities_filter_views', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_labels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLabelOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels', - 'operation_id': 'get_all_entities_labels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "ATTRIBUTE": "attribute", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', - 'operation_id': 'get_all_entities_metrics', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'get_all_entities_user_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', - 'operation_id': 'get_all_entities_visualization_objects', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', - 'operation_id': 'get_all_entities_workspace_data_filter_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', - 'operation_id': 'get_all_entities_workspace_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', - 'operation_id': 'get_all_entities_workspace_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_aggregated_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAggregatedFactOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}', - 'operation_id': 'get_entity_aggregated_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "FACTS": "facts", - "DATASET": "dataset", - "SOURCEFACT": "sourceFact", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'get_entity_analytical_dashboards', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'get_entity_attribute_hierarchies', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_attributes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}', - 'operation_id': 'get_entity_attributes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "LABELS": "labels", - "ATTRIBUTEHIERARCHIES": "attributeHierarchies", - "DATASET": "dataset", - "DEFAULTVIEW": "defaultView", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'get_entity_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'get_entity_custom_application_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'get_entity_dashboard_plugins', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_datasets_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDatasetOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', - 'operation_id': 'get_entity_datasets', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "FACTS": "facts", - "AGGREGATEDFACTS": "aggregatedFacts", - "DATASETS": "datasets", - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "REFERENCES": "references", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'get_entity_export_definitions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFactOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}', - 'operation_id': 'get_entity_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "DATASET": "dataset", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'get_entity_filter_contexts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'get_entity_filter_views', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_labels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLabelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}', - 'operation_id': 'get_entity_labels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "ATTRIBUTE": "attribute", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'get_entity_metrics', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'get_entity_user_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'get_entity_visualization_objects', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'get_entity_workspace_data_filter_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'get_entity_workspace_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'get_entity_workspace_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'patch_entity_analytical_dashboards', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_analytical_dashboard_patch_document': - (JsonApiAnalyticalDashboardPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_analytical_dashboard_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'patch_entity_attribute_hierarchies', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_attribute_hierarchy_patch_document': - (JsonApiAttributeHierarchyPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_attribute_hierarchy_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'patch_entity_automations', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_automation_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_automation_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_automation_patch_document': - (JsonApiAutomationPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_automation_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'patch_entity_custom_application_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_patch_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_custom_application_setting_patch_document': - (JsonApiCustomApplicationSettingPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_custom_application_setting_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'patch_entity_dashboard_plugins', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_dashboard_plugin_patch_document': - (JsonApiDashboardPluginPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_dashboard_plugin_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'patch_entity_export_definitions', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_export_definition_patch_document': - (JsonApiExportDefinitionPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_export_definition_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'patch_entity_filter_contexts', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_context_patch_document': - (JsonApiFilterContextPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_context_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'patch_entity_filter_views', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_view_patch_document': - (JsonApiFilterViewPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_view_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'patch_entity_metrics', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_metric_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_metric_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_metric_patch_document': - (JsonApiMetricPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_metric_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'patch_entity_user_data_filters', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_user_data_filter_patch_document': - (JsonApiUserDataFilterPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_user_data_filter_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'patch_entity_visualization_objects', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_visualization_object_patch_document': - (JsonApiVisualizationObjectPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_visualization_object_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'patch_entity_workspace_data_filter_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_setting_patch_document': - (JsonApiWorkspaceDataFilterSettingPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_setting_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'patch_entity_workspace_data_filters', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_patch_document': - (JsonApiWorkspaceDataFilterPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'patch_entity_workspace_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_patch_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_setting_patch_document': - (JsonApiWorkspaceSettingPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_setting_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'update_entity_analytical_dashboards', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_analytical_dashboard_in_document': - (JsonApiAnalyticalDashboardInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_analytical_dashboard_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'update_entity_attribute_hierarchies', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_attribute_hierarchy_in_document': - (JsonApiAttributeHierarchyInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_attribute_hierarchy_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'update_entity_automations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_automation_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_automation_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_automation_in_document': - (JsonApiAutomationInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_automation_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'update_entity_custom_application_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_in_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_custom_application_setting_in_document': - (JsonApiCustomApplicationSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_custom_application_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'update_entity_dashboard_plugins', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_dashboard_plugin_in_document': - (JsonApiDashboardPluginInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_dashboard_plugin_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'update_entity_export_definitions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_export_definition_in_document': - (JsonApiExportDefinitionInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_export_definition_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'update_entity_filter_contexts', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_context_in_document': - (JsonApiFilterContextInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_context_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'update_entity_filter_views', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_view_in_document': - (JsonApiFilterViewInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_view_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'update_entity_metrics', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_metric_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_metric_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_metric_in_document': - (JsonApiMetricInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_metric_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'update_entity_user_data_filters', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_user_data_filter_in_document': - (JsonApiUserDataFilterInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_user_data_filter_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'update_entity_visualization_objects', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_visualization_object_in_document': - (JsonApiVisualizationObjectInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_visualization_object_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'update_entity_workspace_data_filter_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_setting_in_document': - (JsonApiWorkspaceDataFilterSettingInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_setting_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'update_entity_workspace_data_filters', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_in_document': - (JsonApiWorkspaceDataFilterInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'update_entity_workspace_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_in_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_setting_in_document': - (JsonApiWorkspaceSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Post Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_analytical_dashboard_post_optional_id_document: (required) + :type json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + json_api_analytical_dashboard_post_optional_id_document=json_api_analytical_dashboard_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Post Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_analytical_dashboard_post_optional_id_document: (required) + :type json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + json_api_analytical_dashboard_post_optional_id_document=json_api_analytical_dashboard_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_analytical_dashboard_post_optional_id_document: (required) + :type json_api_analytical_dashboard_post_optional_id_document: JsonApiAnalyticalDashboardPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + json_api_analytical_dashboard_post_optional_id_document=json_api_analytical_dashboard_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_analytical_dashboards_serialize( self, workspace_id, json_api_analytical_dashboard_post_optional_id_document, - **kwargs - ): - """Post Dashboards # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_analytical_dashboard_post_optional_id_document (JsonApiAnalyticalDashboardPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_analytical_dashboard_post_optional_id_document'] = \ - json_api_analytical_dashboard_post_optional_id_document - return self.create_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_analytical_dashboard_post_optional_id_document is not None: + _body_params = json_api_analytical_dashboard_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Post Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Post Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_attribute_hierarchies_serialize( self, workspace_id, json_api_attribute_hierarchy_in_document, - **kwargs - ): - """Post Attribute Hierarchies # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_attribute_hierarchy_in_document'] = \ - json_api_attribute_hierarchy_in_document - return self.create_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_attribute_hierarchy_in_document is not None: + _body_params = json_api_attribute_hierarchy_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_automations( + self, + workspace_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Post Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_automations_serialize( + workspace_id=workspace_id, + json_api_automation_in_document=json_api_automation_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Post Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_automations_serialize( + workspace_id=workspace_id, + json_api_automation_in_document=json_api_automation_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_automations_serialize( + workspace_id=workspace_id, + json_api_automation_in_document=json_api_automation_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_automations_serialize( self, workspace_id, json_api_automation_in_document, - **kwargs - ): - """Post Automations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_automations(workspace_id, json_api_automation_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.create_entity_automations_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_automation_in_document is not None: + _body_params = json_api_automation_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_custom_application_settings( + self, + workspace_id: StrictStr, + json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Post Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_custom_application_setting_post_optional_id_document: (required) + :type json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + json_api_custom_application_setting_post_optional_id_document=json_api_custom_application_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Post Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_custom_application_setting_post_optional_id_document: (required) + :type json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + json_api_custom_application_setting_post_optional_id_document=json_api_custom_application_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_custom_application_setting_post_optional_id_document: (required) + :type json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + json_api_custom_application_setting_post_optional_id_document=json_api_custom_application_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_custom_application_settings_serialize( self, workspace_id, json_api_custom_application_setting_post_optional_id_document, - **kwargs - ): - """Post Custom Application Settings # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_custom_application_setting_post_optional_id_document (JsonApiCustomApplicationSettingPostOptionalIdDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_custom_application_setting_post_optional_id_document'] = \ - json_api_custom_application_setting_post_optional_id_document - return self.create_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_custom_application_setting_post_optional_id_document is not None: + _body_params = json_api_custom_application_setting_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Post Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_dashboard_plugin_post_optional_id_document: (required) + :type json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + json_api_dashboard_plugin_post_optional_id_document=json_api_dashboard_plugin_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Post Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_dashboard_plugin_post_optional_id_document: (required) + :type json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + json_api_dashboard_plugin_post_optional_id_document=json_api_dashboard_plugin_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_dashboard_plugin_post_optional_id_document: (required) + :type json_api_dashboard_plugin_post_optional_id_document: JsonApiDashboardPluginPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + json_api_dashboard_plugin_post_optional_id_document=json_api_dashboard_plugin_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_dashboard_plugins_serialize( self, workspace_id, json_api_dashboard_plugin_post_optional_id_document, - **kwargs - ): - """Post Plugins # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_dashboard_plugin_post_optional_id_document (JsonApiDashboardPluginPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_dashboard_plugin_post_optional_id_document'] = \ - json_api_dashboard_plugin_post_optional_id_document - return self.create_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_dashboard_plugin_post_optional_id_document is not None: + _body_params = json_api_dashboard_plugin_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_export_definitions( + self, + workspace_id: StrictStr, + json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Post Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_export_definition_post_optional_id_document: (required) + :type json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_definitions_serialize( + workspace_id=workspace_id, + json_api_export_definition_post_optional_id_document=json_api_export_definition_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Post Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_export_definition_post_optional_id_document: (required) + :type json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_definitions_serialize( + workspace_id=workspace_id, + json_api_export_definition_post_optional_id_document=json_api_export_definition_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_export_definition_post_optional_id_document: (required) + :type json_api_export_definition_post_optional_id_document: JsonApiExportDefinitionPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_export_definitions_serialize( + workspace_id=workspace_id, + json_api_export_definition_post_optional_id_document=json_api_export_definition_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_export_definitions_serialize( self, workspace_id, json_api_export_definition_post_optional_id_document, - **kwargs - ): - """Post Export Definitions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_export_definition_post_optional_id_document (JsonApiExportDefinitionPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_export_definition_post_optional_id_document'] = \ - json_api_export_definition_post_optional_id_document - return self.create_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_definition_post_optional_id_document is not None: + _body_params = json_api_export_definition_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_filter_contexts( + self, + workspace_id: StrictStr, + json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Post Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_context_post_optional_id_document: (required) + :type json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_contexts_serialize( + workspace_id=workspace_id, + json_api_filter_context_post_optional_id_document=json_api_filter_context_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Post Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_context_post_optional_id_document: (required) + :type json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_contexts_serialize( + workspace_id=workspace_id, + json_api_filter_context_post_optional_id_document=json_api_filter_context_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_context_post_optional_id_document: (required) + :type json_api_filter_context_post_optional_id_document: JsonApiFilterContextPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_contexts_serialize( + workspace_id=workspace_id, + json_api_filter_context_post_optional_id_document=json_api_filter_context_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_filter_contexts_serialize( self, workspace_id, json_api_filter_context_post_optional_id_document, - **kwargs - ): - """Post Context Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_filter_context_post_optional_id_document (JsonApiFilterContextPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_filter_context_post_optional_id_document'] = \ - json_api_filter_context_post_optional_id_document - return self.create_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_context_post_optional_id_document is not None: + _body_params = json_api_filter_context_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_filter_views( + self, + workspace_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Post Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_views_serialize( + workspace_id=workspace_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Post Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_views_serialize( + workspace_id=workspace_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_filter_views_serialize( + workspace_id=workspace_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_filter_views_serialize( self, workspace_id, json_api_filter_view_in_document, - **kwargs - ): - """Post Filter views # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.create_entity_filter_views_endpoint.call_with_http_info(**kwargs) - + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_view_in_document is not None: + _body_params = json_api_filter_view_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_metrics( + self, + workspace_id: StrictStr, + json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Post Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_metric_post_optional_id_document: (required) + :type json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_metrics_serialize( + workspace_id=workspace_id, + json_api_metric_post_optional_id_document=json_api_metric_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Post Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_metric_post_optional_id_document: (required) + :type json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_metrics_serialize( + workspace_id=workspace_id, + json_api_metric_post_optional_id_document=json_api_metric_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_metric_post_optional_id_document: (required) + :type json_api_metric_post_optional_id_document: JsonApiMetricPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_metrics_serialize( + workspace_id=workspace_id, + json_api_metric_post_optional_id_document=json_api_metric_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_metrics_serialize( self, workspace_id, json_api_metric_post_optional_id_document, - **kwargs - ): - """Post Metrics # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_metric_post_optional_id_document (JsonApiMetricPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_metric_post_optional_id_document'] = \ - json_api_metric_post_optional_id_document - return self.create_entity_metrics_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_metric_post_optional_id_document is not None: + _body_params = json_api_metric_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_user_data_filters( + self, + workspace_id: StrictStr, + json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Post User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_user_data_filter_post_optional_id_document: (required) + :type json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_data_filters_serialize( + workspace_id=workspace_id, + json_api_user_data_filter_post_optional_id_document=json_api_user_data_filter_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Post User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_user_data_filter_post_optional_id_document: (required) + :type json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_data_filters_serialize( + workspace_id=workspace_id, + json_api_user_data_filter_post_optional_id_document=json_api_user_data_filter_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_user_data_filter_post_optional_id_document: (required) + :type json_api_user_data_filter_post_optional_id_document: JsonApiUserDataFilterPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_user_data_filters_serialize( + workspace_id=workspace_id, + json_api_user_data_filter_post_optional_id_document=json_api_user_data_filter_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_user_data_filters_serialize( self, workspace_id, json_api_user_data_filter_post_optional_id_document, - **kwargs - ): - """Post User Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_user_data_filter_post_optional_id_document (JsonApiUserDataFilterPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_user_data_filter_post_optional_id_document'] = \ - json_api_user_data_filter_post_optional_id_document - return self.create_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_data_filter_post_optional_id_document is not None: + _body_params = json_api_user_data_filter_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_visualization_objects( + self, + workspace_id: StrictStr, + json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Post Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_visualization_object_post_optional_id_document: (required) + :type json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_visualization_objects_serialize( + workspace_id=workspace_id, + json_api_visualization_object_post_optional_id_document=json_api_visualization_object_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Post Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_visualization_object_post_optional_id_document: (required) + :type json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_visualization_objects_serialize( + workspace_id=workspace_id, + json_api_visualization_object_post_optional_id_document=json_api_visualization_object_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_visualization_object_post_optional_id_document: (required) + :type json_api_visualization_object_post_optional_id_document: JsonApiVisualizationObjectPostOptionalIdDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_visualization_objects_serialize( + workspace_id=workspace_id, + json_api_visualization_object_post_optional_id_document=json_api_visualization_object_post_optional_id_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_visualization_objects_serialize( self, workspace_id, json_api_visualization_object_post_optional_id_document, - **kwargs - ): - """Post Visualization Objects # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_visualization_object_post_optional_id_document (JsonApiVisualizationObjectPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_visualization_object_post_optional_id_document'] = \ - json_api_visualization_object_post_optional_id_document - return self.create_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_visualization_object_post_optional_id_document is not None: + _body_params = json_api_visualization_object_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Post Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Post Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspace_data_filter_settings_serialize( self, workspace_id, json_api_workspace_data_filter_setting_in_document, - **kwargs - ): - """Post Settings for Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_data_filter_setting_in_document'] = \ - json_api_workspace_data_filter_setting_in_document - return self.create_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_setting_in_document is not None: + _body_params = json_api_workspace_data_filter_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Post Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Post Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspace_data_filters_serialize( self, workspace_id, json_api_workspace_data_filter_in_document, - **kwargs - ): - """Post Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_data_filter_in_document'] = \ - json_api_workspace_data_filter_in_document - return self.create_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_in_document is not None: + _body_params = json_api_workspace_data_filter_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_workspace_settings( + self, + workspace_id: StrictStr, + json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Post Settings for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_setting_post_optional_id_document: (required) + :type json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_setting_post_optional_id_document=json_api_workspace_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Post Settings for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_setting_post_optional_id_document: (required) + :type json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_setting_post_optional_id_document=json_api_workspace_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Settings for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_setting_post_optional_id_document: (required) + :type json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_setting_post_optional_id_document=json_api_workspace_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspace_settings_serialize( self, workspace_id, json_api_workspace_setting_post_optional_id_document, - **kwargs - ): - """Post Settings for Workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_setting_post_optional_id_document (JsonApiWorkspaceSettingPostOptionalIdDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_setting_post_optional_id_document'] = \ - json_api_workspace_setting_post_optional_id_document - return self.create_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_setting_post_optional_id_document is not None: + _body_params = json_api_workspace_setting_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_analytical_dashboards_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_analytical_dashboards(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_attribute_hierarchies_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_automations_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_automations(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_automations_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_custom_application_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_custom_application_settings_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_custom_application_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_dashboard_plugins_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_dashboard_plugins(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_export_definitions_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_export_definitions(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_filter_contexts_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_filter_contexts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_filter_views_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_filter_views(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_metrics( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_metrics_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_metrics(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_metrics_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_user_data_filters_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_user_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_visualization_objects_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_visualization_objects(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_workspace_data_filter_settings_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Settings for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_workspace_data_filters_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_workspace_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_workspace_settings_serialize( self, workspace_id, object_id, - **kwargs - ): - """Delete a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_aggregated_facts( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAggregatedFactOutList: + """get_all_entities_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_aggregated_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_aggregated_facts_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAggregatedFactOutList]: + """get_all_entities_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_aggregated_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_aggregated_facts_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_all_entities_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_aggregated_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_aggregated_facts_serialize( self, workspace_id, - **kwargs - ): - """get_all_entities_aggregated_facts # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_aggregated_facts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAggregatedFactOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_aggregated_facts_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_analytical_dashboards( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutList: + """Get all Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_analytical_dashboards_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutList]: + """Get all Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_analytical_dashboards_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_analytical_dashboards_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_analytical_dashboards_serialize( self, workspace_id, - **kwargs - ): - """Get all Dashboards # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_analytical_dashboards(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_attribute_hierarchies( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutList: + """Get all Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attribute_hierarchies_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutList]: + """Get all Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attribute_hierarchies_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Attribute Hierarchies + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attribute_hierarchies_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_attribute_hierarchies_serialize( self, workspace_id, - **kwargs - ): - """Get all Attribute Hierarchies # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_attribute_hierarchies(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_attributes( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeOutList: + """Get all Attributes + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attributes_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_attributes_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeOutList]: + """Get all Attributes + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attributes_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_attributes_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Attributes + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_attributes_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_attributes_serialize( self, workspace_id, - **kwargs - ): - """Get all Attributes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_attributes(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_attributes_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_automations( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutList: + """Get all Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_automations_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_automations_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutList]: + """Get all Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_automations_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_automations_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Automations + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_automations_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_automations_serialize( self, workspace_id, - **kwargs - ): - """Get all Automations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_automations(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_automations_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_custom_application_settings( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutList: + """Get all Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_custom_application_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutList]: + """Get all Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_custom_application_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_custom_application_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_custom_application_settings_serialize( + self, + workspace_id, + origin, + filter, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_dashboard_plugins( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutList: + """Get all Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_dashboard_plugins_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutList]: + """Get all Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_dashboard_plugins_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Plugins + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_dashboard_plugins_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_dashboard_plugins_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_datasets( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDatasetOutList: + """Get all Datasets + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_datasets_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_datasets_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDatasetOutList]: + """Get all Datasets + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_datasets_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_datasets_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Datasets + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_datasets_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_datasets_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/datasets', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_export_definitions( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutList: + """Get all Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_definitions_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutList]: + """Get all Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_definitions_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Export Definitions + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_export_definitions_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_export_definitions_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_facts( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFactOutList: + """Get all Facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_facts_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFactOutList]: + """Get all Facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_facts_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Facts + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_facts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_facts_serialize( + self, + workspace_id, + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/facts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_filter_contexts( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutList: + """Get all Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_contexts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutList]: + """Get all Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_contexts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Context Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_contexts_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_filter_contexts_serialize( self, workspace_id, - **kwargs - ): - """Get all Custom Application Settings # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_custom_application_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) - def get_all_entities_dashboard_plugins( - self, - workspace_id, - **kwargs - ): - """Get all Plugins # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_dashboard_plugins(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def get_all_entities_datasets( - self, - workspace_id, - **kwargs - ): - """Get all Datasets # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_datasets(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDatasetOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_datasets_endpoint.call_with_http_info(**kwargs) + # authentication setting + _auth_settings: List[str] = [ + ] - def get_all_entities_export_definitions( - self, - workspace_id, - **kwargs - ): - """Get all Export Definitions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_export_definitions(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_export_definitions_endpoint.call_with_http_info(**kwargs) + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - def get_all_entities_facts( - self, - workspace_id, - **kwargs - ): - """Get all Facts # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_facts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFactOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_facts_endpoint.call_with_http_info(**kwargs) - def get_all_entities_filter_contexts( - self, - workspace_id, - **kwargs - ): - """Get all Context Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_filter_contexts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) + + @validate_call def get_all_entities_filter_views( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutList: + """Get all Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_views_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_filter_views_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutList]: + """Get all Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_views_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_filter_views_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_filter_views_serialize( self, workspace_id, - **kwargs - ): - """Get all Filter views # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_filter_views(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_filter_views_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_labels( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLabelOutList: + """Get all Labels + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_labels_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_labels_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLabelOutList]: + """Get all Labels + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_labels_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_labels_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Labels + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_labels_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_labels_serialize( self, workspace_id, - **kwargs - ): - """Get all Labels # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_labels(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLabelOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_labels_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/labels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_metrics( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutList: + """Get all Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_metrics_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_metrics_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutList]: + """Get all Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_metrics_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_metrics_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Metrics + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_metrics_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_metrics_serialize( self, workspace_id, - **kwargs - ): - """Get all Metrics # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_metrics(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_metrics_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_user_data_filters( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutList: + """Get all User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutList]: + """Get all User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all User Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_user_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_user_data_filters_serialize( self, workspace_id, - **kwargs - ): - """Get all User Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_data_filters(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_visualization_objects( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutList: + """Get all Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_visualization_objects_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutList]: + """Get all Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_visualization_objects_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Visualization Objects + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_visualization_objects_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_visualization_objects_serialize( self, workspace_id, - **kwargs - ): - """Get all Visualization Objects # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_visualization_objects(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutList: + """Get all Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutList]: + """Get all Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Settings for Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_workspace_data_filter_settings_serialize( self, workspace_id, - **kwargs - ): - """Get all Settings for Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_data_filter_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_all_entities_workspace_data_filters( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutList: + """Get all Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutList]: + """Get all Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Workspace Data Filters + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_data_filters_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_workspace_data_filters_serialize( self, workspace_id, - **kwargs - ): - """Get all Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_data_filters(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + origin, + filter, + include, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_all_entities_workspace_settings( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutList: + """Get all Setting for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutList]: + """Get all Setting for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Setting for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_workspace_settings_serialize( self, workspace_id, - **kwargs - ): - """Get all Setting for Workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) + origin, + filter, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_aggregated_facts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAggregatedFactOutDocument: + """get_entity_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_aggregated_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_aggregated_facts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAggregatedFactOutDocument]: + """get_entity_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_aggregated_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_aggregated_facts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_entity_aggregated_facts + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_aggregated_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAggregatedFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_aggregated_facts_serialize( self, workspace_id, object_id, - **kwargs - ): - """get_entity_aggregated_facts # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_aggregated_facts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAggregatedFactOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_aggregated_facts_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Get a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Get a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_analytical_dashboards_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_analytical_dashboards(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Get an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Get an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_attribute_hierarchies_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_attributes( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeOutDocument: + """Get an Attribute + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attributes_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_attributes_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeOutDocument]: + """Get an Attribute + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attributes_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_attributes_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Attribute + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_attributes_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_attributes_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get an Attribute # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_attributes(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_attributes_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Get an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Get an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_automations_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_automations(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_automations_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_custom_application_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Get a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Get a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_custom_application_settings_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_custom_application_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + filter, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Get a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Get a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_dashboard_plugins_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_dashboard_plugins(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_datasets( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDatasetOutDocument: + """Get a Dataset + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_datasets_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_datasets_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDatasetOutDocument]: + """Get a Dataset + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_datasets_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_datasets_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Dataset + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_datasets_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDatasetOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_datasets_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Dataset # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_datasets(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDatasetOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_datasets_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Get an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Get an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_export_definitions_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_export_definitions(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_facts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFactOutDocument: + """Get a Fact + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_facts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFactOutDocument]: + """Get a Fact + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_facts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Fact + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_facts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFactOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_facts_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Fact # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_facts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFactOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_facts_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Get a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Get a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_filter_contexts_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_filter_contexts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Get Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Get Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_filter_views_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_filter_views(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_filter_views_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_labels( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiLabelOutDocument: + """Get a Label + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_labels_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_labels_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiLabelOutDocument]: + """Get a Label + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_labels_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_labels_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Label + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_labels_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiLabelOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_labels_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Label # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_labels(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLabelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_labels_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_metrics( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Get a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Get a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_metrics_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_metrics(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_metrics_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Get a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Get a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_user_data_filters_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Get a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Get a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_visualization_objects_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_visualization_objects(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Get a Setting for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Get a Setting for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Setting for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_workspace_data_filter_settings_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Setting for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def get_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Get a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Get a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + include=include, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_workspace_data_filters_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + filter, + include, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_entity_workspace_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Get a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Get a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_workspace_settings_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + filter, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Patch a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_patch_document: (required) + :type json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_patch_document=json_api_analytical_dashboard_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Patch a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_patch_document: (required) + :type json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_patch_document=json_api_analytical_dashboard_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Dashboard + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_patch_document: (required) + :type json_api_analytical_dashboard_patch_document: JsonApiAnalyticalDashboardPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_patch_document=json_api_analytical_dashboard_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_analytical_dashboards_serialize( self, workspace_id, object_id, json_api_analytical_dashboard_patch_document, - **kwargs - ): - """Patch a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_analytical_dashboard_patch_document (JsonApiAnalyticalDashboardPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_analytical_dashboard_patch_document'] = \ - json_api_analytical_dashboard_patch_document - return self.patch_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_analytical_dashboard_patch_document is not None: + _body_params = json_api_analytical_dashboard_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Patch an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_patch_document: (required) + :type json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_patch_document=json_api_attribute_hierarchy_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Patch an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_patch_document: (required) + :type json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_patch_document=json_api_attribute_hierarchy_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_patch_document: (required) + :type json_api_attribute_hierarchy_patch_document: JsonApiAttributeHierarchyPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_patch_document=json_api_attribute_hierarchy_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_attribute_hierarchies_serialize( self, workspace_id, object_id, json_api_attribute_hierarchy_patch_document, - **kwargs - ): - """Patch an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_attribute_hierarchy_patch_document (JsonApiAttributeHierarchyPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_attribute_hierarchy_patch_document'] = \ - json_api_attribute_hierarchy_patch_document - return self.patch_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_attribute_hierarchy_patch_document is not None: + _body_params = json_api_attribute_hierarchy_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_patch_document: JsonApiAutomationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Patch an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_patch_document: (required) + :type json_api_automation_patch_document: JsonApiAutomationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_patch_document=json_api_automation_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_patch_document: JsonApiAutomationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Patch an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_patch_document: (required) + :type json_api_automation_patch_document: JsonApiAutomationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_patch_document=json_api_automation_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_patch_document: JsonApiAutomationPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_patch_document: (required) + :type json_api_automation_patch_document: JsonApiAutomationPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_patch_document=json_api_automation_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_automations_serialize( self, workspace_id, object_id, json_api_automation_patch_document, - **kwargs - ): - """Patch an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_automation_patch_document (JsonApiAutomationPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_automation_patch_document'] = \ - json_api_automation_patch_document - return self.patch_entity_automations_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_automation_patch_document is not None: + _body_params = json_api_automation_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_custom_application_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Patch a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_patch_document: (required) + :type json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_patch_document=json_api_custom_application_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Patch a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_patch_document: (required) + :type json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_patch_document=json_api_custom_application_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_patch_document: (required) + :type json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_patch_document=json_api_custom_application_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_custom_application_settings_serialize( self, workspace_id, object_id, json_api_custom_application_setting_patch_document, - **kwargs - ): - """Patch a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_custom_application_setting_patch_document (JsonApiCustomApplicationSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_custom_application_setting_patch_document'] = \ - json_api_custom_application_setting_patch_document - return self.patch_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_custom_application_setting_patch_document is not None: + _body_params = json_api_custom_application_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Patch a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_patch_document: (required) + :type json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_patch_document=json_api_dashboard_plugin_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Patch a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_patch_document: (required) + :type json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_patch_document=json_api_dashboard_plugin_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_patch_document: (required) + :type json_api_dashboard_plugin_patch_document: JsonApiDashboardPluginPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_patch_document=json_api_dashboard_plugin_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_dashboard_plugins_serialize( self, workspace_id, object_id, json_api_dashboard_plugin_patch_document, - **kwargs - ): - """Patch a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_dashboard_plugin_patch_document (JsonApiDashboardPluginPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_dashboard_plugin_patch_document'] = \ - json_api_dashboard_plugin_patch_document - return self.patch_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_dashboard_plugin_patch_document is not None: + _body_params = json_api_dashboard_plugin_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Patch an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_patch_document: (required) + :type json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_patch_document=json_api_export_definition_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Patch an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_patch_document: (required) + :type json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_patch_document=json_api_export_definition_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_patch_document: (required) + :type json_api_export_definition_patch_document: JsonApiExportDefinitionPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_patch_document=json_api_export_definition_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_export_definitions_serialize( self, workspace_id, object_id, json_api_export_definition_patch_document, - **kwargs - ): - """Patch an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_export_definition_patch_document (JsonApiExportDefinitionPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_export_definition_patch_document'] = \ - json_api_export_definition_patch_document - return self.patch_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_definition_patch_document is not None: + _body_params = json_api_export_definition_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Patch a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_patch_document: (required) + :type json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_patch_document=json_api_filter_context_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Patch a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_patch_document: (required) + :type json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_patch_document=json_api_filter_context_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_patch_document: (required) + :type json_api_filter_context_patch_document: JsonApiFilterContextPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_patch_document=json_api_filter_context_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_filter_contexts_serialize( self, workspace_id, object_id, json_api_filter_context_patch_document, - **kwargs - ): - """Patch a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_context_patch_document (JsonApiFilterContextPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_context_patch_document'] = \ - json_api_filter_context_patch_document - return self.patch_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_context_patch_document is not None: + _body_params = json_api_filter_context_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Patch Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_patch_document: (required) + :type json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_patch_document=json_api_filter_view_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Patch Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_patch_document: (required) + :type json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_patch_document=json_api_filter_view_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Filter view + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_patch_document: (required) + :type json_api_filter_view_patch_document: JsonApiFilterViewPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_patch_document=json_api_filter_view_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_filter_views_serialize( self, workspace_id, object_id, json_api_filter_view_patch_document, - **kwargs - ): - """Patch Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_view_patch_document (JsonApiFilterViewPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_view_patch_document'] = \ - json_api_filter_view_patch_document - return self.patch_entity_filter_views_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_view_patch_document is not None: + _body_params = json_api_filter_view_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_metrics( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_patch_document: JsonApiMetricPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Patch a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_patch_document: (required) + :type json_api_metric_patch_document: JsonApiMetricPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_patch_document=json_api_metric_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_patch_document: JsonApiMetricPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Patch a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_patch_document: (required) + :type json_api_metric_patch_document: JsonApiMetricPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_patch_document=json_api_metric_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_patch_document: JsonApiMetricPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_patch_document: (required) + :type json_api_metric_patch_document: JsonApiMetricPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_patch_document=json_api_metric_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_metrics_serialize( self, workspace_id, object_id, json_api_metric_patch_document, - **kwargs - ): - """Patch a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_metric_patch_document (JsonApiMetricPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_metric_patch_document'] = \ - json_api_metric_patch_document - return self.patch_entity_metrics_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_metric_patch_document is not None: + _body_params = json_api_metric_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Patch a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_patch_document: (required) + :type json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_patch_document=json_api_user_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Patch a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_patch_document: (required) + :type json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_patch_document=json_api_user_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_patch_document: (required) + :type json_api_user_data_filter_patch_document: JsonApiUserDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_patch_document=json_api_user_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_user_data_filters_serialize( self, workspace_id, object_id, json_api_user_data_filter_patch_document, - **kwargs - ): - """Patch a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_user_data_filter_patch_document (JsonApiUserDataFilterPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_user_data_filter_patch_document'] = \ - json_api_user_data_filter_patch_document - return self.patch_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_data_filter_patch_document is not None: + _body_params = json_api_user_data_filter_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Patch a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_patch_document: (required) + :type json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_patch_document=json_api_visualization_object_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Patch a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_patch_document: (required) + :type json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_patch_document=json_api_visualization_object_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_patch_document: (required) + :type json_api_visualization_object_patch_document: JsonApiVisualizationObjectPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_patch_document=json_api_visualization_object_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_visualization_objects_serialize( self, workspace_id, object_id, json_api_visualization_object_patch_document, - **kwargs - ): - """Patch a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_visualization_object_patch_document (JsonApiVisualizationObjectPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_visualization_object_patch_document'] = \ - json_api_visualization_object_patch_document - return self.patch_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_visualization_object_patch_document is not None: + _body_params = json_api_visualization_object_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Patch a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_patch_document: (required) + :type json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_patch_document=json_api_workspace_data_filter_setting_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Patch a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_patch_document: (required) + :type json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_patch_document=json_api_workspace_data_filter_setting_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_patch_document: (required) + :type json_api_workspace_data_filter_setting_patch_document: JsonApiWorkspaceDataFilterSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_patch_document=json_api_workspace_data_filter_setting_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspace_data_filter_settings_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, - **kwargs - ): - """Patch a Settings for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_setting_patch_document (JsonApiWorkspaceDataFilterSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_setting_patch_document'] = \ - json_api_workspace_data_filter_setting_patch_document - return self.patch_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_setting_patch_document is not None: + _body_params = json_api_workspace_data_filter_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Patch a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_patch_document: (required) + :type json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_patch_document=json_api_workspace_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Patch a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_patch_document: (required) + :type json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_patch_document=json_api_workspace_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_patch_document: (required) + :type json_api_workspace_data_filter_patch_document: JsonApiWorkspaceDataFilterPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_patch_document=json_api_workspace_data_filter_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspace_data_filters_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_patch_document, - **kwargs - ): - """Patch a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_patch_document (JsonApiWorkspaceDataFilterPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_patch_document'] = \ - json_api_workspace_data_filter_patch_document - return self.patch_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_patch_document is not None: + _body_params = json_api_workspace_data_filter_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def patch_entity_workspace_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Patch a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_patch_document: (required) + :type json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_patch_document=json_api_workspace_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Patch a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_patch_document: (required) + :type json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_patch_document=json_api_workspace_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_patch_document: (required) + :type json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_patch_document=json_api_workspace_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspace_settings_serialize( self, workspace_id, object_id, json_api_workspace_setting_patch_document, - **kwargs - ): - """Patch a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_setting_patch_document (JsonApiWorkspaceSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_setting_patch_document'] = \ - json_api_workspace_setting_patch_document - return self.patch_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_setting_patch_document is not None: + _body_params = json_api_workspace_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_analytical_dashboards( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAnalyticalDashboardOutDocument: + """Put Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_in_document: (required) + :type json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_in_document=json_api_analytical_dashboard_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_analytical_dashboards_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAnalyticalDashboardOutDocument]: + """Put Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_in_document: (required) + :type json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_in_document=json_api_analytical_dashboard_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_analytical_dashboards_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Dashboards + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_analytical_dashboard_in_document: (required) + :type json_api_analytical_dashboard_in_document: JsonApiAnalyticalDashboardInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_analytical_dashboards_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_analytical_dashboard_in_document=json_api_analytical_dashboard_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAnalyticalDashboardOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_analytical_dashboards_serialize( self, workspace_id, object_id, json_api_analytical_dashboard_in_document, - **kwargs - ): - """Put Dashboards # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_analytical_dashboard_in_document (JsonApiAnalyticalDashboardInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_analytical_dashboard_in_document'] = \ - json_api_analytical_dashboard_in_document - return self.update_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_analytical_dashboard_in_document is not None: + _body_params = json_api_analytical_dashboard_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_attribute_hierarchies( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAttributeHierarchyOutDocument: + """Put an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_attribute_hierarchies_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAttributeHierarchyOutDocument]: + """Put an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_attribute_hierarchies_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put an Attribute Hierarchy + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_attribute_hierarchy_in_document: (required) + :type json_api_attribute_hierarchy_in_document: JsonApiAttributeHierarchyInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_attribute_hierarchies_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_attribute_hierarchy_in_document=json_api_attribute_hierarchy_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAttributeHierarchyOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_attribute_hierarchies_serialize( self, workspace_id, object_id, json_api_attribute_hierarchy_in_document, - **kwargs - ): - """Put an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_attribute_hierarchy_in_document'] = \ - json_api_attribute_hierarchy_in_document - return self.update_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_attribute_hierarchy_in_document is not None: + _body_params = json_api_attribute_hierarchy_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_automations( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiAutomationOutDocument: + """Put an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_in_document=json_api_automation_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_automations_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiAutomationOutDocument]: + """Put an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_in_document=json_api_automation_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_automations_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_automation_in_document: JsonApiAutomationInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put an Automation + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_automation_in_document: (required) + :type json_api_automation_in_document: JsonApiAutomationInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_automations_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_automation_in_document=json_api_automation_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiAutomationOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_automations_serialize( self, workspace_id, object_id, json_api_automation_in_document, - **kwargs - ): - """Put an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.update_entity_automations_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_automation_in_document is not None: + _body_params = json_api_automation_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_custom_application_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Put a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_in_document: (required) + :type json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_in_document=json_api_custom_application_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Put a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_in_document: (required) + :type json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_in_document=json_api_custom_application_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_in_document: (required) + :type json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_in_document=json_api_custom_application_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_custom_application_settings_serialize( self, workspace_id, object_id, json_api_custom_application_setting_in_document, - **kwargs - ): - """Put a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_custom_application_setting_in_document (JsonApiCustomApplicationSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_custom_application_setting_in_document'] = \ - json_api_custom_application_setting_in_document - return self.update_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_custom_application_setting_in_document is not None: + _body_params = json_api_custom_application_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_dashboard_plugins( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiDashboardPluginOutDocument: + """Put a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_in_document: (required) + :type json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_in_document=json_api_dashboard_plugin_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_dashboard_plugins_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiDashboardPluginOutDocument]: + """Put a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_in_document: (required) + :type json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_in_document=json_api_dashboard_plugin_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_dashboard_plugins_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Plugin + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_dashboard_plugin_in_document: (required) + :type json_api_dashboard_plugin_in_document: JsonApiDashboardPluginInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_dashboard_plugins_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_dashboard_plugin_in_document=json_api_dashboard_plugin_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiDashboardPluginOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_dashboard_plugins_serialize( self, workspace_id, object_id, json_api_dashboard_plugin_in_document, - **kwargs - ): - """Put a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_dashboard_plugin_in_document (JsonApiDashboardPluginInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_dashboard_plugin_in_document'] = \ - json_api_dashboard_plugin_in_document - return self.update_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_dashboard_plugin_in_document is not None: + _body_params = json_api_dashboard_plugin_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_export_definitions( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_in_document: JsonApiExportDefinitionInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiExportDefinitionOutDocument: + """Put an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_in_document: (required) + :type json_api_export_definition_in_document: JsonApiExportDefinitionInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_in_document=json_api_export_definition_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_export_definitions_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_in_document: JsonApiExportDefinitionInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiExportDefinitionOutDocument]: + """Put an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_in_document: (required) + :type json_api_export_definition_in_document: JsonApiExportDefinitionInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_in_document=json_api_export_definition_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_export_definitions_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_export_definition_in_document: JsonApiExportDefinitionInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put an Export Definition + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_export_definition_in_document: (required) + :type json_api_export_definition_in_document: JsonApiExportDefinitionInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_export_definitions_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_export_definition_in_document=json_api_export_definition_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiExportDefinitionOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_export_definitions_serialize( self, workspace_id, object_id, json_api_export_definition_in_document, - **kwargs - ): - """Put an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_export_definition_in_document (JsonApiExportDefinitionInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_export_definition_in_document'] = \ - json_api_export_definition_in_document - return self.update_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_export_definition_in_document is not None: + _body_params = json_api_export_definition_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_filter_contexts( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_in_document: JsonApiFilterContextInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterContextOutDocument: + """Put a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_in_document: (required) + :type json_api_filter_context_in_document: JsonApiFilterContextInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_in_document=json_api_filter_context_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_filter_contexts_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_in_document: JsonApiFilterContextInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterContextOutDocument]: + """Put a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_in_document: (required) + :type json_api_filter_context_in_document: JsonApiFilterContextInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_in_document=json_api_filter_context_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_filter_contexts_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_context_in_document: JsonApiFilterContextInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Context Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_context_in_document: (required) + :type json_api_filter_context_in_document: JsonApiFilterContextInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_contexts_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_context_in_document=json_api_filter_context_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterContextOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_filter_contexts_serialize( self, workspace_id, object_id, json_api_filter_context_in_document, - **kwargs - ): - """Put a Context Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_context_in_document (JsonApiFilterContextInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_context_in_document'] = \ - json_api_filter_context_in_document - return self.update_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_context_in_document is not None: + _body_params = json_api_filter_context_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_filter_views( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiFilterViewOutDocument: + """Put Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_filter_views_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiFilterViewOutDocument]: + """Put Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_filter_views_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_filter_view_in_document: JsonApiFilterViewInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Filter views + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_filter_view_in_document: (required) + :type json_api_filter_view_in_document: JsonApiFilterViewInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_filter_views_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_filter_view_in_document=json_api_filter_view_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiFilterViewOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_filter_views_serialize( self, workspace_id, object_id, json_api_filter_view_in_document, - **kwargs - ): - """Put Filter views # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.update_entity_filter_views_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_filter_view_in_document is not None: + _body_params = json_api_filter_view_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_metrics( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_in_document: JsonApiMetricInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiMetricOutDocument: + """Put a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_in_document: (required) + :type json_api_metric_in_document: JsonApiMetricInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_in_document=json_api_metric_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_metrics_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_in_document: JsonApiMetricInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiMetricOutDocument]: + """Put a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_in_document: (required) + :type json_api_metric_in_document: JsonApiMetricInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_in_document=json_api_metric_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_metrics_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_metric_in_document: JsonApiMetricInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Metric + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_metric_in_document: (required) + :type json_api_metric_in_document: JsonApiMetricInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_metrics_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_metric_in_document=json_api_metric_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiMetricOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_metrics_serialize( self, workspace_id, object_id, json_api_metric_in_document, - **kwargs - ): - """Put a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_metric_in_document (JsonApiMetricInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_metric_in_document'] = \ - json_api_metric_in_document - return self.update_entity_metrics_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_metric_in_document is not None: + _body_params = json_api_metric_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_user_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiUserDataFilterOutDocument: + """Put a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_in_document: (required) + :type json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_in_document=json_api_user_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_user_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiUserDataFilterOutDocument]: + """Put a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_in_document: (required) + :type json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_in_document=json_api_user_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_user_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a User Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_user_data_filter_in_document: (required) + :type json_api_user_data_filter_in_document: JsonApiUserDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_user_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_user_data_filter_in_document=json_api_user_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiUserDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_user_data_filters_serialize( self, workspace_id, object_id, json_api_user_data_filter_in_document, - **kwargs - ): - """Put a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_user_data_filter_in_document (JsonApiUserDataFilterInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_user_data_filter_in_document'] = \ - json_api_user_data_filter_in_document - return self.update_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_user_data_filter_in_document is not None: + _body_params = json_api_user_data_filter_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_visualization_objects( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiVisualizationObjectOutDocument: + """Put a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_in_document: (required) + :type json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_in_document=json_api_visualization_object_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_visualization_objects_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiVisualizationObjectOutDocument]: + """Put a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_in_document: (required) + :type json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_in_document=json_api_visualization_object_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_visualization_objects_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Visualization Object + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_visualization_object_in_document: (required) + :type json_api_visualization_object_in_document: JsonApiVisualizationObjectInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_visualization_objects_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_visualization_object_in_document=json_api_visualization_object_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiVisualizationObjectOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_visualization_objects_serialize( self, workspace_id, object_id, json_api_visualization_object_in_document, - **kwargs - ): - """Put a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_visualization_object_in_document (JsonApiVisualizationObjectInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_visualization_object_in_document'] = \ - json_api_visualization_object_in_document - return self.update_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_visualization_object_in_document is not None: + _body_params = json_api_visualization_object_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_workspace_data_filter_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterSettingOutDocument: + """Put a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspace_data_filter_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterSettingOutDocument]: + """Put a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_workspace_data_filter_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Settings for Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_setting_in_document: (required) + :type json_api_workspace_data_filter_setting_in_document: JsonApiWorkspaceDataFilterSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filter_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_setting_in_document=json_api_workspace_data_filter_setting_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_workspace_data_filter_settings_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, - **kwargs - ): - """Put a Settings for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_setting_in_document'] = \ - json_api_workspace_data_filter_setting_in_document - return self.update_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_setting_in_document is not None: + _body_params = json_api_workspace_data_filter_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_workspace_data_filters( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceDataFilterOutDocument: + """Put a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspace_data_filters_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceDataFilterOutDocument]: + """Put a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_workspace_data_filters_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Workspace Data Filter + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_data_filter_in_document: (required) + :type json_api_workspace_data_filter_in_document: JsonApiWorkspaceDataFilterInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_data_filters_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_data_filter_in_document=json_api_workspace_data_filter_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceDataFilterOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_workspace_data_filters_serialize( self, workspace_id, object_id, json_api_workspace_data_filter_in_document, - **kwargs - ): - """Put a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_in_document'] = \ - json_api_workspace_data_filter_in_document - return self.update_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_data_filter_in_document is not None: + _body_params = json_api_workspace_data_filter_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def update_entity_workspace_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Put a Setting for a Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_in_document: (required) + :type json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_in_document=json_api_workspace_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Put a Setting for a Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_in_document: (required) + :type json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_in_document=json_api_workspace_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Setting for a Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_in_document: (required) + :type json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_in_document=json_api_workspace_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_workspace_settings_serialize( self, workspace_id, object_id, json_api_workspace_setting_in_document, - **kwargs - ): - """Put a Setting for a Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_setting_in_document (JsonApiWorkspaceSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_setting_in_document'] = \ - json_api_workspace_setting_in_document - return self.update_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_setting_in_document is not None: + _body_params = json_api_workspace_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/workspaces_declarative_apis_api.py b/gooddata-api-client/gooddata_api_client/api/workspaces_declarative_apis_api.py index 6d3140872..7a6e09341 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspaces_declarative_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspaces_declarative_apis_api.py @@ -1,588 +1,1128 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import StrictStr, field_validator +from typing import List, Optional +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class WorkspacesDeclarativeAPIsApi(object): +class WorkspacesDeclarativeAPIsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.get_workspace_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeWorkspaceModel,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}', - 'operation_id': 'get_workspace_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'exclude', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'exclude': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'exclude': 'exclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_workspaces_layout_endpoint = _Endpoint( - settings={ - 'response_type': (DeclarativeWorkspaces,), - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces', - 'operation_id': 'get_workspaces_layout', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'exclude', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'exclude', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('exclude',): { - - "ACTIVITY_INFO": "ACTIVITY_INFO" - }, - }, - 'openapi_types': { - 'exclude': - ([str],), - }, - 'attribute_map': { - 'exclude': 'exclude', - }, - 'location_map': { - 'exclude': 'query', - }, - 'collection_format_map': { - 'exclude': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.put_workspace_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}', - 'operation_id': 'put_workspace_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'declarative_workspace_model', - ], - 'required': [ - 'workspace_id', - 'declarative_workspace_model', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_workspace_model': - (DeclarativeWorkspaceModel,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'declarative_workspace_model': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ + + + @validate_call + def get_workspace_layout( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeWorkspaceModel: + """Get workspace layout + + Retrieve current model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_layout_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_workspace_layout_with_http_info( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeWorkspaceModel]: + """Get workspace layout + + Retrieve current model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_layout_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_workspace_layout_without_preload_content( + self, + workspace_id: StrictStr, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get workspace layout + + Retrieve current model of the workspace in declarative form. + + :param workspace_id: (required) + :type workspace_id: str + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspace_layout_serialize( + workspace_id=workspace_id, + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaceModel", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_workspace_layout_serialize( + self, + workspace_id, + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client - ) - self.set_workspaces_layout_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces', - 'operation_id': 'set_workspaces_layout', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'declarative_workspaces', - ], - 'required': [ - 'declarative_workspaces', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'declarative_workspaces': - (DeclarativeWorkspaces,), - }, - 'attribute_map': { - }, - 'location_map': { - 'declarative_workspaces': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces/{workspaceId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_workspaces_layout( + self, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DeclarativeWorkspaces: + """Get all workspaces layout + + Gets complete layout of workspaces, their hierarchy, models. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspaces_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaces", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_workspaces_layout_with_http_info( + self, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DeclarativeWorkspaces]: + """Get all workspaces layout + + Gets complete layout of workspaces, their hierarchy, models. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspaces_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaces", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_workspaces_layout_without_preload_content( + self, + exclude: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all workspaces layout + + Gets complete layout of workspaces, their hierarchy, models. + + :param exclude: + :type exclude: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_workspaces_layout_serialize( + exclude=exclude, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DeclarativeWorkspaces", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_workspaces_layout_serialize( + self, + exclude, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'exclude': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if exclude is not None: + + _query_params.append(('exclude', exclude)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/json' ] - }, - api_client=api_client + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/layout/workspaces', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - def get_workspace_layout( + + + + @validate_call + def put_workspace_layout( self, - workspace_id, - **kwargs - ): - """Get workspace layout # noqa: E501 - - Retrieve current model of the workspace in declarative form. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_workspace_layout(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeWorkspaceModel - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_workspace_layout_endpoint.call_with_http_info(**kwargs) + workspace_id: StrictStr, + declarative_workspace_model: DeclarativeWorkspaceModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set workspace layout - def get_workspaces_layout( + Set complete layout of workspace, like model, authorization, etc. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_model: (required) + :type declarative_workspace_model: DeclarativeWorkspaceModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_workspace_layout_serialize( + workspace_id=workspace_id, + declarative_workspace_model=declarative_workspace_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_workspace_layout_with_http_info( self, - **kwargs - ): - """Get all workspaces layout # noqa: E501 - - Gets complete layout of workspaces, their hierarchy, models. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_workspaces_layout(async_req=True) - >>> result = thread.get() - - - Keyword Args: - exclude ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DeclarativeWorkspaces - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_workspaces_layout_endpoint.call_with_http_info(**kwargs) + workspace_id: StrictStr, + declarative_workspace_model: DeclarativeWorkspaceModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set workspace layout - def put_workspace_layout( + Set complete layout of workspace, like model, authorization, etc. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_model: (required) + :type declarative_workspace_model: DeclarativeWorkspaceModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_workspace_layout_serialize( + workspace_id=workspace_id, + declarative_workspace_model=declarative_workspace_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_workspace_layout_without_preload_content( + self, + workspace_id: StrictStr, + declarative_workspace_model: DeclarativeWorkspaceModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set workspace layout + + Set complete layout of workspace, like model, authorization, etc. + + :param workspace_id: (required) + :type workspace_id: str + :param declarative_workspace_model: (required) + :type declarative_workspace_model: DeclarativeWorkspaceModel + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_workspace_layout_serialize( + workspace_id=workspace_id, + declarative_workspace_model=declarative_workspace_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_workspace_layout_serialize( self, workspace_id, declarative_workspace_model, - **kwargs - ): - """Set workspace layout # noqa: E501 - - Set complete layout of workspace, like model, authorization, etc. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_workspace_layout(workspace_id, declarative_workspace_model, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - declarative_workspace_model (DeclarativeWorkspaceModel): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['declarative_workspace_model'] = \ - declarative_workspace_model - return self.put_workspace_layout_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_workspace_model is not None: + _body_params = declarative_workspace_model + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces/{workspaceId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def set_workspaces_layout( + self, + declarative_workspaces: DeclarativeWorkspaces, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Set all workspaces layout + + Sets complete layout of workspaces, their hierarchy, models. + + :param declarative_workspaces: (required) + :type declarative_workspaces: DeclarativeWorkspaces + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspaces_layout_serialize( + declarative_workspaces=declarative_workspaces, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_workspaces_layout_with_http_info( + self, + declarative_workspaces: DeclarativeWorkspaces, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Set all workspaces layout + + Sets complete layout of workspaces, their hierarchy, models. + + :param declarative_workspaces: (required) + :type declarative_workspaces: DeclarativeWorkspaces + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspaces_layout_serialize( + declarative_workspaces=declarative_workspaces, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_workspaces_layout_without_preload_content( + self, + declarative_workspaces: DeclarativeWorkspaces, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set all workspaces layout + + Sets complete layout of workspaces, their hierarchy, models. + + :param declarative_workspaces: (required) + :type declarative_workspaces: DeclarativeWorkspaces + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_workspaces_layout_serialize( + declarative_workspaces=declarative_workspaces, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_workspaces_layout_serialize( self, declarative_workspaces, - **kwargs - ): - """Set all workspaces layout # noqa: E501 - - Sets complete layout of workspaces, their hierarchy, models. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_workspaces_layout(declarative_workspaces, async_req=True) - >>> result = thread.get() - - Args: - declarative_workspaces (DeclarativeWorkspaces): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['declarative_workspaces'] = \ - declarative_workspaces - return self.set_workspaces_layout_endpoint.call_with_http_info(**kwargs) + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if declarative_workspaces is not None: + _body_params = declarative_workspaces + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/layout/workspaces', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api/workspaces_entity_apis_api.py b/gooddata-api-client/gooddata_api_client/api/workspaces_entity_apis_api.py index e01eea084..07b30705b 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspaces_entity_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspaces_entity_apis_api.py @@ -1,1054 +1,1931 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType -class WorkspacesEntityAPIsApi(object): +class WorkspacesEntityAPIsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces', - 'operation_id': 'create_entity_workspaces', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_workspace_in_document', - 'include', - 'meta_include', - ], - 'required': [ - 'json_api_workspace_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - ('meta_include',): { - - "CONFIG": "config", - "PERMISSIONS": "permissions", - "HIERARCHY": "hierarchy", - "DATAMODELDATASETS": "dataModelDatasets", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_workspace_in_document': - (JsonApiWorkspaceInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'json_api_workspace_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + + + @validate_call + def create_entity_workspaces( + self, + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Post Workspace entities + + Space of the shared interest + + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspaces_serialize( + json_api_workspace_in_document=json_api_workspace_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.delete_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'delete_entity_workspaces', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.get_all_entities_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces', - 'operation_id': 'get_all_entities_workspaces', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - ('meta_include',): { - - "CONFIG": "config", - "PERMISSIONS": "permissions", - "HIERARCHY": "hierarchy", - "DATAMODELDATASETS": "dataModelDatasets", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspaces_with_http_info( + self, + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Post Workspace entities + + Space of the shared interest + + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspaces_serialize( + json_api_workspace_in_document=json_api_workspace_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - self.get_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'get_entity_workspaces', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - 'include', - 'meta_include', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'id', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - ('meta_include',): { - - "CONFIG": "config", - "PERMISSIONS": "permissions", - "HIERARCHY": "hierarchy", - "DATAMODELDATASETS": "dataModelDatasets", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - self.patch_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'patch_entity_workspaces', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_workspace_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_workspace_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_workspace_patch_document': - (JsonApiWorkspacePatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_workspace_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - self.update_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'update_entity_workspaces', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_workspace_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_workspace_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_workspace_in_document': - (JsonApiWorkspaceInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_workspace_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ + + + @validate_call + def create_entity_workspaces_without_preload_content( + self, + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Workspace entities + + Space of the shared interest + + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspaces_serialize( + json_api_workspace_in_document=json_api_workspace_in_document, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspaces_serialize( + self, + json_api_workspace_in_document, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_in_document is not None: + _body_params = json_api_workspace_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ 'application/vnd.gooddata.api+json' ] - }, - api_client=api_client + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - def create_entity_workspaces( + + + + @validate_call + def delete_entity_workspaces( self, - json_api_workspace_in_document, - **kwargs - ): - """Post Workspace entities # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspaces(json_api_workspace_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_workspace_in_document (JsonApiWorkspaceInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspaces_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspaces_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspaces_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def delete_entity_workspaces_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspaces_serialize( + id=id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_workspace_in_document'] = \ - json_api_workspace_in_document - return self.create_entity_workspaces_endpoint.call_with_http_info(**kwargs) + return response_data.response - def delete_entity_workspaces( + + def _delete_entity_workspaces_serialize( self, id, - **kwargs - ): - """Delete Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspaces(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_workspaces( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutList: + """Get Workspace entities + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspaces_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspaces_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutList]: + """Get Workspace entities + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspaces_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_all_entities_workspaces_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Workspace entities + + Space of the shared interest + + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspaces_serialize( + filter=filter, + include=include, + page=page, + size=size, + sort=sort, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_workspaces_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_all_entities_workspaces( + + def _get_all_entities_workspaces_serialize( + self, + filter, + include, + page, + size, + sort, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_workspaces( self, - **kwargs - ): - """Get Workspace entities # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspaces(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Get Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspaces_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspaces_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Get Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspaces_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def get_entity_workspaces_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspaces_serialize( + id=id, + filter=filter, + include=include, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_workspaces_endpoint.call_with_http_info(**kwargs) + return response_data.response - def get_entity_workspaces( + + def _get_entity_workspaces_serialize( self, id, - **kwargs - ): - """Get Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspaces(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def patch_entity_workspaces( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_patch_document: JsonApiWorkspacePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Patch Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_patch_document: (required) + :type json_api_workspace_patch_document: JsonApiWorkspacePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspaces_serialize( + id=id, + json_api_workspace_patch_document=json_api_workspace_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspaces_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_patch_document: JsonApiWorkspacePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Patch Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_patch_document: (required) + :type json_api_workspace_patch_document: JsonApiWorkspacePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspaces_serialize( + id=id, + json_api_workspace_patch_document=json_api_workspace_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + + @validate_call + def patch_entity_workspaces_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_patch_document: JsonApiWorkspacePatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_patch_document: (required) + :type json_api_workspace_patch_document: JsonApiWorkspacePatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspaces_serialize( + id=id, + json_api_workspace_patch_document=json_api_workspace_patch_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def patch_entity_workspaces( + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspaces_serialize( self, id, json_api_workspace_patch_document, - **kwargs - ): - """Patch Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspaces(id, json_api_workspace_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_workspace_patch_document (JsonApiWorkspacePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_patch_document is not None: + _body_params = json_api_workspace_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True + + + + + @validate_call + def update_entity_workspaces( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceOutDocument: + """Put Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspaces_serialize( + id=id, + json_api_workspace_in_document=json_api_workspace_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspaces_with_http_info( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceOutDocument]: + """Put Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspaces_serialize( + id=id, + json_api_workspace_in_document=json_api_workspace_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True + + + @validate_call + def update_entity_workspaces_without_preload_content( + self, + id: Annotated[str, Field(strict=True)], + json_api_workspace_in_document: JsonApiWorkspaceInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + include: Annotated[Optional[List[StrictStr]], Field(description="Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put Workspace entity + + Space of the shared interest + + :param id: (required) + :type id: str + :param json_api_workspace_in_document: (required) + :type json_api_workspace_in_document: JsonApiWorkspaceInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param include: Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. + :type include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspaces_serialize( + id=id, + json_api_workspace_in_document=json_api_workspace_in_document, + filter=filter, + include=include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_workspace_patch_document'] = \ - json_api_workspace_patch_document - return self.patch_entity_workspaces_endpoint.call_with_http_info(**kwargs) + return response_data.response - def update_entity_workspaces( + + def _update_entity_workspaces_serialize( self, id, json_api_workspace_in_document, - **kwargs - ): - """Put Workspace entity # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspaces(id, json_api_workspace_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_workspace_in_document (JsonApiWorkspaceInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + filter, + include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'include': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if include is not None: + + _query_params.append(('include', include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_in_document is not None: + _body_params = json_api_workspace_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_workspace_in_document'] = \ - json_api_workspace_in_document - return self.update_entity_workspaces_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py b/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py index fd9aa05aa..54e507033 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py @@ -1,2297 +1,4433 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint -from gooddata_api_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest -from gooddata_api_client.model.resolved_setting import ResolvedSetting - - -class WorkspacesSettingsApi(object): +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting + +from gooddata_api_client.api_client import ApiClient, RequestSerialized +from gooddata_api_client.api_response import ApiResponse +from gooddata_api_client.rest import RESTResponseType + + +class WorkspacesSettingsApi: """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=None): + def __init__(self, api_client=None) -> None: if api_client is None: - api_client = ApiClient() + api_client = ApiClient.get_default() self.api_client = api_client - self.create_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', - 'operation_id': 'create_entity_custom_application_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_custom_application_setting_post_optional_id_document', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_custom_application_setting_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_custom_application_setting_post_optional_id_document': - (JsonApiCustomApplicationSettingPostOptionalIdDocument,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_custom_application_setting_post_optional_id_document': 'body', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', - 'operation_id': 'create_entity_workspace_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_workspace_setting_post_optional_id_document', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_workspace_setting_post_optional_id_document', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'json_api_workspace_setting_post_optional_id_document': - (JsonApiWorkspaceSettingPostOptionalIdDocument,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_workspace_setting_post_optional_id_document': 'body', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.delete_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'delete_entity_custom_application_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'delete_entity_workspace_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', - 'operation_id': 'get_all_entities_custom_application_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', - 'operation_id': 'get_all_entities_workspace_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'get_entity_custom_application_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'get_entity_workspace_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'patch_entity_custom_application_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_patch_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_custom_application_setting_patch_document': - (JsonApiCustomApplicationSettingPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_custom_application_setting_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'patch_entity_workspace_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_patch_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_setting_patch_document': - (JsonApiWorkspaceSettingPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_setting_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'update_entity_custom_application_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_in_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_custom_application_setting_in_document': - (JsonApiCustomApplicationSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_custom_application_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'update_entity_workspace_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_in_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_setting_in_document': - (JsonApiWorkspaceSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.workspace_resolve_all_settings_endpoint = _Endpoint( - settings={ - 'response_type': ([ResolvedSetting],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/resolveSettings', - 'operation_id': 'workspace_resolve_all_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.workspace_resolve_settings_endpoint = _Endpoint( - settings={ - 'response_type': ([ResolvedSetting],), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/resolveSettings', - 'operation_id': 'workspace_resolve_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'resolve_settings_request', - ], - 'required': [ - 'workspace_id', - 'resolve_settings_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'resolve_settings_request': - (ResolveSettingsRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'resolve_settings_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) + + @validate_call def create_entity_custom_application_settings( + self, + workspace_id: StrictStr, + json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Post Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_custom_application_setting_post_optional_id_document: (required) + :type json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + json_api_custom_application_setting_post_optional_id_document=json_api_custom_application_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Post Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_custom_application_setting_post_optional_id_document: (required) + :type json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + json_api_custom_application_setting_post_optional_id_document=json_api_custom_application_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_custom_application_setting_post_optional_id_document: (required) + :type json_api_custom_application_setting_post_optional_id_document: JsonApiCustomApplicationSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + json_api_custom_application_setting_post_optional_id_document=json_api_custom_application_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_custom_application_settings_serialize( self, workspace_id, json_api_custom_application_setting_post_optional_id_document, - **kwargs - ): - """Post Custom Application Settings # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_custom_application_setting_post_optional_id_document (JsonApiCustomApplicationSettingPostOptionalIdDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_custom_application_setting_post_optional_id_document'] = \ - json_api_custom_application_setting_post_optional_id_document - return self.create_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_custom_application_setting_post_optional_id_document is not None: + _body_params = json_api_custom_application_setting_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def create_entity_workspace_settings( + self, + workspace_id: StrictStr, + json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Post Settings for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_setting_post_optional_id_document: (required) + :type json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_setting_post_optional_id_document=json_api_workspace_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Post Settings for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_setting_post_optional_id_document: (required) + :type json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_setting_post_optional_id_document=json_api_workspace_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Post Settings for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param json_api_workspace_setting_post_optional_id_document: (required) + :type json_api_workspace_setting_post_optional_id_document: JsonApiWorkspaceSettingPostOptionalIdDocument + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_entity_workspace_settings_serialize( + workspace_id=workspace_id, + json_api_workspace_setting_post_optional_id_document=json_api_workspace_setting_post_optional_id_document, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_entity_workspace_settings_serialize( self, workspace_id, json_api_workspace_setting_post_optional_id_document, - **kwargs - ): - """Post Settings for Workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_setting_post_optional_id_document (JsonApiWorkspaceSettingPostOptionalIdDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_setting_post_optional_id_document'] = \ - json_api_workspace_setting_post_optional_id_document - return self.create_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_setting_post_optional_id_document is not None: + _body_params = json_api_workspace_setting_post_optional_id_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call def delete_entity_custom_application_settings( self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_custom_application_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Custom Application Setting - def delete_entity_workspace_settings( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_custom_application_settings( + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_custom_application_settings_with_http_info( self, - workspace_id, - **kwargs - ): - """Get all Custom Application Settings # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_custom_application_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Custom Application Setting - def get_all_entities_workspace_settings( + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_custom_application_settings_without_preload_content( self, - workspace_id, - **kwargs - ): - """Get all Setting for Workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Custom Application Setting - def get_entity_custom_application_settings( + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_custom_application_settings_serialize( self, workspace_id, object_id, - **kwargs - ): - """Get a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_custom_application_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: - def get_entity_workspace_settings( + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_entity_workspace_settings( self, - workspace_id, - object_id, - **kwargs - ): - """Get a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete a Setting for Workspace - def patch_entity_custom_application_settings( + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_entity_workspace_settings_with_http_info( self, - workspace_id, - object_id, - json_api_custom_application_setting_patch_document, - **kwargs - ): - """Patch a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_custom_application_setting_patch_document (JsonApiCustomApplicationSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_custom_application_setting_patch_document'] = \ - json_api_custom_application_setting_patch_document - return self.patch_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete a Setting for Workspace - def patch_entity_workspace_settings( + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_entity_workspace_settings_without_preload_content( self, - workspace_id, - object_id, - json_api_workspace_setting_patch_document, - **kwargs - ): - """Patch a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_setting_patch_document (JsonApiWorkspaceSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_setting_patch_document'] = \ - json_api_workspace_setting_patch_document - return self.patch_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a Setting for Workspace - def update_entity_custom_application_settings( + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_entity_workspace_settings_serialize( self, workspace_id, object_id, - json_api_custom_application_setting_in_document, - **kwargs - ): - """Put a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_custom_application_setting_in_document (JsonApiCustomApplicationSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_custom_application_setting_in_document'] = \ - json_api_custom_application_setting_in_document - return self.update_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: - def update_entity_workspace_settings( + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_custom_application_settings( self, - workspace_id, - object_id, - json_api_workspace_setting_in_document, - **kwargs - ): - """Put a Setting for a Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_setting_in_document (JsonApiWorkspaceSettingInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_setting_in_document'] = \ - json_api_workspace_setting_in_document - return self.update_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutList: + """Get all Custom Application Settings - def workspace_resolve_all_settings( + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_custom_application_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_custom_application_settings_with_http_info( self, - workspace_id, - **kwargs - ): - """Values for all settings. # noqa: E501 - - Resolves values for all settings in a workspace by current user, workspace, organization, or default settings. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.workspace_resolve_all_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ResolvedSetting] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.workspace_resolve_all_settings_endpoint.call_with_http_info(**kwargs) + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutList]: + """Get all Custom Application Settings - def workspace_resolve_settings( + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_custom_application_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_custom_application_settings_without_preload_content( self, - workspace_id, - resolve_settings_request, - **kwargs - ): - """Values for selected settings. # noqa: E501 - - Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.workspace_resolve_settings(workspace_id, resolve_settings_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - resolve_settings_request (ResolveSettingsRequest): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): 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. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - [ResolvedSetting] - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['resolve_settings_request'] = \ - resolve_settings_request - return self.workspace_resolve_settings_endpoint.call_with_http_info(**kwargs) + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Custom Application Settings + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_custom_application_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_custom_application_settings_serialize( + self, + workspace_id, + origin, + filter, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_entities_workspace_settings( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutList: + """Get all Setting for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_entities_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutList]: + """Get all Setting for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_entities_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + origin: Optional[StrictStr] = None, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + page: Annotated[Optional[StrictInt], Field(description="Zero-based page index (0..N)")] = None, + size: Annotated[Optional[StrictInt], Field(description="The size of the page to be returned")] = None, + sort: Annotated[Optional[List[StrictStr]], Field(description="Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all Setting for Workspaces + + + :param workspace_id: (required) + :type workspace_id: str + :param origin: + :type origin: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param page: Zero-based page index (0..N) + :type page: int + :param size: The size of the page to be returned + :type size: int + :param sort: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. + :type sort: List[str] + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_entities_workspace_settings_serialize( + workspace_id=workspace_id, + origin=origin, + filter=filter, + page=page, + size=size, + sort=sort, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_entities_workspace_settings_serialize( + self, + workspace_id, + origin, + filter, + page, + size, + sort, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'sort': 'multi', + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + if origin is not None: + + _query_params.append(('origin', origin)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_custom_application_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Get a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Get a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_custom_application_settings_serialize( + self, + workspace_id, + object_id, + filter, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_entity_workspace_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Get a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Get a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + x_gdc_validate_relations: Optional[StrictBool] = None, + meta_include: Annotated[Optional[List[StrictStr]], Field(description="Include Meta objects.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param x_gdc_validate_relations: + :type x_gdc_validate_relations: bool + :param meta_include: Include Meta objects. + :type meta_include: List[str] + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + filter=filter, + x_gdc_validate_relations=x_gdc_validate_relations, + meta_include=meta_include, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_entity_workspace_settings_serialize( + self, + workspace_id, + object_id, + filter, + x_gdc_validate_relations, + meta_include, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'metaInclude': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + if meta_include is not None: + + _query_params.append(('metaInclude', meta_include)) + + # process the header parameters + if x_gdc_validate_relations is not None: + _header_params['X-GDC-VALIDATE-RELATIONS'] = x_gdc_validate_relations + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def patch_entity_custom_application_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Patch a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_patch_document: (required) + :type json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_patch_document=json_api_custom_application_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Patch a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_patch_document: (required) + :type json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_patch_document=json_api_custom_application_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_patch_document: (required) + :type json_api_custom_application_setting_patch_document: JsonApiCustomApplicationSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_patch_document=json_api_custom_application_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_custom_application_settings_serialize( + self, + workspace_id, + object_id, + json_api_custom_application_setting_patch_document, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_custom_application_setting_patch_document is not None: + _body_params = json_api_custom_application_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def patch_entity_workspace_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Patch a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_patch_document: (required) + :type json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_patch_document=json_api_workspace_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Patch a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_patch_document: (required) + :type json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_patch_document=json_api_workspace_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch a Setting for Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_patch_document: (required) + :type json_api_workspace_setting_patch_document: JsonApiWorkspaceSettingPatchDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_patch_document=json_api_workspace_setting_patch_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_entity_workspace_settings_serialize( + self, + workspace_id, + object_id, + json_api_workspace_setting_patch_document, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_setting_patch_document is not None: + _body_params = json_api_workspace_setting_patch_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_entity_custom_application_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiCustomApplicationSettingOutDocument: + """Put a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_in_document: (required) + :type json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_in_document=json_api_custom_application_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_custom_application_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiCustomApplicationSettingOutDocument]: + """Put a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_in_document: (required) + :type json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_in_document=json_api_custom_application_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_custom_application_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Custom Application Setting + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_custom_application_setting_in_document: (required) + :type json_api_custom_application_setting_in_document: JsonApiCustomApplicationSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_custom_application_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_custom_application_setting_in_document=json_api_custom_application_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiCustomApplicationSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_custom_application_settings_serialize( + self, + workspace_id, + object_id, + json_api_custom_application_setting_in_document, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_custom_application_setting_in_document is not None: + _body_params = json_api_custom_application_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_entity_workspace_settings( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JsonApiWorkspaceSettingOutDocument: + """Put a Setting for a Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_in_document: (required) + :type json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_in_document=json_api_workspace_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_entity_workspace_settings_with_http_info( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JsonApiWorkspaceSettingOutDocument]: + """Put a Setting for a Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_in_document: (required) + :type json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_in_document=json_api_workspace_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_entity_workspace_settings_without_preload_content( + self, + workspace_id: StrictStr, + object_id: StrictStr, + json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument, + filter: Annotated[Optional[StrictStr], Field(description="Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Put a Setting for a Workspace + + + :param workspace_id: (required) + :type workspace_id: str + :param object_id: (required) + :type object_id: str + :param json_api_workspace_setting_in_document: (required) + :type json_api_workspace_setting_in_document: JsonApiWorkspaceSettingInDocument + :param filter: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). + :type filter: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_entity_workspace_settings_serialize( + workspace_id=workspace_id, + object_id=object_id, + json_api_workspace_setting_in_document=json_api_workspace_setting_in_document, + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JsonApiWorkspaceSettingOutDocument", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_entity_workspace_settings_serialize( + self, + workspace_id, + object_id, + json_api_workspace_setting_in_document, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + + # process the header parameters + # process the form parameters + # process the body parameter + if json_api_workspace_setting_in_document is not None: + _body_params = json_api_workspace_setting_in_document + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.gooddata.api+json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/vnd.gooddata.api+json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def workspace_resolve_all_settings( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ResolvedSetting]: + """Values for all settings. + + Resolves values for all settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_all_settings_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def workspace_resolve_all_settings_with_http_info( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ResolvedSetting]]: + """Values for all settings. + + Resolves values for all settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_all_settings_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def workspace_resolve_all_settings_without_preload_content( + self, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for all settings. + + Resolves values for all settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_all_settings_serialize( + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _workspace_resolve_all_settings_serialize( + self, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/v1/actions/workspaces/{workspaceId}/resolveSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def workspace_resolve_settings( + self, + workspace_id: StrictStr, + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ResolvedSetting]: + """Values for selected settings. + + Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_settings_serialize( + workspace_id=workspace_id, + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def workspace_resolve_settings_with_http_info( + self, + workspace_id: StrictStr, + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ResolvedSetting]]: + """Values for selected settings. + + Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_settings_serialize( + workspace_id=workspace_id, + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def workspace_resolve_settings_without_preload_content( + self, + workspace_id: StrictStr, + resolve_settings_request: ResolveSettingsRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Values for selected settings. + + Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings. + + :param workspace_id: (required) + :type workspace_id: str + :param resolve_settings_request: (required) + :type resolve_settings_request: ResolveSettingsRequest + :param _request_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. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._workspace_resolve_settings_serialize( + workspace_id=workspace_id, + resolve_settings_request=resolve_settings_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ResolvedSetting]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _workspace_resolve_settings_serialize( + self, + workspace_id, + resolve_settings_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if workspace_id is not None: + _path_params['workspaceId'] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if resolve_settings_request is not None: + _body_params = resolve_settings_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/v1/actions/workspaces/{workspaceId}/resolveSettings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + diff --git a/gooddata-api-client/gooddata_api_client/api_client.py b/gooddata-api-client/gooddata_api_client/api_client.py index 3601e4431..995d7a2a0 100644 --- a/gooddata-api-client/gooddata_api_client/api_client.py +++ b/gooddata-api-client/gooddata_api_client/api_client.py @@ -1,46 +1,49 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +import datetime +from dateutil.parser import parse +from enum import Enum +import decimal import json -import atexit import mimetypes -from multiprocessing.pool import ThreadPool -import io import os import re -import typing -from urllib.parse import quote -from urllib3.fields import RequestField +import tempfile +from urllib.parse import quote +from typing import Tuple, Optional, List, Dict, Union +from pydantic import SecretStr -from gooddata_api_client import rest from gooddata_api_client.configuration import Configuration -from gooddata_api_client.exceptions import ApiTypeError, ApiValueError, ApiException -from gooddata_api_client.model_utils import ( - ModelNormal, - ModelSimple, - ModelComposed, - check_allowed_values, - check_validations, - date, - datetime, - deserialize_file, - file_type, - model_to_dict, - none_type, - validate_and_convert_types +from gooddata_api_client.api_response import ApiResponse, T as ApiResponseT +import gooddata_api_client.models +from gooddata_api_client import rest +from gooddata_api_client.exceptions import ( + ApiValueError, + ApiException, + BadRequestException, + UnauthorizedException, + ForbiddenException, + NotFoundException, + ServiceException ) +RequestSerialized = Tuple[str, str, Dict[str, str], Optional[str], List[str]] -class ApiClient(object): +class ApiClient: """Generic API client for OpenAPI client library builds. OpenAPI generic API client. This client handles the client- @@ -48,28 +51,39 @@ class ApiClient(object): 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. """ + PRIMITIVE_TYPES = (float, bool, bytes, str, int) + NATIVE_TYPES_MAPPING = { + 'int': int, + 'long': int, # TODO remove as only py3 is supported? + 'float': float, + 'str': str, + 'bool': bool, + 'date': datetime.date, + 'datetime': datetime.datetime, + 'decimal': decimal.Decimal, + 'object': object, + } _pool = None - def __init__(self, configuration=None, header_name=None, header_value=None, - cookie=None, pool_threads=1): + def __init__( + self, + configuration=None, + header_name=None, + header_value=None, + cookie=None + ) -> None: + # use default configuration if none is provided if configuration is None: - configuration = Configuration.get_default_copy() + configuration = Configuration.get_default() self.configuration = configuration - self.pool_threads = pool_threads self.rest_client = rest.RESTClientObject(configuration) self.default_headers = {} @@ -78,30 +92,13 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.cookie = cookie # Set default User-Agent. self.user_agent = 'OpenAPI-Generator/1.51.0/python' + self.client_side_validation = configuration.client_side_validation 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 + pass @property def user_agent(self): @@ -115,27 +112,69 @@ def user_agent(self, value): def set_default_header(self, header_name, header_value): self.default_headers[header_name] = header_value - def __call_api( + + _default = None + + @classmethod + def get_default(cls): + """Return new instance of ApiClient. + + This method returns newly created, based on default constructor, + object of ApiClient class or returns a copy of default + ApiClient. + + :return: The ApiClient object. + """ + if cls._default is None: + cls._default = ApiClient() + return cls._default + + @classmethod + def set_default(cls, default): + """Set default instance of ApiClient. + + It stores default ApiClient. + + :param default: object of ApiClient. + """ + cls._default = default + + def param_serialize( self, - resource_path: str, - method: str, - path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - body: typing.Optional[typing.Any] = None, - post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, - response_type: typing.Optional[typing.Tuple[typing.Any]] = None, - auth_settings: typing.Optional[typing.List[str]] = None, - _return_http_data_only: typing.Optional[bool] = None, - collection_formats: typing.Optional[typing.Dict[str, str]] = None, - _preload_content: bool = True, - _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, - _host: typing.Optional[str] = None, - _check_type: typing.Optional[bool] = None, - _content_type: typing.Optional[str] = None, - _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None - ): + method, + resource_path, + path_params=None, + query_params=None, + header_params=None, + body=None, + post_params=None, + files=None, auth_settings=None, + collection_formats=None, + _host=None, + _request_auth=None + ) -> RequestSerialized: + + """Builds the HTTP request params needed by the request. + :param method: Method to call. + :param resource_path: Path to method endpoint. + :param path_params: Path parameters in the url. + :param query_params: Query parameters in the url. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param auth_settings list: Auth Settings names for the request. + :param files dict: key -> filename, value -> filepath, + for `multipart/form-data`. + :param collection_formats: dict of collection formats for path, query, + header, and post parameters. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :return: tuple of form (path, http_method, query_params, header_params, + body, post_params, files) + """ config = self.configuration @@ -146,14 +185,17 @@ def __call_api( header_params['Cookie'] = self.cookie if header_params: header_params = self.sanitize_for_serialization(header_params) - header_params = dict(self.parameters_to_tuples(header_params, - collection_formats)) + header_params = dict( + self.parameters_to_tuples(header_params,collection_formats) + ) # path parameters if path_params: path_params = self.sanitize_for_serialization(path_params) - path_params = self.parameters_to_tuples(path_params, - collection_formats) + path_params = self.parameters_to_tuples( + path_params, + collection_formats + ) for k, v in path_params: # specified safe chars, encode everything resource_path = resource_path.replace( @@ -161,345 +203,269 @@ def __call_api( quote(str(v), safe=config.safe_chars_for_path_param) ) - # query parameters - if query_params: - query_params = self.sanitize_for_serialization(query_params) - query_params = self.parameters_to_tuples(query_params, - collection_formats) - # post parameters if post_params or files: post_params = post_params if post_params else [] post_params = self.sanitize_for_serialization(post_params) - post_params = self.parameters_to_tuples(post_params, - collection_formats) - post_params.extend(self.files_parameters(files)) - if header_params['Content-Type'].startswith("multipart"): - post_params = self.parameters_to_multipart(post_params, - (dict)) + post_params = self.parameters_to_tuples( + post_params, + collection_formats + ) + if files: + post_params.extend(self.files_parameters(files)) + + # auth setting + self.update_params_for_auth( + header_params, + query_params, + auth_settings, + resource_path, + method, + body, + request_auth=_request_auth + ) # body if body: body = self.sanitize_for_serialization(body) - # auth setting - self.update_params_for_auth(header_params, query_params, - auth_settings, resource_path, method, body, - request_auths=_request_auths) - # request url - if _host is None: + if _host is None or self.configuration.ignore_operation_servers: url = self.configuration.host + resource_path else: # use server/host defined in path or operation instead url = _host + resource_path + # query parameters + if query_params: + query_params = self.sanitize_for_serialization(query_params) + url_query = self.parameters_to_url_query( + query_params, + collection_formats + ) + url += "?" + url_query + + return method, url, header_params, body, post_params + + + def call_api( + self, + method, + url, + header_params=None, + body=None, + post_params=None, + _request_timeout=None + ) -> rest.RESTResponse: + """Makes the HTTP request (synchronous) + :param method: Method to call. + :param url: Path to method endpoint. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param _request_timeout: timeout setting for this request. + :return: RESTResponse + """ + try: # perform request and return response - response_data = self.request( - method, url, query_params=query_params, headers=header_params, - post_params=post_params, body=body, - _preload_content=_preload_content, - _request_timeout=_request_timeout) + response_data = self.rest_client.request( + method, url, + headers=header_params, + body=body, post_params=post_params, + _request_timeout=_request_timeout + ) + except ApiException as e: - e.body = e.body.decode('utf-8') raise e - self.last_response = response_data + return response_data + + def response_deserialize( + self, + response_data: rest.RESTResponse, + response_types_map: Optional[Dict[str, ApiResponseT]]=None + ) -> ApiResponse[ApiResponseT]: + """Deserializes response into an object. + :param response_data: RESTResponse object to be deserialized. + :param response_types_map: dict of response types. + :return: ApiResponse + """ - return_data = response_data + msg = "RESTResponse.read() must be called before passing it to response_deserialize()" + assert response_data.data is not None, msg - if not _preload_content: - return (return_data) - return return_data + response_type = response_types_map.get(str(response_data.status), None) + if not response_type and isinstance(response_data.status, int) and 100 <= response_data.status <= 599: + # if not found, look for '1XX', '2XX', etc. + response_type = response_types_map.get(str(response_data.status)[0] + "XX", None) # deserialize response data - if response_type: - if response_type != (file_type,): - encoding = "utf-8" + response_text = None + return_data = None + try: + if response_type == "bytearray": + return_data = response_data.data + elif response_type == "file": + return_data = self.__deserialize_file(response_data) + elif response_type is not None: + match = None content_type = response_data.getheader('content-type') if content_type is not None: - match = re.search(r"charset=([a-zA-Z\-\d]+)[\s\;]?", content_type) - if match: - encoding = match.group(1) - response_data.data = response_data.data.decode(encoding) - - return_data = self.deserialize( - response_data, - response_type, - _check_type - ) - else: - return_data = None + match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type) + encoding = match.group(1) if match else "utf-8" + response_text = response_data.data.decode(encoding) + return_data = self.deserialize(response_text, response_type, content_type) + finally: + if not 200 <= response_data.status <= 299: + raise ApiException.from_response( + http_resp=response_data, + body=response_text, + data=return_data, + ) - if _return_http_data_only: - return (return_data) - else: - return (return_data, response_data.status, - response_data.getheaders()) + return ApiResponse( + status_code = response_data.status, + data = return_data, + headers = response_data.getheaders(), + raw_data = response_data.data + ) - def parameters_to_multipart(self, params, collection_types): - """Get parameters as list of tuples, formatting as json if value is collection_types + def sanitize_for_serialization(self, obj): + """Builds a JSON POST object. - :param params: Parameters as list of two-tuples - :param dict collection_types: Parameter collection types - :return: Parameters as list of tuple or urllib3.fields.RequestField - """ - new_params = [] - if collection_types is None: - collection_types = (dict) - for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 - if isinstance( - v, collection_types): # v is instance of collection_type, formatting as application/json - v = json.dumps(v, ensure_ascii=False).encode("utf-8") - field = RequestField(k, v) - field.make_multipart(content_type="application/json; charset=utf-8") - new_params.append(field) - else: - new_params.append((k, v)) - return new_params - - @classmethod - def sanitize_for_serialization(cls, obj): - """Prepares data for transmission before it is sent with the rest client If obj is None, return None. + If obj is SecretStr, return obj.get_secret_value() If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date convert to string in iso8601 format. + If obj is decimal.Decimal return string representation. If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is OpenAPI model, return the properties dict. - If obj is io.IOBase, return the bytes + :param obj: The data to serialize. :return: The serialized form of data. """ - if isinstance(obj, (ModelNormal, ModelComposed)): - return { - key: cls.sanitize_for_serialization(val) for key, - val in model_to_dict( - obj, - serialize=True).items()} - elif isinstance(obj, io.IOBase): - return cls.get_file_data_and_close_file(obj) - elif isinstance(obj, (str, int, float, none_type, bool)): + if obj is None: + return None + elif isinstance(obj, Enum): + return obj.value + elif isinstance(obj, SecretStr): + return obj.get_secret_value() + elif isinstance(obj, self.PRIMITIVE_TYPES): return obj - elif isinstance(obj, (datetime, date)): + elif isinstance(obj, list): + return [ + self.sanitize_for_serialization(sub_obj) for sub_obj in obj + ] + elif isinstance(obj, tuple): + return tuple( + self.sanitize_for_serialization(sub_obj) for sub_obj in obj + ) + elif isinstance(obj, (datetime.datetime, datetime.date)): return obj.isoformat() - elif isinstance(obj, ModelSimple): - return cls.sanitize_for_serialization(obj.value) - elif isinstance(obj, (list, tuple)): - return [cls.sanitize_for_serialization(item) for item in obj] - if isinstance(obj, dict): - return {key: cls.sanitize_for_serialization(val) for key, val in obj.items()} - raise ApiValueError( - 'Unable to prepare type {} for serialization'.format( - obj.__class__.__name__)) - - def deserialize(self, response, response_type, _check_type): + elif isinstance(obj, decimal.Decimal): + return str(obj) + + elif isinstance(obj, dict): + obj_dict = obj + else: + # Convert model obj to dict except + # attributes `openapi_types`, `attribute_map` + # and attributes which value is not None. + # Convert attribute name to json key in + # model definition for request. + if hasattr(obj, 'to_dict') and callable(getattr(obj, 'to_dict')): + obj_dict = obj.to_dict() + else: + obj_dict = obj.__dict__ + + return { + key: self.sanitize_for_serialization(val) + for key, val in obj_dict.items() + } + + def deserialize(self, response_text: str, response_type: str, content_type: Optional[str]): """Deserializes response into an object. :param response: RESTResponse object to be deserialized. - :param response_type: For the response, a tuple containing: - valid classes - a list containing valid classes (for list schemas) - a dict containing a tuple of valid classes as the value - Example values: - (str,) - (Pet,) - (float, none_type) - ([int, none_type],) - ({str: (bool, str, int, float, date, datetime, str, none_type)},) - :param _check_type: boolean, whether to check the types of the data - received from the server - :type _check_type: bool + :param response_type: class literal for + deserialized object, or string of class name. + :param content_type: content type of response. :return: deserialized object. """ - # handle file downloading - # save response body into a tmp file and return the instance - if response_type == (file_type,): - content_disposition = response.getheader("Content-Disposition") - return deserialize_file(response.data, self.configuration, - content_disposition=content_disposition) # fetch data from response object - try: - received_data = json.loads(response.data) - except ValueError: - received_data = response.data - - # store our data under the key of 'received_data' so users have some - # context if they are deserializing a string and the data type is wrong - deserialized_data = validate_and_convert_types( - received_data, - response_type, - ['received_data'], - True, - _check_type, - configuration=self.configuration - ) - return deserialized_data + if content_type is None: + try: + data = json.loads(response_text) + except ValueError: + data = response_text + elif re.match(r'^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE): + if response_text == "": + data = "" + else: + data = json.loads(response_text) + elif re.match(r'^text\/[a-z.+-]+\s*(;|$)', content_type, re.IGNORECASE): + data = response_text + else: + raise ApiException( + status=0, + reason="Unsupported content type: {0}".format(content_type) + ) - def call_api( - self, - resource_path: str, - method: str, - path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - body: typing.Optional[typing.Any] = None, - post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, - response_type: typing.Optional[typing.Tuple[typing.Any]] = None, - auth_settings: typing.Optional[typing.List[str]] = None, - async_req: typing.Optional[bool] = None, - _return_http_data_only: typing.Optional[bool] = None, - collection_formats: typing.Optional[typing.Dict[str, str]] = None, - _preload_content: bool = True, - _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, - _host: typing.Optional[str] = None, - _check_type: typing.Optional[bool] = None, - _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None - ): - """Makes the HTTP request (synchronous) and returns deserialized data. + return self.__deserialize(data, response_type) - To make an async_req request, set the async_req parameter. + def __deserialize(self, data, klass): + """Deserializes dict, list, str into an object. - :param resource_path: Path to method endpoint. - :param method: Method to call. - :param path_params: Path parameters in the url. - :param query_params: Query parameters in the url. - :param header_params: Header parameters to be - placed in the request header. - :param body: Request body. - :param post_params dict: Request post form parameters, - for `application/x-www-form-urlencoded`, `multipart/form-data`. - :param auth_settings list: Auth Settings names for the request. - :param response_type: For the response, a tuple containing: - valid classes - a list containing valid classes (for list schemas) - a dict containing a tuple of valid classes as the value - Example values: - (str,) - (Pet,) - (float, none_type) - ([int, none_type],) - ({str: (bool, str, int, float, date, datetime, str, none_type)},) - :param files: key -> field name, value -> a list of open file - objects for `multipart/form-data`. - :type files: dict - :param async_req bool: execute request asynchronously - :type async_req: bool, optional - :param _return_http_data_only: response data without head status code - and headers - :type _return_http_data_only: bool, optional - :param collection_formats: dict of collection formats for path, query, - header, and post parameters. - :type collection_formats: dict, optional - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :type _preload_content: bool, optional - :param _request_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 _check_type: boolean describing if the data back from the server - should have its type checked. - :type _check_type: bool, optional - :param _request_auths: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auths: list, optional - :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. + :param data: dict, list or str. + :param klass: class literal, or string of class name. + + :return: object. """ - if not async_req: - return self.__call_api(resource_path, method, - path_params, query_params, header_params, - body, post_params, files, - response_type, auth_settings, - _return_http_data_only, collection_formats, - _preload_content, _request_timeout, _host, - _check_type, _request_auths=_request_auths) - - return self.pool.apply_async(self.__call_api, (resource_path, - method, path_params, - query_params, - header_params, body, - post_params, files, - response_type, - auth_settings, - _return_http_data_only, - collection_formats, - _preload_content, - _request_timeout, - _host, _check_type, None, _request_auths)) - - def request(self, method, url, query_params=None, headers=None, - post_params=None, body=None, _preload_content=True, - _request_timeout=None): - """Makes the HTTP request using RESTClient.""" - if method == "GET": - return self.rest_client.GET(url, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - headers=headers) - elif method == "HEAD": - return self.rest_client.HEAD(url, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - headers=headers) - elif method == "OPTIONS": - return self.rest_client.OPTIONS(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "POST": - return self.rest_client.POST(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "PUT": - return self.rest_client.PUT(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "PATCH": - return self.rest_client.PATCH(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "DELETE": - return self.rest_client.DELETE(url, - query_params=query_params, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) + if data is None: + return None + + if isinstance(klass, str): + if klass.startswith('List['): + m = re.match(r'List\[(.*)]', klass) + assert m is not None, "Malformed List type definition" + sub_kls = m.group(1) + return [self.__deserialize(sub_data, sub_kls) + for sub_data in data] + + if klass.startswith('Dict['): + m = re.match(r'Dict\[([^,]*), (.*)]', klass) + assert m is not None, "Malformed Dict type definition" + sub_kls = m.group(2) + return {k: self.__deserialize(v, sub_kls) + for k, v in data.items()} + + # convert str to class + if klass in self.NATIVE_TYPES_MAPPING: + klass = self.NATIVE_TYPES_MAPPING[klass] + else: + klass = getattr(gooddata_api_client.models, klass) + + if klass in self.PRIMITIVE_TYPES: + return self.__deserialize_primitive(data, klass) + elif klass == object: + return self.__deserialize_object(data) + elif klass == datetime.date: + return self.__deserialize_date(data) + elif klass == datetime.datetime: + return self.__deserialize_datetime(data) + elif klass == decimal.Decimal: + return decimal.Decimal(data) + elif issubclass(klass, Enum): + return self.__deserialize_enum(data, klass) else: - raise ApiValueError( - "http method must be `GET`, `HEAD`, `OPTIONS`," - " `POST`, `PATCH`, `PUT` or `DELETE`." - ) + return self.__deserialize_model(data, klass) def parameters_to_tuples(self, params, collection_formats): """Get parameters as list of tuples, formatting collections. @@ -508,10 +474,10 @@ def parameters_to_tuples(self, params, collection_formats): :param dict collection_formats: Parameter collection formats :return: Parameters as list of tuples, collections formatted """ - new_params = [] + new_params: List[Tuple[str, str]] = [] if collection_formats is None: collection_formats = {} - for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + for k, v in params.items() if isinstance(params, dict) else params: if k in collection_formats: collection_format = collection_formats[k] if collection_format == 'multi': @@ -531,118 +497,178 @@ def parameters_to_tuples(self, params, collection_formats): new_params.append((k, v)) return new_params - @staticmethod - def get_file_data_and_close_file(file_instance: io.IOBase) -> bytes: - file_data = file_instance.read() - file_instance.close() - return file_data + def parameters_to_url_query(self, params, collection_formats): + """Get parameters as list of tuples, formatting collections. + + :param params: Parameters as dict or list of two-tuples + :param dict collection_formats: Parameter collection formats + :return: URL query string (e.g. a=Hello%20World&b=123) + """ + new_params: List[Tuple[str, str]] = [] + if collection_formats is None: + collection_formats = {} + for k, v in params.items() if isinstance(params, dict) else params: + if isinstance(v, bool): + v = str(v).lower() + if isinstance(v, (int, float)): + v = str(v) + if isinstance(v, dict): + v = json.dumps(v) + + if k in collection_formats: + collection_format = collection_formats[k] + if collection_format == 'multi': + new_params.extend((k, quote(str(value))) for value in v) + else: + if collection_format == 'ssv': + delimiter = ' ' + elif collection_format == 'tsv': + delimiter = '\t' + elif collection_format == 'pipes': + delimiter = '|' + else: # csv is the default + delimiter = ',' + new_params.append( + (k, delimiter.join(quote(str(value)) for value in v)) + ) + else: + new_params.append((k, quote(str(v)))) + + return "&".join(["=".join(map(str, item)) for item in new_params]) - def files_parameters(self, - files: typing.Optional[typing.Dict[str, - typing.List[io.IOBase]]] = None): + def files_parameters( + self, + files: Dict[str, Union[str, bytes, List[str], List[bytes], Tuple[str, bytes]]], + ): """Builds form parameters. - :param files: None or a dict with key=param_name and - value is a list of open file objects - :return: List of tuples of form parameters with file data + :param files: File parameters. + :return: Form parameters with files. """ - if files is None: - return [] - params = [] - for param_name, file_instances in files.items(): - if file_instances is None: - # if the file field is nullable, skip None values + for k, v in files.items(): + if isinstance(v, str): + with open(v, 'rb') as f: + filename = os.path.basename(f.name) + filedata = f.read() + elif isinstance(v, bytes): + filename = k + filedata = v + elif isinstance(v, tuple): + filename, filedata = v + elif isinstance(v, list): + for file_param in v: + params.extend(self.files_parameters({k: file_param})) continue - for file_instance in file_instances: - if file_instance is None: - # if the file field is nullable, skip None values - continue - if file_instance.closed is True: - raise ApiValueError( - "Cannot read a closed file. The passed in file_type " - "for %s must be open." % param_name - ) - filename = os.path.basename(file_instance.name) - filedata = self.get_file_data_and_close_file(file_instance) - mimetype = (mimetypes.guess_type(filename)[0] or - 'application/octet-stream') - params.append( - tuple([param_name, tuple([filename, filedata, mimetype])])) - + else: + raise ValueError("Unsupported file value") + mimetype = ( + mimetypes.guess_type(filename)[0] + or 'application/octet-stream' + ) + params.append( + tuple([k, tuple([filename, filedata, mimetype])]) + ) return params - def select_header_accept(self, accepts): + def select_header_accept(self, accepts: List[str]) -> Optional[str]: """Returns `Accept` based on an array of accepts provided. :param accepts: List of headers. :return: Accept (e.g. application/json). """ if not accepts: - return + return None - accepts = [x.lower() for x in accepts] + for accept in accepts: + if re.search('json', accept, re.IGNORECASE): + return accept - if 'application/json' in accepts: - return 'application/json' - else: - return ', '.join(accepts) + return accepts[0] - def select_header_content_type(self, content_types, method=None, body=None): + def select_header_content_type(self, content_types): """Returns `Content-Type` based on an array of content_types provided. :param content_types: List of content-types. - :param method: http method (e.g. POST, PATCH). - :param body: http body to send. :return: Content-Type (e.g. application/json). """ if not content_types: return None - content_types = [x.lower() for x in content_types] + for content_type in content_types: + if re.search('json', content_type, re.IGNORECASE): + return content_type - if (method == 'PATCH' and - 'application/json-patch+json' in content_types and - isinstance(body, list)): - return 'application/json-patch+json' + return content_types[0] - if 'application/json' in content_types or '*/*' in content_types: - return 'application/json' - else: - return content_types[0] - - def update_params_for_auth(self, headers, queries, auth_settings, - resource_path, method, body, request_auths=None): + def update_params_for_auth( + self, + headers, + queries, + auth_settings, + resource_path, + method, + body, + request_auth=None + ) -> None: """Updates header and query params based on authentication setting. :param headers: Header parameters dict to be updated. :param queries: Query parameters tuple list 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(). - :param request_auths: if set, the provided settings will - override the token in the configuration. + :resource_path: A string representation of the HTTP request resource path. + :method: A string representation of the HTTP request method. + :body: A object representing the body of the HTTP request. + The object type is the return value of sanitize_for_serialization(). + :param request_auth: if set, the provided settings will + override the token in the configuration. """ if not auth_settings: return - if request_auths: - for auth_setting in request_auths: - self._apply_auth_params( - headers, queries, resource_path, method, body, auth_setting) - return + if request_auth: + self._apply_auth_params( + headers, + queries, + resource_path, + method, + body, + request_auth + ) + else: + for auth in auth_settings: + auth_setting = self.configuration.auth_settings().get(auth) + if auth_setting: + self._apply_auth_params( + headers, + queries, + resource_path, + method, + body, + auth_setting + ) - for auth in auth_settings: - auth_setting = self.configuration.auth_settings().get(auth) - if auth_setting: - self._apply_auth_params( - headers, queries, resource_path, method, body, auth_setting) + def _apply_auth_params( + self, + headers, + queries, + resource_path, + method, + body, + auth_setting + ) -> None: + """Updates the request parameters based on a single auth_setting - def _apply_auth_params(self, headers, queries, resource_path, method, body, auth_setting): + :param headers: Header parameters dict to be updated. + :param queries: Query parameters tuple list to be updated. + :resource_path: A string representation of the HTTP request resource path. + :method: A string representation of the HTTP request method. + :body: A object representing the body of the HTTP request. + The object type is the return value of sanitize_for_serialization(). + :param auth_setting: auth settings for the endpoint + """ if auth_setting['in'] == 'cookie': - headers['Cookie'] = auth_setting['key'] + "=" + auth_setting['value'] + headers['Cookie'] = auth_setting['value'] elif auth_setting['in'] == 'header': if auth_setting['type'] != 'http-signature': headers[auth_setting['key']] = auth_setting['value'] @@ -653,245 +679,120 @@ def _apply_auth_params(self, headers, queries, resource_path, method, body, auth 'Authentication token must be in `query` or `header`' ) + def __deserialize_file(self, response): + """Deserializes body to file -class Endpoint(object): - def __init__(self, settings=None, params_map=None, root_map=None, - headers_map=None, api_client=None, callable=None): - """Creates an endpoint - - Args: - settings (dict): see below key value pairs - 'response_type' (tuple/None): response type - 'auth' (list): a list of auth type keys - 'endpoint_path' (str): the endpoint path - 'operation_id' (str): endpoint string identifier - 'http_method' (str): POST/PUT/PATCH/GET etc - 'servers' (list): list of str servers that this endpoint is at - params_map (dict): see below key value pairs - 'all' (list): list of str endpoint parameter names - 'required' (list): list of required parameter names - 'nullable' (list): list of nullable parameter names - 'enum' (list): list of parameters with enum values - 'validation' (list): list of parameters with validations - root_map - 'validations' (dict): the dict mapping endpoint parameter tuple - paths to their validation dictionaries - 'allowed_values' (dict): the dict mapping endpoint parameter - tuple paths to their allowed_values (enum) dictionaries - 'openapi_types' (dict): param_name to openapi type - 'attribute_map' (dict): param_name to camelCase name - 'location_map' (dict): param_name to 'body', 'file', 'form', - 'header', 'path', 'query' - collection_format_map (dict): param_name to `csv` etc. - headers_map (dict): see below key value pairs - 'accept' (list): list of Accept header strings - 'content_type' (list): list of Content-Type header strings - api_client (ApiClient) api client instance - callable (function): the function which is invoked when the - Endpoint is called - """ - self.settings = settings - self.params_map = params_map - self.params_map['all'].extend([ - 'async_req', - '_host_index', - '_preload_content', - '_request_timeout', - '_return_http_data_only', - '_check_input_type', - '_check_return_type', - '_content_type', - '_spec_property_naming', - '_request_auths' - ]) - self.params_map['nullable'].extend(['_request_timeout']) - self.validations = root_map['validations'] - self.allowed_values = root_map['allowed_values'] - self.openapi_types = root_map['openapi_types'] - extra_types = { - 'async_req': (bool,), - '_host_index': (none_type, int), - '_preload_content': (bool,), - '_request_timeout': (none_type, float, (float,), [float], int, (int,), [int]), - '_return_http_data_only': (bool,), - '_check_input_type': (bool,), - '_check_return_type': (bool,), - '_spec_property_naming': (bool,), - '_content_type': (none_type, str), - '_request_auths': (none_type, list) - } - self.openapi_types.update(extra_types) - self.attribute_map = root_map['attribute_map'] - self.location_map = root_map['location_map'] - self.collection_format_map = root_map['collection_format_map'] - self.headers_map = headers_map - self.api_client = api_client - self.callable = callable - - def __validate_inputs(self, kwargs): - for param in self.params_map['enum']: - if param in kwargs: - check_allowed_values( - self.allowed_values, - (param,), - kwargs[param] - ) - - for param in self.params_map['validation']: - if param in kwargs: - check_validations( - self.validations, - (param,), - kwargs[param], - configuration=self.api_client.configuration - ) + Saves response body into a file in a temporary folder, + using the filename from the `Content-Disposition` header if provided. - if kwargs['_check_input_type'] is False: - return + handle file downloading + save response body into a tmp file and return the instance - for key, value in kwargs.items(): - fixed_val = validate_and_convert_types( - value, - self.openapi_types[key], - [key], - kwargs['_spec_property_naming'], - kwargs['_check_input_type'], - configuration=self.api_client.configuration + :param response: RESTResponse. + :return: file path. + """ + fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path) + os.close(fd) + os.remove(path) + + content_disposition = response.getheader("Content-Disposition") + if content_disposition: + m = re.search( + r'filename=[\'"]?([^\'"\s]+)[\'"]?', + content_disposition ) - kwargs[key] = fixed_val - - def __gather_params(self, kwargs): - params = { - 'body': None, - 'collection_format': {}, - 'file': {}, - 'form': [], - 'header': {}, - 'path': {}, - 'query': [] - } + assert m is not None, "Unexpected 'content-disposition' header value" + filename = m.group(1) + path = os.path.join(os.path.dirname(path), filename) - for param_name, param_value in kwargs.items(): - param_location = self.location_map.get(param_name) - if param_location is None: - continue - if param_location: - if param_location == 'body': - params['body'] = param_value - continue - base_name = self.attribute_map[param_name] - if (param_location == 'form' and - self.openapi_types[param_name] == (file_type,)): - params['file'][base_name] = [param_value] - elif (param_location == 'form' and - self.openapi_types[param_name] == ([file_type],)): - # param_value is already a list - params['file'][base_name] = param_value - elif param_location in {'form', 'query'}: - param_value_full = (base_name, param_value) - params[param_location].append(param_value_full) - if param_location not in {'form', 'query'}: - params[param_location][base_name] = param_value - collection_format = self.collection_format_map.get(param_name) - if collection_format: - params['collection_format'][base_name] = collection_format + with open(path, "wb") as f: + f.write(response.data) - return params + return path - def __call__(self, *args, **kwargs): - """ This method is invoked when endpoints are called - Example: + def __deserialize_primitive(self, data, klass): + """Deserializes string to primitive type. - api_instance = AIApi() - api_instance.metadata_sync # this is an instance of the class Endpoint - api_instance.metadata_sync() # this invokes api_instance.metadata_sync.__call__() - which then invokes the callable functions stored in that endpoint at - api_instance.metadata_sync.callable or self.callable in this class + :param data: str. + :param klass: class literal. + :return: int, long, float, str, bool. """ - return self.callable(self, *args, **kwargs) + try: + return klass(data) + except UnicodeEncodeError: + return str(data) + except TypeError: + return data - def call_with_http_info(self, **kwargs): + def __deserialize_object(self, value): + """Return an original value. + :return: object. + """ + return value + + def __deserialize_date(self, string): + """Deserializes string to date. + + :param string: str. + :return: date. + """ try: - index = self.api_client.configuration.server_operation_index.get( - self.settings['operation_id'], self.api_client.configuration.server_index - ) if kwargs['_host_index'] is None else kwargs['_host_index'] - server_variables = self.api_client.configuration.server_operation_variables.get( - self.settings['operation_id'], self.api_client.configuration.server_variables - ) - _host = self.api_client.configuration.get_host_from_settings( - index, variables=server_variables, servers=self.settings['servers'] + return parse(string).date() + except ImportError: + return string + except ValueError: + raise rest.ApiException( + status=0, + reason="Failed to parse `{0}` as date object".format(string) ) - except IndexError: - if self.settings['servers']: - raise ApiValueError( - "Invalid host index. Must be 0 <= index < %s" % - len(self.settings['servers']) - ) - _host = None - - for key, value in kwargs.items(): - if key not in self.params_map['all']: - raise ApiTypeError( - "Got an unexpected parameter '%s'" - " to method `%s`" % - (key, self.settings['operation_id']) - ) - # only throw this nullable ApiValueError if _check_input_type - # is False, if _check_input_type==True we catch this case - # in self.__validate_inputs - if (key not in self.params_map['nullable'] and value is None - and kwargs['_check_input_type'] is False): - raise ApiValueError( - "Value may not be None for non-nullable parameter `%s`" - " when calling `%s`" % - (key, self.settings['operation_id']) - ) - for key in self.params_map['required']: - if key not in kwargs.keys(): - raise ApiValueError( - "Missing the required parameter `%s` when calling " - "`%s`" % (key, self.settings['operation_id']) + def __deserialize_datetime(self, string): + """Deserializes string to datetime. + + The string should be in iso8601 datetime format. + + :param string: str. + :return: datetime. + """ + try: + return parse(string) + except ImportError: + return string + except ValueError: + raise rest.ApiException( + status=0, + reason=( + "Failed to parse `{0}` as datetime object" + .format(string) ) + ) - self.__validate_inputs(kwargs) + def __deserialize_enum(self, data, klass): + """Deserializes primitive type to enum. - params = self.__gather_params(kwargs) + :param data: primitive type. + :param klass: class literal. + :return: enum value. + """ + try: + return klass(data) + except ValueError: + raise rest.ApiException( + status=0, + reason=( + "Failed to parse `{0}` as `{1}`" + .format(data, klass) + ) + ) - accept_headers_list = self.headers_map['accept'] - if accept_headers_list: - params['header']['Accept'] = self.api_client.select_header_accept( - accept_headers_list) + def __deserialize_model(self, data, klass): + """Deserializes list or dict to model. - if kwargs.get('_content_type'): - params['header']['Content-Type'] = kwargs['_content_type'] - else: - content_type_headers_list = self.headers_map['content_type'] - if content_type_headers_list: - if params['body'] != "": - content_types_list = self.api_client.select_header_content_type( - content_type_headers_list, self.settings['http_method'], - params['body']) - if content_types_list: - params['header']['Content-Type'] = content_types_list - - return self.api_client.call_api( - self.settings['endpoint_path'], self.settings['http_method'], - params['path'], - params['query'], - params['header'], - body=params['body'], - post_params=params['form'], - files=params['file'], - response_type=self.settings['response_type'], - auth_settings=self.settings['auth'], - async_req=kwargs['async_req'], - _check_type=kwargs['_check_return_type'], - _return_http_data_only=kwargs['_return_http_data_only'], - _preload_content=kwargs['_preload_content'], - _request_timeout=kwargs['_request_timeout'], - _host=_host, - _request_auths=kwargs['_request_auths'], - collection_formats=params['collection_format']) + :param data: dict, list. + :param klass: class literal. + :return: model object. + """ + + return klass.from_dict(data) diff --git a/gooddata-api-client/gooddata_api_client/api_response.py b/gooddata-api-client/gooddata_api_client/api_response.py new file mode 100644 index 000000000..9bc7c11f6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api_response.py @@ -0,0 +1,21 @@ +"""API response object.""" + +from __future__ import annotations +from typing import Optional, Generic, Mapping, TypeVar +from pydantic import Field, StrictInt, StrictBytes, BaseModel + +T = TypeVar("T") + +class ApiResponse(BaseModel, Generic[T]): + """ + API response object + """ + + status_code: StrictInt = Field(description="HTTP status code") + headers: Optional[Mapping[str, str]] = Field(None, description="HTTP headers") + data: T = Field(description="Deserialized data given the data type") + raw_data: StrictBytes = Field(description="Raw data (HTTP response body)") + + model_config = { + "arbitrary_types_allowed": True + } diff --git a/gooddata-api-client/gooddata_api_client/apis/__init__.py b/gooddata-api-client/gooddata_api_client/apis/__init__.py deleted file mode 100644 index 2dc15f243..000000000 --- a/gooddata-api-client/gooddata_api_client/apis/__init__.py +++ /dev/null @@ -1,88 +0,0 @@ - -# flake8: noqa - -# Import all APIs into this package. -# If you have many APIs here with many many models used in each API this may -# raise a `RecursionError`. -# In order to avoid this, import only the API that you directly need like: -# -# from gooddata_api_client.api.ai_api import AIApi -# -# or import this package, but before doing it, use: -# -# import sys -# sys.setrecursionlimit(n) - -# Import APIs into API package: -from gooddata_api_client.api.ai_api import AIApi -from gooddata_api_client.api.api_tokens_api import APITokensApi -from gooddata_api_client.api.analytics_model_api import AnalyticsModelApi -from gooddata_api_client.api.appearance_api import AppearanceApi -from gooddata_api_client.api.attribute_hierarchies_api import AttributeHierarchiesApi -from gooddata_api_client.api.attributes_api import AttributesApi -from gooddata_api_client.api.automations_api import AutomationsApi -from gooddata_api_client.api.available_drivers_api import AvailableDriversApi -from gooddata_api_client.api.csp_directives_api import CSPDirectivesApi -from gooddata_api_client.api.computation_api import ComputationApi -from gooddata_api_client.api.context_filters_api import ContextFiltersApi -from gooddata_api_client.api.cookie_security_configuration_api import CookieSecurityConfigurationApi -from gooddata_api_client.api.dashboards_api import DashboardsApi -from gooddata_api_client.api.data_filters_api import DataFiltersApi -from gooddata_api_client.api.data_source_declarative_apis_api import DataSourceDeclarativeAPIsApi -from gooddata_api_client.api.data_source_entity_apis_api import DataSourceEntityAPIsApi -from gooddata_api_client.api.datasets_api import DatasetsApi -from gooddata_api_client.api.dependency_graph_api import DependencyGraphApi -from gooddata_api_client.api.entitlement_api import EntitlementApi -from gooddata_api_client.api.export_definitions_api import ExportDefinitionsApi -from gooddata_api_client.api.export_templates_api import ExportTemplatesApi -from gooddata_api_client.api.facts_api import FactsApi -from gooddata_api_client.api.filter_views_api import FilterViewsApi -from gooddata_api_client.api.generate_logical_data_model_api import GenerateLogicalDataModelApi -from gooddata_api_client.api.hierarchy_api import HierarchyApi -from gooddata_api_client.api.identity_providers_api import IdentityProvidersApi -from gooddata_api_client.api.image_export_api import ImageExportApi -from gooddata_api_client.api.invalidate_cache_api import InvalidateCacheApi -from gooddata_api_client.api.jwks_api import JWKSApi -from gooddata_api_client.api.ldm_declarative_apis_api import LDMDeclarativeAPIsApi -from gooddata_api_client.api.llm_endpoints_api import LLMEndpointsApi -from gooddata_api_client.api.labels_api import LabelsApi -from gooddata_api_client.api.manage_permissions_api import ManagePermissionsApi -from gooddata_api_client.api.metadata_sync_api import MetadataSyncApi -from gooddata_api_client.api.metrics_api import MetricsApi -from gooddata_api_client.api.notification_channels_api import NotificationChannelsApi -from gooddata_api_client.api.options_api import OptionsApi -from gooddata_api_client.api.organization_api import OrganizationApi -from gooddata_api_client.api.organization_declarative_apis_api import OrganizationDeclarativeAPIsApi -from gooddata_api_client.api.organization_entity_apis_api import OrganizationEntityAPIsApi -from gooddata_api_client.api.permissions_api import PermissionsApi -from gooddata_api_client.api.plugins_api import PluginsApi -from gooddata_api_client.api.raw_export_api import RawExportApi -from gooddata_api_client.api.reporting_settings_api import ReportingSettingsApi -from gooddata_api_client.api.scanning_api import ScanningApi -from gooddata_api_client.api.slides_export_api import SlidesExportApi -from gooddata_api_client.api.smart_functions_api import SmartFunctionsApi -from gooddata_api_client.api.tabular_export_api import TabularExportApi -from gooddata_api_client.api.test_connection_api import TestConnectionApi -from gooddata_api_client.api.translations_api import TranslationsApi -from gooddata_api_client.api.usage_api import UsageApi -from gooddata_api_client.api.user_groups_declarative_apis_api import UserGroupsDeclarativeAPIsApi -from gooddata_api_client.api.user_groups_entity_apis_api import UserGroupsEntityAPIsApi -from gooddata_api_client.api.user_data_filters_api import UserDataFiltersApi -from gooddata_api_client.api.user_identifiers_api import UserIdentifiersApi -from gooddata_api_client.api.user_settings_api import UserSettingsApi -from gooddata_api_client.api.user_management_api import UserManagementApi -from gooddata_api_client.api.users_declarative_apis_api import UsersDeclarativeAPIsApi -from gooddata_api_client.api.users_entity_apis_api import UsersEntityAPIsApi -from gooddata_api_client.api.visual_export_api import VisualExportApi -from gooddata_api_client.api.visualization_object_api import VisualizationObjectApi -from gooddata_api_client.api.workspaces_declarative_apis_api import WorkspacesDeclarativeAPIsApi -from gooddata_api_client.api.workspaces_entity_apis_api import WorkspacesEntityAPIsApi -from gooddata_api_client.api.workspaces_settings_api import WorkspacesSettingsApi -from gooddata_api_client.api.actions_api import ActionsApi -from gooddata_api_client.api.automation_organization_view_controller_api import AutomationOrganizationViewControllerApi -from gooddata_api_client.api.entities_api import EntitiesApi -from gooddata_api_client.api.layout_api import LayoutApi -from gooddata_api_client.api.organization_controller_api import OrganizationControllerApi -from gooddata_api_client.api.organization_model_controller_api import OrganizationModelControllerApi -from gooddata_api_client.api.user_model_controller_api import UserModelControllerApi -from gooddata_api_client.api.workspace_object_controller_api import WorkspaceObjectControllerApi diff --git a/gooddata-api-client/gooddata_api_client/configuration.py b/gooddata-api-client/gooddata_api_client/configuration.py index 21b52c08a..0c63760b2 100644 --- a/gooddata-api-client/gooddata_api_client/configuration.py +++ b/gooddata-api-client/gooddata_api_client/configuration.py @@ -1,22 +1,28 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 import copy +import http.client as httplib import logging +from logging import FileHandler import multiprocessing import sys -import urllib3 +from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict +from typing_extensions import NotRequired, Self -from http import client as http_client -from gooddata_api_client.exceptions import ApiValueError +import urllib3 JSON_SCHEMA_VALIDATION_KEYWORDS = { @@ -25,46 +31,123 @@ 'minLength', 'pattern', 'maxItems', 'minItems' } -class Configuration(object): - """NOTE: This class is auto generated by OpenAPI Generator - - Ref: https://openapi-generator.tech - Do not edit the class manually. - - :param host: Base url +ServerVariablesT = Dict[str, str] + +GenericAuthSetting = TypedDict( + "GenericAuthSetting", + { + "type": str, + "in": str, + "key": str, + "value": str, + }, +) + + +OAuth2AuthSetting = TypedDict( + "OAuth2AuthSetting", + { + "type": Literal["oauth2"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +APIKeyAuthSetting = TypedDict( + "APIKeyAuthSetting", + { + "type": Literal["api_key"], + "in": str, + "key": str, + "value": Optional[str], + }, +) + + +BasicAuthSetting = TypedDict( + "BasicAuthSetting", + { + "type": Literal["basic"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": Optional[str], + }, +) + + +BearerFormatAuthSetting = TypedDict( + "BearerFormatAuthSetting", + { + "type": Literal["bearer"], + "in": Literal["header"], + "format": Literal["JWT"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +BearerAuthSetting = TypedDict( + "BearerAuthSetting", + { + "type": Literal["bearer"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +HTTPSignatureAuthSetting = TypedDict( + "HTTPSignatureAuthSetting", + { + "type": Literal["http-signature"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": None, + }, +) + + +AuthSettings = TypedDict( + "AuthSettings", + { + }, + total=False, +) + + +class HostSettingVariable(TypedDict): + description: str + default_value: str + enum_values: List[str] + + +class HostSetting(TypedDict): + url: str + description: str + variables: NotRequired[Dict[str, HostSettingVariable]] + + +class Configuration: + """This class contains various settings of the API client. + + :param host: Base url. + :param ignore_operation_servers + Boolean to ignore operation servers for the API client. + Config will use `host` as the base url regardless of the operation servers. :param api_key: Dict to store API key(s). Each entry in the dict specifies an API key. The dict key is the name of the security scheme in the OAS specification. The dict value is the API key secret. - :param api_key_prefix: Dict to store API prefix (e.g. Bearer) + :param api_key_prefix: Dict to store API prefix (e.g. Bearer). The dict key is the name of the security scheme in the OAS specification. The dict value is an API key prefix when generating the auth data. - :param username: Username for HTTP basic authentication - :param password: Password for HTTP basic authentication - :param discard_unknown_keys: Boolean value indicating whether to discard - unknown properties. A server may send a response that includes additional - properties that are not known by the client in the following scenarios: - 1. The OpenAPI document is incomplete, i.e. it does not match the server - implementation. - 2. The client was generated using an older version of the OpenAPI document - and the server has been upgraded since then. - If a schema in the OpenAPI document defines the additionalProperties attribute, - then all undeclared properties received by the server are injected into the - additional properties map. In that case, there are undeclared properties, and - nothing to discard. - :param disabled_client_side_validations (string): Comma-separated list of - JSON schema validation keywords to disable JSON schema structural validation - rules. The following keywords may be specified: multipleOf, maximum, - exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, - maxItems, minItems. - By default, the validation is performed for data generated locally by the client - and data received from the server, independent of any validation performed by - the server side. If the input data does not satisfy the JSON schema validation - rules specified in the OpenAPI document, an exception is raised. - If disabled_client_side_validations is set, structural validation is - disabled. This can be useful to troubleshoot data validation problem, such as - when the OpenAPI document validation rules do not match the actual API data - received by the server. + :param username: Username for HTTP basic authentication. + :param password: Password for HTTP basic authentication. + :param access_token: Access token. :param server_index: Index to servers configuration. :param server_variables: Mapping with string values to replace variables in templated server configuration. The validation of enums is performed for @@ -73,24 +156,34 @@ class Configuration(object): configuration. :param server_operation_variables: Mapping from operation ID to a mapping with string values to replace variables in templated server configuration. - The validation of enums is performed for variables with defined enum values before. + The validation of enums is performed for variables with defined enum + values before. :param ssl_ca_cert: str - the path to a file of concatenated CA certificates - in PEM format + in PEM format. + :param retries: Number of retries for API requests. """ - _default = None - - def __init__(self, host=None, - api_key=None, api_key_prefix=None, - access_token=None, - username=None, password=None, - discard_unknown_keys=False, - disabled_client_side_validations="", - server_index=None, server_variables=None, - server_operation_index=None, server_operation_variables=None, - ssl_ca_cert=None, - ): + _default: ClassVar[Optional[Self]] = None + + def __init__( + self, + host: Optional[str]=None, + api_key: Optional[Dict[str, str]]=None, + api_key_prefix: Optional[Dict[str, str]]=None, + username: Optional[str]=None, + password: Optional[str]=None, + access_token: Optional[str]=None, + server_index: Optional[int]=None, + server_variables: Optional[ServerVariablesT]=None, + server_operation_index: Optional[Dict[int, int]]=None, + server_operation_variables: Optional[Dict[int, ServerVariablesT]]=None, + ignore_operation_servers: bool=False, + ssl_ca_cert: Optional[str]=None, + retries: Optional[int] = None, + *, + debug: Optional[bool] = None, + ) -> None: """Constructor """ self._base_path = "http://localhost" if host is None else host @@ -104,11 +197,13 @@ def __init__(self, host=None, self.server_operation_variables = server_operation_variables or {} """Default server variables """ + self.ignore_operation_servers = ignore_operation_servers + """Ignore operation servers + """ self.temp_folder_path = None """Temp file folder for downloading files """ # Authentication Settings - self.access_token = access_token self.api_key = {} if api_key: self.api_key = api_key @@ -128,8 +223,9 @@ def __init__(self, host=None, self.password = password """Password for HTTP basic authentication """ - self.discard_unknown_keys = discard_unknown_keys - self.disabled_client_side_validations = disabled_client_side_validations + self.access_token = access_token + """Access token + """ self.logger = {} """Logging Settings """ @@ -141,13 +237,16 @@ def __init__(self, host=None, self.logger_stream_handler = None """Log stream handler """ - self.logger_file_handler = None + self.logger_file_handler: Optional[FileHandler] = None """Log file handler """ self.logger_file = None """Debug file location """ - self.debug = False + if debug is not None: + self.debug = debug + else: + self.__debug = False """Debug switch """ @@ -168,6 +267,10 @@ def __init__(self, host=None, self.assert_hostname = None """Set this to True/False to enable/disable SSL hostname verification. """ + self.tls_server_name = None + """SSL/TLS Server Name Indication (SNI) + Set this to the SNI value expected by the server. + """ self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 """urllib3 connection pool's maximum number of connections saved @@ -177,28 +280,34 @@ def __init__(self, host=None, cpu_count * 5 is used as default value to increase performance. """ - self.proxy = None + self.proxy: Optional[str] = None """Proxy URL """ - self.no_proxy = None - """bypass proxy for host in the no_proxy list. - """ self.proxy_headers = None """Proxy headers """ self.safe_chars_for_path_param = '' """Safe chars for path_param """ - self.retries = None + self.retries = retries """Adding retries to override urllib3 default value 3 """ # Enable client side validation self.client_side_validation = True - # Options to pass down to the underlying urllib3 socket self.socket_options = None + """Options to pass down to the underlying urllib3 socket + """ + + self.datetime_format = "%Y-%m-%dT%H:%M:%S.%f%z" + """datetime format + """ + + self.date_format = "%Y-%m-%d" + """date format + """ - def __deepcopy__(self, memo): + def __deepcopy__(self, memo: Dict[int, Any]) -> Self: cls = self.__class__ result = cls.__new__(cls) memo[id(self)] = result @@ -212,18 +321,11 @@ def __deepcopy__(self, memo): result.debug = self.debug return result - def __setattr__(self, name, value): + def __setattr__(self, name: str, value: Any) -> None: object.__setattr__(self, name, value) - if name == 'disabled_client_side_validations': - s = set(filter(None, value.split(','))) - for v in s: - if v not in JSON_SCHEMA_VALIDATION_KEYWORDS: - raise ApiValueError( - "Invalid keyword: '{0}''".format(v)) - self._disabled_client_side_validations = s @classmethod - def set_default(cls, default): + def set_default(cls, default: Optional[Self]) -> None: """Set default instance of configuration. It stores default configuration, which can be @@ -231,24 +333,34 @@ def set_default(cls, default): :param default: object of Configuration """ - cls._default = copy.deepcopy(default) + cls._default = default + + @classmethod + def get_default_copy(cls) -> Self: + """Deprecated. Please use `get_default` instead. + + Deprecated. Please use `get_default` instead. + + :return: The configuration object. + """ + return cls.get_default() @classmethod - def get_default_copy(cls): - """Return new instance of configuration. + def get_default(cls) -> Self: + """Return the default configuration. This method returns newly created, based on default constructor, object of Configuration class or returns a copy of default - configuration passed by the set_default method. + configuration. :return: The configuration object. """ - if cls._default is not None: - return copy.deepcopy(cls._default) - return Configuration() + if cls._default is None: + cls._default = cls() + return cls._default @property - def logger_file(self): + def logger_file(self) -> Optional[str]: """The logger file. If the logger_file is None, then add stream handler and remove file @@ -260,7 +372,7 @@ def logger_file(self): return self.__logger_file @logger_file.setter - def logger_file(self, value): + def logger_file(self, value: Optional[str]) -> None: """The logger file. If the logger_file is None, then add stream handler and remove file @@ -279,7 +391,7 @@ def logger_file(self, value): logger.addHandler(self.logger_file_handler) @property - def debug(self): + def debug(self) -> bool: """Debug status :param value: The debug status, True or False. @@ -288,7 +400,7 @@ def debug(self): return self.__debug @debug.setter - def debug(self, value): + def debug(self, value: bool) -> None: """Debug status :param value: The debug status, True or False. @@ -299,18 +411,18 @@ def debug(self, value): # if debug status is True, turn on debug logging for _, logger in self.logger.items(): logger.setLevel(logging.DEBUG) - # turn on http_client debug - http_client.HTTPConnection.debuglevel = 1 + # turn on httplib debug + httplib.HTTPConnection.debuglevel = 1 else: # if debug status is False, turn off debug logging, # setting log level to default `logging.WARNING` for _, logger in self.logger.items(): logger.setLevel(logging.WARNING) - # turn off http_client debug - http_client.HTTPConnection.debuglevel = 0 + # turn off httplib debug + httplib.HTTPConnection.debuglevel = 0 @property - def logger_format(self): + def logger_format(self) -> str: """The logger format. The logger_formatter will be updated when sets logger_format. @@ -321,7 +433,7 @@ def logger_format(self): return self.__logger_format @logger_format.setter - def logger_format(self, value): + def logger_format(self, value: str) -> None: """The logger format. The logger_formatter will be updated when sets logger_format. @@ -332,7 +444,7 @@ def logger_format(self, value): self.__logger_format = value self.logger_formatter = logging.Formatter(self.__logger_format) - def get_api_key_with_prefix(self, identifier, alias=None): + def get_api_key_with_prefix(self, identifier: str, alias: Optional[str]=None) -> Optional[str]: """Gets API key (with prefix if set). :param identifier: The identifier of apiKey. @@ -349,7 +461,9 @@ def get_api_key_with_prefix(self, identifier, alias=None): else: return key - def get_basic_auth_token(self): + return None + + def get_basic_auth_token(self) -> Optional[str]: """Gets HTTP basic authentication header (string). :return: The token for basic HTTP authentication. @@ -364,15 +478,15 @@ def get_basic_auth_token(self): basic_auth=username + ':' + password ).get('authorization') - def auth_settings(self): + def auth_settings(self)-> AuthSettings: """Gets Auth Settings dict for api client. :return: The Auth Settings information dict. """ - auth = {} + auth: AuthSettings = {} return auth - def to_debug_report(self): + def to_debug_report(self) -> str: """Gets the essential information for debugging. :return: The report for debugging. @@ -384,7 +498,7 @@ def to_debug_report(self): "SDK Package Version: 1.51.0".\ format(env=sys.platform, pyversion=sys.version) - def get_host_settings(self): + def get_host_settings(self) -> List[HostSetting]: """Gets an array of host settings :return: An array of host settings @@ -396,7 +510,12 @@ def get_host_settings(self): } ] - def get_host_from_settings(self, index, variables=None, servers=None): + def get_host_from_settings( + self, + index: Optional[int], + variables: Optional[ServerVariablesT]=None, + servers: Optional[List[HostSetting]]=None, + ) -> str: """Gets host URL based on the index and variables :param index: array index of the host settings :param variables: hash of variable and the corresponding value @@ -436,20 +555,12 @@ def get_host_from_settings(self, index, variables=None, servers=None): return url @property - def host(self): + def host(self) -> str: """Return generated host.""" return self.get_host_from_settings(self.server_index, variables=self.server_variables) @host.setter - def host(self, value): + def host(self, value: str) -> None: """Fix base path.""" self._base_path = value self.server_index = None - - -class ConversionConfiguration: - _CONFIG: Configuration = Configuration() - - @classmethod - def get_configuration(cls): - return cls._CONFIG diff --git a/gooddata-api-client/gooddata_api_client/exceptions.py b/gooddata-api-client/gooddata_api_client/exceptions.py index cfdbb9044..af387dffb 100644 --- a/gooddata-api-client/gooddata_api_client/exceptions.py +++ b/gooddata-api-client/gooddata_api_client/exceptions.py @@ -1,13 +1,19 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 +from typing import Any, Optional +from typing_extensions import Self class OpenApiException(Exception): """The base exception class for all OpenAPIExceptions""" @@ -15,7 +21,7 @@ class OpenApiException(Exception): class ApiTypeError(OpenApiException, TypeError): def __init__(self, msg, path_to_item=None, valid_classes=None, - key_type=None): + key_type=None) -> None: """ Raises an exception for TypeErrors Args: @@ -43,7 +49,7 @@ def __init__(self, msg, path_to_item=None, valid_classes=None, class ApiValueError(OpenApiException, ValueError): - def __init__(self, msg, path_to_item=None): + def __init__(self, msg, path_to_item=None) -> None: """ Args: msg (str): the exception message @@ -61,7 +67,7 @@ def __init__(self, msg, path_to_item=None): class ApiAttributeError(OpenApiException, AttributeError): - def __init__(self, msg, path_to_item=None): + def __init__(self, msg, path_to_item=None) -> None: """ Raised when an attribute reference or assignment fails. @@ -80,7 +86,7 @@ def __init__(self, msg, path_to_item=None): class ApiKeyError(OpenApiException, KeyError): - def __init__(self, msg, path_to_item=None): + def __init__(self, msg, path_to_item=None) -> None: """ Args: msg (str): the exception message @@ -98,54 +104,106 @@ def __init__(self, msg, path_to_item=None): class ApiException(OpenApiException): - def __init__(self, status=None, reason=None, http_resp=None): + def __init__( + self, + status=None, + reason=None, + http_resp=None, + *, + body: Optional[str] = None, + data: Optional[Any] = None, + ) -> None: + self.status = status + self.reason = reason + self.body = body + self.data = data + self.headers = None + if http_resp: - self.status = http_resp.status - self.reason = http_resp.reason - self.body = http_resp.data + if self.status is None: + self.status = http_resp.status + if self.reason is None: + self.reason = http_resp.reason + if self.body is None: + try: + self.body = http_resp.data.decode('utf-8') + except Exception: + pass self.headers = http_resp.getheaders() - else: - self.status = status - self.reason = reason - self.body = None - self.headers = None + + @classmethod + def from_response( + cls, + *, + http_resp, + body: Optional[str], + data: Optional[Any], + ) -> Self: + if http_resp.status == 400: + raise BadRequestException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 401: + raise UnauthorizedException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 403: + raise ForbiddenException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 404: + raise NotFoundException(http_resp=http_resp, body=body, data=data) + + # Added new conditions for 409 and 422 + if http_resp.status == 409: + raise ConflictException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 422: + raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data) + + if 500 <= http_resp.status <= 599: + raise ServiceException(http_resp=http_resp, body=body, data=data) + raise ApiException(http_resp=http_resp, body=body, data=data) def __str__(self): """Custom error messages for exception""" - error_message = "Status Code: {0}\n"\ + error_message = "({0})\n"\ "Reason: {1}\n".format(self.status, self.reason) if self.headers: error_message += "HTTP response headers: {0}\n".format( self.headers) - if self.body: - error_message += "HTTP response body: {0}\n".format(self.body) + if self.data or self.body: + error_message += "HTTP response body: {0}\n".format(self.data or self.body) return error_message -class NotFoundException(ApiException): +class BadRequestException(ApiException): + pass - def __init__(self, status=None, reason=None, http_resp=None): - super(NotFoundException, self).__init__(status, reason, http_resp) +class NotFoundException(ApiException): + pass -class UnauthorizedException(ApiException): - def __init__(self, status=None, reason=None, http_resp=None): - super(UnauthorizedException, self).__init__(status, reason, http_resp) +class UnauthorizedException(ApiException): + pass class ForbiddenException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None): - super(ForbiddenException, self).__init__(status, reason, http_resp) + pass class ServiceException(ApiException): + pass + + +class ConflictException(ApiException): + """Exception for HTTP 409 Conflict.""" + pass + - def __init__(self, status=None, reason=None, http_resp=None): - super(ServiceException, self).__init__(status, reason, http_resp) +class UnprocessableEntityException(ApiException): + """Exception for HTTP 422 Unprocessable Entity.""" + pass def render_path(path_to_item): diff --git a/gooddata-api-client/gooddata_api_client/model/__init__.py b/gooddata-api-client/gooddata_api_client/model/__init__.py deleted file mode 100644 index d88284126..000000000 --- a/gooddata-api-client/gooddata_api_client/model/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -# we can not import model classes here because that would create a circular -# reference which would not work in python2 -# do not import all models into this module because that uses a lot of memory and stack frames -# if you need the ability to import all models from one package, import them with -# from gooddata_api_client.models import ModelA, ModelB diff --git a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter.py b/gooddata-api-client/gooddata_api_client/model/absolute_date_filter.py deleted file mode 100644 index d676501e0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter - globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter - - -class AbsoluteDateFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, absolute_date_filter, *args, **kwargs): # noqa: E501 - """AbsoluteDateFilter - a model defined in OpenAPI - - Args: - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.absolute_date_filter = absolute_date_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, absolute_date_filter, *args, **kwargs): # noqa: E501 - """AbsoluteDateFilter - a model defined in OpenAPI - - Args: - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.absolute_date_filter = absolute_date_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter.pyi b/gooddata-api-client/gooddata_api_client/model/absolute_date_filter.pyi index 228514fd2..67fb1f3ce 100644 --- a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/absolute_date_filter.pyi @@ -40,36 +40,36 @@ class AbsoluteDateFilter( required = { "absoluteDateFilter", } - + class properties: - - + + class absoluteDateFilter( schemas.DictSchema ): - - + + class MetaOapg: required = { "from", "to", "dataset", } - + class properties: applyOnResult = schemas.BoolSchema - + @staticmethod def dataset() -> typing.Type['AfmObjectIdentifierDataset']: return AfmObjectIdentifierDataset - - + + class _from( schemas.StrSchema ): pass - - + + class to( schemas.StrSchema ): @@ -80,49 +80,49 @@ class AbsoluteDateFilter( "from": _from, "to": to, } - + to: MetaOapg.properties.to dataset: 'AfmObjectIdentifierDataset' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["applyOnResult"]) -> MetaOapg.properties.applyOnResult: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataset"]) -> 'AfmObjectIdentifierDataset': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "dataset", "from", "to", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["applyOnResult"]) -> typing.Union[MetaOapg.properties.applyOnResult, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataset"]) -> 'AfmObjectIdentifierDataset': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "dataset", "from", "to", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -144,29 +144,29 @@ class AbsoluteDateFilter( __annotations__ = { "absoluteDateFilter": absoluteDateFilter, } - + absoluteDateFilter: MetaOapg.properties.absoluteDateFilter - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["absoluteDateFilter"]) -> MetaOapg.properties.absoluteDateFilter: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["absoluteDateFilter", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["absoluteDateFilter"]) -> MetaOapg.properties.absoluteDateFilter: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["absoluteDateFilter", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -183,4 +183,4 @@ class AbsoluteDateFilter( **kwargs, ) -from gooddata_api_client.model.afm_object_identifier_dataset import AfmObjectIdentifierDataset +from gooddata_api_client.models.afm_object_identifier_dataset import AfmObjectIdentifierDataset diff --git a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py b/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py deleted file mode 100644 index 5dbd388ec..000000000 --- a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_dataset import AfmObjectIdentifierDataset - globals()['AfmObjectIdentifierDataset'] = AfmObjectIdentifierDataset - - -class AbsoluteDateFilterAbsoluteDateFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('_from',): { - 'regex': { - 'pattern': r'^\d{4}-\d{1,2}-\d{1,2}( \d{1,2}:\d{1,2})?$', # noqa: E501 - }, - }, - ('to',): { - 'regex': { - 'pattern': r'^\d{4}-\d{1,2}-\d{1,2}( \d{1,2}:\d{1,2})?$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dataset': (AfmObjectIdentifierDataset,), # noqa: E501 - '_from': (str,), # noqa: E501 - 'to': (str,), # noqa: E501 - 'apply_on_result': (bool,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dataset': 'dataset', # noqa: E501 - '_from': 'from', # noqa: E501 - 'to': 'to', # noqa: E501 - 'apply_on_result': 'applyOnResult', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dataset, _from, to, *args, **kwargs): # noqa: E501 - """AbsoluteDateFilterAbsoluteDateFilter - a model defined in OpenAPI - - Args: - dataset (AfmObjectIdentifierDataset): - _from (str): - to (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dataset = dataset - self._from = _from - self.to = to - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dataset, _from, to, *args, **kwargs): # noqa: E501 - """AbsoluteDateFilterAbsoluteDateFilter - a model defined in OpenAPI - - Args: - dataset (AfmObjectIdentifierDataset): - _from (str): - to (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dataset = dataset - self._from = _from - self.to = to - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/abstract_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/model/abstract_measure_value_filter.py deleted file mode 100644 index d76bd735a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/abstract_measure_value_filter.py +++ /dev/null @@ -1,340 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.comparison_measure_value_filter import ComparisonMeasureValueFilter - from gooddata_api_client.model.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter - from gooddata_api_client.model.range_measure_value_filter import RangeMeasureValueFilter - from gooddata_api_client.model.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter - from gooddata_api_client.model.ranking_filter import RankingFilter - from gooddata_api_client.model.ranking_filter_ranking_filter import RankingFilterRankingFilter - globals()['ComparisonMeasureValueFilter'] = ComparisonMeasureValueFilter - globals()['ComparisonMeasureValueFilterComparisonMeasureValueFilter'] = ComparisonMeasureValueFilterComparisonMeasureValueFilter - globals()['RangeMeasureValueFilter'] = RangeMeasureValueFilter - globals()['RangeMeasureValueFilterRangeMeasureValueFilter'] = RangeMeasureValueFilterRangeMeasureValueFilter - globals()['RankingFilter'] = RankingFilter - globals()['RankingFilterRankingFilter'] = RankingFilterRankingFilter - - -class AbstractMeasureValueFilter(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'comparison_measure_value_filter': (ComparisonMeasureValueFilterComparisonMeasureValueFilter,), # noqa: E501 - 'range_measure_value_filter': (RangeMeasureValueFilterRangeMeasureValueFilter,), # noqa: E501 - 'ranking_filter': (RankingFilterRankingFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'comparison_measure_value_filter': 'comparisonMeasureValueFilter', # noqa: E501 - 'range_measure_value_filter': 'rangeMeasureValueFilter', # noqa: E501 - 'ranking_filter': 'rankingFilter', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AbstractMeasureValueFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AbstractMeasureValueFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - ComparisonMeasureValueFilter, - RangeMeasureValueFilter, - RankingFilter, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/abstract_measure_value_filter.pyi b/gooddata-api-client/gooddata_api_client/model/abstract_measure_value_filter.pyi index d776fe9f7..dff81b934 100644 --- a/gooddata-api-client/gooddata_api_client/model/abstract_measure_value_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/abstract_measure_value_filter.pyi @@ -36,7 +36,7 @@ class AbstractMeasureValueFilter( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -67,6 +67,6 @@ class AbstractMeasureValueFilter( **kwargs, ) -from gooddata_api_client.model.comparison_measure_value_filter import ComparisonMeasureValueFilter -from gooddata_api_client.model.range_measure_value_filter import RangeMeasureValueFilter -from gooddata_api_client.model.ranking_filter import RankingFilter +from gooddata_api_client.models.comparison_measure_value_filter import ComparisonMeasureValueFilter +from gooddata_api_client.models.range_measure_value_filter import RangeMeasureValueFilter +from gooddata_api_client.models.ranking_filter import RankingFilter diff --git a/gooddata-api-client/gooddata_api_client/model/active_object_identification.py b/gooddata-api-client/gooddata_api_client/model/active_object_identification.py deleted file mode 100644 index 0007ef0c2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/active_object_identification.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ActiveObjectIdentification(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'workspace_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'workspace_id': 'workspaceId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, workspace_id, *args, **kwargs): # noqa: E501 - """ActiveObjectIdentification - a model defined in OpenAPI - - Args: - id (str): Object ID. - type (str): Object type, e.g. dashboard. - workspace_id (str): Workspace ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - self.workspace_id = workspace_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, workspace_id, *args, **kwargs): # noqa: E501 - """ActiveObjectIdentification - a model defined in OpenAPI - - Args: - id (str): Object ID. - type (str): Object type, e.g. dashboard. - workspace_id (str): Workspace ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - self.workspace_id = workspace_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/ad_hoc_automation.py b/gooddata-api-client/gooddata_api_client/model/ad_hoc_automation.py deleted file mode 100644 index cdd425715..000000000 --- a/gooddata-api-client/gooddata_api_client/model/ad_hoc_automation.py +++ /dev/null @@ -1,378 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.automation_alert import AutomationAlert - from gooddata_api_client.model.automation_dashboard_tabular_export import AutomationDashboardTabularExport - from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient - from gooddata_api_client.model.automation_image_export import AutomationImageExport - from gooddata_api_client.model.automation_metadata import AutomationMetadata - from gooddata_api_client.model.automation_raw_export import AutomationRawExport - from gooddata_api_client.model.automation_slides_export import AutomationSlidesExport - from gooddata_api_client.model.automation_tabular_export import AutomationTabularExport - from gooddata_api_client.model.automation_visual_export import AutomationVisualExport - from gooddata_api_client.model.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier - from gooddata_api_client.model.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier - from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - globals()['AutomationAlert'] = AutomationAlert - globals()['AutomationDashboardTabularExport'] = AutomationDashboardTabularExport - globals()['AutomationExternalRecipient'] = AutomationExternalRecipient - globals()['AutomationImageExport'] = AutomationImageExport - globals()['AutomationMetadata'] = AutomationMetadata - globals()['AutomationRawExport'] = AutomationRawExport - globals()['AutomationSlidesExport'] = AutomationSlidesExport - globals()['AutomationTabularExport'] = AutomationTabularExport - globals()['AutomationVisualExport'] = AutomationVisualExport - globals()['DeclarativeAnalyticalDashboardIdentifier'] = DeclarativeAnalyticalDashboardIdentifier - globals()['DeclarativeNotificationChannelIdentifier'] = DeclarativeNotificationChannelIdentifier - globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - - -class AdHocAutomation(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('dashboard_tabular_exports',): { - }, - ('description',): { - 'max_length': 255, - }, - ('details',): { - }, - ('external_recipients',): { - }, - ('image_exports',): { - }, - ('raw_exports',): { - }, - ('recipients',): { - }, - ('slides_exports',): { - }, - ('tabular_exports',): { - }, - ('tags',): { - }, - ('title',): { - 'max_length': 255, - }, - ('visual_exports',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'alert': (AutomationAlert,), # noqa: E501 - 'analytical_dashboard': (DeclarativeAnalyticalDashboardIdentifier,), # noqa: E501 - 'dashboard_tabular_exports': ([AutomationDashboardTabularExport],), # noqa: E501 - 'description': (str,), # noqa: E501 - 'details': ({str: (str,)},), # noqa: E501 - 'external_recipients': ([AutomationExternalRecipient],), # noqa: E501 - 'image_exports': ([AutomationImageExport],), # noqa: E501 - 'metadata': (AutomationMetadata,), # noqa: E501 - 'notification_channel': (DeclarativeNotificationChannelIdentifier,), # noqa: E501 - 'raw_exports': ([AutomationRawExport],), # noqa: E501 - 'recipients': ([DeclarativeUserIdentifier],), # noqa: E501 - 'slides_exports': ([AutomationSlidesExport],), # noqa: E501 - 'tabular_exports': ([AutomationTabularExport],), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - 'visual_exports': ([AutomationVisualExport],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'alert': 'alert', # noqa: E501 - 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 - 'dashboard_tabular_exports': 'dashboardTabularExports', # noqa: E501 - 'description': 'description', # noqa: E501 - 'details': 'details', # noqa: E501 - 'external_recipients': 'externalRecipients', # noqa: E501 - 'image_exports': 'imageExports', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - 'notification_channel': 'notificationChannel', # noqa: E501 - 'raw_exports': 'rawExports', # noqa: E501 - 'recipients': 'recipients', # noqa: E501 - 'slides_exports': 'slidesExports', # noqa: E501 - 'tabular_exports': 'tabularExports', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - 'visual_exports': 'visualExports', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AdHocAutomation - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - alert (AutomationAlert): [optional] # noqa: E501 - analytical_dashboard (DeclarativeAnalyticalDashboardIdentifier): [optional] # noqa: E501 - dashboard_tabular_exports ([AutomationDashboardTabularExport]): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - details ({str: (str,)}): Additional details to be included in the automated message.. [optional] # noqa: E501 - external_recipients ([AutomationExternalRecipient]): External recipients of the automation action results.. [optional] # noqa: E501 - image_exports ([AutomationImageExport]): [optional] # noqa: E501 - metadata (AutomationMetadata): [optional] # noqa: E501 - notification_channel (DeclarativeNotificationChannelIdentifier): [optional] # noqa: E501 - raw_exports ([AutomationRawExport]): [optional] # noqa: E501 - recipients ([DeclarativeUserIdentifier]): [optional] # noqa: E501 - slides_exports ([AutomationSlidesExport]): [optional] # noqa: E501 - tabular_exports ([AutomationTabularExport]): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - visual_exports ([AutomationVisualExport]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AdHocAutomation - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - alert (AutomationAlert): [optional] # noqa: E501 - analytical_dashboard (DeclarativeAnalyticalDashboardIdentifier): [optional] # noqa: E501 - dashboard_tabular_exports ([AutomationDashboardTabularExport]): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - details ({str: (str,)}): Additional details to be included in the automated message.. [optional] # noqa: E501 - external_recipients ([AutomationExternalRecipient]): External recipients of the automation action results.. [optional] # noqa: E501 - image_exports ([AutomationImageExport]): [optional] # noqa: E501 - metadata (AutomationMetadata): [optional] # noqa: E501 - notification_channel (DeclarativeNotificationChannelIdentifier): [optional] # noqa: E501 - raw_exports ([AutomationRawExport]): [optional] # noqa: E501 - recipients ([DeclarativeUserIdentifier]): [optional] # noqa: E501 - slides_exports ([AutomationSlidesExport]): [optional] # noqa: E501 - tabular_exports ([AutomationTabularExport]): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - visual_exports ([AutomationVisualExport]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm.py b/gooddata-api-client/gooddata_api_client/model/afm.py deleted file mode 100644 index 97eb90fd3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_filters_inner import AFMFiltersInner - from gooddata_api_client.model.attribute_item import AttributeItem - from gooddata_api_client.model.measure_item import MeasureItem - globals()['AFMFiltersInner'] = AFMFiltersInner - globals()['AttributeItem'] = AttributeItem - globals()['MeasureItem'] = MeasureItem - - -class AFM(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': ([AttributeItem],), # noqa: E501 - 'filters': ([AFMFiltersInner],), # noqa: E501 - 'measures': ([MeasureItem],), # noqa: E501 - 'aux_measures': ([MeasureItem],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'filters': 'filters', # noqa: E501 - 'measures': 'measures', # noqa: E501 - 'aux_measures': 'auxMeasures', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, filters, measures, *args, **kwargs): # noqa: E501 - """AFM - a model defined in OpenAPI - - Args: - attributes ([AttributeItem]): Attributes to be used in the computation. - filters ([AFMFiltersInner]): Various filter types to filter the execution result. - measures ([MeasureItem]): Metrics to be computed. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aux_measures ([MeasureItem]): Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.filters = filters - self.measures = measures - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, filters, measures, *args, **kwargs): # noqa: E501 - """AFM - a model defined in OpenAPI - - Args: - attributes ([AttributeItem]): Attributes to be used in the computation. - filters ([AFMFiltersInner]): Various filter types to filter the execution result. - measures ([MeasureItem]): Metrics to be computed. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aux_measures ([MeasureItem]): Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.filters = filters - self.measures = measures - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm.pyi b/gooddata-api-client/gooddata_api_client/model/afm.pyi index 98a9e4651..140034727 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm.pyi +++ b/gooddata-api-client/gooddata_api_client/model/afm.pyi @@ -42,21 +42,21 @@ class AFM( "attributes", "filters", } - + class properties: - - + + class attributes( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['AttributeItem']: return AttributeItem - + def __new__( cls, _arg: typing.Union[typing.Tuple['AttributeItem'], typing.List['AttributeItem']], @@ -67,22 +67,22 @@ class AFM( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'AttributeItem': return super().__getitem__(i) - - + + class filters( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['FilterDefinition']: return FilterDefinition - + def __new__( cls, _arg: typing.Union[typing.Tuple['FilterDefinition'], typing.List['FilterDefinition']], @@ -93,22 +93,22 @@ class AFM( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'FilterDefinition': return super().__getitem__(i) - - + + class measures( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['MeasureItem']: return MeasureItem - + def __new__( cls, _arg: typing.Union[typing.Tuple['MeasureItem'], typing.List['MeasureItem']], @@ -119,22 +119,22 @@ class AFM( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'MeasureItem': return super().__getitem__(i) - - + + class auxMeasures( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['MeasureItem']: return MeasureItem - + def __new__( cls, _arg: typing.Union[typing.Tuple['MeasureItem'], typing.List['MeasureItem']], @@ -145,7 +145,7 @@ class AFM( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'MeasureItem': return super().__getitem__(i) __annotations__ = { @@ -154,49 +154,49 @@ class AFM( "measures": measures, "auxMeasures": auxMeasures, } - + measures: MetaOapg.properties.measures attributes: MetaOapg.properties.attributes filters: MetaOapg.properties.filters - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["measures"]) -> MetaOapg.properties.measures: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["auxMeasures"]) -> MetaOapg.properties.auxMeasures: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "filters", "measures", "auxMeasures", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["measures"]) -> MetaOapg.properties.measures: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["auxMeasures"]) -> typing.Union[MetaOapg.properties.auxMeasures, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "filters", "measures", "auxMeasures", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -219,6 +219,6 @@ class AFM( **kwargs, ) -from gooddata_api_client.model.attribute_item import AttributeItem -from gooddata_api_client.model.filter_definition import FilterDefinition -from gooddata_api_client.model.measure_item import MeasureItem +from gooddata_api_client.models.attribute_item import AttributeItem +from gooddata_api_client.models.filter_definition import FilterDefinition +from gooddata_api_client.models.measure_item import MeasureItem diff --git a/gooddata-api-client/gooddata_api_client/model/afm_cancel_tokens.py b/gooddata-api-client/gooddata_api_client/model/afm_cancel_tokens.py deleted file mode 100644 index f97891164..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_cancel_tokens.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AfmCancelTokens(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'result_id_to_cancel_token_pairs': ({str: (str,)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'result_id_to_cancel_token_pairs': 'resultIdToCancelTokenPairs', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, result_id_to_cancel_token_pairs, *args, **kwargs): # noqa: E501 - """AfmCancelTokens - a model defined in OpenAPI - - Args: - result_id_to_cancel_token_pairs ({str: (str,)}): resultId to cancel token pairs - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.result_id_to_cancel_token_pairs = result_id_to_cancel_token_pairs - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, result_id_to_cancel_token_pairs, *args, **kwargs): # noqa: E501 - """AfmCancelTokens - a model defined in OpenAPI - - Args: - result_id_to_cancel_token_pairs ({str: (str,)}): resultId to cancel token pairs - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.result_id_to_cancel_token_pairs = result_id_to_cancel_token_pairs - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_execution.py b/gooddata-api-client/gooddata_api_client/model/afm_execution.py deleted file mode 100644 index e5644f277..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_execution.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm import AFM - from gooddata_api_client.model.execution_settings import ExecutionSettings - from gooddata_api_client.model.result_spec import ResultSpec - globals()['AFM'] = AFM - globals()['ExecutionSettings'] = ExecutionSettings - globals()['ResultSpec'] = ResultSpec - - -class AfmExecution(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'execution': (AFM,), # noqa: E501 - 'result_spec': (ResultSpec,), # noqa: E501 - 'settings': (ExecutionSettings,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'execution': 'execution', # noqa: E501 - 'result_spec': 'resultSpec', # noqa: E501 - 'settings': 'settings', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, execution, result_spec, *args, **kwargs): # noqa: E501 - """AfmExecution - a model defined in OpenAPI - - Args: - execution (AFM): - result_spec (ResultSpec): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - settings (ExecutionSettings): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.execution = execution - self.result_spec = result_spec - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, execution, result_spec, *args, **kwargs): # noqa: E501 - """AfmExecution - a model defined in OpenAPI - - Args: - execution (AFM): - result_spec (ResultSpec): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - settings (ExecutionSettings): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.execution = execution - self.result_spec = result_spec - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_execution.pyi b/gooddata-api-client/gooddata_api_client/model/afm_execution.pyi index 88388b2d0..488ddf612 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm_execution.pyi +++ b/gooddata-api-client/gooddata_api_client/model/afm_execution.pyi @@ -39,17 +39,17 @@ class AfmExecution( "execution", "resultSpec", } - + class properties: - + @staticmethod def execution() -> typing.Type['AFM']: return AFM - + @staticmethod def resultSpec() -> typing.Type['ResultSpec']: return ResultSpec - + @staticmethod def settings() -> typing.Type['ExecutionSettings']: return ExecutionSettings @@ -58,42 +58,42 @@ class AfmExecution( "resultSpec": resultSpec, "settings": settings, } - + execution: 'AFM' resultSpec: 'ResultSpec' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["execution"]) -> 'AFM': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["resultSpec"]) -> 'ResultSpec': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["settings"]) -> 'ExecutionSettings': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["execution", "resultSpec", "settings", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["execution"]) -> 'AFM': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["resultSpec"]) -> 'ResultSpec': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["settings"]) -> typing.Union['ExecutionSettings', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["execution", "resultSpec", "settings", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -114,6 +114,6 @@ class AfmExecution( **kwargs, ) -from gooddata_api_client.model.afm import AFM -from gooddata_api_client.model.execution_settings import ExecutionSettings -from gooddata_api_client.model.result_spec import ResultSpec +from gooddata_api_client.models.afm import AFM +from gooddata_api_client.models.execution_settings import ExecutionSettings +from gooddata_api_client.models.result_spec import ResultSpec diff --git a/gooddata-api-client/gooddata_api_client/model/afm_execution_response.py b/gooddata-api-client/gooddata_api_client/model/afm_execution_response.py deleted file mode 100644 index 8f7b209a2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_execution_response.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.execution_response import ExecutionResponse - globals()['ExecutionResponse'] = ExecutionResponse - - -class AfmExecutionResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'execution_response': (ExecutionResponse,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'execution_response': 'executionResponse', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, execution_response, *args, **kwargs): # noqa: E501 - """AfmExecutionResponse - a model defined in OpenAPI - - Args: - execution_response (ExecutionResponse): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.execution_response = execution_response - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, execution_response, *args, **kwargs): # noqa: E501 - """AfmExecutionResponse - a model defined in OpenAPI - - Args: - execution_response (ExecutionResponse): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.execution_response = execution_response - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_execution_response.pyi b/gooddata-api-client/gooddata_api_client/model/afm_execution_response.pyi index d6b74d7af..4add4e834 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm_execution_response.pyi +++ b/gooddata-api-client/gooddata_api_client/model/afm_execution_response.pyi @@ -38,38 +38,38 @@ class AfmExecutionResponse( required = { "executionResponse", } - + class properties: - + @staticmethod def executionResponse() -> typing.Type['ExecutionResponse']: return ExecutionResponse __annotations__ = { "executionResponse": executionResponse, } - + executionResponse: 'ExecutionResponse' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["executionResponse"]) -> 'ExecutionResponse': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["executionResponse", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["executionResponse"]) -> 'ExecutionResponse': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["executionResponse", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class AfmExecutionResponse( **kwargs, ) -from gooddata_api_client.model.execution_response import ExecutionResponse +from gooddata_api_client.models.execution_response import ExecutionResponse diff --git a/gooddata-api-client/gooddata_api_client/model/afm_filters_inner.py b/gooddata-api-client/gooddata_api_client/model/afm_filters_inner.py deleted file mode 100644 index 93300685a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_filters_inner.py +++ /dev/null @@ -1,363 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter - from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter - from gooddata_api_client.model.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter - from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure - from gooddata_api_client.model.inline_filter_definition import InlineFilterDefinition - from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline - from gooddata_api_client.model.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter - from gooddata_api_client.model.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter - from gooddata_api_client.model.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter - from gooddata_api_client.model.ranking_filter_ranking_filter import RankingFilterRankingFilter - from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter - globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter - globals()['AbstractMeasureValueFilter'] = AbstractMeasureValueFilter - globals()['ComparisonMeasureValueFilterComparisonMeasureValueFilter'] = ComparisonMeasureValueFilterComparisonMeasureValueFilter - globals()['FilterDefinitionForSimpleMeasure'] = FilterDefinitionForSimpleMeasure - globals()['InlineFilterDefinition'] = InlineFilterDefinition - globals()['InlineFilterDefinitionInline'] = InlineFilterDefinitionInline - globals()['NegativeAttributeFilterNegativeAttributeFilter'] = NegativeAttributeFilterNegativeAttributeFilter - globals()['PositiveAttributeFilterPositiveAttributeFilter'] = PositiveAttributeFilterPositiveAttributeFilter - globals()['RangeMeasureValueFilterRangeMeasureValueFilter'] = RangeMeasureValueFilterRangeMeasureValueFilter - globals()['RankingFilterRankingFilter'] = RankingFilterRankingFilter - globals()['RelativeDateFilterRelativeDateFilter'] = RelativeDateFilterRelativeDateFilter - - -class AFMFiltersInner(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'comparison_measure_value_filter': (ComparisonMeasureValueFilterComparisonMeasureValueFilter,), # noqa: E501 - 'range_measure_value_filter': (RangeMeasureValueFilterRangeMeasureValueFilter,), # noqa: E501 - 'ranking_filter': (RankingFilterRankingFilter,), # noqa: E501 - 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 - 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 - 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 - 'positive_attribute_filter': (PositiveAttributeFilterPositiveAttributeFilter,), # noqa: E501 - 'inline': (InlineFilterDefinitionInline,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'comparison_measure_value_filter': 'comparisonMeasureValueFilter', # noqa: E501 - 'range_measure_value_filter': 'rangeMeasureValueFilter', # noqa: E501 - 'ranking_filter': 'rankingFilter', # noqa: E501 - 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 - 'relative_date_filter': 'relativeDateFilter', # noqa: E501 - 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 - 'positive_attribute_filter': 'positiveAttributeFilter', # noqa: E501 - 'inline': 'inline', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AFMFiltersInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 - relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 - negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - inline (InlineFilterDefinitionInline): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AFMFiltersInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 - relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 - negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - inline (InlineFilterDefinitionInline): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AbstractMeasureValueFilter, - FilterDefinitionForSimpleMeasure, - InlineFilterDefinition, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/afm_identifier.py b/gooddata-api-client/gooddata_api_client/model/afm_identifier.py deleted file mode 100644 index 4c6c66598..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_identifier.py +++ /dev/null @@ -1,334 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_local_identifier import AfmLocalIdentifier - from gooddata_api_client.model.afm_object_identifier import AfmObjectIdentifier - from gooddata_api_client.model.afm_object_identifier_identifier import AfmObjectIdentifierIdentifier - globals()['AfmLocalIdentifier'] = AfmLocalIdentifier - globals()['AfmObjectIdentifier'] = AfmObjectIdentifier - globals()['AfmObjectIdentifierIdentifier'] = AfmObjectIdentifierIdentifier - - -class AfmIdentifier(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('local_identifier',): { - 'regex': { - 'pattern': r'^[.a-zA-Z0-9_-]+$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'identifier': (AfmObjectIdentifierIdentifier,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'identifier': 'identifier', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AfmIdentifier - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - identifier (AfmObjectIdentifierIdentifier): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AfmIdentifier - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - identifier (AfmObjectIdentifierIdentifier): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AfmLocalIdentifier, - AfmObjectIdentifier, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/afm_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/afm_identifier.pyi index 5b76446c5..808f5af45 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm_identifier.pyi +++ b/gooddata-api-client/gooddata_api_client/model/afm_identifier.pyi @@ -36,7 +36,7 @@ class AfmIdentifier( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -66,5 +66,5 @@ class AfmIdentifier( **kwargs, ) -from gooddata_api_client.model.afm_local_identifier import AfmLocalIdentifier -from gooddata_api_client.model.afm_object_identifier import AfmObjectIdentifier +from gooddata_api_client.models.afm_local_identifier import AfmLocalIdentifier +from gooddata_api_client.models.afm_object_identifier import AfmObjectIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/afm_local_identifier.py b/gooddata-api-client/gooddata_api_client/model/afm_local_identifier.py deleted file mode 100644 index 173079cdf..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_local_identifier.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AfmLocalIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('local_identifier',): { - 'regex': { - 'pattern': r'^[.a-zA-Z0-9_-]+$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'local_identifier': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'local_identifier': 'localIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, local_identifier, *args, **kwargs): # noqa: E501 - """AfmLocalIdentifier - a model defined in OpenAPI - - Args: - local_identifier (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, local_identifier, *args, **kwargs): # noqa: E501 - """AfmLocalIdentifier - a model defined in OpenAPI - - Args: - local_identifier (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier.py deleted file mode 100644 index b76ba6086..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_identifier import AfmObjectIdentifierIdentifier - globals()['AfmObjectIdentifierIdentifier'] = AfmObjectIdentifierIdentifier - - -class AfmObjectIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'identifier': (AfmObjectIdentifierIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'identifier': 'identifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, identifier, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifier - a model defined in OpenAPI - - Args: - identifier (AfmObjectIdentifierIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, identifier, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifier - a model defined in OpenAPI - - Args: - identifier (AfmObjectIdentifierIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_attribute.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_attribute.py deleted file mode 100644 index 01fbb1a65..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_attribute.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_attribute_identifier import AfmObjectIdentifierAttributeIdentifier - globals()['AfmObjectIdentifierAttributeIdentifier'] = AfmObjectIdentifierAttributeIdentifier - - -class AfmObjectIdentifierAttribute(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'identifier': (AfmObjectIdentifierAttributeIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'identifier': 'identifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, identifier, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierAttribute - a model defined in OpenAPI - - Args: - identifier (AfmObjectIdentifierAttributeIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, identifier, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierAttribute - a model defined in OpenAPI - - Args: - identifier (AfmObjectIdentifierAttributeIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_attribute_identifier.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_attribute_identifier.py deleted file mode 100644 index ce75f7343..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_attribute_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AfmObjectIdentifierAttributeIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTE': "attribute", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierAttributeIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "attribute", must be one of ["attribute", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "attribute") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierAttributeIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "attribute", must be one of ["attribute", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "attribute") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_core.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_core.py deleted file mode 100644 index 9d6fe652b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_core.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_core_identifier import AfmObjectIdentifierCoreIdentifier - globals()['AfmObjectIdentifierCoreIdentifier'] = AfmObjectIdentifierCoreIdentifier - - -class AfmObjectIdentifierCore(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'identifier': (AfmObjectIdentifierCoreIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'identifier': 'identifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, identifier, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierCore - a model defined in OpenAPI - - Args: - identifier (AfmObjectIdentifierCoreIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, identifier, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierCore - a model defined in OpenAPI - - Args: - identifier (AfmObjectIdentifierCoreIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_core_identifier.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_core_identifier.py deleted file mode 100644 index 7effdae91..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_core_identifier.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AfmObjectIdentifierCoreIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTE': "attribute", - 'LABEL': "label", - 'FACT': "fact", - 'METRIC': "metric", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierCoreIdentifier - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierCoreIdentifier - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_dataset.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_dataset.py deleted file mode 100644 index d64c4e801..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_dataset.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_dataset_identifier import AfmObjectIdentifierDatasetIdentifier - globals()['AfmObjectIdentifierDatasetIdentifier'] = AfmObjectIdentifierDatasetIdentifier - - -class AfmObjectIdentifierDataset(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'identifier': (AfmObjectIdentifierDatasetIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'identifier': 'identifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, identifier, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierDataset - a model defined in OpenAPI - - Args: - identifier (AfmObjectIdentifierDatasetIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, identifier, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierDataset - a model defined in OpenAPI - - Args: - identifier (AfmObjectIdentifierDatasetIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_dataset_identifier.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_dataset_identifier.py deleted file mode 100644 index c4ac736c2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_dataset_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AfmObjectIdentifierDatasetIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASET': "dataset", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierDatasetIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierDatasetIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_identifier.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_identifier.py deleted file mode 100644 index 957a62a3e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_identifier.py +++ /dev/null @@ -1,293 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AfmObjectIdentifierIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - 'ATTRIBUTE': "attribute", - 'DASHBOARDPLUGIN': "dashboardPlugin", - 'DATASET': "dataset", - 'FACT': "fact", - 'LABEL': "label", - 'METRIC': "metric", - 'PROMPT': "prompt", - 'VISUALIZATIONOBJECT': "visualizationObject", - 'FILTERCONTEXT': "filterContext", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierIdentifier - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierIdentifier - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_label.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_label.py deleted file mode 100644 index 4a4ddcedb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_label.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_label_identifier import AfmObjectIdentifierLabelIdentifier - globals()['AfmObjectIdentifierLabelIdentifier'] = AfmObjectIdentifierLabelIdentifier - - -class AfmObjectIdentifierLabel(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'identifier': (AfmObjectIdentifierLabelIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'identifier': 'identifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, identifier, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierLabel - a model defined in OpenAPI - - Args: - identifier (AfmObjectIdentifierLabelIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, identifier, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierLabel - a model defined in OpenAPI - - Args: - identifier (AfmObjectIdentifierLabelIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_label_identifier.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_label_identifier.py deleted file mode 100644 index 5837b784f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_label_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AfmObjectIdentifierLabelIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'LABEL': "label", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierLabelIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "label", must be one of ["label", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "label") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """AfmObjectIdentifierLabelIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "label", must be one of ["label", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "label") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_query.py b/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_query.py deleted file mode 100644 index 4864ab03d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_query.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_attribute import AfmObjectIdentifierAttribute - globals()['AfmObjectIdentifierAttribute'] = AfmObjectIdentifierAttribute - - -class AfmValidDescendantsQuery(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': ([AfmObjectIdentifierAttribute],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 - """AfmValidDescendantsQuery - a model defined in OpenAPI - - Args: - attributes ([AfmObjectIdentifierAttribute]): List of identifiers of the attributes to get the valid descendants for. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, *args, **kwargs): # noqa: E501 - """AfmValidDescendantsQuery - a model defined in OpenAPI - - Args: - attributes ([AfmObjectIdentifierAttribute]): List of identifiers of the attributes to get the valid descendants for. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_response.py b/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_response.py deleted file mode 100644 index 53026f81d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_response.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_attribute import AfmObjectIdentifierAttribute - globals()['AfmObjectIdentifierAttribute'] = AfmObjectIdentifierAttribute - - -class AfmValidDescendantsResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'valid_descendants': ({str: ([AfmObjectIdentifierAttribute],)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'valid_descendants': 'validDescendants', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, valid_descendants, *args, **kwargs): # noqa: E501 - """AfmValidDescendantsResponse - a model defined in OpenAPI - - Args: - valid_descendants ({str: ([AfmObjectIdentifierAttribute],)}): Map of attribute identifiers to list of valid descendants identifiers. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.valid_descendants = valid_descendants - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, valid_descendants, *args, **kwargs): # noqa: E501 - """AfmValidDescendantsResponse - a model defined in OpenAPI - - Args: - valid_descendants ({str: ([AfmObjectIdentifierAttribute],)}): Map of attribute identifiers to list of valid descendants identifiers. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.valid_descendants = valid_descendants - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_query.py b/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_query.py deleted file mode 100644 index d83479183..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_query.py +++ /dev/null @@ -1,289 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm import AFM - globals()['AFM'] = AFM - - -class AfmValidObjectsQuery(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('types',): { - 'FACTS': "facts", - 'ATTRIBUTES': "attributes", - 'MEASURES': "measures", - }, - } - - validations = { - ('types',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'afm': (AFM,), # noqa: E501 - 'types': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'afm': 'afm', # noqa: E501 - 'types': 'types', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, afm, types, *args, **kwargs): # noqa: E501 - """AfmValidObjectsQuery - a model defined in OpenAPI - - Args: - afm (AFM): - types ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.afm = afm - self.types = types - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, afm, types, *args, **kwargs): # noqa: E501 - """AfmValidObjectsQuery - a model defined in OpenAPI - - Args: - afm (AFM): - types ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.afm = afm - self.types = types - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_query.pyi b/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_query.pyi index 1cc4a4986..06e2477f7 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_query.pyi +++ b/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_query.pyi @@ -41,43 +41,43 @@ class AfmValidObjectsQuery( "types", "afm", } - + class properties: - + @staticmethod def afm() -> typing.Type['AFM']: return AFM - - + + class types( schemas.ListSchema ): - - + + class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def MEASURES(cls): return cls("measures") - + @schemas.classproperty def UNRECOGNIZED(cls): return cls("UNRECOGNIZED") - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -88,43 +88,43 @@ class AfmValidObjectsQuery( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) __annotations__ = { "afm": afm, "types": types, } - + types: MetaOapg.properties.types afm: 'AFM' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["afm"]) -> 'AFM': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["types"]) -> MetaOapg.properties.types: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["afm", "types", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["afm"]) -> 'AFM': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["types"]) -> MetaOapg.properties.types: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["afm", "types", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -143,4 +143,4 @@ class AfmValidObjectsQuery( **kwargs, ) -from gooddata_api_client.model.afm import AFM +from gooddata_api_client.models.afm import AFM diff --git a/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_response.py b/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_response.py deleted file mode 100644 index 919e56d72..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_response.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.rest_api_identifier import RestApiIdentifier - globals()['RestApiIdentifier'] = RestApiIdentifier - - -class AfmValidObjectsResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'items': ([RestApiIdentifier],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'items': 'items', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, items, *args, **kwargs): # noqa: E501 - """AfmValidObjectsResponse - a model defined in OpenAPI - - Args: - items ([RestApiIdentifier]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.items = items - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, items, *args, **kwargs): # noqa: E501 - """AfmValidObjectsResponse - a model defined in OpenAPI - - Args: - items ([RestApiIdentifier]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.items = items - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_response.pyi b/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_response.pyi index a61bc3f7d..9839de491 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_response.pyi +++ b/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_response.pyi @@ -40,21 +40,21 @@ class AfmValidObjectsResponse( required = { "items", } - + class properties: - - + + class items( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['RestApiIdentifier']: return RestApiIdentifier - + def __new__( cls, _arg: typing.Union[typing.Tuple['RestApiIdentifier'], typing.List['RestApiIdentifier']], @@ -65,35 +65,35 @@ class AfmValidObjectsResponse( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'RestApiIdentifier': return super().__getitem__(i) __annotations__ = { "items": items, } - + items: MetaOapg.properties.items - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["items", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["items", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -110,4 +110,4 @@ class AfmValidObjectsResponse( **kwargs, ) -from gooddata_api_client.model.rest_api_identifier import RestApiIdentifier +from gooddata_api_client.models.rest_api_identifier import RestApiIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/alert_afm.py b/gooddata-api-client/gooddata_api_client/model/alert_afm.py deleted file mode 100644 index 2aafb7735..000000000 --- a/gooddata-api-client/gooddata_api_client/model/alert_afm.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_item import AttributeItem - from gooddata_api_client.model.filter_definition import FilterDefinition - from gooddata_api_client.model.measure_item import MeasureItem - globals()['AttributeItem'] = AttributeItem - globals()['FilterDefinition'] = FilterDefinition - globals()['MeasureItem'] = MeasureItem - - -class AlertAfm(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('measures',): { - }, - ('attributes',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'filters': ([FilterDefinition],), # noqa: E501 - 'measures': ([MeasureItem],), # noqa: E501 - 'attributes': ([AttributeItem],), # noqa: E501 - 'aux_measures': ([MeasureItem],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'filters': 'filters', # noqa: E501 - 'measures': 'measures', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'aux_measures': 'auxMeasures', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, filters, measures, *args, **kwargs): # noqa: E501 - """AlertAfm - a model defined in OpenAPI - - Args: - filters ([FilterDefinition]): Various filter types to filter execution result. - measures ([MeasureItem]): Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes ([AttributeItem]): Attributes to be used in the computation.. [optional] # noqa: E501 - aux_measures ([MeasureItem]): Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filters = filters - self.measures = measures - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, filters, measures, *args, **kwargs): # noqa: E501 - """AlertAfm - a model defined in OpenAPI - - Args: - filters ([FilterDefinition]): Various filter types to filter execution result. - measures ([MeasureItem]): Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes ([AttributeItem]): Attributes to be used in the computation.. [optional] # noqa: E501 - aux_measures ([MeasureItem]): Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filters = filters - self.measures = measures - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/alert_condition.py b/gooddata-api-client/gooddata_api_client/model/alert_condition.py deleted file mode 100644 index 8b76b08ea..000000000 --- a/gooddata-api-client/gooddata_api_client/model/alert_condition.py +++ /dev/null @@ -1,340 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.comparison import Comparison - from gooddata_api_client.model.comparison_wrapper import ComparisonWrapper - from gooddata_api_client.model.range import Range - from gooddata_api_client.model.range_wrapper import RangeWrapper - from gooddata_api_client.model.relative import Relative - from gooddata_api_client.model.relative_wrapper import RelativeWrapper - globals()['Comparison'] = Comparison - globals()['ComparisonWrapper'] = ComparisonWrapper - globals()['Range'] = Range - globals()['RangeWrapper'] = RangeWrapper - globals()['Relative'] = Relative - globals()['RelativeWrapper'] = RelativeWrapper - - -class AlertCondition(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'comparison': (Comparison,), # noqa: E501 - 'range': (Range,), # noqa: E501 - 'relative': (Relative,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'comparison': 'comparison', # noqa: E501 - 'range': 'range', # noqa: E501 - 'relative': 'relative', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AlertCondition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - comparison (Comparison): [optional] # noqa: E501 - range (Range): [optional] # noqa: E501 - relative (Relative): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AlertCondition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - comparison (Comparison): [optional] # noqa: E501 - range (Range): [optional] # noqa: E501 - relative (Relative): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - ComparisonWrapper, - RangeWrapper, - RelativeWrapper, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/alert_condition_operand.py b/gooddata-api-client/gooddata_api_client/model/alert_condition_operand.py deleted file mode 100644 index 55f6226ec..000000000 --- a/gooddata-api-client/gooddata_api_client/model/alert_condition_operand.py +++ /dev/null @@ -1,341 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.local_identifier import LocalIdentifier - from gooddata_api_client.model.value import Value - globals()['LocalIdentifier'] = LocalIdentifier - globals()['Value'] = Value - - -class AlertConditionOperand(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('format',): { - 'max_length': 2048, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'format': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - 'value': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'format': 'format', # noqa: E501 - 'title': 'title', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AlertConditionOperand - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (str, none_type): Metric format.. [optional] if omitted the server will use the default value of "#,##0.00" # noqa: E501 - title (str, none_type): Metric title.. [optional] # noqa: E501 - local_identifier (str): Local identifier of the metric to be compared.. [optional] # noqa: E501 - value (float): Value of the alert threshold to compare the metric to.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AlertConditionOperand - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (str, none_type): Metric format.. [optional] if omitted the server will use the default value of "#,##0.00" # noqa: E501 - title (str, none_type): Metric title.. [optional] # noqa: E501 - local_identifier (str): Local identifier of the metric to be compared.. [optional] # noqa: E501 - value (float): Value of the alert threshold to compare the metric to.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - LocalIdentifier, - Value, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/alert_description.py b/gooddata-api-client/gooddata_api_client/model/alert_description.py deleted file mode 100644 index 64888f59e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/alert_description.py +++ /dev/null @@ -1,340 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.alert_evaluation_row import AlertEvaluationRow - globals()['AlertEvaluationRow'] = AlertEvaluationRow - - -class AlertDescription(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('status',): { - 'SUCCESS': "SUCCESS", - 'ERROR': "ERROR", - 'INTERNAL_ERROR': "INTERNAL_ERROR", - 'TIMEOUT': "TIMEOUT", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'condition': (str,), # noqa: E501 - 'metric': (str,), # noqa: E501 - 'attribute': (str,), # noqa: E501 - 'current_values': ([AlertEvaluationRow],), # noqa: E501 - 'error_message': (str,), # noqa: E501 - 'formatted_threshold': (str,), # noqa: E501 - 'lower_threshold': (float,), # noqa: E501 - 'remaining_alert_evaluation_count': (int,), # noqa: E501 - 'status': (str,), # noqa: E501 - 'threshold': (float,), # noqa: E501 - 'total_value_count': (int,), # noqa: E501 - 'trace_id': (str,), # noqa: E501 - 'triggered_at': (datetime,), # noqa: E501 - 'triggered_count': (int,), # noqa: E501 - 'upper_threshold': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'condition': 'condition', # noqa: E501 - 'metric': 'metric', # noqa: E501 - 'attribute': 'attribute', # noqa: E501 - 'current_values': 'currentValues', # noqa: E501 - 'error_message': 'errorMessage', # noqa: E501 - 'formatted_threshold': 'formattedThreshold', # noqa: E501 - 'lower_threshold': 'lowerThreshold', # noqa: E501 - 'remaining_alert_evaluation_count': 'remainingAlertEvaluationCount', # noqa: E501 - 'status': 'status', # noqa: E501 - 'threshold': 'threshold', # noqa: E501 - 'total_value_count': 'totalValueCount', # noqa: E501 - 'trace_id': 'traceId', # noqa: E501 - 'triggered_at': 'triggeredAt', # noqa: E501 - 'triggered_count': 'triggeredCount', # noqa: E501 - 'upper_threshold': 'upperThreshold', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, condition, metric, *args, **kwargs): # noqa: E501 - """AlertDescription - a model defined in OpenAPI - - Args: - condition (str): - metric (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute (str): [optional] # noqa: E501 - current_values ([AlertEvaluationRow]): [optional] # noqa: E501 - error_message (str): [optional] # noqa: E501 - formatted_threshold (str): [optional] # noqa: E501 - lower_threshold (float): [optional] # noqa: E501 - remaining_alert_evaluation_count (int): [optional] # noqa: E501 - status (str): [optional] # noqa: E501 - threshold (float): [optional] # noqa: E501 - total_value_count (int): [optional] # noqa: E501 - trace_id (str): [optional] # noqa: E501 - triggered_at (datetime): [optional] # noqa: E501 - triggered_count (int): [optional] # noqa: E501 - upper_threshold (float): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.condition = condition - self.metric = metric - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, condition, metric, *args, **kwargs): # noqa: E501 - """AlertDescription - a model defined in OpenAPI - - Args: - condition (str): - metric (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute (str): [optional] # noqa: E501 - current_values ([AlertEvaluationRow]): [optional] # noqa: E501 - error_message (str): [optional] # noqa: E501 - formatted_threshold (str): [optional] # noqa: E501 - lower_threshold (float): [optional] # noqa: E501 - remaining_alert_evaluation_count (int): [optional] # noqa: E501 - status (str): [optional] # noqa: E501 - threshold (float): [optional] # noqa: E501 - total_value_count (int): [optional] # noqa: E501 - trace_id (str): [optional] # noqa: E501 - triggered_at (datetime): [optional] # noqa: E501 - triggered_count (int): [optional] # noqa: E501 - upper_threshold (float): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.condition = condition - self.metric = metric - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/alert_evaluation_row.py b/gooddata-api-client/gooddata_api_client/model/alert_evaluation_row.py deleted file mode 100644 index a2c739084..000000000 --- a/gooddata-api-client/gooddata_api_client/model/alert_evaluation_row.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.metric_record import MetricRecord - globals()['MetricRecord'] = MetricRecord - - -class AlertEvaluationRow(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'computed_metric': (MetricRecord,), # noqa: E501 - 'label_value': (str,), # noqa: E501 - 'primary_metric': (MetricRecord,), # noqa: E501 - 'secondary_metric': (MetricRecord,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'computed_metric': 'computedMetric', # noqa: E501 - 'label_value': 'labelValue', # noqa: E501 - 'primary_metric': 'primaryMetric', # noqa: E501 - 'secondary_metric': 'secondaryMetric', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AlertEvaluationRow - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - computed_metric (MetricRecord): [optional] # noqa: E501 - label_value (str): [optional] # noqa: E501 - primary_metric (MetricRecord): [optional] # noqa: E501 - secondary_metric (MetricRecord): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AlertEvaluationRow - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - computed_metric (MetricRecord): [optional] # noqa: E501 - label_value (str): [optional] # noqa: E501 - primary_metric (MetricRecord): [optional] # noqa: E501 - secondary_metric (MetricRecord): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/analytics_catalog_tags.py b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_tags.py deleted file mode 100644 index 7f7a25235..000000000 --- a/gooddata-api-client/gooddata_api_client/model/analytics_catalog_tags.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AnalyticsCatalogTags(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, tags, *args, **kwargs): # noqa: E501 - """AnalyticsCatalogTags - a model defined in OpenAPI - - Args: - tags ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.tags = tags - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, tags, *args, **kwargs): # noqa: E501 - """AnalyticsCatalogTags - a model defined in OpenAPI - - Args: - tags ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.tags = tags - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/anomaly_detection_request.py b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_request.py deleted file mode 100644 index d2fe87999..000000000 --- a/gooddata-api-client/gooddata_api_client/model/anomaly_detection_request.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AnomalyDetectionRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'sensitivity': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'sensitivity': 'sensitivity', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, sensitivity, *args, **kwargs): # noqa: E501 - """AnomalyDetectionRequest - a model defined in OpenAPI - - Args: - sensitivity (float): Anomaly detection sensitivity. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.sensitivity = sensitivity - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, sensitivity, *args, **kwargs): # noqa: E501 - """AnomalyDetectionRequest - a model defined in OpenAPI - - Args: - sensitivity (float): Anomaly detection sensitivity. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.sensitivity = sensitivity - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/anomaly_detection_result.py b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_result.py deleted file mode 100644 index 731539c8e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/anomaly_detection_result.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AnomalyDetectionResult(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'anomaly_flag': ([bool, none_type],), # noqa: E501 - 'attribute': ([str],), # noqa: E501 - 'values': ([float, none_type],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'anomaly_flag': 'anomalyFlag', # noqa: E501 - 'attribute': 'attribute', # noqa: E501 - 'values': 'values', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, anomaly_flag, attribute, values, *args, **kwargs): # noqa: E501 - """AnomalyDetectionResult - a model defined in OpenAPI - - Args: - anomaly_flag ([bool, none_type]): - attribute ([str]): - values ([float, none_type]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.anomaly_flag = anomaly_flag - self.attribute = attribute - self.values = values - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, anomaly_flag, attribute, values, *args, **kwargs): # noqa: E501 - """AnomalyDetectionResult - a model defined in OpenAPI - - Args: - anomaly_flag ([bool, none_type]): - attribute ([str]): - values ([float, none_type]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.anomaly_flag = anomaly_flag - self.attribute = attribute - self.values = values - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/api_entitlement.py b/gooddata-api-client/gooddata_api_client/model/api_entitlement.py deleted file mode 100644 index cc2a3f6a2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/api_entitlement.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ApiEntitlement(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'CACHESTRATEGY': "CacheStrategy", - 'CONTRACT': "Contract", - 'CUSTOMTHEMING': "CustomTheming", - 'EXTRACACHE': "ExtraCache", - 'HIPAA': "Hipaa", - 'PDFEXPORTS': "PdfExports", - 'MANAGEDOIDC': "ManagedOIDC", - 'UILOCALIZATION': "UiLocalization", - 'TIER': "Tier", - 'USERCOUNT': "UserCount", - 'MANAGEDIDPUSERCOUNT': "ManagedIdpUserCount", - 'UNLIMITEDUSERS': "UnlimitedUsers", - 'UNLIMITEDWORKSPACES': "UnlimitedWorkspaces", - 'WHITELABELING': "WhiteLabeling", - 'WORKSPACECOUNT': "WorkspaceCount", - 'USERTELEMETRYDISABLED': "UserTelemetryDisabled", - 'AUTOMATIONCOUNT': "AutomationCount", - 'UNLIMITEDAUTOMATIONS': "UnlimitedAutomations", - 'AUTOMATIONRECIPIENTCOUNT': "AutomationRecipientCount", - 'UNLIMITEDAUTOMATIONRECIPIENTS': "UnlimitedAutomationRecipients", - 'DAILYSCHEDULEDACTIONCOUNT': "DailyScheduledActionCount", - 'UNLIMITEDDAILYSCHEDULEDACTIONS': "UnlimitedDailyScheduledActions", - 'DAILYALERTACTIONCOUNT': "DailyAlertActionCount", - 'UNLIMITEDDAILYALERTACTIONS': "UnlimitedDailyAlertActions", - 'SCHEDULEDACTIONMINIMUMRECURRENCEMINUTES': "ScheduledActionMinimumRecurrenceMinutes", - 'FEDERATEDIDENTITYMANAGEMENT': "FederatedIdentityManagement", - 'AUDITLOGGING': "AuditLogging", - 'CONTROLLEDFEATUREROLLOUT': "ControlledFeatureRollout", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'expiry': (date,), # noqa: E501 - 'value': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'expiry': 'expiry', # noqa: E501 - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 - """ApiEntitlement - a model defined in OpenAPI - - Args: - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - expiry (date): [optional] # noqa: E501 - value (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, name, *args, **kwargs): # noqa: E501 - """ApiEntitlement - a model defined in OpenAPI - - Args: - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - expiry (date): [optional] # noqa: E501 - value (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/arithmetic_measure.py b/gooddata-api-client/gooddata_api_client/model/arithmetic_measure.py deleted file mode 100644 index 3e1e0cd81..000000000 --- a/gooddata-api-client/gooddata_api_client/model/arithmetic_measure.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.local_identifier import LocalIdentifier - globals()['LocalIdentifier'] = LocalIdentifier - - -class ArithmeticMeasure(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('operator',): { - 'DIFFERENCE': "DIFFERENCE", - 'CHANGE': "CHANGE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'left': (LocalIdentifier,), # noqa: E501 - 'operator': (str,), # noqa: E501 - 'right': (LocalIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'left': 'left', # noqa: E501 - 'operator': 'operator', # noqa: E501 - 'right': 'right', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, left, operator, right, *args, **kwargs): # noqa: E501 - """ArithmeticMeasure - a model defined in OpenAPI - - Args: - left (LocalIdentifier): - operator (str): Arithmetic operator. DIFFERENCE - m₁−m₂ - the difference between two metrics. CHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics. - right (LocalIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.left = left - self.operator = operator - self.right = right - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, left, operator, right, *args, **kwargs): # noqa: E501 - """ArithmeticMeasure - a model defined in OpenAPI - - Args: - left (LocalIdentifier): - operator (str): Arithmetic operator. DIFFERENCE - m₁−m₂ - the difference between two metrics. CHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics. - right (LocalIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.left = left - self.operator = operator - self.right = right - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/arithmetic_measure_definition.py b/gooddata-api-client/gooddata_api_client/model/arithmetic_measure_definition.py deleted file mode 100644 index c1ddf078a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/arithmetic_measure_definition.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.arithmetic_measure_definition_arithmetic_measure import ArithmeticMeasureDefinitionArithmeticMeasure - globals()['ArithmeticMeasureDefinitionArithmeticMeasure'] = ArithmeticMeasureDefinitionArithmeticMeasure - - -class ArithmeticMeasureDefinition(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'arithmetic_measure': (ArithmeticMeasureDefinitionArithmeticMeasure,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'arithmetic_measure': 'arithmeticMeasure', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, arithmetic_measure, *args, **kwargs): # noqa: E501 - """ArithmeticMeasureDefinition - a model defined in OpenAPI - - Args: - arithmetic_measure (ArithmeticMeasureDefinitionArithmeticMeasure): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.arithmetic_measure = arithmetic_measure - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, arithmetic_measure, *args, **kwargs): # noqa: E501 - """ArithmeticMeasureDefinition - a model defined in OpenAPI - - Args: - arithmetic_measure (ArithmeticMeasureDefinitionArithmeticMeasure): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.arithmetic_measure = arithmetic_measure - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/arithmetic_measure_definition.pyi b/gooddata-api-client/gooddata_api_client/model/arithmetic_measure_definition.pyi index 55a279fc5..0352edcb6 100644 --- a/gooddata-api-client/gooddata_api_client/model/arithmetic_measure_definition.pyi +++ b/gooddata-api-client/gooddata_api_client/model/arithmetic_measure_definition.pyi @@ -201,4 +201,4 @@ class ArithmeticMeasureDefinition( **kwargs, ) -from gooddata_api_client.model.afm_local_identifier import AfmLocalIdentifier +from gooddata_api_client.models.afm_local_identifier import AfmLocalIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/arithmetic_measure_definition_arithmetic_measure.py b/gooddata-api-client/gooddata_api_client/model/arithmetic_measure_definition_arithmetic_measure.py deleted file mode 100644 index f79605c74..000000000 --- a/gooddata-api-client/gooddata_api_client/model/arithmetic_measure_definition_arithmetic_measure.py +++ /dev/null @@ -1,289 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_local_identifier import AfmLocalIdentifier - globals()['AfmLocalIdentifier'] = AfmLocalIdentifier - - -class ArithmeticMeasureDefinitionArithmeticMeasure(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('operator',): { - 'SUM': "SUM", - 'DIFFERENCE': "DIFFERENCE", - 'MULTIPLICATION': "MULTIPLICATION", - 'RATIO': "RATIO", - 'CHANGE': "CHANGE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'measure_identifiers': ([AfmLocalIdentifier],), # noqa: E501 - 'operator': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'measure_identifiers': 'measureIdentifiers', # noqa: E501 - 'operator': 'operator', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, measure_identifiers, operator, *args, **kwargs): # noqa: E501 - """ArithmeticMeasureDefinitionArithmeticMeasure - a model defined in OpenAPI - - Args: - measure_identifiers ([AfmLocalIdentifier]): List of metrics to apply arithmetic operation by chosen operator. - operator (str): Arithmetic operator describing operation between metrics. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure_identifiers = measure_identifiers - self.operator = operator - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, measure_identifiers, operator, *args, **kwargs): # noqa: E501 - """ArithmeticMeasureDefinitionArithmeticMeasure - a model defined in OpenAPI - - Args: - measure_identifiers ([AfmLocalIdentifier]): List of metrics to apply arithmetic operation by chosen operator. - operator (str): Arithmetic operator describing operation between metrics. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure_identifiers = measure_identifiers - self.operator = operator - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/assignee_identifier.py b/gooddata-api-client/gooddata_api_client/model/assignee_identifier.py deleted file mode 100644 index 082dc36fe..000000000 --- a/gooddata-api-client/gooddata_api_client/model/assignee_identifier.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AssigneeIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USER': "user", - 'USERGROUP': "userGroup", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """AssigneeIdentifier - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """AssigneeIdentifier - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/assignee_rule.py b/gooddata-api-client/gooddata_api_client/model/assignee_rule.py deleted file mode 100644 index 5889af62a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/assignee_rule.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AssigneeRule(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ALLWORKSPACEUSERS': "allWorkspaceUsers", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AssigneeRule - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): defaults to "allWorkspaceUsers", must be one of ["allWorkspaceUsers", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "allWorkspaceUsers") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AssigneeRule - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): defaults to "allWorkspaceUsers", must be one of ["allWorkspaceUsers", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "allWorkspaceUsers") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_elements.py b/gooddata-api-client/gooddata_api_client/model/attribute_elements.py deleted file mode 100644 index cdc23674b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_elements.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_elements_by_ref import AttributeElementsByRef - from gooddata_api_client.model.attribute_elements_by_value import AttributeElementsByValue - globals()['AttributeElementsByRef'] = AttributeElementsByRef - globals()['AttributeElementsByValue'] = AttributeElementsByValue - - -class AttributeElements(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'uris': ([str, none_type],), # noqa: E501 - 'values': ([str, none_type],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'uris': 'uris', # noqa: E501 - 'values': 'values', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AttributeElements - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - uris ([str, none_type]): List of attribute elements by reference. [optional] # noqa: E501 - values ([str, none_type]): List of attribute elements by value. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AttributeElements - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - uris ([str, none_type]): List of attribute elements by reference. [optional] # noqa: E501 - values ([str, none_type]): List of attribute elements by value. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AttributeElementsByRef, - AttributeElementsByValue, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_ref.py b/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_ref.py deleted file mode 100644 index 5d2270d8c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_ref.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AttributeElementsByRef(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'uris': ([str, none_type],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'uris': 'uris', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, uris, *args, **kwargs): # noqa: E501 - """AttributeElementsByRef - a model defined in OpenAPI - - Args: - uris ([str, none_type]): List of attribute elements by reference - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.uris = uris - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, uris, *args, **kwargs): # noqa: E501 - """AttributeElementsByRef - a model defined in OpenAPI - - Args: - uris ([str, none_type]): List of attribute elements by reference - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.uris = uris - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_value.py b/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_value.py deleted file mode 100644 index 959f8a6d0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_value.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AttributeElementsByValue(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'values': ([str, none_type],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'values': 'values', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, values, *args, **kwargs): # noqa: E501 - """AttributeElementsByValue - a model defined in OpenAPI - - Args: - values ([str, none_type]): List of attribute elements by value - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.values = values - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, values, *args, **kwargs): # noqa: E501 - """AttributeElementsByValue - a model defined in OpenAPI - - Args: - values ([str, none_type]): List of attribute elements by value - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.values = values - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_execution_result_header.py b/gooddata-api-client/gooddata_api_client/model/attribute_execution_result_header.py deleted file mode 100644 index e5bdc23e7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_execution_result_header.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_result_header import AttributeResultHeader - globals()['AttributeResultHeader'] = AttributeResultHeader - - -class AttributeExecutionResultHeader(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute_header': (AttributeResultHeader,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute_header': 'attributeHeader', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute_header, *args, **kwargs): # noqa: E501 - """AttributeExecutionResultHeader - a model defined in OpenAPI - - Args: - attribute_header (AttributeResultHeader): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute_header = attribute_header - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attribute_header, *args, **kwargs): # noqa: E501 - """AttributeExecutionResultHeader - a model defined in OpenAPI - - Args: - attribute_header (AttributeResultHeader): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute_header = attribute_header - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_execution_result_header.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_execution_result_header.pyi index 6ea1dd497..49b50f656 100644 --- a/gooddata-api-client/gooddata_api_client/model/attribute_execution_result_header.pyi +++ b/gooddata-api-client/gooddata_api_client/model/attribute_execution_result_header.pyi @@ -38,38 +38,38 @@ class AttributeExecutionResultHeader( required = { "attributeHeader", } - + class properties: - + @staticmethod def attributeHeader() -> typing.Type['AttributeResultHeader']: return AttributeResultHeader __annotations__ = { "attributeHeader": attributeHeader, } - + attributeHeader: 'AttributeResultHeader' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributeHeader"]) -> 'AttributeResultHeader': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributeHeader", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributeHeader"]) -> 'AttributeResultHeader': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributeHeader", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class AttributeExecutionResultHeader( **kwargs, ) -from gooddata_api_client.model.attribute_result_header import AttributeResultHeader +from gooddata_api_client.models.attribute_result_header import AttributeResultHeader diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/attribute_filter.py deleted file mode 100644 index d5d414e70..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_filter.py +++ /dev/null @@ -1,331 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.negative_attribute_filter import NegativeAttributeFilter - from gooddata_api_client.model.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter - from gooddata_api_client.model.positive_attribute_filter import PositiveAttributeFilter - from gooddata_api_client.model.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter - globals()['NegativeAttributeFilter'] = NegativeAttributeFilter - globals()['NegativeAttributeFilterNegativeAttributeFilter'] = NegativeAttributeFilterNegativeAttributeFilter - globals()['PositiveAttributeFilter'] = PositiveAttributeFilter - globals()['PositiveAttributeFilterPositiveAttributeFilter'] = PositiveAttributeFilterPositiveAttributeFilter - - -class AttributeFilter(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 - 'positive_attribute_filter': (PositiveAttributeFilterPositiveAttributeFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 - 'positive_attribute_filter': 'positiveAttributeFilter', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AttributeFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AttributeFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - NegativeAttributeFilter, - PositiveAttributeFilter, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_filter.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_filter.pyi index aad881b79..92321e0d4 100644 --- a/gooddata-api-client/gooddata_api_client/model/attribute_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/attribute_filter.pyi @@ -38,7 +38,7 @@ class AttributeFilter( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -68,5 +68,5 @@ class AttributeFilter( **kwargs, ) -from gooddata_api_client.model.negative_attribute_filter import NegativeAttributeFilter -from gooddata_api_client.model.positive_attribute_filter import PositiveAttributeFilter +from gooddata_api_client.models.negative_attribute_filter import NegativeAttributeFilter +from gooddata_api_client.models.positive_attribute_filter import PositiveAttributeFilter diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_filter_by_date.py b/gooddata-api-client/gooddata_api_client/model/attribute_filter_by_date.py deleted file mode 100644 index 33d155c5c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_filter_by_date.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AttributeFilterByDate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'filter_local_identifier': (str,), # noqa: E501 - 'is_common_date': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'filter_local_identifier': 'filterLocalIdentifier', # noqa: E501 - 'is_common_date': 'isCommonDate', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, filter_local_identifier, is_common_date, *args, **kwargs): # noqa: E501 - """AttributeFilterByDate - a model defined in OpenAPI - - Args: - filter_local_identifier (str): - is_common_date (bool): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter_local_identifier = filter_local_identifier - self.is_common_date = is_common_date - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, filter_local_identifier, is_common_date, *args, **kwargs): # noqa: E501 - """AttributeFilterByDate - a model defined in OpenAPI - - Args: - filter_local_identifier (str): - is_common_date (bool): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter_local_identifier = filter_local_identifier - self.is_common_date = is_common_date - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_filter_elements.py b/gooddata-api-client/gooddata_api_client/model/attribute_filter_elements.py deleted file mode 100644 index 70774d3c5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_filter_elements.py +++ /dev/null @@ -1,272 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AttributeFilterElements(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('values',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'values': ([str, none_type],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'values': 'values', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, values, *args, **kwargs): # noqa: E501 - """AttributeFilterElements - a model defined in OpenAPI - - Args: - values ([str, none_type]): Set of label values. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.values = values - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, values, *args, **kwargs): # noqa: E501 - """AttributeFilterElements - a model defined in OpenAPI - - Args: - values ([str, none_type]): Set of label values. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.values = values - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_filter_parent.py b/gooddata-api-client/gooddata_api_client/model/attribute_filter_parent.py deleted file mode 100644 index 9b069ce24..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_filter_parent.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.over import Over - globals()['Over'] = Over - - -class AttributeFilterParent(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'filter_local_identifier': (str,), # noqa: E501 - 'over': (Over,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'filter_local_identifier': 'filterLocalIdentifier', # noqa: E501 - 'over': 'over', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, filter_local_identifier, over, *args, **kwargs): # noqa: E501 - """AttributeFilterParent - a model defined in OpenAPI - - Args: - filter_local_identifier (str): - over (Over): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter_local_identifier = filter_local_identifier - self.over = over - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, filter_local_identifier, over, *args, **kwargs): # noqa: E501 - """AttributeFilterParent - a model defined in OpenAPI - - Args: - filter_local_identifier (str): - over (Over): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter_local_identifier = filter_local_identifier - self.over = over - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_format.py b/gooddata-api-client/gooddata_api_client/model/attribute_format.py deleted file mode 100644 index 013d9636e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_format.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AttributeFormat(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'locale': (str,), # noqa: E501 - 'pattern': (str,), # noqa: E501 - 'timezone': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'locale': 'locale', # noqa: E501 - 'pattern': 'pattern', # noqa: E501 - 'timezone': 'timezone', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, locale, pattern, *args, **kwargs): # noqa: E501 - """AttributeFormat - a model defined in OpenAPI - - Args: - locale (str): Format locale code like 'en-US', 'cs-CZ', etc. - pattern (str): ICU formatting pattern like 'y', 'dd.MM.y', etc. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - timezone (str): Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.locale = locale - self.pattern = pattern - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, locale, pattern, *args, **kwargs): # noqa: E501 - """AttributeFormat - a model defined in OpenAPI - - Args: - locale (str): Format locale code like 'en-US', 'cs-CZ', etc. - pattern (str): ICU formatting pattern like 'y', 'dd.MM.y', etc. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - timezone (str): Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.locale = locale - self.pattern = pattern - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_header.py b/gooddata-api-client/gooddata_api_client/model/attribute_header.py deleted file mode 100644 index 7ae9f438b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_header.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_header_attribute_header import AttributeHeaderAttributeHeader - globals()['AttributeHeaderAttributeHeader'] = AttributeHeaderAttributeHeader - - -class AttributeHeader(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute_header': (AttributeHeaderAttributeHeader,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute_header': 'attributeHeader', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute_header, *args, **kwargs): # noqa: E501 - """AttributeHeader - a model defined in OpenAPI - - Args: - attribute_header (AttributeHeaderAttributeHeader): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute_header = attribute_header - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attribute_header, *args, **kwargs): # noqa: E501 - """AttributeHeader - a model defined in OpenAPI - - Args: - attribute_header (AttributeHeaderAttributeHeader): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute_header = attribute_header - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py b/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py deleted file mode 100644 index e68e79c9d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py +++ /dev/null @@ -1,351 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_format import AttributeFormat - from gooddata_api_client.model.rest_api_identifier import RestApiIdentifier - globals()['AttributeFormat'] = AttributeFormat - globals()['RestApiIdentifier'] = RestApiIdentifier - - -class AttributeHeaderAttributeHeader(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularity',): { - 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", - 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", - 'HOUR_OF_DAY': "HOUR_OF_DAY", - 'DAY_OF_WEEK': "DAY_OF_WEEK", - 'DAY_OF_MONTH': "DAY_OF_MONTH", - 'DAY_OF_QUARTER': "DAY_OF_QUARTER", - 'DAY_OF_YEAR': "DAY_OF_YEAR", - 'WEEK_OF_YEAR': "WEEK_OF_YEAR", - 'MONTH_OF_YEAR': "MONTH_OF_YEAR", - 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", - }, - ('value_type',): { - 'TEXT': "TEXT", - 'HYPERLINK': "HYPERLINK", - 'GEO': "GEO", - 'GEO_LONGITUDE': "GEO_LONGITUDE", - 'GEO_LATITUDE': "GEO_LATITUDE", - 'IMAGE': "IMAGE", - }, - } - - validations = { - ('local_identifier',): { - 'regex': { - 'pattern': r'^[.a-zA-Z0-9_-]+$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute': (RestApiIdentifier,), # noqa: E501 - 'attribute_name': (str,), # noqa: E501 - 'label': (RestApiIdentifier,), # noqa: E501 - 'label_name': (str,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - 'primary_label': (RestApiIdentifier,), # noqa: E501 - 'format': (AttributeFormat,), # noqa: E501 - 'granularity': (str,), # noqa: E501 - 'value_type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute': 'attribute', # noqa: E501 - 'attribute_name': 'attributeName', # noqa: E501 - 'label': 'label', # noqa: E501 - 'label_name': 'labelName', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - 'primary_label': 'primaryLabel', # noqa: E501 - 'format': 'format', # noqa: E501 - 'granularity': 'granularity', # noqa: E501 - 'value_type': 'valueType', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute, attribute_name, label, label_name, local_identifier, primary_label, *args, **kwargs): # noqa: E501 - """AttributeHeaderAttributeHeader - a model defined in OpenAPI - - Args: - attribute (RestApiIdentifier): - attribute_name (str): Attribute name. - label (RestApiIdentifier): - label_name (str): Label name. - local_identifier (str): Local identifier of the attribute this header relates to. - primary_label (RestApiIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (AttributeFormat): [optional] # noqa: E501 - granularity (str): Date granularity of the attribute, only filled for date attributes.. [optional] # noqa: E501 - value_type (str): Attribute value type.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - self.attribute_name = attribute_name - self.label = label - self.label_name = label_name - self.local_identifier = local_identifier - self.primary_label = primary_label - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attribute, attribute_name, label, label_name, local_identifier, primary_label, *args, **kwargs): # noqa: E501 - """AttributeHeaderAttributeHeader - a model defined in OpenAPI - - Args: - attribute (RestApiIdentifier): - attribute_name (str): Attribute name. - label (RestApiIdentifier): - label_name (str): Label name. - local_identifier (str): Local identifier of the attribute this header relates to. - primary_label (RestApiIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (AttributeFormat): [optional] # noqa: E501 - granularity (str): Date granularity of the attribute, only filled for date attributes.. [optional] # noqa: E501 - value_type (str): Attribute value type.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - self.attribute_name = attribute_name - self.label = label - self.label_name = label_name - self.local_identifier = local_identifier - self.primary_label = primary_label - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_header_out.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_header_out.pyi index 4b8a265de..7aaa5a7df 100644 --- a/gooddata-api-client/gooddata_api_client/model/attribute_header_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/attribute_header_out.pyi @@ -38,15 +38,15 @@ class AttributeHeaderOut( required = { "attributeHeader", } - + class properties: - - + + class attributeHeader( schemas.DictSchema ): - - + + class MetaOapg: required = { "primaryLabel", @@ -56,95 +56,95 @@ class AttributeHeaderOut( "label", "labelName", } - + class properties: - + @staticmethod def attribute() -> typing.Type['RestApiIdentifier']: return RestApiIdentifier attributeName = schemas.StrSchema - + @staticmethod def format() -> typing.Type['AttributeFormat']: return AttributeFormat - - + + class granularity( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def MINUTE(cls): return cls("MINUTE") - + @schemas.classproperty def HOUR(cls): return cls("HOUR") - + @schemas.classproperty def DAY(cls): return cls("DAY") - + @schemas.classproperty def WEEK(cls): return cls("WEEK") - + @schemas.classproperty def MONTH(cls): return cls("MONTH") - + @schemas.classproperty def QUARTER(cls): return cls("QUARTER") - + @schemas.classproperty def YEAR(cls): return cls("YEAR") - + @schemas.classproperty def MINUTE_OF_HOUR(cls): return cls("MINUTE_OF_HOUR") - + @schemas.classproperty def HOUR_OF_DAY(cls): return cls("HOUR_OF_DAY") - + @schemas.classproperty def DAY_OF_WEEK(cls): return cls("DAY_OF_WEEK") - + @schemas.classproperty def DAY_OF_MONTH(cls): return cls("DAY_OF_MONTH") - + @schemas.classproperty def DAY_OF_YEAR(cls): return cls("DAY_OF_YEAR") - + @schemas.classproperty def WEEK_OF_YEAR(cls): return cls("WEEK_OF_YEAR") - + @schemas.classproperty def MONTH_OF_YEAR(cls): return cls("MONTH_OF_YEAR") - + @schemas.classproperty def QUARTER_OF_YEAR(cls): return cls("QUARTER_OF_YEAR") - + @staticmethod def label() -> typing.Type['RestApiIdentifier']: return RestApiIdentifier labelName = schemas.StrSchema - - + + class localIdentifier( schemas.StrSchema ): pass - + @staticmethod def primaryLabel() -> typing.Type['RestApiIdentifier']: return RestApiIdentifier @@ -158,77 +158,77 @@ class AttributeHeaderOut( "localIdentifier": localIdentifier, "primaryLabel": primaryLabel, } - + primaryLabel: 'RestApiIdentifier' localIdentifier: MetaOapg.properties.localIdentifier attributeName: MetaOapg.properties.attributeName attribute: 'RestApiIdentifier' label: 'RestApiIdentifier' labelName: MetaOapg.properties.labelName - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> 'RestApiIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributeName"]) -> MetaOapg.properties.attributeName: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["format"]) -> 'AttributeFormat': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["label"]) -> 'RestApiIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["labelName"]) -> MetaOapg.properties.labelName: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["primaryLabel"]) -> 'RestApiIdentifier': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attribute", "attributeName", "format", "granularity", "label", "labelName", "localIdentifier", "primaryLabel", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> 'RestApiIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributeName"]) -> MetaOapg.properties.attributeName: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> typing.Union['AttributeFormat', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> typing.Union[MetaOapg.properties.granularity, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["label"]) -> 'RestApiIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["labelName"]) -> MetaOapg.properties.labelName: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["primaryLabel"]) -> 'RestApiIdentifier': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attribute", "attributeName", "format", "granularity", "label", "labelName", "localIdentifier", "primaryLabel", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -260,29 +260,29 @@ class AttributeHeaderOut( __annotations__ = { "attributeHeader": attributeHeader, } - + attributeHeader: MetaOapg.properties.attributeHeader - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributeHeader"]) -> MetaOapg.properties.attributeHeader: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributeHeader", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributeHeader"]) -> MetaOapg.properties.attributeHeader: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributeHeader", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -299,5 +299,5 @@ class AttributeHeaderOut( **kwargs, ) -from gooddata_api_client.model.attribute_format import AttributeFormat -from gooddata_api_client.model.rest_api_identifier import RestApiIdentifier +from gooddata_api_client.models.attribute_format import AttributeFormat +from gooddata_api_client.models.rest_api_identifier import RestApiIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_item.py b/gooddata-api-client/gooddata_api_client/model/attribute_item.py deleted file mode 100644 index 0f47c104a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_item.py +++ /dev/null @@ -1,291 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_label import AfmObjectIdentifierLabel - globals()['AfmObjectIdentifierLabel'] = AfmObjectIdentifierLabel - - -class AttributeItem(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('local_identifier',): { - 'regex': { - 'pattern': r'^[.a-zA-Z0-9_-]+$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'label': (AfmObjectIdentifierLabel,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - 'show_all_values': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'label': 'label', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - 'show_all_values': 'showAllValues', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, label, local_identifier, *args, **kwargs): # noqa: E501 - """AttributeItem - a model defined in OpenAPI - - Args: - label (AfmObjectIdentifierLabel): - local_identifier (str): Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - show_all_values (bool): Indicates whether to show all values of given attribute even if the data bound to those values is not available.. [optional] if omitted the server will use the default value of False # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.label = label - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, label, local_identifier, *args, **kwargs): # noqa: E501 - """AttributeItem - a model defined in OpenAPI - - Args: - label (AfmObjectIdentifierLabel): - local_identifier (str): Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - show_all_values (bool): Indicates whether to show all values of given attribute even if the data bound to those values is not available.. [optional] if omitted the server will use the default value of False # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.label = label - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_item.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_item.pyi index 3b5f99a1c..5580764ef 100644 --- a/gooddata-api-client/gooddata_api_client/model/attribute_item.pyi +++ b/gooddata-api-client/gooddata_api_client/model/attribute_item.pyi @@ -39,14 +39,14 @@ class AttributeItem( "localIdentifier", "label", } - + class properties: - + @staticmethod def label() -> typing.Type['AfmObjectIdentifierLabel']: return AfmObjectIdentifierLabel - - + + class localIdentifier( schemas.StrSchema ): @@ -57,42 +57,42 @@ class AttributeItem( "localIdentifier": localIdentifier, "showAllValues": showAllValues, } - + localIdentifier: MetaOapg.properties.localIdentifier label: 'AfmObjectIdentifierLabel' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["label"]) -> 'AfmObjectIdentifierLabel': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["showAllValues"]) -> MetaOapg.properties.showAllValues: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["label", "localIdentifier", "showAllValues", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["label"]) -> 'AfmObjectIdentifierLabel': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["showAllValues"]) -> typing.Union[MetaOapg.properties.showAllValues, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["label", "localIdentifier", "showAllValues", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -113,4 +113,4 @@ class AttributeItem( **kwargs, ) -from gooddata_api_client.model.afm_object_identifier_label import AfmObjectIdentifierLabel +from gooddata_api_client.models.afm_object_identifier_label import AfmObjectIdentifierLabel diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter.py b/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter.py deleted file mode 100644 index 17bf8fe2d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_negative_filter_all_of import AttributeNegativeFilterAllOf - from gooddata_api_client.model.filter import Filter - globals()['AttributeNegativeFilterAllOf'] = AttributeNegativeFilterAllOf - globals()['Filter'] = Filter - - -class AttributeNegativeFilter(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'exclude': ([str],), # noqa: E501 - 'using': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'exclude': 'exclude', # noqa: E501 - 'using': 'using', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AttributeNegativeFilter - a model defined in OpenAPI - - Keyword Args: - exclude ([str]): - using (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AttributeNegativeFilter - a model defined in OpenAPI - - Keyword Args: - exclude ([str]): - using (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - AttributeNegativeFilterAllOf, - Filter, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter_all_of.py deleted file mode 100644 index 5de3703ba..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter_all_of.py +++ /dev/null @@ -1,268 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AttributeNegativeFilterAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'exclude': ([str],), # noqa: E501 - 'using': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'exclude': 'exclude', # noqa: E501 - 'using': 'using', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AttributeNegativeFilterAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - exclude ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AttributeNegativeFilterAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - exclude ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter.py b/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter.py deleted file mode 100644 index 41fb58cd0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_positive_filter_all_of import AttributePositiveFilterAllOf - from gooddata_api_client.model.filter import Filter - globals()['AttributePositiveFilterAllOf'] = AttributePositiveFilterAllOf - globals()['Filter'] = Filter - - -class AttributePositiveFilter(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'include': ([str],), # noqa: E501 - 'using': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'include': 'include', # noqa: E501 - 'using': 'using', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AttributePositiveFilter - a model defined in OpenAPI - - Keyword Args: - include ([str]): - using (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AttributePositiveFilter - a model defined in OpenAPI - - Keyword Args: - include ([str]): - using (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - AttributePositiveFilterAllOf, - Filter, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter_all_of.py deleted file mode 100644 index 40a51c1f0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter_all_of.py +++ /dev/null @@ -1,268 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AttributePositiveFilterAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'include': ([str],), # noqa: E501 - 'using': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'include': 'include', # noqa: E501 - 'using': 'using', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AttributePositiveFilterAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - include ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AttributePositiveFilterAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - include ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_result_header.py b/gooddata-api-client/gooddata_api_client/model/attribute_result_header.py deleted file mode 100644 index 3e5789bb1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_result_header.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AttributeResultHeader(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'label_value': (str,), # noqa: E501 - 'primary_label_value': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'label_value': 'labelValue', # noqa: E501 - 'primary_label_value': 'primaryLabelValue', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, label_value, primary_label_value, *args, **kwargs): # noqa: E501 - """AttributeResultHeader - a model defined in OpenAPI - - Args: - label_value (str): A value of the current attribute label. - primary_label_value (str): A value of the primary attribute label. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.label_value = label_value - self.primary_label_value = primary_label_value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, label_value, primary_label_value, *args, **kwargs): # noqa: E501 - """AttributeResultHeader - a model defined in OpenAPI - - Args: - label_value (str): A value of the current attribute label. - primary_label_value (str): A value of the primary attribute label. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.label_value = label_value - self.primary_label_value = primary_label_value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_alert.py b/gooddata-api-client/gooddata_api_client/model/automation_alert.py deleted file mode 100644 index 6c9b2952d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_alert.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.alert_afm import AlertAfm - from gooddata_api_client.model.automation_alert_condition import AutomationAlertCondition - globals()['AlertAfm'] = AlertAfm - globals()['AutomationAlertCondition'] = AutomationAlertCondition - - -class AutomationAlert(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('trigger',): { - 'ALWAYS': "ALWAYS", - 'ONCE': "ONCE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'condition': (AutomationAlertCondition,), # noqa: E501 - 'execution': (AlertAfm,), # noqa: E501 - 'trigger': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'condition': 'condition', # noqa: E501 - 'execution': 'execution', # noqa: E501 - 'trigger': 'trigger', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, condition, execution, *args, **kwargs): # noqa: E501 - """AutomationAlert - a model defined in OpenAPI - - Args: - condition (AutomationAlertCondition): - execution (AlertAfm): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.condition = condition - self.execution = execution - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, condition, execution, *args, **kwargs): # noqa: E501 - """AutomationAlert - a model defined in OpenAPI - - Args: - condition (AutomationAlertCondition): - execution (AlertAfm): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.condition = condition - self.execution = execution - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_alert_condition.py b/gooddata-api-client/gooddata_api_client/model/automation_alert_condition.py deleted file mode 100644 index b70261b9f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_alert_condition.py +++ /dev/null @@ -1,340 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.comparison import Comparison - from gooddata_api_client.model.comparison_wrapper import ComparisonWrapper - from gooddata_api_client.model.range import Range - from gooddata_api_client.model.range_wrapper import RangeWrapper - from gooddata_api_client.model.relative import Relative - from gooddata_api_client.model.relative_wrapper import RelativeWrapper - globals()['Comparison'] = Comparison - globals()['ComparisonWrapper'] = ComparisonWrapper - globals()['Range'] = Range - globals()['RangeWrapper'] = RangeWrapper - globals()['Relative'] = Relative - globals()['RelativeWrapper'] = RelativeWrapper - - -class AutomationAlertCondition(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'comparison': (Comparison,), # noqa: E501 - 'range': (Range,), # noqa: E501 - 'relative': (Relative,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'comparison': 'comparison', # noqa: E501 - 'range': 'range', # noqa: E501 - 'relative': 'relative', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AutomationAlertCondition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - comparison (Comparison): [optional] # noqa: E501 - range (Range): [optional] # noqa: E501 - relative (Relative): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AutomationAlertCondition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - comparison (Comparison): [optional] # noqa: E501 - range (Range): [optional] # noqa: E501 - relative (Relative): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - ComparisonWrapper, - RangeWrapper, - RelativeWrapper, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/automation_dashboard_tabular_export.py b/gooddata-api-client/gooddata_api_client/model/automation_dashboard_tabular_export.py deleted file mode 100644 index bbac0564c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_dashboard_tabular_export.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 - globals()['DashboardTabularExportRequestV2'] = DashboardTabularExportRequestV2 - - -class AutomationDashboardTabularExport(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (DashboardTabularExportRequestV2,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """AutomationDashboardTabularExport - a model defined in OpenAPI - - Args: - request_payload (DashboardTabularExportRequestV2): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """AutomationDashboardTabularExport - a model defined in OpenAPI - - Args: - request_payload (DashboardTabularExportRequestV2): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_external_recipient.py b/gooddata-api-client/gooddata_api_client/model/automation_external_recipient.py deleted file mode 100644 index 0a99e64a5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_external_recipient.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AutomationExternalRecipient(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'email': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'email': 'email', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, email, *args, **kwargs): # noqa: E501 - """AutomationExternalRecipient - a model defined in OpenAPI - - Args: - email (str): E-mail address to send notifications from. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.email = email - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, email, *args, **kwargs): # noqa: E501 - """AutomationExternalRecipient - a model defined in OpenAPI - - Args: - email (str): E-mail address to send notifications from. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.email = email - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_image_export.py b/gooddata-api-client/gooddata_api_client/model/automation_image_export.py deleted file mode 100644 index 56f80eeca..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_image_export.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.image_export_request import ImageExportRequest - globals()['ImageExportRequest'] = ImageExportRequest - - -class AutomationImageExport(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (ImageExportRequest,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """AutomationImageExport - a model defined in OpenAPI - - Args: - request_payload (ImageExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """AutomationImageExport - a model defined in OpenAPI - - Args: - request_payload (ImageExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_metadata.py b/gooddata-api-client/gooddata_api_client/model/automation_metadata.py deleted file mode 100644 index 126e12971..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_metadata.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.visible_filter import VisibleFilter - globals()['VisibleFilter'] = VisibleFilter - - -class AutomationMetadata(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('value',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'visible_filters': ([VisibleFilter],), # noqa: E501 - 'widget': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'visible_filters': 'visibleFilters', # noqa: E501 - 'widget': 'widget', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AutomationMetadata - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - visible_filters ([VisibleFilter]): [optional] # noqa: E501 - widget (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AutomationMetadata - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - visible_filters ([VisibleFilter]): [optional] # noqa: E501 - widget (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_notification.py b/gooddata-api-client/gooddata_api_client/model/automation_notification.py deleted file mode 100644 index 461a3f29a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_notification.py +++ /dev/null @@ -1,339 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.automation_notification import AutomationNotification - from gooddata_api_client.model.automation_notification_all_of import AutomationNotificationAllOf - from gooddata_api_client.model.notification_content import NotificationContent - from gooddata_api_client.model.test_notification import TestNotification - from gooddata_api_client.model.webhook_message import WebhookMessage - globals()['AutomationNotification'] = AutomationNotification - globals()['AutomationNotificationAllOf'] = AutomationNotificationAllOf - globals()['NotificationContent'] = NotificationContent - globals()['TestNotification'] = TestNotification - globals()['WebhookMessage'] = WebhookMessage - - -class AutomationNotification(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (WebhookMessage,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - lazy_import() - val = { - 'AUTOMATION': AutomationNotification, - 'TEST': TestNotification, - } - if not val: - return None - return {'type': val} - - attribute_map = { - 'content': 'content', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AutomationNotification - a model defined in OpenAPI - - Keyword Args: - content (WebhookMessage): - type (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AutomationNotification - a model defined in OpenAPI - - Keyword Args: - content (WebhookMessage): - type (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - AutomationNotificationAllOf, - NotificationContent, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/automation_notification_all_of.py b/gooddata-api-client/gooddata_api_client/model/automation_notification_all_of.py deleted file mode 100644 index 3186eca1a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_notification_all_of.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.webhook_message import WebhookMessage - globals()['WebhookMessage'] = WebhookMessage - - -class AutomationNotificationAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (WebhookMessage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AutomationNotificationAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content (WebhookMessage): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AutomationNotificationAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content (WebhookMessage): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_raw_export.py b/gooddata-api-client/gooddata_api_client/model/automation_raw_export.py deleted file mode 100644 index 62189f922..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_raw_export.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.raw_export_automation_request import RawExportAutomationRequest - globals()['RawExportAutomationRequest'] = RawExportAutomationRequest - - -class AutomationRawExport(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (RawExportAutomationRequest,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """AutomationRawExport - a model defined in OpenAPI - - Args: - request_payload (RawExportAutomationRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """AutomationRawExport - a model defined in OpenAPI - - Args: - request_payload (RawExportAutomationRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_schedule.py b/gooddata-api-client/gooddata_api_client/model/automation_schedule.py deleted file mode 100644 index 391cbce13..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_schedule.py +++ /dev/null @@ -1,291 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AutomationSchedule(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('cron',): { - 'max_length': 255, - }, - ('timezone',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'cron': (str,), # noqa: E501 - 'timezone': (str,), # noqa: E501 - 'cron_description': (str,), # noqa: E501 - 'first_run': (datetime,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'cron': 'cron', # noqa: E501 - 'timezone': 'timezone', # noqa: E501 - 'cron_description': 'cronDescription', # noqa: E501 - 'first_run': 'firstRun', # noqa: E501 - } - - read_only_vars = { - 'cron_description', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, cron, timezone, *args, **kwargs): # noqa: E501 - """AutomationSchedule - a model defined in OpenAPI - - Args: - cron (str): Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays. - timezone (str): Timezone in which the schedule is defined. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cron_description (str): Human-readable description of the cron expression.. [optional] # noqa: E501 - first_run (datetime): Timestamp of the first scheduled action. If not provided default to the next scheduled time.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.cron = cron - self.timezone = timezone - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, cron, timezone, *args, **kwargs): # noqa: E501 - """AutomationSchedule - a model defined in OpenAPI - - Args: - cron (str): Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays. - timezone (str): Timezone in which the schedule is defined. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cron_description (str): Human-readable description of the cron expression.. [optional] # noqa: E501 - first_run (datetime): Timestamp of the first scheduled action. If not provided default to the next scheduled time.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.cron = cron - self.timezone = timezone - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_slides_export.py b/gooddata-api-client/gooddata_api_client/model/automation_slides_export.py deleted file mode 100644 index bdc92d964..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_slides_export.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.slides_export_request import SlidesExportRequest - globals()['SlidesExportRequest'] = SlidesExportRequest - - -class AutomationSlidesExport(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (SlidesExportRequest,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """AutomationSlidesExport - a model defined in OpenAPI - - Args: - request_payload (SlidesExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """AutomationSlidesExport - a model defined in OpenAPI - - Args: - request_payload (SlidesExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_tabular_export.py b/gooddata-api-client/gooddata_api_client/model/automation_tabular_export.py deleted file mode 100644 index 512dd3c46..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_tabular_export.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.tabular_export_request import TabularExportRequest - globals()['TabularExportRequest'] = TabularExportRequest - - -class AutomationTabularExport(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (TabularExportRequest,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """AutomationTabularExport - a model defined in OpenAPI - - Args: - request_payload (TabularExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """AutomationTabularExport - a model defined in OpenAPI - - Args: - request_payload (TabularExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_visual_export.py b/gooddata-api-client/gooddata_api_client/model/automation_visual_export.py deleted file mode 100644 index cfffcd83d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/automation_visual_export.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.visual_export_request import VisualExportRequest - globals()['VisualExportRequest'] = VisualExportRequest - - -class AutomationVisualExport(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (VisualExportRequest,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """AutomationVisualExport - a model defined in OpenAPI - - Args: - request_payload (VisualExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """AutomationVisualExport - a model defined in OpenAPI - - Args: - request_payload (VisualExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/available_assignees.py b/gooddata-api-client/gooddata_api_client/model/available_assignees.py deleted file mode 100644 index 36b73979a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/available_assignees.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.user_assignee import UserAssignee - from gooddata_api_client.model.user_group_assignee import UserGroupAssignee - globals()['UserAssignee'] = UserAssignee - globals()['UserGroupAssignee'] = UserGroupAssignee - - -class AvailableAssignees(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'user_groups': ([UserGroupAssignee],), # noqa: E501 - 'users': ([UserAssignee],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'user_groups': 'userGroups', # noqa: E501 - 'users': 'users', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, user_groups, users, *args, **kwargs): # noqa: E501 - """AvailableAssignees - a model defined in OpenAPI - - Args: - user_groups ([UserGroupAssignee]): List of user groups - users ([UserAssignee]): List of users - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.user_groups = user_groups - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, user_groups, users, *args, **kwargs): # noqa: E501 - """AvailableAssignees - a model defined in OpenAPI - - Args: - user_groups ([UserGroupAssignee]): List of user groups - users ([UserAssignee]): List of users - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.user_groups = user_groups - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/available_assignees.pyi b/gooddata-api-client/gooddata_api_client/model/available_assignees.pyi index 379316057..decd2ccb2 100644 --- a/gooddata-api-client/gooddata_api_client/model/available_assignees.pyi +++ b/gooddata-api-client/gooddata_api_client/model/available_assignees.pyi @@ -39,21 +39,21 @@ class AvailableAssignees( "userGroups", "users", } - + class properties: - - + + class userGroups( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['UserGroupAssignee']: return UserGroupAssignee - + def __new__( cls, _arg: typing.Union[typing.Tuple['UserGroupAssignee'], typing.List['UserGroupAssignee']], @@ -64,22 +64,22 @@ class AvailableAssignees( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'UserGroupAssignee': return super().__getitem__(i) - - + + class users( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['UserAssignee']: return UserAssignee - + def __new__( cls, _arg: typing.Union[typing.Tuple['UserAssignee'], typing.List['UserAssignee']], @@ -90,43 +90,43 @@ class AvailableAssignees( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'UserAssignee': return super().__getitem__(i) __annotations__ = { "userGroups": userGroups, "users": users, } - + userGroups: MetaOapg.properties.userGroups users: MetaOapg.properties.users - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["userGroups", "users", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userGroups", "users", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -145,5 +145,5 @@ class AvailableAssignees( **kwargs, ) -from gooddata_api_client.model.user_assignee import UserAssignee -from gooddata_api_client.model.user_group_assignee import UserGroupAssignee +from gooddata_api_client.models.user_assignee import UserAssignee +from gooddata_api_client.models.user_group_assignee import UserGroupAssignee diff --git a/gooddata-api-client/gooddata_api_client/model/bounded_filter.py b/gooddata-api-client/gooddata_api_client/model/bounded_filter.py deleted file mode 100644 index 45d4ec449..000000000 --- a/gooddata-api-client/gooddata_api_client/model/bounded_filter.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class BoundedFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularity',): { - 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", - 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", - 'HOUR_OF_DAY': "HOUR_OF_DAY", - 'DAY_OF_WEEK': "DAY_OF_WEEK", - 'DAY_OF_MONTH': "DAY_OF_MONTH", - 'DAY_OF_QUARTER': "DAY_OF_QUARTER", - 'DAY_OF_YEAR': "DAY_OF_YEAR", - 'WEEK_OF_YEAR': "WEEK_OF_YEAR", - 'MONTH_OF_YEAR': "MONTH_OF_YEAR", - 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'granularity': (str,), # noqa: E501 - '_from': (int, none_type,), # noqa: E501 - 'to': (int, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'granularity': 'granularity', # noqa: E501 - '_from': 'from', # noqa: E501 - 'to': 'to', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, granularity, *args, **kwargs): # noqa: E501 - """BoundedFilter - a model defined in OpenAPI - - Args: - granularity (str): Date granularity specifying particular date attribute in given dimension. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - _from (int, none_type): Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.. [optional] # noqa: E501 - to (int, none_type): End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.granularity = granularity - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, granularity, *args, **kwargs): # noqa: E501 - """BoundedFilter - a model defined in OpenAPI - - Args: - granularity (str): Date granularity specifying particular date attribute in given dimension. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - _from (int, none_type): Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.. [optional] # noqa: E501 - to (int, none_type): End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.granularity = granularity - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.py b/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.py deleted file mode 100644 index b2af5d1c0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.py +++ /dev/null @@ -1,330 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.created_visualizations import CreatedVisualizations - from gooddata_api_client.model.found_objects import FoundObjects - from gooddata_api_client.model.route_result import RouteResult - globals()['CreatedVisualizations'] = CreatedVisualizations - globals()['FoundObjects'] = FoundObjects - globals()['RouteResult'] = RouteResult - - -class ChatHistoryInteraction(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('user_feedback',): { - 'POSITIVE': "POSITIVE", - 'NEGATIVE': "NEGATIVE", - 'NONE': "NONE", - }, - } - - validations = { - ('question',): { - 'max_length': 2000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'chat_history_interaction_id': (str,), # noqa: E501 - 'interaction_finished': (bool,), # noqa: E501 - 'question': (str,), # noqa: E501 - 'routing': (RouteResult,), # noqa: E501 - 'created_visualizations': (CreatedVisualizations,), # noqa: E501 - 'error_response': (str,), # noqa: E501 - 'found_objects': (FoundObjects,), # noqa: E501 - 'text_response': (str,), # noqa: E501 - 'thread_id_suffix': (str,), # noqa: E501 - 'user_feedback': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'chat_history_interaction_id': 'chatHistoryInteractionId', # noqa: E501 - 'interaction_finished': 'interactionFinished', # noqa: E501 - 'question': 'question', # noqa: E501 - 'routing': 'routing', # noqa: E501 - 'created_visualizations': 'createdVisualizations', # noqa: E501 - 'error_response': 'errorResponse', # noqa: E501 - 'found_objects': 'foundObjects', # noqa: E501 - 'text_response': 'textResponse', # noqa: E501 - 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 - 'user_feedback': 'userFeedback', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, chat_history_interaction_id, interaction_finished, question, routing, *args, **kwargs): # noqa: E501 - """ChatHistoryInteraction - a model defined in OpenAPI - - Args: - chat_history_interaction_id (str): Chat History interaction ID. Unique ID for each interaction. - interaction_finished (bool): Has the interaction already finished? Can be used for polling when interaction is in progress. - question (str): User question - routing (RouteResult): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_visualizations (CreatedVisualizations): [optional] # noqa: E501 - error_response (str): Error response in anything fails.. [optional] # noqa: E501 - found_objects (FoundObjects): [optional] # noqa: E501 - text_response (str): Text response for general questions.. [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - user_feedback (str): User feedback.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.chat_history_interaction_id = chat_history_interaction_id - self.interaction_finished = interaction_finished - self.question = question - self.routing = routing - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, chat_history_interaction_id, interaction_finished, question, routing, *args, **kwargs): # noqa: E501 - """ChatHistoryInteraction - a model defined in OpenAPI - - Args: - chat_history_interaction_id (str): Chat History interaction ID. Unique ID for each interaction. - interaction_finished (bool): Has the interaction already finished? Can be used for polling when interaction is in progress. - question (str): User question - routing (RouteResult): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_visualizations (CreatedVisualizations): [optional] # noqa: E501 - error_response (str): Error response in anything fails.. [optional] # noqa: E501 - found_objects (FoundObjects): [optional] # noqa: E501 - text_response (str): Text response for general questions.. [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - user_feedback (str): User feedback.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.chat_history_interaction_id = chat_history_interaction_id - self.interaction_finished = interaction_finished - self.question = question - self.routing = routing - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/chat_history_request.py b/gooddata-api-client/gooddata_api_client/model/chat_history_request.py deleted file mode 100644 index 10819e2b1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/chat_history_request.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.saved_visualization import SavedVisualization - globals()['SavedVisualization'] = SavedVisualization - - -class ChatHistoryRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('response_state',): { - 'SUCCESSFUL': "SUCCESSFUL", - 'UNEXPECTED_ERROR': "UNEXPECTED_ERROR", - 'NOT_FOUND_ATTRIBUTES': "NOT_FOUND_ATTRIBUTES", - 'TOO_MANY_DATA_POINTS': "TOO_MANY_DATA_POINTS", - 'NO_DATA': "NO_DATA", - 'NO_RESULTS': "NO_RESULTS", - 'OUT_OF_TOPIC': "OUT_OF_TOPIC", - }, - ('user_feedback',): { - 'POSITIVE': "POSITIVE", - 'NEGATIVE': "NEGATIVE", - 'NONE': "NONE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'chat_history_interaction_id': (str,), # noqa: E501 - 'reset': (bool,), # noqa: E501 - 'response_state': (str,), # noqa: E501 - 'saved_visualization': (SavedVisualization,), # noqa: E501 - 'thread_id_suffix': (str,), # noqa: E501 - 'user_feedback': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'chat_history_interaction_id': 'chatHistoryInteractionId', # noqa: E501 - 'reset': 'reset', # noqa: E501 - 'response_state': 'responseState', # noqa: E501 - 'saved_visualization': 'savedVisualization', # noqa: E501 - 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 - 'user_feedback': 'userFeedback', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ChatHistoryRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - chat_history_interaction_id (str): Return chat history records only after this interaction ID. If empty, complete chat history is returned.. [optional] # noqa: E501 - reset (bool): User feedback.. [optional] # noqa: E501 - response_state (str): Response state indicating the outcome of the AI interaction.. [optional] # noqa: E501 - saved_visualization (SavedVisualization): [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - user_feedback (str): User feedback.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ChatHistoryRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - chat_history_interaction_id (str): Return chat history records only after this interaction ID. If empty, complete chat history is returned.. [optional] # noqa: E501 - reset (bool): User feedback.. [optional] # noqa: E501 - response_state (str): Response state indicating the outcome of the AI interaction.. [optional] # noqa: E501 - saved_visualization (SavedVisualization): [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - user_feedback (str): User feedback.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/chat_history_result.py b/gooddata-api-client/gooddata_api_client/model/chat_history_result.py deleted file mode 100644 index bb51900b6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/chat_history_result.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.chat_history_interaction import ChatHistoryInteraction - globals()['ChatHistoryInteraction'] = ChatHistoryInteraction - - -class ChatHistoryResult(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'interactions': ([ChatHistoryInteraction],), # noqa: E501 - 'thread_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'interactions': 'interactions', # noqa: E501 - 'thread_id': 'threadId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, interactions, thread_id, *args, **kwargs): # noqa: E501 - """ChatHistoryResult - a model defined in OpenAPI - - Args: - interactions ([ChatHistoryInteraction]): List of chat history interactions. - thread_id (str): The conversation thread ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.interactions = interactions - self.thread_id = thread_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, interactions, thread_id, *args, **kwargs): # noqa: E501 - """ChatHistoryResult - a model defined in OpenAPI - - Args: - interactions ([ChatHistoryInteraction]): List of chat history interactions. - thread_id (str): The conversation thread ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.interactions = interactions - self.thread_id = thread_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/chat_request.py b/gooddata-api-client/gooddata_api_client/model/chat_request.py deleted file mode 100644 index 8fa16a9ec..000000000 --- a/gooddata-api-client/gooddata_api_client/model/chat_request.py +++ /dev/null @@ -1,311 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.user_context import UserContext - globals()['UserContext'] = UserContext - - -class ChatRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('question',): { - 'max_length': 2000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'question': (str,), # noqa: E501 - 'limit_create': (int,), # noqa: E501 - 'limit_create_context': (int,), # noqa: E501 - 'limit_search': (int,), # noqa: E501 - 'relevant_score_threshold': (float,), # noqa: E501 - 'search_score_threshold': (float,), # noqa: E501 - 'thread_id_suffix': (str,), # noqa: E501 - 'title_to_descriptor_ratio': (float,), # noqa: E501 - 'user_context': (UserContext,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'question': 'question', # noqa: E501 - 'limit_create': 'limitCreate', # noqa: E501 - 'limit_create_context': 'limitCreateContext', # noqa: E501 - 'limit_search': 'limitSearch', # noqa: E501 - 'relevant_score_threshold': 'relevantScoreThreshold', # noqa: E501 - 'search_score_threshold': 'searchScoreThreshold', # noqa: E501 - 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 - 'title_to_descriptor_ratio': 'titleToDescriptorRatio', # noqa: E501 - 'user_context': 'userContext', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, question, *args, **kwargs): # noqa: E501 - """ChatRequest - a model defined in OpenAPI - - Args: - question (str): User question - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - limit_create (int): Maximum number of created results.. [optional] if omitted the server will use the default value of 3 # noqa: E501 - limit_create_context (int): Maximum number of relevant objects included into context for LLM (for each object type).. [optional] if omitted the server will use the default value of 10 # noqa: E501 - limit_search (int): Maximum number of search results.. [optional] if omitted the server will use the default value of 5 # noqa: E501 - relevant_score_threshold (float): Score, above which we return found objects. Below this score objects are not relevant.. [optional] if omitted the server will use the default value of 0.45 # noqa: E501 - search_score_threshold (float): Score, above which we return found object(s) and don't call LLM to create new objects.. [optional] if omitted the server will use the default value of 0.9 # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - title_to_descriptor_ratio (float): Temporary for experiments. Ratio of title score to descriptor score.. [optional] if omitted the server will use the default value of 0.7 # noqa: E501 - user_context (UserContext): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.question = question - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, question, *args, **kwargs): # noqa: E501 - """ChatRequest - a model defined in OpenAPI - - Args: - question (str): User question - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - limit_create (int): Maximum number of created results.. [optional] if omitted the server will use the default value of 3 # noqa: E501 - limit_create_context (int): Maximum number of relevant objects included into context for LLM (for each object type).. [optional] if omitted the server will use the default value of 10 # noqa: E501 - limit_search (int): Maximum number of search results.. [optional] if omitted the server will use the default value of 5 # noqa: E501 - relevant_score_threshold (float): Score, above which we return found objects. Below this score objects are not relevant.. [optional] if omitted the server will use the default value of 0.45 # noqa: E501 - search_score_threshold (float): Score, above which we return found object(s) and don't call LLM to create new objects.. [optional] if omitted the server will use the default value of 0.9 # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - title_to_descriptor_ratio (float): Temporary for experiments. Ratio of title score to descriptor score.. [optional] if omitted the server will use the default value of 0.7 # noqa: E501 - user_context (UserContext): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.question = question - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/chat_result.py b/gooddata-api-client/gooddata_api_client/model/chat_result.py deleted file mode 100644 index ac4dbf6da..000000000 --- a/gooddata-api-client/gooddata_api_client/model/chat_result.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.created_visualizations import CreatedVisualizations - from gooddata_api_client.model.found_objects import FoundObjects - from gooddata_api_client.model.route_result import RouteResult - globals()['CreatedVisualizations'] = CreatedVisualizations - globals()['FoundObjects'] = FoundObjects - globals()['RouteResult'] = RouteResult - - -class ChatResult(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'chat_history_interaction_id': (str,), # noqa: E501 - 'created_visualizations': (CreatedVisualizations,), # noqa: E501 - 'error_response': (str,), # noqa: E501 - 'found_objects': (FoundObjects,), # noqa: E501 - 'routing': (RouteResult,), # noqa: E501 - 'text_response': (str,), # noqa: E501 - 'thread_id_suffix': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'chat_history_interaction_id': 'chatHistoryInteractionId', # noqa: E501 - 'created_visualizations': 'createdVisualizations', # noqa: E501 - 'error_response': 'errorResponse', # noqa: E501 - 'found_objects': 'foundObjects', # noqa: E501 - 'routing': 'routing', # noqa: E501 - 'text_response': 'textResponse', # noqa: E501 - 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ChatResult - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - chat_history_interaction_id (str): Chat History interaction ID. Unique ID for each interaction.. [optional] # noqa: E501 - created_visualizations (CreatedVisualizations): [optional] # noqa: E501 - error_response (str): Error response in anything fails.. [optional] # noqa: E501 - found_objects (FoundObjects): [optional] # noqa: E501 - routing (RouteResult): [optional] # noqa: E501 - text_response (str): Text response for general questions.. [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ChatResult - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - chat_history_interaction_id (str): Chat History interaction ID. Unique ID for each interaction.. [optional] # noqa: E501 - created_visualizations (CreatedVisualizations): [optional] # noqa: E501 - error_response (str): Error response in anything fails.. [optional] # noqa: E501 - found_objects (FoundObjects): [optional] # noqa: E501 - routing (RouteResult): [optional] # noqa: E501 - text_response (str): Text response for general questions.. [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/chat_usage_response.py b/gooddata-api-client/gooddata_api_client/model/chat_usage_response.py deleted file mode 100644 index 84fe2fd65..000000000 --- a/gooddata-api-client/gooddata_api_client/model/chat_usage_response.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ChatUsageResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'interaction_count': (int,), # noqa: E501 - 'interaction_limit': (int,), # noqa: E501 - 'time_window_hours': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'interaction_count': 'interactionCount', # noqa: E501 - 'interaction_limit': 'interactionLimit', # noqa: E501 - 'time_window_hours': 'timeWindowHours', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, interaction_count, interaction_limit, time_window_hours, *args, **kwargs): # noqa: E501 - """ChatUsageResponse - a model defined in OpenAPI - - Args: - interaction_count (int): Number of interactions in the time window - interaction_limit (int): Maximum number of interactions in the time window any user can do in the workspace - time_window_hours (int): Time window in hours - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.interaction_count = interaction_count - self.interaction_limit = interaction_limit - self.time_window_hours = time_window_hours - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, interaction_count, interaction_limit, time_window_hours, *args, **kwargs): # noqa: E501 - """ChatUsageResponse - a model defined in OpenAPI - - Args: - interaction_count (int): Number of interactions in the time window - interaction_limit (int): Maximum number of interactions in the time window any user can do in the workspace - time_window_hours (int): Time window in hours - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.interaction_count = interaction_count - self.interaction_limit = interaction_limit - self.time_window_hours = time_window_hours - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/clustering_request.py b/gooddata-api-client/gooddata_api_client/model/clustering_request.py deleted file mode 100644 index 062301bae..000000000 --- a/gooddata-api-client/gooddata_api_client/model/clustering_request.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ClusteringRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('number_of_clusters',): { - 'inclusive_minimum': 1, - }, - ('threshold',): { - 'exclusive_minimum''inclusive_minimum': 0, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'number_of_clusters': (int,), # noqa: E501 - 'threshold': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'number_of_clusters': 'numberOfClusters', # noqa: E501 - 'threshold': 'threshold', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, number_of_clusters, *args, **kwargs): # noqa: E501 - """ClusteringRequest - a model defined in OpenAPI - - Args: - number_of_clusters (int): Number of clusters to create - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - threshold (float): Threshold used for algorithm. [optional] if omitted the server will use the default value of 0.03 # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.number_of_clusters = number_of_clusters - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, number_of_clusters, *args, **kwargs): # noqa: E501 - """ClusteringRequest - a model defined in OpenAPI - - Args: - number_of_clusters (int): Number of clusters to create - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - threshold (float): Threshold used for algorithm. [optional] if omitted the server will use the default value of 0.03 # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.number_of_clusters = number_of_clusters - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/clustering_result.py b/gooddata-api-client/gooddata_api_client/model/clustering_result.py deleted file mode 100644 index 1a966f7dc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/clustering_result.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ClusteringResult(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'attribute': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 - 'clusters': ([int, none_type],), # noqa: E501 - 'xcoord': ([float],), # noqa: E501 - 'ycoord': ([float],), # noqa: E501 - 'x_coord': ([float, none_type],), # noqa: E501 - 'y_coord': ([float, none_type],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute': 'attribute', # noqa: E501 - 'clusters': 'clusters', # noqa: E501 - 'xcoord': 'xcoord', # noqa: E501 - 'ycoord': 'ycoord', # noqa: E501 - 'x_coord': 'xCoord', # noqa: E501 - 'y_coord': 'yCoord', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute, clusters, xcoord, ycoord, *args, **kwargs): # noqa: E501 - """ClusteringResult - a model defined in OpenAPI - - Args: - attribute ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): - clusters ([int, none_type]): - xcoord ([float]): - ycoord ([float]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - x_coord ([float, none_type]): [optional] # noqa: E501 - y_coord ([float, none_type]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - self.clusters = clusters - self.xcoord = xcoord - self.ycoord = ycoord - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attribute, clusters, xcoord, ycoord, *args, **kwargs): # noqa: E501 - """ClusteringResult - a model defined in OpenAPI - - Args: - attribute ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): - clusters ([int, none_type]): - xcoord ([float]): - ycoord ([float]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - x_coord ([float, none_type]): [optional] # noqa: E501 - y_coord ([float, none_type]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - self.clusters = clusters - self.xcoord = xcoord - self.ycoord = ycoord - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/column_location.py b/gooddata-api-client/gooddata_api_client/model/column_location.py deleted file mode 100644 index 9a8dc3033..000000000 --- a/gooddata-api-client/gooddata_api_client/model/column_location.py +++ /dev/null @@ -1,260 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ColumnLocation(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ColumnLocation - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ColumnLocation - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/column_override.py b/gooddata-api-client/gooddata_api_client/model/column_override.py deleted file mode 100644 index 9a2c0d8b2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/column_override.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ColumnOverride(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('label_type',): { - 'TEXT': "TEXT", - 'HYPERLINK': "HYPERLINK", - 'GEO': "GEO", - 'GEO_LONGITUDE': "GEO_LONGITUDE", - 'GEO_LATITUDE': "GEO_LATITUDE", - 'IMAGE': "IMAGE", - }, - ('ldm_type_override',): { - 'FACT': "FACT", - 'LABEL': "LABEL", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'label_target_column': (str,), # noqa: E501 - 'label_type': (str,), # noqa: E501 - 'ldm_type_override': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'label_target_column': 'labelTargetColumn', # noqa: E501 - 'label_type': 'labelType', # noqa: E501 - 'ldm_type_override': 'ldmTypeOverride', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 - """ColumnOverride - a model defined in OpenAPI - - Args: - name (str): Column name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - label_target_column (str): Specifies the attribute's column to which this label is associated.. [optional] # noqa: E501 - label_type (str): Label type for the target attribute.. [optional] # noqa: E501 - ldm_type_override (str): Logical Data Model type for the column.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, name, *args, **kwargs): # noqa: E501 - """ColumnOverride - a model defined in OpenAPI - - Args: - name (str): Column name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - label_target_column (str): Specifies the attribute's column to which this label is associated.. [optional] # noqa: E501 - label_type (str): Label type for the target attribute.. [optional] # noqa: E501 - ldm_type_override (str): Logical Data Model type for the column.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/column_statistic.py b/gooddata-api-client/gooddata_api_client/model/column_statistic.py deleted file mode 100644 index 08c417a8a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/column_statistic.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ColumnStatistic(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'COUNT': "COUNT", - 'COUNT_NULL': "COUNT_NULL", - 'COUNT_UNIQUE': "COUNT_UNIQUE", - 'AVG': "AVG", - 'STDDEV': "STDDEV", - 'MIN': "MIN", - 'MAX': "MAX", - 'PERCENTILE_25': "PERCENTILE_25", - 'PERCENTILE_50': "PERCENTILE_50", - 'PERCENTILE_75': "PERCENTILE_75", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'type': (str,), # noqa: E501 - 'value': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """ColumnStatistic - a model defined in OpenAPI - - Args: - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - value (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, type, *args, **kwargs): # noqa: E501 - """ColumnStatistic - a model defined in OpenAPI - - Args: - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - value (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/column_statistic_warning.py b/gooddata-api-client/gooddata_api_client/model/column_statistic_warning.py deleted file mode 100644 index b678a9b10..000000000 --- a/gooddata-api-client/gooddata_api_client/model/column_statistic_warning.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ColumnStatisticWarning(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'action': (str,), # noqa: E501 - 'message': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'action': 'action', # noqa: E501 - 'message': 'message', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, action, message, *args, **kwargs): # noqa: E501 - """ColumnStatisticWarning - a model defined in OpenAPI - - Args: - action (str): - message (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.action = action - self.message = message - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, action, message, *args, **kwargs): # noqa: E501 - """ColumnStatisticWarning - a model defined in OpenAPI - - Args: - action (str): - message (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.action = action - self.message = message - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/column_statistics_request.py b/gooddata-api-client/gooddata_api_client/model/column_statistics_request.py deleted file mode 100644 index f694edd5c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/column_statistics_request.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.column_statistics_request_from import ColumnStatisticsRequestFrom - from gooddata_api_client.model.frequency_properties import FrequencyProperties - from gooddata_api_client.model.histogram_properties import HistogramProperties - globals()['ColumnStatisticsRequestFrom'] = ColumnStatisticsRequestFrom - globals()['FrequencyProperties'] = FrequencyProperties - globals()['HistogramProperties'] = HistogramProperties - - -class ColumnStatisticsRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('statistics',): { - 'COUNT': "COUNT", - 'COUNT_NULL': "COUNT_NULL", - 'COUNT_UNIQUE': "COUNT_UNIQUE", - 'AVG': "AVG", - 'STDDEV': "STDDEV", - 'MIN': "MIN", - 'MAX': "MAX", - 'PERCENTILE_25': "PERCENTILE_25", - 'PERCENTILE_50': "PERCENTILE_50", - 'PERCENTILE_75': "PERCENTILE_75", - }, - } - - validations = { - ('statistics',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'column_name': (str,), # noqa: E501 - '_from': (ColumnStatisticsRequestFrom,), # noqa: E501 - 'frequency': (FrequencyProperties,), # noqa: E501 - 'histogram': (HistogramProperties,), # noqa: E501 - 'statistics': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'column_name': 'columnName', # noqa: E501 - '_from': 'from', # noqa: E501 - 'frequency': 'frequency', # noqa: E501 - 'histogram': 'histogram', # noqa: E501 - 'statistics': 'statistics', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, column_name, _from, *args, **kwargs): # noqa: E501 - """ColumnStatisticsRequest - a model defined in OpenAPI - - Args: - column_name (str): - _from (ColumnStatisticsRequestFrom): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - frequency (FrequencyProperties): [optional] # noqa: E501 - histogram (HistogramProperties): [optional] # noqa: E501 - statistics ([str]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column_name = column_name - self._from = _from - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, column_name, _from, *args, **kwargs): # noqa: E501 - """ColumnStatisticsRequest - a model defined in OpenAPI - - Args: - column_name (str): - _from (ColumnStatisticsRequestFrom): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - frequency (FrequencyProperties): [optional] # noqa: E501 - histogram (HistogramProperties): [optional] # noqa: E501 - statistics ([str]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column_name = column_name - self._from = _from - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/column_statistics_request_from.py b/gooddata-api-client/gooddata_api_client/model/column_statistics_request_from.py deleted file mode 100644 index 4fa1a50d4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/column_statistics_request_from.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.sql_query import SqlQuery - from gooddata_api_client.model.table import Table - globals()['SqlQuery'] = SqlQuery - globals()['Table'] = Table - - -class ColumnStatisticsRequestFrom(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'sql': (str,), # noqa: E501 - 'table_name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'sql': 'sql', # noqa: E501 - 'table_name': 'tableName', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ColumnStatisticsRequestFrom - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - sql (str): [optional] # noqa: E501 - table_name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ColumnStatisticsRequestFrom - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - sql (str): [optional] # noqa: E501 - table_name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - SqlQuery, - Table, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/column_statistics_response.py b/gooddata-api-client/gooddata_api_client/model/column_statistics_response.py deleted file mode 100644 index b2b6aebb4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/column_statistics_response.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.column_statistic import ColumnStatistic - from gooddata_api_client.model.column_statistic_warning import ColumnStatisticWarning - from gooddata_api_client.model.frequency import Frequency - from gooddata_api_client.model.histogram import Histogram - globals()['ColumnStatistic'] = ColumnStatistic - globals()['ColumnStatisticWarning'] = ColumnStatisticWarning - globals()['Frequency'] = Frequency - globals()['Histogram'] = Histogram - - -class ColumnStatisticsResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'frequency': (Frequency,), # noqa: E501 - 'histogram': (Histogram,), # noqa: E501 - 'statistics': ([ColumnStatistic],), # noqa: E501 - 'warnings': ([ColumnStatisticWarning],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'frequency': 'frequency', # noqa: E501 - 'histogram': 'histogram', # noqa: E501 - 'statistics': 'statistics', # noqa: E501 - 'warnings': 'warnings', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ColumnStatisticsResponse - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - frequency (Frequency): [optional] # noqa: E501 - histogram (Histogram): [optional] # noqa: E501 - statistics ([ColumnStatistic]): [optional] # noqa: E501 - warnings ([ColumnStatisticWarning]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ColumnStatisticsResponse - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - frequency (Frequency): [optional] # noqa: E501 - histogram (Histogram): [optional] # noqa: E501 - statistics ([ColumnStatistic]): [optional] # noqa: E501 - warnings ([ColumnStatisticWarning]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/column_warning.py b/gooddata-api-client/gooddata_api_client/model/column_warning.py deleted file mode 100644 index c12188a33..000000000 --- a/gooddata-api-client/gooddata_api_client/model/column_warning.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ColumnWarning(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'message': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'message': 'message', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, message, name, *args, **kwargs): # noqa: E501 - """ColumnWarning - a model defined in OpenAPI - - Args: - message (str): Warning message related to the column. - name (str): Column name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.message = message - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, message, name, *args, **kwargs): # noqa: E501 - """ColumnWarning - a model defined in OpenAPI - - Args: - message (str): Warning message related to the column. - name (str): Column name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.message = message - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/comparison.py b/gooddata-api-client/gooddata_api_client/model/comparison.py deleted file mode 100644 index 399ebda2a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/comparison.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.alert_condition_operand import AlertConditionOperand - from gooddata_api_client.model.local_identifier import LocalIdentifier - globals()['AlertConditionOperand'] = AlertConditionOperand - globals()['LocalIdentifier'] = LocalIdentifier - - -class Comparison(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('operator',): { - 'GREATER_THAN': "GREATER_THAN", - 'GREATER_THAN_OR_EQUAL_TO': "GREATER_THAN_OR_EQUAL_TO", - 'LESS_THAN': "LESS_THAN", - 'LESS_THAN_OR_EQUAL_TO': "LESS_THAN_OR_EQUAL_TO", - 'EQUAL_TO': "EQUAL_TO", - 'NOT_EQUAL_TO': "NOT_EQUAL_TO", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'left': (LocalIdentifier,), # noqa: E501 - 'operator': (str,), # noqa: E501 - 'right': (AlertConditionOperand,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'left': 'left', # noqa: E501 - 'operator': 'operator', # noqa: E501 - 'right': 'right', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, left, operator, right, *args, **kwargs): # noqa: E501 - """Comparison - a model defined in OpenAPI - - Args: - left (LocalIdentifier): - operator (str): - right (AlertConditionOperand): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.left = left - self.operator = operator - self.right = right - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, left, operator, right, *args, **kwargs): # noqa: E501 - """Comparison - a model defined in OpenAPI - - Args: - left (LocalIdentifier): - operator (str): - right (AlertConditionOperand): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.left = left - self.operator = operator - self.right = right - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/comparison_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/model/comparison_measure_value_filter.py deleted file mode 100644 index 99e9f603a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/comparison_measure_value_filter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter - globals()['ComparisonMeasureValueFilterComparisonMeasureValueFilter'] = ComparisonMeasureValueFilterComparisonMeasureValueFilter - - -class ComparisonMeasureValueFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'comparison_measure_value_filter': (ComparisonMeasureValueFilterComparisonMeasureValueFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'comparison_measure_value_filter': 'comparisonMeasureValueFilter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, comparison_measure_value_filter, *args, **kwargs): # noqa: E501 - """ComparisonMeasureValueFilter - a model defined in OpenAPI - - Args: - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.comparison_measure_value_filter = comparison_measure_value_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, comparison_measure_value_filter, *args, **kwargs): # noqa: E501 - """ComparisonMeasureValueFilter - a model defined in OpenAPI - - Args: - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.comparison_measure_value_filter = comparison_measure_value_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/comparison_measure_value_filter.pyi b/gooddata-api-client/gooddata_api_client/model/comparison_measure_value_filter.pyi index dc11d6902..da4bbdb0d 100644 --- a/gooddata-api-client/gooddata_api_client/model/comparison_measure_value_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/comparison_measure_value_filter.pyi @@ -40,55 +40,55 @@ class ComparisonMeasureValueFilter( required = { "comparisonMeasureValueFilter", } - + class properties: - - + + class comparisonMeasureValueFilter( schemas.DictSchema ): - - + + class MetaOapg: required = { "measure", "value", "operator", } - + class properties: applyOnResult = schemas.BoolSchema - + @staticmethod def measure() -> typing.Type['AfmIdentifier']: return AfmIdentifier - - + + class operator( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def GREATER_THAN(cls): return cls("GREATER_THAN") - + @schemas.classproperty def GREATER_THAN_OR_EQUAL_TO(cls): return cls("GREATER_THAN_OR_EQUAL_TO") - + @schemas.classproperty def LESS_THAN(cls): return cls("LESS_THAN") - + @schemas.classproperty def LESS_THAN_OR_EQUAL_TO(cls): return cls("LESS_THAN_OR_EQUAL_TO") - + @schemas.classproperty def EQUAL_TO(cls): return cls("EQUAL_TO") - + @schemas.classproperty def NOT_EQUAL_TO(cls): return cls("NOT_EQUAL_TO") @@ -101,56 +101,56 @@ class ComparisonMeasureValueFilter( "treatNullValuesAs": treatNullValuesAs, "value": value, } - + measure: 'AfmIdentifier' value: MetaOapg.properties.value operator: MetaOapg.properties.operator - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["applyOnResult"]) -> MetaOapg.properties.applyOnResult: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["measure"]) -> 'AfmIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["treatNullValuesAs"]) -> MetaOapg.properties.treatNullValuesAs: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "measure", "operator", "treatNullValuesAs", "value", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["applyOnResult"]) -> typing.Union[MetaOapg.properties.applyOnResult, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["measure"]) -> 'AfmIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["treatNullValuesAs"]) -> typing.Union[MetaOapg.properties.treatNullValuesAs, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "measure", "operator", "treatNullValuesAs", "value", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -176,29 +176,29 @@ class ComparisonMeasureValueFilter( __annotations__ = { "comparisonMeasureValueFilter": comparisonMeasureValueFilter, } - + comparisonMeasureValueFilter: MetaOapg.properties.comparisonMeasureValueFilter - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["comparisonMeasureValueFilter"]) -> MetaOapg.properties.comparisonMeasureValueFilter: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["comparisonMeasureValueFilter", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["comparisonMeasureValueFilter"]) -> MetaOapg.properties.comparisonMeasureValueFilter: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["comparisonMeasureValueFilter", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -215,4 +215,4 @@ class ComparisonMeasureValueFilter( **kwargs, ) -from gooddata_api_client.model.afm_identifier import AfmIdentifier +from gooddata_api_client.models.afm_identifier import AfmIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/comparison_measure_value_filter_comparison_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/model/comparison_measure_value_filter_comparison_measure_value_filter.py deleted file mode 100644 index 3ae1cbe6c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/comparison_measure_value_filter_comparison_measure_value_filter.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_identifier import AfmIdentifier - globals()['AfmIdentifier'] = AfmIdentifier - - -class ComparisonMeasureValueFilterComparisonMeasureValueFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('operator',): { - 'GREATER_THAN': "GREATER_THAN", - 'GREATER_THAN_OR_EQUAL_TO': "GREATER_THAN_OR_EQUAL_TO", - 'LESS_THAN': "LESS_THAN", - 'LESS_THAN_OR_EQUAL_TO': "LESS_THAN_OR_EQUAL_TO", - 'EQUAL_TO': "EQUAL_TO", - 'NOT_EQUAL_TO': "NOT_EQUAL_TO", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'measure': (AfmIdentifier,), # noqa: E501 - 'operator': (str,), # noqa: E501 - 'value': (float,), # noqa: E501 - 'apply_on_result': (bool,), # noqa: E501 - 'dimensionality': ([AfmIdentifier],), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - 'treat_null_values_as': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'measure': 'measure', # noqa: E501 - 'operator': 'operator', # noqa: E501 - 'value': 'value', # noqa: E501 - 'apply_on_result': 'applyOnResult', # noqa: E501 - 'dimensionality': 'dimensionality', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - 'treat_null_values_as': 'treatNullValuesAs', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, measure, operator, value, *args, **kwargs): # noqa: E501 - """ComparisonMeasureValueFilterComparisonMeasureValueFilter - a model defined in OpenAPI - - Args: - measure (AfmIdentifier): - operator (str): - value (float): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - dimensionality ([AfmIdentifier]): References to the attributes to be used when filtering.. [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - treat_null_values_as (float): A value that will be substituted for null values in the metric for the comparisons.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure = measure - self.operator = operator - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, measure, operator, value, *args, **kwargs): # noqa: E501 - """ComparisonMeasureValueFilterComparisonMeasureValueFilter - a model defined in OpenAPI - - Args: - measure (AfmIdentifier): - operator (str): - value (float): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - dimensionality ([AfmIdentifier]): References to the attributes to be used when filtering.. [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - treat_null_values_as (float): A value that will be substituted for null values in the metric for the comparisons.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure = measure - self.operator = operator - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/comparison_wrapper.py b/gooddata-api-client/gooddata_api_client/model/comparison_wrapper.py deleted file mode 100644 index 72fb3e27f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/comparison_wrapper.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.comparison import Comparison - globals()['Comparison'] = Comparison - - -class ComparisonWrapper(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'comparison': (Comparison,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'comparison': 'comparison', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, comparison, *args, **kwargs): # noqa: E501 - """ComparisonWrapper - a model defined in OpenAPI - - Args: - comparison (Comparison): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.comparison = comparison - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, comparison, *args, **kwargs): # noqa: E501 - """ComparisonWrapper - a model defined in OpenAPI - - Args: - comparison (Comparison): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.comparison = comparison - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/content_slide_template.py b/gooddata-api-client/gooddata_api_client/model/content_slide_template.py deleted file mode 100644 index b9f27b395..000000000 --- a/gooddata-api-client/gooddata_api_client/model/content_slide_template.py +++ /dev/null @@ -1,278 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.running_section import RunningSection - globals()['RunningSection'] = RunningSection - - -class ContentSlideTemplate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'description_field': (str, none_type,), # noqa: E501 - 'footer': (RunningSection,), # noqa: E501 - 'header': (RunningSection,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'description_field': 'descriptionField', # noqa: E501 - 'footer': 'footer', # noqa: E501 - 'header': 'header', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ContentSlideTemplate - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description_field (str, none_type): [optional] # noqa: E501 - footer (RunningSection): [optional] # noqa: E501 - header (RunningSection): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ContentSlideTemplate - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description_field (str, none_type): [optional] # noqa: E501 - footer (RunningSection): [optional] # noqa: E501 - header (RunningSection): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/cover_slide_template.py b/gooddata-api-client/gooddata_api_client/model/cover_slide_template.py deleted file mode 100644 index 2e2407a74..000000000 --- a/gooddata-api-client/gooddata_api_client/model/cover_slide_template.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.running_section import RunningSection - globals()['RunningSection'] = RunningSection - - -class CoverSlideTemplate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'background_image': (bool,), # noqa: E501 - 'description_field': (str, none_type,), # noqa: E501 - 'footer': (RunningSection,), # noqa: E501 - 'header': (RunningSection,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'background_image': 'backgroundImage', # noqa: E501 - 'description_field': 'descriptionField', # noqa: E501 - 'footer': 'footer', # noqa: E501 - 'header': 'header', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CoverSlideTemplate - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 - description_field (str, none_type): [optional] # noqa: E501 - footer (RunningSection): [optional] # noqa: E501 - header (RunningSection): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """CoverSlideTemplate - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 - description_field (str, none_type): [optional] # noqa: E501 - footer (RunningSection): [optional] # noqa: E501 - header (RunningSection): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/created_visualization.py b/gooddata-api-client/gooddata_api_client/model/created_visualization.py deleted file mode 100644 index ca10ad91e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/created_visualization.py +++ /dev/null @@ -1,330 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.created_visualization_filters_inner import CreatedVisualizationFiltersInner - from gooddata_api_client.model.dim_attribute import DimAttribute - from gooddata_api_client.model.metric import Metric - from gooddata_api_client.model.suggestion import Suggestion - globals()['CreatedVisualizationFiltersInner'] = CreatedVisualizationFiltersInner - globals()['DimAttribute'] = DimAttribute - globals()['Metric'] = Metric - globals()['Suggestion'] = Suggestion - - -class CreatedVisualization(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('visualization_type',): { - 'TABLE': "TABLE", - 'HEADLINE': "HEADLINE", - 'BAR': "BAR", - 'LINE': "LINE", - 'PIE': "PIE", - 'COLUMN': "COLUMN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dimensionality': ([DimAttribute],), # noqa: E501 - 'filters': ([CreatedVisualizationFiltersInner],), # noqa: E501 - 'id': (str,), # noqa: E501 - 'metrics': ([Metric],), # noqa: E501 - 'suggestions': ([Suggestion],), # noqa: E501 - 'title': (str,), # noqa: E501 - 'visualization_type': (str,), # noqa: E501 - 'saved_visualization_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dimensionality': 'dimensionality', # noqa: E501 - 'filters': 'filters', # noqa: E501 - 'id': 'id', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'suggestions': 'suggestions', # noqa: E501 - 'title': 'title', # noqa: E501 - 'visualization_type': 'visualizationType', # noqa: E501 - 'saved_visualization_id': 'savedVisualizationId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dimensionality, filters, id, metrics, suggestions, title, visualization_type, *args, **kwargs): # noqa: E501 - """CreatedVisualization - a model defined in OpenAPI - - Args: - dimensionality ([DimAttribute]): List of attributes representing the dimensionality of the new visualization - filters ([CreatedVisualizationFiltersInner]): List of filters to be applied to the new visualization - id (str): Proposed ID of the new visualization - metrics ([Metric]): List of metrics to be used in the new visualization - suggestions ([Suggestion]): Suggestions for next steps - title (str): Proposed title of the new visualization - visualization_type (str): Visualization type requested in question - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - saved_visualization_id (str): Saved visualization ID.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dimensionality = dimensionality - self.filters = filters - self.id = id - self.metrics = metrics - self.suggestions = suggestions - self.title = title - self.visualization_type = visualization_type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dimensionality, filters, id, metrics, suggestions, title, visualization_type, *args, **kwargs): # noqa: E501 - """CreatedVisualization - a model defined in OpenAPI - - Args: - dimensionality ([DimAttribute]): List of attributes representing the dimensionality of the new visualization - filters ([CreatedVisualizationFiltersInner]): List of filters to be applied to the new visualization - id (str): Proposed ID of the new visualization - metrics ([Metric]): List of metrics to be used in the new visualization - suggestions ([Suggestion]): Suggestions for next steps - title (str): Proposed title of the new visualization - visualization_type (str): Visualization type requested in question - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - saved_visualization_id (str): Saved visualization ID.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dimensionality = dimensionality - self.filters = filters - self.id = id - self.metrics = metrics - self.suggestions = suggestions - self.title = title - self.visualization_type = visualization_type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/created_visualization_filters_inner.py b/gooddata-api-client/gooddata_api_client/model/created_visualization_filters_inner.py deleted file mode 100644 index b93ef9074..000000000 --- a/gooddata-api-client/gooddata_api_client/model/created_visualization_filters_inner.py +++ /dev/null @@ -1,376 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_negative_filter import AttributeNegativeFilter - from gooddata_api_client.model.attribute_positive_filter import AttributePositiveFilter - from gooddata_api_client.model.date_absolute_filter import DateAbsoluteFilter - from gooddata_api_client.model.date_relative_filter import DateRelativeFilter - from gooddata_api_client.model.ranking_filter import RankingFilter - from gooddata_api_client.model.ranking_filter_ranking_filter import RankingFilterRankingFilter - globals()['AttributeNegativeFilter'] = AttributeNegativeFilter - globals()['AttributePositiveFilter'] = AttributePositiveFilter - globals()['DateAbsoluteFilter'] = DateAbsoluteFilter - globals()['DateRelativeFilter'] = DateRelativeFilter - globals()['RankingFilter'] = RankingFilter - globals()['RankingFilterRankingFilter'] = RankingFilterRankingFilter - - -class CreatedVisualizationFiltersInner(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularity',): { - 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", - 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", - 'HOUR_OF_DAY': "HOUR_OF_DAY", - 'DAY_OF_WEEK': "DAY_OF_WEEK", - 'DAY_OF_MONTH': "DAY_OF_MONTH", - 'DAY_OF_QUARTER': "DAY_OF_QUARTER", - 'DAY_OF_YEAR': "DAY_OF_YEAR", - 'WEEK_OF_YEAR': "WEEK_OF_YEAR", - 'MONTH_OF_YEAR': "MONTH_OF_YEAR", - 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'exclude': ([str],), # noqa: E501 - 'using': (str,), # noqa: E501 - 'include': ([str],), # noqa: E501 - '_from': (int,), # noqa: E501 - 'to': (int,), # noqa: E501 - 'granularity': (str,), # noqa: E501 - 'ranking_filter': (RankingFilterRankingFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'exclude': 'exclude', # noqa: E501 - 'using': 'using', # noqa: E501 - 'include': 'include', # noqa: E501 - '_from': 'from', # noqa: E501 - 'to': 'to', # noqa: E501 - 'granularity': 'granularity', # noqa: E501 - 'ranking_filter': 'rankingFilter', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CreatedVisualizationFiltersInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - exclude ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - include ([str]): [optional] # noqa: E501 - _from (int): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """CreatedVisualizationFiltersInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - exclude ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - include ([str]): [optional] # noqa: E501 - _from (int): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AttributeNegativeFilter, - AttributePositiveFilter, - DateAbsoluteFilter, - DateRelativeFilter, - RankingFilter, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/created_visualizations.py b/gooddata-api-client/gooddata_api_client/model/created_visualizations.py deleted file mode 100644 index 6fd2c60b4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/created_visualizations.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.created_visualization import CreatedVisualization - from gooddata_api_client.model.suggestion import Suggestion - globals()['CreatedVisualization'] = CreatedVisualization - globals()['Suggestion'] = Suggestion - - -class CreatedVisualizations(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'objects': ([CreatedVisualization],), # noqa: E501 - 'reasoning': (str,), # noqa: E501 - 'suggestions': ([Suggestion],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'objects': 'objects', # noqa: E501 - 'reasoning': 'reasoning', # noqa: E501 - 'suggestions': 'suggestions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, objects, reasoning, suggestions, *args, **kwargs): # noqa: E501 - """CreatedVisualizations - a model defined in OpenAPI - - Args: - objects ([CreatedVisualization]): List of created visualization objects - reasoning (str): Reasoning from LLM. Description of how and why the answer was generated. - suggestions ([Suggestion]): List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.objects = objects - self.reasoning = reasoning - self.suggestions = suggestions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, objects, reasoning, suggestions, *args, **kwargs): # noqa: E501 - """CreatedVisualizations - a model defined in OpenAPI - - Args: - objects ([CreatedVisualization]): List of created visualization objects - reasoning (str): Reasoning from LLM. Description of how and why the answer was generated. - suggestions ([Suggestion]): List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.objects = objects - self.reasoning = reasoning - self.suggestions = suggestions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/custom_label.py b/gooddata-api-client/gooddata_api_client/model/custom_label.py deleted file mode 100644 index 09011359d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/custom_label.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class CustomLabel(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, title, *args, **kwargs): # noqa: E501 - """CustomLabel - a model defined in OpenAPI - - Args: - title (str): Override value. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, title, *args, **kwargs): # noqa: E501 - """CustomLabel - a model defined in OpenAPI - - Args: - title (str): Override value. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/custom_metric.py b/gooddata-api-client/gooddata_api_client/model/custom_metric.py deleted file mode 100644 index 243703bb6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/custom_metric.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class CustomMetric(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'format': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'format': 'format', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, format, title, *args, **kwargs): # noqa: E501 - """CustomMetric - a model defined in OpenAPI - - Args: - format (str): Format override. - title (str): Metric title override. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.format = format - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, format, title, *args, **kwargs): # noqa: E501 - """CustomMetric - a model defined in OpenAPI - - Args: - format (str): Format override. - title (str): Metric title override. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.format = format - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/custom_override.py b/gooddata-api-client/gooddata_api_client/model/custom_override.py deleted file mode 100644 index e772918cb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/custom_override.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.custom_label import CustomLabel - from gooddata_api_client.model.custom_metric import CustomMetric - globals()['CustomLabel'] = CustomLabel - globals()['CustomMetric'] = CustomMetric - - -class CustomOverride(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'labels': ({str: (CustomLabel,)},), # noqa: E501 - 'metrics': ({str: (CustomMetric,)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'labels': 'labels', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CustomOverride - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - labels ({str: (CustomLabel,)}): Map of CustomLabels with keys used as placeholders in document.. [optional] # noqa: E501 - metrics ({str: (CustomMetric,)}): Map of CustomMetrics with keys used as placeholders in document.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """CustomOverride - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - labels ({str: (CustomLabel,)}): Map of CustomLabels with keys used as placeholders in document.. [optional] # noqa: E501 - metrics ({str: (CustomMetric,)}): Map of CustomMetrics with keys used as placeholders in document.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/custom_override.pyi b/gooddata-api-client/gooddata_api_client/model/custom_override.pyi index 68852bb1f..e61962fc8 100644 --- a/gooddata-api-client/gooddata_api_client/model/custom_override.pyi +++ b/gooddata-api-client/gooddata_api_client/model/custom_override.pyi @@ -37,28 +37,28 @@ class CustomOverride( class MetaOapg: - + class properties: - - + + class labels( schemas.DictSchema ): - - + + class MetaOapg: - + @staticmethod def additional_properties() -> typing.Type['CustomLabel']: return CustomLabel - + def __getitem__(self, name: typing.Union[str, ]) -> 'CustomLabel': # dict_instance[name] accessor return super().__getitem__(name) - + def get_item_oapg(self, name: typing.Union[str, ]) -> 'CustomLabel': return super().get_item_oapg(name) - + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -71,26 +71,26 @@ class CustomOverride( _configuration=_configuration, **kwargs, ) - - + + class metrics( schemas.DictSchema ): - - + + class MetaOapg: - + @staticmethod def additional_properties() -> typing.Type['CustomMetric']: return CustomMetric - + def __getitem__(self, name: typing.Union[str, ]) -> 'CustomMetric': # dict_instance[name] accessor return super().__getitem__(name) - + def get_item_oapg(self, name: typing.Union[str, ]) -> 'CustomMetric': return super().get_item_oapg(name) - + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -107,33 +107,33 @@ class CustomOverride( "labels": labels, "metrics": metrics, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["labels"]) -> MetaOapg.properties.labels: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["labels", "metrics", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["labels"]) -> typing.Union[MetaOapg.properties.labels, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["labels", "metrics", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -152,5 +152,5 @@ class CustomOverride( **kwargs, ) -from gooddata_api_client.model.custom_label import CustomLabel -from gooddata_api_client.model.custom_metric import CustomMetric +from gooddata_api_client.models.custom_label import CustomLabel +from gooddata_api_client.models.custom_metric import CustomMetric diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/dashboard_attribute_filter.py deleted file mode 100644 index e98689381..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_attribute_filter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dashboard_attribute_filter_attribute_filter import DashboardAttributeFilterAttributeFilter - globals()['DashboardAttributeFilterAttributeFilter'] = DashboardAttributeFilterAttributeFilter - - -class DashboardAttributeFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute_filter': (DashboardAttributeFilterAttributeFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute_filter': 'attributeFilter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute_filter, *args, **kwargs): # noqa: E501 - """DashboardAttributeFilter - a model defined in OpenAPI - - Args: - attribute_filter (DashboardAttributeFilterAttributeFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute_filter = attribute_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attribute_filter, *args, **kwargs): # noqa: E501 - """DashboardAttributeFilter - a model defined in OpenAPI - - Args: - attribute_filter (DashboardAttributeFilterAttributeFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute_filter = attribute_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_attribute_filter_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/dashboard_attribute_filter_attribute_filter.py deleted file mode 100644 index f369f47c5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_attribute_filter_attribute_filter.py +++ /dev/null @@ -1,322 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_elements import AttributeElements - from gooddata_api_client.model.attribute_filter_by_date import AttributeFilterByDate - from gooddata_api_client.model.attribute_filter_parent import AttributeFilterParent - from gooddata_api_client.model.identifier_ref import IdentifierRef - globals()['AttributeElements'] = AttributeElements - globals()['AttributeFilterByDate'] = AttributeFilterByDate - globals()['AttributeFilterParent'] = AttributeFilterParent - globals()['IdentifierRef'] = IdentifierRef - - -class DashboardAttributeFilterAttributeFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('selection_mode',): { - 'SINGLE': "single", - 'MULTI': "multi", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute_elements': (AttributeElements,), # noqa: E501 - 'display_form': (IdentifierRef,), # noqa: E501 - 'negative_selection': (bool,), # noqa: E501 - 'filter_elements_by': ([AttributeFilterParent],), # noqa: E501 - 'filter_elements_by_date': ([AttributeFilterByDate],), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - 'selection_mode': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'validate_elements_by': ([IdentifierRef],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute_elements': 'attributeElements', # noqa: E501 - 'display_form': 'displayForm', # noqa: E501 - 'negative_selection': 'negativeSelection', # noqa: E501 - 'filter_elements_by': 'filterElementsBy', # noqa: E501 - 'filter_elements_by_date': 'filterElementsByDate', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - 'selection_mode': 'selectionMode', # noqa: E501 - 'title': 'title', # noqa: E501 - 'validate_elements_by': 'validateElementsBy', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute_elements, display_form, negative_selection, *args, **kwargs): # noqa: E501 - """DashboardAttributeFilterAttributeFilter - a model defined in OpenAPI - - Args: - attribute_elements (AttributeElements): - display_form (IdentifierRef): - negative_selection (bool): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - filter_elements_by ([AttributeFilterParent]): [optional] # noqa: E501 - filter_elements_by_date ([AttributeFilterByDate]): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - selection_mode (str): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - validate_elements_by ([IdentifierRef]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute_elements = attribute_elements - self.display_form = display_form - self.negative_selection = negative_selection - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attribute_elements, display_form, negative_selection, *args, **kwargs): # noqa: E501 - """DashboardAttributeFilterAttributeFilter - a model defined in OpenAPI - - Args: - attribute_elements (AttributeElements): - display_form (IdentifierRef): - negative_selection (bool): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - filter_elements_by ([AttributeFilterParent]): [optional] # noqa: E501 - filter_elements_by_date ([AttributeFilterByDate]): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - selection_mode (str): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - validate_elements_by ([IdentifierRef]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute_elements = attribute_elements - self.display_form = display_form - self.negative_selection = negative_selection - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter.py b/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter.py deleted file mode 100644 index 078831bb2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dashboard_date_filter_date_filter import DashboardDateFilterDateFilter - globals()['DashboardDateFilterDateFilter'] = DashboardDateFilterDateFilter - - -class DashboardDateFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'date_filter': (DashboardDateFilterDateFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'date_filter': 'dateFilter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, date_filter, *args, **kwargs): # noqa: E501 - """DashboardDateFilter - a model defined in OpenAPI - - Args: - date_filter (DashboardDateFilterDateFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.date_filter = date_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, date_filter, *args, **kwargs): # noqa: E501 - """DashboardDateFilter - a model defined in OpenAPI - - Args: - date_filter (DashboardDateFilterDateFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.date_filter = date_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py b/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py deleted file mode 100644 index becb35e4c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py +++ /dev/null @@ -1,339 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dashboard_date_filter_date_filter_from import DashboardDateFilterDateFilterFrom - from gooddata_api_client.model.identifier_ref import IdentifierRef - from gooddata_api_client.model.relative_bounded_date_filter import RelativeBoundedDateFilter - globals()['DashboardDateFilterDateFilterFrom'] = DashboardDateFilterDateFilterFrom - globals()['IdentifierRef'] = IdentifierRef - globals()['RelativeBoundedDateFilter'] = RelativeBoundedDateFilter - - -class DashboardDateFilterDateFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularity',): { - 'ALL_TIME_GRANULARITY': "ALL_TIME_GRANULARITY", - 'GDC.TIME.YEAR': "GDC.time.year", - 'GDC.TIME.WEEK_US': "GDC.time.week_us", - 'GDC.TIME.WEEK_IN_YEAR': "GDC.time.week_in_year", - 'GDC.TIME.WEEK_IN_QUARTER': "GDC.time.week_in_quarter", - 'GDC.TIME.WEEK': "GDC.time.week", - 'GDC.TIME.EUWEEK_IN_YEAR': "GDC.time.euweek_in_year", - 'GDC.TIME.EUWEEK_IN_QUARTER': "GDC.time.euweek_in_quarter", - 'GDC.TIME.QUARTER': "GDC.time.quarter", - 'GDC.TIME.QUARTER_IN_YEAR': "GDC.time.quarter_in_year", - 'GDC.TIME.MONTH': "GDC.time.month", - 'GDC.TIME.MONTH_IN_QUARTER': "GDC.time.month_in_quarter", - 'GDC.TIME.MONTH_IN_YEAR': "GDC.time.month_in_year", - 'GDC.TIME.DAY_IN_YEAR': "GDC.time.day_in_year", - 'GDC.TIME.DAY_IN_QUARTER': "GDC.time.day_in_quarter", - 'GDC.TIME.DAY_IN_MONTH': "GDC.time.day_in_month", - 'GDC.TIME.DAY_IN_WEEK': "GDC.time.day_in_week", - 'GDC.TIME.DAY_IN_EUWEEK': "GDC.time.day_in_euweek", - 'GDC.TIME.DATE': "GDC.time.date", - 'GDC.TIME.HOUR': "GDC.time.hour", - 'GDC.TIME.HOUR_IN_DAY': "GDC.time.hour_in_day", - 'GDC.TIME.MINUTE': "GDC.time.minute", - 'GDC.TIME.MINUTE_IN_HOUR': "GDC.time.minute_in_hour", - }, - ('type',): { - 'RELATIVE': "relative", - 'ABSOLUTE': "absolute", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'granularity': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attribute': (IdentifierRef,), # noqa: E501 - 'bounded_filter': (RelativeBoundedDateFilter,), # noqa: E501 - 'data_set': (IdentifierRef,), # noqa: E501 - '_from': (DashboardDateFilterDateFilterFrom,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - 'to': (DashboardDateFilterDateFilterFrom,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'granularity': 'granularity', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attribute': 'attribute', # noqa: E501 - 'bounded_filter': 'boundedFilter', # noqa: E501 - 'data_set': 'dataSet', # noqa: E501 - '_from': 'from', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - 'to': 'to', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, granularity, type, *args, **kwargs): # noqa: E501 - """DashboardDateFilterDateFilter - a model defined in OpenAPI - - Args: - granularity (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute (IdentifierRef): [optional] # noqa: E501 - bounded_filter (RelativeBoundedDateFilter): [optional] # noqa: E501 - data_set (IdentifierRef): [optional] # noqa: E501 - _from (DashboardDateFilterDateFilterFrom): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - to (DashboardDateFilterDateFilterFrom): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.granularity = granularity - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, granularity, type, *args, **kwargs): # noqa: E501 - """DashboardDateFilterDateFilter - a model defined in OpenAPI - - Args: - granularity (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute (IdentifierRef): [optional] # noqa: E501 - bounded_filter (RelativeBoundedDateFilter): [optional] # noqa: E501 - data_set (IdentifierRef): [optional] # noqa: E501 - _from (DashboardDateFilterDateFilterFrom): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - to (DashboardDateFilterDateFilterFrom): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.granularity = granularity - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter_from.py b/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter_from.py deleted file mode 100644 index 06393e075..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter_from.py +++ /dev/null @@ -1,260 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DashboardDateFilterDateFilterFrom(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DashboardDateFilterDateFilterFrom - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DashboardDateFilterDateFilterFrom - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_export_settings.py b/gooddata-api-client/gooddata_api_client/model/dashboard_export_settings.py deleted file mode 100644 index bd683f7c9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_export_settings.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DashboardExportSettings(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('page_orientation',): { - 'PORTRAIT': "PORTRAIT", - 'LANDSCAPE': "LANDSCAPE", - }, - ('page_size',): { - 'A3': "A3", - 'A4': "A4", - 'LETTER': "LETTER", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'export_info': (bool,), # noqa: E501 - 'merge_headers': (bool,), # noqa: E501 - 'page_orientation': (str,), # noqa: E501 - 'page_size': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'export_info': 'exportInfo', # noqa: E501 - 'merge_headers': 'mergeHeaders', # noqa: E501 - 'page_orientation': 'pageOrientation', # noqa: E501 - 'page_size': 'pageSize', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DashboardExportSettings - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - export_info (bool): If true, the export will contain the information about the export – exported date, dashboard filters, etc.. [optional] if omitted the server will use the default value of False # noqa: E501 - merge_headers (bool): Merge equal headers in neighbouring cells. Used for [XLSX] format only.. [optional] if omitted the server will use the default value of False # noqa: E501 - page_orientation (str): Set page orientation. (PDF). [optional] if omitted the server will use the default value of "PORTRAIT" # noqa: E501 - page_size (str): Set page size. (PDF). [optional] if omitted the server will use the default value of "A4" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DashboardExportSettings - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - export_info (bool): If true, the export will contain the information about the export – exported date, dashboard filters, etc.. [optional] if omitted the server will use the default value of False # noqa: E501 - merge_headers (bool): Merge equal headers in neighbouring cells. Used for [XLSX] format only.. [optional] if omitted the server will use the default value of False # noqa: E501 - page_orientation (str): Set page orientation. (PDF). [optional] if omitted the server will use the default value of "PORTRAIT" # noqa: E501 - page_size (str): Set page size. (PDF). [optional] if omitted the server will use the default value of "A4" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_filter.py b/gooddata-api-client/gooddata_api_client/model/dashboard_filter.py deleted file mode 100644 index 27b551ddd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_filter.py +++ /dev/null @@ -1,331 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dashboard_attribute_filter import DashboardAttributeFilter - from gooddata_api_client.model.dashboard_attribute_filter_attribute_filter import DashboardAttributeFilterAttributeFilter - from gooddata_api_client.model.dashboard_date_filter import DashboardDateFilter - from gooddata_api_client.model.dashboard_date_filter_date_filter import DashboardDateFilterDateFilter - globals()['DashboardAttributeFilter'] = DashboardAttributeFilter - globals()['DashboardAttributeFilterAttributeFilter'] = DashboardAttributeFilterAttributeFilter - globals()['DashboardDateFilter'] = DashboardDateFilter - globals()['DashboardDateFilterDateFilter'] = DashboardDateFilterDateFilter - - -class DashboardFilter(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute_filter': (DashboardAttributeFilterAttributeFilter,), # noqa: E501 - 'date_filter': (DashboardDateFilterDateFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute_filter': 'attributeFilter', # noqa: E501 - 'date_filter': 'dateFilter', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DashboardFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute_filter (DashboardAttributeFilterAttributeFilter): [optional] # noqa: E501 - date_filter (DashboardDateFilterDateFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DashboardFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute_filter (DashboardAttributeFilterAttributeFilter): [optional] # noqa: E501 - date_filter (DashboardDateFilterDateFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - DashboardAttributeFilter, - DashboardDateFilter, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_permissions.py b/gooddata-api-client/gooddata_api_client/model/dashboard_permissions.py deleted file mode 100644 index 8d307bdf5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_permissions.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.rule_permission import RulePermission - from gooddata_api_client.model.user_group_permission import UserGroupPermission - from gooddata_api_client.model.user_permission import UserPermission - globals()['RulePermission'] = RulePermission - globals()['UserGroupPermission'] = UserGroupPermission - globals()['UserPermission'] = UserPermission - - -class DashboardPermissions(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'rules': ([RulePermission],), # noqa: E501 - 'user_groups': ([UserGroupPermission],), # noqa: E501 - 'users': ([UserPermission],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'rules': 'rules', # noqa: E501 - 'user_groups': 'userGroups', # noqa: E501 - 'users': 'users', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, rules, user_groups, users, *args, **kwargs): # noqa: E501 - """DashboardPermissions - a model defined in OpenAPI - - Args: - rules ([RulePermission]): List of rules - user_groups ([UserGroupPermission]): List of user groups - users ([UserPermission]): List of users - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.rules = rules - self.user_groups = user_groups - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, rules, user_groups, users, *args, **kwargs): # noqa: E501 - """DashboardPermissions - a model defined in OpenAPI - - Args: - rules ([RulePermission]): List of rules - user_groups ([UserGroupPermission]): List of user groups - users ([UserPermission]): List of users - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.rules = rules - self.user_groups = user_groups - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_permissions.pyi b/gooddata-api-client/gooddata_api_client/model/dashboard_permissions.pyi index 7a8f27527..75ccfd192 100644 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_permissions.pyi +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_permissions.pyi @@ -39,21 +39,21 @@ class DashboardPermissions( "userGroups", "users", } - + class properties: - - + + class userGroups( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['UserGroupPermission']: return UserGroupPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['UserGroupPermission'], typing.List['UserGroupPermission']], @@ -64,22 +64,22 @@ class DashboardPermissions( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'UserGroupPermission': return super().__getitem__(i) - - + + class users( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['UserPermission']: return UserPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['UserPermission'], typing.List['UserPermission']], @@ -90,43 +90,43 @@ class DashboardPermissions( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'UserPermission': return super().__getitem__(i) __annotations__ = { "userGroups": userGroups, "users": users, } - + userGroups: MetaOapg.properties.userGroups users: MetaOapg.properties.users - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["userGroups", "users", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userGroups", "users", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -145,5 +145,5 @@ class DashboardPermissions( **kwargs, ) -from gooddata_api_client.model.user_group_permission import UserGroupPermission -from gooddata_api_client.model.user_permission import UserPermission +from gooddata_api_client.models.user_group_permission import UserGroupPermission +from gooddata_api_client.models.user_permission import UserPermission diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_permissions_assignment.py b/gooddata-api-client/gooddata_api_client/model/dashboard_permissions_assignment.py deleted file mode 100644 index 674515ff4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_permissions_assignment.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DashboardPermissionsAssignment(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('permissions',): { - 'EDIT': "EDIT", - 'SHARE': "SHARE", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'permissions': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, permissions, *args, **kwargs): # noqa: E501 - """DashboardPermissionsAssignment - a model defined in OpenAPI - - Args: - permissions ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, permissions, *args, **kwargs): # noqa: E501 - """DashboardPermissionsAssignment - a model defined in OpenAPI - - Args: - permissions ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_slides_template.py b/gooddata-api-client/gooddata_api_client/model/dashboard_slides_template.py deleted file mode 100644 index 4a41bc0fb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_slides_template.py +++ /dev/null @@ -1,305 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.content_slide_template import ContentSlideTemplate - from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate - from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate - from gooddata_api_client.model.section_slide_template import SectionSlideTemplate - globals()['ContentSlideTemplate'] = ContentSlideTemplate - globals()['CoverSlideTemplate'] = CoverSlideTemplate - globals()['IntroSlideTemplate'] = IntroSlideTemplate - globals()['SectionSlideTemplate'] = SectionSlideTemplate - - -class DashboardSlidesTemplate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('applied_on',): { - 'PDF': "PDF", - 'PPTX': "PPTX", - }, - } - - validations = { - ('applied_on',): { - 'min_items': 1, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'applied_on': ([str],), # noqa: E501 - 'content_slide': (ContentSlideTemplate,), # noqa: E501 - 'cover_slide': (CoverSlideTemplate,), # noqa: E501 - 'intro_slide': (IntroSlideTemplate,), # noqa: E501 - 'section_slide': (SectionSlideTemplate,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'applied_on': 'appliedOn', # noqa: E501 - 'content_slide': 'contentSlide', # noqa: E501 - 'cover_slide': 'coverSlide', # noqa: E501 - 'intro_slide': 'introSlide', # noqa: E501 - 'section_slide': 'sectionSlide', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 - """DashboardSlidesTemplate - a model defined in OpenAPI - - Args: - applied_on ([str]): Export types this template applies to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content_slide (ContentSlideTemplate): [optional] # noqa: E501 - cover_slide (CoverSlideTemplate): [optional] # noqa: E501 - intro_slide (IntroSlideTemplate): [optional] # noqa: E501 - section_slide (SectionSlideTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.applied_on = applied_on - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, applied_on, *args, **kwargs): # noqa: E501 - """DashboardSlidesTemplate - a model defined in OpenAPI - - Args: - applied_on ([str]): Export types this template applies to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content_slide (ContentSlideTemplate): [optional] # noqa: E501 - cover_slide (CoverSlideTemplate): [optional] # noqa: E501 - intro_slide (IntroSlideTemplate): [optional] # noqa: E501 - section_slide (SectionSlideTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.applied_on = applied_on - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request.py b/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request.py deleted file mode 100644 index 9c494705a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request.py +++ /dev/null @@ -1,303 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dashboard_export_settings import DashboardExportSettings - from gooddata_api_client.model.dashboard_filter import DashboardFilter - globals()['DashboardExportSettings'] = DashboardExportSettings - globals()['DashboardFilter'] = DashboardFilter - - -class DashboardTabularExportRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('format',): { - 'XLSX': "XLSX", - 'PDF': "PDF", - }, - } - - validations = { - ('widget_ids',): { - 'max_items': 1, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'file_name': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - 'dashboard_filters_override': ([DashboardFilter],), # noqa: E501 - 'settings': (DashboardExportSettings,), # noqa: E501 - 'widget_ids': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'file_name': 'fileName', # noqa: E501 - 'format': 'format', # noqa: E501 - 'dashboard_filters_override': 'dashboardFiltersOverride', # noqa: E501 - 'settings': 'settings', # noqa: E501 - 'widget_ids': 'widgetIds', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, file_name, format, *args, **kwargs): # noqa: E501 - """DashboardTabularExportRequest - a model defined in OpenAPI - - Args: - file_name (str): Filename of downloaded file without extension. - format (str): Requested tabular export type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_filters_override ([DashboardFilter]): List of filters that will be used instead of the default dashboard filters.. [optional] # noqa: E501 - settings (DashboardExportSettings): [optional] # noqa: E501 - widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, file_name, format, *args, **kwargs): # noqa: E501 - """DashboardTabularExportRequest - a model defined in OpenAPI - - Args: - file_name (str): Filename of downloaded file without extension. - format (str): Requested tabular export type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_filters_override ([DashboardFilter]): List of filters that will be used instead of the default dashboard filters.. [optional] # noqa: E501 - settings (DashboardExportSettings): [optional] # noqa: E501 - widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request_v2.py b/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request_v2.py deleted file mode 100644 index e345fa5ac..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request_v2.py +++ /dev/null @@ -1,309 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dashboard_export_settings import DashboardExportSettings - from gooddata_api_client.model.dashboard_filter import DashboardFilter - globals()['DashboardExportSettings'] = DashboardExportSettings - globals()['DashboardFilter'] = DashboardFilter - - -class DashboardTabularExportRequestV2(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('format',): { - 'XLSX': "XLSX", - 'PDF': "PDF", - }, - } - - validations = { - ('widget_ids',): { - 'max_items': 1, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dashboard_id': (str,), # noqa: E501 - 'file_name': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - 'dashboard_filters_override': ([DashboardFilter],), # noqa: E501 - 'settings': (DashboardExportSettings,), # noqa: E501 - 'widget_ids': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dashboard_id': 'dashboardId', # noqa: E501 - 'file_name': 'fileName', # noqa: E501 - 'format': 'format', # noqa: E501 - 'dashboard_filters_override': 'dashboardFiltersOverride', # noqa: E501 - 'settings': 'settings', # noqa: E501 - 'widget_ids': 'widgetIds', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dashboard_id, file_name, format, *args, **kwargs): # noqa: E501 - """DashboardTabularExportRequestV2 - a model defined in OpenAPI - - Args: - dashboard_id (str): Dashboard identifier - file_name (str): Filename of downloaded file without extension. - format (str): Requested tabular export type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_filters_override ([DashboardFilter]): List of filters that will be used instead of the default dashboard filters.. [optional] # noqa: E501 - settings (DashboardExportSettings): [optional] # noqa: E501 - widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dashboard_id = dashboard_id - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dashboard_id, file_name, format, *args, **kwargs): # noqa: E501 - """DashboardTabularExportRequestV2 - a model defined in OpenAPI - - Args: - dashboard_id (str): Dashboard identifier - file_name (str): Filename of downloaded file without extension. - format (str): Requested tabular export type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_filters_override ([DashboardFilter]): List of filters that will be used instead of the default dashboard filters.. [optional] # noqa: E501 - settings (DashboardExportSettings): [optional] # noqa: E501 - widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dashboard_id = dashboard_id - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/data_column_locator.py b/gooddata-api-client/gooddata_api_client/model/data_column_locator.py deleted file mode 100644 index 869225e3a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/data_column_locator.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DataColumnLocator(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'properties': ({str: (str,)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'properties': 'properties', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, properties, *args, **kwargs): # noqa: E501 - """DataColumnLocator - a model defined in OpenAPI - - Args: - properties ({str: (str,)}): Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.properties = properties - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, properties, *args, **kwargs): # noqa: E501 - """DataColumnLocator - a model defined in OpenAPI - - Args: - properties ({str: (str,)}): Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.properties = properties - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/data_column_locators.py b/gooddata-api-client/gooddata_api_client/model/data_column_locators.py deleted file mode 100644 index 995c87208..000000000 --- a/gooddata-api-client/gooddata_api_client/model/data_column_locators.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.data_column_locator import DataColumnLocator - globals()['DataColumnLocator'] = DataColumnLocator - - -class DataColumnLocators(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'properties': ({str: (DataColumnLocator,)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'properties': 'properties', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DataColumnLocators - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - properties ({str: (DataColumnLocator,)}): Mapping from dimensions to data column locators.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DataColumnLocators - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - properties ({str: (DataColumnLocator,)}): Mapping from dimensions to data column locators.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/data_column_locators.pyi b/gooddata-api-client/gooddata_api_client/model/data_column_locators.pyi index a41da4018..1caa59674 100644 --- a/gooddata-api-client/gooddata_api_client/model/data_column_locators.pyi +++ b/gooddata-api-client/gooddata_api_client/model/data_column_locators.pyi @@ -35,28 +35,28 @@ class DataColumnLocators( class MetaOapg: - + class properties: - - + + class properties( schemas.DictSchema ): - - + + class MetaOapg: - + @staticmethod def additional_properties() -> typing.Type['DataColumnLocator']: return DataColumnLocator - + def __getitem__(self, name: typing.Union[str, ]) -> 'DataColumnLocator': # dict_instance[name] accessor return super().__getitem__(name) - + def get_item_oapg(self, name: typing.Union[str, ]) -> 'DataColumnLocator': return super().get_item_oapg(name) - + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -72,27 +72,27 @@ class DataColumnLocators( __annotations__ = { "properties": properties, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["properties"]) -> MetaOapg.properties.properties: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["properties", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["properties"]) -> typing.Union[MetaOapg.properties.properties, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["properties", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -109,4 +109,4 @@ class DataColumnLocators( **kwargs, ) -from gooddata_api_client.model.data_column_locator import DataColumnLocator +from gooddata_api_client.models.data_column_locator import DataColumnLocator diff --git a/gooddata-api-client/gooddata_api_client/model/data_source_parameter.py b/gooddata-api-client/gooddata_api_client/model/data_source_parameter.py deleted file mode 100644 index bca71d916..000000000 --- a/gooddata-api-client/gooddata_api_client/model/data_source_parameter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DataSourceParameter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'value': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, value, *args, **kwargs): # noqa: E501 - """DataSourceParameter - a model defined in OpenAPI - - Args: - name (str): Parameter name. - value (str): Parameter value. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, name, value, *args, **kwargs): # noqa: E501 - """DataSourceParameter - a model defined in OpenAPI - - Args: - name (str): Parameter name. - value (str): Parameter value. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/data_source_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/data_source_permission_assignment.py deleted file mode 100644 index cdb594d5a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/data_source_permission_assignment.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - globals()['AssigneeIdentifier'] = AssigneeIdentifier - - -class DataSourcePermissionAssignment(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('permissions',): { - 'MANAGE': "MANAGE", - 'USE': "USE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 - 'permissions': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, assignee_identifier, permissions, *args, **kwargs): # noqa: E501 - """DataSourcePermissionAssignment - a model defined in OpenAPI - - Args: - assignee_identifier (AssigneeIdentifier): - permissions ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee_identifier = assignee_identifier - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, assignee_identifier, permissions, *args, **kwargs): # noqa: E501 - """DataSourcePermissionAssignment - a model defined in OpenAPI - - Args: - assignee_identifier (AssigneeIdentifier): - permissions ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee_identifier = assignee_identifier - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/data_source_schemata.py b/gooddata-api-client/gooddata_api_client/model/data_source_schemata.py deleted file mode 100644 index 0ec72fce7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/data_source_schemata.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DataSourceSchemata(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'schema_names': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'schema_names': 'schemaNames', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, schema_names, *args, **kwargs): # noqa: E501 - """DataSourceSchemata - a model defined in OpenAPI - - Args: - schema_names ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.schema_names = schema_names - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, schema_names, *args, **kwargs): # noqa: E501 - """DataSourceSchemata - a model defined in OpenAPI - - Args: - schema_names ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.schema_names = schema_names - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/data_source_table_identifier.py b/gooddata-api-client/gooddata_api_client/model/data_source_table_identifier.py deleted file mode 100644 index 5890d278c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/data_source_table_identifier.py +++ /dev/null @@ -1,299 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DataSourceTableIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASOURCE': "dataSource", - }, - } - - validations = { - ('data_source_id',): { - 'max_length': 255, - }, - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'data_source_id': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'path': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_source_id': 'dataSourceId', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'path': 'path', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_source_id, id, *args, **kwargs): # noqa: E501 - """DataSourceTableIdentifier - a model defined in OpenAPI - - Args: - data_source_id (str): Data source ID. - id (str): ID of table. - - Keyword Args: - type (str): Data source entity type.. defaults to "dataSource", must be one of ["dataSource", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - path ([str], none_type): Path to table.. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataSource") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_source_id = data_source_id - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_source_id, id, *args, **kwargs): # noqa: E501 - """DataSourceTableIdentifier - a model defined in OpenAPI - - Args: - data_source_id (str): Data source ID. - id (str): ID of table. - - Keyword Args: - type (str): Data source entity type.. defaults to "dataSource", must be one of ["dataSource", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - path ([str], none_type): Path to table.. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataSource") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_source_id = data_source_id - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dataset_grain.py b/gooddata-api-client/gooddata_api_client/model/dataset_grain.py deleted file mode 100644 index aeec83a70..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dataset_grain.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DatasetGrain(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTE': "attribute", - 'DATE': "date", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """DatasetGrain - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """DatasetGrain - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dataset_reference_identifier.py b/gooddata-api-client/gooddata_api_client/model/dataset_reference_identifier.py deleted file mode 100644 index 5a6be1b66..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dataset_reference_identifier.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DatasetReferenceIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASET': "dataset", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DatasetReferenceIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DatasetReferenceIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dataset_workspace_data_filter_identifier.py b/gooddata-api-client/gooddata_api_client/model/dataset_workspace_data_filter_identifier.py deleted file mode 100644 index 75f2f8be8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dataset_workspace_data_filter_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DatasetWorkspaceDataFilterIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTER': "workspaceDataFilter", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DatasetWorkspaceDataFilterIdentifier - a model defined in OpenAPI - - Args: - id (str): Workspace Data Filters ID. - - Keyword Args: - type (str): Filter type.. defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DatasetWorkspaceDataFilterIdentifier - a model defined in OpenAPI - - Args: - id (str): Workspace Data Filters ID. - - Keyword Args: - type (str): Filter type.. defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/date_absolute_filter.py b/gooddata-api-client/gooddata_api_client/model/date_absolute_filter.py deleted file mode 100644 index 68958cfae..000000000 --- a/gooddata-api-client/gooddata_api_client/model/date_absolute_filter.py +++ /dev/null @@ -1,331 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.date_absolute_filter_all_of import DateAbsoluteFilterAllOf - from gooddata_api_client.model.filter import Filter - globals()['DateAbsoluteFilterAllOf'] = DateAbsoluteFilterAllOf - globals()['Filter'] = Filter - - -class DateAbsoluteFilter(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - '_from': (str,), # noqa: E501 - 'to': (str,), # noqa: E501 - 'using': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - '_from': 'from', # noqa: E501 - 'to': 'to', # noqa: E501 - 'using': 'using', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DateAbsoluteFilter - a model defined in OpenAPI - - Keyword Args: - _from (str): - to (str): - using (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DateAbsoluteFilter - a model defined in OpenAPI - - Keyword Args: - _from (str): - to (str): - using (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - DateAbsoluteFilterAllOf, - Filter, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/date_absolute_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/date_absolute_filter_all_of.py deleted file mode 100644 index bb6d2bfab..000000000 --- a/gooddata-api-client/gooddata_api_client/model/date_absolute_filter_all_of.py +++ /dev/null @@ -1,272 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DateAbsoluteFilterAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - '_from': (str,), # noqa: E501 - 'to': (str,), # noqa: E501 - 'using': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - '_from': 'from', # noqa: E501 - 'to': 'to', # noqa: E501 - 'using': 'using', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DateAbsoluteFilterAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - _from (str): [optional] # noqa: E501 - to (str): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DateAbsoluteFilterAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - _from (str): [optional] # noqa: E501 - to (str): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/date_filter.py b/gooddata-api-client/gooddata_api_client/model/date_filter.py deleted file mode 100644 index 3b2e25293..000000000 --- a/gooddata-api-client/gooddata_api_client/model/date_filter.py +++ /dev/null @@ -1,331 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.absolute_date_filter import AbsoluteDateFilter - from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter - from gooddata_api_client.model.relative_date_filter import RelativeDateFilter - from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter - globals()['AbsoluteDateFilter'] = AbsoluteDateFilter - globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter - globals()['RelativeDateFilter'] = RelativeDateFilter - globals()['RelativeDateFilterRelativeDateFilter'] = RelativeDateFilterRelativeDateFilter - - -class DateFilter(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 - 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 - 'relative_date_filter': 'relativeDateFilter', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DateFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 - relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DateFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 - relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AbsoluteDateFilter, - RelativeDateFilter, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/date_filter.pyi b/gooddata-api-client/gooddata_api_client/model/date_filter.pyi index 61e3134b0..8a23efe3a 100644 --- a/gooddata-api-client/gooddata_api_client/model/date_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/date_filter.pyi @@ -38,7 +38,7 @@ class DateFilter( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -68,5 +68,5 @@ class DateFilter( **kwargs, ) -from gooddata_api_client.model.absolute_date_filter import AbsoluteDateFilter -from gooddata_api_client.model.relative_date_filter import RelativeDateFilter +from gooddata_api_client.models.absolute_date_filter import AbsoluteDateFilter +from gooddata_api_client.models.relative_date_filter import RelativeDateFilter diff --git a/gooddata-api-client/gooddata_api_client/model/date_relative_filter.py b/gooddata-api-client/gooddata_api_client/model/date_relative_filter.py deleted file mode 100644 index 062390c03..000000000 --- a/gooddata-api-client/gooddata_api_client/model/date_relative_filter.py +++ /dev/null @@ -1,353 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.date_relative_filter_all_of import DateRelativeFilterAllOf - from gooddata_api_client.model.filter import Filter - globals()['DateRelativeFilterAllOf'] = DateRelativeFilterAllOf - globals()['Filter'] = Filter - - -class DateRelativeFilter(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularity',): { - 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", - 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", - 'HOUR_OF_DAY': "HOUR_OF_DAY", - 'DAY_OF_WEEK': "DAY_OF_WEEK", - 'DAY_OF_MONTH': "DAY_OF_MONTH", - 'DAY_OF_QUARTER': "DAY_OF_QUARTER", - 'DAY_OF_YEAR': "DAY_OF_YEAR", - 'WEEK_OF_YEAR': "WEEK_OF_YEAR", - 'MONTH_OF_YEAR': "MONTH_OF_YEAR", - 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - '_from': (int,), # noqa: E501 - 'granularity': (str,), # noqa: E501 - 'to': (int,), # noqa: E501 - 'using': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - '_from': 'from', # noqa: E501 - 'granularity': 'granularity', # noqa: E501 - 'to': 'to', # noqa: E501 - 'using': 'using', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DateRelativeFilter - a model defined in OpenAPI - - Keyword Args: - _from (int): - granularity (str): - to (int): - using (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DateRelativeFilter - a model defined in OpenAPI - - Keyword Args: - _from (int): - granularity (str): - to (int): - using (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - DateRelativeFilterAllOf, - Filter, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/date_relative_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/date_relative_filter_all_of.py deleted file mode 100644 index 11c4f70fa..000000000 --- a/gooddata-api-client/gooddata_api_client/model/date_relative_filter_all_of.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DateRelativeFilterAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularity',): { - 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", - 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", - 'HOUR_OF_DAY': "HOUR_OF_DAY", - 'DAY_OF_WEEK': "DAY_OF_WEEK", - 'DAY_OF_MONTH': "DAY_OF_MONTH", - 'DAY_OF_QUARTER': "DAY_OF_QUARTER", - 'DAY_OF_YEAR': "DAY_OF_YEAR", - 'WEEK_OF_YEAR': "WEEK_OF_YEAR", - 'MONTH_OF_YEAR': "MONTH_OF_YEAR", - 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - '_from': (int,), # noqa: E501 - 'granularity': (str,), # noqa: E501 - 'to': (int,), # noqa: E501 - 'using': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - '_from': 'from', # noqa: E501 - 'granularity': 'granularity', # noqa: E501 - 'to': 'to', # noqa: E501 - 'using': 'using', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DateRelativeFilterAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - _from (int): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DateRelativeFilterAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - _from (int): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/date_value.py b/gooddata-api-client/gooddata_api_client/model/date_value.py deleted file mode 100644 index beb07341b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/date_value.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DateValue(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'value': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, value, *args, **kwargs): # noqa: E501 - """DateValue - a model defined in OpenAPI - - Args: - value (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, value, *args, **kwargs): # noqa: E501 - """DateValue - a model defined in OpenAPI - - Args: - value (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_aggregated_fact.py b/gooddata-api-client/gooddata_api_client/model/declarative_aggregated_fact.py deleted file mode 100644 index 64888d9a5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_aggregated_fact.py +++ /dev/null @@ -1,325 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_source_fact_reference import DeclarativeSourceFactReference - globals()['DeclarativeSourceFactReference'] = DeclarativeSourceFactReference - - -class DeclarativeAggregatedFact(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('source_column_data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('source_column',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('source_column_data_type',): { - 'max_length': 255, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'source_column': (str,), # noqa: E501 - 'source_fact_reference': (DeclarativeSourceFactReference,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'source_column_data_type': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'source_column': 'sourceColumn', # noqa: E501 - 'source_fact_reference': 'sourceFactReference', # noqa: E501 - 'description': 'description', # noqa: E501 - 'source_column_data_type': 'sourceColumnDataType', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, source_column, source_fact_reference, *args, **kwargs): # noqa: E501 - """DeclarativeAggregatedFact - a model defined in OpenAPI - - Args: - id (str): Fact ID. - source_column (str): A name of the source column in the table. - source_fact_reference (DeclarativeSourceFactReference): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Fact description.. [optional] # noqa: E501 - source_column_data_type (str): A type of the source column. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.source_column = source_column - self.source_fact_reference = source_fact_reference - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, source_column, source_fact_reference, *args, **kwargs): # noqa: E501 - """DeclarativeAggregatedFact - a model defined in OpenAPI - - Args: - id (str): Fact ID. - source_column (str): A name of the source column in the table. - source_fact_reference (DeclarativeSourceFactReference): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Fact description.. [optional] # noqa: E501 - source_column_data_type (str): A type of the source column. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.source_column = source_column - self.source_fact_reference = source_fact_reference - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.py deleted file mode 100644 index f2cb5467b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.py +++ /dev/null @@ -1,343 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_analytical_dashboard_permissions_inner import DeclarativeAnalyticalDashboardPermissionsInner - from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - from gooddata_api_client.model.json_node import JsonNode - globals()['DeclarativeAnalyticalDashboardPermissionsInner'] = DeclarativeAnalyticalDashboardPermissionsInner - globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - globals()['JsonNode'] = JsonNode - - -class DeclarativeAnalyticalDashboard(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('created_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('description',): { - 'max_length': 10000, - }, - ('modified_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (JsonNode,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'created_at': (str, none_type,), # noqa: E501 - 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'modified_at': (str, none_type,), # noqa: E501 - 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'permissions': ([DeclarativeAnalyticalDashboardPermissionsInner],), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'description': 'description', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboard - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Analytical dashboard ID. - title (str): Analytical dashboard title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Analytical dashboard description.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - permissions ([DeclarativeAnalyticalDashboardPermissionsInner]): A list of permissions.. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboard - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Analytical dashboard ID. - title (str): Analytical dashboard title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Analytical dashboard description.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - permissions ([DeclarativeAnalyticalDashboardPermissionsInner]): A list of permissions.. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.pyi index 8a6d38cc8..85cceda82 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.pyi @@ -199,4 +199,4 @@ class DeclarativeAnalyticalDashboard( **kwargs, ) -from gooddata_api_client.model.declarative_analytical_dashboard_permission import DeclarativeAnalyticalDashboardPermission +from gooddata_api_client.models.declarative_analytical_dashboard_permission import DeclarativeAnalyticalDashboardPermission diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_extension.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_extension.py deleted file mode 100644 index 35c50b79d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_extension.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_analytical_dashboard_permissions_inner import DeclarativeAnalyticalDashboardPermissionsInner - globals()['DeclarativeAnalyticalDashboardPermissionsInner'] = DeclarativeAnalyticalDashboardPermissionsInner - - -class DeclarativeAnalyticalDashboardExtension(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'permissions': ([DeclarativeAnalyticalDashboardPermissionsInner],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, permissions, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardExtension - a model defined in OpenAPI - - Args: - id (str): Analytical dashboard ID. - permissions ([DeclarativeAnalyticalDashboardPermissionsInner]): A list of permissions. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, permissions, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardExtension - a model defined in OpenAPI - - Args: - id (str): Analytical dashboard ID. - permissions ([DeclarativeAnalyticalDashboardPermissionsInner]): A list of permissions. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_extension.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_extension.pyi index a40519869..78b6a4e29 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_extension.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_extension.pyi @@ -39,27 +39,27 @@ class DeclarativeAnalyticalDashboardExtension( "permissions", "id", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeAnalyticalDashboardPermission']: return DeclarativeAnalyticalDashboardPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeAnalyticalDashboardPermission'], typing.List['DeclarativeAnalyticalDashboardPermission']], @@ -70,43 +70,43 @@ class DeclarativeAnalyticalDashboardExtension( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeAnalyticalDashboardPermission': return super().__getitem__(i) __annotations__ = { "id": id, "permissions": permissions, } - + permissions: MetaOapg.properties.permissions id: MetaOapg.properties.id - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "permissions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "permissions", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -125,4 +125,4 @@ class DeclarativeAnalyticalDashboardExtension( **kwargs, ) -from gooddata_api_client.model.declarative_analytical_dashboard_permission import DeclarativeAnalyticalDashboardPermission +from gooddata_api_client.models.declarative_analytical_dashboard_permission import DeclarativeAnalyticalDashboardPermission diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_identifier.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_identifier.py deleted file mode 100644 index d2298ddf1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeAnalyticalDashboardIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardIdentifier - a model defined in OpenAPI - - Args: - id (str): Identifier of the analytical dashboard. - - Keyword Args: - type (str): A type.. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardIdentifier - a model defined in OpenAPI - - Args: - id (str): Identifier of the analytical dashboard. - - Keyword Args: - type (str): A type.. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission.pyi index a7539d3e4..42f3fcc06 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission.pyi @@ -41,27 +41,27 @@ class DeclarativeAnalyticalDashboardPermission( "name", "assignee", } - + class properties: - + @staticmethod def assignee() -> typing.Type['AssigneeIdentifier']: return AssigneeIdentifier - - + + class name( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def EDIT(cls): return cls("EDIT") - + @schemas.classproperty def SHARE(cls): return cls("SHARE") - + @schemas.classproperty def VIEW(cls): return cls("VIEW") @@ -69,36 +69,36 @@ class DeclarativeAnalyticalDashboardPermission( "assignee": assignee, "name": name, } - + name: MetaOapg.properties.name assignee: 'AssigneeIdentifier' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -117,4 +117,4 @@ class DeclarativeAnalyticalDashboardPermission( **kwargs, ) -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_assignment.py deleted file mode 100644 index 677f9d867..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_assignment.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeAnalyticalDashboardPermissionAssignment(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'EDIT': "EDIT", - 'SHARE': "SHARE", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionAssignment - a model defined in OpenAPI - - Args: - name (str): Permission name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, name, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionAssignment - a model defined in OpenAPI - - Args: - name (str): Permission name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee.py deleted file mode 100644 index 7be09d3c8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee.py +++ /dev/null @@ -1,334 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - from gooddata_api_client.model.declarative_analytical_dashboard_permission_assignment import DeclarativeAnalyticalDashboardPermissionAssignment - from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee_all_of import DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf - globals()['AssigneeIdentifier'] = AssigneeIdentifier - globals()['DeclarativeAnalyticalDashboardPermissionAssignment'] = DeclarativeAnalyticalDashboardPermissionAssignment - globals()['DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf'] = DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf - - -class DeclarativeAnalyticalDashboardPermissionForAssignee(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'EDIT': "EDIT", - 'SHARE': "SHARE", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'name': (str,), # noqa: E501 - 'assignee': (AssigneeIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'assignee': 'assignee', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionForAssignee - a model defined in OpenAPI - - Keyword Args: - name (str): Permission name. - assignee (AssigneeIdentifier): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionForAssignee - a model defined in OpenAPI - - Keyword Args: - name (str): Permission name. - assignee (AssigneeIdentifier): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - DeclarativeAnalyticalDashboardPermissionAssignment, - DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_all_of.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_all_of.py deleted file mode 100644 index 023f2346d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_all_of.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - globals()['AssigneeIdentifier'] = AssigneeIdentifier - - -class DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee': (AssigneeIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee': 'assignee', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - assignee (AssigneeIdentifier): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - assignee (AssigneeIdentifier): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_rule.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_rule.py deleted file mode 100644 index 6cdafcb1b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_rule.py +++ /dev/null @@ -1,334 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_rule import AssigneeRule - from gooddata_api_client.model.declarative_analytical_dashboard_permission_assignment import DeclarativeAnalyticalDashboardPermissionAssignment - from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee_rule_all_of import DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf - globals()['AssigneeRule'] = AssigneeRule - globals()['DeclarativeAnalyticalDashboardPermissionAssignment'] = DeclarativeAnalyticalDashboardPermissionAssignment - globals()['DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf'] = DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf - - -class DeclarativeAnalyticalDashboardPermissionForAssigneeRule(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'EDIT': "EDIT", - 'SHARE': "SHARE", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'name': (str,), # noqa: E501 - 'assignee_rule': (AssigneeRule,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'assignee_rule': 'assigneeRule', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionForAssigneeRule - a model defined in OpenAPI - - Keyword Args: - name (str): Permission name. - assignee_rule (AssigneeRule): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionForAssigneeRule - a model defined in OpenAPI - - Keyword Args: - name (str): Permission name. - assignee_rule (AssigneeRule): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - DeclarativeAnalyticalDashboardPermissionAssignment, - DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_rule_all_of.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_rule_all_of.py deleted file mode 100644 index 364d9cb4b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_rule_all_of.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_rule import AssigneeRule - globals()['AssigneeRule'] = AssigneeRule - - -class DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee_rule': (AssigneeRule,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee_rule': 'assigneeRule', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - assignee_rule (AssigneeRule): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - assignee_rule (AssigneeRule): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permissions_inner.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permissions_inner.py deleted file mode 100644 index a2e7cc3c4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permissions_inner.py +++ /dev/null @@ -1,340 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - from gooddata_api_client.model.assignee_rule import AssigneeRule - from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee import DeclarativeAnalyticalDashboardPermissionForAssignee - from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee_rule import DeclarativeAnalyticalDashboardPermissionForAssigneeRule - globals()['AssigneeIdentifier'] = AssigneeIdentifier - globals()['AssigneeRule'] = AssigneeRule - globals()['DeclarativeAnalyticalDashboardPermissionForAssignee'] = DeclarativeAnalyticalDashboardPermissionForAssignee - globals()['DeclarativeAnalyticalDashboardPermissionForAssigneeRule'] = DeclarativeAnalyticalDashboardPermissionForAssigneeRule - - -class DeclarativeAnalyticalDashboardPermissionsInner(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'EDIT': "EDIT", - 'SHARE': "SHARE", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'name': (str,), # noqa: E501 - 'assignee': (AssigneeIdentifier,), # noqa: E501 - 'assignee_rule': (AssigneeRule,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'assignee': 'assignee', # noqa: E501 - 'assignee_rule': 'assigneeRule', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionsInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Permission name.. [optional] # noqa: E501 - assignee (AssigneeIdentifier): [optional] # noqa: E501 - assignee_rule (AssigneeRule): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticalDashboardPermissionsInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Permission name.. [optional] # noqa: E501 - assignee (AssigneeIdentifier): [optional] # noqa: E501 - assignee_rule (AssigneeRule): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - DeclarativeAnalyticalDashboardPermissionForAssignee, - DeclarativeAnalyticalDashboardPermissionForAssigneeRule, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytics.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytics.py deleted file mode 100644 index e5feb9629..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytics.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_analytics_layer import DeclarativeAnalyticsLayer - globals()['DeclarativeAnalyticsLayer'] = DeclarativeAnalyticsLayer - - -class DeclarativeAnalytics(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'analytics': (DeclarativeAnalyticsLayer,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'analytics': 'analytics', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeAnalytics - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytics (DeclarativeAnalyticsLayer): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeAnalytics - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytics (DeclarativeAnalyticsLayer): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytics.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_analytics.pyi index 6c6091ccc..0023953db 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytics.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytics.pyi @@ -37,36 +37,36 @@ class DeclarativeAnalytics( class MetaOapg: - + class properties: - + @staticmethod def analytics() -> typing.Type['DeclarativeAnalyticsLayer']: return DeclarativeAnalyticsLayer __annotations__ = { "analytics": analytics, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["analytics"]) -> 'DeclarativeAnalyticsLayer': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analytics", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["analytics"]) -> typing.Union['DeclarativeAnalyticsLayer', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analytics", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -83,4 +83,4 @@ class DeclarativeAnalytics( **kwargs, ) -from gooddata_api_client.model.declarative_analytics_layer import DeclarativeAnalyticsLayer +from gooddata_api_client.models.declarative_analytics_layer import DeclarativeAnalyticsLayer diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.py deleted file mode 100644 index c55246920..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard - from gooddata_api_client.model.declarative_analytical_dashboard_extension import DeclarativeAnalyticalDashboardExtension - from gooddata_api_client.model.declarative_attribute_hierarchy import DeclarativeAttributeHierarchy - from gooddata_api_client.model.declarative_dashboard_plugin import DeclarativeDashboardPlugin - from gooddata_api_client.model.declarative_export_definition import DeclarativeExportDefinition - from gooddata_api_client.model.declarative_filter_context import DeclarativeFilterContext - from gooddata_api_client.model.declarative_metric import DeclarativeMetric - from gooddata_api_client.model.declarative_visualization_object import DeclarativeVisualizationObject - globals()['DeclarativeAnalyticalDashboard'] = DeclarativeAnalyticalDashboard - globals()['DeclarativeAnalyticalDashboardExtension'] = DeclarativeAnalyticalDashboardExtension - globals()['DeclarativeAttributeHierarchy'] = DeclarativeAttributeHierarchy - globals()['DeclarativeDashboardPlugin'] = DeclarativeDashboardPlugin - globals()['DeclarativeExportDefinition'] = DeclarativeExportDefinition - globals()['DeclarativeFilterContext'] = DeclarativeFilterContext - globals()['DeclarativeMetric'] = DeclarativeMetric - globals()['DeclarativeVisualizationObject'] = DeclarativeVisualizationObject - - -class DeclarativeAnalyticsLayer(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'analytical_dashboard_extensions': ([DeclarativeAnalyticalDashboardExtension],), # noqa: E501 - 'analytical_dashboards': ([DeclarativeAnalyticalDashboard],), # noqa: E501 - 'attribute_hierarchies': ([DeclarativeAttributeHierarchy],), # noqa: E501 - 'dashboard_plugins': ([DeclarativeDashboardPlugin],), # noqa: E501 - 'export_definitions': ([DeclarativeExportDefinition],), # noqa: E501 - 'filter_contexts': ([DeclarativeFilterContext],), # noqa: E501 - 'metrics': ([DeclarativeMetric],), # noqa: E501 - 'visualization_objects': ([DeclarativeVisualizationObject],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'analytical_dashboard_extensions': 'analyticalDashboardExtensions', # noqa: E501 - 'analytical_dashboards': 'analyticalDashboards', # noqa: E501 - 'attribute_hierarchies': 'attributeHierarchies', # noqa: E501 - 'dashboard_plugins': 'dashboardPlugins', # noqa: E501 - 'export_definitions': 'exportDefinitions', # noqa: E501 - 'filter_contexts': 'filterContexts', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'visualization_objects': 'visualizationObjects', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticsLayer - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard_extensions ([DeclarativeAnalyticalDashboardExtension]): A list of dashboard permissions assigned to a related dashboard.. [optional] # noqa: E501 - analytical_dashboards ([DeclarativeAnalyticalDashboard]): A list of analytical dashboards available in the model.. [optional] # noqa: E501 - attribute_hierarchies ([DeclarativeAttributeHierarchy]): A list of attribute hierarchies.. [optional] # noqa: E501 - dashboard_plugins ([DeclarativeDashboardPlugin]): A list of dashboard plugins available in the model.. [optional] # noqa: E501 - export_definitions ([DeclarativeExportDefinition]): A list of export definitions.. [optional] # noqa: E501 - filter_contexts ([DeclarativeFilterContext]): A list of filter contexts available in the model.. [optional] # noqa: E501 - metrics ([DeclarativeMetric]): A list of metrics available in the model.. [optional] # noqa: E501 - visualization_objects ([DeclarativeVisualizationObject]): A list of visualization objects available in the model.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeAnalyticsLayer - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard_extensions ([DeclarativeAnalyticalDashboardExtension]): A list of dashboard permissions assigned to a related dashboard.. [optional] # noqa: E501 - analytical_dashboards ([DeclarativeAnalyticalDashboard]): A list of analytical dashboards available in the model.. [optional] # noqa: E501 - attribute_hierarchies ([DeclarativeAttributeHierarchy]): A list of attribute hierarchies.. [optional] # noqa: E501 - dashboard_plugins ([DeclarativeDashboardPlugin]): A list of dashboard plugins available in the model.. [optional] # noqa: E501 - export_definitions ([DeclarativeExportDefinition]): A list of export definitions.. [optional] # noqa: E501 - filter_contexts ([DeclarativeFilterContext]): A list of filter contexts available in the model.. [optional] # noqa: E501 - metrics ([DeclarativeMetric]): A list of metrics available in the model.. [optional] # noqa: E501 - visualization_objects ([DeclarativeVisualizationObject]): A list of visualization objects available in the model.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.pyi index 3bbce5b9e..4c655c957 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.pyi @@ -35,21 +35,21 @@ class DeclarativeAnalyticsLayer( class MetaOapg: - + class properties: - - + + class analyticalDashboardExtensions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeAnalyticalDashboardExtension']: return DeclarativeAnalyticalDashboardExtension - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeAnalyticalDashboardExtension'], typing.List['DeclarativeAnalyticalDashboardExtension']], @@ -60,22 +60,22 @@ class DeclarativeAnalyticsLayer( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeAnalyticalDashboardExtension': return super().__getitem__(i) - - + + class analyticalDashboards( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeAnalyticalDashboard']: return DeclarativeAnalyticalDashboard - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeAnalyticalDashboard'], typing.List['DeclarativeAnalyticalDashboard']], @@ -86,22 +86,22 @@ class DeclarativeAnalyticsLayer( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeAnalyticalDashboard': return super().__getitem__(i) - - + + class dashboardPlugins( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeDashboardPlugin']: return DeclarativeDashboardPlugin - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeDashboardPlugin'], typing.List['DeclarativeDashboardPlugin']], @@ -112,22 +112,22 @@ class DeclarativeAnalyticsLayer( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeDashboardPlugin': return super().__getitem__(i) - - + + class filterContexts( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeFilterContext']: return DeclarativeFilterContext - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeFilterContext'], typing.List['DeclarativeFilterContext']], @@ -138,22 +138,22 @@ class DeclarativeAnalyticsLayer( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeFilterContext': return super().__getitem__(i) - - + + class metrics( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeMetric']: return DeclarativeMetric - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeMetric'], typing.List['DeclarativeMetric']], @@ -164,22 +164,22 @@ class DeclarativeAnalyticsLayer( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeMetric': return super().__getitem__(i) - - + + class visualizationObjects( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeVisualizationObject']: return DeclarativeVisualizationObject - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeVisualizationObject'], typing.List['DeclarativeVisualizationObject']], @@ -190,7 +190,7 @@ class DeclarativeAnalyticsLayer( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeVisualizationObject': return super().__getitem__(i) __annotations__ = { @@ -201,57 +201,57 @@ class DeclarativeAnalyticsLayer( "metrics": metrics, "visualizationObjects": visualizationObjects, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["analyticalDashboardExtensions"]) -> MetaOapg.properties.analyticalDashboardExtensions: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["analyticalDashboards"]) -> MetaOapg.properties.analyticalDashboards: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dashboardPlugins"]) -> MetaOapg.properties.dashboardPlugins: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["filterContexts"]) -> MetaOapg.properties.filterContexts: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["visualizationObjects"]) -> MetaOapg.properties.visualizationObjects: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboardExtensions", "analyticalDashboards", "dashboardPlugins", "filterContexts", "metrics", "visualizationObjects", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboardExtensions"]) -> typing.Union[MetaOapg.properties.analyticalDashboardExtensions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboards"]) -> typing.Union[MetaOapg.properties.analyticalDashboards, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dashboardPlugins"]) -> typing.Union[MetaOapg.properties.dashboardPlugins, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["filterContexts"]) -> typing.Union[MetaOapg.properties.filterContexts, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["visualizationObjects"]) -> typing.Union[MetaOapg.properties.visualizationObjects, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboardExtensions", "analyticalDashboards", "dashboardPlugins", "filterContexts", "metrics", "visualizationObjects", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -278,9 +278,9 @@ class DeclarativeAnalyticsLayer( **kwargs, ) -from gooddata_api_client.model.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard -from gooddata_api_client.model.declarative_analytical_dashboard_extension import DeclarativeAnalyticalDashboardExtension -from gooddata_api_client.model.declarative_dashboard_plugin import DeclarativeDashboardPlugin -from gooddata_api_client.model.declarative_filter_context import DeclarativeFilterContext -from gooddata_api_client.model.declarative_metric import DeclarativeMetric -from gooddata_api_client.model.declarative_visualization_object import DeclarativeVisualizationObject +from gooddata_api_client.models.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard +from gooddata_api_client.models.declarative_analytical_dashboard_extension import DeclarativeAnalyticalDashboardExtension +from gooddata_api_client.models.declarative_dashboard_plugin import DeclarativeDashboardPlugin +from gooddata_api_client.models.declarative_filter_context import DeclarativeFilterContext +from gooddata_api_client.models.declarative_metric import DeclarativeMetric +from gooddata_api_client.models.declarative_visualization_object import DeclarativeVisualizationObject diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_attribute.py b/gooddata-api-client/gooddata_api_client/model/declarative_attribute.py deleted file mode 100644 index f84a98491..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_attribute.py +++ /dev/null @@ -1,359 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_label import DeclarativeLabel - from gooddata_api_client.model.label_identifier import LabelIdentifier - globals()['DeclarativeLabel'] = DeclarativeLabel - globals()['LabelIdentifier'] = LabelIdentifier - - -class DeclarativeAttribute(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('sort_direction',): { - 'ASC': "ASC", - 'DESC': "DESC", - }, - ('source_column_data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('source_column',): { - 'max_length': 255, - }, - ('title',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('sort_column',): { - 'max_length': 255, - }, - ('source_column_data_type',): { - 'max_length': 255, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'labels': ([DeclarativeLabel],), # noqa: E501 - 'source_column': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'default_view': (LabelIdentifier,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'sort_column': (str,), # noqa: E501 - 'sort_direction': (str,), # noqa: E501 - 'source_column_data_type': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'labels': 'labels', # noqa: E501 - 'source_column': 'sourceColumn', # noqa: E501 - 'title': 'title', # noqa: E501 - 'default_view': 'defaultView', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'sort_column': 'sortColumn', # noqa: E501 - 'sort_direction': 'sortDirection', # noqa: E501 - 'source_column_data_type': 'sourceColumnDataType', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, labels, source_column, title, *args, **kwargs): # noqa: E501 - """DeclarativeAttribute - a model defined in OpenAPI - - Args: - id (str): Attribute ID. - labels ([DeclarativeLabel]): An array of attribute labels. - source_column (str): A name of the source column that is the primary label - title (str): Attribute title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - default_view (LabelIdentifier): [optional] # noqa: E501 - description (str): Attribute description.. [optional] # noqa: E501 - is_hidden (bool): If true, this attribute is hidden from AI search results.. [optional] # noqa: E501 - sort_column (str): Attribute sort column.. [optional] # noqa: E501 - sort_direction (str): Attribute sort direction.. [optional] # noqa: E501 - source_column_data_type (str): A type of the source column. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.labels = labels - self.source_column = source_column - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, labels, source_column, title, *args, **kwargs): # noqa: E501 - """DeclarativeAttribute - a model defined in OpenAPI - - Args: - id (str): Attribute ID. - labels ([DeclarativeLabel]): An array of attribute labels. - source_column (str): A name of the source column that is the primary label - title (str): Attribute title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - default_view (LabelIdentifier): [optional] # noqa: E501 - description (str): Attribute description.. [optional] # noqa: E501 - is_hidden (bool): If true, this attribute is hidden from AI search results.. [optional] # noqa: E501 - sort_column (str): Attribute sort column.. [optional] # noqa: E501 - sort_direction (str): Attribute sort direction.. [optional] # noqa: E501 - source_column_data_type (str): A type of the source column. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.labels = labels - self.source_column = source_column - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_attribute.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_attribute.pyi index 276daf66d..13f11df84 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_attribute.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_attribute.pyi @@ -43,27 +43,27 @@ class DeclarativeAttribute( "labels", "sourceColumn", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class labels( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeLabel']: return DeclarativeLabel - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeLabel'], typing.List['DeclarativeLabel']], @@ -74,95 +74,95 @@ class DeclarativeAttribute( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeLabel': return super().__getitem__(i) - - + + class sourceColumn( schemas.StrSchema ): pass - - + + class title( schemas.StrSchema ): pass - + @staticmethod def defaultView() -> typing.Type['LabelIdentifier']: return LabelIdentifier - - + + class description( schemas.StrSchema ): pass - - + + class sortColumn( schemas.StrSchema ): pass - - + + class sortDirection( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ASC(cls): return cls("ASC") - + @schemas.classproperty def DESC(cls): return cls("DESC") - - + + class sourceColumnDataType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def INT(cls): return cls("INT") - + @schemas.classproperty def STRING(cls): return cls("STRING") - + @schemas.classproperty def DATE(cls): return cls("DATE") - + @schemas.classproperty def NUMERIC(cls): return cls("NUMERIC") - + @schemas.classproperty def TIMESTAMP(cls): return cls("TIMESTAMP") - + @schemas.classproperty def TIMESTAMP_TZ(cls): return cls("TIMESTAMP_TZ") - + @schemas.classproperty def BOOLEAN(cls): return cls("BOOLEAN") - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -173,7 +173,7 @@ class DeclarativeAttribute( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) __annotations__ = { @@ -188,86 +188,86 @@ class DeclarativeAttribute( "sourceColumnDataType": sourceColumnDataType, "tags": tags, } - + id: MetaOapg.properties.id title: MetaOapg.properties.title labels: MetaOapg.properties.labels sourceColumn: MetaOapg.properties.sourceColumn - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["labels"]) -> MetaOapg.properties.labels: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sourceColumn"]) -> MetaOapg.properties.sourceColumn: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["defaultView"]) -> 'LabelIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sortColumn"]) -> MetaOapg.properties.sortColumn: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sortDirection"]) -> MetaOapg.properties.sortDirection: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> MetaOapg.properties.sourceColumnDataType: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "labels", "sourceColumn", "title", "defaultView", "description", "sortColumn", "sortDirection", "sourceColumnDataType", "tags", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["labels"]) -> MetaOapg.properties.labels: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sourceColumn"]) -> MetaOapg.properties.sourceColumn: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["defaultView"]) -> typing.Union['LabelIdentifier', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sortColumn"]) -> typing.Union[MetaOapg.properties.sortColumn, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sortDirection"]) -> typing.Union[MetaOapg.properties.sortDirection, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> typing.Union[MetaOapg.properties.sourceColumnDataType, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "labels", "sourceColumn", "title", "defaultView", "description", "sortColumn", "sortDirection", "sourceColumnDataType", "tags", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -302,5 +302,5 @@ class DeclarativeAttribute( **kwargs, ) -from gooddata_api_client.model.declarative_label import DeclarativeLabel -from gooddata_api_client.model.label_identifier import LabelIdentifier +from gooddata_api_client.models.declarative_label import DeclarativeLabel +from gooddata_api_client.models.label_identifier import LabelIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_attribute_hierarchy.py b/gooddata-api-client/gooddata_api_client/model/declarative_attribute_hierarchy.py deleted file mode 100644 index 9b8113093..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_attribute_hierarchy.py +++ /dev/null @@ -1,337 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - from gooddata_api_client.model.json_node import JsonNode - globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - globals()['JsonNode'] = JsonNode - - -class DeclarativeAttributeHierarchy(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('created_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('description',): { - 'max_length': 10000, - }, - ('modified_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (JsonNode,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'created_at': (str, none_type,), # noqa: E501 - 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'modified_at': (str, none_type,), # noqa: E501 - 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'description': 'description', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeAttributeHierarchy - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Attribute hierarchy object ID. - title (str): Attribute hierarchy object title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Attribute hierarchy object description.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeAttributeHierarchy - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Attribute hierarchy object ID. - title (str): Attribute hierarchy object title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Attribute hierarchy object description.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_automation.py b/gooddata-api-client/gooddata_api_client/model/declarative_automation.py deleted file mode 100644 index ab7b92c33..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_automation.py +++ /dev/null @@ -1,449 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.automation_alert import AutomationAlert - from gooddata_api_client.model.automation_dashboard_tabular_export import AutomationDashboardTabularExport - from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient - from gooddata_api_client.model.automation_image_export import AutomationImageExport - from gooddata_api_client.model.automation_metadata import AutomationMetadata - from gooddata_api_client.model.automation_raw_export import AutomationRawExport - from gooddata_api_client.model.automation_schedule import AutomationSchedule - from gooddata_api_client.model.automation_slides_export import AutomationSlidesExport - from gooddata_api_client.model.automation_tabular_export import AutomationTabularExport - from gooddata_api_client.model.automation_visual_export import AutomationVisualExport - from gooddata_api_client.model.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier - from gooddata_api_client.model.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier - from gooddata_api_client.model.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier - from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - globals()['AutomationAlert'] = AutomationAlert - globals()['AutomationDashboardTabularExport'] = AutomationDashboardTabularExport - globals()['AutomationExternalRecipient'] = AutomationExternalRecipient - globals()['AutomationImageExport'] = AutomationImageExport - globals()['AutomationMetadata'] = AutomationMetadata - globals()['AutomationRawExport'] = AutomationRawExport - globals()['AutomationSchedule'] = AutomationSchedule - globals()['AutomationSlidesExport'] = AutomationSlidesExport - globals()['AutomationTabularExport'] = AutomationTabularExport - globals()['AutomationVisualExport'] = AutomationVisualExport - globals()['DeclarativeAnalyticalDashboardIdentifier'] = DeclarativeAnalyticalDashboardIdentifier - globals()['DeclarativeExportDefinitionIdentifier'] = DeclarativeExportDefinitionIdentifier - globals()['DeclarativeNotificationChannelIdentifier'] = DeclarativeNotificationChannelIdentifier - globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - - -class DeclarativeAutomation(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('evaluation_mode',): { - 'SHARED': "SHARED", - 'PER_RECIPIENT': "PER_RECIPIENT", - }, - ('state',): { - 'ACTIVE': "ACTIVE", - 'PAUSED': "PAUSED", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('created_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('dashboard_tabular_exports',): { - }, - ('description',): { - 'max_length': 255, - }, - ('details',): { - }, - ('export_definitions',): { - }, - ('external_recipients',): { - }, - ('image_exports',): { - }, - ('modified_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('raw_exports',): { - }, - ('recipients',): { - }, - ('slides_exports',): { - }, - ('tabular_exports',): { - }, - ('tags',): { - }, - ('title',): { - 'max_length': 255, - }, - ('visual_exports',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'alert': (AutomationAlert,), # noqa: E501 - 'analytical_dashboard': (DeclarativeAnalyticalDashboardIdentifier,), # noqa: E501 - 'created_at': (str, none_type,), # noqa: E501 - 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'dashboard_tabular_exports': ([AutomationDashboardTabularExport],), # noqa: E501 - 'description': (str,), # noqa: E501 - 'details': ({str: (str,)},), # noqa: E501 - 'evaluation_mode': (str,), # noqa: E501 - 'export_definitions': ([DeclarativeExportDefinitionIdentifier],), # noqa: E501 - 'external_recipients': ([AutomationExternalRecipient],), # noqa: E501 - 'image_exports': ([AutomationImageExport],), # noqa: E501 - 'metadata': (AutomationMetadata,), # noqa: E501 - 'modified_at': (str, none_type,), # noqa: E501 - 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'notification_channel': (DeclarativeNotificationChannelIdentifier,), # noqa: E501 - 'raw_exports': ([AutomationRawExport],), # noqa: E501 - 'recipients': ([DeclarativeUserIdentifier],), # noqa: E501 - 'schedule': (AutomationSchedule,), # noqa: E501 - 'slides_exports': ([AutomationSlidesExport],), # noqa: E501 - 'state': (str,), # noqa: E501 - 'tabular_exports': ([AutomationTabularExport],), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - 'visual_exports': ([AutomationVisualExport],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'alert': 'alert', # noqa: E501 - 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'dashboard_tabular_exports': 'dashboardTabularExports', # noqa: E501 - 'description': 'description', # noqa: E501 - 'details': 'details', # noqa: E501 - 'evaluation_mode': 'evaluationMode', # noqa: E501 - 'export_definitions': 'exportDefinitions', # noqa: E501 - 'external_recipients': 'externalRecipients', # noqa: E501 - 'image_exports': 'imageExports', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - 'notification_channel': 'notificationChannel', # noqa: E501 - 'raw_exports': 'rawExports', # noqa: E501 - 'recipients': 'recipients', # noqa: E501 - 'schedule': 'schedule', # noqa: E501 - 'slides_exports': 'slidesExports', # noqa: E501 - 'state': 'state', # noqa: E501 - 'tabular_exports': 'tabularExports', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - 'visual_exports': 'visualExports', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeAutomation - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - alert (AutomationAlert): [optional] # noqa: E501 - analytical_dashboard (DeclarativeAnalyticalDashboardIdentifier): [optional] # noqa: E501 - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - dashboard_tabular_exports ([AutomationDashboardTabularExport]): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - details ({str: (str,)}): TODO. [optional] # noqa: E501 - evaluation_mode (str): Specify automation evaluation mode.. [optional] if omitted the server will use the default value of "PER_RECIPIENT" # noqa: E501 - export_definitions ([DeclarativeExportDefinitionIdentifier]): [optional] # noqa: E501 - external_recipients ([AutomationExternalRecipient]): External recipients of the automation action results.. [optional] # noqa: E501 - image_exports ([AutomationImageExport]): [optional] # noqa: E501 - metadata (AutomationMetadata): [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - notification_channel (DeclarativeNotificationChannelIdentifier): [optional] # noqa: E501 - raw_exports ([AutomationRawExport]): [optional] # noqa: E501 - recipients ([DeclarativeUserIdentifier]): [optional] # noqa: E501 - schedule (AutomationSchedule): [optional] # noqa: E501 - slides_exports ([AutomationSlidesExport]): [optional] # noqa: E501 - state (str): Current state of the automation.. [optional] if omitted the server will use the default value of "ACTIVE" # noqa: E501 - tabular_exports ([AutomationTabularExport]): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - visual_exports ([AutomationVisualExport]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeAutomation - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - alert (AutomationAlert): [optional] # noqa: E501 - analytical_dashboard (DeclarativeAnalyticalDashboardIdentifier): [optional] # noqa: E501 - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - dashboard_tabular_exports ([AutomationDashboardTabularExport]): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - details ({str: (str,)}): TODO. [optional] # noqa: E501 - evaluation_mode (str): Specify automation evaluation mode.. [optional] if omitted the server will use the default value of "PER_RECIPIENT" # noqa: E501 - export_definitions ([DeclarativeExportDefinitionIdentifier]): [optional] # noqa: E501 - external_recipients ([AutomationExternalRecipient]): External recipients of the automation action results.. [optional] # noqa: E501 - image_exports ([AutomationImageExport]): [optional] # noqa: E501 - metadata (AutomationMetadata): [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - notification_channel (DeclarativeNotificationChannelIdentifier): [optional] # noqa: E501 - raw_exports ([AutomationRawExport]): [optional] # noqa: E501 - recipients ([DeclarativeUserIdentifier]): [optional] # noqa: E501 - schedule (AutomationSchedule): [optional] # noqa: E501 - slides_exports ([AutomationSlidesExport]): [optional] # noqa: E501 - state (str): Current state of the automation.. [optional] if omitted the server will use the default value of "ACTIVE" # noqa: E501 - tabular_exports ([AutomationTabularExport]): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - visual_exports ([AutomationVisualExport]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_color_palette.py b/gooddata-api-client/gooddata_api_client/model/declarative_color_palette.py deleted file mode 100644 index 836267092..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_color_palette.py +++ /dev/null @@ -1,291 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_node import JsonNode - globals()['JsonNode'] = JsonNode - - -class DeclarativeColorPalette(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (JsonNode,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, id, name, *args, **kwargs): # noqa: E501 - """DeclarativeColorPalette - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, id, name, *args, **kwargs): # noqa: E501 - """DeclarativeColorPalette - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_column.py b/gooddata-api-client/gooddata_api_client/model/declarative_column.py deleted file mode 100644 index da50679c2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_column.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeColumn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - ('name',): { - 'max_length': 255, - }, - ('referenced_table_column',): { - 'max_length': 255, - }, - ('referenced_table_id',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'data_type': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'is_primary_key': (bool,), # noqa: E501 - 'referenced_table_column': (str,), # noqa: E501 - 'referenced_table_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_type': 'dataType', # noqa: E501 - 'name': 'name', # noqa: E501 - 'is_primary_key': 'isPrimaryKey', # noqa: E501 - 'referenced_table_column': 'referencedTableColumn', # noqa: E501 - 'referenced_table_id': 'referencedTableId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_type, name, *args, **kwargs): # noqa: E501 - """DeclarativeColumn - a model defined in OpenAPI - - Args: - data_type (str): Column type - name (str): Column name - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - is_primary_key (bool): Is column part of primary key?. [optional] # noqa: E501 - referenced_table_column (str): Referenced table (Foreign key). [optional] # noqa: E501 - referenced_table_id (str): Referenced table (Foreign key). [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_type = data_type - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_type, name, *args, **kwargs): # noqa: E501 - """DeclarativeColumn - a model defined in OpenAPI - - Args: - data_type (str): Column type - name (str): Column name - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - is_primary_key (bool): Is column part of primary key?. [optional] # noqa: E501 - referenced_table_column (str): Referenced table (Foreign key). [optional] # noqa: E501 - referenced_table_id (str): Referenced table (Foreign key). [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_type = data_type - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_csp_directive.py b/gooddata-api-client/gooddata_api_client/model/declarative_csp_directive.py deleted file mode 100644 index 497b68aa9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_csp_directive.py +++ /dev/null @@ -1,279 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeCspDirective(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('directive',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'directive': (str,), # noqa: E501 - 'sources': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'directive': 'directive', # noqa: E501 - 'sources': 'sources', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, directive, sources, *args, **kwargs): # noqa: E501 - """DeclarativeCspDirective - a model defined in OpenAPI - - Args: - directive (str): - sources ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.directive = directive - self.sources = sources - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, directive, sources, *args, **kwargs): # noqa: E501 - """DeclarativeCspDirective - a model defined in OpenAPI - - Args: - directive (str): - sources ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.directive = directive - self.sources = sources - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_custom_application_setting.py b/gooddata-api-client/gooddata_api_client/model/declarative_custom_application_setting.py deleted file mode 100644 index ff391768b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_custom_application_setting.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_node import JsonNode - globals()['JsonNode'] = JsonNode - - -class DeclarativeCustomApplicationSetting(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('application_name',): { - 'max_length': 255, - }, - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'application_name': (str,), # noqa: E501 - 'content': (JsonNode,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'application_name': 'applicationName', # noqa: E501 - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, application_name, content, id, *args, **kwargs): # noqa: E501 - """DeclarativeCustomApplicationSetting - a model defined in OpenAPI - - Args: - application_name (str): The application id - content (JsonNode): - id (str): Custom Application Setting ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.application_name = application_name - self.content = content - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, application_name, content, id, *args, **kwargs): # noqa: E501 - """DeclarativeCustomApplicationSetting - a model defined in OpenAPI - - Args: - application_name (str): The application id - content (JsonNode): - id (str): Custom Application Setting ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.application_name = application_name - self.content = content - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_dashboard_plugin.py b/gooddata-api-client/gooddata_api_client/model/declarative_dashboard_plugin.py deleted file mode 100644 index 0e6eb48ea..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_dashboard_plugin.py +++ /dev/null @@ -1,337 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - from gooddata_api_client.model.json_node import JsonNode - globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - globals()['JsonNode'] = JsonNode - - -class DeclarativeDashboardPlugin(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('created_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('description',): { - 'max_length': 10000, - }, - ('modified_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (JsonNode,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'created_at': (str, none_type,), # noqa: E501 - 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'modified_at': (str, none_type,), # noqa: E501 - 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'description': 'description', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeDashboardPlugin - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Dashboard plugin object ID. - title (str): Dashboard plugin object title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Dashboard plugin description.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeDashboardPlugin - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Dashboard plugin object ID. - title (str): Dashboard plugin object title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Dashboard plugin description.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_data_source.py b/gooddata-api-client/gooddata_api_client/model/declarative_data_source.py deleted file mode 100644 index c4d08e989..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_data_source.py +++ /dev/null @@ -1,423 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_data_source_permission import DeclarativeDataSourcePermission - from gooddata_api_client.model.parameter import Parameter - globals()['DeclarativeDataSourcePermission'] = DeclarativeDataSourcePermission - globals()['Parameter'] = Parameter - - -class DeclarativeDataSource(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'POSTGRESQL': "POSTGRESQL", - 'REDSHIFT': "REDSHIFT", - 'VERTICA': "VERTICA", - 'SNOWFLAKE': "SNOWFLAKE", - 'ADS': "ADS", - 'BIGQUERY': "BIGQUERY", - 'MSSQL': "MSSQL", - 'PRESTO': "PRESTO", - 'DREMIO': "DREMIO", - 'DRILL': "DRILL", - 'GREENPLUM': "GREENPLUM", - 'AZURESQL': "AZURESQL", - 'SYNAPSESQL': "SYNAPSESQL", - 'DATABRICKS': "DATABRICKS", - 'GDSTORAGE': "GDSTORAGE", - 'CLICKHOUSE': "CLICKHOUSE", - 'MYSQL': "MYSQL", - 'MARIADB': "MARIADB", - 'ORACLE': "ORACLE", - 'PINOT': "PINOT", - 'SINGLESTORE': "SINGLESTORE", - 'MOTHERDUCK': "MOTHERDUCK", - 'FLEXCONNECT': "FLEXCONNECT", - 'STARROCKS': "STARROCKS", - 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", - }, - ('authentication_type',): { - 'None': None, - 'USERNAME_PASSWORD': "USERNAME_PASSWORD", - 'TOKEN': "TOKEN", - 'KEY_PAIR': "KEY_PAIR", - 'CLIENT_SECRET': "CLIENT_SECRET", - 'ACCESS_TOKEN': "ACCESS_TOKEN", - }, - ('cache_strategy',): { - 'ALWAYS': "ALWAYS", - 'NEVER': "NEVER", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('name',): { - 'max_length': 255, - }, - ('schema',): { - 'max_length': 255, - }, - ('client_id',): { - 'max_length': 255, - }, - ('client_secret',): { - 'max_length': 255, - }, - ('password',): { - 'max_length': 255, - }, - ('private_key',): { - 'max_length': 15000, - }, - ('private_key_passphrase',): { - 'max_length': 255, - }, - ('token',): { - 'max_length': 10000, - }, - ('url',): { - 'max_length': 255, - }, - ('username',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'schema': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'authentication_type': (str, none_type,), # noqa: E501 - 'cache_strategy': (str,), # noqa: E501 - 'client_id': (str,), # noqa: E501 - 'client_secret': (str,), # noqa: E501 - 'decoded_parameters': ([Parameter],), # noqa: E501 - 'parameters': ([Parameter],), # noqa: E501 - 'password': (str,), # noqa: E501 - 'permissions': ([DeclarativeDataSourcePermission],), # noqa: E501 - 'private_key': (str, none_type,), # noqa: E501 - 'private_key_passphrase': (str, none_type,), # noqa: E501 - 'token': (str,), # noqa: E501 - 'url': (str,), # noqa: E501 - 'username': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - 'schema': 'schema', # noqa: E501 - 'type': 'type', # noqa: E501 - 'authentication_type': 'authenticationType', # noqa: E501 - 'cache_strategy': 'cacheStrategy', # noqa: E501 - 'client_id': 'clientId', # noqa: E501 - 'client_secret': 'clientSecret', # noqa: E501 - 'decoded_parameters': 'decodedParameters', # noqa: E501 - 'parameters': 'parameters', # noqa: E501 - 'password': 'password', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - 'private_key': 'privateKey', # noqa: E501 - 'private_key_passphrase': 'privateKeyPassphrase', # noqa: E501 - 'token': 'token', # noqa: E501 - 'url': 'url', # noqa: E501 - 'username': 'username', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, name, schema, type, *args, **kwargs): # noqa: E501 - """DeclarativeDataSource - a model defined in OpenAPI - - Args: - id (str): Data source ID. - name (str): Name of the data source. - schema (str): A scheme/database with the data. - type (str): Type of database. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 - cache_strategy (str): Determines how the results coming from a particular datasource should be cached. - ALWAYS: The results from the datasource should be cached normally (the default). - NEVER: The results from the datasource should never be cached.. [optional] # noqa: E501 - client_id (str): Id of client with permission to connect to the data source.. [optional] # noqa: E501 - client_secret (str): The client secret to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - decoded_parameters ([Parameter]): [optional] # noqa: E501 - parameters ([Parameter]): [optional] # noqa: E501 - password (str): Password for the data-source user, property is never returned back.. [optional] # noqa: E501 - permissions ([DeclarativeDataSourcePermission]): [optional] # noqa: E501 - private_key (str, none_type): The private key to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - private_key_passphrase (str, none_type): The passphrase used to encrypt the private key.. [optional] # noqa: E501 - token (str): Token as an alternative to username and password.. [optional] # noqa: E501 - url (str): An connection string relevant to type of database.. [optional] # noqa: E501 - username (str): User with permission connect the data source/database.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.name = name - self.schema = schema - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, name, schema, type, *args, **kwargs): # noqa: E501 - """DeclarativeDataSource - a model defined in OpenAPI - - Args: - id (str): Data source ID. - name (str): Name of the data source. - schema (str): A scheme/database with the data. - type (str): Type of database. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 - cache_strategy (str): Determines how the results coming from a particular datasource should be cached. - ALWAYS: The results from the datasource should be cached normally (the default). - NEVER: The results from the datasource should never be cached.. [optional] # noqa: E501 - client_id (str): Id of client with permission to connect to the data source.. [optional] # noqa: E501 - client_secret (str): The client secret to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - decoded_parameters ([Parameter]): [optional] # noqa: E501 - parameters ([Parameter]): [optional] # noqa: E501 - password (str): Password for the data-source user, property is never returned back.. [optional] # noqa: E501 - permissions ([DeclarativeDataSourcePermission]): [optional] # noqa: E501 - private_key (str, none_type): The private key to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - private_key_passphrase (str, none_type): The passphrase used to encrypt the private key.. [optional] # noqa: E501 - token (str): Token as an alternative to username and password.. [optional] # noqa: E501 - url (str): An connection string relevant to type of database.. [optional] # noqa: E501 - username (str): User with permission connect the data source/database.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.name = name - self.schema = schema - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_data_source.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_data_source.pyi index ebd8f1c5e..ac6b50ef0 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_data_source.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_data_source.pyi @@ -43,98 +43,98 @@ class DeclarativeDataSource( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class name( schemas.StrSchema ): pass - - + + class schema( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def POSTGRESQL(cls): return cls("POSTGRESQL") - + @schemas.classproperty def REDSHIFT(cls): return cls("REDSHIFT") - + @schemas.classproperty def VERTICA(cls): return cls("VERTICA") - + @schemas.classproperty def SNOWFLAKE(cls): return cls("SNOWFLAKE") - + @schemas.classproperty def ADS(cls): return cls("ADS") - + @schemas.classproperty def BIGQUERY(cls): return cls("BIGQUERY") - + @schemas.classproperty def MSSQL(cls): return cls("MSSQL") - + @schemas.classproperty def PRESTO(cls): return cls("PRESTO") - + @schemas.classproperty def DREMIO(cls): return cls("DREMIO") - + @schemas.classproperty def DRILL(cls): return cls("DRILL") - + @schemas.classproperty def GREENPLUM(cls): return cls("GREENPLUM") - + @schemas.classproperty def AZURESQL(cls): return cls("AZURESQL") - + @schemas.classproperty def SYNAPSESQL(cls): return cls("SYNAPSESQL") - + @schemas.classproperty def DATABRICKS(cls): return cls("DATABRICKS") - - + + class cachePath( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -145,22 +145,22 @@ class DeclarativeDataSource( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class decodedParameters( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['Parameter']: return Parameter - + def __new__( cls, _arg: typing.Union[typing.Tuple['Parameter'], typing.List['Parameter']], @@ -171,23 +171,23 @@ class DeclarativeDataSource( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'Parameter': return super().__getitem__(i) enableCaching = schemas.BoolSchema - - + + class parameters( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['Parameter']: return Parameter - + def __new__( cls, _arg: typing.Union[typing.Tuple['Parameter'], typing.List['Parameter']], @@ -198,32 +198,32 @@ class DeclarativeDataSource( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'Parameter': return super().__getitem__(i) - - + + class password( schemas.StrSchema ): pass - + @staticmethod def pdm() -> typing.Type['DeclarativeTables']: return DeclarativeTables - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeDataSourcePermission']: return DeclarativeDataSourcePermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeDataSourcePermission'], typing.List['DeclarativeDataSourcePermission']], @@ -234,23 +234,23 @@ class DeclarativeDataSource( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeDataSourcePermission': return super().__getitem__(i) - - + + class token( schemas.StrSchema ): pass - - + + class url( schemas.StrSchema ): pass - - + + class username( schemas.StrSchema ): @@ -271,110 +271,110 @@ class DeclarativeDataSource( "url": url, "username": username, } - + schema: MetaOapg.properties.schema name: MetaOapg.properties.name id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["schema"]) -> MetaOapg.properties.schema: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["cachePath"]) -> MetaOapg.properties.cachePath: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["decodedParameters"]) -> MetaOapg.properties.decodedParameters: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["enableCaching"]) -> MetaOapg.properties.enableCaching: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["parameters"]) -> MetaOapg.properties.parameters: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["password"]) -> MetaOapg.properties.password: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["pdm"]) -> 'DeclarativeTables': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["token"]) -> MetaOapg.properties.token: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["url"]) -> MetaOapg.properties.url: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["username"]) -> MetaOapg.properties.username: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "name", "schema", "type", "cachePath", "decodedParameters", "enableCaching", "parameters", "password", "pdm", "permissions", "token", "url", "username", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["schema"]) -> MetaOapg.properties.schema: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["cachePath"]) -> typing.Union[MetaOapg.properties.cachePath, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["decodedParameters"]) -> typing.Union[MetaOapg.properties.decodedParameters, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["enableCaching"]) -> typing.Union[MetaOapg.properties.enableCaching, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["parameters"]) -> typing.Union[MetaOapg.properties.parameters, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["password"]) -> typing.Union[MetaOapg.properties.password, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["pdm"]) -> typing.Union['DeclarativeTables', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["token"]) -> typing.Union[MetaOapg.properties.token, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["url"]) -> typing.Union[MetaOapg.properties.url, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["username"]) -> typing.Union[MetaOapg.properties.username, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "name", "schema", "type", "cachePath", "decodedParameters", "enableCaching", "parameters", "password", "pdm", "permissions", "token", "url", "username", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -417,6 +417,6 @@ class DeclarativeDataSource( **kwargs, ) -from gooddata_api_client.model.declarative_data_source_permission import DeclarativeDataSourcePermission -from gooddata_api_client.model.declarative_tables import DeclarativeTables -from gooddata_api_client.model.parameter import Parameter +from gooddata_api_client.models.declarative_data_source_permission import DeclarativeDataSourcePermission +from gooddata_api_client.models.declarative_tables import DeclarativeTables +from gooddata_api_client.models.parameter import Parameter diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permission.py b/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permission.py deleted file mode 100644 index b3dd238b1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permission.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - globals()['AssigneeIdentifier'] = AssigneeIdentifier - - -class DeclarativeDataSourcePermission(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'MANAGE': "MANAGE", - 'USE': "USE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee': (AssigneeIdentifier,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee': 'assignee', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, assignee, name, *args, **kwargs): # noqa: E501 - """DeclarativeDataSourcePermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - name (str): Permission name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, assignee, name, *args, **kwargs): # noqa: E501 - """DeclarativeDataSourcePermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - name (str): Permission name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permission.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permission.pyi index 3e712c0d7..bf3741bf0 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permission.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permission.pyi @@ -39,23 +39,23 @@ class DeclarativeDataSourcePermission( "name", "assignee", } - + class properties: - + @staticmethod def assignee() -> typing.Type['AssigneeIdentifier']: return AssigneeIdentifier - - + + class name( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def MANAGE(cls): return cls("MANAGE") - + @schemas.classproperty def USE(cls): return cls("USE") @@ -63,36 +63,36 @@ class DeclarativeDataSourcePermission( "assignee": assignee, "name": name, } - + name: MetaOapg.properties.name assignee: 'AssigneeIdentifier' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -111,4 +111,4 @@ class DeclarativeDataSourcePermission( **kwargs, ) -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permissions.py b/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permissions.py deleted file mode 100644 index 52b65d969..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permissions.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_data_source_permission import DeclarativeDataSourcePermission - globals()['DeclarativeDataSourcePermission'] = DeclarativeDataSourcePermission - - -class DeclarativeDataSourcePermissions(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'permissions': ([DeclarativeDataSourcePermission],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeDataSourcePermissions - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([DeclarativeDataSourcePermission]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeDataSourcePermissions - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([DeclarativeDataSourcePermission]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_data_sources.py b/gooddata-api-client/gooddata_api_client/model/declarative_data_sources.py deleted file mode 100644 index a7a645fb2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_data_sources.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_data_source import DeclarativeDataSource - globals()['DeclarativeDataSource'] = DeclarativeDataSource - - -class DeclarativeDataSources(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data_sources': ([DeclarativeDataSource],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_sources': 'dataSources', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_sources, *args, **kwargs): # noqa: E501 - """DeclarativeDataSources - a model defined in OpenAPI - - Args: - data_sources ([DeclarativeDataSource]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_sources = data_sources - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_sources, *args, **kwargs): # noqa: E501 - """DeclarativeDataSources - a model defined in OpenAPI - - Args: - data_sources ([DeclarativeDataSource]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_sources = data_sources - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_data_sources.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_data_sources.pyi index 0843cdcc3..7c1553130 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_data_sources.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_data_sources.pyi @@ -40,21 +40,21 @@ class DeclarativeDataSources( required = { "dataSources", } - + class properties: - - + + class dataSources( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeDataSource']: return DeclarativeDataSource - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeDataSource'], typing.List['DeclarativeDataSource']], @@ -65,35 +65,35 @@ class DeclarativeDataSources( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeDataSource': return super().__getitem__(i) __annotations__ = { "dataSources": dataSources, } - + dataSources: MetaOapg.properties.dataSources - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataSources"]) -> MetaOapg.properties.dataSources: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataSources", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataSources"]) -> MetaOapg.properties.dataSources: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataSources", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -110,4 +110,4 @@ class DeclarativeDataSources( **kwargs, ) -from gooddata_api_client.model.declarative_data_source import DeclarativeDataSource +from gooddata_api_client.models.declarative_data_source import DeclarativeDataSource diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_dataset.py b/gooddata-api-client/gooddata_api_client/model/declarative_dataset.py deleted file mode 100644 index 7076567a8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_dataset.py +++ /dev/null @@ -1,366 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.data_source_table_identifier import DataSourceTableIdentifier - from gooddata_api_client.model.declarative_aggregated_fact import DeclarativeAggregatedFact - from gooddata_api_client.model.declarative_attribute import DeclarativeAttribute - from gooddata_api_client.model.declarative_dataset_sql import DeclarativeDatasetSql - from gooddata_api_client.model.declarative_fact import DeclarativeFact - from gooddata_api_client.model.declarative_reference import DeclarativeReference - from gooddata_api_client.model.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn - from gooddata_api_client.model.declarative_workspace_data_filter_references import DeclarativeWorkspaceDataFilterReferences - from gooddata_api_client.model.grain_identifier import GrainIdentifier - globals()['DataSourceTableIdentifier'] = DataSourceTableIdentifier - globals()['DeclarativeAggregatedFact'] = DeclarativeAggregatedFact - globals()['DeclarativeAttribute'] = DeclarativeAttribute - globals()['DeclarativeDatasetSql'] = DeclarativeDatasetSql - globals()['DeclarativeFact'] = DeclarativeFact - globals()['DeclarativeReference'] = DeclarativeReference - globals()['DeclarativeWorkspaceDataFilterColumn'] = DeclarativeWorkspaceDataFilterColumn - globals()['DeclarativeWorkspaceDataFilterReferences'] = DeclarativeWorkspaceDataFilterReferences - globals()['GrainIdentifier'] = GrainIdentifier - - -class DeclarativeDataset(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('precedence',): { - 'inclusive_minimum': 0, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'grain': ([GrainIdentifier],), # noqa: E501 - 'id': (str,), # noqa: E501 - 'references': ([DeclarativeReference],), # noqa: E501 - 'title': (str,), # noqa: E501 - 'aggregated_facts': ([DeclarativeAggregatedFact],), # noqa: E501 - 'attributes': ([DeclarativeAttribute],), # noqa: E501 - 'data_source_table_id': (DataSourceTableIdentifier,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'facts': ([DeclarativeFact],), # noqa: E501 - 'precedence': (int,), # noqa: E501 - 'sql': (DeclarativeDatasetSql,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'workspace_data_filter_columns': ([DeclarativeWorkspaceDataFilterColumn],), # noqa: E501 - 'workspace_data_filter_references': ([DeclarativeWorkspaceDataFilterReferences],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'grain': 'grain', # noqa: E501 - 'id': 'id', # noqa: E501 - 'references': 'references', # noqa: E501 - 'title': 'title', # noqa: E501 - 'aggregated_facts': 'aggregatedFacts', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'data_source_table_id': 'dataSourceTableId', # noqa: E501 - 'description': 'description', # noqa: E501 - 'facts': 'facts', # noqa: E501 - 'precedence': 'precedence', # noqa: E501 - 'sql': 'sql', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'workspace_data_filter_columns': 'workspaceDataFilterColumns', # noqa: E501 - 'workspace_data_filter_references': 'workspaceDataFilterReferences', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, grain, id, references, title, *args, **kwargs): # noqa: E501 - """DeclarativeDataset - a model defined in OpenAPI - - Args: - grain ([GrainIdentifier]): An array of grain identifiers. - id (str): The Dataset ID. This ID is further used to refer to this instance of dataset. - references ([DeclarativeReference]): An array of references. - title (str): A dataset title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aggregated_facts ([DeclarativeAggregatedFact]): An array of aggregated facts.. [optional] # noqa: E501 - attributes ([DeclarativeAttribute]): An array of attributes.. [optional] # noqa: E501 - data_source_table_id (DataSourceTableIdentifier): [optional] # noqa: E501 - description (str): A dataset description.. [optional] # noqa: E501 - facts ([DeclarativeFact]): An array of facts.. [optional] # noqa: E501 - precedence (int): Precedence used in aggregate awareness.. [optional] # noqa: E501 - sql (DeclarativeDatasetSql): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - workspace_data_filter_columns ([DeclarativeWorkspaceDataFilterColumn]): An array of columns which are available for match to implicit workspace data filters.. [optional] # noqa: E501 - workspace_data_filter_references ([DeclarativeWorkspaceDataFilterReferences]): An array of explicit workspace data filters.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.grain = grain - self.id = id - self.references = references - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, grain, id, references, title, *args, **kwargs): # noqa: E501 - """DeclarativeDataset - a model defined in OpenAPI - - Args: - grain ([GrainIdentifier]): An array of grain identifiers. - id (str): The Dataset ID. This ID is further used to refer to this instance of dataset. - references ([DeclarativeReference]): An array of references. - title (str): A dataset title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aggregated_facts ([DeclarativeAggregatedFact]): An array of aggregated facts.. [optional] # noqa: E501 - attributes ([DeclarativeAttribute]): An array of attributes.. [optional] # noqa: E501 - data_source_table_id (DataSourceTableIdentifier): [optional] # noqa: E501 - description (str): A dataset description.. [optional] # noqa: E501 - facts ([DeclarativeFact]): An array of facts.. [optional] # noqa: E501 - precedence (int): Precedence used in aggregate awareness.. [optional] # noqa: E501 - sql (DeclarativeDatasetSql): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - workspace_data_filter_columns ([DeclarativeWorkspaceDataFilterColumn]): An array of columns which are available for match to implicit workspace data filters.. [optional] # noqa: E501 - workspace_data_filter_references ([DeclarativeWorkspaceDataFilterReferences]): An array of explicit workspace data filters.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.grain = grain - self.id = id - self.references = references - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_dataset.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_dataset.pyi index c877d13d4..b8f27735c 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_dataset.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_dataset.pyi @@ -43,21 +43,21 @@ class DeclarativeDataset( "id", "title", } - + class properties: - - + + class grain( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['GrainIdentifier']: return GrainIdentifier - + def __new__( cls, _arg: typing.Union[typing.Tuple['GrainIdentifier'], typing.List['GrainIdentifier']], @@ -68,28 +68,28 @@ class DeclarativeDataset( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'GrainIdentifier': return super().__getitem__(i) - - + + class id( schemas.StrSchema ): pass - - + + class references( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeReference']: return DeclarativeReference - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeReference'], typing.List['DeclarativeReference']], @@ -100,28 +100,28 @@ class DeclarativeDataset( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeReference': return super().__getitem__(i) - - + + class title( schemas.StrSchema ): pass - - + + class attributes( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeAttribute']: return DeclarativeAttribute - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeAttribute'], typing.List['DeclarativeAttribute']], @@ -132,32 +132,32 @@ class DeclarativeDataset( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeAttribute': return super().__getitem__(i) - + @staticmethod def dataSourceTableId() -> typing.Type['DataSourceTableIdentifier']: return DataSourceTableIdentifier - - + + class description( schemas.StrSchema ): pass - - + + class facts( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeFact']: return DeclarativeFact - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeFact'], typing.List['DeclarativeFact']], @@ -168,23 +168,23 @@ class DeclarativeDataset( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeFact': return super().__getitem__(i) - + @staticmethod def sql() -> typing.Type['DeclarativeDatasetSql']: return DeclarativeDatasetSql - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -195,22 +195,22 @@ class DeclarativeDataset( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class workspaceDataFilterColumns( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeWorkspaceDataFilterColumn']: return DeclarativeWorkspaceDataFilterColumn - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeWorkspaceDataFilterColumn'], typing.List['DeclarativeWorkspaceDataFilterColumn']], @@ -221,7 +221,7 @@ class DeclarativeDataset( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeWorkspaceDataFilterColumn': return super().__getitem__(i) __annotations__ = { @@ -237,92 +237,92 @@ class DeclarativeDataset( "tags": tags, "workspaceDataFilterColumns": workspaceDataFilterColumns, } - + references: MetaOapg.properties.references grain: MetaOapg.properties.grain id: MetaOapg.properties.id title: MetaOapg.properties.title - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["grain"]) -> MetaOapg.properties.grain: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["references"]) -> MetaOapg.properties.references: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataSourceTableId"]) -> 'DataSourceTableIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["facts"]) -> MetaOapg.properties.facts: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sql"]) -> 'DeclarativeDatasetSql': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["workspaceDataFilterColumns"]) -> MetaOapg.properties.workspaceDataFilterColumns: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["grain", "id", "references", "title", "attributes", "dataSourceTableId", "description", "facts", "sql", "tags", "workspaceDataFilterColumns", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["grain"]) -> MetaOapg.properties.grain: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["references"]) -> MetaOapg.properties.references: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataSourceTableId"]) -> typing.Union['DataSourceTableIdentifier', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["facts"]) -> typing.Union[MetaOapg.properties.facts, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sql"]) -> typing.Union['DeclarativeDatasetSql', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["workspaceDataFilterColumns"]) -> typing.Union[MetaOapg.properties.workspaceDataFilterColumns, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["grain", "id", "references", "title", "attributes", "dataSourceTableId", "description", "facts", "sql", "tags", "workspaceDataFilterColumns", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -359,10 +359,10 @@ class DeclarativeDataset( **kwargs, ) -from gooddata_api_client.model.data_source_table_identifier import DataSourceTableIdentifier -from gooddata_api_client.model.declarative_attribute import DeclarativeAttribute -from gooddata_api_client.model.declarative_dataset_sql import DeclarativeDatasetSql -from gooddata_api_client.model.declarative_fact import DeclarativeFact -from gooddata_api_client.model.declarative_reference import DeclarativeReference -from gooddata_api_client.model.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn -from gooddata_api_client.model.grain_identifier import GrainIdentifier +from gooddata_api_client.models.data_source_table_identifier import DataSourceTableIdentifier +from gooddata_api_client.models.declarative_attribute import DeclarativeAttribute +from gooddata_api_client.models.declarative_dataset_sql import DeclarativeDatasetSql +from gooddata_api_client.models.declarative_fact import DeclarativeFact +from gooddata_api_client.models.declarative_reference import DeclarativeReference +from gooddata_api_client.models.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn +from gooddata_api_client.models.grain_identifier import GrainIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_dataset_extension.py b/gooddata-api-client/gooddata_api_client/model/declarative_dataset_extension.py deleted file mode 100644 index 509dd2955..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_dataset_extension.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_workspace_data_filter_references import DeclarativeWorkspaceDataFilterReferences - globals()['DeclarativeWorkspaceDataFilterReferences'] = DeclarativeWorkspaceDataFilterReferences - - -class DeclarativeDatasetExtension(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'workspace_data_filter_references': ([DeclarativeWorkspaceDataFilterReferences],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'workspace_data_filter_references': 'workspaceDataFilterReferences', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeDatasetExtension - a model defined in OpenAPI - - Args: - id (str): The Dataset ID. This ID is further used to refer to this instance of dataset. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - workspace_data_filter_references ([DeclarativeWorkspaceDataFilterReferences]): An array of explicit workspace data filters.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeDatasetExtension - a model defined in OpenAPI - - Args: - id (str): The Dataset ID. This ID is further used to refer to this instance of dataset. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - workspace_data_filter_references ([DeclarativeWorkspaceDataFilterReferences]): An array of explicit workspace data filters.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_dataset_sql.py b/gooddata-api-client/gooddata_api_client/model/declarative_dataset_sql.py deleted file mode 100644 index b4085d467..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_dataset_sql.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeDatasetSql(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'data_source_id': (str,), # noqa: E501 - 'statement': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_source_id': 'dataSourceId', # noqa: E501 - 'statement': 'statement', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_source_id, statement, *args, **kwargs): # noqa: E501 - """DeclarativeDatasetSql - a model defined in OpenAPI - - Args: - data_source_id (str): Data source ID. - statement (str): SQL statement. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_source_id = data_source_id - self.statement = statement - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_source_id, statement, *args, **kwargs): # noqa: E501 - """DeclarativeDatasetSql - a model defined in OpenAPI - - Args: - data_source_id (str): Data source ID. - statement (str): SQL statement. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_source_id = data_source_id - self.statement = statement - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.py b/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.py deleted file mode 100644 index e28e751b2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.py +++ /dev/null @@ -1,333 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.granularities_formatting import GranularitiesFormatting - globals()['GranularitiesFormatting'] = GranularitiesFormatting - - -class DeclarativeDateDataset(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularities',): { - 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", - 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", - 'HOUR_OF_DAY': "HOUR_OF_DAY", - 'DAY_OF_WEEK': "DAY_OF_WEEK", - 'DAY_OF_MONTH': "DAY_OF_MONTH", - 'DAY_OF_QUARTER': "DAY_OF_QUARTER", - 'DAY_OF_YEAR': "DAY_OF_YEAR", - 'WEEK_OF_YEAR': "WEEK_OF_YEAR", - 'MONTH_OF_YEAR': "MONTH_OF_YEAR", - 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'granularities': ([str],), # noqa: E501 - 'granularities_formatting': (GranularitiesFormatting,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'granularities': 'granularities', # noqa: E501 - 'granularities_formatting': 'granularitiesFormatting', # noqa: E501 - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'description': 'description', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, granularities, granularities_formatting, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeDateDataset - a model defined in OpenAPI - - Args: - granularities ([str]): An array of date granularities. All listed granularities will be available for date dataset. - granularities_formatting (GranularitiesFormatting): - id (str): Date dataset ID. - title (str): Date dataset title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Date dataset description.. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.granularities = granularities - self.granularities_formatting = granularities_formatting - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, granularities, granularities_formatting, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeDateDataset - a model defined in OpenAPI - - Args: - granularities ([str]): An array of date granularities. All listed granularities will be available for date dataset. - granularities_formatting (GranularitiesFormatting): - id (str): Date dataset ID. - title (str): Date dataset title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Date dataset description.. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.granularities = granularities - self.granularities_formatting = granularities_formatting - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.pyi index 557677da5..2227086ba 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.pyi @@ -43,83 +43,83 @@ class DeclarativeDateDataset( "title", "granularities", } - + class properties: - - + + class granularities( schemas.ListSchema ): - - + + class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def MINUTE(cls): return cls("MINUTE") - + @schemas.classproperty def HOUR(cls): return cls("HOUR") - + @schemas.classproperty def DAY(cls): return cls("DAY") - + @schemas.classproperty def WEEK(cls): return cls("WEEK") - + @schemas.classproperty def MONTH(cls): return cls("MONTH") - + @schemas.classproperty def QUARTER(cls): return cls("QUARTER") - + @schemas.classproperty def YEAR(cls): return cls("YEAR") - + @schemas.classproperty def MINUTE_OF_HOUR(cls): return cls("MINUTE_OF_HOUR") - + @schemas.classproperty def HOUR_OF_DAY(cls): return cls("HOUR_OF_DAY") - + @schemas.classproperty def DAY_OF_WEEK(cls): return cls("DAY_OF_WEEK") - + @schemas.classproperty def DAY_OF_MONTH(cls): return cls("DAY_OF_MONTH") - + @schemas.classproperty def DAY_OF_YEAR(cls): return cls("DAY_OF_YEAR") - + @schemas.classproperty def WEEK_OF_YEAR(cls): return cls("WEEK_OF_YEAR") - + @schemas.classproperty def MONTH_OF_YEAR(cls): return cls("MONTH_OF_YEAR") - + @schemas.classproperty def QUARTER_OF_YEAR(cls): return cls("QUARTER_OF_YEAR") - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -130,41 +130,41 @@ class DeclarativeDateDataset( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - + @staticmethod def granularitiesFormatting() -> typing.Type['GranularitiesFormatting']: return GranularitiesFormatting - - + + class id( schemas.StrSchema ): pass - - + + class title( schemas.StrSchema ): pass - - + + class description( schemas.StrSchema ): pass - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -175,7 +175,7 @@ class DeclarativeDateDataset( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) __annotations__ = { @@ -186,62 +186,62 @@ class DeclarativeDateDataset( "description": description, "tags": tags, } - + granularitiesFormatting: 'GranularitiesFormatting' id: MetaOapg.properties.id title: MetaOapg.properties.title granularities: MetaOapg.properties.granularities - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["granularities"]) -> MetaOapg.properties.granularities: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["granularitiesFormatting"]) -> 'GranularitiesFormatting': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["granularities", "granularitiesFormatting", "id", "title", "description", "tags", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["granularities"]) -> MetaOapg.properties.granularities: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["granularitiesFormatting"]) -> 'GranularitiesFormatting': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["granularities", "granularitiesFormatting", "id", "title", "description", "tags", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -268,4 +268,4 @@ class DeclarativeDateDataset( **kwargs, ) -from gooddata_api_client.model.granularities_formatting import GranularitiesFormatting +from gooddata_api_client.models.granularities_formatting import GranularitiesFormatting diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition.py b/gooddata-api-client/gooddata_api_client/model/declarative_export_definition.py deleted file mode 100644 index 4a69b7a09..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition.py +++ /dev/null @@ -1,335 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_export_definition_request_payload import DeclarativeExportDefinitionRequestPayload - from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - globals()['DeclarativeExportDefinitionRequestPayload'] = DeclarativeExportDefinitionRequestPayload - globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - - -class DeclarativeExportDefinition(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('created_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('description',): { - 'max_length': 10000, - }, - ('modified_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'created_at': (str, none_type,), # noqa: E501 - 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'modified_at': (str, none_type,), # noqa: E501 - 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'request_payload': (DeclarativeExportDefinitionRequestPayload,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'description': 'description', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - 'request_payload': 'requestPayload', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeExportDefinition - a model defined in OpenAPI - - Args: - id (str): Export definition id. - title (str): Export definition object title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Export definition object description.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - request_payload (DeclarativeExportDefinitionRequestPayload): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeExportDefinition - a model defined in OpenAPI - - Args: - id (str): Export definition id. - title (str): Export definition object title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Export definition object description.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - request_payload (DeclarativeExportDefinitionRequestPayload): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_identifier.py b/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_identifier.py deleted file mode 100644 index d6af4d8cc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeExportDefinitionIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTDEFINITION': "exportDefinition", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeExportDefinitionIdentifier - a model defined in OpenAPI - - Args: - id (str): Export definition identifier. - - Keyword Args: - type (str): A type.. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeExportDefinitionIdentifier - a model defined in OpenAPI - - Args: - id (str): Export definition identifier. - - Keyword Args: - type (str): A type.. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_request_payload.py b/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_request_payload.py deleted file mode 100644 index 9fb69bc0a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_request_payload.py +++ /dev/null @@ -1,369 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.custom_override import CustomOverride - from gooddata_api_client.model.settings import Settings - from gooddata_api_client.model.tabular_export_request import TabularExportRequest - from gooddata_api_client.model.visual_export_request import VisualExportRequest - globals()['CustomOverride'] = CustomOverride - globals()['Settings'] = Settings - globals()['TabularExportRequest'] = TabularExportRequest - globals()['VisualExportRequest'] = VisualExportRequest - - -class DeclarativeExportDefinitionRequestPayload(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('format',): { - 'CSV': "CSV", - 'XLSX': "XLSX", - 'HTML': "HTML", - 'PDF': "PDF", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'custom_override': (CustomOverride,), # noqa: E501 - 'execution_result': (str,), # noqa: E501 - 'metadata': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'related_dashboard_id': (str,), # noqa: E501 - 'settings': (Settings,), # noqa: E501 - 'visualization_object': (str,), # noqa: E501 - 'visualization_object_custom_filters': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 - 'file_name': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - 'dashboard_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'custom_override': 'customOverride', # noqa: E501 - 'execution_result': 'executionResult', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - 'related_dashboard_id': 'relatedDashboardId', # noqa: E501 - 'settings': 'settings', # noqa: E501 - 'visualization_object': 'visualizationObject', # noqa: E501 - 'visualization_object_custom_filters': 'visualizationObjectCustomFilters', # noqa: E501 - 'file_name': 'fileName', # noqa: E501 - 'format': 'format', # noqa: E501 - 'dashboard_id': 'dashboardId', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeExportDefinitionRequestPayload - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_override (CustomOverride): [optional] # noqa: E501 - execution_result (str): Execution result identifier.. [optional] # noqa: E501 - metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Metadata definition in free-form JSON format.. [optional] # noqa: E501 - related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 - settings (Settings): [optional] # noqa: E501 - visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 - visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 - file_name (str): File name to be used for retrieving the pdf document.. [optional] # noqa: E501 - format (str): Expected file format.. [optional] # noqa: E501 - dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeExportDefinitionRequestPayload - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_override (CustomOverride): [optional] # noqa: E501 - execution_result (str): Execution result identifier.. [optional] # noqa: E501 - metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Metadata definition in free-form JSON format.. [optional] # noqa: E501 - related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 - settings (Settings): [optional] # noqa: E501 - visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 - visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 - file_name (str): File name to be used for retrieving the pdf document.. [optional] # noqa: E501 - format (str): Expected file format.. [optional] # noqa: E501 - dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - TabularExportRequest, - VisualExportRequest, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_template.py b/gooddata-api-client/gooddata_api_client/model/declarative_export_template.py deleted file mode 100644 index 60e91bbe9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_export_template.py +++ /dev/null @@ -1,300 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dashboard_slides_template import DashboardSlidesTemplate - from gooddata_api_client.model.widget_slides_template import WidgetSlidesTemplate - globals()['DashboardSlidesTemplate'] = DashboardSlidesTemplate - globals()['WidgetSlidesTemplate'] = WidgetSlidesTemplate - - -class DeclarativeExportTemplate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'dashboard_slides_template': (DashboardSlidesTemplate,), # noqa: E501 - 'widget_slides_template': (WidgetSlidesTemplate,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - 'dashboard_slides_template': 'dashboardSlidesTemplate', # noqa: E501 - 'widget_slides_template': 'widgetSlidesTemplate', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 - """DeclarativeExportTemplate - a model defined in OpenAPI - - Args: - id (str): Identifier of an export template - name (str): Name of an export template. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_slides_template (DashboardSlidesTemplate): [optional] # noqa: E501 - widget_slides_template (WidgetSlidesTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, name, *args, **kwargs): # noqa: E501 - """DeclarativeExportTemplate - a model defined in OpenAPI - - Args: - id (str): Identifier of an export template - name (str): Name of an export template. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_slides_template (DashboardSlidesTemplate): [optional] # noqa: E501 - widget_slides_template (WidgetSlidesTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_templates.py b/gooddata-api-client/gooddata_api_client/model/declarative_export_templates.py deleted file mode 100644 index db3e3d55d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_export_templates.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_export_template import DeclarativeExportTemplate - globals()['DeclarativeExportTemplate'] = DeclarativeExportTemplate - - -class DeclarativeExportTemplates(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'export_templates': ([DeclarativeExportTemplate],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'export_templates': 'exportTemplates', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, export_templates, *args, **kwargs): # noqa: E501 - """DeclarativeExportTemplates - a model defined in OpenAPI - - Args: - export_templates ([DeclarativeExportTemplate]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.export_templates = export_templates - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, export_templates, *args, **kwargs): # noqa: E501 - """DeclarativeExportTemplates - a model defined in OpenAPI - - Args: - export_templates ([DeclarativeExportTemplate]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.export_templates = export_templates - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_fact.py b/gooddata-api-client/gooddata_api_client/model/declarative_fact.py deleted file mode 100644 index 14f059876..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_fact.py +++ /dev/null @@ -1,326 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeFact(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('source_column_data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('source_column',): { - 'max_length': 255, - }, - ('title',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('source_column_data_type',): { - 'max_length': 255, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'source_column': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'source_column_data_type': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'source_column': 'sourceColumn', # noqa: E501 - 'title': 'title', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'source_column_data_type': 'sourceColumnDataType', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, source_column, title, *args, **kwargs): # noqa: E501 - """DeclarativeFact - a model defined in OpenAPI - - Args: - id (str): Fact ID. - source_column (str): A name of the source column in the table. - title (str): Fact title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Fact description.. [optional] # noqa: E501 - is_hidden (bool): If true, this fact is hidden from AI search results.. [optional] # noqa: E501 - source_column_data_type (str): A type of the source column. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.source_column = source_column - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, source_column, title, *args, **kwargs): # noqa: E501 - """DeclarativeFact - a model defined in OpenAPI - - Args: - id (str): Fact ID. - source_column (str): A name of the source column in the table. - title (str): Fact title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Fact description.. [optional] # noqa: E501 - is_hidden (bool): If true, this fact is hidden from AI search results.. [optional] # noqa: E501 - source_column_data_type (str): A type of the source column. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.source_column = source_column - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_filter_context.py b/gooddata-api-client/gooddata_api_client/model/declarative_filter_context.py deleted file mode 100644 index 9a8844861..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_filter_context.py +++ /dev/null @@ -1,309 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_node import JsonNode - globals()['JsonNode'] = JsonNode - - -class DeclarativeFilterContext(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (JsonNode,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'description': 'description', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeFilterContext - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Filter Context ID. - title (str): Filter Context title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Filter Context description.. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeFilterContext - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Filter Context ID. - title (str): Filter Context title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Filter Context description.. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_filter_view.py b/gooddata-api-client/gooddata_api_client/model/declarative_filter_view.py deleted file mode 100644 index c302b8a48..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_filter_view.py +++ /dev/null @@ -1,323 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier - from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - from gooddata_api_client.model.json_node import JsonNode - globals()['DeclarativeAnalyticalDashboardIdentifier'] = DeclarativeAnalyticalDashboardIdentifier - globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - globals()['JsonNode'] = JsonNode - - -class DeclarativeFilterView(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 255, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'analytical_dashboard': (DeclarativeAnalyticalDashboardIdentifier,), # noqa: E501 - 'content': (JsonNode,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_default': (bool,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'user': (DeclarativeUserIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 - 'content': 'content', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_default': 'isDefault', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'user': 'user', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeFilterView - a model defined in OpenAPI - - Args: - id (str): FilterView object ID. - title (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (DeclarativeAnalyticalDashboardIdentifier): [optional] # noqa: E501 - content (JsonNode): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_default (bool): Indicator whether the filter view should by applied by default.. [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - user (DeclarativeUserIdentifier): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeFilterView - a model defined in OpenAPI - - Args: - id (str): FilterView object ID. - title (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (DeclarativeAnalyticalDashboardIdentifier): [optional] # noqa: E501 - content (JsonNode): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_default (bool): Indicator whether the filter view should by applied by default.. [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - user (DeclarativeUserIdentifier): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider.py b/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider.py deleted file mode 100644 index b178be39f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider.py +++ /dev/null @@ -1,347 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeIdentityProvider(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('idp_type',): { - 'MANAGED_IDP': "MANAGED_IDP", - 'FIM_IDP': "FIM_IDP", - 'DEX_IDP': "DEX_IDP", - 'CUSTOM_IDP': "CUSTOM_IDP", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('custom_claim_mapping',): { - }, - ('oauth_client_id',): { - 'max_length': 255, - }, - ('oauth_client_secret',): { - 'max_length': 255, - }, - ('oauth_custom_auth_attributes',): { - }, - ('oauth_issuer_id',): { - 'max_length': 255, - }, - ('oauth_issuer_location',): { - 'max_length': 255, - }, - ('oauth_subject_id_claim',): { - 'max_length': 255, - }, - ('saml_metadata',): { - 'max_length': 15000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'custom_claim_mapping': ({str: (str,)},), # noqa: E501 - 'identifiers': ([str],), # noqa: E501 - 'idp_type': (str,), # noqa: E501 - 'oauth_client_id': (str,), # noqa: E501 - 'oauth_client_secret': (str,), # noqa: E501 - 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 - 'oauth_custom_scopes': ([str], none_type,), # noqa: E501 - 'oauth_issuer_id': (str,), # noqa: E501 - 'oauth_issuer_location': (str,), # noqa: E501 - 'oauth_subject_id_claim': (str,), # noqa: E501 - 'saml_metadata': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'custom_claim_mapping': 'customClaimMapping', # noqa: E501 - 'identifiers': 'identifiers', # noqa: E501 - 'idp_type': 'idpType', # noqa: E501 - 'oauth_client_id': 'oauthClientId', # noqa: E501 - 'oauth_client_secret': 'oauthClientSecret', # noqa: E501 - 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 - 'oauth_custom_scopes': 'oauthCustomScopes', # noqa: E501 - 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 - 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 - 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 - 'saml_metadata': 'samlMetadata', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeIdentityProvider - a model defined in OpenAPI - - Args: - id (str): FilterView object ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_claim_mapping ({str: (str,)}): Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.. [optional] # noqa: E501 - identifiers ([str]): List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.. [optional] # noqa: E501 - idp_type (str): Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.. [optional] # noqa: E501 - oauth_client_id (str): The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_client_secret (str): The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): The location of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - saml_metadata (str): Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeIdentityProvider - a model defined in OpenAPI - - Args: - id (str): FilterView object ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_claim_mapping ({str: (str,)}): Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.. [optional] # noqa: E501 - identifiers ([str]): List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.. [optional] # noqa: E501 - idp_type (str): Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.. [optional] # noqa: E501 - oauth_client_id (str): The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_client_secret (str): The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): The location of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - saml_metadata (str): Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider_identifier.py b/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider_identifier.py deleted file mode 100644 index 65a3e31ac..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeIdentityProviderIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'IDENTITYPROVIDER': "identityProvider", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeIdentityProviderIdentifier - a model defined in OpenAPI - - Args: - id (str): Identifier of the identity provider. - - Keyword Args: - type (str): A type.. defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeIdentityProviderIdentifier - a model defined in OpenAPI - - Args: - id (str): Identifier of the identity provider. - - Keyword Args: - type (str): A type.. defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_jwk.py b/gooddata-api-client/gooddata_api_client/model/declarative_jwk.py deleted file mode 100644 index 5b6ed8182..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_jwk.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_jwk_specification import DeclarativeJwkSpecification - globals()['DeclarativeJwkSpecification'] = DeclarativeJwkSpecification - - -class DeclarativeJwk(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (DeclarativeJwkSpecification,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, id, *args, **kwargs): # noqa: E501 - """DeclarativeJwk - a model defined in OpenAPI - - Args: - content (DeclarativeJwkSpecification): - id (str): JWK object ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, id, *args, **kwargs): # noqa: E501 - """DeclarativeJwk - a model defined in OpenAPI - - Args: - content (DeclarativeJwkSpecification): - id (str): JWK object ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_jwk_specification.py b/gooddata-api-client/gooddata_api_client/model/declarative_jwk_specification.py deleted file mode 100644 index 3b95a1962..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_jwk_specification.py +++ /dev/null @@ -1,365 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_rsa_specification import DeclarativeRsaSpecification - globals()['DeclarativeRsaSpecification'] = DeclarativeRsaSpecification - - -class DeclarativeJwkSpecification(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('alg',): { - 'RS256': "RS256", - 'RS384': "RS384", - 'RS512': "RS512", - }, - ('kty',): { - 'RSA': "RSA", - }, - ('use',): { - 'SIG': "sig", - }, - } - - validations = { - ('kid',): { - 'max_length': 255, - 'regex': { - 'pattern': r'^[^.]', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'x5c': ([str],), # noqa: E501 - 'x5t': (str,), # noqa: E501 - 'alg': (str,), # noqa: E501 - 'e': (str,), # noqa: E501 - 'kid': (str,), # noqa: E501 - 'kty': (str,), # noqa: E501 - 'n': (str,), # noqa: E501 - 'use': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'x5c': 'x5c', # noqa: E501 - 'x5t': 'x5t', # noqa: E501 - 'alg': 'alg', # noqa: E501 - 'e': 'e', # noqa: E501 - 'kid': 'kid', # noqa: E501 - 'kty': 'kty', # noqa: E501 - 'n': 'n', # noqa: E501 - 'use': 'use', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeJwkSpecification - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - x5c ([str]): Parameter contains a chain of one or more PKIX certificates.. [optional] # noqa: E501 - x5t (str): Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate.. [optional] # noqa: E501 - alg (str): Algorithm intended for use with the key.. [optional] # noqa: E501 - e (str): parameter contains the exponent value for the RSA public key.. [optional] # noqa: E501 - kid (str): Parameter is used to match a specific key.. [optional] # noqa: E501 - kty (str): Key type parameter. [optional] if omitted the server will use the default value of "RSA" # noqa: E501 - n (str): Parameter contains the modulus value for the RSA public key.. [optional] # noqa: E501 - use (str): Parameter identifies the intended use of the public key.. [optional] if omitted the server will use the default value of "sig" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeJwkSpecification - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - x5c ([str]): Parameter contains a chain of one or more PKIX certificates.. [optional] # noqa: E501 - x5t (str): Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate.. [optional] # noqa: E501 - alg (str): Algorithm intended for use with the key.. [optional] # noqa: E501 - e (str): parameter contains the exponent value for the RSA public key.. [optional] # noqa: E501 - kid (str): Parameter is used to match a specific key.. [optional] # noqa: E501 - kty (str): Key type parameter. [optional] if omitted the server will use the default value of "RSA" # noqa: E501 - n (str): Parameter contains the modulus value for the RSA public key.. [optional] # noqa: E501 - use (str): Parameter identifies the intended use of the public key.. [optional] if omitted the server will use the default value of "sig" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - DeclarativeRsaSpecification, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_label.py b/gooddata-api-client/gooddata_api_client/model/declarative_label.py deleted file mode 100644 index 742617506..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_label.py +++ /dev/null @@ -1,338 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeLabel(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('source_column_data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - ('value_type',): { - 'TEXT': "TEXT", - 'HYPERLINK': "HYPERLINK", - 'GEO': "GEO", - 'GEO_LONGITUDE': "GEO_LONGITUDE", - 'GEO_LATITUDE': "GEO_LATITUDE", - 'IMAGE': "IMAGE", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('source_column',): { - 'max_length': 255, - }, - ('title',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('source_column_data_type',): { - 'max_length': 255, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'source_column': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'source_column_data_type': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'value_type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'source_column': 'sourceColumn', # noqa: E501 - 'title': 'title', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'source_column_data_type': 'sourceColumnDataType', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'value_type': 'valueType', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, source_column, title, *args, **kwargs): # noqa: E501 - """DeclarativeLabel - a model defined in OpenAPI - - Args: - id (str): Label ID. - source_column (str): A name of the source column in the table. - title (str): Label title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Label description.. [optional] # noqa: E501 - is_hidden (bool): Determines if the label is hidden from AI features.. [optional] # noqa: E501 - source_column_data_type (str): A type of the source column. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - value_type (str): Specific type of label. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.source_column = source_column - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, source_column, title, *args, **kwargs): # noqa: E501 - """DeclarativeLabel - a model defined in OpenAPI - - Args: - id (str): Label ID. - source_column (str): A name of the source column in the table. - title (str): Label title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Label description.. [optional] # noqa: E501 - is_hidden (bool): Determines if the label is hidden from AI features.. [optional] # noqa: E501 - source_column_data_type (str): A type of the source column. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - value_type (str): Specific type of label. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.source_column = source_column - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_ldm.py b/gooddata-api-client/gooddata_api_client/model/declarative_ldm.py deleted file mode 100644 index 50a8d6fc9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_ldm.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_dataset import DeclarativeDataset - from gooddata_api_client.model.declarative_dataset_extension import DeclarativeDatasetExtension - from gooddata_api_client.model.declarative_date_dataset import DeclarativeDateDataset - globals()['DeclarativeDataset'] = DeclarativeDataset - globals()['DeclarativeDatasetExtension'] = DeclarativeDatasetExtension - globals()['DeclarativeDateDataset'] = DeclarativeDateDataset - - -class DeclarativeLdm(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dataset_extensions': ([DeclarativeDatasetExtension],), # noqa: E501 - 'datasets': ([DeclarativeDataset],), # noqa: E501 - 'date_instances': ([DeclarativeDateDataset],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dataset_extensions': 'datasetExtensions', # noqa: E501 - 'datasets': 'datasets', # noqa: E501 - 'date_instances': 'dateInstances', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeLdm - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dataset_extensions ([DeclarativeDatasetExtension]): An array containing extensions for datasets defined in parent workspaces.. [optional] # noqa: E501 - datasets ([DeclarativeDataset]): An array containing datasets.. [optional] # noqa: E501 - date_instances ([DeclarativeDateDataset]): An array containing date-related datasets.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeLdm - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dataset_extensions ([DeclarativeDatasetExtension]): An array containing extensions for datasets defined in parent workspaces.. [optional] # noqa: E501 - datasets ([DeclarativeDataset]): An array containing datasets.. [optional] # noqa: E501 - date_instances ([DeclarativeDateDataset]): An array containing date-related datasets.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_ldm.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_ldm.pyi index f90fd67b2..6d12d1e56 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_ldm.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_ldm.pyi @@ -37,21 +37,21 @@ class DeclarativeLdm( class MetaOapg: - + class properties: - - + + class datasets( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeDataset']: return DeclarativeDataset - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeDataset'], typing.List['DeclarativeDataset']], @@ -62,22 +62,22 @@ class DeclarativeLdm( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeDataset': return super().__getitem__(i) - - + + class dateInstances( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeDateDataset']: return DeclarativeDateDataset - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeDateDataset'], typing.List['DeclarativeDateDataset']], @@ -88,40 +88,40 @@ class DeclarativeLdm( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeDateDataset': return super().__getitem__(i) __annotations__ = { "datasets": datasets, "dateInstances": dateInstances, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["datasets"]) -> MetaOapg.properties.datasets: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dateInstances"]) -> MetaOapg.properties.dateInstances: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["datasets", "dateInstances", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["datasets"]) -> typing.Union[MetaOapg.properties.datasets, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dateInstances"]) -> typing.Union[MetaOapg.properties.dateInstances, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["datasets", "dateInstances", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -140,5 +140,5 @@ class DeclarativeLdm( **kwargs, ) -from gooddata_api_client.model.declarative_dataset import DeclarativeDataset -from gooddata_api_client.model.declarative_date_dataset import DeclarativeDateDataset +from gooddata_api_client.models.declarative_dataset import DeclarativeDataset +from gooddata_api_client.models.declarative_date_dataset import DeclarativeDateDataset diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_metric.py b/gooddata-api-client/gooddata_api_client/model/declarative_metric.py deleted file mode 100644 index 8581781e4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_metric.py +++ /dev/null @@ -1,337 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - from gooddata_api_client.model.json_node import JsonNode - globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - globals()['JsonNode'] = JsonNode - - -class DeclarativeMetric(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('created_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('description',): { - 'max_length': 10000, - }, - ('modified_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (JsonNode,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'created_at': (str, none_type,), # noqa: E501 - 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'modified_at': (str, none_type,), # noqa: E501 - 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'description': 'description', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeMetric - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Metric ID. - title (str): Metric title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Metric description.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeMetric - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Metric ID. - title (str): Metric title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Metric description.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_model.py b/gooddata-api-client/gooddata_api_client/model/declarative_model.py deleted file mode 100644 index c5a1148bf..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_model.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_ldm import DeclarativeLdm - globals()['DeclarativeLdm'] = DeclarativeLdm - - -class DeclarativeModel(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'ldm': (DeclarativeLdm,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'ldm': 'ldm', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeModel - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - ldm (DeclarativeLdm): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeModel - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - ldm (DeclarativeLdm): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_model.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_model.pyi index 8c98eeba2..4aaefe5b8 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_model.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_model.pyi @@ -37,36 +37,36 @@ class DeclarativeModel( class MetaOapg: - + class properties: - + @staticmethod def ldm() -> typing.Type['DeclarativeLdm']: return DeclarativeLdm __annotations__ = { "ldm": ldm, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["ldm"]) -> 'DeclarativeLdm': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["ldm", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["ldm"]) -> typing.Union['DeclarativeLdm', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["ldm", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -83,4 +83,4 @@ class DeclarativeModel( **kwargs, ) -from gooddata_api_client.model.declarative_ldm import DeclarativeLdm +from gooddata_api_client.models.declarative_ldm import DeclarativeLdm diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.py b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.py deleted file mode 100644 index bed7f24f4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.py +++ /dev/null @@ -1,351 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_notification_channel_destination import DeclarativeNotificationChannelDestination - globals()['DeclarativeNotificationChannelDestination'] = DeclarativeNotificationChannelDestination - - -class DeclarativeNotificationChannel(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('allowed_recipients',): { - 'CREATOR': "CREATOR", - 'INTERNAL': "INTERNAL", - 'EXTERNAL': "EXTERNAL", - }, - ('dashboard_link_visibility',): { - 'HIDDEN': "HIDDEN", - 'INTERNAL_ONLY': "INTERNAL_ONLY", - 'ALL': "ALL", - }, - ('destination_type',): { - 'None': None, - 'WEBHOOK': "WEBHOOK", - 'SMTP': "SMTP", - 'DEFAULT_SMTP': "DEFAULT_SMTP", - 'IN_PLATFORM': "IN_PLATFORM", - }, - ('in_platform_notification',): { - 'DISABLED': "DISABLED", - 'ENABLED': "ENABLED", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('custom_dashboard_url',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('name',): { - 'max_length': 255, - }, - ('notification_source',): { - 'max_length': 10000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'allowed_recipients': (str,), # noqa: E501 - 'custom_dashboard_url': (str,), # noqa: E501 - 'dashboard_link_visibility': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'destination': (DeclarativeNotificationChannelDestination,), # noqa: E501 - 'destination_type': (str, none_type,), # noqa: E501 - 'in_platform_notification': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'notification_source': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'allowed_recipients': 'allowedRecipients', # noqa: E501 - 'custom_dashboard_url': 'customDashboardUrl', # noqa: E501 - 'dashboard_link_visibility': 'dashboardLinkVisibility', # noqa: E501 - 'description': 'description', # noqa: E501 - 'destination': 'destination', # noqa: E501 - 'destination_type': 'destinationType', # noqa: E501 - 'in_platform_notification': 'inPlatformNotification', # noqa: E501 - 'name': 'name', # noqa: E501 - 'notification_source': 'notificationSource', # noqa: E501 - } - - read_only_vars = { - 'destination_type', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeNotificationChannel - a model defined in OpenAPI - - Args: - id (str): Identifier of a notification channel - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_recipients (str): Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization . [optional] if omitted the server will use the default value of "INTERNAL" # noqa: E501 - custom_dashboard_url (str): Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} . [optional] # noqa: E501 - dashboard_link_visibility (str): Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link . [optional] if omitted the server will use the default value of "INTERNAL_ONLY" # noqa: E501 - description (str): Description of a notification channel.. [optional] # noqa: E501 - destination (DeclarativeNotificationChannelDestination): [optional] # noqa: E501 - destination_type (str, none_type): [optional] # noqa: E501 - in_platform_notification (str): In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications . [optional] if omitted the server will use the default value of "DISABLED" # noqa: E501 - name (str): Name of a notification channel.. [optional] # noqa: E501 - notification_source (str): Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} . [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeNotificationChannel - a model defined in OpenAPI - - Args: - id (str): Identifier of a notification channel - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_recipients (str): Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization . [optional] if omitted the server will use the default value of "INTERNAL" # noqa: E501 - custom_dashboard_url (str): Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} . [optional] # noqa: E501 - dashboard_link_visibility (str): Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link . [optional] if omitted the server will use the default value of "INTERNAL_ONLY" # noqa: E501 - description (str): Description of a notification channel.. [optional] # noqa: E501 - destination (DeclarativeNotificationChannelDestination): [optional] # noqa: E501 - destination_type (str, none_type): [optional] # noqa: E501 - in_platform_notification (str): In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications . [optional] if omitted the server will use the default value of "DISABLED" # noqa: E501 - name (str): Name of a notification channel.. [optional] # noqa: E501 - notification_source (str): Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} . [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_destination.py b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_destination.py deleted file mode 100644 index 4718770e6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_destination.py +++ /dev/null @@ -1,384 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.default_smtp import DefaultSmtp - from gooddata_api_client.model.in_platform import InPlatform - from gooddata_api_client.model.smtp import Smtp - from gooddata_api_client.model.webhook import Webhook - globals()['DefaultSmtp'] = DefaultSmtp - globals()['InPlatform'] = InPlatform - globals()['Smtp'] = Smtp - globals()['Webhook'] = Webhook - - -class DeclarativeNotificationChannelDestination(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('port',): { - '25': 25, - '465': 465, - '587': 587, - '2525': 2525, - }, - ('type',): { - 'WEBHOOK': "WEBHOOK", - }, - } - - validations = { - ('token',): { - 'max_length': 10000, - }, - ('url',): { - 'max_length': 255, - 'regex': { - 'pattern': r'https?\:\/\/.*', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'from_email': (str,), # noqa: E501 - 'from_email_name': (str,), # noqa: E501 - 'host': (str,), # noqa: E501 - 'password': (str,), # noqa: E501 - 'port': (int,), # noqa: E501 - 'username': (str,), # noqa: E501 - 'has_token': (bool, none_type,), # noqa: E501 - 'token': (str, none_type,), # noqa: E501 - 'url': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'from_email': 'fromEmail', # noqa: E501 - 'from_email_name': 'fromEmailName', # noqa: E501 - 'host': 'host', # noqa: E501 - 'password': 'password', # noqa: E501 - 'port': 'port', # noqa: E501 - 'username': 'username', # noqa: E501 - 'has_token': 'hasToken', # noqa: E501 - 'token': 'token', # noqa: E501 - 'url': 'url', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - 'has_token', # noqa: E501 - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeNotificationChannelDestination - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "WEBHOOK" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeNotificationChannelDestination - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "WEBHOOK" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - DefaultSmtp, - InPlatform, - Smtp, - Webhook, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_identifier.py b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_identifier.py deleted file mode 100644 index 3e50d5e47..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeNotificationChannelIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'NOTIFICATIONCHANNEL': "notificationChannel", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeNotificationChannelIdentifier - a model defined in OpenAPI - - Args: - id (str): Notification channel identifier. - - Keyword Args: - type (str): A type.. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeNotificationChannelIdentifier - a model defined in OpenAPI - - Args: - id (str): Notification channel identifier. - - Keyword Args: - type (str): A type.. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channels.py b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channels.py deleted file mode 100644 index 57b9bb499..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channels.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_notification_channel import DeclarativeNotificationChannel - globals()['DeclarativeNotificationChannel'] = DeclarativeNotificationChannel - - -class DeclarativeNotificationChannels(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'notification_channels': ([DeclarativeNotificationChannel],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'notification_channels': 'notificationChannels', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, notification_channels, *args, **kwargs): # noqa: E501 - """DeclarativeNotificationChannels - a model defined in OpenAPI - - Args: - notification_channels ([DeclarativeNotificationChannel]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.notification_channels = notification_channels - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, notification_channels, *args, **kwargs): # noqa: E501 - """DeclarativeNotificationChannels - a model defined in OpenAPI - - Args: - notification_channels ([DeclarativeNotificationChannel]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.notification_channels = notification_channels - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_organization.py b/gooddata-api-client/gooddata_api_client/model/declarative_organization.py deleted file mode 100644 index 37c34fced..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_organization.py +++ /dev/null @@ -1,330 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_data_source import DeclarativeDataSource - from gooddata_api_client.model.declarative_export_template import DeclarativeExportTemplate - from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider - from gooddata_api_client.model.declarative_jwk import DeclarativeJwk - from gooddata_api_client.model.declarative_notification_channel import DeclarativeNotificationChannel - from gooddata_api_client.model.declarative_organization_info import DeclarativeOrganizationInfo - from gooddata_api_client.model.declarative_user import DeclarativeUser - from gooddata_api_client.model.declarative_user_group import DeclarativeUserGroup - from gooddata_api_client.model.declarative_workspace import DeclarativeWorkspace - from gooddata_api_client.model.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter - globals()['DeclarativeDataSource'] = DeclarativeDataSource - globals()['DeclarativeExportTemplate'] = DeclarativeExportTemplate - globals()['DeclarativeIdentityProvider'] = DeclarativeIdentityProvider - globals()['DeclarativeJwk'] = DeclarativeJwk - globals()['DeclarativeNotificationChannel'] = DeclarativeNotificationChannel - globals()['DeclarativeOrganizationInfo'] = DeclarativeOrganizationInfo - globals()['DeclarativeUser'] = DeclarativeUser - globals()['DeclarativeUserGroup'] = DeclarativeUserGroup - globals()['DeclarativeWorkspace'] = DeclarativeWorkspace - globals()['DeclarativeWorkspaceDataFilter'] = DeclarativeWorkspaceDataFilter - - -class DeclarativeOrganization(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'organization': (DeclarativeOrganizationInfo,), # noqa: E501 - 'data_sources': ([DeclarativeDataSource],), # noqa: E501 - 'export_templates': ([DeclarativeExportTemplate],), # noqa: E501 - 'identity_providers': ([DeclarativeIdentityProvider],), # noqa: E501 - 'jwks': ([DeclarativeJwk],), # noqa: E501 - 'notification_channels': ([DeclarativeNotificationChannel],), # noqa: E501 - 'user_groups': ([DeclarativeUserGroup],), # noqa: E501 - 'users': ([DeclarativeUser],), # noqa: E501 - 'workspace_data_filters': ([DeclarativeWorkspaceDataFilter],), # noqa: E501 - 'workspaces': ([DeclarativeWorkspace],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'organization': 'organization', # noqa: E501 - 'data_sources': 'dataSources', # noqa: E501 - 'export_templates': 'exportTemplates', # noqa: E501 - 'identity_providers': 'identityProviders', # noqa: E501 - 'jwks': 'jwks', # noqa: E501 - 'notification_channels': 'notificationChannels', # noqa: E501 - 'user_groups': 'userGroups', # noqa: E501 - 'users': 'users', # noqa: E501 - 'workspace_data_filters': 'workspaceDataFilters', # noqa: E501 - 'workspaces': 'workspaces', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, organization, *args, **kwargs): # noqa: E501 - """DeclarativeOrganization - a model defined in OpenAPI - - Args: - organization (DeclarativeOrganizationInfo): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_sources ([DeclarativeDataSource]): [optional] # noqa: E501 - export_templates ([DeclarativeExportTemplate]): [optional] # noqa: E501 - identity_providers ([DeclarativeIdentityProvider]): [optional] # noqa: E501 - jwks ([DeclarativeJwk]): [optional] # noqa: E501 - notification_channels ([DeclarativeNotificationChannel]): [optional] # noqa: E501 - user_groups ([DeclarativeUserGroup]): [optional] # noqa: E501 - users ([DeclarativeUser]): [optional] # noqa: E501 - workspace_data_filters ([DeclarativeWorkspaceDataFilter]): [optional] # noqa: E501 - workspaces ([DeclarativeWorkspace]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.organization = organization - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, organization, *args, **kwargs): # noqa: E501 - """DeclarativeOrganization - a model defined in OpenAPI - - Args: - organization (DeclarativeOrganizationInfo): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_sources ([DeclarativeDataSource]): [optional] # noqa: E501 - export_templates ([DeclarativeExportTemplate]): [optional] # noqa: E501 - identity_providers ([DeclarativeIdentityProvider]): [optional] # noqa: E501 - jwks ([DeclarativeJwk]): [optional] # noqa: E501 - notification_channels ([DeclarativeNotificationChannel]): [optional] # noqa: E501 - user_groups ([DeclarativeUserGroup]): [optional] # noqa: E501 - users ([DeclarativeUser]): [optional] # noqa: E501 - workspace_data_filters ([DeclarativeWorkspaceDataFilter]): [optional] # noqa: E501 - workspaces ([DeclarativeWorkspace]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.organization = organization - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_organization.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_organization.pyi index 772eadb9a..47c53ebd3 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_organization.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_organization.pyi @@ -40,25 +40,25 @@ class DeclarativeOrganization( required = { "organization", } - + class properties: - + @staticmethod def organization() -> typing.Type['DeclarativeOrganizationInfo']: return DeclarativeOrganizationInfo - - + + class dataSources( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeDataSource']: return DeclarativeDataSource - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeDataSource'], typing.List['DeclarativeDataSource']], @@ -69,22 +69,22 @@ class DeclarativeOrganization( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeDataSource': return super().__getitem__(i) - - + + class userGroups( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUserGroup']: return DeclarativeUserGroup - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUserGroup'], typing.List['DeclarativeUserGroup']], @@ -95,22 +95,22 @@ class DeclarativeOrganization( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUserGroup': return super().__getitem__(i) - - + + class users( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUser']: return DeclarativeUser - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUser'], typing.List['DeclarativeUser']], @@ -121,22 +121,22 @@ class DeclarativeOrganization( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUser': return super().__getitem__(i) - - + + class workspaceDataFilters( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeWorkspaceDataFilter']: return DeclarativeWorkspaceDataFilter - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeWorkspaceDataFilter'], typing.List['DeclarativeWorkspaceDataFilter']], @@ -147,22 +147,22 @@ class DeclarativeOrganization( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeWorkspaceDataFilter': return super().__getitem__(i) - - + + class workspaces( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeWorkspace']: return DeclarativeWorkspace - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeWorkspace'], typing.List['DeclarativeWorkspace']], @@ -173,7 +173,7 @@ class DeclarativeOrganization( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeWorkspace': return super().__getitem__(i) __annotations__ = { @@ -184,59 +184,59 @@ class DeclarativeOrganization( "workspaceDataFilters": workspaceDataFilters, "workspaces": workspaces, } - + organization: 'DeclarativeOrganizationInfo' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["organization"]) -> 'DeclarativeOrganizationInfo': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataSources"]) -> MetaOapg.properties.dataSources: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["workspaceDataFilters"]) -> MetaOapg.properties.workspaceDataFilters: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["workspaces"]) -> MetaOapg.properties.workspaces: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["organization", "dataSources", "userGroups", "users", "workspaceDataFilters", "workspaces", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["organization"]) -> 'DeclarativeOrganizationInfo': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataSources"]) -> typing.Union[MetaOapg.properties.dataSources, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroups"]) -> typing.Union[MetaOapg.properties.userGroups, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["users"]) -> typing.Union[MetaOapg.properties.users, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["workspaceDataFilters"]) -> typing.Union[MetaOapg.properties.workspaceDataFilters, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["workspaces"]) -> typing.Union[MetaOapg.properties.workspaces, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["organization", "dataSources", "userGroups", "users", "workspaceDataFilters", "workspaces", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -263,9 +263,9 @@ class DeclarativeOrganization( **kwargs, ) -from gooddata_api_client.model.declarative_data_source import DeclarativeDataSource -from gooddata_api_client.model.declarative_organization_info import DeclarativeOrganizationInfo -from gooddata_api_client.model.declarative_user import DeclarativeUser -from gooddata_api_client.model.declarative_user_group import DeclarativeUserGroup -from gooddata_api_client.model.declarative_workspace import DeclarativeWorkspace -from gooddata_api_client.model.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter +from gooddata_api_client.models.declarative_data_source import DeclarativeDataSource +from gooddata_api_client.models.declarative_organization_info import DeclarativeOrganizationInfo +from gooddata_api_client.models.declarative_user import DeclarativeUser +from gooddata_api_client.models.declarative_user_group import DeclarativeUserGroup +from gooddata_api_client.models.declarative_workspace import DeclarativeWorkspace +from gooddata_api_client.models.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.py b/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.py deleted file mode 100644 index 75f68b083..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.py +++ /dev/null @@ -1,397 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_color_palette import DeclarativeColorPalette - from gooddata_api_client.model.declarative_csp_directive import DeclarativeCspDirective - from gooddata_api_client.model.declarative_identity_provider_identifier import DeclarativeIdentityProviderIdentifier - from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission - from gooddata_api_client.model.declarative_setting import DeclarativeSetting - from gooddata_api_client.model.declarative_theme import DeclarativeTheme - globals()['DeclarativeColorPalette'] = DeclarativeColorPalette - globals()['DeclarativeCspDirective'] = DeclarativeCspDirective - globals()['DeclarativeIdentityProviderIdentifier'] = DeclarativeIdentityProviderIdentifier - globals()['DeclarativeOrganizationPermission'] = DeclarativeOrganizationPermission - globals()['DeclarativeSetting'] = DeclarativeSetting - globals()['DeclarativeTheme'] = DeclarativeTheme - - -class DeclarativeOrganizationInfo(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('hostname',): { - 'max_length': 255, - }, - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('name',): { - 'max_length': 255, - }, - ('early_access',): { - 'max_length': 255, - }, - ('early_access_values',): { - }, - ('oauth_client_id',): { - 'max_length': 255, - }, - ('oauth_client_secret',): { - 'max_length': 255, - }, - ('oauth_custom_auth_attributes',): { - }, - ('oauth_issuer_id',): { - 'max_length': 255, - }, - ('oauth_issuer_location',): { - 'max_length': 255, - }, - ('oauth_subject_id_claim',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'hostname': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'permissions': ([DeclarativeOrganizationPermission],), # noqa: E501 - 'allowed_origins': ([str],), # noqa: E501 - 'color_palettes': ([DeclarativeColorPalette],), # noqa: E501 - 'csp_directives': ([DeclarativeCspDirective],), # noqa: E501 - 'early_access': (str,), # noqa: E501 - 'early_access_values': ([str],), # noqa: E501 - 'identity_provider': (DeclarativeIdentityProviderIdentifier,), # noqa: E501 - 'oauth_client_id': (str,), # noqa: E501 - 'oauth_client_secret': (str,), # noqa: E501 - 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 - 'oauth_custom_scopes': ([str], none_type,), # noqa: E501 - 'oauth_issuer_id': (str,), # noqa: E501 - 'oauth_issuer_location': (str,), # noqa: E501 - 'oauth_subject_id_claim': (str,), # noqa: E501 - 'settings': ([DeclarativeSetting],), # noqa: E501 - 'themes': ([DeclarativeTheme],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'hostname': 'hostname', # noqa: E501 - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - 'allowed_origins': 'allowedOrigins', # noqa: E501 - 'color_palettes': 'colorPalettes', # noqa: E501 - 'csp_directives': 'cspDirectives', # noqa: E501 - 'early_access': 'earlyAccess', # noqa: E501 - 'early_access_values': 'earlyAccessValues', # noqa: E501 - 'identity_provider': 'identityProvider', # noqa: E501 - 'oauth_client_id': 'oauthClientId', # noqa: E501 - 'oauth_client_secret': 'oauthClientSecret', # noqa: E501 - 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 - 'oauth_custom_scopes': 'oauthCustomScopes', # noqa: E501 - 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 - 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 - 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 - 'settings': 'settings', # noqa: E501 - 'themes': 'themes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, hostname, id, name, permissions, *args, **kwargs): # noqa: E501 - """DeclarativeOrganizationInfo - a model defined in OpenAPI - - Args: - hostname (str): Formal hostname used in deployment. - id (str): Identifier of the organization. - name (str): Formal name of the organization. - permissions ([DeclarativeOrganizationPermission]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_origins ([str]): [optional] # noqa: E501 - color_palettes ([DeclarativeColorPalette]): A list of color palettes.. [optional] # noqa: E501 - csp_directives ([DeclarativeCspDirective]): A list of CSP directives.. [optional] # noqa: E501 - early_access (str): Early access defined on level Organization. [optional] # noqa: E501 - early_access_values ([str]): Early access defined on level Organization. [optional] # noqa: E501 - identity_provider (DeclarativeIdentityProviderIdentifier): [optional] # noqa: E501 - oauth_client_id (str): Identifier of the authentication provider. [optional] # noqa: E501 - oauth_client_secret (str): Communication secret of the authentication provider (never returned back).. [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): URI of the authentication provider.. [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - settings ([DeclarativeSetting]): A list of organization settings.. [optional] # noqa: E501 - themes ([DeclarativeTheme]): A list of themes.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.hostname = hostname - self.id = id - self.name = name - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, hostname, id, name, permissions, *args, **kwargs): # noqa: E501 - """DeclarativeOrganizationInfo - a model defined in OpenAPI - - Args: - hostname (str): Formal hostname used in deployment. - id (str): Identifier of the organization. - name (str): Formal name of the organization. - permissions ([DeclarativeOrganizationPermission]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_origins ([str]): [optional] # noqa: E501 - color_palettes ([DeclarativeColorPalette]): A list of color palettes.. [optional] # noqa: E501 - csp_directives ([DeclarativeCspDirective]): A list of CSP directives.. [optional] # noqa: E501 - early_access (str): Early access defined on level Organization. [optional] # noqa: E501 - early_access_values ([str]): Early access defined on level Organization. [optional] # noqa: E501 - identity_provider (DeclarativeIdentityProviderIdentifier): [optional] # noqa: E501 - oauth_client_id (str): Identifier of the authentication provider. [optional] # noqa: E501 - oauth_client_secret (str): Communication secret of the authentication provider (never returned back).. [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): URI of the authentication provider.. [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - settings ([DeclarativeSetting]): A list of organization settings.. [optional] # noqa: E501 - themes ([DeclarativeTheme]): A list of themes.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.hostname = hostname - self.id = id - self.name = name - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.pyi index ca41b6999..60ecd9034 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.pyi @@ -43,39 +43,39 @@ class DeclarativeOrganizationInfo( "name", "id", } - + class properties: - - + + class hostname( schemas.StrSchema ): pass - - + + class id( schemas.StrSchema ): pass - - + + class name( schemas.StrSchema ): pass - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeOrganizationPermission']: return DeclarativeOrganizationPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeOrganizationPermission'], typing.List['DeclarativeOrganizationPermission']], @@ -86,22 +86,22 @@ class DeclarativeOrganizationInfo( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeOrganizationPermission': return super().__getitem__(i) - - + + class colorPalettes( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeColorPalette']: return DeclarativeColorPalette - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeColorPalette'], typing.List['DeclarativeColorPalette']], @@ -112,22 +112,22 @@ class DeclarativeOrganizationInfo( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeColorPalette': return super().__getitem__(i) - - + + class cspDirectives( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeCspDirective']: return DeclarativeCspDirective - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeCspDirective'], typing.List['DeclarativeCspDirective']], @@ -138,52 +138,52 @@ class DeclarativeOrganizationInfo( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeCspDirective': return super().__getitem__(i) - - + + class earlyAccess( schemas.StrSchema ): pass - - + + class oauthClientId( schemas.StrSchema ): pass - - + + class oauthClientSecret( schemas.StrSchema ): pass - - + + class oauthIssuerId( schemas.StrSchema ): pass - - + + class oauthIssuerLocation( schemas.StrSchema ): pass - - + + class settings( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeSetting']: return DeclarativeSetting - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeSetting'], typing.List['DeclarativeSetting']], @@ -194,22 +194,22 @@ class DeclarativeOrganizationInfo( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeSetting': return super().__getitem__(i) - - + + class themes( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeTheme']: return DeclarativeTheme - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeTheme'], typing.List['DeclarativeTheme']], @@ -220,7 +220,7 @@ class DeclarativeOrganizationInfo( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeTheme': return super().__getitem__(i) __annotations__ = { @@ -238,104 +238,104 @@ class DeclarativeOrganizationInfo( "settings": settings, "themes": themes, } - + hostname: MetaOapg.properties.hostname permissions: MetaOapg.properties.permissions name: MetaOapg.properties.name id: MetaOapg.properties.id - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["hostname"]) -> MetaOapg.properties.hostname: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["colorPalettes"]) -> MetaOapg.properties.colorPalettes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["cspDirectives"]) -> MetaOapg.properties.cspDirectives: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["earlyAccess"]) -> MetaOapg.properties.earlyAccess: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["oauthClientId"]) -> MetaOapg.properties.oauthClientId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["oauthClientSecret"]) -> MetaOapg.properties.oauthClientSecret: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["oauthIssuerId"]) -> MetaOapg.properties.oauthIssuerId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> MetaOapg.properties.oauthIssuerLocation: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["settings"]) -> MetaOapg.properties.settings: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["themes"]) -> MetaOapg.properties.themes: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["hostname", "id", "name", "permissions", "colorPalettes", "cspDirectives", "earlyAccess", "oauthClientId", "oauthClientSecret", "oauthIssuerId", "oauthIssuerLocation", "settings", "themes", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["hostname"]) -> MetaOapg.properties.hostname: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["colorPalettes"]) -> typing.Union[MetaOapg.properties.colorPalettes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["cspDirectives"]) -> typing.Union[MetaOapg.properties.cspDirectives, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["earlyAccess"]) -> typing.Union[MetaOapg.properties.earlyAccess, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["oauthClientId"]) -> typing.Union[MetaOapg.properties.oauthClientId, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["oauthClientSecret"]) -> typing.Union[MetaOapg.properties.oauthClientSecret, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerId"]) -> typing.Union[MetaOapg.properties.oauthIssuerId, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> typing.Union[MetaOapg.properties.oauthIssuerLocation, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["settings"]) -> typing.Union[MetaOapg.properties.settings, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["themes"]) -> typing.Union[MetaOapg.properties.themes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["hostname", "id", "name", "permissions", "colorPalettes", "cspDirectives", "earlyAccess", "oauthClientId", "oauthClientSecret", "oauthIssuerId", "oauthIssuerLocation", "settings", "themes", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -376,8 +376,8 @@ class DeclarativeOrganizationInfo( **kwargs, ) -from gooddata_api_client.model.declarative_color_palette import DeclarativeColorPalette -from gooddata_api_client.model.declarative_csp_directive import DeclarativeCspDirective -from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission -from gooddata_api_client.model.declarative_setting import DeclarativeSetting -from gooddata_api_client.model.declarative_theme import DeclarativeTheme +from gooddata_api_client.models.declarative_color_palette import DeclarativeColorPalette +from gooddata_api_client.models.declarative_csp_directive import DeclarativeCspDirective +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.models.declarative_setting import DeclarativeSetting +from gooddata_api_client.models.declarative_theme import DeclarativeTheme diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_organization_permission.py b/gooddata-api-client/gooddata_api_client/model/declarative_organization_permission.py deleted file mode 100644 index 568a424e1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_organization_permission.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - globals()['AssigneeIdentifier'] = AssigneeIdentifier - - -class DeclarativeOrganizationPermission(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'MANAGE': "MANAGE", - 'SELF_CREATE_TOKEN': "SELF_CREATE_TOKEN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee': (AssigneeIdentifier,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee': 'assignee', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, assignee, name, *args, **kwargs): # noqa: E501 - """DeclarativeOrganizationPermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - name (str): Permission name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, assignee, name, *args, **kwargs): # noqa: E501 - """DeclarativeOrganizationPermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - name (str): Permission name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_organization_permission.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_organization_permission.pyi index 0a9b034c2..2b60228d6 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_organization_permission.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_organization_permission.pyi @@ -41,19 +41,19 @@ class DeclarativeOrganizationPermission( "name", "assignee", } - + class properties: - + @staticmethod def assignee() -> typing.Type['AssigneeIdentifier']: return AssigneeIdentifier - - + + class name( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def MANAGE(cls): return cls("MANAGE") @@ -61,36 +61,36 @@ class DeclarativeOrganizationPermission( "assignee": assignee, "name": name, } - + name: MetaOapg.properties.name assignee: 'AssigneeIdentifier' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -109,4 +109,4 @@ class DeclarativeOrganizationPermission( **kwargs, ) -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_reference.py b/gooddata-api-client/gooddata_api_client/model/declarative_reference.py deleted file mode 100644 index 33bdf1816..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_reference.py +++ /dev/null @@ -1,305 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_reference_source import DeclarativeReferenceSource - from gooddata_api_client.model.reference_identifier import ReferenceIdentifier - globals()['DeclarativeReferenceSource'] = DeclarativeReferenceSource - globals()['ReferenceIdentifier'] = ReferenceIdentifier - - -class DeclarativeReference(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('source_column_data_types',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'identifier': (ReferenceIdentifier,), # noqa: E501 - 'multivalue': (bool,), # noqa: E501 - 'source_column_data_types': ([str],), # noqa: E501 - 'source_columns': ([str],), # noqa: E501 - 'sources': ([DeclarativeReferenceSource],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'identifier': 'identifier', # noqa: E501 - 'multivalue': 'multivalue', # noqa: E501 - 'source_column_data_types': 'sourceColumnDataTypes', # noqa: E501 - 'source_columns': 'sourceColumns', # noqa: E501 - 'sources': 'sources', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, identifier, multivalue, *args, **kwargs): # noqa: E501 - """DeclarativeReference - a model defined in OpenAPI - - Args: - identifier (ReferenceIdentifier): - multivalue (bool): The multi-value flag enables many-to-many cardinality for references. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - source_column_data_types ([str]): An array of source column data types for a given reference. Deprecated, use 'sources' instead.. [optional] # noqa: E501 - source_columns ([str]): An array of source column names for a given reference. Deprecated, use 'sources' instead.. [optional] # noqa: E501 - sources ([DeclarativeReferenceSource]): An array of source columns for a given reference.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - self.multivalue = multivalue - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, identifier, multivalue, *args, **kwargs): # noqa: E501 - """DeclarativeReference - a model defined in OpenAPI - - Args: - identifier (ReferenceIdentifier): - multivalue (bool): The multi-value flag enables many-to-many cardinality for references. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - source_column_data_types ([str]): An array of source column data types for a given reference. Deprecated, use 'sources' instead.. [optional] # noqa: E501 - source_columns ([str]): An array of source column names for a given reference. Deprecated, use 'sources' instead.. [optional] # noqa: E501 - sources ([DeclarativeReferenceSource]): An array of source columns for a given reference.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - self.multivalue = multivalue - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_reference.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_reference.pyi index a8e420877..014ac0bc6 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_reference.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_reference.pyi @@ -42,23 +42,23 @@ class DeclarativeReference( "sourceColumns", "multivalue", } - + class properties: - + @staticmethod def identifier() -> typing.Type['ReferenceIdentifier']: return ReferenceIdentifier multivalue = schemas.BoolSchema - - + + class sourceColumns( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -69,19 +69,19 @@ class DeclarativeReference( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class sourceColumnDataTypes( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -92,7 +92,7 @@ class DeclarativeReference( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) __annotations__ = { @@ -101,49 +101,49 @@ class DeclarativeReference( "sourceColumns": sourceColumns, "sourceColumnDataTypes": sourceColumnDataTypes, } - + identifier: 'ReferenceIdentifier' sourceColumns: MetaOapg.properties.sourceColumns multivalue: MetaOapg.properties.multivalue - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["identifier"]) -> 'ReferenceIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["multivalue"]) -> MetaOapg.properties.multivalue: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sourceColumns"]) -> MetaOapg.properties.sourceColumns: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sourceColumnDataTypes"]) -> MetaOapg.properties.sourceColumnDataTypes: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["identifier", "multivalue", "sourceColumns", "sourceColumnDataTypes", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["identifier"]) -> 'ReferenceIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["multivalue"]) -> MetaOapg.properties.multivalue: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sourceColumns"]) -> MetaOapg.properties.sourceColumns: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sourceColumnDataTypes"]) -> typing.Union[MetaOapg.properties.sourceColumnDataTypes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["identifier", "multivalue", "sourceColumns", "sourceColumnDataTypes", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -166,4 +166,4 @@ class DeclarativeReference( **kwargs, ) -from gooddata_api_client.model.reference_identifier import ReferenceIdentifier +from gooddata_api_client.models.reference_identifier import ReferenceIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_reference_source.py b/gooddata-api-client/gooddata_api_client/model/declarative_reference_source.py deleted file mode 100644 index 2fd84ee9a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_reference_source.py +++ /dev/null @@ -1,301 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.grain_identifier import GrainIdentifier - globals()['GrainIdentifier'] = GrainIdentifier - - -class DeclarativeReferenceSource(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - ('column',): { - 'max_length': 255, - }, - ('data_type',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'column': (str,), # noqa: E501 - 'target': (GrainIdentifier,), # noqa: E501 - 'data_type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'column': 'column', # noqa: E501 - 'target': 'target', # noqa: E501 - 'data_type': 'dataType', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, column, target, *args, **kwargs): # noqa: E501 - """DeclarativeReferenceSource - a model defined in OpenAPI - - Args: - column (str): A name of the source column in the table. - target (GrainIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_type (str): A type of the source column.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column = column - self.target = target - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, column, target, *args, **kwargs): # noqa: E501 - """DeclarativeReferenceSource - a model defined in OpenAPI - - Args: - column (str): A name of the source column in the table. - target (GrainIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_type (str): A type of the source column.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column = column - self.target = target - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_rsa_specification.py b/gooddata-api-client/gooddata_api_client/model/declarative_rsa_specification.py deleted file mode 100644 index 3aa1beaee..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_rsa_specification.py +++ /dev/null @@ -1,329 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeRsaSpecification(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('alg',): { - 'RS256': "RS256", - 'RS384': "RS384", - 'RS512': "RS512", - }, - ('kty',): { - 'RSA': "RSA", - }, - ('use',): { - 'SIG': "sig", - }, - } - - validations = { - ('kid',): { - 'max_length': 255, - 'regex': { - 'pattern': r'^[^.]', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'alg': (str,), # noqa: E501 - 'e': (str,), # noqa: E501 - 'kid': (str,), # noqa: E501 - 'kty': (str,), # noqa: E501 - 'n': (str,), # noqa: E501 - 'use': (str,), # noqa: E501 - 'x5c': ([str],), # noqa: E501 - 'x5t': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'alg': 'alg', # noqa: E501 - 'e': 'e', # noqa: E501 - 'kid': 'kid', # noqa: E501 - 'kty': 'kty', # noqa: E501 - 'n': 'n', # noqa: E501 - 'use': 'use', # noqa: E501 - 'x5c': 'x5c', # noqa: E501 - 'x5t': 'x5t', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, alg, e, kid, n, *args, **kwargs): # noqa: E501 - """DeclarativeRsaSpecification - a model defined in OpenAPI - - Args: - alg (str): Algorithm intended for use with the key. - e (str): parameter contains the exponent value for the RSA public key. - kid (str): Parameter is used to match a specific key. - n (str): Parameter contains the modulus value for the RSA public key. - - Keyword Args: - kty (str): Key type parameter. defaults to "RSA", must be one of ["RSA", ] # noqa: E501 - use (str): Parameter identifies the intended use of the public key.. defaults to "sig", must be one of ["sig", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - x5c ([str]): Parameter contains a chain of one or more PKIX certificates.. [optional] # noqa: E501 - x5t (str): Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate.. [optional] # noqa: E501 - """ - - kty = kwargs.get('kty', "RSA") - use = kwargs.get('use', "sig") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.alg = alg - self.e = e - self.kid = kid - self.kty = kty - self.n = n - self.use = use - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, alg, e, kid, n, *args, **kwargs): # noqa: E501 - """DeclarativeRsaSpecification - a model defined in OpenAPI - - Args: - alg (str): Algorithm intended for use with the key. - e (str): parameter contains the exponent value for the RSA public key. - kid (str): Parameter is used to match a specific key. - n (str): Parameter contains the modulus value for the RSA public key. - - Keyword Args: - kty (str): Key type parameter. defaults to "RSA", must be one of ["RSA", ] # noqa: E501 - use (str): Parameter identifies the intended use of the public key.. defaults to "sig", must be one of ["sig", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - x5c ([str]): Parameter contains a chain of one or more PKIX certificates.. [optional] # noqa: E501 - x5t (str): Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate.. [optional] # noqa: E501 - """ - - kty = kwargs.get('kty', "RSA") - use = kwargs.get('use', "sig") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.alg = alg - self.e = e - self.kid = kid - self.kty = kty - self.n = n - self.use = use - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py deleted file mode 100644 index fca34d24a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py +++ /dev/null @@ -1,321 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_node import JsonNode - globals()['JsonNode'] = JsonNode - - -class DeclarativeSetting(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'TIMEZONE': "TIMEZONE", - 'ACTIVE_THEME': "ACTIVE_THEME", - 'ACTIVE_COLOR_PALETTE': "ACTIVE_COLOR_PALETTE", - 'ACTIVE_LLM_ENDPOINT': "ACTIVE_LLM_ENDPOINT", - 'WHITE_LABELING': "WHITE_LABELING", - 'LOCALE': "LOCALE", - 'METADATA_LOCALE': "METADATA_LOCALE", - 'FORMAT_LOCALE': "FORMAT_LOCALE", - 'MAPBOX_TOKEN': "MAPBOX_TOKEN", - 'AG_GRID_TOKEN': "AG_GRID_TOKEN", - 'WEEK_START': "WEEK_START", - 'SHOW_HIDDEN_CATALOG_ITEMS': "SHOW_HIDDEN_CATALOG_ITEMS", - 'OPERATOR_OVERRIDES': "OPERATOR_OVERRIDES", - 'TIMEZONE_VALIDATION_ENABLED': "TIMEZONE_VALIDATION_ENABLED", - 'OPENAI_CONFIG': "OPENAI_CONFIG", - 'ENABLE_FILE_ANALYTICS': "ENABLE_FILE_ANALYTICS", - 'ALERT': "ALERT", - 'SEPARATORS': "SEPARATORS", - 'DATE_FILTER_CONFIG': "DATE_FILTER_CONFIG", - 'JIT_PROVISIONING': "JIT_PROVISIONING", - 'JWT_JIT_PROVISIONING': "JWT_JIT_PROVISIONING", - 'DASHBOARD_FILTERS_APPLY_MODE': "DASHBOARD_FILTERS_APPLY_MODE", - 'ENABLE_SLIDES_EXPORT': "ENABLE_SLIDES_EXPORT", - 'AI_RATE_LIMIT': "AI_RATE_LIMIT", - 'ATTACHMENT_SIZE_LIMIT': "ATTACHMENT_SIZE_LIMIT", - 'ATTACHMENT_LINK_TTL': "ATTACHMENT_LINK_TTL", - 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE': "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS': "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - 'ENABLE_AUTOMATION_EVALUATION_MODE': "ENABLE_AUTOMATION_EVALUATION_MODE", - 'REGISTERED_PLUGGABLE_APPLICATIONS': "REGISTERED_PLUGGABLE_APPLICATIONS", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'content': (JsonNode,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'content': 'content', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeSetting - a model defined in OpenAPI - - Args: - id (str): Setting ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content (JsonNode): [optional] # noqa: E501 - type (str): Type of the setting.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeSetting - a model defined in OpenAPI - - Args: - id (str): Setting ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content (JsonNode): [optional] # noqa: E501 - type (str): Type of the setting.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_single_workspace_permission.py b/gooddata-api-client/gooddata_api_client/model/declarative_single_workspace_permission.py deleted file mode 100644 index ac9f1cd2e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_single_workspace_permission.py +++ /dev/null @@ -1,293 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - globals()['AssigneeIdentifier'] = AssigneeIdentifier - - -class DeclarativeSingleWorkspacePermission(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'MANAGE': "MANAGE", - 'ANALYZE': "ANALYZE", - 'EXPORT': "EXPORT", - 'EXPORT_TABULAR': "EXPORT_TABULAR", - 'EXPORT_PDF': "EXPORT_PDF", - 'CREATE_AUTOMATION': "CREATE_AUTOMATION", - 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", - 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee': (AssigneeIdentifier,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee': 'assignee', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, assignee, name, *args, **kwargs): # noqa: E501 - """DeclarativeSingleWorkspacePermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - name (str): Permission name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, assignee, name, *args, **kwargs): # noqa: E501 - """DeclarativeSingleWorkspacePermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - name (str): Permission name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_single_workspace_permission.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_single_workspace_permission.pyi index 3efaea5c3..991fd0476 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_single_workspace_permission.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_single_workspace_permission.pyi @@ -39,39 +39,39 @@ class DeclarativeSingleWorkspacePermission( "name", "assignee", } - + class properties: - + @staticmethod def assignee() -> typing.Type['AssigneeIdentifier']: return AssigneeIdentifier - - + + class name( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def MANAGE(cls): return cls("MANAGE") - + @schemas.classproperty def ANALYZE(cls): return cls("ANALYZE") - + @schemas.classproperty def EXPORT(cls): return cls("EXPORT") - + @schemas.classproperty def EXPORT_TABULAR(cls): return cls("EXPORT_TABULAR") - + @schemas.classproperty def EXPORT_PDF(cls): return cls("EXPORT_PDF") - + @schemas.classproperty def VIEW(cls): return cls("VIEW") @@ -79,36 +79,36 @@ class DeclarativeSingleWorkspacePermission( "assignee": assignee, "name": name, } - + name: MetaOapg.properties.name assignee: 'AssigneeIdentifier' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -127,4 +127,4 @@ class DeclarativeSingleWorkspacePermission( **kwargs, ) -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_source_fact_reference.py b/gooddata-api-client/gooddata_api_client/model/declarative_source_fact_reference.py deleted file mode 100644 index b8725374d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_source_fact_reference.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.fact_identifier import FactIdentifier - globals()['FactIdentifier'] = FactIdentifier - - -class DeclarativeSourceFactReference(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('operation',): { - 'SUM': "SUM", - 'MIN': "MIN", - 'MAX': "MAX", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'operation': (str,), # noqa: E501 - 'reference': (FactIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'operation': 'operation', # noqa: E501 - 'reference': 'reference', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, operation, reference, *args, **kwargs): # noqa: E501 - """DeclarativeSourceFactReference - a model defined in OpenAPI - - Args: - operation (str): Aggregation operation. - reference (FactIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.operation = operation - self.reference = reference - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, operation, reference, *args, **kwargs): # noqa: E501 - """DeclarativeSourceFactReference - a model defined in OpenAPI - - Args: - operation (str): Aggregation operation. - reference (FactIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.operation = operation - self.reference = reference - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_table.py b/gooddata-api-client/gooddata_api_client/model/declarative_table.py deleted file mode 100644 index 20f8c9b14..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_table.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_column import DeclarativeColumn - globals()['DeclarativeColumn'] = DeclarativeColumn - - -class DeclarativeTable(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('name_prefix',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'columns': ([DeclarativeColumn],), # noqa: E501 - 'id': (str,), # noqa: E501 - 'path': ([str],), # noqa: E501 - 'type': (str,), # noqa: E501 - 'name_prefix': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'columns': 'columns', # noqa: E501 - 'id': 'id', # noqa: E501 - 'path': 'path', # noqa: E501 - 'type': 'type', # noqa: E501 - 'name_prefix': 'namePrefix', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, columns, id, path, type, *args, **kwargs): # noqa: E501 - """DeclarativeTable - a model defined in OpenAPI - - Args: - columns ([DeclarativeColumn]): An array of physical columns - id (str): Table id. - path ([str]): Path to table. - type (str): Table type: TABLE or VIEW. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name_prefix (str): Table or view name prefix used in scan. Will be stripped when generating LDM.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.columns = columns - self.id = id - self.path = path - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, columns, id, path, type, *args, **kwargs): # noqa: E501 - """DeclarativeTable - a model defined in OpenAPI - - Args: - columns ([DeclarativeColumn]): An array of physical columns - id (str): Table id. - path ([str]): Path to table. - type (str): Table type: TABLE or VIEW. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name_prefix (str): Table or view name prefix used in scan. Will be stripped when generating LDM.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.columns = columns - self.id = id - self.path = path - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_table.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_table.pyi index d80df1f37..61ce9a2dc 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_table.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_table.pyi @@ -43,21 +43,21 @@ class DeclarativeTable( "id", "type", } - + class properties: - - + + class columns( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeColumn']: return DeclarativeColumn - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeColumn'], typing.List['DeclarativeColumn']], @@ -68,25 +68,25 @@ class DeclarativeTable( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeColumn': return super().__getitem__(i) - - + + class id( schemas.StrSchema ): pass - - + + class path( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -97,12 +97,12 @@ class DeclarativeTable( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) type = schemas.StrSchema - - + + class namePrefix( schemas.StrSchema ): @@ -114,56 +114,56 @@ class DeclarativeTable( "type": type, "namePrefix": namePrefix, } - + path: MetaOapg.properties.path columns: MetaOapg.properties.columns id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["path"]) -> MetaOapg.properties.path: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["namePrefix"]) -> MetaOapg.properties.namePrefix: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["columns", "id", "path", "type", "namePrefix", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["path"]) -> MetaOapg.properties.path: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["namePrefix"]) -> typing.Union[MetaOapg.properties.namePrefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["columns", "id", "path", "type", "namePrefix", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -188,4 +188,4 @@ class DeclarativeTable( **kwargs, ) -from gooddata_api_client.model.declarative_column import DeclarativeColumn +from gooddata_api_client.models.declarative_column import DeclarativeColumn diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_tables.py b/gooddata-api-client/gooddata_api_client/model/declarative_tables.py deleted file mode 100644 index 0fc248659..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_tables.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_table import DeclarativeTable - globals()['DeclarativeTable'] = DeclarativeTable - - -class DeclarativeTables(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'tables': ([DeclarativeTable],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'tables': 'tables', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, tables, *args, **kwargs): # noqa: E501 - """DeclarativeTables - a model defined in OpenAPI - - Args: - tables ([DeclarativeTable]): An array of physical database tables. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.tables = tables - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, tables, *args, **kwargs): # noqa: E501 - """DeclarativeTables - a model defined in OpenAPI - - Args: - tables ([DeclarativeTable]): An array of physical database tables. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.tables = tables - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_tables.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_tables.pyi index 961e6ed08..93d5ff587 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_tables.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_tables.pyi @@ -40,21 +40,21 @@ class DeclarativeTables( required = { "tables", } - + class properties: - - + + class tables( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeTable']: return DeclarativeTable - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeTable'], typing.List['DeclarativeTable']], @@ -65,35 +65,35 @@ class DeclarativeTables( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeTable': return super().__getitem__(i) __annotations__ = { "tables": tables, } - + tables: MetaOapg.properties.tables - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tables"]) -> MetaOapg.properties.tables: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["tables", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tables"]) -> MetaOapg.properties.tables: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["tables", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -110,4 +110,4 @@ class DeclarativeTables( **kwargs, ) -from gooddata_api_client.model.declarative_table import DeclarativeTable +from gooddata_api_client.models.declarative_table import DeclarativeTable diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_theme.py b/gooddata-api-client/gooddata_api_client/model/declarative_theme.py deleted file mode 100644 index 401ccdc77..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_theme.py +++ /dev/null @@ -1,291 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_node import JsonNode - globals()['JsonNode'] = JsonNode - - -class DeclarativeTheme(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (JsonNode,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, id, name, *args, **kwargs): # noqa: E501 - """DeclarativeTheme - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, id, name, *args, **kwargs): # noqa: E501 - """DeclarativeTheme - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user.py b/gooddata-api-client/gooddata_api_client/model/declarative_user.py deleted file mode 100644 index dc6725a1d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user.py +++ /dev/null @@ -1,325 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_setting import DeclarativeSetting - from gooddata_api_client.model.declarative_user_group_identifier import DeclarativeUserGroupIdentifier - from gooddata_api_client.model.declarative_user_permission import DeclarativeUserPermission - globals()['DeclarativeSetting'] = DeclarativeSetting - globals()['DeclarativeUserGroupIdentifier'] = DeclarativeUserGroupIdentifier - globals()['DeclarativeUserPermission'] = DeclarativeUserPermission - - -class DeclarativeUser(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('auth_id',): { - 'max_length': 255, - }, - ('email',): { - 'max_length': 255, - }, - ('firstname',): { - 'max_length': 255, - }, - ('lastname',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'auth_id': (str,), # noqa: E501 - 'email': (str,), # noqa: E501 - 'firstname': (str,), # noqa: E501 - 'lastname': (str,), # noqa: E501 - 'permissions': ([DeclarativeUserPermission],), # noqa: E501 - 'settings': ([DeclarativeSetting],), # noqa: E501 - 'user_groups': ([DeclarativeUserGroupIdentifier],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'auth_id': 'authId', # noqa: E501 - 'email': 'email', # noqa: E501 - 'firstname': 'firstname', # noqa: E501 - 'lastname': 'lastname', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - 'settings': 'settings', # noqa: E501 - 'user_groups': 'userGroups', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeUser - a model defined in OpenAPI - - Args: - id (str): User identifier. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - auth_id (str): User identification in the authentication manager.. [optional] # noqa: E501 - email (str): User email address. [optional] # noqa: E501 - firstname (str): User first name. [optional] # noqa: E501 - lastname (str): User last name. [optional] # noqa: E501 - permissions ([DeclarativeUserPermission]): [optional] # noqa: E501 - settings ([DeclarativeSetting]): A list of user settings.. [optional] # noqa: E501 - user_groups ([DeclarativeUserGroupIdentifier]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeUser - a model defined in OpenAPI - - Args: - id (str): User identifier. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - auth_id (str): User identification in the authentication manager.. [optional] # noqa: E501 - email (str): User email address. [optional] # noqa: E501 - firstname (str): User first name. [optional] # noqa: E501 - lastname (str): User last name. [optional] # noqa: E501 - permissions ([DeclarativeUserPermission]): [optional] # noqa: E501 - settings ([DeclarativeSetting]): A list of user settings.. [optional] # noqa: E501 - user_groups ([DeclarativeUserGroupIdentifier]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_user.pyi index 3eeefc009..301a36205 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_user.pyi @@ -40,51 +40,51 @@ class DeclarativeUser( required = { "id", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class authId( schemas.StrSchema ): pass - - + + class email( schemas.StrSchema ): pass - - + + class firstname( schemas.StrSchema ): pass - - + + class lastname( schemas.StrSchema ): pass - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUserPermission']: return DeclarativeUserPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUserPermission'], typing.List['DeclarativeUserPermission']], @@ -95,22 +95,22 @@ class DeclarativeUser( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUserPermission': return super().__getitem__(i) - - + + class settings( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeSetting']: return DeclarativeSetting - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeSetting'], typing.List['DeclarativeSetting']], @@ -121,22 +121,22 @@ class DeclarativeUser( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeSetting': return super().__getitem__(i) - - + + class userGroups( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUserGroupIdentifier']: return DeclarativeUserGroupIdentifier - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUserGroupIdentifier'], typing.List['DeclarativeUserGroupIdentifier']], @@ -147,7 +147,7 @@ class DeclarativeUser( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUserGroupIdentifier': return super().__getitem__(i) __annotations__ = { @@ -160,71 +160,71 @@ class DeclarativeUser( "settings": settings, "userGroups": userGroups, } - + id: MetaOapg.properties.id - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["authId"]) -> MetaOapg.properties.authId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["firstname"]) -> MetaOapg.properties.firstname: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["lastname"]) -> MetaOapg.properties.lastname: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["settings"]) -> MetaOapg.properties.settings: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "authId", "email", "firstname", "lastname", "permissions", "settings", "userGroups", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["authId"]) -> typing.Union[MetaOapg.properties.authId, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> typing.Union[MetaOapg.properties.email, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["firstname"]) -> typing.Union[MetaOapg.properties.firstname, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["lastname"]) -> typing.Union[MetaOapg.properties.lastname, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["settings"]) -> typing.Union[MetaOapg.properties.settings, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroups"]) -> typing.Union[MetaOapg.properties.userGroups, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "authId", "email", "firstname", "lastname", "permissions", "settings", "userGroups", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -255,6 +255,6 @@ class DeclarativeUser( **kwargs, ) -from gooddata_api_client.model.declarative_setting import DeclarativeSetting -from gooddata_api_client.model.declarative_user_permission import DeclarativeUserPermission -from gooddata_api_client.model.user_group_identifier import DeclarativeUserGroupIdentifier +from gooddata_api_client.models.declarative_setting import DeclarativeSetting +from gooddata_api_client.models.declarative_user_permission import DeclarativeUserPermission +from gooddata_api_client.models.user_group_identifier import DeclarativeUserGroupIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filter.py b/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filter.py deleted file mode 100644 index 1eaff311f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filter.py +++ /dev/null @@ -1,322 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user_group_identifier import DeclarativeUserGroupIdentifier - from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - globals()['DeclarativeUserGroupIdentifier'] = DeclarativeUserGroupIdentifier - globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - - -class DeclarativeUserDataFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('maql',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'maql': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'user': (DeclarativeUserIdentifier,), # noqa: E501 - 'user_group': (DeclarativeUserGroupIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'maql': 'maql', # noqa: E501 - 'title': 'title', # noqa: E501 - 'description': 'description', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'user': 'user', # noqa: E501 - 'user_group': 'userGroup', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, maql, title, *args, **kwargs): # noqa: E501 - """DeclarativeUserDataFilter - a model defined in OpenAPI - - Args: - id (str): User Data Filters ID. This ID is further used to refer to this instance. - maql (str): Expression in MAQL specifying the User Data Filter - title (str): User Data Filters setting title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): User Data Filters setting description.. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - user (DeclarativeUserIdentifier): [optional] # noqa: E501 - user_group (DeclarativeUserGroupIdentifier): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.maql = maql - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, maql, title, *args, **kwargs): # noqa: E501 - """DeclarativeUserDataFilter - a model defined in OpenAPI - - Args: - id (str): User Data Filters ID. This ID is further used to refer to this instance. - maql (str): Expression in MAQL specifying the User Data Filter - title (str): User Data Filters setting title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): User Data Filters setting description.. [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - user (DeclarativeUserIdentifier): [optional] # noqa: E501 - user_group (DeclarativeUserGroupIdentifier): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.maql = maql - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filter.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filter.pyi index 8dd7e545d..030b6ece9 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filter.pyi @@ -42,42 +42,42 @@ class DeclarativeUserDataFilter( "maql", "title", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class maql( schemas.StrSchema ): pass - - + + class title( schemas.StrSchema ): pass - - + + class description( schemas.StrSchema ): pass - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -88,14 +88,14 @@ class DeclarativeUserDataFilter( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - + @staticmethod def user() -> typing.Type['UserIdentifier']: return UserIdentifier - + @staticmethod def userGroup() -> typing.Type['DeclarativeUserGroupIdentifier']: return DeclarativeUserGroupIdentifier @@ -108,67 +108,67 @@ class DeclarativeUserDataFilter( "user": user, "userGroup": userGroup, } - + id: MetaOapg.properties.id maql: MetaOapg.properties.maql title: MetaOapg.properties.title - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["user"]) -> 'UserIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroup"]) -> 'DeclarativeUserGroupIdentifier': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "maql", "title", "description", "tags", "user", "userGroup", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["user"]) -> typing.Union['UserIdentifier', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroup"]) -> typing.Union['DeclarativeUserGroupIdentifier', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "maql", "title", "description", "tags", "user", "userGroup", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -197,5 +197,5 @@ class DeclarativeUserDataFilter( **kwargs, ) -from gooddata_api_client.model.user_group_identifier import DeclarativeUserGroupIdentifier -from gooddata_api_client.model.user_identifier import UserIdentifier +from gooddata_api_client.models.user_group_identifier import DeclarativeUserGroupIdentifier +from gooddata_api_client.models.user_identifier import UserIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filters.py b/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filters.py deleted file mode 100644 index 92be98218..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filters.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user_data_filter import DeclarativeUserDataFilter - globals()['DeclarativeUserDataFilter'] = DeclarativeUserDataFilter - - -class DeclarativeUserDataFilters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'user_data_filters': ([DeclarativeUserDataFilter],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'user_data_filters': 'userDataFilters', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, user_data_filters, *args, **kwargs): # noqa: E501 - """DeclarativeUserDataFilters - a model defined in OpenAPI - - Args: - user_data_filters ([DeclarativeUserDataFilter]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.user_data_filters = user_data_filters - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, user_data_filters, *args, **kwargs): # noqa: E501 - """DeclarativeUserDataFilters - a model defined in OpenAPI - - Args: - user_data_filters ([DeclarativeUserDataFilter]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.user_data_filters = user_data_filters - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filters.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filters.pyi index 5ad290543..29b68c638 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filters.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_user_data_filters.pyi @@ -40,21 +40,21 @@ class DeclarativeUserDataFilters( required = { "userDataFilters", } - + class properties: - - + + class userDataFilters( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUserDataFilter']: return DeclarativeUserDataFilter - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUserDataFilter'], typing.List['DeclarativeUserDataFilter']], @@ -65,35 +65,35 @@ class DeclarativeUserDataFilters( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUserDataFilter': return super().__getitem__(i) __annotations__ = { "userDataFilters": userDataFilters, } - + userDataFilters: MetaOapg.properties.userDataFilters - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userDataFilters"]) -> MetaOapg.properties.userDataFilters: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["userDataFilters", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userDataFilters"]) -> MetaOapg.properties.userDataFilters: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userDataFilters", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -110,4 +110,4 @@ class DeclarativeUserDataFilters( **kwargs, ) -from gooddata_api_client.model.declarative_user_data_filter import DeclarativeUserDataFilter +from gooddata_api_client.models.declarative_user_data_filter import DeclarativeUserDataFilter diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_group.py b/gooddata-api-client/gooddata_api_client/model/declarative_user_group.py deleted file mode 100644 index a05685f44..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_group.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user_group_identifier import DeclarativeUserGroupIdentifier - from gooddata_api_client.model.declarative_user_group_permission import DeclarativeUserGroupPermission - globals()['DeclarativeUserGroupIdentifier'] = DeclarativeUserGroupIdentifier - globals()['DeclarativeUserGroupPermission'] = DeclarativeUserGroupPermission - - -class DeclarativeUserGroup(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'parents': ([DeclarativeUserGroupIdentifier],), # noqa: E501 - 'permissions': ([DeclarativeUserGroupPermission],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - 'parents': 'parents', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeUserGroup - a model defined in OpenAPI - - Args: - id (str): UserGroup identifier. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Name of UserGroup. [optional] # noqa: E501 - parents ([DeclarativeUserGroupIdentifier]): [optional] # noqa: E501 - permissions ([DeclarativeUserGroupPermission]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeUserGroup - a model defined in OpenAPI - - Args: - id (str): UserGroup identifier. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Name of UserGroup. [optional] # noqa: E501 - parents ([DeclarativeUserGroupIdentifier]): [optional] # noqa: E501 - permissions ([DeclarativeUserGroupPermission]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_group.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_user_group.pyi index b08bca6b0..9e41eeef5 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_group.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_user_group.pyi @@ -40,33 +40,33 @@ class DeclarativeUserGroup( required = { "id", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class name( schemas.StrSchema ): pass - - + + class parents( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUserGroupIdentifier']: return DeclarativeUserGroupIdentifier - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUserGroupIdentifier'], typing.List['DeclarativeUserGroupIdentifier']], @@ -77,22 +77,22 @@ class DeclarativeUserGroup( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUserGroupIdentifier': return super().__getitem__(i) - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUserGroupPermission']: return DeclarativeUserGroupPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUserGroupPermission'], typing.List['DeclarativeUserGroupPermission']], @@ -103,7 +103,7 @@ class DeclarativeUserGroup( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUserGroupPermission': return super().__getitem__(i) __annotations__ = { @@ -112,47 +112,47 @@ class DeclarativeUserGroup( "parents": parents, "permissions": permissions, } - + id: MetaOapg.properties.id - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["parents"]) -> MetaOapg.properties.parents: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "name", "parents", "permissions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["parents"]) -> typing.Union[MetaOapg.properties.parents, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "name", "parents", "permissions", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -175,5 +175,5 @@ class DeclarativeUserGroup( **kwargs, ) -from gooddata_api_client.model.declarative_user_group_permission import DeclarativeUserGroupPermission -from gooddata_api_client.model.user_group_identifier import DeclarativeUserGroupIdentifier +from gooddata_api_client.models.declarative_user_group_permission import DeclarativeUserGroupPermission +from gooddata_api_client.models.user_group_identifier import DeclarativeUserGroupIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_group_identifier.py b/gooddata-api-client/gooddata_api_client/model/declarative_user_group_identifier.py deleted file mode 100644 index 594690a2d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_group_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeUserGroupIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERGROUP': "userGroup", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeUserGroupIdentifier - a model defined in OpenAPI - - Args: - id (str): Identifier of the user group. - - Keyword Args: - type (str): A type.. defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeUserGroupIdentifier - a model defined in OpenAPI - - Args: - id (str): Identifier of the user group. - - Keyword Args: - type (str): A type.. defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permission.py b/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permission.py deleted file mode 100644 index c6469536e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permission.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - globals()['AssigneeIdentifier'] = AssigneeIdentifier - - -class DeclarativeUserGroupPermission(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'SEE': "SEE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee': (AssigneeIdentifier,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee': 'assignee', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, assignee, *args, **kwargs): # noqa: E501 - """DeclarativeUserGroupPermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - - Keyword Args: - name (str): Permission name.. defaults to "SEE", must be one of ["SEE", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - name = kwargs.get('name', "SEE") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, assignee, *args, **kwargs): # noqa: E501 - """DeclarativeUserGroupPermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - - Keyword Args: - name (str): Permission name.. defaults to "SEE", must be one of ["SEE", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - name = kwargs.get('name', "SEE") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permission.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permission.pyi index 6b30d3e16..1a5643668 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permission.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permission.pyi @@ -41,19 +41,19 @@ class DeclarativeUserGroupPermission( "name", "assignee", } - + class properties: - + @staticmethod def assignee() -> typing.Type['AssigneeIdentifier']: return AssigneeIdentifier - - + + class name( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def SEE(cls): return cls("SEE") @@ -61,36 +61,36 @@ class DeclarativeUserGroupPermission( "assignee": assignee, "name": name, } - + name: MetaOapg.properties.name assignee: 'AssigneeIdentifier' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -109,4 +109,4 @@ class DeclarativeUserGroupPermission( **kwargs, ) -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permissions.py b/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permissions.py deleted file mode 100644 index fc6a6fe24..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permissions.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user_group_permission import DeclarativeUserGroupPermission - globals()['DeclarativeUserGroupPermission'] = DeclarativeUserGroupPermission - - -class DeclarativeUserGroupPermissions(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'permissions': ([DeclarativeUserGroupPermission],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeUserGroupPermissions - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([DeclarativeUserGroupPermission]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeUserGroupPermissions - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([DeclarativeUserGroupPermission]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permissions.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permissions.pyi index 268e56e55..5d0758ca0 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permissions.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_user_group_permissions.pyi @@ -37,21 +37,21 @@ class DeclarativeUserGroupPermissions( class MetaOapg: - + class properties: - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUserGroupPermission']: return DeclarativeUserGroupPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUserGroupPermission'], typing.List['DeclarativeUserGroupPermission']], @@ -62,33 +62,33 @@ class DeclarativeUserGroupPermissions( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUserGroupPermission': return super().__getitem__(i) __annotations__ = { "permissions": permissions, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["permissions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["permissions", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -105,4 +105,4 @@ class DeclarativeUserGroupPermissions( **kwargs, ) -from gooddata_api_client.model.declarative_user_group_permission import DeclarativeUserGroupPermission +from gooddata_api_client.models.declarative_user_group_permission import DeclarativeUserGroupPermission diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_groups.py b/gooddata-api-client/gooddata_api_client/model/declarative_user_groups.py deleted file mode 100644 index 9d04e1228..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_groups.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user_group import DeclarativeUserGroup - globals()['DeclarativeUserGroup'] = DeclarativeUserGroup - - -class DeclarativeUserGroups(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'user_groups': ([DeclarativeUserGroup],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'user_groups': 'userGroups', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, user_groups, *args, **kwargs): # noqa: E501 - """DeclarativeUserGroups - a model defined in OpenAPI - - Args: - user_groups ([DeclarativeUserGroup]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.user_groups = user_groups - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, user_groups, *args, **kwargs): # noqa: E501 - """DeclarativeUserGroups - a model defined in OpenAPI - - Args: - user_groups ([DeclarativeUserGroup]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.user_groups = user_groups - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_groups.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_user_groups.pyi index 140fa1c7c..ce8be79ea 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_groups.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_user_groups.pyi @@ -40,21 +40,21 @@ class DeclarativeUserGroups( required = { "userGroups", } - + class properties: - - + + class userGroups( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUserGroup']: return DeclarativeUserGroup - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUserGroup'], typing.List['DeclarativeUserGroup']], @@ -65,35 +65,35 @@ class DeclarativeUserGroups( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUserGroup': return super().__getitem__(i) __annotations__ = { "userGroups": userGroups, } - + userGroups: MetaOapg.properties.userGroups - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["userGroups", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userGroups", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -110,4 +110,4 @@ class DeclarativeUserGroups( **kwargs, ) -from gooddata_api_client.model.declarative_user_group import DeclarativeUserGroup +from gooddata_api_client.models.declarative_user_group import DeclarativeUserGroup diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_identifier.py b/gooddata-api-client/gooddata_api_client/model/declarative_user_identifier.py deleted file mode 100644 index 1c685d25a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeUserIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USER': "user", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """DeclarativeUserIdentifier - a model defined in OpenAPI - - Args: - id (str): User identifier. - - Keyword Args: - type (str): A type.. defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """DeclarativeUserIdentifier - a model defined in OpenAPI - - Args: - id (str): User identifier. - - Keyword Args: - type (str): A type.. defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_permission.py b/gooddata-api-client/gooddata_api_client/model/declarative_user_permission.py deleted file mode 100644 index d7c5b659c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_permission.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - globals()['AssigneeIdentifier'] = AssigneeIdentifier - - -class DeclarativeUserPermission(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'SEE': "SEE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee': (AssigneeIdentifier,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee': 'assignee', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, assignee, *args, **kwargs): # noqa: E501 - """DeclarativeUserPermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - - Keyword Args: - name (str): Permission name.. defaults to "SEE", must be one of ["SEE", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - name = kwargs.get('name', "SEE") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, assignee, *args, **kwargs): # noqa: E501 - """DeclarativeUserPermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - - Keyword Args: - name (str): Permission name.. defaults to "SEE", must be one of ["SEE", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - name = kwargs.get('name', "SEE") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_permission.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_user_permission.pyi index 795810ba6..23cef94ca 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_permission.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_user_permission.pyi @@ -41,19 +41,19 @@ class DeclarativeUserPermission( "name", "assignee", } - + class properties: - + @staticmethod def assignee() -> typing.Type['AssigneeIdentifier']: return AssigneeIdentifier - - + + class name( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def SEE(cls): return cls("SEE") @@ -61,36 +61,36 @@ class DeclarativeUserPermission( "assignee": assignee, "name": name, } - + name: MetaOapg.properties.name assignee: 'AssigneeIdentifier' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -109,4 +109,4 @@ class DeclarativeUserPermission( **kwargs, ) -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_permissions.py b/gooddata-api-client/gooddata_api_client/model/declarative_user_permissions.py deleted file mode 100644 index 5d1662d56..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_permissions.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user_permission import DeclarativeUserPermission - globals()['DeclarativeUserPermission'] = DeclarativeUserPermission - - -class DeclarativeUserPermissions(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'permissions': ([DeclarativeUserPermission],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeUserPermissions - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([DeclarativeUserPermission]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeUserPermissions - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([DeclarativeUserPermission]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_permissions.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_user_permissions.pyi index bdfe9606c..8e9a7f825 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_user_permissions.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_user_permissions.pyi @@ -37,21 +37,21 @@ class DeclarativeUserPermissions( class MetaOapg: - + class properties: - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUserPermission']: return DeclarativeUserPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUserPermission'], typing.List['DeclarativeUserPermission']], @@ -62,33 +62,33 @@ class DeclarativeUserPermissions( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUserPermission': return super().__getitem__(i) __annotations__ = { "permissions": permissions, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["permissions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["permissions", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -105,4 +105,4 @@ class DeclarativeUserPermissions( **kwargs, ) -from gooddata_api_client.model.declarative_user_permission import DeclarativeUserPermission +from gooddata_api_client.models.declarative_user_permission import DeclarativeUserPermission diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_users.py b/gooddata-api-client/gooddata_api_client/model/declarative_users.py deleted file mode 100644 index fe5ec8ef0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_users.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user import DeclarativeUser - globals()['DeclarativeUser'] = DeclarativeUser - - -class DeclarativeUsers(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'users': ([DeclarativeUser],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'users': 'users', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, users, *args, **kwargs): # noqa: E501 - """DeclarativeUsers - a model defined in OpenAPI - - Args: - users ([DeclarativeUser]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, users, *args, **kwargs): # noqa: E501 - """DeclarativeUsers - a model defined in OpenAPI - - Args: - users ([DeclarativeUser]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_users.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_users.pyi index f43e9b96d..e6a2c3b16 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_users.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_users.pyi @@ -40,21 +40,21 @@ class DeclarativeUsers( required = { "users", } - + class properties: - - + + class users( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUser']: return DeclarativeUser - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUser'], typing.List['DeclarativeUser']], @@ -65,35 +65,35 @@ class DeclarativeUsers( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUser': return super().__getitem__(i) __annotations__ = { "users": users, } - + users: MetaOapg.properties.users - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["users", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["users", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -110,4 +110,4 @@ class DeclarativeUsers( **kwargs, ) -from gooddata_api_client.model.declarative_user import DeclarativeUser +from gooddata_api_client.models.declarative_user import DeclarativeUser diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_users_user_groups.py b/gooddata-api-client/gooddata_api_client/model/declarative_users_user_groups.py deleted file mode 100644 index f16386139..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_users_user_groups.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user import DeclarativeUser - from gooddata_api_client.model.declarative_user_group import DeclarativeUserGroup - globals()['DeclarativeUser'] = DeclarativeUser - globals()['DeclarativeUserGroup'] = DeclarativeUserGroup - - -class DeclarativeUsersUserGroups(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'user_groups': ([DeclarativeUserGroup],), # noqa: E501 - 'users': ([DeclarativeUser],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'user_groups': 'userGroups', # noqa: E501 - 'users': 'users', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, user_groups, users, *args, **kwargs): # noqa: E501 - """DeclarativeUsersUserGroups - a model defined in OpenAPI - - Args: - user_groups ([DeclarativeUserGroup]): - users ([DeclarativeUser]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.user_groups = user_groups - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, user_groups, users, *args, **kwargs): # noqa: E501 - """DeclarativeUsersUserGroups - a model defined in OpenAPI - - Args: - user_groups ([DeclarativeUserGroup]): - users ([DeclarativeUser]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.user_groups = user_groups - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_users_user_groups.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_users_user_groups.pyi index 4a47d4e89..597693e1c 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_users_user_groups.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_users_user_groups.pyi @@ -41,21 +41,21 @@ class DeclarativeUsersUserGroups( "userGroups", "users", } - + class properties: - - + + class userGroups( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUserGroup']: return DeclarativeUserGroup - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUserGroup'], typing.List['DeclarativeUserGroup']], @@ -66,22 +66,22 @@ class DeclarativeUsersUserGroups( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUserGroup': return super().__getitem__(i) - - + + class users( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUser']: return DeclarativeUser - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUser'], typing.List['DeclarativeUser']], @@ -92,43 +92,43 @@ class DeclarativeUsersUserGroups( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUser': return super().__getitem__(i) __annotations__ = { "userGroups": userGroups, "users": users, } - + userGroups: MetaOapg.properties.userGroups users: MetaOapg.properties.users - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["userGroups", "users", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userGroups", "users", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -147,5 +147,5 @@ class DeclarativeUsersUserGroups( **kwargs, ) -from gooddata_api_client.model.declarative_user import DeclarativeUser -from gooddata_api_client.model.declarative_user_group import DeclarativeUserGroup +from gooddata_api_client.models.declarative_user import DeclarativeUser +from gooddata_api_client.models.declarative_user_group import DeclarativeUserGroup diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object.py b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object.py deleted file mode 100644 index bf0537806..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object.py +++ /dev/null @@ -1,341 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - from gooddata_api_client.model.json_node import JsonNode - globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - globals()['JsonNode'] = JsonNode - - -class DeclarativeVisualizationObject(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('created_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('description',): { - 'max_length': 10000, - }, - ('modified_at',): { - 'regex': { - 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 - }, - }, - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (JsonNode,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'created_at': (str, none_type,), # noqa: E501 - 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'modified_at': (str, none_type,), # noqa: E501 - 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeVisualizationObject - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Visualization object ID. - title (str): Visualization object title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Visualization object description.. [optional] # noqa: E501 - is_hidden (bool): If true, this visualization object is hidden from AI search results.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 - """DeclarativeVisualizationObject - a model defined in OpenAPI - - Args: - content (JsonNode): - id (str): Visualization object ID. - title (str): Visualization object title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 - created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - description (str): Visualization object description.. [optional] # noqa: E501 - is_hidden (bool): If true, this visualization object is hidden from AI search results.. [optional] # noqa: E501 - modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 - modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - tags ([str]): A list of tags.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace.py deleted file mode 100644 index 00c85223c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace.py +++ /dev/null @@ -1,382 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_automation import DeclarativeAutomation - from gooddata_api_client.model.declarative_custom_application_setting import DeclarativeCustomApplicationSetting - from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView - from gooddata_api_client.model.declarative_setting import DeclarativeSetting - from gooddata_api_client.model.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission - from gooddata_api_client.model.declarative_user_data_filter import DeclarativeUserDataFilter - from gooddata_api_client.model.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission - from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel - from gooddata_api_client.model.workspace_data_source import WorkspaceDataSource - from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier - globals()['DeclarativeAutomation'] = DeclarativeAutomation - globals()['DeclarativeCustomApplicationSetting'] = DeclarativeCustomApplicationSetting - globals()['DeclarativeFilterView'] = DeclarativeFilterView - globals()['DeclarativeSetting'] = DeclarativeSetting - globals()['DeclarativeSingleWorkspacePermission'] = DeclarativeSingleWorkspacePermission - globals()['DeclarativeUserDataFilter'] = DeclarativeUserDataFilter - globals()['DeclarativeWorkspaceHierarchyPermission'] = DeclarativeWorkspaceHierarchyPermission - globals()['DeclarativeWorkspaceModel'] = DeclarativeWorkspaceModel - globals()['WorkspaceDataSource'] = WorkspaceDataSource - globals()['WorkspaceIdentifier'] = WorkspaceIdentifier - - -class DeclarativeWorkspace(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('name',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 255, - }, - ('early_access',): { - 'max_length': 255, - }, - ('early_access_values',): { - }, - ('prefix',): { - 'max_length': 255, - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'automations': ([DeclarativeAutomation],), # noqa: E501 - 'cache_extra_limit': (int,), # noqa: E501 - 'custom_application_settings': ([DeclarativeCustomApplicationSetting],), # noqa: E501 - 'data_source': (WorkspaceDataSource,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'early_access': (str,), # noqa: E501 - 'early_access_values': ([str],), # noqa: E501 - 'filter_views': ([DeclarativeFilterView],), # noqa: E501 - 'hierarchy_permissions': ([DeclarativeWorkspaceHierarchyPermission],), # noqa: E501 - 'model': (DeclarativeWorkspaceModel,), # noqa: E501 - 'parent': (WorkspaceIdentifier,), # noqa: E501 - 'permissions': ([DeclarativeSingleWorkspacePermission],), # noqa: E501 - 'prefix': (str,), # noqa: E501 - 'settings': ([DeclarativeSetting],), # noqa: E501 - 'user_data_filters': ([DeclarativeUserDataFilter],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - 'automations': 'automations', # noqa: E501 - 'cache_extra_limit': 'cacheExtraLimit', # noqa: E501 - 'custom_application_settings': 'customApplicationSettings', # noqa: E501 - 'data_source': 'dataSource', # noqa: E501 - 'description': 'description', # noqa: E501 - 'early_access': 'earlyAccess', # noqa: E501 - 'early_access_values': 'earlyAccessValues', # noqa: E501 - 'filter_views': 'filterViews', # noqa: E501 - 'hierarchy_permissions': 'hierarchyPermissions', # noqa: E501 - 'model': 'model', # noqa: E501 - 'parent': 'parent', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - 'prefix': 'prefix', # noqa: E501 - 'settings': 'settings', # noqa: E501 - 'user_data_filters': 'userDataFilters', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspace - a model defined in OpenAPI - - Args: - id (str): Identifier of a workspace - name (str): Name of a workspace to view. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - automations ([DeclarativeAutomation]): [optional] # noqa: E501 - cache_extra_limit (int): Extra cache limit allocated to specific workspace. In case there is extra cache budget setup for organization, it can be split between multiple workspaces.. [optional] # noqa: E501 - custom_application_settings ([DeclarativeCustomApplicationSetting]): A list of workspace custom settings.. [optional] # noqa: E501 - data_source (WorkspaceDataSource): [optional] # noqa: E501 - description (str): Description of the workspace. [optional] # noqa: E501 - early_access (str): Early access defined on level Workspace. [optional] # noqa: E501 - early_access_values ([str]): Early access defined on level Workspace. [optional] # noqa: E501 - filter_views ([DeclarativeFilterView]): [optional] # noqa: E501 - hierarchy_permissions ([DeclarativeWorkspaceHierarchyPermission]): [optional] # noqa: E501 - model (DeclarativeWorkspaceModel): [optional] # noqa: E501 - parent (WorkspaceIdentifier): [optional] # noqa: E501 - permissions ([DeclarativeSingleWorkspacePermission]): [optional] # noqa: E501 - prefix (str): Custom prefix of entity identifiers in workspace. [optional] # noqa: E501 - settings ([DeclarativeSetting]): A list of workspace settings.. [optional] # noqa: E501 - user_data_filters ([DeclarativeUserDataFilter]): A list of workspace user data filters.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, name, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspace - a model defined in OpenAPI - - Args: - id (str): Identifier of a workspace - name (str): Name of a workspace to view. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - automations ([DeclarativeAutomation]): [optional] # noqa: E501 - cache_extra_limit (int): Extra cache limit allocated to specific workspace. In case there is extra cache budget setup for organization, it can be split between multiple workspaces.. [optional] # noqa: E501 - custom_application_settings ([DeclarativeCustomApplicationSetting]): A list of workspace custom settings.. [optional] # noqa: E501 - data_source (WorkspaceDataSource): [optional] # noqa: E501 - description (str): Description of the workspace. [optional] # noqa: E501 - early_access (str): Early access defined on level Workspace. [optional] # noqa: E501 - early_access_values ([str]): Early access defined on level Workspace. [optional] # noqa: E501 - filter_views ([DeclarativeFilterView]): [optional] # noqa: E501 - hierarchy_permissions ([DeclarativeWorkspaceHierarchyPermission]): [optional] # noqa: E501 - model (DeclarativeWorkspaceModel): [optional] # noqa: E501 - parent (WorkspaceIdentifier): [optional] # noqa: E501 - permissions ([DeclarativeSingleWorkspacePermission]): [optional] # noqa: E501 - prefix (str): Custom prefix of entity identifiers in workspace. [optional] # noqa: E501 - settings ([DeclarativeSetting]): A list of workspace settings.. [optional] # noqa: E501 - user_data_filters ([DeclarativeUserDataFilter]): A list of workspace user data filters.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_workspace.pyi index bb0a74560..f1ae48325 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace.pyi @@ -41,33 +41,33 @@ class DeclarativeWorkspace( "name", "id", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class name( schemas.StrSchema ): pass - - + + class customApplicationSettings( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeCustomApplicationSetting']: return DeclarativeCustomApplicationSetting - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeCustomApplicationSetting'], typing.List['DeclarativeCustomApplicationSetting']], @@ -78,34 +78,34 @@ class DeclarativeWorkspace( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeCustomApplicationSetting': return super().__getitem__(i) - - + + class description( schemas.StrSchema ): pass - - + + class earlyAccess( schemas.StrSchema ): pass - - + + class hierarchyPermissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeWorkspaceHierarchyPermission']: return DeclarativeWorkspaceHierarchyPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeWorkspaceHierarchyPermission'], typing.List['DeclarativeWorkspaceHierarchyPermission']], @@ -116,30 +116,30 @@ class DeclarativeWorkspace( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeWorkspaceHierarchyPermission': return super().__getitem__(i) - + @staticmethod def model() -> typing.Type['DeclarativeWorkspaceModel']: return DeclarativeWorkspaceModel - + @staticmethod def parent() -> typing.Type['WorkspaceIdentifier']: return WorkspaceIdentifier - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeSingleWorkspacePermission']: return DeclarativeSingleWorkspacePermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeSingleWorkspacePermission'], typing.List['DeclarativeSingleWorkspacePermission']], @@ -150,28 +150,28 @@ class DeclarativeWorkspace( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeSingleWorkspacePermission': return super().__getitem__(i) - - + + class prefix( schemas.StrSchema ): pass - - + + class settings( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeSetting']: return DeclarativeSetting - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeSetting'], typing.List['DeclarativeSetting']], @@ -182,22 +182,22 @@ class DeclarativeWorkspace( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeSetting': return super().__getitem__(i) - - + + class userDataFilters( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeUserDataFilter']: return DeclarativeUserDataFilter - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeUserDataFilter'], typing.List['DeclarativeUserDataFilter']], @@ -208,7 +208,7 @@ class DeclarativeWorkspace( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeUserDataFilter': return super().__getitem__(i) __annotations__ = { @@ -225,96 +225,96 @@ class DeclarativeWorkspace( "settings": settings, "userDataFilters": userDataFilters, } - + name: MetaOapg.properties.name id: MetaOapg.properties.id - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["customApplicationSettings"]) -> MetaOapg.properties.customApplicationSettings: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["earlyAccess"]) -> MetaOapg.properties.earlyAccess: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["hierarchyPermissions"]) -> MetaOapg.properties.hierarchyPermissions: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["model"]) -> 'DeclarativeWorkspaceModel': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["parent"]) -> 'WorkspaceIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["prefix"]) -> MetaOapg.properties.prefix: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["settings"]) -> MetaOapg.properties.settings: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userDataFilters"]) -> MetaOapg.properties.userDataFilters: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "name", "customApplicationSettings", "description", "earlyAccess", "hierarchyPermissions", "model", "parent", "permissions", "prefix", "settings", "userDataFilters", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["customApplicationSettings"]) -> typing.Union[MetaOapg.properties.customApplicationSettings, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["earlyAccess"]) -> typing.Union[MetaOapg.properties.earlyAccess, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["hierarchyPermissions"]) -> typing.Union[MetaOapg.properties.hierarchyPermissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["model"]) -> typing.Union['DeclarativeWorkspaceModel', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["parent"]) -> typing.Union['WorkspaceIdentifier', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["prefix"]) -> typing.Union[MetaOapg.properties.prefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["settings"]) -> typing.Union[MetaOapg.properties.settings, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userDataFilters"]) -> typing.Union[MetaOapg.properties.userDataFilters, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "name", "customApplicationSettings", "description", "earlyAccess", "hierarchyPermissions", "model", "parent", "permissions", "prefix", "settings", "userDataFilters", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -353,10 +353,10 @@ class DeclarativeWorkspace( **kwargs, ) -from gooddata_api_client.model.declarative_custom_application_setting import DeclarativeCustomApplicationSetting -from gooddata_api_client.model.declarative_setting import DeclarativeSetting -from gooddata_api_client.model.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission -from gooddata_api_client.model.declarative_user_data_filter import DeclarativeUserDataFilter -from gooddata_api_client.model.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel -from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier +from gooddata_api_client.models.declarative_custom_application_setting import DeclarativeCustomApplicationSetting +from gooddata_api_client.models.declarative_setting import DeclarativeSetting +from gooddata_api_client.models.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission +from gooddata_api_client.models.declarative_user_data_filter import DeclarativeUserDataFilter +from gooddata_api_client.models.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.workspace_identifier import WorkspaceIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter.py deleted file mode 100644 index e28f7ff95..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter.py +++ /dev/null @@ -1,320 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_workspace_data_filter_setting import DeclarativeWorkspaceDataFilterSetting - from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier - globals()['DeclarativeWorkspaceDataFilterSetting'] = DeclarativeWorkspaceDataFilterSetting - globals()['WorkspaceIdentifier'] = WorkspaceIdentifier - - -class DeclarativeWorkspaceDataFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('column_name',): { - 'max_length': 255, - }, - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'column_name': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'workspace': (WorkspaceIdentifier,), # noqa: E501 - 'workspace_data_filter_settings': ([DeclarativeWorkspaceDataFilterSetting],), # noqa: E501 - 'description': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'column_name': 'columnName', # noqa: E501 - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'workspace': 'workspace', # noqa: E501 - 'workspace_data_filter_settings': 'workspaceDataFilterSettings', # noqa: E501 - 'description': 'description', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, column_name, id, title, workspace, workspace_data_filter_settings, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceDataFilter - a model defined in OpenAPI - - Args: - column_name (str): Workspace Data Filters column name. Data are filtered using this physical column. - id (str): Workspace Data Filters ID. This ID is further used to refer to this instance. - title (str): Workspace Data Filters title. - workspace (WorkspaceIdentifier): - workspace_data_filter_settings ([DeclarativeWorkspaceDataFilterSetting]): Filter settings specifying values of filters valid for the workspace. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Workspace Data Filters description.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column_name = column_name - self.id = id - self.title = title - self.workspace = workspace - self.workspace_data_filter_settings = workspace_data_filter_settings - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, column_name, id, title, workspace, workspace_data_filter_settings, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceDataFilter - a model defined in OpenAPI - - Args: - column_name (str): Workspace Data Filters column name. Data are filtered using this physical column. - id (str): Workspace Data Filters ID. This ID is further used to refer to this instance. - title (str): Workspace Data Filters title. - workspace (WorkspaceIdentifier): - workspace_data_filter_settings ([DeclarativeWorkspaceDataFilterSetting]): Filter settings specifying values of filters valid for the workspace. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Workspace Data Filters description.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column_name = column_name - self.id = id - self.title = title - self.workspace = workspace - self.workspace_data_filter_settings = workspace_data_filter_settings - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter.pyi index cfcce9d99..9a6ef105d 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter.pyi @@ -43,39 +43,39 @@ class DeclarativeWorkspaceDataFilter( "title", "columnName", } - + class properties: - - + + class columnName( schemas.StrSchema ): pass - - + + class id( schemas.StrSchema ): pass - - + + class title( schemas.StrSchema ): pass - - + + class workspaceDataFilterSettings( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeWorkspaceDataFilterSetting']: return DeclarativeWorkspaceDataFilterSetting - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeWorkspaceDataFilterSetting'], typing.List['DeclarativeWorkspaceDataFilterSetting']], @@ -86,16 +86,16 @@ class DeclarativeWorkspaceDataFilter( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeWorkspaceDataFilterSetting': return super().__getitem__(i) - - + + class description( schemas.StrSchema ): pass - + @staticmethod def workspace() -> typing.Type['WorkspaceIdentifier']: return WorkspaceIdentifier @@ -107,62 +107,62 @@ class DeclarativeWorkspaceDataFilter( "description": description, "workspace": workspace, } - + workspaceDataFilterSettings: MetaOapg.properties.workspaceDataFilterSettings id: MetaOapg.properties.id title: MetaOapg.properties.title columnName: MetaOapg.properties.columnName - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["columnName"]) -> MetaOapg.properties.columnName: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["workspaceDataFilterSettings"]) -> MetaOapg.properties.workspaceDataFilterSettings: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["workspace"]) -> 'WorkspaceIdentifier': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["columnName", "id", "title", "workspaceDataFilterSettings", "description", "workspace", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["columnName"]) -> MetaOapg.properties.columnName: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["workspaceDataFilterSettings"]) -> MetaOapg.properties.workspaceDataFilterSettings: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["workspace"]) -> typing.Union['WorkspaceIdentifier', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["columnName", "id", "title", "workspaceDataFilterSettings", "description", "workspace", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -189,5 +189,5 @@ class DeclarativeWorkspaceDataFilter( **kwargs, ) -from gooddata_api_client.model.declarative_workspace_data_filter_setting import DeclarativeWorkspaceDataFilterSetting -from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier +from gooddata_api_client.models.declarative_workspace_data_filter_setting import DeclarativeWorkspaceDataFilterSetting +from gooddata_api_client.models.workspace_identifier import WorkspaceIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_column.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_column.py deleted file mode 100644 index 6aa74d499..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_column.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DeclarativeWorkspaceDataFilterColumn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'data_type': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_type': 'dataType', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_type, name, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceDataFilterColumn - a model defined in OpenAPI - - Args: - data_type (str): Data type of the column - name (str): Name of the column - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_type = data_type - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_type, name, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceDataFilterColumn - a model defined in OpenAPI - - Args: - data_type (str): Data type of the column - name (str): Name of the column - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_type = data_type - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_references.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_references.py deleted file mode 100644 index f22ca35f0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_references.py +++ /dev/null @@ -1,297 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier - globals()['DatasetWorkspaceDataFilterIdentifier'] = DatasetWorkspaceDataFilterIdentifier - - -class DeclarativeWorkspaceDataFilterReferences(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('filter_column_data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'filter_column': (str,), # noqa: E501 - 'filter_column_data_type': (str,), # noqa: E501 - 'filter_id': (DatasetWorkspaceDataFilterIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'filter_column': 'filterColumn', # noqa: E501 - 'filter_column_data_type': 'filterColumnDataType', # noqa: E501 - 'filter_id': 'filterId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, filter_column, filter_column_data_type, filter_id, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceDataFilterReferences - a model defined in OpenAPI - - Args: - filter_column (str): Filter column name - filter_column_data_type (str): Filter column data type - filter_id (DatasetWorkspaceDataFilterIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter_column = filter_column - self.filter_column_data_type = filter_column_data_type - self.filter_id = filter_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, filter_column, filter_column_data_type, filter_id, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceDataFilterReferences - a model defined in OpenAPI - - Args: - filter_column (str): Filter column name - filter_column_data_type (str): Filter column data type - filter_id (DatasetWorkspaceDataFilterIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter_column = filter_column - self.filter_column_data_type = filter_column_data_type - self.filter_id = filter_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_setting.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_setting.py deleted file mode 100644 index b4a1387fa..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_setting.py +++ /dev/null @@ -1,309 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier - globals()['WorkspaceIdentifier'] = WorkspaceIdentifier - - -class DeclarativeWorkspaceDataFilterSetting(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - ('title',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'filter_values': ([str],), # noqa: E501 - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'workspace': (WorkspaceIdentifier,), # noqa: E501 - 'description': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'filter_values': 'filterValues', # noqa: E501 - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'workspace': 'workspace', # noqa: E501 - 'description': 'description', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, filter_values, id, title, workspace, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceDataFilterSetting - a model defined in OpenAPI - - Args: - filter_values ([str]): Only those rows are returned, where columnName from filter matches those values. - id (str): Workspace Data Filters ID. This ID is further used to refer to this instance. - title (str): Workspace Data Filters setting title. - workspace (WorkspaceIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Workspace Data Filters setting description.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter_values = filter_values - self.id = id - self.title = title - self.workspace = workspace - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, filter_values, id, title, workspace, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceDataFilterSetting - a model defined in OpenAPI - - Args: - filter_values ([str]): Only those rows are returned, where columnName from filter matches those values. - id (str): Workspace Data Filters ID. This ID is further used to refer to this instance. - title (str): Workspace Data Filters setting title. - workspace (WorkspaceIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Workspace Data Filters setting description.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter_values = filter_values - self.id = id - self.title = title - self.workspace = workspace - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_setting.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_setting.pyi index 0c4c3089c..049be3510 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_setting.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_setting.pyi @@ -43,18 +43,18 @@ class DeclarativeWorkspaceDataFilterSetting( "id", "title", } - + class properties: - - + + class filterValues( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -65,27 +65,27 @@ class DeclarativeWorkspaceDataFilterSetting( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class id( schemas.StrSchema ): pass - - + + class title( schemas.StrSchema ): pass - + @staticmethod def workspace() -> typing.Type['WorkspaceIdentifier']: return WorkspaceIdentifier - - + + class description( schemas.StrSchema ): @@ -97,56 +97,56 @@ class DeclarativeWorkspaceDataFilterSetting( "workspace": workspace, "description": description, } - + filterValues: MetaOapg.properties.filterValues workspace: 'WorkspaceIdentifier' id: MetaOapg.properties.id title: MetaOapg.properties.title - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["filterValues"]) -> MetaOapg.properties.filterValues: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["workspace"]) -> 'WorkspaceIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["filterValues", "id", "title", "workspace", "description", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["filterValues"]) -> MetaOapg.properties.filterValues: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["workspace"]) -> 'WorkspaceIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["filterValues", "id", "title", "workspace", "description", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -171,4 +171,4 @@ class DeclarativeWorkspaceDataFilterSetting( **kwargs, ) -from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier +from gooddata_api_client.models.workspace_identifier import WorkspaceIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filters.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filters.py deleted file mode 100644 index 99afe6f28..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filters.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter - globals()['DeclarativeWorkspaceDataFilter'] = DeclarativeWorkspaceDataFilter - - -class DeclarativeWorkspaceDataFilters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'workspace_data_filters': ([DeclarativeWorkspaceDataFilter],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'workspace_data_filters': 'workspaceDataFilters', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, workspace_data_filters, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceDataFilters - a model defined in OpenAPI - - Args: - workspace_data_filters ([DeclarativeWorkspaceDataFilter]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.workspace_data_filters = workspace_data_filters - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, workspace_data_filters, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceDataFilters - a model defined in OpenAPI - - Args: - workspace_data_filters ([DeclarativeWorkspaceDataFilter]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.workspace_data_filters = workspace_data_filters - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filters.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filters.pyi index 2158061c8..a975147d8 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filters.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filters.pyi @@ -40,21 +40,21 @@ class DeclarativeWorkspaceDataFilters( required = { "workspaceDataFilters", } - + class properties: - - + + class workspaceDataFilters( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeWorkspaceDataFilter']: return DeclarativeWorkspaceDataFilter - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeWorkspaceDataFilter'], typing.List['DeclarativeWorkspaceDataFilter']], @@ -65,35 +65,35 @@ class DeclarativeWorkspaceDataFilters( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeWorkspaceDataFilter': return super().__getitem__(i) __annotations__ = { "workspaceDataFilters": workspaceDataFilters, } - + workspaceDataFilters: MetaOapg.properties.workspaceDataFilters - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["workspaceDataFilters"]) -> MetaOapg.properties.workspaceDataFilters: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["workspaceDataFilters", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["workspaceDataFilters"]) -> MetaOapg.properties.workspaceDataFilters: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["workspaceDataFilters", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -110,4 +110,4 @@ class DeclarativeWorkspaceDataFilters( **kwargs, ) -from gooddata_api_client.model.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter +from gooddata_api_client.models.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_hierarchy_permission.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_hierarchy_permission.py deleted file mode 100644 index 854309a92..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_hierarchy_permission.py +++ /dev/null @@ -1,293 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - globals()['AssigneeIdentifier'] = AssigneeIdentifier - - -class DeclarativeWorkspaceHierarchyPermission(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'MANAGE': "MANAGE", - 'ANALYZE': "ANALYZE", - 'EXPORT': "EXPORT", - 'EXPORT_TABULAR': "EXPORT_TABULAR", - 'EXPORT_PDF': "EXPORT_PDF", - 'CREATE_AUTOMATION': "CREATE_AUTOMATION", - 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", - 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee': (AssigneeIdentifier,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee': 'assignee', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, assignee, name, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceHierarchyPermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - name (str): Permission name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, assignee, name, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceHierarchyPermission - a model defined in OpenAPI - - Args: - assignee (AssigneeIdentifier): - name (str): Permission name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee = assignee - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_hierarchy_permission.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_hierarchy_permission.pyi index 1bf30df41..d670315f8 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_hierarchy_permission.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_hierarchy_permission.pyi @@ -39,39 +39,39 @@ class DeclarativeWorkspaceHierarchyPermission( "name", "assignee", } - + class properties: - + @staticmethod def assignee() -> typing.Type['AssigneeIdentifier']: return AssigneeIdentifier - - + + class name( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def MANAGE(cls): return cls("MANAGE") - + @schemas.classproperty def ANALYZE(cls): return cls("ANALYZE") - + @schemas.classproperty def EXPORT(cls): return cls("EXPORT") - + @schemas.classproperty def EXPORT_TABULAR(cls): return cls("EXPORT_TABULAR") - + @schemas.classproperty def EXPORT_PDF(cls): return cls("EXPORT_PDF") - + @schemas.classproperty def VIEW(cls): return cls("VIEW") @@ -79,36 +79,36 @@ class DeclarativeWorkspaceHierarchyPermission( "assignee": assignee, "name": name, } - + name: MetaOapg.properties.name assignee: 'AssigneeIdentifier' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assignee", "name", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -127,4 +127,4 @@ class DeclarativeWorkspaceHierarchyPermission( **kwargs, ) -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_model.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_model.py deleted file mode 100644 index 4a4fba810..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_model.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_analytics_layer import DeclarativeAnalyticsLayer - from gooddata_api_client.model.declarative_ldm import DeclarativeLdm - globals()['DeclarativeAnalyticsLayer'] = DeclarativeAnalyticsLayer - globals()['DeclarativeLdm'] = DeclarativeLdm - - -class DeclarativeWorkspaceModel(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'analytics': (DeclarativeAnalyticsLayer,), # noqa: E501 - 'ldm': (DeclarativeLdm,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'analytics': 'analytics', # noqa: E501 - 'ldm': 'ldm', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceModel - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytics (DeclarativeAnalyticsLayer): [optional] # noqa: E501 - ldm (DeclarativeLdm): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaceModel - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytics (DeclarativeAnalyticsLayer): [optional] # noqa: E501 - ldm (DeclarativeLdm): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_model.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_model.pyi index 64eabcc64..4011c86d5 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_model.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_model.pyi @@ -37,13 +37,13 @@ class DeclarativeWorkspaceModel( class MetaOapg: - + class properties: - + @staticmethod def analytics() -> typing.Type['DeclarativeAnalyticsLayer']: return DeclarativeAnalyticsLayer - + @staticmethod def ldm() -> typing.Type['DeclarativeLdm']: return DeclarativeLdm @@ -51,33 +51,33 @@ class DeclarativeWorkspaceModel( "analytics": analytics, "ldm": ldm, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["analytics"]) -> 'DeclarativeAnalyticsLayer': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["ldm"]) -> 'DeclarativeLdm': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analytics", "ldm", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["analytics"]) -> typing.Union['DeclarativeAnalyticsLayer', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["ldm"]) -> typing.Union['DeclarativeLdm', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analytics", "ldm", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -96,5 +96,5 @@ class DeclarativeWorkspaceModel( **kwargs, ) -from gooddata_api_client.model.declarative_analytics_layer import DeclarativeAnalyticsLayer -from gooddata_api_client.model.declarative_ldm import DeclarativeLdm +from gooddata_api_client.models.declarative_analytics_layer import DeclarativeAnalyticsLayer +from gooddata_api_client.models.declarative_ldm import DeclarativeLdm diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_permissions.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_permissions.py deleted file mode 100644 index b3da80166..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_permissions.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission - from gooddata_api_client.model.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission - globals()['DeclarativeSingleWorkspacePermission'] = DeclarativeSingleWorkspacePermission - globals()['DeclarativeWorkspaceHierarchyPermission'] = DeclarativeWorkspaceHierarchyPermission - - -class DeclarativeWorkspacePermissions(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'hierarchy_permissions': ([DeclarativeWorkspaceHierarchyPermission],), # noqa: E501 - 'permissions': ([DeclarativeSingleWorkspacePermission],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'hierarchy_permissions': 'hierarchyPermissions', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspacePermissions - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - hierarchy_permissions ([DeclarativeWorkspaceHierarchyPermission]): [optional] # noqa: E501 - permissions ([DeclarativeSingleWorkspacePermission]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspacePermissions - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - hierarchy_permissions ([DeclarativeWorkspaceHierarchyPermission]): [optional] # noqa: E501 - permissions ([DeclarativeSingleWorkspacePermission]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_permissions.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_permissions.pyi index fe66af378..9fe444ebf 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_permissions.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_permissions.pyi @@ -37,21 +37,21 @@ class DeclarativeWorkspacePermissions( class MetaOapg: - + class properties: - - + + class hierarchyPermissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeWorkspaceHierarchyPermission']: return DeclarativeWorkspaceHierarchyPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeWorkspaceHierarchyPermission'], typing.List['DeclarativeWorkspaceHierarchyPermission']], @@ -62,22 +62,22 @@ class DeclarativeWorkspacePermissions( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeWorkspaceHierarchyPermission': return super().__getitem__(i) - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeSingleWorkspacePermission']: return DeclarativeSingleWorkspacePermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeSingleWorkspacePermission'], typing.List['DeclarativeSingleWorkspacePermission']], @@ -88,40 +88,40 @@ class DeclarativeWorkspacePermissions( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeSingleWorkspacePermission': return super().__getitem__(i) __annotations__ = { "hierarchyPermissions": hierarchyPermissions, "permissions": permissions, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["hierarchyPermissions"]) -> MetaOapg.properties.hierarchyPermissions: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["hierarchyPermissions", "permissions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["hierarchyPermissions"]) -> typing.Union[MetaOapg.properties.hierarchyPermissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["hierarchyPermissions", "permissions", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -140,5 +140,5 @@ class DeclarativeWorkspacePermissions( **kwargs, ) -from gooddata_api_client.model.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission -from gooddata_api_client.model.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission +from gooddata_api_client.models.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission +from gooddata_api_client.models.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspaces.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspaces.py deleted file mode 100644 index 2a01d2234..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspaces.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_workspace import DeclarativeWorkspace - from gooddata_api_client.model.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter - globals()['DeclarativeWorkspace'] = DeclarativeWorkspace - globals()['DeclarativeWorkspaceDataFilter'] = DeclarativeWorkspaceDataFilter - - -class DeclarativeWorkspaces(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'workspace_data_filters': ([DeclarativeWorkspaceDataFilter],), # noqa: E501 - 'workspaces': ([DeclarativeWorkspace],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'workspace_data_filters': 'workspaceDataFilters', # noqa: E501 - 'workspaces': 'workspaces', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, workspace_data_filters, workspaces, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaces - a model defined in OpenAPI - - Args: - workspace_data_filters ([DeclarativeWorkspaceDataFilter]): - workspaces ([DeclarativeWorkspace]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.workspace_data_filters = workspace_data_filters - self.workspaces = workspaces - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, workspace_data_filters, workspaces, *args, **kwargs): # noqa: E501 - """DeclarativeWorkspaces - a model defined in OpenAPI - - Args: - workspace_data_filters ([DeclarativeWorkspaceDataFilter]): - workspaces ([DeclarativeWorkspace]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.workspace_data_filters = workspace_data_filters - self.workspaces = workspaces - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspaces.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_workspaces.pyi index 6d5ad695d..ef2145592 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspaces.pyi +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspaces.pyi @@ -41,21 +41,21 @@ class DeclarativeWorkspaces( "workspaces", "workspaceDataFilters", } - + class properties: - - + + class workspaceDataFilters( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeWorkspaceDataFilter']: return DeclarativeWorkspaceDataFilter - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeWorkspaceDataFilter'], typing.List['DeclarativeWorkspaceDataFilter']], @@ -66,22 +66,22 @@ class DeclarativeWorkspaces( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeWorkspaceDataFilter': return super().__getitem__(i) - - + + class workspaces( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DeclarativeWorkspace']: return DeclarativeWorkspace - + def __new__( cls, _arg: typing.Union[typing.Tuple['DeclarativeWorkspace'], typing.List['DeclarativeWorkspace']], @@ -92,43 +92,43 @@ class DeclarativeWorkspaces( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DeclarativeWorkspace': return super().__getitem__(i) __annotations__ = { "workspaceDataFilters": workspaceDataFilters, "workspaces": workspaces, } - + workspaces: MetaOapg.properties.workspaces workspaceDataFilters: MetaOapg.properties.workspaceDataFilters - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["workspaceDataFilters"]) -> MetaOapg.properties.workspaceDataFilters: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["workspaces"]) -> MetaOapg.properties.workspaces: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["workspaceDataFilters", "workspaces", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["workspaceDataFilters"]) -> MetaOapg.properties.workspaceDataFilters: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["workspaces"]) -> MetaOapg.properties.workspaces: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["workspaceDataFilters", "workspaces", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -147,5 +147,5 @@ class DeclarativeWorkspaces( **kwargs, ) -from gooddata_api_client.model.declarative_workspace import DeclarativeWorkspace -from gooddata_api_client.model.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter +from gooddata_api_client.models.declarative_workspace import DeclarativeWorkspace +from gooddata_api_client.models.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter diff --git a/gooddata-api-client/gooddata_api_client/model/default_smtp.py b/gooddata-api-client/gooddata_api_client/model/default_smtp.py deleted file mode 100644 index 5d14c64aa..000000000 --- a/gooddata-api-client/gooddata_api_client/model/default_smtp.py +++ /dev/null @@ -1,333 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.default_smtp_all_of import DefaultSmtpAllOf - globals()['DefaultSmtpAllOf'] = DefaultSmtpAllOf - - -class DefaultSmtp(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DEFAULT_SMTP': "DEFAULT_SMTP", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'from_email': (str,), # noqa: E501 - 'from_email_name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'from_email': 'fromEmail', # noqa: E501 - 'from_email_name': 'fromEmailName', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DefaultSmtp - a model defined in OpenAPI - - Keyword Args: - type (str): The destination type.. defaults to "DEFAULT_SMTP", must be one of ["DEFAULT_SMTP", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - """ - - type = kwargs.get('type', "DEFAULT_SMTP") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DefaultSmtp - a model defined in OpenAPI - - Keyword Args: - type (str): The destination type.. defaults to "DEFAULT_SMTP", must be one of ["DEFAULT_SMTP", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - """ - - type = kwargs.get('type', "DEFAULT_SMTP") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - DefaultSmtpAllOf, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/default_smtp_all_of.py b/gooddata-api-client/gooddata_api_client/model/default_smtp_all_of.py deleted file mode 100644 index a9f19a906..000000000 --- a/gooddata-api-client/gooddata_api_client/model/default_smtp_all_of.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DefaultSmtpAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DEFAULT_SMTP': "DEFAULT_SMTP", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'from_email': (str,), # noqa: E501 - 'from_email_name': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'from_email': 'fromEmail', # noqa: E501 - 'from_email_name': 'fromEmailName', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DefaultSmtpAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "DEFAULT_SMTP" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DefaultSmtpAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "DEFAULT_SMTP" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dependent_entities_graph.py b/gooddata-api-client/gooddata_api_client/model/dependent_entities_graph.py deleted file mode 100644 index 8041b1c31..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dependent_entities_graph.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dependent_entities_node import DependentEntitiesNode - from gooddata_api_client.model.entity_identifier import EntityIdentifier - globals()['DependentEntitiesNode'] = DependentEntitiesNode - globals()['EntityIdentifier'] = EntityIdentifier - - -class DependentEntitiesGraph(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('edges',): { - }, - ('nodes',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'edges': ([[EntityIdentifier]],), # noqa: E501 - 'nodes': ([DependentEntitiesNode],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'edges': 'edges', # noqa: E501 - 'nodes': 'nodes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, edges, nodes, *args, **kwargs): # noqa: E501 - """DependentEntitiesGraph - a model defined in OpenAPI - - Args: - edges ([[EntityIdentifier]]): - nodes ([DependentEntitiesNode]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.edges = edges - self.nodes = nodes - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, edges, nodes, *args, **kwargs): # noqa: E501 - """DependentEntitiesGraph - a model defined in OpenAPI - - Args: - edges ([[EntityIdentifier]]): - nodes ([DependentEntitiesNode]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.edges = edges - self.nodes = nodes - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dependent_entities_graph.pyi b/gooddata-api-client/gooddata_api_client/model/dependent_entities_graph.pyi index 9ef60ce16..bca8c1114 100644 --- a/gooddata-api-client/gooddata_api_client/model/dependent_entities_graph.pyi +++ b/gooddata-api-client/gooddata_api_client/model/dependent_entities_graph.pyi @@ -39,29 +39,29 @@ class DependentEntitiesGraph( "nodes", "edges", } - + class properties: - - + + class edges( schemas.ListSchema ): - - + + class MetaOapg: - - + + class items( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['EntityIdentifier']: return EntityIdentifier - + def __new__( cls, _arg: typing.Union[typing.Tuple['EntityIdentifier'], typing.List['EntityIdentifier']], @@ -72,10 +72,10 @@ class DependentEntitiesGraph( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'EntityIdentifier': return super().__getitem__(i) - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, list, tuple, ]], typing.List[typing.Union[MetaOapg.items, list, tuple, ]]], @@ -86,22 +86,22 @@ class DependentEntitiesGraph( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class nodes( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DependentEntitiesNode']: return DependentEntitiesNode - + def __new__( cls, _arg: typing.Union[typing.Tuple['DependentEntitiesNode'], typing.List['DependentEntitiesNode']], @@ -112,43 +112,43 @@ class DependentEntitiesGraph( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DependentEntitiesNode': return super().__getitem__(i) __annotations__ = { "edges": edges, "nodes": nodes, } - + nodes: MetaOapg.properties.nodes edges: MetaOapg.properties.edges - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["edges"]) -> MetaOapg.properties.edges: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["nodes"]) -> MetaOapg.properties.nodes: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["edges", "nodes", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["edges"]) -> MetaOapg.properties.edges: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["nodes"]) -> MetaOapg.properties.nodes: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["edges", "nodes", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -167,5 +167,5 @@ class DependentEntitiesGraph( **kwargs, ) -from gooddata_api_client.model.dependent_entities_node import DependentEntitiesNode -from gooddata_api_client.model.entity_identifier import EntityIdentifier +from gooddata_api_client.models.dependent_entities_node import DependentEntitiesNode +from gooddata_api_client.models.entity_identifier import EntityIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/dependent_entities_node.py b/gooddata-api-client/gooddata_api_client/model/dependent_entities_node.py deleted file mode 100644 index 90eee8acd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dependent_entities_node.py +++ /dev/null @@ -1,295 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DependentEntitiesNode(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - 'ATTRIBUTE': "attribute", - 'ATTRIBUTEHIERARCHY': "attributeHierarchy", - 'DASHBOARDPLUGIN': "dashboardPlugin", - 'DATASET': "dataset", - 'FACT': "fact", - 'LABEL': "label", - 'METRIC': "metric", - 'USERDATAFILTER': "userDataFilter", - 'AUTOMATION': "automation", - 'VISUALIZATIONOBJECT': "visualizationObject", - 'FILTERCONTEXT': "filterContext", - 'FILTERVIEW': "filterView", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """DependentEntitiesNode - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """DependentEntitiesNode - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dependent_entities_request.py b/gooddata-api-client/gooddata_api_client/model/dependent_entities_request.py deleted file mode 100644 index 38c1583db..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dependent_entities_request.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.entity_identifier import EntityIdentifier - globals()['EntityIdentifier'] = EntityIdentifier - - -class DependentEntitiesRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'identifiers': ([EntityIdentifier],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'identifiers': 'identifiers', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, identifiers, *args, **kwargs): # noqa: E501 - """DependentEntitiesRequest - a model defined in OpenAPI - - Args: - identifiers ([EntityIdentifier]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifiers = identifiers - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, identifiers, *args, **kwargs): # noqa: E501 - """DependentEntitiesRequest - a model defined in OpenAPI - - Args: - identifiers ([EntityIdentifier]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifiers = identifiers - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dependent_entities_request.pyi b/gooddata-api-client/gooddata_api_client/model/dependent_entities_request.pyi index 293becea8..8446c04c4 100644 --- a/gooddata-api-client/gooddata_api_client/model/dependent_entities_request.pyi +++ b/gooddata-api-client/gooddata_api_client/model/dependent_entities_request.pyi @@ -38,21 +38,21 @@ class DependentEntitiesRequest( required = { "identifiers", } - + class properties: - - + + class identifiers( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['EntityIdentifier']: return EntityIdentifier - + def __new__( cls, _arg: typing.Union[typing.Tuple['EntityIdentifier'], typing.List['EntityIdentifier']], @@ -63,35 +63,35 @@ class DependentEntitiesRequest( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'EntityIdentifier': return super().__getitem__(i) __annotations__ = { "identifiers": identifiers, } - + identifiers: MetaOapg.properties.identifiers - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["identifiers"]) -> MetaOapg.properties.identifiers: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["identifiers", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["identifiers"]) -> MetaOapg.properties.identifiers: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["identifiers", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -108,4 +108,4 @@ class DependentEntitiesRequest( **kwargs, ) -from gooddata_api_client.model.entity_identifier import EntityIdentifier +from gooddata_api_client.models.entity_identifier import EntityIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/dependent_entities_response.py b/gooddata-api-client/gooddata_api_client/model/dependent_entities_response.py deleted file mode 100644 index 66ab425bd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dependent_entities_response.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dependent_entities_graph import DependentEntitiesGraph - globals()['DependentEntitiesGraph'] = DependentEntitiesGraph - - -class DependentEntitiesResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'graph': (DependentEntitiesGraph,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'graph': 'graph', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, graph, *args, **kwargs): # noqa: E501 - """DependentEntitiesResponse - a model defined in OpenAPI - - Args: - graph (DependentEntitiesGraph): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.graph = graph - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, graph, *args, **kwargs): # noqa: E501 - """DependentEntitiesResponse - a model defined in OpenAPI - - Args: - graph (DependentEntitiesGraph): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.graph = graph - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dependent_entities_response.pyi b/gooddata-api-client/gooddata_api_client/model/dependent_entities_response.pyi index 9016d8c3e..8b2b61440 100644 --- a/gooddata-api-client/gooddata_api_client/model/dependent_entities_response.pyi +++ b/gooddata-api-client/gooddata_api_client/model/dependent_entities_response.pyi @@ -38,38 +38,38 @@ class DependentEntitiesResponse( required = { "graph", } - + class properties: - + @staticmethod def graph() -> typing.Type['DependentEntitiesGraph']: return DependentEntitiesGraph __annotations__ = { "graph": graph, } - + graph: 'DependentEntitiesGraph' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["graph"]) -> 'DependentEntitiesGraph': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["graph", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["graph"]) -> 'DependentEntitiesGraph': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["graph", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class DependentEntitiesResponse( **kwargs, ) -from gooddata_api_client.model.dependent_entities_graph import DependentEntitiesGraph +from gooddata_api_client.models.dependent_entities_graph import DependentEntitiesGraph diff --git a/gooddata-api-client/gooddata_api_client/model/depends_on.py b/gooddata-api-client/gooddata_api_client/model/depends_on.py deleted file mode 100644 index 594528e43..000000000 --- a/gooddata-api-client/gooddata_api_client/model/depends_on.py +++ /dev/null @@ -1,331 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.depends_on_all_of import DependsOnAllOf - from gooddata_api_client.model.depends_on_item import DependsOnItem - globals()['DependsOnAllOf'] = DependsOnAllOf - globals()['DependsOnItem'] = DependsOnItem - - -class DependsOn(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'label': (str,), # noqa: E501 - 'values': ([str, none_type],), # noqa: E501 - 'complement_filter': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'label': 'label', # noqa: E501 - 'values': 'values', # noqa: E501 - 'complement_filter': 'complementFilter', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DependsOn - a model defined in OpenAPI - - Keyword Args: - label (str): Specifies on which label the filter depends on. - values ([str, none_type]): Specifies values of the label for element filtering. - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DependsOn - a model defined in OpenAPI - - Keyword Args: - label (str): Specifies on which label the filter depends on. - values ([str, none_type]): Specifies values of the label for element filtering. - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - DependsOnAllOf, - DependsOnItem, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/depends_on_all_of.py b/gooddata-api-client/gooddata_api_client/model/depends_on_all_of.py deleted file mode 100644 index 664601750..000000000 --- a/gooddata-api-client/gooddata_api_client/model/depends_on_all_of.py +++ /dev/null @@ -1,272 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DependsOnAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'complement_filter': (bool,), # noqa: E501 - 'label': (str,), # noqa: E501 - 'values': ([str, none_type],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'complement_filter': 'complementFilter', # noqa: E501 - 'label': 'label', # noqa: E501 - 'values': 'values', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DependsOnAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 - label (str): Specifies on which label the filter depends on.. [optional] # noqa: E501 - values ([str, none_type]): Specifies values of the label for element filtering.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DependsOnAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 - label (str): Specifies on which label the filter depends on.. [optional] # noqa: E501 - values ([str, none_type]): Specifies values of the label for element filtering.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/depends_on_date_filter.py b/gooddata-api-client/gooddata_api_client/model/depends_on_date_filter.py deleted file mode 100644 index 0737c5677..000000000 --- a/gooddata-api-client/gooddata_api_client/model/depends_on_date_filter.py +++ /dev/null @@ -1,325 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.date_filter import DateFilter - from gooddata_api_client.model.depends_on_date_filter_all_of import DependsOnDateFilterAllOf - from gooddata_api_client.model.depends_on_item import DependsOnItem - globals()['DateFilter'] = DateFilter - globals()['DependsOnDateFilterAllOf'] = DependsOnDateFilterAllOf - globals()['DependsOnItem'] = DependsOnItem - - -class DependsOnDateFilter(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'date_filter': (DateFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'date_filter': 'dateFilter', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DependsOnDateFilter - a model defined in OpenAPI - - Keyword Args: - date_filter (DateFilter): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DependsOnDateFilter - a model defined in OpenAPI - - Keyword Args: - date_filter (DateFilter): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - DependsOnDateFilterAllOf, - DependsOnItem, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/depends_on_date_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/depends_on_date_filter_all_of.py deleted file mode 100644 index 32dc5dc2d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/depends_on_date_filter_all_of.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.date_filter import DateFilter - globals()['DateFilter'] = DateFilter - - -class DependsOnDateFilterAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'date_filter': (DateFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'date_filter': 'dateFilter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DependsOnDateFilterAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - date_filter (DateFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DependsOnDateFilterAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - date_filter (DateFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/depends_on_item.py b/gooddata-api-client/gooddata_api_client/model/depends_on_item.py deleted file mode 100644 index 30029a608..000000000 --- a/gooddata-api-client/gooddata_api_client/model/depends_on_item.py +++ /dev/null @@ -1,260 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DependsOnItem(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DependsOnItem - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DependsOnItem - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dim_attribute.py b/gooddata-api-client/gooddata_api_client/model/dim_attribute.py deleted file mode 100644 index f64d90fa1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dim_attribute.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DimAttribute(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTE': "attribute", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 - """DimAttribute - a model defined in OpenAPI - - Args: - id (str): ID of the object - title (str): Title of attribute. - - Keyword Args: - type (str): Object type. defaults to "attribute", must be one of ["attribute", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "attribute") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, title, *args, **kwargs): # noqa: E501 - """DimAttribute - a model defined in OpenAPI - - Args: - id (str): ID of the object - title (str): Title of attribute. - - Keyword Args: - type (str): Object type. defaults to "attribute", must be one of ["attribute", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "attribute") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dimension.py b/gooddata-api-client/gooddata_api_client/model/dimension.py deleted file mode 100644 index e5d7dde9a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dimension.py +++ /dev/null @@ -1,289 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.sort_key import SortKey - globals()['SortKey'] = SortKey - - -class Dimension(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('local_identifier',): { - 'regex': { - 'pattern': r'^[.a-zA-Z0-9_-]+$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'item_identifiers': ([str],), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - 'sorting': ([SortKey],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'item_identifiers': 'itemIdentifiers', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - 'sorting': 'sorting', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, item_identifiers, *args, **kwargs): # noqa: E501 - """Dimension - a model defined in OpenAPI - - Args: - item_identifiers ([str]): List of items in current dimension. Can reference 'localIdentifier' from 'AttributeItem', or special pseudo attribute \"measureGroup\" representing list of metrics. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - local_identifier (str): Dimension identification within requests. Other entities can reference this dimension by this value.. [optional] # noqa: E501 - sorting ([SortKey]): List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal).. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.item_identifiers = item_identifiers - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, item_identifiers, *args, **kwargs): # noqa: E501 - """Dimension - a model defined in OpenAPI - - Args: - item_identifiers ([str]): List of items in current dimension. Can reference 'localIdentifier' from 'AttributeItem', or special pseudo attribute \"measureGroup\" representing list of metrics. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - local_identifier (str): Dimension identification within requests. Other entities can reference this dimension by this value.. [optional] # noqa: E501 - sorting ([SortKey]): List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal).. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.item_identifiers = item_identifiers - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dimension.pyi b/gooddata-api-client/gooddata_api_client/model/dimension.pyi index 545e795e8..5ae1e25c7 100644 --- a/gooddata-api-client/gooddata_api_client/model/dimension.pyi +++ b/gooddata-api-client/gooddata_api_client/model/dimension.pyi @@ -40,18 +40,18 @@ class Dimension( required = { "itemIdentifiers", } - + class properties: - - + + class itemIdentifiers( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -62,28 +62,28 @@ class Dimension( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class localIdentifier( schemas.StrSchema ): pass - - + + class sorting( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['SortKey']: return SortKey - + def __new__( cls, _arg: typing.Union[typing.Tuple['SortKey'], typing.List['SortKey']], @@ -94,7 +94,7 @@ class Dimension( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'SortKey': return super().__getitem__(i) __annotations__ = { @@ -102,41 +102,41 @@ class Dimension( "localIdentifier": localIdentifier, "sorting": sorting, } - + itemIdentifiers: MetaOapg.properties.itemIdentifiers - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["itemIdentifiers"]) -> MetaOapg.properties.itemIdentifiers: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sorting"]) -> MetaOapg.properties.sorting: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["itemIdentifiers", "localIdentifier", "sorting", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["itemIdentifiers"]) -> MetaOapg.properties.itemIdentifiers: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> typing.Union[MetaOapg.properties.localIdentifier, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sorting"]) -> typing.Union[MetaOapg.properties.sorting, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["itemIdentifiers", "localIdentifier", "sorting", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -157,4 +157,4 @@ class Dimension( **kwargs, ) -from gooddata_api_client.model.sort_key import SortKey +from gooddata_api_client.models.sort_key import SortKey diff --git a/gooddata-api-client/gooddata_api_client/model/dimension_header.py b/gooddata-api-client/gooddata_api_client/model/dimension_header.py deleted file mode 100644 index 03ff40577..000000000 --- a/gooddata-api-client/gooddata_api_client/model/dimension_header.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.header_group import HeaderGroup - globals()['HeaderGroup'] = HeaderGroup - - -class DimensionHeader(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'header_groups': ([HeaderGroup],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'header_groups': 'headerGroups', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, header_groups, *args, **kwargs): # noqa: E501 - """DimensionHeader - a model defined in OpenAPI - - Args: - header_groups ([HeaderGroup]): An array containing header groups. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.header_groups = header_groups - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, header_groups, *args, **kwargs): # noqa: E501 - """DimensionHeader - a model defined in OpenAPI - - Args: - header_groups ([HeaderGroup]): An array containing header groups. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.header_groups = header_groups - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dimension_header.pyi b/gooddata-api-client/gooddata_api_client/model/dimension_header.pyi index f92cf39dd..098ff6cc0 100644 --- a/gooddata-api-client/gooddata_api_client/model/dimension_header.pyi +++ b/gooddata-api-client/gooddata_api_client/model/dimension_header.pyi @@ -40,21 +40,21 @@ class DimensionHeader( required = { "headerGroups", } - + class properties: - - + + class headerGroups( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['HeaderGroup']: return HeaderGroup - + def __new__( cls, _arg: typing.Union[typing.Tuple['HeaderGroup'], typing.List['HeaderGroup']], @@ -65,35 +65,35 @@ class DimensionHeader( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'HeaderGroup': return super().__getitem__(i) __annotations__ = { "headerGroups": headerGroups, } - + headerGroups: MetaOapg.properties.headerGroups - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["headerGroups"]) -> MetaOapg.properties.headerGroups: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["headerGroups", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["headerGroups"]) -> MetaOapg.properties.headerGroups: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["headerGroups", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -110,4 +110,4 @@ class DimensionHeader( **kwargs, ) -from gooddata_api_client.model.header_group import HeaderGroup +from gooddata_api_client.models.header_group import HeaderGroup diff --git a/gooddata-api-client/gooddata_api_client/model/element.py b/gooddata-api-client/gooddata_api_client/model/element.py deleted file mode 100644 index 89e8bd892..000000000 --- a/gooddata-api-client/gooddata_api_client/model/element.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class Element(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'primary_title': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'primary_title': 'primaryTitle', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, primary_title, title, *args, **kwargs): # noqa: E501 - """Element - a model defined in OpenAPI - - Args: - primary_title (str): Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded - title (str): Title of requested label. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.primary_title = primary_title - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, primary_title, title, *args, **kwargs): # noqa: E501 - """Element - a model defined in OpenAPI - - Args: - primary_title (str): Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded - title (str): Title of requested label. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.primary_title = primary_title - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/elements_request.py b/gooddata-api-client/gooddata_api_client/model/elements_request.py deleted file mode 100644 index 23ce93f91..000000000 --- a/gooddata-api-client/gooddata_api_client/model/elements_request.py +++ /dev/null @@ -1,329 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.elements_request_depends_on_inner import ElementsRequestDependsOnInner - from gooddata_api_client.model.filter_by import FilterBy - from gooddata_api_client.model.validate_by_item import ValidateByItem - globals()['ElementsRequestDependsOnInner'] = ElementsRequestDependsOnInner - globals()['FilterBy'] = FilterBy - globals()['ValidateByItem'] = ValidateByItem - - -class ElementsRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('sort_order',): { - 'ASC': "ASC", - 'DESC': "DESC", - }, - } - - validations = { - ('label',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'label': (str,), # noqa: E501 - 'cache_id': (str,), # noqa: E501 - 'complement_filter': (bool,), # noqa: E501 - 'data_sampling_percentage': (float,), # noqa: E501 - 'depends_on': ([ElementsRequestDependsOnInner],), # noqa: E501 - 'exact_filter': ([str, none_type],), # noqa: E501 - 'exclude_primary_label': (bool,), # noqa: E501 - 'filter_by': (FilterBy,), # noqa: E501 - 'pattern_filter': (str,), # noqa: E501 - 'sort_order': (str,), # noqa: E501 - 'validate_by': ([ValidateByItem],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'label': 'label', # noqa: E501 - 'cache_id': 'cacheId', # noqa: E501 - 'complement_filter': 'complementFilter', # noqa: E501 - 'data_sampling_percentage': 'dataSamplingPercentage', # noqa: E501 - 'depends_on': 'dependsOn', # noqa: E501 - 'exact_filter': 'exactFilter', # noqa: E501 - 'exclude_primary_label': 'excludePrimaryLabel', # noqa: E501 - 'filter_by': 'filterBy', # noqa: E501 - 'pattern_filter': 'patternFilter', # noqa: E501 - 'sort_order': 'sortOrder', # noqa: E501 - 'validate_by': 'validateBy', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, label, *args, **kwargs): # noqa: E501 - """ElementsRequest - a model defined in OpenAPI - - Args: - label (str): Requested label. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_id (str): If specified, the element data will be taken from the result with the same cacheId if it is available.. [optional] # noqa: E501 - complement_filter (bool): Inverse filters: * ```false``` - return items matching ```patternFilter``` and ```exactFilter``` * ```true``` - return items not matching ```patternFilter``` and ```exactFilter```. [optional] if omitted the server will use the default value of False # noqa: E501 - data_sampling_percentage (float): Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.. [optional] if omitted the server will use the default value of 100.0 # noqa: E501 - depends_on ([ElementsRequestDependsOnInner]): Return only items that are not filtered-out by the parent filters.. [optional] # noqa: E501 - exact_filter ([str, none_type]): Return only items, whose ```label``` title exactly matches one of ```filter```.. [optional] # noqa: E501 - exclude_primary_label (bool): Excludes items from the result that differ only by primary label * ```false``` - return items with distinct primary label * ```true``` - return items with distinct requested label. [optional] if omitted the server will use the default value of False # noqa: E501 - filter_by (FilterBy): [optional] # noqa: E501 - pattern_filter (str): Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.. [optional] # noqa: E501 - sort_order (str): Sort order of returned items. Items are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default. [optional] # noqa: E501 - validate_by ([ValidateByItem]): Return only items that are computable on metric.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.label = label - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, label, *args, **kwargs): # noqa: E501 - """ElementsRequest - a model defined in OpenAPI - - Args: - label (str): Requested label. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_id (str): If specified, the element data will be taken from the result with the same cacheId if it is available.. [optional] # noqa: E501 - complement_filter (bool): Inverse filters: * ```false``` - return items matching ```patternFilter``` and ```exactFilter``` * ```true``` - return items not matching ```patternFilter``` and ```exactFilter```. [optional] if omitted the server will use the default value of False # noqa: E501 - data_sampling_percentage (float): Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.. [optional] if omitted the server will use the default value of 100.0 # noqa: E501 - depends_on ([ElementsRequestDependsOnInner]): Return only items that are not filtered-out by the parent filters.. [optional] # noqa: E501 - exact_filter ([str, none_type]): Return only items, whose ```label``` title exactly matches one of ```filter```.. [optional] # noqa: E501 - exclude_primary_label (bool): Excludes items from the result that differ only by primary label * ```false``` - return items with distinct primary label * ```true``` - return items with distinct requested label. [optional] if omitted the server will use the default value of False # noqa: E501 - filter_by (FilterBy): [optional] # noqa: E501 - pattern_filter (str): Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.. [optional] # noqa: E501 - sort_order (str): Sort order of returned items. Items are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default. [optional] # noqa: E501 - validate_by ([ValidateByItem]): Return only items that are computable on metric.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.label = label - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/elements_request.pyi b/gooddata-api-client/gooddata_api_client/model/elements_request.pyi index a49fdbe50..c842e7ae9 100644 --- a/gooddata-api-client/gooddata_api_client/model/elements_request.pyi +++ b/gooddata-api-client/gooddata_api_client/model/elements_request.pyi @@ -38,26 +38,26 @@ class ElementsRequest( required = { "label", } - + class properties: - - + + class label( schemas.StrSchema ): pass complementFilter = schemas.BoolSchema dataSamplingPercentage = schemas.Float32Schema - - + + class exactFilter( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -68,26 +68,26 @@ class ElementsRequest( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) excludePrimaryLabel = schemas.BoolSchema - + @staticmethod def filterBy() -> typing.Type['FilterBy']: return FilterBy patternFilter = schemas.StrSchema - - + + class sortOrder( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ASC(cls): return cls("ASC") - + @schemas.classproperty def DESC(cls): return cls("DESC") @@ -101,71 +101,71 @@ class ElementsRequest( "patternFilter": patternFilter, "sortOrder": sortOrder, } - + label: MetaOapg.properties.label - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["label"]) -> MetaOapg.properties.label: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["complementFilter"]) -> MetaOapg.properties.complementFilter: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataSamplingPercentage"]) -> MetaOapg.properties.dataSamplingPercentage: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["exactFilter"]) -> MetaOapg.properties.exactFilter: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["excludePrimaryLabel"]) -> MetaOapg.properties.excludePrimaryLabel: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["filterBy"]) -> 'FilterBy': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["patternFilter"]) -> MetaOapg.properties.patternFilter: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sortOrder"]) -> MetaOapg.properties.sortOrder: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["label", "complementFilter", "dataSamplingPercentage", "exactFilter", "excludePrimaryLabel", "filterBy", "patternFilter", "sortOrder", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["label"]) -> MetaOapg.properties.label: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["complementFilter"]) -> typing.Union[MetaOapg.properties.complementFilter, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataSamplingPercentage"]) -> typing.Union[MetaOapg.properties.dataSamplingPercentage, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["exactFilter"]) -> typing.Union[MetaOapg.properties.exactFilter, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["excludePrimaryLabel"]) -> typing.Union[MetaOapg.properties.excludePrimaryLabel, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["filterBy"]) -> typing.Union['FilterBy', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["patternFilter"]) -> typing.Union[MetaOapg.properties.patternFilter, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sortOrder"]) -> typing.Union[MetaOapg.properties.sortOrder, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["label", "complementFilter", "dataSamplingPercentage", "exactFilter", "excludePrimaryLabel", "filterBy", "patternFilter", "sortOrder", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -196,4 +196,4 @@ class ElementsRequest( **kwargs, ) -from gooddata_api_client.model.filter_by import FilterBy +from gooddata_api_client.models.filter_by import FilterBy diff --git a/gooddata-api-client/gooddata_api_client/model/elements_request_depends_on_inner.py b/gooddata-api-client/gooddata_api_client/model/elements_request_depends_on_inner.py deleted file mode 100644 index cf1bc2822..000000000 --- a/gooddata-api-client/gooddata_api_client/model/elements_request_depends_on_inner.py +++ /dev/null @@ -1,337 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.date_filter import DateFilter - from gooddata_api_client.model.depends_on import DependsOn - from gooddata_api_client.model.depends_on_date_filter import DependsOnDateFilter - globals()['DateFilter'] = DateFilter - globals()['DependsOn'] = DependsOn - globals()['DependsOnDateFilter'] = DependsOnDateFilter - - -class ElementsRequestDependsOnInner(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'complement_filter': (bool,), # noqa: E501 - 'label': (str,), # noqa: E501 - 'values': ([str, none_type],), # noqa: E501 - 'date_filter': (DateFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'complement_filter': 'complementFilter', # noqa: E501 - 'label': 'label', # noqa: E501 - 'values': 'values', # noqa: E501 - 'date_filter': 'dateFilter', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ElementsRequestDependsOnInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 - label (str): Specifies on which label the filter depends on.. [optional] # noqa: E501 - values ([str, none_type]): Specifies values of the label for element filtering.. [optional] # noqa: E501 - date_filter (DateFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ElementsRequestDependsOnInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 - label (str): Specifies on which label the filter depends on.. [optional] # noqa: E501 - values ([str, none_type]): Specifies values of the label for element filtering.. [optional] # noqa: E501 - date_filter (DateFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - DependsOn, - DependsOnDateFilter, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/elements_response.py b/gooddata-api-client/gooddata_api_client/model/elements_response.py deleted file mode 100644 index 6e320e716..000000000 --- a/gooddata-api-client/gooddata_api_client/model/elements_response.py +++ /dev/null @@ -1,324 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_format import AttributeFormat - from gooddata_api_client.model.element import Element - from gooddata_api_client.model.paging import Paging - from gooddata_api_client.model.rest_api_identifier import RestApiIdentifier - globals()['AttributeFormat'] = AttributeFormat - globals()['Element'] = Element - globals()['Paging'] = Paging - globals()['RestApiIdentifier'] = RestApiIdentifier - - -class ElementsResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularity',): { - 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", - 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", - 'HOUR_OF_DAY': "HOUR_OF_DAY", - 'DAY_OF_WEEK': "DAY_OF_WEEK", - 'DAY_OF_MONTH': "DAY_OF_MONTH", - 'DAY_OF_QUARTER': "DAY_OF_QUARTER", - 'DAY_OF_YEAR': "DAY_OF_YEAR", - 'WEEK_OF_YEAR': "WEEK_OF_YEAR", - 'MONTH_OF_YEAR': "MONTH_OF_YEAR", - 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'elements': ([Element],), # noqa: E501 - 'paging': (Paging,), # noqa: E501 - 'primary_label': (RestApiIdentifier,), # noqa: E501 - 'cache_id': (str,), # noqa: E501 - 'format': (AttributeFormat,), # noqa: E501 - 'granularity': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'elements': 'elements', # noqa: E501 - 'paging': 'paging', # noqa: E501 - 'primary_label': 'primaryLabel', # noqa: E501 - 'cache_id': 'cacheId', # noqa: E501 - 'format': 'format', # noqa: E501 - 'granularity': 'granularity', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, elements, paging, primary_label, *args, **kwargs): # noqa: E501 - """ElementsResponse - a model defined in OpenAPI - - Args: - elements ([Element]): List of returned elements. - paging (Paging): - primary_label (RestApiIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_id (str): The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.. [optional] # noqa: E501 - format (AttributeFormat): [optional] # noqa: E501 - granularity (str): Granularity of requested label in case of date attribute. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.elements = elements - self.paging = paging - self.primary_label = primary_label - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, elements, paging, primary_label, *args, **kwargs): # noqa: E501 - """ElementsResponse - a model defined in OpenAPI - - Args: - elements ([Element]): List of returned elements. - paging (Paging): - primary_label (RestApiIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_id (str): The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.. [optional] # noqa: E501 - format (AttributeFormat): [optional] # noqa: E501 - granularity (str): Granularity of requested label in case of date attribute. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.elements = elements - self.paging = paging - self.primary_label = primary_label - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/elements_response.pyi b/gooddata-api-client/gooddata_api_client/model/elements_response.pyi index 0608feada..b516b43f0 100644 --- a/gooddata-api-client/gooddata_api_client/model/elements_response.pyi +++ b/gooddata-api-client/gooddata_api_client/model/elements_response.pyi @@ -228,7 +228,7 @@ class ElementsResponse( **kwargs, ) -from gooddata_api_client.model.attribute_format import AttributeFormat -from gooddata_api_client.model.element import Element -from gooddata_api_client.model.paging import Paging -from gooddata_api_client.model.rest_api_identifier import RestApiIdentifier +from gooddata_api_client.models.attribute_format import AttributeFormat +from gooddata_api_client.models.element import Element +from gooddata_api_client.models.paging import Paging +from gooddata_api_client.models.rest_api_identifier import RestApiIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/entitlements_request.py b/gooddata-api-client/gooddata_api_client/model/entitlements_request.py deleted file mode 100644 index 66625f74f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/entitlements_request.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class EntitlementsRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('entitlements_name',): { - 'CACHESTRATEGY': "CacheStrategy", - 'CONTRACT': "Contract", - 'CUSTOMTHEMING': "CustomTheming", - 'EXTRACACHE': "ExtraCache", - 'HIPAA': "Hipaa", - 'PDFEXPORTS': "PdfExports", - 'MANAGEDOIDC': "ManagedOIDC", - 'UILOCALIZATION': "UiLocalization", - 'TIER': "Tier", - 'USERCOUNT': "UserCount", - 'MANAGEDIDPUSERCOUNT': "ManagedIdpUserCount", - 'UNLIMITEDUSERS': "UnlimitedUsers", - 'UNLIMITEDWORKSPACES': "UnlimitedWorkspaces", - 'WHITELABELING': "WhiteLabeling", - 'WORKSPACECOUNT': "WorkspaceCount", - 'USERTELEMETRYDISABLED': "UserTelemetryDisabled", - 'AUTOMATIONCOUNT': "AutomationCount", - 'UNLIMITEDAUTOMATIONS': "UnlimitedAutomations", - 'AUTOMATIONRECIPIENTCOUNT': "AutomationRecipientCount", - 'UNLIMITEDAUTOMATIONRECIPIENTS': "UnlimitedAutomationRecipients", - 'DAILYSCHEDULEDACTIONCOUNT': "DailyScheduledActionCount", - 'UNLIMITEDDAILYSCHEDULEDACTIONS': "UnlimitedDailyScheduledActions", - 'DAILYALERTACTIONCOUNT': "DailyAlertActionCount", - 'UNLIMITEDDAILYALERTACTIONS': "UnlimitedDailyAlertActions", - 'SCHEDULEDACTIONMINIMUMRECURRENCEMINUTES': "ScheduledActionMinimumRecurrenceMinutes", - 'FEDERATEDIDENTITYMANAGEMENT': "FederatedIdentityManagement", - 'AUDITLOGGING': "AuditLogging", - 'CONTROLLEDFEATUREROLLOUT': "ControlledFeatureRollout", - }, - } - - validations = { - ('entitlements_name',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'entitlements_name': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'entitlements_name': 'entitlementsName', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, entitlements_name, *args, **kwargs): # noqa: E501 - """EntitlementsRequest - a model defined in OpenAPI - - Args: - entitlements_name ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.entitlements_name = entitlements_name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, entitlements_name, *args, **kwargs): # noqa: E501 - """EntitlementsRequest - a model defined in OpenAPI - - Args: - entitlements_name ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.entitlements_name = entitlements_name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/entity_identifier.py b/gooddata-api-client/gooddata_api_client/model/entity_identifier.py deleted file mode 100644 index 521b945db..000000000 --- a/gooddata-api-client/gooddata_api_client/model/entity_identifier.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class EntityIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - 'ATTRIBUTE': "attribute", - 'ATTRIBUTEHIERARCHY': "attributeHierarchy", - 'DASHBOARDPLUGIN': "dashboardPlugin", - 'DATASET': "dataset", - 'FACT': "fact", - 'LABEL': "label", - 'METRIC': "metric", - 'USERDATAFILTER': "userDataFilter", - 'AUTOMATION': "automation", - 'VISUALIZATIONOBJECT': "visualizationObject", - 'FILTERCONTEXT': "filterContext", - 'FILTERVIEW': "filterView", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """EntityIdentifier - a model defined in OpenAPI - - Args: - id (str): Object identifier. - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """EntityIdentifier - a model defined in OpenAPI - - Args: - id (str): Object identifier. - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/execution_links.py b/gooddata-api-client/gooddata_api_client/model/execution_links.py deleted file mode 100644 index 7eeeed7e1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/execution_links.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ExecutionLinks(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'execution_result': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'execution_result': 'executionResult', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, execution_result, *args, **kwargs): # noqa: E501 - """ExecutionLinks - a model defined in OpenAPI - - Args: - execution_result (str): Link to the result data. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.execution_result = execution_result - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, execution_result, *args, **kwargs): # noqa: E501 - """ExecutionLinks - a model defined in OpenAPI - - Args: - execution_result (str): Link to the result data. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.execution_result = execution_result - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/execution_response.py b/gooddata-api-client/gooddata_api_client/model/execution_response.py deleted file mode 100644 index 15bda8582..000000000 --- a/gooddata-api-client/gooddata_api_client/model/execution_response.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.execution_links import ExecutionLinks - from gooddata_api_client.model.result_dimension import ResultDimension - globals()['ExecutionLinks'] = ExecutionLinks - globals()['ResultDimension'] = ResultDimension - - -class ExecutionResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dimensions': ([ResultDimension],), # noqa: E501 - 'links': (ExecutionLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dimensions': 'dimensions', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dimensions, links, *args, **kwargs): # noqa: E501 - """ExecutionResponse - a model defined in OpenAPI - - Args: - dimensions ([ResultDimension]): Dimensions of the result - links (ExecutionLinks): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dimensions = dimensions - self.links = links - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dimensions, links, *args, **kwargs): # noqa: E501 - """ExecutionResponse - a model defined in OpenAPI - - Args: - dimensions ([ResultDimension]): Dimensions of the result - links (ExecutionLinks): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dimensions = dimensions - self.links = links - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/execution_response.pyi b/gooddata-api-client/gooddata_api_client/model/execution_response.pyi index 1fa0b9b7b..f2694a176 100644 --- a/gooddata-api-client/gooddata_api_client/model/execution_response.pyi +++ b/gooddata-api-client/gooddata_api_client/model/execution_response.pyi @@ -123,5 +123,5 @@ class ExecutionResponse( **kwargs, ) -from gooddata_api_client.model.execution_links import ExecutionLinks -from gooddata_api_client.model.result_dimension import ResultDimension +from gooddata_api_client.models.execution_links import ExecutionLinks +from gooddata_api_client.models.result_dimension import ResultDimension diff --git a/gooddata-api-client/gooddata_api_client/model/execution_result.py b/gooddata-api-client/gooddata_api_client/model/execution_result.py deleted file mode 100644 index ebe9f1a59..000000000 --- a/gooddata-api-client/gooddata_api_client/model/execution_result.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dimension_header import DimensionHeader - from gooddata_api_client.model.execution_result_grand_total import ExecutionResultGrandTotal - from gooddata_api_client.model.execution_result_metadata import ExecutionResultMetadata - from gooddata_api_client.model.execution_result_paging import ExecutionResultPaging - globals()['DimensionHeader'] = DimensionHeader - globals()['ExecutionResultGrandTotal'] = ExecutionResultGrandTotal - globals()['ExecutionResultMetadata'] = ExecutionResultMetadata - globals()['ExecutionResultPaging'] = ExecutionResultPaging - - -class ExecutionResult(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 - 'dimension_headers': ([DimensionHeader],), # noqa: E501 - 'grand_totals': ([ExecutionResultGrandTotal],), # noqa: E501 - 'metadata': (ExecutionResultMetadata,), # noqa: E501 - 'paging': (ExecutionResultPaging,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'dimension_headers': 'dimensionHeaders', # noqa: E501 - 'grand_totals': 'grandTotals', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - 'paging': 'paging', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, dimension_headers, grand_totals, metadata, paging, *args, **kwargs): # noqa: E501 - """ExecutionResult - a model defined in OpenAPI - - Args: - data ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values. - dimension_headers ([DimensionHeader]): An array containing dimension headers. The size of the array corresponds to the number of dimensions. Their order corresponds to the dimension order in the execution result spec. - grand_totals ([ExecutionResultGrandTotal]): - metadata (ExecutionResultMetadata): - paging (ExecutionResultPaging): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - self.dimension_headers = dimension_headers - self.grand_totals = grand_totals - self.metadata = metadata - self.paging = paging - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, dimension_headers, grand_totals, metadata, paging, *args, **kwargs): # noqa: E501 - """ExecutionResult - a model defined in OpenAPI - - Args: - data ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values. - dimension_headers ([DimensionHeader]): An array containing dimension headers. The size of the array corresponds to the number of dimensions. Their order corresponds to the dimension order in the execution result spec. - grand_totals ([ExecutionResultGrandTotal]): - metadata (ExecutionResultMetadata): - paging (ExecutionResultPaging): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - self.dimension_headers = dimension_headers - self.grand_totals = grand_totals - self.metadata = metadata - self.paging = paging - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/execution_result.pyi b/gooddata-api-client/gooddata_api_client/model/execution_result.pyi index 7dcd2f698..b08367ec2 100644 --- a/gooddata-api-client/gooddata_api_client/model/execution_result.pyi +++ b/gooddata-api-client/gooddata_api_client/model/execution_result.pyi @@ -43,18 +43,18 @@ class ExecutionResult( "paging", "grandTotals", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.DictSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], @@ -65,22 +65,22 @@ class ExecutionResult( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class dimensionHeaders( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DimensionHeader']: return DimensionHeader - + def __new__( cls, _arg: typing.Union[typing.Tuple['DimensionHeader'], typing.List['DimensionHeader']], @@ -91,22 +91,22 @@ class ExecutionResult( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DimensionHeader': return super().__getitem__(i) - - + + class grandTotals( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['ExecutionResultGrandTotal']: return ExecutionResultGrandTotal - + def __new__( cls, _arg: typing.Union[typing.Tuple['ExecutionResultGrandTotal'], typing.List['ExecutionResultGrandTotal']], @@ -117,10 +117,10 @@ class ExecutionResult( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'ExecutionResultGrandTotal': return super().__getitem__(i) - + @staticmethod def paging() -> typing.Type['ExecutionResultPaging']: return ExecutionResultPaging @@ -130,50 +130,50 @@ class ExecutionResult( "grandTotals": grandTotals, "paging": paging, } - + data: MetaOapg.properties.data dimensionHeaders: MetaOapg.properties.dimensionHeaders paging: 'ExecutionResultPaging' grandTotals: MetaOapg.properties.grandTotals - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dimensionHeaders"]) -> MetaOapg.properties.dimensionHeaders: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["grandTotals"]) -> MetaOapg.properties.grandTotals: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["paging"]) -> 'ExecutionResultPaging': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "dimensionHeaders", "grandTotals", "paging", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dimensionHeaders"]) -> MetaOapg.properties.dimensionHeaders: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["grandTotals"]) -> MetaOapg.properties.grandTotals: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["paging"]) -> 'ExecutionResultPaging': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "dimensionHeaders", "grandTotals", "paging", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -196,6 +196,6 @@ class ExecutionResult( **kwargs, ) -from gooddata_api_client.model.dimension_header import DimensionHeader -from gooddata_api_client.model.execution_result_grand_total import ExecutionResultGrandTotal -from gooddata_api_client.model.execution_result_paging import ExecutionResultPaging +from gooddata_api_client.models.dimension_header import DimensionHeader +from gooddata_api_client.models.execution_result_grand_total import ExecutionResultGrandTotal +from gooddata_api_client.models.execution_result_paging import ExecutionResultPaging diff --git a/gooddata-api-client/gooddata_api_client/model/execution_result_data_source_message.py b/gooddata-api-client/gooddata_api_client/model/execution_result_data_source_message.py deleted file mode 100644 index 5e1f08885..000000000 --- a/gooddata-api-client/gooddata_api_client/model/execution_result_data_source_message.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ExecutionResultDataSourceMessage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'correlation_id': (str,), # noqa: E501 - 'source': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'data': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'correlation_id': 'correlationId', # noqa: E501 - 'source': 'source', # noqa: E501 - 'type': 'type', # noqa: E501 - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, correlation_id, source, type, *args, **kwargs): # noqa: E501 - """ExecutionResultDataSourceMessage - a model defined in OpenAPI - - Args: - correlation_id (str): Id correlating different pieces of supplementary info together. - source (str): Information about what part of the system created this piece of supplementary info. - type (str): Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.correlation_id = correlation_id - self.source = source - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, correlation_id, source, type, *args, **kwargs): # noqa: E501 - """ExecutionResultDataSourceMessage - a model defined in OpenAPI - - Args: - correlation_id (str): Id correlating different pieces of supplementary info together. - source (str): Information about what part of the system created this piece of supplementary info. - type (str): Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.correlation_id = correlation_id - self.source = source - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/execution_result_grand_total.py b/gooddata-api-client/gooddata_api_client/model/execution_result_grand_total.py deleted file mode 100644 index ce34b8774..000000000 --- a/gooddata-api-client/gooddata_api_client/model/execution_result_grand_total.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dimension_header import DimensionHeader - globals()['DimensionHeader'] = DimensionHeader - - -class ExecutionResultGrandTotal(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 - 'dimension_headers': ([DimensionHeader],), # noqa: E501 - 'total_dimensions': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'dimension_headers': 'dimensionHeaders', # noqa: E501 - 'total_dimensions': 'totalDimensions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, dimension_headers, total_dimensions, *args, **kwargs): # noqa: E501 - """ExecutionResultGrandTotal - a model defined in OpenAPI - - Args: - data ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values. - dimension_headers ([DimensionHeader]): Contains headers for a subset of `totalDimensions` in which the totals are grand totals. - total_dimensions ([str]): Dimensions of the grand totals. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - self.dimension_headers = dimension_headers - self.total_dimensions = total_dimensions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, dimension_headers, total_dimensions, *args, **kwargs): # noqa: E501 - """ExecutionResultGrandTotal - a model defined in OpenAPI - - Args: - data ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values. - dimension_headers ([DimensionHeader]): Contains headers for a subset of `totalDimensions` in which the totals are grand totals. - total_dimensions ([str]): Dimensions of the grand totals. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - self.dimension_headers = dimension_headers - self.total_dimensions = total_dimensions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/execution_result_grand_total.pyi b/gooddata-api-client/gooddata_api_client/model/execution_result_grand_total.pyi index a42557241..1f21d815e 100644 --- a/gooddata-api-client/gooddata_api_client/model/execution_result_grand_total.pyi +++ b/gooddata-api-client/gooddata_api_client/model/execution_result_grand_total.pyi @@ -42,18 +42,18 @@ class ExecutionResultGrandTotal( "totalDimensions", "dimensionHeaders", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.DictSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], @@ -64,22 +64,22 @@ class ExecutionResultGrandTotal( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class dimensionHeaders( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DimensionHeader']: return DimensionHeader - + def __new__( cls, _arg: typing.Union[typing.Tuple['DimensionHeader'], typing.List['DimensionHeader']], @@ -90,19 +90,19 @@ class ExecutionResultGrandTotal( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DimensionHeader': return super().__getitem__(i) - - + + class totalDimensions( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -113,7 +113,7 @@ class ExecutionResultGrandTotal( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) __annotations__ = { @@ -121,43 +121,43 @@ class ExecutionResultGrandTotal( "dimensionHeaders": dimensionHeaders, "totalDimensions": totalDimensions, } - + data: MetaOapg.properties.data totalDimensions: MetaOapg.properties.totalDimensions dimensionHeaders: MetaOapg.properties.dimensionHeaders - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dimensionHeaders"]) -> MetaOapg.properties.dimensionHeaders: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["totalDimensions"]) -> MetaOapg.properties.totalDimensions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "dimensionHeaders", "totalDimensions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dimensionHeaders"]) -> MetaOapg.properties.dimensionHeaders: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["totalDimensions"]) -> MetaOapg.properties.totalDimensions: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "dimensionHeaders", "totalDimensions", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -178,4 +178,4 @@ class ExecutionResultGrandTotal( **kwargs, ) -from gooddata_api_client.model.dimension_header import DimensionHeader +from gooddata_api_client.models.dimension_header import DimensionHeader diff --git a/gooddata-api-client/gooddata_api_client/model/execution_result_header.py b/gooddata-api-client/gooddata_api_client/model/execution_result_header.py deleted file mode 100644 index 373cd6172..000000000 --- a/gooddata-api-client/gooddata_api_client/model/execution_result_header.py +++ /dev/null @@ -1,340 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_execution_result_header import AttributeExecutionResultHeader - from gooddata_api_client.model.attribute_result_header import AttributeResultHeader - from gooddata_api_client.model.measure_execution_result_header import MeasureExecutionResultHeader - from gooddata_api_client.model.measure_result_header import MeasureResultHeader - from gooddata_api_client.model.total_execution_result_header import TotalExecutionResultHeader - from gooddata_api_client.model.total_result_header import TotalResultHeader - globals()['AttributeExecutionResultHeader'] = AttributeExecutionResultHeader - globals()['AttributeResultHeader'] = AttributeResultHeader - globals()['MeasureExecutionResultHeader'] = MeasureExecutionResultHeader - globals()['MeasureResultHeader'] = MeasureResultHeader - globals()['TotalExecutionResultHeader'] = TotalExecutionResultHeader - globals()['TotalResultHeader'] = TotalResultHeader - - -class ExecutionResultHeader(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute_header': (AttributeResultHeader,), # noqa: E501 - 'measure_header': (MeasureResultHeader,), # noqa: E501 - 'total_header': (TotalResultHeader,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute_header': 'attributeHeader', # noqa: E501 - 'measure_header': 'measureHeader', # noqa: E501 - 'total_header': 'totalHeader', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ExecutionResultHeader - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute_header (AttributeResultHeader): [optional] # noqa: E501 - measure_header (MeasureResultHeader): [optional] # noqa: E501 - total_header (TotalResultHeader): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ExecutionResultHeader - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute_header (AttributeResultHeader): [optional] # noqa: E501 - measure_header (MeasureResultHeader): [optional] # noqa: E501 - total_header (TotalResultHeader): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AttributeExecutionResultHeader, - MeasureExecutionResultHeader, - TotalExecutionResultHeader, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/execution_result_header.pyi b/gooddata-api-client/gooddata_api_client/model/execution_result_header.pyi index ceceb0417..8f4294aa9 100644 --- a/gooddata-api-client/gooddata_api_client/model/execution_result_header.pyi +++ b/gooddata-api-client/gooddata_api_client/model/execution_result_header.pyi @@ -38,7 +38,7 @@ class ExecutionResultHeader( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -69,6 +69,6 @@ class ExecutionResultHeader( **kwargs, ) -from gooddata_api_client.model.attribute_execution_result_header import AttributeExecutionResultHeader -from gooddata_api_client.model.measure_execution_result_header import MeasureExecutionResultHeader -from gooddata_api_client.model.total_execution_result_header import TotalExecutionResultHeader +from gooddata_api_client.models.attribute_execution_result_header import AttributeExecutionResultHeader +from gooddata_api_client.models.measure_execution_result_header import MeasureExecutionResultHeader +from gooddata_api_client.models.total_execution_result_header import TotalExecutionResultHeader diff --git a/gooddata-api-client/gooddata_api_client/model/execution_result_metadata.py b/gooddata-api-client/gooddata_api_client/model/execution_result_metadata.py deleted file mode 100644 index 92c672510..000000000 --- a/gooddata-api-client/gooddata_api_client/model/execution_result_metadata.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.execution_result_data_source_message import ExecutionResultDataSourceMessage - globals()['ExecutionResultDataSourceMessage'] = ExecutionResultDataSourceMessage - - -class ExecutionResultMetadata(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data_source_messages': ([ExecutionResultDataSourceMessage],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_source_messages': 'dataSourceMessages', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_source_messages, *args, **kwargs): # noqa: E501 - """ExecutionResultMetadata - a model defined in OpenAPI - - Args: - data_source_messages ([ExecutionResultDataSourceMessage]): Additional information sent by the underlying data source. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_source_messages = data_source_messages - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_source_messages, *args, **kwargs): # noqa: E501 - """ExecutionResultMetadata - a model defined in OpenAPI - - Args: - data_source_messages ([ExecutionResultDataSourceMessage]): Additional information sent by the underlying data source. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_source_messages = data_source_messages - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/execution_result_paging.py b/gooddata-api-client/gooddata_api_client/model/execution_result_paging.py deleted file mode 100644 index 37f278bdc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/execution_result_paging.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ExecutionResultPaging(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'count': ([int],), # noqa: E501 - 'offset': ([int],), # noqa: E501 - 'total': ([int],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'count': 'count', # noqa: E501 - 'offset': 'offset', # noqa: E501 - 'total': 'total', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, count, offset, total, *args, **kwargs): # noqa: E501 - """ExecutionResultPaging - a model defined in OpenAPI - - Args: - count ([int]): A count of the returned results in every dimension. - offset ([int]): The offset of the results returned in every dimension. - total ([int]): A total count of the results in every dimension. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.count = count - self.offset = offset - self.total = total - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, count, offset, total, *args, **kwargs): # noqa: E501 - """ExecutionResultPaging - a model defined in OpenAPI - - Args: - count ([int]): A count of the returned results in every dimension. - offset ([int]): The offset of the results returned in every dimension. - total ([int]): A total count of the results in every dimension. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.count = count - self.offset = offset - self.total = total - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/execution_settings.py b/gooddata-api-client/gooddata_api_client/model/execution_settings.py deleted file mode 100644 index b7daddc02..000000000 --- a/gooddata-api-client/gooddata_api_client/model/execution_settings.py +++ /dev/null @@ -1,272 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ExecutionSettings(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data_sampling_percentage',): { - 'exclusive_maximum''inclusive_maximum': 100, - 'exclusive_minimum''inclusive_minimum': 0, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'data_sampling_percentage': (float,), # noqa: E501 - 'timestamp': (datetime,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_sampling_percentage': 'dataSamplingPercentage', # noqa: E501 - 'timestamp': 'timestamp', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ExecutionSettings - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_sampling_percentage (float): Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.. [optional] # noqa: E501 - timestamp (datetime): Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ExecutionSettings - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_sampling_percentage (float): Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.. [optional] # noqa: E501 - timestamp (datetime): Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/export_request.py b/gooddata-api-client/gooddata_api_client/model/export_request.py deleted file mode 100644 index e848d04fe..000000000 --- a/gooddata-api-client/gooddata_api_client/model/export_request.py +++ /dev/null @@ -1,371 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.custom_override import CustomOverride - from gooddata_api_client.model.json_node import JsonNode - from gooddata_api_client.model.settings import Settings - from gooddata_api_client.model.tabular_export_request import TabularExportRequest - from gooddata_api_client.model.visual_export_request import VisualExportRequest - globals()['CustomOverride'] = CustomOverride - globals()['JsonNode'] = JsonNode - globals()['Settings'] = Settings - globals()['TabularExportRequest'] = TabularExportRequest - globals()['VisualExportRequest'] = VisualExportRequest - - -class ExportRequest(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('format',): { - 'CSV': "CSV", - 'XLSX': "XLSX", - 'HTML': "HTML", - 'PDF': "PDF", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'metadata': (JsonNode,), # noqa: E501 - 'custom_override': (CustomOverride,), # noqa: E501 - 'execution_result': (str,), # noqa: E501 - 'related_dashboard_id': (str,), # noqa: E501 - 'settings': (Settings,), # noqa: E501 - 'visualization_object': (str,), # noqa: E501 - 'visualization_object_custom_filters': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 - 'dashboard_id': (str,), # noqa: E501 - 'file_name': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'metadata': 'metadata', # noqa: E501 - 'custom_override': 'customOverride', # noqa: E501 - 'execution_result': 'executionResult', # noqa: E501 - 'related_dashboard_id': 'relatedDashboardId', # noqa: E501 - 'settings': 'settings', # noqa: E501 - 'visualization_object': 'visualizationObject', # noqa: E501 - 'visualization_object_custom_filters': 'visualizationObjectCustomFilters', # noqa: E501 - 'dashboard_id': 'dashboardId', # noqa: E501 - 'file_name': 'fileName', # noqa: E501 - 'format': 'format', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ExportRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - metadata (JsonNode): [optional] # noqa: E501 - custom_override (CustomOverride): [optional] # noqa: E501 - execution_result (str): Execution result identifier.. [optional] # noqa: E501 - related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 - settings (Settings): [optional] # noqa: E501 - visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 - visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 - dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 - file_name (str): Filename of downloaded file without extension.. [optional] # noqa: E501 - format (str): Expected file format.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ExportRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - metadata (JsonNode): [optional] # noqa: E501 - custom_override (CustomOverride): [optional] # noqa: E501 - execution_result (str): Execution result identifier.. [optional] # noqa: E501 - related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 - settings (Settings): [optional] # noqa: E501 - visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 - visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 - dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 - file_name (str): Filename of downloaded file without extension.. [optional] # noqa: E501 - format (str): Expected file format.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - TabularExportRequest, - VisualExportRequest, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/export_response.py b/gooddata-api-client/gooddata_api_client/model/export_response.py deleted file mode 100644 index 039b6e224..000000000 --- a/gooddata-api-client/gooddata_api_client/model/export_response.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ExportResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'export_result': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'export_result': 'exportResult', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, export_result, *args, **kwargs): # noqa: E501 - """ExportResponse - a model defined in OpenAPI - - Args: - export_result (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.export_result = export_result - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, export_result, *args, **kwargs): # noqa: E501 - """ExportResponse - a model defined in OpenAPI - - Args: - export_result (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.export_result = export_result - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/export_result.py b/gooddata-api-client/gooddata_api_client/model/export_result.py deleted file mode 100644 index 288d51ca3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/export_result.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ExportResult(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('status',): { - 'SUCCESS': "SUCCESS", - 'ERROR': "ERROR", - 'INTERNAL_ERROR': "INTERNAL_ERROR", - 'TIMEOUT': "TIMEOUT", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'export_id': (str,), # noqa: E501 - 'file_name': (str,), # noqa: E501 - 'status': (str,), # noqa: E501 - 'error_message': (str,), # noqa: E501 - 'expires_at': (datetime,), # noqa: E501 - 'file_size': (int,), # noqa: E501 - 'file_uri': (str,), # noqa: E501 - 'trace_id': (str,), # noqa: E501 - 'triggered_at': (datetime,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'export_id': 'exportId', # noqa: E501 - 'file_name': 'fileName', # noqa: E501 - 'status': 'status', # noqa: E501 - 'error_message': 'errorMessage', # noqa: E501 - 'expires_at': 'expiresAt', # noqa: E501 - 'file_size': 'fileSize', # noqa: E501 - 'file_uri': 'fileUri', # noqa: E501 - 'trace_id': 'traceId', # noqa: E501 - 'triggered_at': 'triggeredAt', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, export_id, file_name, status, *args, **kwargs): # noqa: E501 - """ExportResult - a model defined in OpenAPI - - Args: - export_id (str): - file_name (str): - status (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - error_message (str): [optional] # noqa: E501 - expires_at (datetime): [optional] # noqa: E501 - file_size (int): [optional] # noqa: E501 - file_uri (str): [optional] # noqa: E501 - trace_id (str): [optional] # noqa: E501 - triggered_at (datetime): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.export_id = export_id - self.file_name = file_name - self.status = status - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, export_id, file_name, status, *args, **kwargs): # noqa: E501 - """ExportResult - a model defined in OpenAPI - - Args: - export_id (str): - file_name (str): - status (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - error_message (str): [optional] # noqa: E501 - expires_at (datetime): [optional] # noqa: E501 - file_size (int): [optional] # noqa: E501 - file_uri (str): [optional] # noqa: E501 - trace_id (str): [optional] # noqa: E501 - triggered_at (datetime): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.export_id = export_id - self.file_name = file_name - self.status = status - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/fact_identifier.py b/gooddata-api-client/gooddata_api_client/model/fact_identifier.py deleted file mode 100644 index a8844d74a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/fact_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class FactIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FACT': "fact", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """FactIdentifier - a model defined in OpenAPI - - Args: - id (str): Fact ID. - - Keyword Args: - type (str): A type of the fact.. defaults to "fact", must be one of ["fact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "fact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """FactIdentifier - a model defined in OpenAPI - - Args: - id (str): Fact ID. - - Keyword Args: - type (str): A type of the fact.. defaults to "fact", must be one of ["fact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "fact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/file.py b/gooddata-api-client/gooddata_api_client/model/file.py deleted file mode 100644 index 8e4aab148..000000000 --- a/gooddata-api-client/gooddata_api_client/model/file.py +++ /dev/null @@ -1,334 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.notes import Notes - from gooddata_api_client.model.skeleton import Skeleton - globals()['Notes'] = Notes - globals()['Skeleton'] = Skeleton - - -class File(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('can_resegment',): { - 'YES': "YES", - 'NO': "NO", - }, - ('src_dir',): { - 'LTR': "LTR", - 'RTL': "RTL", - 'AUTO': "AUTO", - }, - ('translate',): { - 'YES': "YES", - 'NO': "NO", - }, - ('trg_dir',): { - 'LTR': "LTR", - 'RTL': "RTL", - 'AUTO': "AUTO", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'any': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 - 'can_resegment': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'notes': (Notes,), # noqa: E501 - 'original': (str,), # noqa: E501 - 'other_attributes': ({str: (str,)},), # noqa: E501 - 'skeleton': (Skeleton,), # noqa: E501 - 'space': (str,), # noqa: E501 - 'src_dir': (str,), # noqa: E501 - 'translate': (str,), # noqa: E501 - 'trg_dir': (str,), # noqa: E501 - 'unit_or_group': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'any': 'any', # noqa: E501 - 'can_resegment': 'canResegment', # noqa: E501 - 'id': 'id', # noqa: E501 - 'notes': 'notes', # noqa: E501 - 'original': 'original', # noqa: E501 - 'other_attributes': 'otherAttributes', # noqa: E501 - 'skeleton': 'skeleton', # noqa: E501 - 'space': 'space', # noqa: E501 - 'src_dir': 'srcDir', # noqa: E501 - 'translate': 'translate', # noqa: E501 - 'trg_dir': 'trgDir', # noqa: E501 - 'unit_or_group': 'unitOrGroup', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """File - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - any ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501 - can_resegment (str): [optional] # noqa: E501 - id (str): [optional] # noqa: E501 - notes (Notes): [optional] # noqa: E501 - original (str): [optional] # noqa: E501 - other_attributes ({str: (str,)}): [optional] # noqa: E501 - skeleton (Skeleton): [optional] # noqa: E501 - space (str): [optional] # noqa: E501 - src_dir (str): [optional] # noqa: E501 - translate (str): [optional] # noqa: E501 - trg_dir (str): [optional] # noqa: E501 - unit_or_group ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """File - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - any ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501 - can_resegment (str): [optional] # noqa: E501 - id (str): [optional] # noqa: E501 - notes (Notes): [optional] # noqa: E501 - original (str): [optional] # noqa: E501 - other_attributes ({str: (str,)}): [optional] # noqa: E501 - skeleton (Skeleton): [optional] # noqa: E501 - space (str): [optional] # noqa: E501 - src_dir (str): [optional] # noqa: E501 - translate (str): [optional] # noqa: E501 - trg_dir (str): [optional] # noqa: E501 - unit_or_group ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/filter.py b/gooddata-api-client/gooddata_api_client/model/filter.py deleted file mode 100644 index 160e2d9f3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/filter.py +++ /dev/null @@ -1,260 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class Filter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """Filter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """Filter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/filter_by.py b/gooddata-api-client/gooddata_api_client/model/filter_by.py deleted file mode 100644 index 8e483e4f1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/filter_by.py +++ /dev/null @@ -1,268 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class FilterBy(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('label_type',): { - 'PRIMARY': "PRIMARY", - 'REQUESTED': "REQUESTED", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'label_type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'label_type': 'labelType', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """FilterBy - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - label_type (str): Specifies which label is used for filtering - primary or requested.. [optional] if omitted the server will use the default value of "REQUESTED" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """FilterBy - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - label_type (str): Specifies which label is used for filtering - primary or requested.. [optional] if omitted the server will use the default value of "REQUESTED" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/filter_definition.py b/gooddata-api-client/gooddata_api_client/model/filter_definition.py deleted file mode 100644 index 94fce52c7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/filter_definition.py +++ /dev/null @@ -1,385 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.absolute_date_filter import AbsoluteDateFilter - from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter - from gooddata_api_client.model.comparison_measure_value_filter import ComparisonMeasureValueFilter - from gooddata_api_client.model.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter - from gooddata_api_client.model.inline_filter_definition import InlineFilterDefinition - from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline - from gooddata_api_client.model.negative_attribute_filter import NegativeAttributeFilter - from gooddata_api_client.model.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter - from gooddata_api_client.model.positive_attribute_filter import PositiveAttributeFilter - from gooddata_api_client.model.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter - from gooddata_api_client.model.range_measure_value_filter import RangeMeasureValueFilter - from gooddata_api_client.model.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter - from gooddata_api_client.model.ranking_filter import RankingFilter - from gooddata_api_client.model.ranking_filter_ranking_filter import RankingFilterRankingFilter - from gooddata_api_client.model.relative_date_filter import RelativeDateFilter - from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter - globals()['AbsoluteDateFilter'] = AbsoluteDateFilter - globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter - globals()['ComparisonMeasureValueFilter'] = ComparisonMeasureValueFilter - globals()['ComparisonMeasureValueFilterComparisonMeasureValueFilter'] = ComparisonMeasureValueFilterComparisonMeasureValueFilter - globals()['InlineFilterDefinition'] = InlineFilterDefinition - globals()['InlineFilterDefinitionInline'] = InlineFilterDefinitionInline - globals()['NegativeAttributeFilter'] = NegativeAttributeFilter - globals()['NegativeAttributeFilterNegativeAttributeFilter'] = NegativeAttributeFilterNegativeAttributeFilter - globals()['PositiveAttributeFilter'] = PositiveAttributeFilter - globals()['PositiveAttributeFilterPositiveAttributeFilter'] = PositiveAttributeFilterPositiveAttributeFilter - globals()['RangeMeasureValueFilter'] = RangeMeasureValueFilter - globals()['RangeMeasureValueFilterRangeMeasureValueFilter'] = RangeMeasureValueFilterRangeMeasureValueFilter - globals()['RankingFilter'] = RankingFilter - globals()['RankingFilterRankingFilter'] = RankingFilterRankingFilter - globals()['RelativeDateFilter'] = RelativeDateFilter - globals()['RelativeDateFilterRelativeDateFilter'] = RelativeDateFilterRelativeDateFilter - - -class FilterDefinition(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'inline': (InlineFilterDefinitionInline,), # noqa: E501 - 'ranking_filter': (RankingFilterRankingFilter,), # noqa: E501 - 'comparison_measure_value_filter': (ComparisonMeasureValueFilterComparisonMeasureValueFilter,), # noqa: E501 - 'range_measure_value_filter': (RangeMeasureValueFilterRangeMeasureValueFilter,), # noqa: E501 - 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 - 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 - 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 - 'positive_attribute_filter': (PositiveAttributeFilterPositiveAttributeFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'inline': 'inline', # noqa: E501 - 'ranking_filter': 'rankingFilter', # noqa: E501 - 'comparison_measure_value_filter': 'comparisonMeasureValueFilter', # noqa: E501 - 'range_measure_value_filter': 'rangeMeasureValueFilter', # noqa: E501 - 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 - 'relative_date_filter': 'relativeDateFilter', # noqa: E501 - 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 - 'positive_attribute_filter': 'positiveAttributeFilter', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """FilterDefinition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - inline (InlineFilterDefinitionInline): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 - relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 - negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """FilterDefinition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - inline (InlineFilterDefinitionInline): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 - relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 - negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AbsoluteDateFilter, - ComparisonMeasureValueFilter, - InlineFilterDefinition, - NegativeAttributeFilter, - PositiveAttributeFilter, - RangeMeasureValueFilter, - RankingFilter, - RelativeDateFilter, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/filter_definition.pyi b/gooddata-api-client/gooddata_api_client/model/filter_definition.pyi index eb5eefa60..5bc9b30bb 100644 --- a/gooddata-api-client/gooddata_api_client/model/filter_definition.pyi +++ b/gooddata-api-client/gooddata_api_client/model/filter_definition.pyi @@ -38,7 +38,7 @@ class FilterDefinition( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -74,11 +74,11 @@ class FilterDefinition( **kwargs, ) -from gooddata_api_client.model.absolute_date_filter import AbsoluteDateFilter -from gooddata_api_client.model.comparison_measure_value_filter import ComparisonMeasureValueFilter -from gooddata_api_client.model.inline_filter_definition import InlineFilterDefinition -from gooddata_api_client.model.negative_attribute_filter import NegativeAttributeFilter -from gooddata_api_client.model.positive_attribute_filter import PositiveAttributeFilter -from gooddata_api_client.model.range_measure_value_filter import RangeMeasureValueFilter -from gooddata_api_client.model.ranking_filter import RankingFilter -from gooddata_api_client.model.relative_date_filter import RelativeDateFilter +from gooddata_api_client.models.absolute_date_filter import AbsoluteDateFilter +from gooddata_api_client.models.comparison_measure_value_filter import ComparisonMeasureValueFilter +from gooddata_api_client.models.inline_filter_definition import InlineFilterDefinition +from gooddata_api_client.models.negative_attribute_filter import NegativeAttributeFilter +from gooddata_api_client.models.positive_attribute_filter import PositiveAttributeFilter +from gooddata_api_client.models.range_measure_value_filter import RangeMeasureValueFilter +from gooddata_api_client.models.ranking_filter import RankingFilter +from gooddata_api_client.models.relative_date_filter import RelativeDateFilter diff --git a/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.py b/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.py deleted file mode 100644 index 14bd2464a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.py +++ /dev/null @@ -1,343 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter - from gooddata_api_client.model.attribute_filter import AttributeFilter - from gooddata_api_client.model.date_filter import DateFilter - from gooddata_api_client.model.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter - from gooddata_api_client.model.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter - from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter - globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter - globals()['AttributeFilter'] = AttributeFilter - globals()['DateFilter'] = DateFilter - globals()['NegativeAttributeFilterNegativeAttributeFilter'] = NegativeAttributeFilterNegativeAttributeFilter - globals()['PositiveAttributeFilterPositiveAttributeFilter'] = PositiveAttributeFilterPositiveAttributeFilter - globals()['RelativeDateFilterRelativeDateFilter'] = RelativeDateFilterRelativeDateFilter - - -class FilterDefinitionForSimpleMeasure(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 - 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 - 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 - 'positive_attribute_filter': (PositiveAttributeFilterPositiveAttributeFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 - 'relative_date_filter': 'relativeDateFilter', # noqa: E501 - 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 - 'positive_attribute_filter': 'positiveAttributeFilter', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """FilterDefinitionForSimpleMeasure - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 - relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 - negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """FilterDefinitionForSimpleMeasure - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 - relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 - negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AttributeFilter, - DateFilter, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.pyi b/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.pyi index 81b17b1c8..a65247fd6 100644 --- a/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.pyi +++ b/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.pyi @@ -38,7 +38,7 @@ class FilterDefinitionForSimpleMeasure( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -68,5 +68,5 @@ class FilterDefinitionForSimpleMeasure( **kwargs, ) -from gooddata_api_client.model.attribute_filter import AttributeFilter -from gooddata_api_client.model.date_filter import DateFilter +from gooddata_api_client.models.attribute_filter import AttributeFilter +from gooddata_api_client.models.date_filter import DateFilter diff --git a/gooddata-api-client/gooddata_api_client/model/forecast_request.py b/gooddata-api-client/gooddata_api_client/model/forecast_request.py deleted file mode 100644 index 24e847cca..000000000 --- a/gooddata-api-client/gooddata_api_client/model/forecast_request.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ForecastRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('confidence_level',): { - 'exclusive_maximum''inclusive_maximum': 1.0, - 'exclusive_minimum''inclusive_minimum': 0.0, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'forecast_period': (int,), # noqa: E501 - 'confidence_level': (float,), # noqa: E501 - 'seasonal': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'forecast_period': 'forecastPeriod', # noqa: E501 - 'confidence_level': 'confidenceLevel', # noqa: E501 - 'seasonal': 'seasonal', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, forecast_period, *args, **kwargs): # noqa: E501 - """ForecastRequest - a model defined in OpenAPI - - Args: - forecast_period (int): Number of future periods that should be forecasted - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - confidence_level (float): Confidence interval boundary value.. [optional] if omitted the server will use the default value of 0.95 # noqa: E501 - seasonal (bool): Whether the input data is seasonal. [optional] if omitted the server will use the default value of False # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.forecast_period = forecast_period - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, forecast_period, *args, **kwargs): # noqa: E501 - """ForecastRequest - a model defined in OpenAPI - - Args: - forecast_period (int): Number of future periods that should be forecasted - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - confidence_level (float): Confidence interval boundary value.. [optional] if omitted the server will use the default value of 0.95 # noqa: E501 - seasonal (bool): Whether the input data is seasonal. [optional] if omitted the server will use the default value of False # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.forecast_period = forecast_period - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/forecast_result.py b/gooddata-api-client/gooddata_api_client/model/forecast_result.py deleted file mode 100644 index 60cd6a506..000000000 --- a/gooddata-api-client/gooddata_api_client/model/forecast_result.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ForecastResult(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'attribute': ([str],), # noqa: E501 - 'lower_bound': ([float, none_type],), # noqa: E501 - 'origin': ([float, none_type],), # noqa: E501 - 'prediction': ([float, none_type],), # noqa: E501 - 'upper_bound': ([float, none_type],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute': 'attribute', # noqa: E501 - 'lower_bound': 'lowerBound', # noqa: E501 - 'origin': 'origin', # noqa: E501 - 'prediction': 'prediction', # noqa: E501 - 'upper_bound': 'upperBound', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute, lower_bound, origin, prediction, upper_bound, *args, **kwargs): # noqa: E501 - """ForecastResult - a model defined in OpenAPI - - Args: - attribute ([str]): - lower_bound ([float, none_type]): - origin ([float, none_type]): - prediction ([float, none_type]): - upper_bound ([float, none_type]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - self.lower_bound = lower_bound - self.origin = origin - self.prediction = prediction - self.upper_bound = upper_bound - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attribute, lower_bound, origin, prediction, upper_bound, *args, **kwargs): # noqa: E501 - """ForecastResult - a model defined in OpenAPI - - Args: - attribute ([str]): - lower_bound ([float, none_type]): - origin ([float, none_type]): - prediction ([float, none_type]): - upper_bound ([float, none_type]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - self.lower_bound = lower_bound - self.origin = origin - self.prediction = prediction - self.upper_bound = upper_bound - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/found_objects.py b/gooddata-api-client/gooddata_api_client/model/found_objects.py deleted file mode 100644 index 9558ede33..000000000 --- a/gooddata-api-client/gooddata_api_client/model/found_objects.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.search_result_object import SearchResultObject - globals()['SearchResultObject'] = SearchResultObject - - -class FoundObjects(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'objects': ([SearchResultObject],), # noqa: E501 - 'reasoning': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'objects': 'objects', # noqa: E501 - 'reasoning': 'reasoning', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, objects, reasoning, *args, **kwargs): # noqa: E501 - """FoundObjects - a model defined in OpenAPI - - Args: - objects ([SearchResultObject]): List of objects found with a similarity search. - reasoning (str): Reasoning from LLM. Description of how and why the answer was generated. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.objects = objects - self.reasoning = reasoning - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, objects, reasoning, *args, **kwargs): # noqa: E501 - """FoundObjects - a model defined in OpenAPI - - Args: - objects ([SearchResultObject]): List of objects found with a similarity search. - reasoning (str): Reasoning from LLM. Description of how and why the answer was generated. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.objects = objects - self.reasoning = reasoning - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/frequency.py b/gooddata-api-client/gooddata_api_client/model/frequency.py deleted file mode 100644 index 5a39e7efe..000000000 --- a/gooddata-api-client/gooddata_api_client/model/frequency.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.frequency_bucket import FrequencyBucket - globals()['FrequencyBucket'] = FrequencyBucket - - -class Frequency(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'buckets': ([FrequencyBucket],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'buckets': 'buckets', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, buckets, *args, **kwargs): # noqa: E501 - """Frequency - a model defined in OpenAPI - - Args: - buckets ([FrequencyBucket]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.buckets = buckets - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, buckets, *args, **kwargs): # noqa: E501 - """Frequency - a model defined in OpenAPI - - Args: - buckets ([FrequencyBucket]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.buckets = buckets - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/frequency_bucket.py b/gooddata-api-client/gooddata_api_client/model/frequency_bucket.py deleted file mode 100644 index 6eaa50a59..000000000 --- a/gooddata-api-client/gooddata_api_client/model/frequency_bucket.py +++ /dev/null @@ -1,274 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class FrequencyBucket(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'count': (int,), # noqa: E501 - 'value': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'count': 'count', # noqa: E501 - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, count, *args, **kwargs): # noqa: E501 - """FrequencyBucket - a model defined in OpenAPI - - Args: - count (int): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - value (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.count = count - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, count, *args, **kwargs): # noqa: E501 - """FrequencyBucket - a model defined in OpenAPI - - Args: - count (int): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - value (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.count = count - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/frequency_properties.py b/gooddata-api-client/gooddata_api_client/model/frequency_properties.py deleted file mode 100644 index af4c946d9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/frequency_properties.py +++ /dev/null @@ -1,264 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class FrequencyProperties(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'value_limit': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'value_limit': 'valueLimit', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """FrequencyProperties - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - value_limit (int): The maximum number of distinct values to return.. [optional] if omitted the server will use the default value of 10 # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """FrequencyProperties - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - value_limit (int): The maximum number of distinct values to return.. [optional] if omitted the server will use the default value of 10 # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/generate_ldm_request.py b/gooddata-api-client/gooddata_api_client/model/generate_ldm_request.py deleted file mode 100644 index 021e08f04..000000000 --- a/gooddata-api-client/gooddata_api_client/model/generate_ldm_request.py +++ /dev/null @@ -1,338 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.pdm_ldm_request import PdmLdmRequest - globals()['PdmLdmRequest'] = PdmLdmRequest - - -class GenerateLdmRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'aggregated_fact_prefix': (str,), # noqa: E501 - 'date_granularities': (str,), # noqa: E501 - 'denorm_prefix': (str,), # noqa: E501 - 'fact_prefix': (str,), # noqa: E501 - 'generate_long_ids': (bool,), # noqa: E501 - 'grain_multivalue_reference_prefix': (str,), # noqa: E501 - 'grain_prefix': (str,), # noqa: E501 - 'grain_reference_prefix': (str,), # noqa: E501 - 'multivalue_reference_prefix': (str,), # noqa: E501 - 'pdm': (PdmLdmRequest,), # noqa: E501 - 'primary_label_prefix': (str,), # noqa: E501 - 'reference_prefix': (str,), # noqa: E501 - 'secondary_label_prefix': (str,), # noqa: E501 - 'separator': (str,), # noqa: E501 - 'table_prefix': (str,), # noqa: E501 - 'view_prefix': (str,), # noqa: E501 - 'wdf_prefix': (str,), # noqa: E501 - 'workspace_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'aggregated_fact_prefix': 'aggregatedFactPrefix', # noqa: E501 - 'date_granularities': 'dateGranularities', # noqa: E501 - 'denorm_prefix': 'denormPrefix', # noqa: E501 - 'fact_prefix': 'factPrefix', # noqa: E501 - 'generate_long_ids': 'generateLongIds', # noqa: E501 - 'grain_multivalue_reference_prefix': 'grainMultivalueReferencePrefix', # noqa: E501 - 'grain_prefix': 'grainPrefix', # noqa: E501 - 'grain_reference_prefix': 'grainReferencePrefix', # noqa: E501 - 'multivalue_reference_prefix': 'multivalueReferencePrefix', # noqa: E501 - 'pdm': 'pdm', # noqa: E501 - 'primary_label_prefix': 'primaryLabelPrefix', # noqa: E501 - 'reference_prefix': 'referencePrefix', # noqa: E501 - 'secondary_label_prefix': 'secondaryLabelPrefix', # noqa: E501 - 'separator': 'separator', # noqa: E501 - 'table_prefix': 'tablePrefix', # noqa: E501 - 'view_prefix': 'viewPrefix', # noqa: E501 - 'wdf_prefix': 'wdfPrefix', # noqa: E501 - 'workspace_id': 'workspaceId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """GenerateLdmRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aggregated_fact_prefix (str): Columns starting with this prefix will be considered as aggregated facts. The prefix is then followed by the value of `separator` parameter. Given the aggregated fact prefix is `aggr` and separator is `__`, the columns with name like `aggr__sum__product__sold` will be considered as aggregated sold fact in the product table with SUM aggregate function.. [optional] # noqa: E501 - date_granularities (str): Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is `all` which enables all available date granularities, including time granularities (like hours, minutes).. [optional] # noqa: E501 - denorm_prefix (str): Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of `separator` parameter. Given the denormalization reference prefix is `dr` and separator is `__`, the columns with name like `dr__customer_name` will be considered as denormalization references.. [optional] # noqa: E501 - fact_prefix (str): Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of `separator` parameter. Given the fact prefix is `f` and separator is `__`, the columns with name like `f__sold` will be considered as facts.. [optional] # noqa: E501 - generate_long_ids (bool): A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `.` is used. If the flag is set to true, then all ids will be generated in the long form.. [optional] if omitted the server will use the default value of False # noqa: E501 - grain_multivalue_reference_prefix (str): Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `grmr` and separator is `__`, the columns with name like `grmr__customer__customer_id` will be considered as grain multivalue references to customer_id in customer table.. [optional] # noqa: E501 - grain_prefix (str): Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of `separator` parameter. Given the grain prefix is `gr` and separator is `__`, the columns with name like `gr__name` will be considered as grains.. [optional] # noqa: E501 - grain_reference_prefix (str): Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `grr` and separator is `__`, the columns with name like `grr__customer__customer_id` will be considered as grain references to customer_id in customer table.. [optional] # noqa: E501 - multivalue_reference_prefix (str): Columns starting with this prefix will be considered as multivalue references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `mr` and separator is `__`, the columns with name like `mr__customer__customer_id` will be considered as multivalue references to customer_id in customer table.. [optional] # noqa: E501 - pdm (PdmLdmRequest): [optional] # noqa: E501 - primary_label_prefix (str): Columns starting with this prefix will be considered as primary labels. The prefix is then followed by the value of `separator` parameter. Given the primary label prefix is `pl` and separator is `__`, the columns with name like `pl__country_id` will be considered as primary labels.. [optional] # noqa: E501 - reference_prefix (str): Columns starting with this prefix will be considered as references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `r` and separator is `__`, the columns with name like `r__customer__customer_id` will be considered as references to customer_id in customer table.. [optional] # noqa: E501 - secondary_label_prefix (str): Columns starting with this prefix will be considered as secondary labels. The prefix is then followed by the value of `separator` parameter. Given the secondary label prefix is `ls` and separator is `__`, the columns with name like `ls__country_id__country_name` will be considered as secondary labels.. [optional] # noqa: E501 - separator (str): A separator between prefixes and the names. Default is \"__\".. [optional] if omitted the server will use the default value of "__" # noqa: E501 - table_prefix (str): Tables starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.. [optional] # noqa: E501 - view_prefix (str): Views starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.. [optional] # noqa: E501 - wdf_prefix (str): Column serving as workspace data filter. No labels are auto generated for such columns.. [optional] if omitted the server will use the default value of "wdf" # noqa: E501 - workspace_id (str): Optional workspace id.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """GenerateLdmRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aggregated_fact_prefix (str): Columns starting with this prefix will be considered as aggregated facts. The prefix is then followed by the value of `separator` parameter. Given the aggregated fact prefix is `aggr` and separator is `__`, the columns with name like `aggr__sum__product__sold` will be considered as aggregated sold fact in the product table with SUM aggregate function.. [optional] # noqa: E501 - date_granularities (str): Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is `all` which enables all available date granularities, including time granularities (like hours, minutes).. [optional] # noqa: E501 - denorm_prefix (str): Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of `separator` parameter. Given the denormalization reference prefix is `dr` and separator is `__`, the columns with name like `dr__customer_name` will be considered as denormalization references.. [optional] # noqa: E501 - fact_prefix (str): Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of `separator` parameter. Given the fact prefix is `f` and separator is `__`, the columns with name like `f__sold` will be considered as facts.. [optional] # noqa: E501 - generate_long_ids (bool): A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `
.` is used. If the flag is set to true, then all ids will be generated in the long form.. [optional] if omitted the server will use the default value of False # noqa: E501 - grain_multivalue_reference_prefix (str): Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `grmr` and separator is `__`, the columns with name like `grmr__customer__customer_id` will be considered as grain multivalue references to customer_id in customer table.. [optional] # noqa: E501 - grain_prefix (str): Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of `separator` parameter. Given the grain prefix is `gr` and separator is `__`, the columns with name like `gr__name` will be considered as grains.. [optional] # noqa: E501 - grain_reference_prefix (str): Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `grr` and separator is `__`, the columns with name like `grr__customer__customer_id` will be considered as grain references to customer_id in customer table.. [optional] # noqa: E501 - multivalue_reference_prefix (str): Columns starting with this prefix will be considered as multivalue references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `mr` and separator is `__`, the columns with name like `mr__customer__customer_id` will be considered as multivalue references to customer_id in customer table.. [optional] # noqa: E501 - pdm (PdmLdmRequest): [optional] # noqa: E501 - primary_label_prefix (str): Columns starting with this prefix will be considered as primary labels. The prefix is then followed by the value of `separator` parameter. Given the primary label prefix is `pl` and separator is `__`, the columns with name like `pl__country_id` will be considered as primary labels.. [optional] # noqa: E501 - reference_prefix (str): Columns starting with this prefix will be considered as references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `r` and separator is `__`, the columns with name like `r__customer__customer_id` will be considered as references to customer_id in customer table.. [optional] # noqa: E501 - secondary_label_prefix (str): Columns starting with this prefix will be considered as secondary labels. The prefix is then followed by the value of `separator` parameter. Given the secondary label prefix is `ls` and separator is `__`, the columns with name like `ls__country_id__country_name` will be considered as secondary labels.. [optional] # noqa: E501 - separator (str): A separator between prefixes and the names. Default is \"__\".. [optional] if omitted the server will use the default value of "__" # noqa: E501 - table_prefix (str): Tables starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.. [optional] # noqa: E501 - view_prefix (str): Views starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.. [optional] # noqa: E501 - wdf_prefix (str): Column serving as workspace data filter. No labels are auto generated for such columns.. [optional] if omitted the server will use the default value of "wdf" # noqa: E501 - workspace_id (str): Optional workspace id.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/generate_ldm_request.pyi b/gooddata-api-client/gooddata_api_client/model/generate_ldm_request.pyi index 9e81940ba..5e804eb60 100644 --- a/gooddata-api-client/gooddata_api_client/model/generate_ldm_request.pyi +++ b/gooddata-api-client/gooddata_api_client/model/generate_ldm_request.pyi @@ -37,7 +37,7 @@ class GenerateLdmRequest( class MetaOapg: - + class properties: dateGranularities = schemas.StrSchema denormPrefix = schemas.StrSchema @@ -45,7 +45,7 @@ class GenerateLdmRequest( generateLongIds = schemas.BoolSchema grainPrefix = schemas.StrSchema grainReferencePrefix = schemas.StrSchema - + @staticmethod def pdm() -> typing.Type['PdmLdmRequest']: return PdmLdmRequest @@ -72,105 +72,105 @@ class GenerateLdmRequest( "viewPrefix": viewPrefix, "wdfPrefix": wdfPrefix, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dateGranularities"]) -> MetaOapg.properties.dateGranularities: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["denormPrefix"]) -> MetaOapg.properties.denormPrefix: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["factPrefix"]) -> MetaOapg.properties.factPrefix: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["generateLongIds"]) -> MetaOapg.properties.generateLongIds: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["grainPrefix"]) -> MetaOapg.properties.grainPrefix: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["grainReferencePrefix"]) -> MetaOapg.properties.grainReferencePrefix: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["pdm"]) -> 'PdmLdmRequest': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["primaryLabelPrefix"]) -> MetaOapg.properties.primaryLabelPrefix: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["referencePrefix"]) -> MetaOapg.properties.referencePrefix: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["secondaryLabelPrefix"]) -> MetaOapg.properties.secondaryLabelPrefix: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["separator"]) -> MetaOapg.properties.separator: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tablePrefix"]) -> MetaOapg.properties.tablePrefix: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["viewPrefix"]) -> MetaOapg.properties.viewPrefix: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["wdfPrefix"]) -> MetaOapg.properties.wdfPrefix: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dateGranularities", "denormPrefix", "factPrefix", "generateLongIds", "grainPrefix", "grainReferencePrefix", "pdm", "primaryLabelPrefix", "referencePrefix", "secondaryLabelPrefix", "separator", "tablePrefix", "viewPrefix", "wdfPrefix", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dateGranularities"]) -> typing.Union[MetaOapg.properties.dateGranularities, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["denormPrefix"]) -> typing.Union[MetaOapg.properties.denormPrefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["factPrefix"]) -> typing.Union[MetaOapg.properties.factPrefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["generateLongIds"]) -> typing.Union[MetaOapg.properties.generateLongIds, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["grainPrefix"]) -> typing.Union[MetaOapg.properties.grainPrefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["grainReferencePrefix"]) -> typing.Union[MetaOapg.properties.grainReferencePrefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["pdm"]) -> typing.Union['PdmLdmRequest', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["primaryLabelPrefix"]) -> typing.Union[MetaOapg.properties.primaryLabelPrefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["referencePrefix"]) -> typing.Union[MetaOapg.properties.referencePrefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["secondaryLabelPrefix"]) -> typing.Union[MetaOapg.properties.secondaryLabelPrefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["separator"]) -> typing.Union[MetaOapg.properties.separator, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tablePrefix"]) -> typing.Union[MetaOapg.properties.tablePrefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["viewPrefix"]) -> typing.Union[MetaOapg.properties.viewPrefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["wdfPrefix"]) -> typing.Union[MetaOapg.properties.wdfPrefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dateGranularities", "denormPrefix", "factPrefix", "generateLongIds", "grainPrefix", "grainReferencePrefix", "pdm", "primaryLabelPrefix", "referencePrefix", "secondaryLabelPrefix", "separator", "tablePrefix", "viewPrefix", "wdfPrefix", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -213,4 +213,4 @@ class GenerateLdmRequest( **kwargs, ) -from gooddata_api_client.model.pdm_ldm_request import PdmLdmRequest +from gooddata_api_client.models.pdm_ldm_request import PdmLdmRequest diff --git a/gooddata-api-client/gooddata_api_client/model/get_image_export202_response_inner.py b/gooddata-api-client/gooddata_api_client/model/get_image_export202_response_inner.py deleted file mode 100644 index b8471bc53..000000000 --- a/gooddata-api-client/gooddata_api_client/model/get_image_export202_response_inner.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class GetImageExport202ResponseInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'char': (str,), # noqa: E501 - 'direct': (bool,), # noqa: E501 - 'double': (float,), # noqa: E501 - 'float': (float,), # noqa: E501 - 'int': (int,), # noqa: E501 - 'long': (int,), # noqa: E501 - 'read_only': (bool,), # noqa: E501 - 'short': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'char': 'char', # noqa: E501 - 'direct': 'direct', # noqa: E501 - 'double': 'double', # noqa: E501 - 'float': 'float', # noqa: E501 - 'int': 'int', # noqa: E501 - 'long': 'long', # noqa: E501 - 'read_only': 'readOnly', # noqa: E501 - 'short': 'short', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """GetImageExport202ResponseInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - char (str): [optional] # noqa: E501 - direct (bool): [optional] # noqa: E501 - double (float): [optional] # noqa: E501 - float (float): [optional] # noqa: E501 - int (int): [optional] # noqa: E501 - long (int): [optional] # noqa: E501 - read_only (bool): [optional] # noqa: E501 - short (int): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """GetImageExport202ResponseInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - char (str): [optional] # noqa: E501 - direct (bool): [optional] # noqa: E501 - double (float): [optional] # noqa: E501 - float (float): [optional] # noqa: E501 - int (int): [optional] # noqa: E501 - long (int): [optional] # noqa: E501 - read_only (bool): [optional] # noqa: E501 - short (int): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/get_quality_issues_response.py b/gooddata-api-client/gooddata_api_client/model/get_quality_issues_response.py deleted file mode 100644 index 1e3cfa50b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/get_quality_issues_response.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.quality_issue import QualityIssue - globals()['QualityIssue'] = QualityIssue - - -class GetQualityIssuesResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'issues': ([QualityIssue],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'issues': 'issues', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, issues, *args, **kwargs): # noqa: E501 - """GetQualityIssuesResponse - a model defined in OpenAPI - - Args: - issues ([QualityIssue]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.issues = issues - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, issues, *args, **kwargs): # noqa: E501 - """GetQualityIssuesResponse - a model defined in OpenAPI - - Args: - issues ([QualityIssue]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.issues = issues - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/grain_identifier.py b/gooddata-api-client/gooddata_api_client/model/grain_identifier.py deleted file mode 100644 index 0eb07c28f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/grain_identifier.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class GrainIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTE': "attribute", - 'DATE': "date", - }, - } - - validations = { - ('value',): { - }, - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """GrainIdentifier - a model defined in OpenAPI - - Args: - id (str): Grain ID. - type (str): A type of the grain. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """GrainIdentifier - a model defined in OpenAPI - - Args: - id (str): Grain ID. - type (str): A type of the grain. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/granted_permission.py b/gooddata-api-client/gooddata_api_client/model/granted_permission.py deleted file mode 100644 index 21ce103d1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/granted_permission.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class GrantedPermission(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'level': (str,), # noqa: E501 - 'source': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'level': 'level', # noqa: E501 - 'source': 'source', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, level, source, *args, **kwargs): # noqa: E501 - """GrantedPermission - a model defined in OpenAPI - - Args: - level (str): Level of permission - source (str): Source of permission - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.level = level - self.source = source - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, level, source, *args, **kwargs): # noqa: E501 - """GrantedPermission - a model defined in OpenAPI - - Args: - level (str): Level of permission - source (str): Source of permission - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.level = level - self.source = source - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/granularities_formatting.py b/gooddata-api-client/gooddata_api_client/model/granularities_formatting.py deleted file mode 100644 index 9fb4bf1d3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/granularities_formatting.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class GranularitiesFormatting(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('title_base',): { - 'max_length': 255, - }, - ('title_pattern',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'title_base': (str,), # noqa: E501 - 'title_pattern': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'title_base': 'titleBase', # noqa: E501 - 'title_pattern': 'titlePattern', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, title_base, title_pattern, *args, **kwargs): # noqa: E501 - """GranularitiesFormatting - a model defined in OpenAPI - - Args: - title_base (str): Title base is used as a token in title pattern. If left empty, it is replaced by date dataset title. - title_pattern (str): This pattern is used to generate the title of attributes and labels that result from the granularities. There are two tokens available: * `%titleBase` - represents shared part by all titles, or title of Date Dataset if left empty * `%granularityTitle` - represents `DateGranularity` built-in title - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title_base = title_base - self.title_pattern = title_pattern - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, title_base, title_pattern, *args, **kwargs): # noqa: E501 - """GranularitiesFormatting - a model defined in OpenAPI - - Args: - title_base (str): Title base is used as a token in title pattern. If left empty, it is replaced by date dataset title. - title_pattern (str): This pattern is used to generate the title of attributes and labels that result from the granularities. There are two tokens available: * `%titleBase` - represents shared part by all titles, or title of Date Dataset if left empty * `%granularityTitle` - represents `DateGranularity` built-in title - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title_base = title_base - self.title_pattern = title_pattern - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/header_group.py b/gooddata-api-client/gooddata_api_client/model/header_group.py deleted file mode 100644 index 891eff7df..000000000 --- a/gooddata-api-client/gooddata_api_client/model/header_group.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.execution_result_header import ExecutionResultHeader - globals()['ExecutionResultHeader'] = ExecutionResultHeader - - -class HeaderGroup(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'headers': ([ExecutionResultHeader],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'headers': 'headers', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, headers, *args, **kwargs): # noqa: E501 - """HeaderGroup - a model defined in OpenAPI - - Args: - headers ([ExecutionResultHeader]): An array containing headers. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.headers = headers - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, headers, *args, **kwargs): # noqa: E501 - """HeaderGroup - a model defined in OpenAPI - - Args: - headers ([ExecutionResultHeader]): An array containing headers. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.headers = headers - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/header_group.pyi b/gooddata-api-client/gooddata_api_client/model/header_group.pyi index 7b303451c..98fb0a7f3 100644 --- a/gooddata-api-client/gooddata_api_client/model/header_group.pyi +++ b/gooddata-api-client/gooddata_api_client/model/header_group.pyi @@ -110,4 +110,4 @@ class HeaderGroup( **kwargs, ) -from gooddata_api_client.model.execution_result_header import ExecutionResultHeader +from gooddata_api_client.models.execution_result_header import ExecutionResultHeader diff --git a/gooddata-api-client/gooddata_api_client/model/hierarchy_object_identification.py b/gooddata-api-client/gooddata_api_client/model/hierarchy_object_identification.py deleted file mode 100644 index ba5c1ee9f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/hierarchy_object_identification.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class HierarchyObjectIdentification(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - 'ATTRIBUTE': "attribute", - 'DASHBOARDPLUGIN': "dashboardPlugin", - 'DATASET': "dataset", - 'FACT': "fact", - 'LABEL': "label", - 'METRIC': "metric", - 'PROMPT': "prompt", - 'VISUALIZATIONOBJECT': "visualizationObject", - 'FILTERCONTEXT': "filterContext", - 'WORKSPACEDATAFILTER': "workspaceDataFilter", - 'WORKSPACEDATAFILTERSETTINGS': "workspaceDataFilterSettings", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """HierarchyObjectIdentification - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """HierarchyObjectIdentification - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/histogram.py b/gooddata-api-client/gooddata_api_client/model/histogram.py deleted file mode 100644 index 54010101c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/histogram.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.histogram_bucket import HistogramBucket - globals()['HistogramBucket'] = HistogramBucket - - -class Histogram(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'buckets': ([HistogramBucket],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'buckets': 'buckets', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, buckets, *args, **kwargs): # noqa: E501 - """Histogram - a model defined in OpenAPI - - Args: - buckets ([HistogramBucket]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.buckets = buckets - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, buckets, *args, **kwargs): # noqa: E501 - """Histogram - a model defined in OpenAPI - - Args: - buckets ([HistogramBucket]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.buckets = buckets - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/histogram_bucket.py b/gooddata-api-client/gooddata_api_client/model/histogram_bucket.py deleted file mode 100644 index 623ab57bf..000000000 --- a/gooddata-api-client/gooddata_api_client/model/histogram_bucket.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class HistogramBucket(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'count': (int,), # noqa: E501 - 'lower_bound': (float,), # noqa: E501 - 'upper_bound': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'count': 'count', # noqa: E501 - 'lower_bound': 'lowerBound', # noqa: E501 - 'upper_bound': 'upperBound', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, count, lower_bound, upper_bound, *args, **kwargs): # noqa: E501 - """HistogramBucket - a model defined in OpenAPI - - Args: - count (int): - lower_bound (float): - upper_bound (float): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.count = count - self.lower_bound = lower_bound - self.upper_bound = upper_bound - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, count, lower_bound, upper_bound, *args, **kwargs): # noqa: E501 - """HistogramBucket - a model defined in OpenAPI - - Args: - count (int): - lower_bound (float): - upper_bound (float): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.count = count - self.lower_bound = lower_bound - self.upper_bound = upper_bound - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/histogram_properties.py b/gooddata-api-client/gooddata_api_client/model/histogram_properties.py deleted file mode 100644 index 3d6e988dd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/histogram_properties.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class HistogramProperties(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'bucket_count': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'bucket_count': 'bucketCount', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, bucket_count, *args, **kwargs): # noqa: E501 - """HistogramProperties - a model defined in OpenAPI - - Args: - bucket_count (int): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.bucket_count = bucket_count - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, bucket_count, *args, **kwargs): # noqa: E501 - """HistogramProperties - a model defined in OpenAPI - - Args: - bucket_count (int): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.bucket_count = bucket_count - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/identifier_duplications.py b/gooddata-api-client/gooddata_api_client/model/identifier_duplications.py deleted file mode 100644 index 6c16a2fe8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/identifier_duplications.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class IdentifierDuplications(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - 'ATTRIBUTE': "attribute", - 'DASHBOARDPLUGIN': "dashboardPlugin", - 'DATASET': "dataset", - 'FACT': "fact", - 'LABEL': "label", - 'METRIC': "metric", - 'PROMPT': "prompt", - 'VISUALIZATIONOBJECT': "visualizationObject", - 'FILTERCONTEXT': "filterContext", - 'WORKSPACEDATAFILTER': "workspaceDataFilter", - 'WORKSPACEDATAFILTERSETTINGS': "workspaceDataFilterSettings", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'origins': ([str],), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'origins': 'origins', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, origins, type, *args, **kwargs): # noqa: E501 - """IdentifierDuplications - a model defined in OpenAPI - - Args: - id (str): - origins ([str]): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.origins = origins - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, origins, type, *args, **kwargs): # noqa: E501 - """IdentifierDuplications - a model defined in OpenAPI - - Args: - id (str): - origins ([str]): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.origins = origins - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/identifier_ref.py b/gooddata-api-client/gooddata_api_client/model/identifier_ref.py deleted file mode 100644 index 260650773..000000000 --- a/gooddata-api-client/gooddata_api_client/model/identifier_ref.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.identifier_ref_identifier import IdentifierRefIdentifier - globals()['IdentifierRefIdentifier'] = IdentifierRefIdentifier - - -class IdentifierRef(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'identifier': (IdentifierRefIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'identifier': 'identifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """IdentifierRef - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - identifier (IdentifierRefIdentifier): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """IdentifierRef - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - identifier (IdentifierRefIdentifier): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/identifier_ref_identifier.py b/gooddata-api-client/gooddata_api_client/model/identifier_ref_identifier.py deleted file mode 100644 index 800c23bb4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/identifier_ref_identifier.py +++ /dev/null @@ -1,299 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class IdentifierRefIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - 'ATTRIBUTE': "attribute", - 'ATTRIBUTEHIERARCHY': "attributeHierarchy", - 'DASHBOARDPLUGIN': "dashboardPlugin", - 'DATASET': "dataset", - 'FACT': "fact", - 'AGGREGATEDFACT': "aggregatedFact", - 'LABEL': "label", - 'METRIC': "metric", - 'USERDATAFILTER': "userDataFilter", - 'EXPORTDEFINITION': "exportDefinition", - 'AUTOMATION': "automation", - 'AUTOMATIONRESULT': "automationResult", - 'PROMPT': "prompt", - 'VISUALIZATIONOBJECT': "visualizationObject", - 'FILTERCONTEXT': "filterContext", - 'WORKSPACESETTINGS': "workspaceSettings", - 'CUSTOMAPPLICATIONSETTING': "customApplicationSetting", - 'WORKSPACEDATAFILTER': "workspaceDataFilter", - 'WORKSPACEDATAFILTERSETTING': "workspaceDataFilterSetting", - 'FILTERVIEW': "filterView", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """IdentifierRefIdentifier - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """IdentifierRefIdentifier - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/image_export_request.py b/gooddata-api-client/gooddata_api_client/model/image_export_request.py deleted file mode 100644 index 31b482ebd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/image_export_request.py +++ /dev/null @@ -1,307 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_node import JsonNode - globals()['JsonNode'] = JsonNode - - -class ImageExportRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('format',): { - 'PNG': "PNG", - }, - } - - validations = { - ('widget_ids',): { - 'max_items': 1, - 'min_items': 1, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dashboard_id': (str,), # noqa: E501 - 'file_name': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - 'widget_ids': ([str],), # noqa: E501 - 'metadata': (JsonNode,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dashboard_id': 'dashboardId', # noqa: E501 - 'file_name': 'fileName', # noqa: E501 - 'format': 'format', # noqa: E501 - 'widget_ids': 'widgetIds', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dashboard_id, file_name, widget_ids, *args, **kwargs): # noqa: E501 - """ImageExportRequest - a model defined in OpenAPI - - Args: - dashboard_id (str): Dashboard identifier - file_name (str): File name to be used for retrieving the image document. - widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported. - - Keyword Args: - format (str): Requested resulting file type.. defaults to "PNG", must be one of ["PNG", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - metadata (JsonNode): [optional] # noqa: E501 - """ - - format = kwargs.get('format', "PNG") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dashboard_id = dashboard_id - self.file_name = file_name - self.format = format - self.widget_ids = widget_ids - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dashboard_id, file_name, widget_ids, *args, **kwargs): # noqa: E501 - """ImageExportRequest - a model defined in OpenAPI - - Args: - dashboard_id (str): Dashboard identifier - file_name (str): File name to be used for retrieving the image document. - widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported. - - Keyword Args: - format (str): Requested resulting file type.. defaults to "PNG", must be one of ["PNG", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - metadata (JsonNode): [optional] # noqa: E501 - """ - - format = kwargs.get('format', "PNG") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dashboard_id = dashboard_id - self.file_name = file_name - self.format = format - self.widget_ids = widget_ids - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/in_platform.py b/gooddata-api-client/gooddata_api_client/model/in_platform.py deleted file mode 100644 index 12b64632a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/in_platform.py +++ /dev/null @@ -1,325 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.in_platform_all_of import InPlatformAllOf - globals()['InPlatformAllOf'] = InPlatformAllOf - - -class InPlatform(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'IN_PLATFORM': "IN_PLATFORM", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """InPlatform - a model defined in OpenAPI - - Keyword Args: - type (str): The destination type.. defaults to "IN_PLATFORM", must be one of ["IN_PLATFORM", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "IN_PLATFORM") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """InPlatform - a model defined in OpenAPI - - Keyword Args: - type (str): The destination type.. defaults to "IN_PLATFORM", must be one of ["IN_PLATFORM", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "IN_PLATFORM") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - InPlatformAllOf, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/in_platform_all_of.py b/gooddata-api-client/gooddata_api_client/model/in_platform_all_of.py deleted file mode 100644 index e2c0440d0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/in_platform_all_of.py +++ /dev/null @@ -1,267 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class InPlatformAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'IN_PLATFORM': "IN_PLATFORM", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """InPlatformAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - type (str): The destination type.. [optional] if omitted the server will use the default value of "IN_PLATFORM" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """InPlatformAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - type (str): The destination type.. [optional] if omitted the server will use the default value of "IN_PLATFORM" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/inline_filter_definition.py b/gooddata-api-client/gooddata_api_client/model/inline_filter_definition.py deleted file mode 100644 index f92d89144..000000000 --- a/gooddata-api-client/gooddata_api_client/model/inline_filter_definition.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline - globals()['InlineFilterDefinitionInline'] = InlineFilterDefinitionInline - - -class InlineFilterDefinition(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'inline': (InlineFilterDefinitionInline,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'inline': 'inline', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, inline, *args, **kwargs): # noqa: E501 - """InlineFilterDefinition - a model defined in OpenAPI - - Args: - inline (InlineFilterDefinitionInline): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.inline = inline - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, inline, *args, **kwargs): # noqa: E501 - """InlineFilterDefinition - a model defined in OpenAPI - - Args: - inline (InlineFilterDefinitionInline): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.inline = inline - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/inline_filter_definition_inline.py b/gooddata-api-client/gooddata_api_client/model/inline_filter_definition_inline.py deleted file mode 100644 index e33ac3ecd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/inline_filter_definition_inline.py +++ /dev/null @@ -1,278 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class InlineFilterDefinitionInline(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'filter': (str,), # noqa: E501 - 'apply_on_result': (bool,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'filter': 'filter', # noqa: E501 - 'apply_on_result': 'applyOnResult', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, filter, *args, **kwargs): # noqa: E501 - """InlineFilterDefinitionInline - a model defined in OpenAPI - - Args: - filter (str): MAQL query representing the filter. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter = filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, filter, *args, **kwargs): # noqa: E501 - """InlineFilterDefinitionInline - a model defined in OpenAPI - - Args: - filter (str): MAQL query representing the filter. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter = filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/inline_measure_definition.py b/gooddata-api-client/gooddata_api_client/model/inline_measure_definition.py deleted file mode 100644 index 346224eb3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/inline_measure_definition.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.inline_measure_definition_inline import InlineMeasureDefinitionInline - globals()['InlineMeasureDefinitionInline'] = InlineMeasureDefinitionInline - - -class InlineMeasureDefinition(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'inline': (InlineMeasureDefinitionInline,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'inline': 'inline', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, inline, *args, **kwargs): # noqa: E501 - """InlineMeasureDefinition - a model defined in OpenAPI - - Args: - inline (InlineMeasureDefinitionInline): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.inline = inline - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, inline, *args, **kwargs): # noqa: E501 - """InlineMeasureDefinition - a model defined in OpenAPI - - Args: - inline (InlineMeasureDefinitionInline): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.inline = inline - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/inline_measure_definition_inline.py b/gooddata-api-client/gooddata_api_client/model/inline_measure_definition_inline.py deleted file mode 100644 index c7d2afe0b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/inline_measure_definition_inline.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class InlineMeasureDefinitionInline(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'maql': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'maql': 'maql', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, maql, *args, **kwargs): # noqa: E501 - """InlineMeasureDefinitionInline - a model defined in OpenAPI - - Args: - maql (str): MAQL query defining the metric. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.maql = maql - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, maql, *args, **kwargs): # noqa: E501 - """InlineMeasureDefinitionInline - a model defined in OpenAPI - - Args: - maql (str): MAQL query defining the metric. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.maql = maql - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/intro_slide_template.py b/gooddata-api-client/gooddata_api_client/model/intro_slide_template.py deleted file mode 100644 index aceb77df0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/intro_slide_template.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.running_section import RunningSection - globals()['RunningSection'] = RunningSection - - -class IntroSlideTemplate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'background_image': (bool,), # noqa: E501 - 'description_field': (str, none_type,), # noqa: E501 - 'footer': (RunningSection,), # noqa: E501 - 'header': (RunningSection,), # noqa: E501 - 'title_field': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'background_image': 'backgroundImage', # noqa: E501 - 'description_field': 'descriptionField', # noqa: E501 - 'footer': 'footer', # noqa: E501 - 'header': 'header', # noqa: E501 - 'title_field': 'titleField', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """IntroSlideTemplate - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 - description_field (str, none_type): [optional] # noqa: E501 - footer (RunningSection): [optional] # noqa: E501 - header (RunningSection): [optional] # noqa: E501 - title_field (str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """IntroSlideTemplate - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 - description_field (str, none_type): [optional] # noqa: E501 - footer (RunningSection): [optional] # noqa: E501 - header (RunningSection): [optional] # noqa: E501 - title_field (str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_linkage.py deleted file mode 100644 index 693e8113f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAggregatedFactLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AGGREGATEDFACT': "aggregatedFact", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "aggregatedFact", must be one of ["aggregatedFact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "aggregatedFact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "aggregatedFact", must be one of ["aggregatedFact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "aggregatedFact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out.py deleted file mode 100644 index c9a185f62..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out.py +++ /dev/null @@ -1,310 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_attributes import JsonApiAggregatedFactOutAttributes - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_aggregated_fact_out_relationships import JsonApiAggregatedFactOutRelationships - globals()['JsonApiAggregatedFactOutAttributes'] = JsonApiAggregatedFactOutAttributes - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAggregatedFactOutRelationships'] = JsonApiAggregatedFactOutRelationships - - -class JsonApiAggregatedFactOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AGGREGATEDFACT': "aggregatedFact", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAggregatedFactOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAggregatedFactOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOut - a model defined in OpenAPI - - Args: - attributes (JsonApiAggregatedFactOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "aggregatedFact", must be one of ["aggregatedFact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAggregatedFactOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "aggregatedFact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOut - a model defined in OpenAPI - - Args: - attributes (JsonApiAggregatedFactOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "aggregatedFact", must be one of ["aggregatedFact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAggregatedFactOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "aggregatedFact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_attributes.py deleted file mode 100644 index ef80f57fe..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_attributes.py +++ /dev/null @@ -1,310 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAggregatedFactOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('operation',): { - 'SUM': "SUM", - 'MIN': "MIN", - 'MAX': "MAX", - }, - ('source_column_data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('source_column',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'operation': (str,), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'source_column': (str,), # noqa: E501 - 'source_column_data_type': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'operation': 'operation', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'description': 'description', # noqa: E501 - 'source_column': 'sourceColumn', # noqa: E501 - 'source_column_data_type': 'sourceColumnDataType', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, operation, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutAttributes - a model defined in OpenAPI - - Args: - operation (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - source_column (str): [optional] # noqa: E501 - source_column_data_type (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.operation = operation - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, operation, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutAttributes - a model defined in OpenAPI - - Args: - operation (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - source_column (str): [optional] # noqa: E501 - source_column_data_type (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.operation = operation - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_document.py deleted file mode 100644 index daf47528c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out import JsonApiAggregatedFactOut - from gooddata_api_client.model.json_api_aggregated_fact_out_includes import JsonApiAggregatedFactOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOut'] = JsonApiAggregatedFactOut - globals()['JsonApiAggregatedFactOutIncludes'] = JsonApiAggregatedFactOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiAggregatedFactOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAggregatedFactOut,), # noqa: E501 - 'included': ([JsonApiAggregatedFactOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiAggregatedFactOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAggregatedFactOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiAggregatedFactOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAggregatedFactOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_includes.py deleted file mode 100644 index c9c658084..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_includes.py +++ /dev/null @@ -1,359 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks - from gooddata_api_client.model.json_api_fact_out_attributes import JsonApiFactOutAttributes - from gooddata_api_client.model.json_api_fact_out_relationships import JsonApiFactOutRelationships - from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks - globals()['JsonApiFactOutAttributes'] = JsonApiFactOutAttributes - globals()['JsonApiFactOutRelationships'] = JsonApiFactOutRelationships - globals()['JsonApiFactOutWithLinks'] = JsonApiFactOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiAggregatedFactOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FACT': "fact", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiFactOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - 'attributes': (JsonApiFactOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "fact" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "fact" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiDatasetOutWithLinks, - JsonApiFactOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_list.py deleted file mode 100644 index 9dfadaf05..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_includes import JsonApiAggregatedFactOutIncludes - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_aggregated_fact_out_with_links import JsonApiAggregatedFactOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutIncludes'] = JsonApiAggregatedFactOutIncludes - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiAggregatedFactOutWithLinks'] = JsonApiAggregatedFactOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiAggregatedFactOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiAggregatedFactOutWithLinks],), # noqa: E501 - 'included': ([JsonApiAggregatedFactOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutList - a model defined in OpenAPI - - Args: - data ([JsonApiAggregatedFactOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAggregatedFactOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutList - a model defined in OpenAPI - - Args: - data ([JsonApiAggregatedFactOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAggregatedFactOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_list_meta.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_list_meta.py deleted file mode 100644 index 6f74f2387..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_list_meta.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.page_metadata import PageMetadata - globals()['PageMetadata'] = PageMetadata - - -class JsonApiAggregatedFactOutListMeta(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'page': (PageMetadata,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'page': 'page', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutListMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - page (PageMetadata): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutListMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - page (PageMetadata): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_meta.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_meta.py deleted file mode 100644 index 524425794..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_meta.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta_origin import JsonApiAggregatedFactOutMetaOrigin - globals()['JsonApiAggregatedFactOutMetaOrigin'] = JsonApiAggregatedFactOutMetaOrigin - - -class JsonApiAggregatedFactOutMeta(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'origin': (JsonApiAggregatedFactOutMetaOrigin,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'origin': 'origin', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - origin (JsonApiAggregatedFactOutMetaOrigin): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - origin (JsonApiAggregatedFactOutMetaOrigin): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_meta_origin.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_meta_origin.py deleted file mode 100644 index 4887ea135..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_meta_origin.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAggregatedFactOutMetaOrigin(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('origin_type',): { - 'NATIVE': "NATIVE", - 'PARENT': "PARENT", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'origin_id': (str,), # noqa: E501 - 'origin_type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'origin_id': 'originId', # noqa: E501 - 'origin_type': 'originType', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, origin_id, origin_type, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutMetaOrigin - a model defined in OpenAPI - - Args: - origin_id (str): defines id of the workspace where the entity comes from - origin_type (str): defines type of the origin of the entity - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.origin_id = origin_id - self.origin_type = origin_type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, origin_id, origin_type, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutMetaOrigin - a model defined in OpenAPI - - Args: - origin_id (str): defines id of the workspace where the entity comes from - origin_type (str): defines type of the origin of the entity - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.origin_id = origin_id - self.origin_type = origin_type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_relationships.py deleted file mode 100644 index c37ea2210..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_relationships.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_relationships_dataset import JsonApiAggregatedFactOutRelationshipsDataset - from gooddata_api_client.model.json_api_aggregated_fact_out_relationships_source_fact import JsonApiAggregatedFactOutRelationshipsSourceFact - globals()['JsonApiAggregatedFactOutRelationshipsDataset'] = JsonApiAggregatedFactOutRelationshipsDataset - globals()['JsonApiAggregatedFactOutRelationshipsSourceFact'] = JsonApiAggregatedFactOutRelationshipsSourceFact - - -class JsonApiAggregatedFactOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dataset': (JsonApiAggregatedFactOutRelationshipsDataset,), # noqa: E501 - 'source_fact': (JsonApiAggregatedFactOutRelationshipsSourceFact,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dataset': 'dataset', # noqa: E501 - 'source_fact': 'sourceFact', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dataset (JsonApiAggregatedFactOutRelationshipsDataset): [optional] # noqa: E501 - source_fact (JsonApiAggregatedFactOutRelationshipsSourceFact): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dataset (JsonApiAggregatedFactOutRelationshipsDataset): [optional] # noqa: E501 - source_fact (JsonApiAggregatedFactOutRelationshipsSourceFact): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_relationships_dataset.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_relationships_dataset.py deleted file mode 100644 index 617110008..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_relationships_dataset.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage - globals()['JsonApiDatasetToOneLinkage'] = JsonApiDatasetToOneLinkage - - -class JsonApiAggregatedFactOutRelationshipsDataset(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDatasetToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutRelationshipsDataset - a model defined in OpenAPI - - Args: - data (JsonApiDatasetToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutRelationshipsDataset - a model defined in OpenAPI - - Args: - data (JsonApiDatasetToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_relationships_source_fact.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_relationships_source_fact.py deleted file mode 100644 index a8550b303..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_relationships_source_fact.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_fact_to_one_linkage import JsonApiFactToOneLinkage - globals()['JsonApiFactToOneLinkage'] = JsonApiFactToOneLinkage - - -class JsonApiAggregatedFactOutRelationshipsSourceFact(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiFactToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutRelationshipsSourceFact - a model defined in OpenAPI - - Args: - data (JsonApiFactToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutRelationshipsSourceFact - a model defined in OpenAPI - - Args: - data (JsonApiFactToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_with_links.py deleted file mode 100644 index 542d78b25..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out import JsonApiAggregatedFactOut - from gooddata_api_client.model.json_api_aggregated_fact_out_attributes import JsonApiAggregatedFactOutAttributes - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_aggregated_fact_out_relationships import JsonApiAggregatedFactOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOut'] = JsonApiAggregatedFactOut - globals()['JsonApiAggregatedFactOutAttributes'] = JsonApiAggregatedFactOutAttributes - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAggregatedFactOutRelationships'] = JsonApiAggregatedFactOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiAggregatedFactOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AGGREGATEDFACT': "aggregatedFact", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAggregatedFactOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAggregatedFactOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiAggregatedFactOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "aggregatedFact", must be one of ["aggregatedFact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAggregatedFactOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "aggregatedFact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAggregatedFactOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiAggregatedFactOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "aggregatedFact", must be one of ["aggregatedFact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAggregatedFactOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "aggregatedFact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiAggregatedFactOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_to_many_linkage.py deleted file mode 100644 index feb0ba9f6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_linkage import JsonApiAggregatedFactLinkage - globals()['JsonApiAggregatedFactLinkage'] = JsonApiAggregatedFactLinkage - - -class JsonApiAggregatedFactToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiAggregatedFactLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiAggregatedFactToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiAggregatedFactLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiAggregatedFactLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiAggregatedFactToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiAggregatedFactLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiAggregatedFactLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in.py deleted file mode 100644 index 8a9df76fb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes - globals()['JsonApiAnalyticalDashboardInAttributes'] = JsonApiAnalyticalDashboardInAttributes - - -class JsonApiAnalyticalDashboardIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAnalyticalDashboardInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardIn - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardIn - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in_attributes.py deleted file mode 100644 index b0d84f7d1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in_attributes.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAnalyticalDashboardInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'description': 'description', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardInAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardInAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in_document.py deleted file mode 100644 index f94c9d907..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_in import JsonApiAnalyticalDashboardIn - globals()['JsonApiAnalyticalDashboardIn'] = JsonApiAnalyticalDashboardIn - - -class JsonApiAnalyticalDashboardInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAnalyticalDashboardIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardInDocument - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardInDocument - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in_document.pyi index f346b53d9..f0b6ca563 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiAnalyticalDashboardInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiAnalyticalDashboardIn']: return JsonApiAnalyticalDashboardIn __annotations__ = { "data": data, } - + data: 'JsonApiAnalyticalDashboardIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiAnalyticalDashboardInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_analytical_dashboard_in import JsonApiAnalyticalDashboardIn +from gooddata_api_client.models.json_api_analytical_dashboard_in import JsonApiAnalyticalDashboardIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_linkage.py deleted file mode 100644 index 84c1ca59e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAnalyticalDashboardLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out.py deleted file mode 100644 index 96ea4a9e4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out.py +++ /dev/null @@ -1,310 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_attributes import JsonApiAnalyticalDashboardOutAttributes - from gooddata_api_client.model.json_api_analytical_dashboard_out_meta import JsonApiAnalyticalDashboardOutMeta - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships import JsonApiAnalyticalDashboardOutRelationships - globals()['JsonApiAnalyticalDashboardOutAttributes'] = JsonApiAnalyticalDashboardOutAttributes - globals()['JsonApiAnalyticalDashboardOutMeta'] = JsonApiAnalyticalDashboardOutMeta - globals()['JsonApiAnalyticalDashboardOutRelationships'] = JsonApiAnalyticalDashboardOutRelationships - - -class JsonApiAnalyticalDashboardOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAnalyticalDashboardOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAnalyticalDashboardOutMeta,), # noqa: E501 - 'relationships': (JsonApiAnalyticalDashboardOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOut - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAnalyticalDashboardOutMeta): [optional] # noqa: E501 - relationships (JsonApiAnalyticalDashboardOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOut - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAnalyticalDashboardOutMeta): [optional] # noqa: E501 - relationships (JsonApiAnalyticalDashboardOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out.pyi index 16c5c2964..ff208e01e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out.pyi @@ -41,52 +41,52 @@ class JsonApiAnalyticalDashboardOut( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ANALYTICAL_DASHBOARD(cls): return cls("analyticalDashboard") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: areRelationsValid = schemas.BoolSchema content = schemas.DictSchema - - + + class description( schemas.StrSchema ): pass - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -97,11 +97,11 @@ class JsonApiAnalyticalDashboardOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): @@ -113,52 +113,52 @@ class JsonApiAnalyticalDashboardOut( "tags": tags, "title": title, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -181,57 +181,57 @@ class JsonApiAnalyticalDashboardOut( _configuration=_configuration, **kwargs, ) - - + + class meta( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class accessInfo( schemas.DictSchema ): - - + + class MetaOapg: required = { "private", } - + class properties: private = schemas.BoolSchema __annotations__ = { "private": private, } - + private: MetaOapg.properties.private - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["private"]) -> MetaOapg.properties.private: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["private", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["private"]) -> MetaOapg.properties.private: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["private", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -246,32 +246,32 @@ class JsonApiAnalyticalDashboardOut( _configuration=_configuration, **kwargs, ) - - + + class origin( schemas.DictSchema ): - - + + class MetaOapg: required = { "originType", "originId", } - + class properties: originId = schemas.StrSchema - - + + class originType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") - + @schemas.classproperty def PARENT(cls): return cls("PARENT") @@ -279,37 +279,37 @@ class JsonApiAnalyticalDashboardOut( "originId": originId, "originType": originType, } - + originType: MetaOapg.properties.originType originId: MetaOapg.properties.originId - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -326,33 +326,33 @@ class JsonApiAnalyticalDashboardOut( _configuration=_configuration, **kwargs, ) - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def EDIT(cls): return cls("EDIT") - + @schemas.classproperty def SHARE(cls): return cls("SHARE") - + @schemas.classproperty def VIEW(cls): return cls("VIEW") - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -363,7 +363,7 @@ class JsonApiAnalyticalDashboardOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) __annotations__ = { @@ -371,40 +371,40 @@ class JsonApiAnalyticalDashboardOut( "origin": origin, "permissions": permissions, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["accessInfo"]) -> MetaOapg.properties.accessInfo: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["accessInfo", "origin", "permissions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["accessInfo"]) -> typing.Union[MetaOapg.properties.accessInfo, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["accessInfo", "origin", "permissions", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -423,60 +423,60 @@ class JsonApiAnalyticalDashboardOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class analyticalDashboards( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiAnalyticalDashboardToManyLinkage']: return JsonApiAnalyticalDashboardToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiAnalyticalDashboardToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -491,50 +491,50 @@ class JsonApiAnalyticalDashboardOut( _configuration=_configuration, **kwargs, ) - - + + class dashboardPlugins( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDashboardPluginToManyLinkage']: return JsonApiDashboardPluginToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiDashboardPluginToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDashboardPluginToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDashboardPluginToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -549,50 +549,50 @@ class JsonApiAnalyticalDashboardOut( _configuration=_configuration, **kwargs, ) - - + + class datasets( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDatasetToManyLinkage']: return JsonApiDatasetToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiDatasetToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -607,50 +607,50 @@ class JsonApiAnalyticalDashboardOut( _configuration=_configuration, **kwargs, ) - - + + class filterContexts( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiFilterContextToManyLinkage']: return JsonApiFilterContextToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiFilterContextToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterContextToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterContextToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -665,50 +665,50 @@ class JsonApiAnalyticalDashboardOut( _configuration=_configuration, **kwargs, ) - - + + class labels( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiLabelToManyLinkage']: return JsonApiLabelToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiLabelToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -723,50 +723,50 @@ class JsonApiAnalyticalDashboardOut( _configuration=_configuration, **kwargs, ) - - + + class metrics( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiMetricToManyLinkage']: return JsonApiMetricToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiMetricToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -781,50 +781,50 @@ class JsonApiAnalyticalDashboardOut( _configuration=_configuration, **kwargs, ) - - + + class visualizationObjects( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiVisualizationObjectToManyLinkage']: return JsonApiVisualizationObjectToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiVisualizationObjectToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -848,64 +848,64 @@ class JsonApiAnalyticalDashboardOut( "metrics": metrics, "visualizationObjects": visualizationObjects, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["analyticalDashboards"]) -> MetaOapg.properties.analyticalDashboards: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dashboardPlugins"]) -> MetaOapg.properties.dashboardPlugins: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["datasets"]) -> MetaOapg.properties.datasets: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["filterContexts"]) -> MetaOapg.properties.filterContexts: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["labels"]) -> MetaOapg.properties.labels: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["visualizationObjects"]) -> MetaOapg.properties.visualizationObjects: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboards", "dashboardPlugins", "datasets", "filterContexts", "labels", "metrics", "visualizationObjects", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboards"]) -> typing.Union[MetaOapg.properties.analyticalDashboards, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dashboardPlugins"]) -> typing.Union[MetaOapg.properties.dashboardPlugins, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["datasets"]) -> typing.Union[MetaOapg.properties.datasets, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["filterContexts"]) -> typing.Union[MetaOapg.properties.filterContexts, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["labels"]) -> typing.Union[MetaOapg.properties.labels, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["visualizationObjects"]) -> typing.Union[MetaOapg.properties.visualizationObjects, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboards", "dashboardPlugins", "datasets", "filterContexts", "labels", "metrics", "visualizationObjects", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -939,54 +939,54 @@ class JsonApiAnalyticalDashboardOut( "meta": meta, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -1011,10 +1011,10 @@ class JsonApiAnalyticalDashboardOut( **kwargs, ) -from gooddata_api_client.model.json_api_analytical_dashboard_to_many_linkage import JsonApiAnalyticalDashboardToManyLinkage -from gooddata_api_client.model.json_api_dashboard_plugin_to_many_linkage import JsonApiDashboardPluginToManyLinkage -from gooddata_api_client.model.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage -from gooddata_api_client.model.json_api_filter_context_to_many_linkage import JsonApiFilterContextToManyLinkage -from gooddata_api_client.model.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage -from gooddata_api_client.model.json_api_metric_to_many_linkage import JsonApiMetricToManyLinkage -from gooddata_api_client.model.json_api_visualization_object_to_many_linkage import JsonApiVisualizationObjectToManyLinkage +from gooddata_api_client.models.json_api_analytical_dashboard_to_many_linkage import JsonApiAnalyticalDashboardToManyLinkage +from gooddata_api_client.models.json_api_dashboard_plugin_to_many_linkage import JsonApiDashboardPluginToManyLinkage +from gooddata_api_client.models.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage +from gooddata_api_client.models.json_api_filter_context_to_many_linkage import JsonApiFilterContextToManyLinkage +from gooddata_api_client.models.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage +from gooddata_api_client.models.json_api_metric_to_many_linkage import JsonApiMetricToManyLinkage +from gooddata_api_client.models.json_api_visualization_object_to_many_linkage import JsonApiVisualizationObjectToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py deleted file mode 100644 index 4537fa979..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py +++ /dev/null @@ -1,300 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAnalyticalDashboardOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'description': 'description', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_document.py deleted file mode 100644 index 014741396..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut - from gooddata_api_client.model.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAnalyticalDashboardOut'] = JsonApiAnalyticalDashboardOut - globals()['JsonApiAnalyticalDashboardOutIncludes'] = JsonApiAnalyticalDashboardOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiAnalyticalDashboardOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAnalyticalDashboardOut,), # noqa: E501 - 'included': ([JsonApiAnalyticalDashboardOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAnalyticalDashboardOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAnalyticalDashboardOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_document.pyi index 12ed5226f..cfa26f708 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_document.pyi @@ -134,6 +134,6 @@ class JsonApiAnalyticalDashboardOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut -from gooddata_api_client.model.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut +from gooddata_api_client.models.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_includes.py deleted file mode 100644 index 03416d2cf..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_includes.py +++ /dev/null @@ -1,377 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks - from gooddata_api_client.model.json_api_dashboard_plugin_out_attributes import JsonApiDashboardPluginOutAttributes - from gooddata_api_client.model.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships - from gooddata_api_client.model.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks - from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks - from gooddata_api_client.model.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks - from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks - from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks - from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks - from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAnalyticalDashboardOutWithLinks'] = JsonApiAnalyticalDashboardOutWithLinks - globals()['JsonApiDashboardPluginOutAttributes'] = JsonApiDashboardPluginOutAttributes - globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships - globals()['JsonApiDashboardPluginOutWithLinks'] = JsonApiDashboardPluginOutWithLinks - globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks - globals()['JsonApiFilterContextOutWithLinks'] = JsonApiFilterContextOutWithLinks - globals()['JsonApiLabelOutWithLinks'] = JsonApiLabelOutWithLinks - globals()['JsonApiMetricOutWithLinks'] = JsonApiMetricOutWithLinks - globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks - globals()['JsonApiVisualizationObjectOutWithLinks'] = JsonApiVisualizationObjectOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiAnalyticalDashboardOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DASHBOARDPLUGIN': "dashboardPlugin", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'links': (ObjectLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiDashboardPluginOutRelationships,), # noqa: E501 - 'attributes': (JsonApiDashboardPluginOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 - attributes (JsonApiDashboardPluginOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "dashboardPlugin" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 - attributes (JsonApiDashboardPluginOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "dashboardPlugin" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAnalyticalDashboardOutWithLinks, - JsonApiDashboardPluginOutWithLinks, - JsonApiDatasetOutWithLinks, - JsonApiFilterContextOutWithLinks, - JsonApiLabelOutWithLinks, - JsonApiMetricOutWithLinks, - JsonApiUserIdentifierOutWithLinks, - JsonApiVisualizationObjectOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_includes.pyi index e80e74396..e18e0f1c3 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_includes.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_includes.pyi @@ -35,7 +35,7 @@ class JsonApiAnalyticalDashboardOutIncludes( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -70,10 +70,10 @@ class JsonApiAnalyticalDashboardOutIncludes( **kwargs, ) -from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks -from gooddata_api_client.model.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks -from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks -from gooddata_api_client.model.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks -from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks -from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks -from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks +from gooddata_api_client.models.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.models.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.json_api_metric_out_with_links import JsonApiMetricOutWithLinks +from gooddata_api_client.models.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_list.py deleted file mode 100644 index 9f7131c31..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes - from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiAnalyticalDashboardOutIncludes'] = JsonApiAnalyticalDashboardOutIncludes - globals()['JsonApiAnalyticalDashboardOutWithLinks'] = JsonApiAnalyticalDashboardOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiAnalyticalDashboardOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiAnalyticalDashboardOutWithLinks],), # noqa: E501 - 'included': ([JsonApiAnalyticalDashboardOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutList - a model defined in OpenAPI - - Args: - data ([JsonApiAnalyticalDashboardOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAnalyticalDashboardOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutList - a model defined in OpenAPI - - Args: - data ([JsonApiAnalyticalDashboardOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAnalyticalDashboardOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_list.pyi index 2344416f0..ed3ffd267 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiAnalyticalDashboardOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiAnalyticalDashboardOutWithLinks']: return JsonApiAnalyticalDashboardOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiAnalyticalDashboardOutWithLinks'], typing.List['JsonApiAnalyticalDashboardOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiAnalyticalDashboardOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiAnalyticalDashboardOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiAnalyticalDashboardOutIncludes']: return JsonApiAnalyticalDashboardOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiAnalyticalDashboardOutIncludes'], typing.List['JsonApiAnalyticalDashboardOutIncludes']], @@ -91,10 +91,10 @@ class JsonApiAnalyticalDashboardOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiAnalyticalDashboardOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiAnalyticalDashboardOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,6 +158,6 @@ class JsonApiAnalyticalDashboardOutList( **kwargs, ) -from gooddata_api_client.model.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes -from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes +from gooddata_api_client.models.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_meta.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_meta.py deleted file mode 100644 index 8755ce6ff..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_meta.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta_origin import JsonApiAggregatedFactOutMetaOrigin - from gooddata_api_client.model.json_api_analytical_dashboard_out_meta_access_info import JsonApiAnalyticalDashboardOutMetaAccessInfo - globals()['JsonApiAggregatedFactOutMetaOrigin'] = JsonApiAggregatedFactOutMetaOrigin - globals()['JsonApiAnalyticalDashboardOutMetaAccessInfo'] = JsonApiAnalyticalDashboardOutMetaAccessInfo - - -class JsonApiAnalyticalDashboardOutMeta(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('permissions',): { - 'EDIT': "EDIT", - 'SHARE': "SHARE", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'access_info': (JsonApiAnalyticalDashboardOutMetaAccessInfo,), # noqa: E501 - 'origin': (JsonApiAggregatedFactOutMetaOrigin,), # noqa: E501 - 'permissions': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'access_info': 'accessInfo', # noqa: E501 - 'origin': 'origin', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - access_info (JsonApiAnalyticalDashboardOutMetaAccessInfo): [optional] # noqa: E501 - origin (JsonApiAggregatedFactOutMetaOrigin): [optional] # noqa: E501 - permissions ([str]): List of valid permissions for a logged-in user.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - access_info (JsonApiAnalyticalDashboardOutMetaAccessInfo): [optional] # noqa: E501 - origin (JsonApiAggregatedFactOutMetaOrigin): [optional] # noqa: E501 - permissions ([str]): List of valid permissions for a logged-in user.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_meta_access_info.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_meta_access_info.py deleted file mode 100644 index 8824419a1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_meta_access_info.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAnalyticalDashboardOutMetaAccessInfo(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'private': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'private': 'private', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, private, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutMetaAccessInfo - a model defined in OpenAPI - - Args: - private (bool): is the entity private to the currently logged-in user - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.private = private - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, private, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutMetaAccessInfo - a model defined in OpenAPI - - Args: - private (bool): is the entity private to the currently logged-in user - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.private = private - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships.py deleted file mode 100644 index 46dd683d0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships.py +++ /dev/null @@ -1,316 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_analytical_dashboards import JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_dashboard_plugins import JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_filter_contexts import JsonApiAnalyticalDashboardOutRelationshipsFilterContexts - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_visualization_objects import JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects - globals()['JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards'] = JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - globals()['JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins'] = JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins - globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets - globals()['JsonApiAnalyticalDashboardOutRelationshipsFilterContexts'] = JsonApiAnalyticalDashboardOutRelationshipsFilterContexts - globals()['JsonApiAnalyticalDashboardOutRelationshipsLabels'] = JsonApiAnalyticalDashboardOutRelationshipsLabels - globals()['JsonApiAnalyticalDashboardOutRelationshipsMetrics'] = JsonApiAnalyticalDashboardOutRelationshipsMetrics - globals()['JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects'] = JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects - - -class JsonApiAnalyticalDashboardOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'analytical_dashboards': (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'dashboard_plugins': (JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins,), # noqa: E501 - 'datasets': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 - 'filter_contexts': (JsonApiAnalyticalDashboardOutRelationshipsFilterContexts,), # noqa: E501 - 'labels': (JsonApiAnalyticalDashboardOutRelationshipsLabels,), # noqa: E501 - 'metrics': (JsonApiAnalyticalDashboardOutRelationshipsMetrics,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'visualization_objects': (JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'analytical_dashboards': 'analyticalDashboards', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'dashboard_plugins': 'dashboardPlugins', # noqa: E501 - 'datasets': 'datasets', # noqa: E501 - 'filter_contexts': 'filterContexts', # noqa: E501 - 'labels': 'labels', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - 'visualization_objects': 'visualizationObjects', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboards (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - dashboard_plugins (JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins): [optional] # noqa: E501 - datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - filter_contexts (JsonApiAnalyticalDashboardOutRelationshipsFilterContexts): [optional] # noqa: E501 - labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 - metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - visualization_objects (JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboards (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - dashboard_plugins (JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins): [optional] # noqa: E501 - datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - filter_contexts (JsonApiAnalyticalDashboardOutRelationshipsFilterContexts): [optional] # noqa: E501 - labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 - metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - visualization_objects (JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_analytical_dashboards.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_analytical_dashboards.py deleted file mode 100644 index 686141078..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_analytical_dashboards.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_to_many_linkage import JsonApiAnalyticalDashboardToManyLinkage - globals()['JsonApiAnalyticalDashboardToManyLinkage'] = JsonApiAnalyticalDashboardToManyLinkage - - -class JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAnalyticalDashboardToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_created_by.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_created_by.py deleted file mode 100644 index 3eb449668..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_created_by.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_identifier_to_one_linkage import JsonApiUserIdentifierToOneLinkage - globals()['JsonApiUserIdentifierToOneLinkage'] = JsonApiUserIdentifierToOneLinkage - - -class JsonApiAnalyticalDashboardOutRelationshipsCreatedBy(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserIdentifierToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - a model defined in OpenAPI - - Args: - data (JsonApiUserIdentifierToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - a model defined in OpenAPI - - Args: - data (JsonApiUserIdentifierToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_dashboard_plugins.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_dashboard_plugins.py deleted file mode 100644 index ac3fa75fc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_dashboard_plugins.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dashboard_plugin_to_many_linkage import JsonApiDashboardPluginToManyLinkage - globals()['JsonApiDashboardPluginToManyLinkage'] = JsonApiDashboardPluginToManyLinkage - - -class JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDashboardPluginToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins - a model defined in OpenAPI - - Args: - data (JsonApiDashboardPluginToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins - a model defined in OpenAPI - - Args: - data (JsonApiDashboardPluginToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_datasets.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_datasets.py deleted file mode 100644 index d546bf6f6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_datasets.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage - globals()['JsonApiDatasetToManyLinkage'] = JsonApiDatasetToManyLinkage - - -class JsonApiAnalyticalDashboardOutRelationshipsDatasets(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDatasetToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsDatasets - a model defined in OpenAPI - - Args: - data (JsonApiDatasetToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsDatasets - a model defined in OpenAPI - - Args: - data (JsonApiDatasetToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_filter_contexts.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_filter_contexts.py deleted file mode 100644 index e4dc845ff..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_filter_contexts.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_context_to_many_linkage import JsonApiFilterContextToManyLinkage - globals()['JsonApiFilterContextToManyLinkage'] = JsonApiFilterContextToManyLinkage - - -class JsonApiAnalyticalDashboardOutRelationshipsFilterContexts(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiFilterContextToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsFilterContexts - a model defined in OpenAPI - - Args: - data (JsonApiFilterContextToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsFilterContexts - a model defined in OpenAPI - - Args: - data (JsonApiFilterContextToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_labels.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_labels.py deleted file mode 100644 index 3fada8563..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_labels.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage - globals()['JsonApiLabelToManyLinkage'] = JsonApiLabelToManyLinkage - - -class JsonApiAnalyticalDashboardOutRelationshipsLabels(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiLabelToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsLabels - a model defined in OpenAPI - - Args: - data (JsonApiLabelToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsLabels - a model defined in OpenAPI - - Args: - data (JsonApiLabelToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_metrics.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_metrics.py deleted file mode 100644 index a1d8db63f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_metrics.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_to_many_linkage import JsonApiMetricToManyLinkage - globals()['JsonApiMetricToManyLinkage'] = JsonApiMetricToManyLinkage - - -class JsonApiAnalyticalDashboardOutRelationshipsMetrics(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiMetricToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsMetrics - a model defined in OpenAPI - - Args: - data (JsonApiMetricToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsMetrics - a model defined in OpenAPI - - Args: - data (JsonApiMetricToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_visualization_objects.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_visualization_objects.py deleted file mode 100644 index 0cabb38c5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_visualization_objects.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_visualization_object_to_many_linkage import JsonApiVisualizationObjectToManyLinkage - globals()['JsonApiVisualizationObjectToManyLinkage'] = JsonApiVisualizationObjectToManyLinkage - - -class JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiVisualizationObjectToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_with_links.py deleted file mode 100644 index edd0f6c99..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut - from gooddata_api_client.model.json_api_analytical_dashboard_out_attributes import JsonApiAnalyticalDashboardOutAttributes - from gooddata_api_client.model.json_api_analytical_dashboard_out_meta import JsonApiAnalyticalDashboardOutMeta - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships import JsonApiAnalyticalDashboardOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAnalyticalDashboardOut'] = JsonApiAnalyticalDashboardOut - globals()['JsonApiAnalyticalDashboardOutAttributes'] = JsonApiAnalyticalDashboardOutAttributes - globals()['JsonApiAnalyticalDashboardOutMeta'] = JsonApiAnalyticalDashboardOutMeta - globals()['JsonApiAnalyticalDashboardOutRelationships'] = JsonApiAnalyticalDashboardOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiAnalyticalDashboardOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAnalyticalDashboardOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAnalyticalDashboardOutMeta,), # noqa: E501 - 'relationships': (JsonApiAnalyticalDashboardOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiAnalyticalDashboardOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAnalyticalDashboardOutMeta): [optional] # noqa: E501 - relationships (JsonApiAnalyticalDashboardOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiAnalyticalDashboardOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAnalyticalDashboardOutMeta): [optional] # noqa: E501 - relationships (JsonApiAnalyticalDashboardOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiAnalyticalDashboardOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_with_links.pyi index 15c23ff76..dd70cc625 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiAnalyticalDashboardOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiAnalyticalDashboardOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch.py deleted file mode 100644 index c3e7a4cfc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_patch_attributes import JsonApiAnalyticalDashboardPatchAttributes - globals()['JsonApiAnalyticalDashboardPatchAttributes'] = JsonApiAnalyticalDashboardPatchAttributes - - -class JsonApiAnalyticalDashboardPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAnalyticalDashboardPatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch_attributes.py deleted file mode 100644 index f0c3b98aa..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch_attributes.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAnalyticalDashboardPatchAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'description': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'content': 'content', # noqa: E501 - 'description': 'description', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch_document.py deleted file mode 100644 index 3215cca9c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_patch import JsonApiAnalyticalDashboardPatch - globals()['JsonApiAnalyticalDashboardPatch'] = JsonApiAnalyticalDashboardPatch - - -class JsonApiAnalyticalDashboardPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAnalyticalDashboardPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch_document.pyi index e70901755..f8b476346 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiAnalyticalDashboardPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiAnalyticalDashboardPatch']: return JsonApiAnalyticalDashboardPatch __annotations__ = { "data": data, } - + data: 'JsonApiAnalyticalDashboardPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiAnalyticalDashboardPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_analytical_dashboard_patch import JsonApiAnalyticalDashboardPatch +from gooddata_api_client.models.json_api_analytical_dashboard_patch import JsonApiAnalyticalDashboardPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id.py deleted file mode 100644 index c441b4300..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes - globals()['JsonApiAnalyticalDashboardInAttributes'] = JsonApiAnalyticalDashboardInAttributes - - -class JsonApiAnalyticalDashboardPostOptionalId(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAnalyticalDashboardInAttributes,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - - Keyword Args: - type (str): Object type. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - - Keyword Args: - type (str): Object type. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "analyticalDashboard") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id_document.py deleted file mode 100644 index 43791191b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id import JsonApiAnalyticalDashboardPostOptionalId - globals()['JsonApiAnalyticalDashboardPostOptionalId'] = JsonApiAnalyticalDashboardPostOptionalId - - -class JsonApiAnalyticalDashboardPostOptionalIdDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAnalyticalDashboardPostOptionalId,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id_document.pyi index 76e2c7c65..af339a7be 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id_document.pyi @@ -38,38 +38,38 @@ class JsonApiAnalyticalDashboardPostOptionalIdDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiAnalyticalDashboardPostOptionalId']: return JsonApiAnalyticalDashboardPostOptionalId __annotations__ = { "data": data, } - + data: 'JsonApiAnalyticalDashboardPostOptionalId' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardPostOptionalId': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardPostOptionalId': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiAnalyticalDashboardPostOptionalIdDocument( **kwargs, ) -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id import JsonApiAnalyticalDashboardPostOptionalId +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id import JsonApiAnalyticalDashboardPostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_many_linkage.py deleted file mode 100644 index 344903ff6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_linkage import JsonApiAnalyticalDashboardLinkage - globals()['JsonApiAnalyticalDashboardLinkage'] = JsonApiAnalyticalDashboardLinkage - - -class JsonApiAnalyticalDashboardToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiAnalyticalDashboardLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiAnalyticalDashboardToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiAnalyticalDashboardLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiAnalyticalDashboardLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiAnalyticalDashboardToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiAnalyticalDashboardLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiAnalyticalDashboardLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_many_linkage.pyi index 025e059db..861598d21 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_many_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_many_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiAnalyticalDashboardToManyLinkage( class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiAnalyticalDashboardLinkage']: return JsonApiAnalyticalDashboardLinkage @@ -56,4 +56,4 @@ class JsonApiAnalyticalDashboardToManyLinkage( def __getitem__(self, i: int) -> 'JsonApiAnalyticalDashboardLinkage': return super().__getitem__(i) -from gooddata_api_client.model.json_api_analytical_dashboard_linkage import JsonApiAnalyticalDashboardLinkage +from gooddata_api_client.models.json_api_analytical_dashboard_linkage import JsonApiAnalyticalDashboardLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_one_linkage.py deleted file mode 100644 index 912d62756..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_linkage import JsonApiAnalyticalDashboardLinkage - globals()['JsonApiAnalyticalDashboardLinkage'] = JsonApiAnalyticalDashboardLinkage - - -class JsonApiAnalyticalDashboardToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ANALYTICALDASHBOARD': "analyticalDashboard", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "analyticalDashboard" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAnalyticalDashboardToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "analyticalDashboard" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAnalyticalDashboardLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_in.py deleted file mode 100644 index 44e2999a0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_in.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiApiTokenIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'APITOKEN': "apiToken", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "apiToken", must be one of ["apiToken", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "apiToken") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "apiToken", must be one of ["apiToken", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "apiToken") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_in_document.py deleted file mode 100644 index 2ac1ba6ed..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_api_token_in import JsonApiApiTokenIn - globals()['JsonApiApiTokenIn'] = JsonApiApiTokenIn - - -class JsonApiApiTokenInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiApiTokenIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenInDocument - a model defined in OpenAPI - - Args: - data (JsonApiApiTokenIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenInDocument - a model defined in OpenAPI - - Args: - data (JsonApiApiTokenIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_in_document.pyi index 62e382b7d..fbffc2683 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiApiTokenInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiApiTokenIn']: return JsonApiApiTokenIn __annotations__ = { "data": data, } - + data: 'JsonApiApiTokenIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiApiTokenIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiApiTokenIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiApiTokenInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_api_token_in import JsonApiApiTokenIn +from gooddata_api_client.models.json_api_api_token_in import JsonApiApiTokenIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out.py deleted file mode 100644 index 66a2bf146..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_api_token_out_attributes import JsonApiApiTokenOutAttributes - globals()['JsonApiApiTokenOutAttributes'] = JsonApiApiTokenOutAttributes - - -class JsonApiApiTokenOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'APITOKEN': "apiToken", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiApiTokenOutAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "apiToken", must be one of ["apiToken", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiApiTokenOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "apiToken") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "apiToken", must be one of ["apiToken", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiApiTokenOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "apiToken") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_attributes.py deleted file mode 100644 index 047e9f7b4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_attributes.py +++ /dev/null @@ -1,264 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiApiTokenOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'bearer_token': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'bearer_token': 'bearerToken', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - bearer_token (str): The value of the Bearer token. It is only returned when the API token is created.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - bearer_token (str): The value of the Bearer token. It is only returned when the API token is created.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_document.py deleted file mode 100644 index f543fa778..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_api_token_out import JsonApiApiTokenOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiApiTokenOut'] = JsonApiApiTokenOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiApiTokenOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiApiTokenOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiApiTokenOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiApiTokenOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_document.pyi index b00d8e3b6..e0ca48012 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiApiTokenOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiApiTokenOut']: return JsonApiApiTokenOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiApiTokenOutDocument( "data": data, "links": links, } - + data: 'JsonApiApiTokenOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiApiTokenOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiApiTokenOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiApiTokenOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_api_token_out import JsonApiApiTokenOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_api_token_out import JsonApiApiTokenOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list.py deleted file mode 100644 index ebca05551..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_api_token_out_with_links import JsonApiApiTokenOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiApiTokenOutWithLinks'] = JsonApiApiTokenOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiApiTokenOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiApiTokenOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenOutList - a model defined in OpenAPI - - Args: - data ([JsonApiApiTokenOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenOutList - a model defined in OpenAPI - - Args: - data ([JsonApiApiTokenOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list.pyi index 606f20bb9..65e7580fb 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiApiTokenOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiApiTokenOutWithLinks']: return JsonApiApiTokenOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiApiTokenOutWithLinks'], typing.List['JsonApiApiTokenOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiApiTokenOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiApiTokenOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiApiTokenOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiApiTokenOutList( **kwargs, ) -from gooddata_api_client.model.json_api_api_token_out_with_links import JsonApiApiTokenOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_api_token_out_with_links import JsonApiApiTokenOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_with_links.py deleted file mode 100644 index d29006ed5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_api_token_out import JsonApiApiTokenOut - from gooddata_api_client.model.json_api_api_token_out_attributes import JsonApiApiTokenOutAttributes - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiApiTokenOut'] = JsonApiApiTokenOut - globals()['JsonApiApiTokenOutAttributes'] = JsonApiApiTokenOutAttributes - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiApiTokenOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'APITOKEN': "apiToken", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiApiTokenOutAttributes,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "apiToken", must be one of ["apiToken", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiApiTokenOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "apiToken") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiApiTokenOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "apiToken", must be one of ["apiToken", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiApiTokenOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "apiToken") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiApiTokenOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_with_links.pyi index 45176f828..aed05c16a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_with_links.pyi @@ -65,5 +65,5 @@ class JsonApiApiTokenOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_api_token_out import JsonApiApiTokenOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_api_token_out import JsonApiApiTokenOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in.py deleted file mode 100644 index eaf2fc855..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_hierarchy_in_attributes import JsonApiAttributeHierarchyInAttributes - globals()['JsonApiAttributeHierarchyInAttributes'] = JsonApiAttributeHierarchyInAttributes - - -class JsonApiAttributeHierarchyIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTEHIERARCHY': "attributeHierarchy", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAttributeHierarchyInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "attributeHierarchy", must be one of ["attributeHierarchy", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attributeHierarchy") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "attributeHierarchy", must be one of ["attributeHierarchy", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attributeHierarchy") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in_attributes.py deleted file mode 100644 index e1dff406f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in_attributes.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAttributeHierarchyInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'description': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'content': 'content', # noqa: E501 - 'description': 'description', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in_document.py deleted file mode 100644 index b29f67037..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_hierarchy_in import JsonApiAttributeHierarchyIn - globals()['JsonApiAttributeHierarchyIn'] = JsonApiAttributeHierarchyIn - - -class JsonApiAttributeHierarchyInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAttributeHierarchyIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyInDocument - a model defined in OpenAPI - - Args: - data (JsonApiAttributeHierarchyIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyInDocument - a model defined in OpenAPI - - Args: - data (JsonApiAttributeHierarchyIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_linkage.py deleted file mode 100644 index d6149bd64..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAttributeHierarchyLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTEHIERARCHY': "attributeHierarchy", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "attributeHierarchy", must be one of ["attributeHierarchy", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "attributeHierarchy") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "attributeHierarchy", must be one of ["attributeHierarchy", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "attributeHierarchy") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out.py deleted file mode 100644 index c9555f846..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_attribute_hierarchy_out_attributes import JsonApiAttributeHierarchyOutAttributes - from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships import JsonApiAttributeHierarchyOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAttributeHierarchyOutAttributes'] = JsonApiAttributeHierarchyOutAttributes - globals()['JsonApiAttributeHierarchyOutRelationships'] = JsonApiAttributeHierarchyOutRelationships - - -class JsonApiAttributeHierarchyOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTEHIERARCHY': "attributeHierarchy", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAttributeHierarchyOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAttributeHierarchyOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "attributeHierarchy", must be one of ["attributeHierarchy", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeHierarchyOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attributeHierarchy") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "attributeHierarchy", must be one of ["attributeHierarchy", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeHierarchyOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attributeHierarchy") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_attributes.py deleted file mode 100644 index 1123140ec..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_attributes.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAttributeHierarchyOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'content': 'content', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'description': 'description', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_document.py deleted file mode 100644 index 23cddaf93..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_hierarchy_out import JsonApiAttributeHierarchyOut - from gooddata_api_client.model.json_api_attribute_hierarchy_out_includes import JsonApiAttributeHierarchyOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAttributeHierarchyOut'] = JsonApiAttributeHierarchyOut - globals()['JsonApiAttributeHierarchyOutIncludes'] = JsonApiAttributeHierarchyOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiAttributeHierarchyOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAttributeHierarchyOut,), # noqa: E501 - 'included': ([JsonApiAttributeHierarchyOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiAttributeHierarchyOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeHierarchyOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiAttributeHierarchyOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeHierarchyOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_includes.py deleted file mode 100644 index e2d58bec9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_includes.py +++ /dev/null @@ -1,359 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes - from gooddata_api_client.model.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships - from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks - from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAttributeOutAttributes'] = JsonApiAttributeOutAttributes - globals()['JsonApiAttributeOutRelationships'] = JsonApiAttributeOutRelationships - globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks - globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiAttributeHierarchyOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTE': "attribute", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAttributeOutAttributes,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAttributeOutRelationships,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "attribute" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "attribute" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAttributeOutWithLinks, - JsonApiUserIdentifierOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_list.py deleted file mode 100644 index 814890fb7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_attribute_hierarchy_out_includes import JsonApiAttributeHierarchyOutIncludes - from gooddata_api_client.model.json_api_attribute_hierarchy_out_with_links import JsonApiAttributeHierarchyOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiAttributeHierarchyOutIncludes'] = JsonApiAttributeHierarchyOutIncludes - globals()['JsonApiAttributeHierarchyOutWithLinks'] = JsonApiAttributeHierarchyOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiAttributeHierarchyOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiAttributeHierarchyOutWithLinks],), # noqa: E501 - 'included': ([JsonApiAttributeHierarchyOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutList - a model defined in OpenAPI - - Args: - data ([JsonApiAttributeHierarchyOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeHierarchyOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutList - a model defined in OpenAPI - - Args: - data ([JsonApiAttributeHierarchyOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeHierarchyOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships.py deleted file mode 100644 index 098b15b1b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - globals()['JsonApiAttributeHierarchyOutRelationshipsAttributes'] = JsonApiAttributeHierarchyOutRelationshipsAttributes - - -class JsonApiAttributeHierarchyOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships_attributes.py deleted file mode 100644 index f3b0a124b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships_attributes.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage - globals()['JsonApiAttributeToManyLinkage'] = JsonApiAttributeToManyLinkage - - -class JsonApiAttributeHierarchyOutRelationshipsAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAttributeToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutRelationshipsAttributes - a model defined in OpenAPI - - Args: - data (JsonApiAttributeToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutRelationshipsAttributes - a model defined in OpenAPI - - Args: - data (JsonApiAttributeToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_with_links.py deleted file mode 100644 index e7e4e0d2b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_attribute_hierarchy_out import JsonApiAttributeHierarchyOut - from gooddata_api_client.model.json_api_attribute_hierarchy_out_attributes import JsonApiAttributeHierarchyOutAttributes - from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships import JsonApiAttributeHierarchyOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAttributeHierarchyOut'] = JsonApiAttributeHierarchyOut - globals()['JsonApiAttributeHierarchyOutAttributes'] = JsonApiAttributeHierarchyOutAttributes - globals()['JsonApiAttributeHierarchyOutRelationships'] = JsonApiAttributeHierarchyOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiAttributeHierarchyOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTEHIERARCHY': "attributeHierarchy", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAttributeHierarchyOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAttributeHierarchyOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "attributeHierarchy", must be one of ["attributeHierarchy", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeHierarchyOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attributeHierarchy") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "attributeHierarchy", must be one of ["attributeHierarchy", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeHierarchyOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attributeHierarchy") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiAttributeHierarchyOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch.py deleted file mode 100644 index 325e62205..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_hierarchy_in_attributes import JsonApiAttributeHierarchyInAttributes - globals()['JsonApiAttributeHierarchyInAttributes'] = JsonApiAttributeHierarchyInAttributes - - -class JsonApiAttributeHierarchyPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTEHIERARCHY': "attributeHierarchy", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAttributeHierarchyInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "attributeHierarchy", must be one of ["attributeHierarchy", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attributeHierarchy") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "attributeHierarchy", must be one of ["attributeHierarchy", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attributeHierarchy") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch_document.py deleted file mode 100644 index c0c175889..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_hierarchy_patch import JsonApiAttributeHierarchyPatch - globals()['JsonApiAttributeHierarchyPatch'] = JsonApiAttributeHierarchyPatch - - -class JsonApiAttributeHierarchyPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAttributeHierarchyPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiAttributeHierarchyPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeHierarchyPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiAttributeHierarchyPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_to_many_linkage.py deleted file mode 100644 index 7037b3f6e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_hierarchy_linkage import JsonApiAttributeHierarchyLinkage - globals()['JsonApiAttributeHierarchyLinkage'] = JsonApiAttributeHierarchyLinkage - - -class JsonApiAttributeHierarchyToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiAttributeHierarchyLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiAttributeHierarchyToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiAttributeHierarchyLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiAttributeHierarchyLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiAttributeHierarchyToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiAttributeHierarchyLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiAttributeHierarchyLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_linkage.py deleted file mode 100644 index c3adc5021..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAttributeLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTE': "attribute", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "attribute", must be one of ["attribute", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "attribute") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "attribute", must be one of ["attribute", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "attribute") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out.py deleted file mode 100644 index 47ab51f12..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes - from gooddata_api_client.model.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAttributeOutAttributes'] = JsonApiAttributeOutAttributes - globals()['JsonApiAttributeOutRelationships'] = JsonApiAttributeOutRelationships - - -class JsonApiAttributeOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTE': "attribute", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAttributeOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAttributeOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "attribute", must be one of ["attribute", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attribute") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "attribute", must be one of ["attribute", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attribute") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out.pyi index 8895609f1..ab7ef377e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out.pyi @@ -41,177 +41,177 @@ class JsonApiAttributeOut( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ATTRIBUTE(cls): return cls("attribute") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: areRelationsValid = schemas.BoolSchema - - + + class description( schemas.StrSchema ): pass - - + + class granularity( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def MINUTE(cls): return cls("MINUTE") - + @schemas.classproperty def HOUR(cls): return cls("HOUR") - + @schemas.classproperty def DAY(cls): return cls("DAY") - + @schemas.classproperty def WEEK(cls): return cls("WEEK") - + @schemas.classproperty def MONTH(cls): return cls("MONTH") - + @schemas.classproperty def QUARTER(cls): return cls("QUARTER") - + @schemas.classproperty def YEAR(cls): return cls("YEAR") - + @schemas.classproperty def MINUTE_OF_HOUR(cls): return cls("MINUTE_OF_HOUR") - + @schemas.classproperty def HOUR_OF_DAY(cls): return cls("HOUR_OF_DAY") - + @schemas.classproperty def DAY_OF_WEEK(cls): return cls("DAY_OF_WEEK") - + @schemas.classproperty def DAY_OF_MONTH(cls): return cls("DAY_OF_MONTH") - + @schemas.classproperty def DAY_OF_YEAR(cls): return cls("DAY_OF_YEAR") - + @schemas.classproperty def WEEK_OF_YEAR(cls): return cls("WEEK_OF_YEAR") - + @schemas.classproperty def MONTH_OF_YEAR(cls): return cls("MONTH_OF_YEAR") - + @schemas.classproperty def QUARTER_OF_YEAR(cls): return cls("QUARTER_OF_YEAR") - - + + class sortColumn( schemas.StrSchema ): pass - - + + class sortDirection( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ASC(cls): return cls("ASC") - + @schemas.classproperty def DESC(cls): return cls("DESC") - - + + class sourceColumn( schemas.StrSchema ): pass - - + + class sourceColumnDataType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def INT(cls): return cls("INT") - + @schemas.classproperty def STRING(cls): return cls("STRING") - + @schemas.classproperty def DATE(cls): return cls("DATE") - + @schemas.classproperty def NUMERIC(cls): return cls("NUMERIC") - + @schemas.classproperty def TIMESTAMP(cls): return cls("TIMESTAMP") - + @schemas.classproperty def TIMESTAMP_TZ(cls): return cls("TIMESTAMP_TZ") - + @schemas.classproperty def BOOLEAN(cls): return cls("BOOLEAN") - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -222,11 +222,11 @@ class JsonApiAttributeOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): @@ -242,76 +242,76 @@ class JsonApiAttributeOut( "tags": tags, "title": title, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sortColumn"]) -> MetaOapg.properties.sortColumn: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sortDirection"]) -> MetaOapg.properties.sortDirection: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sourceColumn"]) -> MetaOapg.properties.sourceColumn: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> MetaOapg.properties.sourceColumnDataType: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "granularity", "sortColumn", "sortDirection", "sourceColumn", "sourceColumnDataType", "tags", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> typing.Union[MetaOapg.properties.granularity, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sortColumn"]) -> typing.Union[MetaOapg.properties.sortColumn, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sortDirection"]) -> typing.Union[MetaOapg.properties.sortDirection, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sourceColumn"]) -> typing.Union[MetaOapg.properties.sourceColumn, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> typing.Union[MetaOapg.properties.sourceColumnDataType, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "granularity", "sortColumn", "sortDirection", "sourceColumn", "sourceColumnDataType", "tags", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -342,42 +342,42 @@ class JsonApiAttributeOut( _configuration=_configuration, **kwargs, ) - - + + class meta( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class origin( schemas.DictSchema ): - - + + class MetaOapg: required = { "originType", "originId", } - + class properties: originId = schemas.StrSchema - - + + class originType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") - + @schemas.classproperty def PARENT(cls): return cls("PARENT") @@ -385,37 +385,37 @@ class JsonApiAttributeOut( "originId": originId, "originType": originType, } - + originType: MetaOapg.properties.originType originId: MetaOapg.properties.originId - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -435,28 +435,28 @@ class JsonApiAttributeOut( __annotations__ = { "origin": origin, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -471,60 +471,60 @@ class JsonApiAttributeOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class dataset( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDatasetToOneLinkage']: return JsonApiDatasetToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiDatasetToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -539,50 +539,50 @@ class JsonApiAttributeOut( _configuration=_configuration, **kwargs, ) - - + + class defaultView( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiLabelToOneLinkage']: return JsonApiLabelToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiLabelToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -597,50 +597,50 @@ class JsonApiAttributeOut( _configuration=_configuration, **kwargs, ) - - + + class labels( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiLabelToManyLinkage']: return JsonApiLabelToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiLabelToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -660,40 +660,40 @@ class JsonApiAttributeOut( "defaultView": defaultView, "labels": labels, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataset"]) -> MetaOapg.properties.dataset: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["defaultView"]) -> MetaOapg.properties.defaultView: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["labels"]) -> MetaOapg.properties.labels: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataset", "defaultView", "labels", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataset"]) -> typing.Union[MetaOapg.properties.dataset, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["defaultView"]) -> typing.Union[MetaOapg.properties.defaultView, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["labels"]) -> typing.Union[MetaOapg.properties.labels, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataset", "defaultView", "labels", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -719,54 +719,54 @@ class JsonApiAttributeOut( "meta": meta, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -791,6 +791,6 @@ class JsonApiAttributeOut( **kwargs, ) -from gooddata_api_client.model.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage -from gooddata_api_client.model.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage -from gooddata_api_client.model.json_api_label_to_one_linkage import JsonApiLabelToOneLinkage +from gooddata_api_client.models.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage +from gooddata_api_client.models.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage +from gooddata_api_client.models.json_api_label_to_one_linkage import JsonApiLabelToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes.py deleted file mode 100644 index 2c6fdafba..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes.py +++ /dev/null @@ -1,343 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAttributeOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularity',): { - 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", - 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", - 'HOUR_OF_DAY': "HOUR_OF_DAY", - 'DAY_OF_WEEK': "DAY_OF_WEEK", - 'DAY_OF_MONTH': "DAY_OF_MONTH", - 'DAY_OF_QUARTER': "DAY_OF_QUARTER", - 'DAY_OF_YEAR': "DAY_OF_YEAR", - 'WEEK_OF_YEAR': "WEEK_OF_YEAR", - 'MONTH_OF_YEAR': "MONTH_OF_YEAR", - 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", - }, - ('sort_direction',): { - 'ASC': "ASC", - 'DESC': "DESC", - }, - ('source_column_data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('sort_column',): { - 'max_length': 255, - }, - ('source_column',): { - 'max_length': 255, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'granularity': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'sort_column': (str,), # noqa: E501 - 'sort_direction': (str,), # noqa: E501 - 'source_column': (str,), # noqa: E501 - 'source_column_data_type': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'description': 'description', # noqa: E501 - 'granularity': 'granularity', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'sort_column': 'sortColumn', # noqa: E501 - 'sort_direction': 'sortDirection', # noqa: E501 - 'source_column': 'sourceColumn', # noqa: E501 - 'source_column_data_type': 'sourceColumnDataType', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - sort_column (str): [optional] # noqa: E501 - sort_direction (str): [optional] # noqa: E501 - source_column (str): [optional] # noqa: E501 - source_column_data_type (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - sort_column (str): [optional] # noqa: E501 - sort_direction (str): [optional] # noqa: E501 - source_column (str): [optional] # noqa: E501 - source_column_data_type (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_document.py deleted file mode 100644 index 4e1f8d66b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_out import JsonApiAttributeOut - from gooddata_api_client.model.json_api_attribute_out_includes import JsonApiAttributeOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAttributeOut'] = JsonApiAttributeOut - globals()['JsonApiAttributeOutIncludes'] = JsonApiAttributeOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiAttributeOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAttributeOut,), # noqa: E501 - 'included': ([JsonApiAttributeOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiAttributeOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiAttributeOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_document.pyi index 6706e6b4d..fd62f2d47 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiAttributeOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiAttributeOut']: return JsonApiAttributeOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiAttributeOutIncludes']: return JsonApiAttributeOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiAttributeOutIncludes'], typing.List['JsonApiAttributeOutIncludes']], @@ -67,10 +67,10 @@ class JsonApiAttributeOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiAttributeOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiAttributeOutDocument( "included": included, "links": links, } - + data: 'JsonApiAttributeOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiAttributeOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_out import JsonApiAttributeOut -from gooddata_api_client.model.json_api_attribute_out_includes import JsonApiAttributeOutIncludes -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_attribute_out import JsonApiAttributeOut +from gooddata_api_client.models.json_api_attribute_out_includes import JsonApiAttributeOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_includes.py deleted file mode 100644 index 6138fbe41..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_includes.py +++ /dev/null @@ -1,362 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_attribute_hierarchy_out_attributes import JsonApiAttributeHierarchyOutAttributes - from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships import JsonApiAttributeHierarchyOutRelationships - from gooddata_api_client.model.json_api_attribute_hierarchy_out_with_links import JsonApiAttributeHierarchyOutWithLinks - from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks - from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAttributeHierarchyOutAttributes'] = JsonApiAttributeHierarchyOutAttributes - globals()['JsonApiAttributeHierarchyOutRelationships'] = JsonApiAttributeHierarchyOutRelationships - globals()['JsonApiAttributeHierarchyOutWithLinks'] = JsonApiAttributeHierarchyOutWithLinks - globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks - globals()['JsonApiLabelOutWithLinks'] = JsonApiLabelOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiAttributeOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTEHIERARCHY': "attributeHierarchy", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAttributeHierarchyOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - 'attributes': (JsonApiAttributeHierarchyOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeHierarchyOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiAttributeHierarchyOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "attributeHierarchy" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeHierarchyOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiAttributeHierarchyOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "attributeHierarchy" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAttributeHierarchyOutWithLinks, - JsonApiDatasetOutWithLinks, - JsonApiLabelOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_includes.pyi index 340848eda..3176de172 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_includes.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_includes.pyi @@ -35,7 +35,7 @@ class JsonApiAttributeOutIncludes( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -65,5 +65,5 @@ class JsonApiAttributeOutIncludes( **kwargs, ) -from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks -from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_list.py deleted file mode 100644 index 6879fd060..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_attribute_out_includes import JsonApiAttributeOutIncludes - from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiAttributeOutIncludes'] = JsonApiAttributeOutIncludes - globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiAttributeOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiAttributeOutWithLinks],), # noqa: E501 - 'included': ([JsonApiAttributeOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutList - a model defined in OpenAPI - - Args: - data ([JsonApiAttributeOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutList - a model defined in OpenAPI - - Args: - data ([JsonApiAttributeOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_list.pyi index 45bb281f4..581f4e48e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiAttributeOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiAttributeOutWithLinks']: return JsonApiAttributeOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiAttributeOutWithLinks'], typing.List['JsonApiAttributeOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiAttributeOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiAttributeOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiAttributeOutIncludes']: return JsonApiAttributeOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiAttributeOutIncludes'], typing.List['JsonApiAttributeOutIncludes']], @@ -91,10 +91,10 @@ class JsonApiAttributeOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiAttributeOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiAttributeOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,6 +158,6 @@ class JsonApiAttributeOutList( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_out_includes import JsonApiAttributeOutIncludes -from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_attribute_out_includes import JsonApiAttributeOutIncludes +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_relationships.py deleted file mode 100644 index 131e9f92a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_relationships.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_relationships_dataset import JsonApiAggregatedFactOutRelationshipsDataset - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels - from gooddata_api_client.model.json_api_attribute_out_relationships_attribute_hierarchies import JsonApiAttributeOutRelationshipsAttributeHierarchies - from gooddata_api_client.model.json_api_attribute_out_relationships_default_view import JsonApiAttributeOutRelationshipsDefaultView - globals()['JsonApiAggregatedFactOutRelationshipsDataset'] = JsonApiAggregatedFactOutRelationshipsDataset - globals()['JsonApiAnalyticalDashboardOutRelationshipsLabels'] = JsonApiAnalyticalDashboardOutRelationshipsLabels - globals()['JsonApiAttributeOutRelationshipsAttributeHierarchies'] = JsonApiAttributeOutRelationshipsAttributeHierarchies - globals()['JsonApiAttributeOutRelationshipsDefaultView'] = JsonApiAttributeOutRelationshipsDefaultView - - -class JsonApiAttributeOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute_hierarchies': (JsonApiAttributeOutRelationshipsAttributeHierarchies,), # noqa: E501 - 'dataset': (JsonApiAggregatedFactOutRelationshipsDataset,), # noqa: E501 - 'default_view': (JsonApiAttributeOutRelationshipsDefaultView,), # noqa: E501 - 'labels': (JsonApiAnalyticalDashboardOutRelationshipsLabels,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute_hierarchies': 'attributeHierarchies', # noqa: E501 - 'dataset': 'dataset', # noqa: E501 - 'default_view': 'defaultView', # noqa: E501 - 'labels': 'labels', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute_hierarchies (JsonApiAttributeOutRelationshipsAttributeHierarchies): [optional] # noqa: E501 - dataset (JsonApiAggregatedFactOutRelationshipsDataset): [optional] # noqa: E501 - default_view (JsonApiAttributeOutRelationshipsDefaultView): [optional] # noqa: E501 - labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute_hierarchies (JsonApiAttributeOutRelationshipsAttributeHierarchies): [optional] # noqa: E501 - dataset (JsonApiAggregatedFactOutRelationshipsDataset): [optional] # noqa: E501 - default_view (JsonApiAttributeOutRelationshipsDefaultView): [optional] # noqa: E501 - labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_relationships_attribute_hierarchies.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_relationships_attribute_hierarchies.py deleted file mode 100644 index 83135fef3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_relationships_attribute_hierarchies.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_hierarchy_to_many_linkage import JsonApiAttributeHierarchyToManyLinkage - globals()['JsonApiAttributeHierarchyToManyLinkage'] = JsonApiAttributeHierarchyToManyLinkage - - -class JsonApiAttributeOutRelationshipsAttributeHierarchies(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAttributeHierarchyToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutRelationshipsAttributeHierarchies - a model defined in OpenAPI - - Args: - data (JsonApiAttributeHierarchyToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutRelationshipsAttributeHierarchies - a model defined in OpenAPI - - Args: - data (JsonApiAttributeHierarchyToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_relationships_default_view.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_relationships_default_view.py deleted file mode 100644 index ffb6d551d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_relationships_default_view.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_label_to_one_linkage import JsonApiLabelToOneLinkage - globals()['JsonApiLabelToOneLinkage'] = JsonApiLabelToOneLinkage - - -class JsonApiAttributeOutRelationshipsDefaultView(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiLabelToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutRelationshipsDefaultView - a model defined in OpenAPI - - Args: - data (JsonApiLabelToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutRelationshipsDefaultView - a model defined in OpenAPI - - Args: - data (JsonApiLabelToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_with_links.py deleted file mode 100644 index c4b232f26..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_attribute_out import JsonApiAttributeOut - from gooddata_api_client.model.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes - from gooddata_api_client.model.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAttributeOut'] = JsonApiAttributeOut - globals()['JsonApiAttributeOutAttributes'] = JsonApiAttributeOutAttributes - globals()['JsonApiAttributeOutRelationships'] = JsonApiAttributeOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiAttributeOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTE': "attribute", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAttributeOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAttributeOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "attribute", must be one of ["attribute", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attribute") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAttributeOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "attribute", must be one of ["attribute", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "attribute") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiAttributeOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_with_links.pyi index feb1d47ad..3a11fedeb 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiAttributeOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiAttributeOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_out import JsonApiAttributeOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_attribute_out import JsonApiAttributeOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_many_linkage.py deleted file mode 100644 index ff970997c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_linkage import JsonApiAttributeLinkage - globals()['JsonApiAttributeLinkage'] = JsonApiAttributeLinkage - - -class JsonApiAttributeToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiAttributeLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiAttributeToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiAttributeLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiAttributeLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiAttributeToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiAttributeLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiAttributeLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_many_linkage.pyi index 44a9052eb..a43c1f84d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_many_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_many_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiAttributeToManyLinkage( class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiAttributeLinkage']: return JsonApiAttributeLinkage @@ -56,4 +56,4 @@ class JsonApiAttributeToManyLinkage( def __getitem__(self, i: int) -> 'JsonApiAttributeLinkage': return super().__getitem__(i) -from gooddata_api_client.model.json_api_attribute_linkage import JsonApiAttributeLinkage +from gooddata_api_client.models.json_api_attribute_linkage import JsonApiAttributeLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_one_linkage.py deleted file mode 100644 index f17b256bc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_linkage import JsonApiAttributeLinkage - globals()['JsonApiAttributeLinkage'] = JsonApiAttributeLinkage - - -class JsonApiAttributeToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTE': "attribute", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAttributeToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "attribute" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAttributeToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "attribute" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAttributeLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_one_linkage.pyi index 37030560c..9bded5f48 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_one_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_to_one_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiAttributeToOneLinkage( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -66,4 +66,4 @@ class JsonApiAttributeToOneLinkage( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_linkage import JsonApiAttributeLinkage +from gooddata_api_client.models.json_api_attribute_linkage import JsonApiAttributeLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in.py deleted file mode 100644 index 754e458af..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_in_attributes import JsonApiAutomationInAttributes - from gooddata_api_client.model.json_api_automation_in_relationships import JsonApiAutomationInRelationships - globals()['JsonApiAutomationInAttributes'] = JsonApiAutomationInAttributes - globals()['JsonApiAutomationInRelationships'] = JsonApiAutomationInRelationships - - -class JsonApiAutomationIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AUTOMATION': "automation", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAutomationInAttributes,), # noqa: E501 - 'relationships': (JsonApiAutomationInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "automation", must be one of ["automation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationInAttributes): [optional] # noqa: E501 - relationships (JsonApiAutomationInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "automation", must be one of ["automation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationInAttributes): [optional] # noqa: E501 - relationships (JsonApiAutomationInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes.py deleted file mode 100644 index 80923dc45..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes.py +++ /dev/null @@ -1,368 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert - from gooddata_api_client.model.json_api_automation_in_attributes_dashboard_tabular_exports_inner import JsonApiAutomationInAttributesDashboardTabularExportsInner - from gooddata_api_client.model.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner - from gooddata_api_client.model.json_api_automation_in_attributes_image_exports_inner import JsonApiAutomationInAttributesImageExportsInner - from gooddata_api_client.model.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata - from gooddata_api_client.model.json_api_automation_in_attributes_raw_exports_inner import JsonApiAutomationInAttributesRawExportsInner - from gooddata_api_client.model.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule - from gooddata_api_client.model.json_api_automation_in_attributes_slides_exports_inner import JsonApiAutomationInAttributesSlidesExportsInner - from gooddata_api_client.model.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner - from gooddata_api_client.model.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner - globals()['JsonApiAutomationInAttributesAlert'] = JsonApiAutomationInAttributesAlert - globals()['JsonApiAutomationInAttributesDashboardTabularExportsInner'] = JsonApiAutomationInAttributesDashboardTabularExportsInner - globals()['JsonApiAutomationInAttributesExternalRecipientsInner'] = JsonApiAutomationInAttributesExternalRecipientsInner - globals()['JsonApiAutomationInAttributesImageExportsInner'] = JsonApiAutomationInAttributesImageExportsInner - globals()['JsonApiAutomationInAttributesMetadata'] = JsonApiAutomationInAttributesMetadata - globals()['JsonApiAutomationInAttributesRawExportsInner'] = JsonApiAutomationInAttributesRawExportsInner - globals()['JsonApiAutomationInAttributesSchedule'] = JsonApiAutomationInAttributesSchedule - globals()['JsonApiAutomationInAttributesSlidesExportsInner'] = JsonApiAutomationInAttributesSlidesExportsInner - globals()['JsonApiAutomationInAttributesTabularExportsInner'] = JsonApiAutomationInAttributesTabularExportsInner - globals()['JsonApiAutomationInAttributesVisualExportsInner'] = JsonApiAutomationInAttributesVisualExportsInner - - -class JsonApiAutomationInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('evaluation_mode',): { - 'SHARED': "SHARED", - 'PER_RECIPIENT': "PER_RECIPIENT", - }, - ('state',): { - 'ACTIVE': "ACTIVE", - 'PAUSED': "PAUSED", - }, - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('details',): { - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'alert': (JsonApiAutomationInAttributesAlert,), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'dashboard_tabular_exports': ([JsonApiAutomationInAttributesDashboardTabularExportsInner],), # noqa: E501 - 'description': (str,), # noqa: E501 - 'details': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'evaluation_mode': (str,), # noqa: E501 - 'external_recipients': ([JsonApiAutomationInAttributesExternalRecipientsInner],), # noqa: E501 - 'image_exports': ([JsonApiAutomationInAttributesImageExportsInner],), # noqa: E501 - 'metadata': (JsonApiAutomationInAttributesMetadata,), # noqa: E501 - 'raw_exports': ([JsonApiAutomationInAttributesRawExportsInner],), # noqa: E501 - 'schedule': (JsonApiAutomationInAttributesSchedule,), # noqa: E501 - 'slides_exports': ([JsonApiAutomationInAttributesSlidesExportsInner],), # noqa: E501 - 'state': (str,), # noqa: E501 - 'tabular_exports': ([JsonApiAutomationInAttributesTabularExportsInner],), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - 'visual_exports': ([JsonApiAutomationInAttributesVisualExportsInner],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'alert': 'alert', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'dashboard_tabular_exports': 'dashboardTabularExports', # noqa: E501 - 'description': 'description', # noqa: E501 - 'details': 'details', # noqa: E501 - 'evaluation_mode': 'evaluationMode', # noqa: E501 - 'external_recipients': 'externalRecipients', # noqa: E501 - 'image_exports': 'imageExports', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - 'raw_exports': 'rawExports', # noqa: E501 - 'schedule': 'schedule', # noqa: E501 - 'slides_exports': 'slidesExports', # noqa: E501 - 'state': 'state', # noqa: E501 - 'tabular_exports': 'tabularExports', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - 'visual_exports': 'visualExports', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - alert (JsonApiAutomationInAttributesAlert): [optional] # noqa: E501 - are_relations_valid (bool): [optional] # noqa: E501 - dashboard_tabular_exports ([JsonApiAutomationInAttributesDashboardTabularExportsInner]): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Additional details to be included in the automated message.. [optional] # noqa: E501 - evaluation_mode (str): Specify automation evaluation mode.. [optional] # noqa: E501 - external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 - image_exports ([JsonApiAutomationInAttributesImageExportsInner]): [optional] # noqa: E501 - metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 - raw_exports ([JsonApiAutomationInAttributesRawExportsInner]): [optional] # noqa: E501 - schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 - slides_exports ([JsonApiAutomationInAttributesSlidesExportsInner]): [optional] # noqa: E501 - state (str): Current state of the automation.. [optional] # noqa: E501 - tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - alert (JsonApiAutomationInAttributesAlert): [optional] # noqa: E501 - are_relations_valid (bool): [optional] # noqa: E501 - dashboard_tabular_exports ([JsonApiAutomationInAttributesDashboardTabularExportsInner]): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Additional details to be included in the automated message.. [optional] # noqa: E501 - evaluation_mode (str): Specify automation evaluation mode.. [optional] # noqa: E501 - external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 - image_exports ([JsonApiAutomationInAttributesImageExportsInner]): [optional] # noqa: E501 - metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 - raw_exports ([JsonApiAutomationInAttributesRawExportsInner]): [optional] # noqa: E501 - schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 - slides_exports ([JsonApiAutomationInAttributesSlidesExportsInner]): [optional] # noqa: E501 - state (str): Current state of the automation.. [optional] # noqa: E501 - tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_alert.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_alert.py deleted file mode 100644 index 98df186e7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_alert.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.alert_afm import AlertAfm - from gooddata_api_client.model.alert_condition import AlertCondition - globals()['AlertAfm'] = AlertAfm - globals()['AlertCondition'] = AlertCondition - - -class JsonApiAutomationInAttributesAlert(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('trigger',): { - 'ALWAYS': "ALWAYS", - 'ONCE': "ONCE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'condition': (AlertCondition,), # noqa: E501 - 'execution': (AlertAfm,), # noqa: E501 - 'trigger': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'condition': 'condition', # noqa: E501 - 'execution': 'execution', # noqa: E501 - 'trigger': 'trigger', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, condition, execution, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesAlert - a model defined in OpenAPI - - Args: - condition (AlertCondition): - execution (AlertAfm): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.condition = condition - self.execution = execution - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, condition, execution, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesAlert - a model defined in OpenAPI - - Args: - condition (AlertCondition): - execution (AlertAfm): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.condition = condition - self.execution = execution - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_dashboard_tabular_exports_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_dashboard_tabular_exports_inner.py deleted file mode 100644 index 0d8f4fc4e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_dashboard_tabular_exports_inner.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 - globals()['DashboardTabularExportRequestV2'] = DashboardTabularExportRequestV2 - - -class JsonApiAutomationInAttributesDashboardTabularExportsInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (DashboardTabularExportRequestV2,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesDashboardTabularExportsInner - a model defined in OpenAPI - - Args: - request_payload (DashboardTabularExportRequestV2): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesDashboardTabularExportsInner - a model defined in OpenAPI - - Args: - request_payload (DashboardTabularExportRequestV2): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_external_recipients_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_external_recipients_inner.py deleted file mode 100644 index fa4530ad2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_external_recipients_inner.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAutomationInAttributesExternalRecipientsInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'email': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'email': 'email', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, email, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesExternalRecipientsInner - a model defined in OpenAPI - - Args: - email (str): E-mail address to send notifications from. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.email = email - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, email, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesExternalRecipientsInner - a model defined in OpenAPI - - Args: - email (str): E-mail address to send notifications from. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.email = email - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_image_exports_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_image_exports_inner.py deleted file mode 100644 index 00b363f69..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_image_exports_inner.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.image_export_request import ImageExportRequest - globals()['ImageExportRequest'] = ImageExportRequest - - -class JsonApiAutomationInAttributesImageExportsInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (ImageExportRequest,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesImageExportsInner - a model defined in OpenAPI - - Args: - request_payload (ImageExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesImageExportsInner - a model defined in OpenAPI - - Args: - request_payload (ImageExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_metadata.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_metadata.py deleted file mode 100644 index 61e1fdf3b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_metadata.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.visible_filter import VisibleFilter - globals()['VisibleFilter'] = VisibleFilter - - -class JsonApiAutomationInAttributesMetadata(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('value',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'visible_filters': ([VisibleFilter],), # noqa: E501 - 'widget': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'visible_filters': 'visibleFilters', # noqa: E501 - 'widget': 'widget', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesMetadata - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - visible_filters ([VisibleFilter]): [optional] # noqa: E501 - widget (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesMetadata - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - visible_filters ([VisibleFilter]): [optional] # noqa: E501 - widget (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_raw_exports_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_raw_exports_inner.py deleted file mode 100644 index 431c0c82a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_raw_exports_inner.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.raw_export_automation_request import RawExportAutomationRequest - globals()['RawExportAutomationRequest'] = RawExportAutomationRequest - - -class JsonApiAutomationInAttributesRawExportsInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (RawExportAutomationRequest,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesRawExportsInner - a model defined in OpenAPI - - Args: - request_payload (RawExportAutomationRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesRawExportsInner - a model defined in OpenAPI - - Args: - request_payload (RawExportAutomationRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_schedule.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_schedule.py deleted file mode 100644 index d7a62d544..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_schedule.py +++ /dev/null @@ -1,291 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAutomationInAttributesSchedule(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('cron',): { - 'max_length': 255, - }, - ('timezone',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'cron': (str,), # noqa: E501 - 'timezone': (str,), # noqa: E501 - 'cron_description': (str,), # noqa: E501 - 'first_run': (datetime,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'cron': 'cron', # noqa: E501 - 'timezone': 'timezone', # noqa: E501 - 'cron_description': 'cronDescription', # noqa: E501 - 'first_run': 'firstRun', # noqa: E501 - } - - read_only_vars = { - 'cron_description', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, cron, timezone, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesSchedule - a model defined in OpenAPI - - Args: - cron (str): Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays. - timezone (str): Timezone in which the schedule is defined. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cron_description (str): Human-readable description of the cron expression.. [optional] # noqa: E501 - first_run (datetime): Timestamp of the first scheduled action. If not provided default to the next scheduled time.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.cron = cron - self.timezone = timezone - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, cron, timezone, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesSchedule - a model defined in OpenAPI - - Args: - cron (str): Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays. - timezone (str): Timezone in which the schedule is defined. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cron_description (str): Human-readable description of the cron expression.. [optional] # noqa: E501 - first_run (datetime): Timestamp of the first scheduled action. If not provided default to the next scheduled time.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.cron = cron - self.timezone = timezone - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_slides_exports_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_slides_exports_inner.py deleted file mode 100644 index 62c074697..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_slides_exports_inner.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.slides_export_request import SlidesExportRequest - globals()['SlidesExportRequest'] = SlidesExportRequest - - -class JsonApiAutomationInAttributesSlidesExportsInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (SlidesExportRequest,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesSlidesExportsInner - a model defined in OpenAPI - - Args: - request_payload (SlidesExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesSlidesExportsInner - a model defined in OpenAPI - - Args: - request_payload (SlidesExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_tabular_exports_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_tabular_exports_inner.py deleted file mode 100644 index 39b37f935..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_tabular_exports_inner.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.tabular_export_request import TabularExportRequest - globals()['TabularExportRequest'] = TabularExportRequest - - -class JsonApiAutomationInAttributesTabularExportsInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (TabularExportRequest,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesTabularExportsInner - a model defined in OpenAPI - - Args: - request_payload (TabularExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesTabularExportsInner - a model defined in OpenAPI - - Args: - request_payload (TabularExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_visual_exports_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_visual_exports_inner.py deleted file mode 100644 index 8f7b1b64c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_visual_exports_inner.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.visual_export_request import VisualExportRequest - globals()['VisualExportRequest'] = VisualExportRequest - - -class JsonApiAutomationInAttributesVisualExportsInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'request_payload': (VisualExportRequest,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'request_payload': 'requestPayload', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesVisualExportsInner - a model defined in OpenAPI - - Args: - request_payload (VisualExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, request_payload, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInAttributesVisualExportsInner - a model defined in OpenAPI - - Args: - request_payload (VisualExportRequest): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.request_payload = request_payload - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_document.py deleted file mode 100644 index 6235128cb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_in import JsonApiAutomationIn - globals()['JsonApiAutomationIn'] = JsonApiAutomationIn - - -class JsonApiAutomationInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAutomationIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInDocument - a model defined in OpenAPI - - Args: - data (JsonApiAutomationIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInDocument - a model defined in OpenAPI - - Args: - data (JsonApiAutomationIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships.py deleted file mode 100644 index f97aa5137..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard - from gooddata_api_client.model.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions - from gooddata_api_client.model.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel - from gooddata_api_client.model.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients - globals()['JsonApiAutomationInRelationshipsAnalyticalDashboard'] = JsonApiAutomationInRelationshipsAnalyticalDashboard - globals()['JsonApiAutomationInRelationshipsExportDefinitions'] = JsonApiAutomationInRelationshipsExportDefinitions - globals()['JsonApiAutomationInRelationshipsNotificationChannel'] = JsonApiAutomationInRelationshipsNotificationChannel - globals()['JsonApiAutomationInRelationshipsRecipients'] = JsonApiAutomationInRelationshipsRecipients - - -class JsonApiAutomationInRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'analytical_dashboard': (JsonApiAutomationInRelationshipsAnalyticalDashboard,), # noqa: E501 - 'export_definitions': (JsonApiAutomationInRelationshipsExportDefinitions,), # noqa: E501 - 'notification_channel': (JsonApiAutomationInRelationshipsNotificationChannel,), # noqa: E501 - 'recipients': (JsonApiAutomationInRelationshipsRecipients,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 - 'export_definitions': 'exportDefinitions', # noqa: E501 - 'notification_channel': 'notificationChannel', # noqa: E501 - 'recipients': 'recipients', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 - notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 - recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 - notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 - recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_analytical_dashboard.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_analytical_dashboard.py deleted file mode 100644 index f3b7cfd5d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_analytical_dashboard.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage - globals()['JsonApiAnalyticalDashboardToOneLinkage'] = JsonApiAnalyticalDashboardToOneLinkage - - -class JsonApiAutomationInRelationshipsAnalyticalDashboard(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAnalyticalDashboardToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInRelationshipsAnalyticalDashboard - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInRelationshipsAnalyticalDashboard - a model defined in OpenAPI - - Args: - data (JsonApiAnalyticalDashboardToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_export_definitions.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_export_definitions.py deleted file mode 100644 index 56d8a04bb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_export_definitions.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_definition_to_many_linkage import JsonApiExportDefinitionToManyLinkage - globals()['JsonApiExportDefinitionToManyLinkage'] = JsonApiExportDefinitionToManyLinkage - - -class JsonApiAutomationInRelationshipsExportDefinitions(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiExportDefinitionToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInRelationshipsExportDefinitions - a model defined in OpenAPI - - Args: - data (JsonApiExportDefinitionToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInRelationshipsExportDefinitions - a model defined in OpenAPI - - Args: - data (JsonApiExportDefinitionToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_notification_channel.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_notification_channel.py deleted file mode 100644 index 0c01f49a2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_notification_channel.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_to_one_linkage import JsonApiNotificationChannelToOneLinkage - globals()['JsonApiNotificationChannelToOneLinkage'] = JsonApiNotificationChannelToOneLinkage - - -class JsonApiAutomationInRelationshipsNotificationChannel(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiNotificationChannelToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInRelationshipsNotificationChannel - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInRelationshipsNotificationChannel - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_recipients.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_recipients.py deleted file mode 100644 index 0321aa56a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_relationships_recipients.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_to_many_linkage import JsonApiUserToManyLinkage - globals()['JsonApiUserToManyLinkage'] = JsonApiUserToManyLinkage - - -class JsonApiAutomationInRelationshipsRecipients(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInRelationshipsRecipients - a model defined in OpenAPI - - Args: - data (JsonApiUserToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationInRelationshipsRecipients - a model defined in OpenAPI - - Args: - data (JsonApiUserToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_linkage.py deleted file mode 100644 index a11943d81..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAutomationLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AUTOMATION': "automation", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "automation", must be one of ["automation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "automation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "automation", must be one of ["automation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "automation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out.py deleted file mode 100644 index d5452a52b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_automation_out_attributes import JsonApiAutomationOutAttributes - from gooddata_api_client.model.json_api_automation_out_relationships import JsonApiAutomationOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAutomationOutAttributes'] = JsonApiAutomationOutAttributes - globals()['JsonApiAutomationOutRelationships'] = JsonApiAutomationOutRelationships - - -class JsonApiAutomationOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AUTOMATION': "automation", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAutomationOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAutomationOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "automation", must be one of ["automation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAutomationOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "automation", must be one of ["automation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAutomationOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py deleted file mode 100644 index deddc63ca..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py +++ /dev/null @@ -1,376 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert - from gooddata_api_client.model.json_api_automation_in_attributes_dashboard_tabular_exports_inner import JsonApiAutomationInAttributesDashboardTabularExportsInner - from gooddata_api_client.model.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner - from gooddata_api_client.model.json_api_automation_in_attributes_image_exports_inner import JsonApiAutomationInAttributesImageExportsInner - from gooddata_api_client.model.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata - from gooddata_api_client.model.json_api_automation_in_attributes_raw_exports_inner import JsonApiAutomationInAttributesRawExportsInner - from gooddata_api_client.model.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule - from gooddata_api_client.model.json_api_automation_in_attributes_slides_exports_inner import JsonApiAutomationInAttributesSlidesExportsInner - from gooddata_api_client.model.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner - from gooddata_api_client.model.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner - globals()['JsonApiAutomationInAttributesAlert'] = JsonApiAutomationInAttributesAlert - globals()['JsonApiAutomationInAttributesDashboardTabularExportsInner'] = JsonApiAutomationInAttributesDashboardTabularExportsInner - globals()['JsonApiAutomationInAttributesExternalRecipientsInner'] = JsonApiAutomationInAttributesExternalRecipientsInner - globals()['JsonApiAutomationInAttributesImageExportsInner'] = JsonApiAutomationInAttributesImageExportsInner - globals()['JsonApiAutomationInAttributesMetadata'] = JsonApiAutomationInAttributesMetadata - globals()['JsonApiAutomationInAttributesRawExportsInner'] = JsonApiAutomationInAttributesRawExportsInner - globals()['JsonApiAutomationInAttributesSchedule'] = JsonApiAutomationInAttributesSchedule - globals()['JsonApiAutomationInAttributesSlidesExportsInner'] = JsonApiAutomationInAttributesSlidesExportsInner - globals()['JsonApiAutomationInAttributesTabularExportsInner'] = JsonApiAutomationInAttributesTabularExportsInner - globals()['JsonApiAutomationInAttributesVisualExportsInner'] = JsonApiAutomationInAttributesVisualExportsInner - - -class JsonApiAutomationOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('evaluation_mode',): { - 'SHARED': "SHARED", - 'PER_RECIPIENT': "PER_RECIPIENT", - }, - ('state',): { - 'ACTIVE': "ACTIVE", - 'PAUSED': "PAUSED", - }, - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('details',): { - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'alert': (JsonApiAutomationInAttributesAlert,), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 - 'dashboard_tabular_exports': ([JsonApiAutomationInAttributesDashboardTabularExportsInner],), # noqa: E501 - 'description': (str,), # noqa: E501 - 'details': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'evaluation_mode': (str,), # noqa: E501 - 'external_recipients': ([JsonApiAutomationInAttributesExternalRecipientsInner],), # noqa: E501 - 'image_exports': ([JsonApiAutomationInAttributesImageExportsInner],), # noqa: E501 - 'metadata': (JsonApiAutomationInAttributesMetadata,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 - 'raw_exports': ([JsonApiAutomationInAttributesRawExportsInner],), # noqa: E501 - 'schedule': (JsonApiAutomationInAttributesSchedule,), # noqa: E501 - 'slides_exports': ([JsonApiAutomationInAttributesSlidesExportsInner],), # noqa: E501 - 'state': (str,), # noqa: E501 - 'tabular_exports': ([JsonApiAutomationInAttributesTabularExportsInner],), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - 'visual_exports': ([JsonApiAutomationInAttributesVisualExportsInner],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'alert': 'alert', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'dashboard_tabular_exports': 'dashboardTabularExports', # noqa: E501 - 'description': 'description', # noqa: E501 - 'details': 'details', # noqa: E501 - 'evaluation_mode': 'evaluationMode', # noqa: E501 - 'external_recipients': 'externalRecipients', # noqa: E501 - 'image_exports': 'imageExports', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'raw_exports': 'rawExports', # noqa: E501 - 'schedule': 'schedule', # noqa: E501 - 'slides_exports': 'slidesExports', # noqa: E501 - 'state': 'state', # noqa: E501 - 'tabular_exports': 'tabularExports', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - 'visual_exports': 'visualExports', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - alert (JsonApiAutomationInAttributesAlert): [optional] # noqa: E501 - are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - dashboard_tabular_exports ([JsonApiAutomationInAttributesDashboardTabularExportsInner]): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Additional details to be included in the automated message.. [optional] # noqa: E501 - evaluation_mode (str): Specify automation evaluation mode.. [optional] # noqa: E501 - external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 - image_exports ([JsonApiAutomationInAttributesImageExportsInner]): [optional] # noqa: E501 - metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - raw_exports ([JsonApiAutomationInAttributesRawExportsInner]): [optional] # noqa: E501 - schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 - slides_exports ([JsonApiAutomationInAttributesSlidesExportsInner]): [optional] # noqa: E501 - state (str): Current state of the automation.. [optional] # noqa: E501 - tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - alert (JsonApiAutomationInAttributesAlert): [optional] # noqa: E501 - are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - dashboard_tabular_exports ([JsonApiAutomationInAttributesDashboardTabularExportsInner]): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Additional details to be included in the automated message.. [optional] # noqa: E501 - evaluation_mode (str): Specify automation evaluation mode.. [optional] # noqa: E501 - external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 - image_exports ([JsonApiAutomationInAttributesImageExportsInner]): [optional] # noqa: E501 - metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - raw_exports ([JsonApiAutomationInAttributesRawExportsInner]): [optional] # noqa: E501 - schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 - slides_exports ([JsonApiAutomationInAttributesSlidesExportsInner]): [optional] # noqa: E501 - state (str): Current state of the automation.. [optional] # noqa: E501 - tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_document.py deleted file mode 100644 index 3d43e8688..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_out import JsonApiAutomationOut - from gooddata_api_client.model.json_api_automation_out_includes import JsonApiAutomationOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAutomationOut'] = JsonApiAutomationOut - globals()['JsonApiAutomationOutIncludes'] = JsonApiAutomationOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiAutomationOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAutomationOut,), # noqa: E501 - 'included': ([JsonApiAutomationOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiAutomationOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAutomationOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiAutomationOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAutomationOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_includes.py deleted file mode 100644 index a70d9e76c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_includes.py +++ /dev/null @@ -1,371 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks - from gooddata_api_client.model.json_api_automation_result_out_attributes import JsonApiAutomationResultOutAttributes - from gooddata_api_client.model.json_api_automation_result_out_relationships import JsonApiAutomationResultOutRelationships - from gooddata_api_client.model.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks - from gooddata_api_client.model.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks - from gooddata_api_client.model.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks - from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks - from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAnalyticalDashboardOutWithLinks'] = JsonApiAnalyticalDashboardOutWithLinks - globals()['JsonApiAutomationResultOutAttributes'] = JsonApiAutomationResultOutAttributes - globals()['JsonApiAutomationResultOutRelationships'] = JsonApiAutomationResultOutRelationships - globals()['JsonApiAutomationResultOutWithLinks'] = JsonApiAutomationResultOutWithLinks - globals()['JsonApiExportDefinitionOutWithLinks'] = JsonApiExportDefinitionOutWithLinks - globals()['JsonApiNotificationChannelOutWithLinks'] = JsonApiNotificationChannelOutWithLinks - globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks - globals()['JsonApiUserOutWithLinks'] = JsonApiUserOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiAutomationOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AUTOMATIONRESULT': "automationResult", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'links': (ObjectLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAutomationResultOutRelationships,), # noqa: E501 - 'attributes': (JsonApiAutomationResultOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAutomationResultOutRelationships): [optional] # noqa: E501 - attributes (JsonApiAutomationResultOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "automationResult" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAutomationResultOutRelationships): [optional] # noqa: E501 - attributes (JsonApiAutomationResultOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "automationResult" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAnalyticalDashboardOutWithLinks, - JsonApiAutomationResultOutWithLinks, - JsonApiExportDefinitionOutWithLinks, - JsonApiNotificationChannelOutWithLinks, - JsonApiUserIdentifierOutWithLinks, - JsonApiUserOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_list.py deleted file mode 100644 index 8444b415d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_automation_out_includes import JsonApiAutomationOutIncludes - from gooddata_api_client.model.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiAutomationOutIncludes'] = JsonApiAutomationOutIncludes - globals()['JsonApiAutomationOutWithLinks'] = JsonApiAutomationOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiAutomationOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiAutomationOutWithLinks],), # noqa: E501 - 'included': ([JsonApiAutomationOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutList - a model defined in OpenAPI - - Args: - data ([JsonApiAutomationOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAutomationOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutList - a model defined in OpenAPI - - Args: - data ([JsonApiAutomationOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAutomationOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships.py deleted file mode 100644 index 3cb64f625..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - from gooddata_api_client.model.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard - from gooddata_api_client.model.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions - from gooddata_api_client.model.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel - from gooddata_api_client.model.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients - from gooddata_api_client.model.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - globals()['JsonApiAutomationInRelationshipsAnalyticalDashboard'] = JsonApiAutomationInRelationshipsAnalyticalDashboard - globals()['JsonApiAutomationInRelationshipsExportDefinitions'] = JsonApiAutomationInRelationshipsExportDefinitions - globals()['JsonApiAutomationInRelationshipsNotificationChannel'] = JsonApiAutomationInRelationshipsNotificationChannel - globals()['JsonApiAutomationInRelationshipsRecipients'] = JsonApiAutomationInRelationshipsRecipients - globals()['JsonApiAutomationOutRelationshipsAutomationResults'] = JsonApiAutomationOutRelationshipsAutomationResults - - -class JsonApiAutomationOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'analytical_dashboard': (JsonApiAutomationInRelationshipsAnalyticalDashboard,), # noqa: E501 - 'automation_results': (JsonApiAutomationOutRelationshipsAutomationResults,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'export_definitions': (JsonApiAutomationInRelationshipsExportDefinitions,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'notification_channel': (JsonApiAutomationInRelationshipsNotificationChannel,), # noqa: E501 - 'recipients': (JsonApiAutomationInRelationshipsRecipients,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 - 'automation_results': 'automationResults', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'export_definitions': 'exportDefinitions', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - 'notification_channel': 'notificationChannel', # noqa: E501 - 'recipients': 'recipients', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 - recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 - recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_automation_results.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_automation_results.py deleted file mode 100644 index 347234afe..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_automation_results.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_result_to_many_linkage import JsonApiAutomationResultToManyLinkage - globals()['JsonApiAutomationResultToManyLinkage'] = JsonApiAutomationResultToManyLinkage - - -class JsonApiAutomationOutRelationshipsAutomationResults(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAutomationResultToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutRelationshipsAutomationResults - a model defined in OpenAPI - - Args: - data (JsonApiAutomationResultToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutRelationshipsAutomationResults - a model defined in OpenAPI - - Args: - data (JsonApiAutomationResultToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_with_links.py deleted file mode 100644 index 9f8b39d7b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_automation_out import JsonApiAutomationOut - from gooddata_api_client.model.json_api_automation_out_attributes import JsonApiAutomationOutAttributes - from gooddata_api_client.model.json_api_automation_out_relationships import JsonApiAutomationOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAutomationOut'] = JsonApiAutomationOut - globals()['JsonApiAutomationOutAttributes'] = JsonApiAutomationOutAttributes - globals()['JsonApiAutomationOutRelationships'] = JsonApiAutomationOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiAutomationOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AUTOMATION': "automation", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAutomationOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAutomationOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "automation", must be one of ["automation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAutomationOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "automation", must be one of ["automation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAutomationOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiAutomationOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch.py deleted file mode 100644 index 69e8759c6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_in_attributes import JsonApiAutomationInAttributes - from gooddata_api_client.model.json_api_automation_in_relationships import JsonApiAutomationInRelationships - globals()['JsonApiAutomationInAttributes'] = JsonApiAutomationInAttributes - globals()['JsonApiAutomationInRelationships'] = JsonApiAutomationInRelationships - - -class JsonApiAutomationPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AUTOMATION': "automation", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAutomationInAttributes,), # noqa: E501 - 'relationships': (JsonApiAutomationInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "automation", must be one of ["automation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationInAttributes): [optional] # noqa: E501 - relationships (JsonApiAutomationInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "automation", must be one of ["automation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationInAttributes): [optional] # noqa: E501 - relationships (JsonApiAutomationInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch_document.py deleted file mode 100644 index ca857995a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_patch import JsonApiAutomationPatch - globals()['JsonApiAutomationPatch'] = JsonApiAutomationPatch - - -class JsonApiAutomationPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAutomationPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiAutomationPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiAutomationPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_linkage.py deleted file mode 100644 index 3dba289a8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAutomationResultLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AUTOMATIONRESULT': "automationResult", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "automationResult", must be one of ["automationResult", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "automationResult") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "automationResult", must be one of ["automationResult", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "automationResult") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out.py deleted file mode 100644 index e722c7f06..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_result_out_attributes import JsonApiAutomationResultOutAttributes - from gooddata_api_client.model.json_api_automation_result_out_relationships import JsonApiAutomationResultOutRelationships - globals()['JsonApiAutomationResultOutAttributes'] = JsonApiAutomationResultOutAttributes - globals()['JsonApiAutomationResultOutRelationships'] = JsonApiAutomationResultOutRelationships - - -class JsonApiAutomationResultOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AUTOMATIONRESULT': "automationResult", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAutomationResultOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'relationships': (JsonApiAutomationResultOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultOut - a model defined in OpenAPI - - Args: - attributes (JsonApiAutomationResultOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "automationResult", must be one of ["automationResult", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiAutomationResultOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automationResult") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultOut - a model defined in OpenAPI - - Args: - attributes (JsonApiAutomationResultOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "automationResult", must be one of ["automationResult", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiAutomationResultOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automationResult") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_attributes.py deleted file mode 100644 index b7247ddc4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_attributes.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiAutomationResultOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('status',): { - 'SUCCESS': "SUCCESS", - 'FAILED': "FAILED", - }, - } - - validations = { - ('error_message',): { - 'max_length': 10000, - }, - ('trace_id',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'executed_at': (datetime,), # noqa: E501 - 'status': (str,), # noqa: E501 - 'error_message': (str,), # noqa: E501 - 'trace_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'executed_at': 'executedAt', # noqa: E501 - 'status': 'status', # noqa: E501 - 'error_message': 'errorMessage', # noqa: E501 - 'trace_id': 'traceId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, executed_at, status, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultOutAttributes - a model defined in OpenAPI - - Args: - executed_at (datetime): Timestamp of the last automation run. - status (str): Status of the last automation run. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - error_message (str): [optional] # noqa: E501 - trace_id (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.executed_at = executed_at - self.status = status - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, executed_at, status, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultOutAttributes - a model defined in OpenAPI - - Args: - executed_at (datetime): Timestamp of the last automation run. - status (str): Status of the last automation run. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - error_message (str): [optional] # noqa: E501 - trace_id (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.executed_at = executed_at - self.status = status - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_relationships.py deleted file mode 100644 index 8fe88d337..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_relationships.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_result_out_relationships_automation import JsonApiAutomationResultOutRelationshipsAutomation - globals()['JsonApiAutomationResultOutRelationshipsAutomation'] = JsonApiAutomationResultOutRelationshipsAutomation - - -class JsonApiAutomationResultOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'automation': (JsonApiAutomationResultOutRelationshipsAutomation,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'automation': 'automation', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - automation (JsonApiAutomationResultOutRelationshipsAutomation): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - automation (JsonApiAutomationResultOutRelationshipsAutomation): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_relationships_automation.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_relationships_automation.py deleted file mode 100644 index fd075bafb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_relationships_automation.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_to_one_linkage import JsonApiAutomationToOneLinkage - globals()['JsonApiAutomationToOneLinkage'] = JsonApiAutomationToOneLinkage - - -class JsonApiAutomationResultOutRelationshipsAutomation(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAutomationToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultOutRelationshipsAutomation - a model defined in OpenAPI - - Args: - data (JsonApiAutomationToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultOutRelationshipsAutomation - a model defined in OpenAPI - - Args: - data (JsonApiAutomationToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_with_links.py deleted file mode 100644 index e617cc9f9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_with_links.py +++ /dev/null @@ -1,355 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_result_out import JsonApiAutomationResultOut - from gooddata_api_client.model.json_api_automation_result_out_attributes import JsonApiAutomationResultOutAttributes - from gooddata_api_client.model.json_api_automation_result_out_relationships import JsonApiAutomationResultOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAutomationResultOut'] = JsonApiAutomationResultOut - globals()['JsonApiAutomationResultOutAttributes'] = JsonApiAutomationResultOutAttributes - globals()['JsonApiAutomationResultOutRelationships'] = JsonApiAutomationResultOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiAutomationResultOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AUTOMATIONRESULT': "automationResult", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAutomationResultOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'relationships': (JsonApiAutomationResultOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiAutomationResultOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "automationResult", must be one of ["automationResult", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiAutomationResultOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automationResult") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAutomationResultOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiAutomationResultOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "automationResult", must be one of ["automationResult", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiAutomationResultOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "automationResult") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiAutomationResultOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_to_many_linkage.py deleted file mode 100644 index 029575c5b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_result_linkage import JsonApiAutomationResultLinkage - globals()['JsonApiAutomationResultLinkage'] = JsonApiAutomationResultLinkage - - -class JsonApiAutomationResultToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiAutomationResultLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiAutomationResultToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiAutomationResultLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiAutomationResultLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiAutomationResultToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiAutomationResultLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiAutomationResultLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_to_one_linkage.py deleted file mode 100644 index 7862aec38..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_linkage import JsonApiAutomationLinkage - globals()['JsonApiAutomationLinkage'] = JsonApiAutomationLinkage - - -class JsonApiAutomationToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AUTOMATION': "automation", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiAutomationToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "automation" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiAutomationToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "automation" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAutomationLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in.py deleted file mode 100644 index 9261c2481..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes - globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes - - -class JsonApiColorPaletteIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'COLORPALETTE': "colorPalette", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteIn - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "colorPalette", must be one of ["colorPalette", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "colorPalette") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteIn - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "colorPalette", must be one of ["colorPalette", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "colorPalette") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in_attributes.py deleted file mode 100644 index d22e5b33f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in_attributes.py +++ /dev/null @@ -1,279 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiColorPaletteInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, name, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteInAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters. - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, name, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteInAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters. - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in_document.py deleted file mode 100644 index 54ab75148..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_color_palette_in import JsonApiColorPaletteIn - globals()['JsonApiColorPaletteIn'] = JsonApiColorPaletteIn - - -class JsonApiColorPaletteInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiColorPaletteIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteInDocument - a model defined in OpenAPI - - Args: - data (JsonApiColorPaletteIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteInDocument - a model defined in OpenAPI - - Args: - data (JsonApiColorPaletteIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in_document.pyi index 58ccdfd63..cd09c9368 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiColorPaletteInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiColorPaletteIn']: return JsonApiColorPaletteIn __annotations__ = { "data": data, } - + data: 'JsonApiColorPaletteIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiColorPaletteIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiColorPaletteIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiColorPaletteInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_color_palette_in import JsonApiColorPaletteIn +from gooddata_api_client.models.json_api_color_palette_in import JsonApiColorPaletteIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out.py deleted file mode 100644 index fe32a9f94..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes - globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes - - -class JsonApiColorPaletteOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'COLORPALETTE': "colorPalette", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteOut - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "colorPalette", must be one of ["colorPalette", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "colorPalette") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteOut - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "colorPalette", must be one of ["colorPalette", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "colorPalette") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_document.py deleted file mode 100644 index 743f64ef0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_color_palette_out import JsonApiColorPaletteOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiColorPaletteOut'] = JsonApiColorPaletteOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiColorPaletteOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiColorPaletteOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiColorPaletteOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiColorPaletteOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_document.pyi index 3d7d34a14..fd333d9f4 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiColorPaletteOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiColorPaletteOut']: return JsonApiColorPaletteOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiColorPaletteOutDocument( "data": data, "links": links, } - + data: 'JsonApiColorPaletteOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiColorPaletteOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiColorPaletteOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiColorPaletteOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_color_palette_out import JsonApiColorPaletteOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_color_palette_out import JsonApiColorPaletteOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_list.py deleted file mode 100644 index 2020a3d87..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_color_palette_out_with_links import JsonApiColorPaletteOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiColorPaletteOutWithLinks'] = JsonApiColorPaletteOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiColorPaletteOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiColorPaletteOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteOutList - a model defined in OpenAPI - - Args: - data ([JsonApiColorPaletteOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteOutList - a model defined in OpenAPI - - Args: - data ([JsonApiColorPaletteOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_list.pyi index 64832c905..1fb560ea1 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiColorPaletteOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiColorPaletteOutWithLinks']: return JsonApiColorPaletteOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiColorPaletteOutWithLinks'], typing.List['JsonApiColorPaletteOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiColorPaletteOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiColorPaletteOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiColorPaletteOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiColorPaletteOutList( **kwargs, ) -from gooddata_api_client.model.json_api_color_palette_out_with_links import JsonApiColorPaletteOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_color_palette_out_with_links import JsonApiColorPaletteOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_with_links.py deleted file mode 100644 index a71da81f1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes - from gooddata_api_client.model.json_api_color_palette_out import JsonApiColorPaletteOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes - globals()['JsonApiColorPaletteOut'] = JsonApiColorPaletteOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiColorPaletteOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'COLORPALETTE': "colorPalette", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "colorPalette", must be one of ["colorPalette", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "colorPalette") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiColorPaletteOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "colorPalette", must be one of ["colorPalette", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "colorPalette") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiColorPaletteOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_with_links.pyi index 82be8876c..55382d69e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiColorPaletteOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiColorPaletteOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_color_palette_out import JsonApiColorPaletteOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_color_palette_out import JsonApiColorPaletteOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch.py deleted file mode 100644 index 477287c2b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_color_palette_patch_attributes import JsonApiColorPalettePatchAttributes - globals()['JsonApiColorPalettePatchAttributes'] = JsonApiColorPalettePatchAttributes - - -class JsonApiColorPalettePatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'COLORPALETTE': "colorPalette", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiColorPalettePatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiColorPalettePatch - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPalettePatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "colorPalette", must be one of ["colorPalette", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "colorPalette") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiColorPalettePatch - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPalettePatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "colorPalette", must be one of ["colorPalette", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "colorPalette") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch_attributes.py deleted file mode 100644 index c1b023f63..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch_attributes.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiColorPalettePatchAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiColorPalettePatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiColorPalettePatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch_document.py deleted file mode 100644 index e967f77a7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_color_palette_patch import JsonApiColorPalettePatch - globals()['JsonApiColorPalettePatch'] = JsonApiColorPalettePatch - - -class JsonApiColorPalettePatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiColorPalettePatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiColorPalettePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiColorPalettePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiColorPalettePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiColorPalettePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch_document.pyi index 2724c1e27..7edeab24f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiColorPalettePatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiColorPalettePatch']: return JsonApiColorPalettePatch __annotations__ = { "data": data, } - + data: 'JsonApiColorPalettePatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiColorPalettePatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiColorPalettePatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiColorPalettePatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_color_palette_patch import JsonApiColorPalettePatch +from gooddata_api_client.models.json_api_color_palette_patch import JsonApiColorPalettePatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in.py deleted file mode 100644 index facaa4355..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_cookie_security_configuration_in_attributes import JsonApiCookieSecurityConfigurationInAttributes - globals()['JsonApiCookieSecurityConfigurationInAttributes'] = JsonApiCookieSecurityConfigurationInAttributes - - -class JsonApiCookieSecurityConfigurationIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'COOKIESECURITYCONFIGURATION': "cookieSecurityConfiguration", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiCookieSecurityConfigurationInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cookieSecurityConfiguration", must be one of ["cookieSecurityConfiguration", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiCookieSecurityConfigurationInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "cookieSecurityConfiguration") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cookieSecurityConfiguration", must be one of ["cookieSecurityConfiguration", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiCookieSecurityConfigurationInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "cookieSecurityConfiguration") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in_attributes.py deleted file mode 100644 index 15a0ac217..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in_attributes.py +++ /dev/null @@ -1,268 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiCookieSecurityConfigurationInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'last_rotation': (datetime,), # noqa: E501 - 'rotation_interval': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'last_rotation': 'lastRotation', # noqa: E501 - 'rotation_interval': 'rotationInterval', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - last_rotation (datetime): [optional] # noqa: E501 - rotation_interval (str): Length of interval between automatic rotations expressed in format of ISO 8601 duration. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - last_rotation (datetime): [optional] # noqa: E501 - rotation_interval (str): Length of interval between automatic rotations expressed in format of ISO 8601 duration. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in_document.py deleted file mode 100644 index f0b04edfb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_cookie_security_configuration_in import JsonApiCookieSecurityConfigurationIn - globals()['JsonApiCookieSecurityConfigurationIn'] = JsonApiCookieSecurityConfigurationIn - - -class JsonApiCookieSecurityConfigurationInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiCookieSecurityConfigurationIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationInDocument - a model defined in OpenAPI - - Args: - data (JsonApiCookieSecurityConfigurationIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationInDocument - a model defined in OpenAPI - - Args: - data (JsonApiCookieSecurityConfigurationIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in_document.pyi index da92b4b36..c0b81ec5f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_in_document.pyi @@ -86,4 +86,4 @@ class JsonApiCookieSecurityConfigurationInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_cookie_security_configuration_in import JsonApiCookieSecurityConfigurationIn +from gooddata_api_client.models.json_api_cookie_security_configuration_in import JsonApiCookieSecurityConfigurationIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_out.py deleted file mode 100644 index bd3943dcc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_out.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_cookie_security_configuration_in_attributes import JsonApiCookieSecurityConfigurationInAttributes - globals()['JsonApiCookieSecurityConfigurationInAttributes'] = JsonApiCookieSecurityConfigurationInAttributes - - -class JsonApiCookieSecurityConfigurationOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'COOKIESECURITYCONFIGURATION': "cookieSecurityConfiguration", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiCookieSecurityConfigurationInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cookieSecurityConfiguration", must be one of ["cookieSecurityConfiguration", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiCookieSecurityConfigurationInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "cookieSecurityConfiguration") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cookieSecurityConfiguration", must be one of ["cookieSecurityConfiguration", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiCookieSecurityConfigurationInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "cookieSecurityConfiguration") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_out_document.py deleted file mode 100644 index 99ab0c8da..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_cookie_security_configuration_out import JsonApiCookieSecurityConfigurationOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiCookieSecurityConfigurationOut'] = JsonApiCookieSecurityConfigurationOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiCookieSecurityConfigurationOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiCookieSecurityConfigurationOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiCookieSecurityConfigurationOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiCookieSecurityConfigurationOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_out_document.pyi index 5bb0ae8ea..056278d3f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiCookieSecurityConfigurationOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiCookieSecurityConfigurationOut']: return JsonApiCookieSecurityConfigurationOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiCookieSecurityConfigurationOutDocument( "data": data, "links": links, } - + data: 'JsonApiCookieSecurityConfigurationOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCookieSecurityConfigurationOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCookieSecurityConfigurationOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiCookieSecurityConfigurationOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_cookie_security_configuration_out import JsonApiCookieSecurityConfigurationOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_cookie_security_configuration_out import JsonApiCookieSecurityConfigurationOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_patch.py deleted file mode 100644 index 19d4ec7d3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_patch.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_cookie_security_configuration_in_attributes import JsonApiCookieSecurityConfigurationInAttributes - globals()['JsonApiCookieSecurityConfigurationInAttributes'] = JsonApiCookieSecurityConfigurationInAttributes - - -class JsonApiCookieSecurityConfigurationPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'COOKIESECURITYCONFIGURATION': "cookieSecurityConfiguration", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiCookieSecurityConfigurationInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cookieSecurityConfiguration", must be one of ["cookieSecurityConfiguration", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiCookieSecurityConfigurationInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "cookieSecurityConfiguration") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cookieSecurityConfiguration", must be one of ["cookieSecurityConfiguration", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiCookieSecurityConfigurationInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "cookieSecurityConfiguration") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_patch_document.py deleted file mode 100644 index 712a3f31b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_cookie_security_configuration_patch import JsonApiCookieSecurityConfigurationPatch - globals()['JsonApiCookieSecurityConfigurationPatch'] = JsonApiCookieSecurityConfigurationPatch - - -class JsonApiCookieSecurityConfigurationPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiCookieSecurityConfigurationPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiCookieSecurityConfigurationPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCookieSecurityConfigurationPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiCookieSecurityConfigurationPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_patch_document.pyi index 0e83a935e..0ee2b63e6 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_cookie_security_configuration_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiCookieSecurityConfigurationPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiCookieSecurityConfigurationPatch']: return JsonApiCookieSecurityConfigurationPatch __annotations__ = { "data": data, } - + data: 'JsonApiCookieSecurityConfigurationPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCookieSecurityConfigurationPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCookieSecurityConfigurationPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiCookieSecurityConfigurationPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_cookie_security_configuration_patch import JsonApiCookieSecurityConfigurationPatch +from gooddata_api_client.models.json_api_cookie_security_configuration_patch import JsonApiCookieSecurityConfigurationPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in.py deleted file mode 100644 index 9ebde6c6d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes - globals()['JsonApiCspDirectiveInAttributes'] = JsonApiCspDirectiveInAttributes - - -class JsonApiCspDirectiveIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'CSPDIRECTIVE': "cspDirective", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiCspDirectiveInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveIn - a model defined in OpenAPI - - Args: - attributes (JsonApiCspDirectiveInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cspDirective", must be one of ["cspDirective", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "cspDirective") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveIn - a model defined in OpenAPI - - Args: - attributes (JsonApiCspDirectiveInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cspDirective", must be one of ["cspDirective", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "cspDirective") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in_attributes.py deleted file mode 100644 index fc0f6def7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in_attributes.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiCspDirectiveInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'sources': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'sources': 'sources', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, sources, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveInAttributes - a model defined in OpenAPI - - Args: - sources ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.sources = sources - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, sources, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveInAttributes - a model defined in OpenAPI - - Args: - sources ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.sources = sources - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in_document.py deleted file mode 100644 index fd338fc59..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_csp_directive_in import JsonApiCspDirectiveIn - globals()['JsonApiCspDirectiveIn'] = JsonApiCspDirectiveIn - - -class JsonApiCspDirectiveInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiCspDirectiveIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveInDocument - a model defined in OpenAPI - - Args: - data (JsonApiCspDirectiveIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveInDocument - a model defined in OpenAPI - - Args: - data (JsonApiCspDirectiveIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in_document.pyi index ae6550cb7..6f6697958 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiCspDirectiveInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiCspDirectiveIn']: return JsonApiCspDirectiveIn __annotations__ = { "data": data, } - + data: 'JsonApiCspDirectiveIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCspDirectiveIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCspDirectiveIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiCspDirectiveInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_csp_directive_in import JsonApiCspDirectiveIn +from gooddata_api_client.models.json_api_csp_directive_in import JsonApiCspDirectiveIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out.py deleted file mode 100644 index f3ec2892f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes - globals()['JsonApiCspDirectiveInAttributes'] = JsonApiCspDirectiveInAttributes - - -class JsonApiCspDirectiveOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'CSPDIRECTIVE': "cspDirective", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiCspDirectiveInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveOut - a model defined in OpenAPI - - Args: - attributes (JsonApiCspDirectiveInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cspDirective", must be one of ["cspDirective", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "cspDirective") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveOut - a model defined in OpenAPI - - Args: - attributes (JsonApiCspDirectiveInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cspDirective", must be one of ["cspDirective", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "cspDirective") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_document.py deleted file mode 100644 index 02199f3a4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_csp_directive_out import JsonApiCspDirectiveOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiCspDirectiveOut'] = JsonApiCspDirectiveOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiCspDirectiveOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiCspDirectiveOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiCspDirectiveOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiCspDirectiveOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_document.pyi index d4a5c8eed..87bb57afd 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiCspDirectiveOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiCspDirectiveOut']: return JsonApiCspDirectiveOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiCspDirectiveOutDocument( "data": data, "links": links, } - + data: 'JsonApiCspDirectiveOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCspDirectiveOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCspDirectiveOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiCspDirectiveOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_csp_directive_out import JsonApiCspDirectiveOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_csp_directive_out import JsonApiCspDirectiveOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_list.py deleted file mode 100644 index 734a14d0e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_csp_directive_out_with_links import JsonApiCspDirectiveOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiCspDirectiveOutWithLinks'] = JsonApiCspDirectiveOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiCspDirectiveOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiCspDirectiveOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveOutList - a model defined in OpenAPI - - Args: - data ([JsonApiCspDirectiveOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveOutList - a model defined in OpenAPI - - Args: - data ([JsonApiCspDirectiveOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_list.pyi index 16f7ba518..36937019d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiCspDirectiveOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiCspDirectiveOutWithLinks']: return JsonApiCspDirectiveOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiCspDirectiveOutWithLinks'], typing.List['JsonApiCspDirectiveOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiCspDirectiveOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiCspDirectiveOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiCspDirectiveOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiCspDirectiveOutList( **kwargs, ) -from gooddata_api_client.model.json_api_csp_directive_out_with_links import JsonApiCspDirectiveOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_csp_directive_out_with_links import JsonApiCspDirectiveOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_with_links.py deleted file mode 100644 index 5a773aae2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes - from gooddata_api_client.model.json_api_csp_directive_out import JsonApiCspDirectiveOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiCspDirectiveInAttributes'] = JsonApiCspDirectiveInAttributes - globals()['JsonApiCspDirectiveOut'] = JsonApiCspDirectiveOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiCspDirectiveOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'CSPDIRECTIVE': "cspDirective", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiCspDirectiveInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiCspDirectiveInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "cspDirective", must be one of ["cspDirective", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "cspDirective") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectiveOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiCspDirectiveInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "cspDirective", must be one of ["cspDirective", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "cspDirective") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiCspDirectiveOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_with_links.pyi index 0eba78f05..064502a3e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiCspDirectiveOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiCspDirectiveOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_csp_directive_out import JsonApiCspDirectiveOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_csp_directive_out import JsonApiCspDirectiveOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch.py deleted file mode 100644 index 8836b2f1c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_csp_directive_patch_attributes import JsonApiCspDirectivePatchAttributes - globals()['JsonApiCspDirectivePatchAttributes'] = JsonApiCspDirectivePatchAttributes - - -class JsonApiCspDirectivePatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'CSPDIRECTIVE': "cspDirective", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiCspDirectivePatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectivePatch - a model defined in OpenAPI - - Args: - attributes (JsonApiCspDirectivePatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cspDirective", must be one of ["cspDirective", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "cspDirective") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectivePatch - a model defined in OpenAPI - - Args: - attributes (JsonApiCspDirectivePatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "cspDirective", must be one of ["cspDirective", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "cspDirective") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch_attributes.py deleted file mode 100644 index a1733e826..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch_attributes.py +++ /dev/null @@ -1,264 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiCspDirectivePatchAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'sources': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'sources': 'sources', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectivePatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - sources ([str]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectivePatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - sources ([str]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch_document.py deleted file mode 100644 index bf7e0316b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_csp_directive_patch import JsonApiCspDirectivePatch - globals()['JsonApiCspDirectivePatch'] = JsonApiCspDirectivePatch - - -class JsonApiCspDirectivePatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiCspDirectivePatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectivePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiCspDirectivePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCspDirectivePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiCspDirectivePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch_document.pyi index ef976e782..c9d114347 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_patch_document.pyi @@ -86,4 +86,4 @@ class JsonApiCspDirectivePatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_csp_directive_patch import JsonApiCspDirectivePatch +from gooddata_api_client.models.json_api_csp_directive_patch import JsonApiCspDirectivePatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in.py deleted file mode 100644 index 88b0bc4f6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes - globals()['JsonApiCustomApplicationSettingInAttributes'] = JsonApiCustomApplicationSettingInAttributes - - -class JsonApiCustomApplicationSettingIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'CUSTOMAPPLICATIONSETTING': "customApplicationSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiCustomApplicationSettingInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingIn - a model defined in OpenAPI - - Args: - attributes (JsonApiCustomApplicationSettingInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "customApplicationSetting", must be one of ["customApplicationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "customApplicationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingIn - a model defined in OpenAPI - - Args: - attributes (JsonApiCustomApplicationSettingInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "customApplicationSetting", must be one of ["customApplicationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "customApplicationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_attributes.py deleted file mode 100644 index 2157ea282..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_attributes.py +++ /dev/null @@ -1,279 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiCustomApplicationSettingInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('application_name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'application_name': (str,), # noqa: E501 - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'application_name': 'applicationName', # noqa: E501 - 'content': 'content', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, application_name, content, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingInAttributes - a model defined in OpenAPI - - Args: - application_name (str): - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.application_name = application_name - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, application_name, content, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingInAttributes - a model defined in OpenAPI - - Args: - application_name (str): - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.application_name = application_name - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_document.py deleted file mode 100644 index 1f6f28f50..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_custom_application_setting_in import JsonApiCustomApplicationSettingIn - globals()['JsonApiCustomApplicationSettingIn'] = JsonApiCustomApplicationSettingIn - - -class JsonApiCustomApplicationSettingInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiCustomApplicationSettingIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingInDocument - a model defined in OpenAPI - - Args: - data (JsonApiCustomApplicationSettingIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingInDocument - a model defined in OpenAPI - - Args: - data (JsonApiCustomApplicationSettingIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_document.pyi index 7786bbf10..8e149caac 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiCustomApplicationSettingInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiCustomApplicationSettingIn']: return JsonApiCustomApplicationSettingIn __annotations__ = { "data": data, } - + data: 'JsonApiCustomApplicationSettingIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCustomApplicationSettingIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCustomApplicationSettingIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiCustomApplicationSettingInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_custom_application_setting_in import JsonApiCustomApplicationSettingIn +from gooddata_api_client.models.json_api_custom_application_setting_in import JsonApiCustomApplicationSettingIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out.py deleted file mode 100644 index eb994083f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiCustomApplicationSettingInAttributes'] = JsonApiCustomApplicationSettingInAttributes - - -class JsonApiCustomApplicationSettingOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'CUSTOMAPPLICATIONSETTING': "customApplicationSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiCustomApplicationSettingInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingOut - a model defined in OpenAPI - - Args: - attributes (JsonApiCustomApplicationSettingInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "customApplicationSetting", must be one of ["customApplicationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "customApplicationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingOut - a model defined in OpenAPI - - Args: - attributes (JsonApiCustomApplicationSettingInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "customApplicationSetting", must be one of ["customApplicationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "customApplicationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_document.py deleted file mode 100644 index dc7f23a4a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_custom_application_setting_out import JsonApiCustomApplicationSettingOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiCustomApplicationSettingOut'] = JsonApiCustomApplicationSettingOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiCustomApplicationSettingOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiCustomApplicationSettingOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiCustomApplicationSettingOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiCustomApplicationSettingOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_document.pyi index a42fcfdd2..a8db89e31 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_document.pyi @@ -99,5 +99,5 @@ class JsonApiCustomApplicationSettingOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_custom_application_setting_out import JsonApiCustomApplicationSettingOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_custom_application_setting_out import JsonApiCustomApplicationSettingOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_list.py deleted file mode 100644 index 219a214e1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_custom_application_setting_out_with_links import JsonApiCustomApplicationSettingOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiCustomApplicationSettingOutWithLinks'] = JsonApiCustomApplicationSettingOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiCustomApplicationSettingOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiCustomApplicationSettingOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingOutList - a model defined in OpenAPI - - Args: - data ([JsonApiCustomApplicationSettingOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingOutList - a model defined in OpenAPI - - Args: - data ([JsonApiCustomApplicationSettingOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_list.pyi index 8566edd36..5a0546911 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiCustomApplicationSettingOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiCustomApplicationSettingOutWithLinks']: return JsonApiCustomApplicationSettingOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiCustomApplicationSettingOutWithLinks'], typing.List['JsonApiCustomApplicationSettingOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiCustomApplicationSettingOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiCustomApplicationSettingOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiCustomApplicationSettingOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiCustomApplicationSettingOutList( **kwargs, ) -from gooddata_api_client.model.json_api_custom_application_setting_out_with_links import JsonApiCustomApplicationSettingOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_custom_application_setting_out_with_links import JsonApiCustomApplicationSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_with_links.py deleted file mode 100644 index 3a0a6eb85..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_with_links.py +++ /dev/null @@ -1,355 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes - from gooddata_api_client.model.json_api_custom_application_setting_out import JsonApiCustomApplicationSettingOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiCustomApplicationSettingInAttributes'] = JsonApiCustomApplicationSettingInAttributes - globals()['JsonApiCustomApplicationSettingOut'] = JsonApiCustomApplicationSettingOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiCustomApplicationSettingOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'CUSTOMAPPLICATIONSETTING': "customApplicationSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiCustomApplicationSettingInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiCustomApplicationSettingInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "customApplicationSetting", must be one of ["customApplicationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "customApplicationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiCustomApplicationSettingInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "customApplicationSetting", must be one of ["customApplicationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "customApplicationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiCustomApplicationSettingOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_with_links.pyi index a4755421c..c52695670 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiCustomApplicationSettingOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiCustomApplicationSettingOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_custom_application_setting_out import JsonApiCustomApplicationSettingOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_custom_application_setting_out import JsonApiCustomApplicationSettingOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch.py deleted file mode 100644 index 94de8cf08..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_custom_application_setting_patch_attributes import JsonApiCustomApplicationSettingPatchAttributes - globals()['JsonApiCustomApplicationSettingPatchAttributes'] = JsonApiCustomApplicationSettingPatchAttributes - - -class JsonApiCustomApplicationSettingPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'CUSTOMAPPLICATIONSETTING': "customApplicationSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiCustomApplicationSettingPatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiCustomApplicationSettingPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "customApplicationSetting", must be one of ["customApplicationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "customApplicationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiCustomApplicationSettingPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "customApplicationSetting", must be one of ["customApplicationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "customApplicationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_attributes.py deleted file mode 100644 index 4374dc16d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_attributes.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiCustomApplicationSettingPatchAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('application_name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'application_name': (str,), # noqa: E501 - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'application_name': 'applicationName', # noqa: E501 - 'content': 'content', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - application_name (str): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - application_name (str): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_document.py deleted file mode 100644 index d377477dd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_custom_application_setting_patch import JsonApiCustomApplicationSettingPatch - globals()['JsonApiCustomApplicationSettingPatch'] = JsonApiCustomApplicationSettingPatch - - -class JsonApiCustomApplicationSettingPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiCustomApplicationSettingPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiCustomApplicationSettingPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiCustomApplicationSettingPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_document.pyi index ad3d54d7d..cb478ee11 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_document.pyi @@ -86,4 +86,4 @@ class JsonApiCustomApplicationSettingPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_custom_application_setting_patch import JsonApiCustomApplicationSettingPatch +from gooddata_api_client.models.json_api_custom_application_setting_patch import JsonApiCustomApplicationSettingPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_post_optional_id.py deleted file mode 100644 index 3d302bc1c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_post_optional_id.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes - globals()['JsonApiCustomApplicationSettingInAttributes'] = JsonApiCustomApplicationSettingInAttributes - - -class JsonApiCustomApplicationSettingPostOptionalId(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'CUSTOMAPPLICATIONSETTING': "customApplicationSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiCustomApplicationSettingInAttributes,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiCustomApplicationSettingInAttributes): - - Keyword Args: - type (str): Object type. defaults to "customApplicationSetting", must be one of ["customApplicationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "customApplicationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiCustomApplicationSettingInAttributes): - - Keyword Args: - type (str): Object type. defaults to "customApplicationSetting", must be one of ["customApplicationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "customApplicationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_post_optional_id_document.py deleted file mode 100644 index b343a4042..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_post_optional_id_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id import JsonApiCustomApplicationSettingPostOptionalId - globals()['JsonApiCustomApplicationSettingPostOptionalId'] = JsonApiCustomApplicationSettingPostOptionalId - - -class JsonApiCustomApplicationSettingPostOptionalIdDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiCustomApplicationSettingPostOptionalId,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiCustomApplicationSettingPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiCustomApplicationSettingPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiCustomApplicationSettingPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_post_optional_id_document.pyi index 5eb4e0c8b..1fdfbe519 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_post_optional_id_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_post_optional_id_document.pyi @@ -86,4 +86,4 @@ class JsonApiCustomApplicationSettingPostOptionalIdDocument( **kwargs, ) -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id import JsonApiCustomApplicationSettingPostOptionalId +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id import JsonApiCustomApplicationSettingPostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in.py deleted file mode 100644 index 5cbebccd6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dashboard_plugin_in_attributes import JsonApiDashboardPluginInAttributes - globals()['JsonApiDashboardPluginInAttributes'] = JsonApiDashboardPluginInAttributes - - -class JsonApiDashboardPluginIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DASHBOARDPLUGIN': "dashboardPlugin", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiDashboardPluginInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiDashboardPluginInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiDashboardPluginInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in_attributes.py deleted file mode 100644 index 7b29763d8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in_attributes.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiDashboardPluginInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'description': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'content': 'content', # noqa: E501 - 'description': 'description', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in_document.py deleted file mode 100644 index 1fe44abe1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dashboard_plugin_in import JsonApiDashboardPluginIn - globals()['JsonApiDashboardPluginIn'] = JsonApiDashboardPluginIn - - -class JsonApiDashboardPluginInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDashboardPluginIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginInDocument - a model defined in OpenAPI - - Args: - data (JsonApiDashboardPluginIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginInDocument - a model defined in OpenAPI - - Args: - data (JsonApiDashboardPluginIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in_document.pyi index f1494b9db..43fbb6121 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiDashboardPluginInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDashboardPluginIn']: return JsonApiDashboardPluginIn __annotations__ = { "data": data, } - + data: 'JsonApiDashboardPluginIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDashboardPluginIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDashboardPluginIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiDashboardPluginInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_dashboard_plugin_in import JsonApiDashboardPluginIn +from gooddata_api_client.models.json_api_dashboard_plugin_in import JsonApiDashboardPluginIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_linkage.py deleted file mode 100644 index 9ec0c7432..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiDashboardPluginLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DASHBOARDPLUGIN': "dashboardPlugin", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out.py deleted file mode 100644 index 523a9b705..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_dashboard_plugin_out_attributes import JsonApiDashboardPluginOutAttributes - from gooddata_api_client.model.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiDashboardPluginOutAttributes'] = JsonApiDashboardPluginOutAttributes - globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships - - -class JsonApiDashboardPluginOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DASHBOARDPLUGIN': "dashboardPlugin", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiDashboardPluginOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiDashboardPluginOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiDashboardPluginOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiDashboardPluginOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_attributes.py deleted file mode 100644 index f59569ad6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_attributes.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiDashboardPluginOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'content': 'content', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'description': 'description', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_document.py deleted file mode 100644 index e94476ad0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut - from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiDashboardPluginOut'] = JsonApiDashboardPluginOut - globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiDashboardPluginOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDashboardPluginOut,), # noqa: E501 - 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiDashboardPluginOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserIdentifierOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiDashboardPluginOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserIdentifierOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_document.pyi index 66df9d582..66ab72a0d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiDashboardPluginOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDashboardPluginOut']: return JsonApiDashboardPluginOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiDashboardPluginOutDocument( "data": data, "links": links, } - + data: 'JsonApiDashboardPluginOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDashboardPluginOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDashboardPluginOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiDashboardPluginOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_list.py deleted file mode 100644 index 18cc0c651..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks - from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiDashboardPluginOutWithLinks'] = JsonApiDashboardPluginOutWithLinks - globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiDashboardPluginOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiDashboardPluginOutWithLinks],), # noqa: E501 - 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOutList - a model defined in OpenAPI - - Args: - data ([JsonApiDashboardPluginOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserIdentifierOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOutList - a model defined in OpenAPI - - Args: - data ([JsonApiDashboardPluginOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserIdentifierOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_list.pyi index 103dcc636..5e2599d09 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiDashboardPluginOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiDashboardPluginOutWithLinks']: return JsonApiDashboardPluginOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiDashboardPluginOutWithLinks'], typing.List['JsonApiDashboardPluginOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiDashboardPluginOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiDashboardPluginOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiDashboardPluginOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiDashboardPluginOutList( **kwargs, ) -from gooddata_api_client.model.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_relationships.py deleted file mode 100644 index 7552a6b35..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_relationships.py +++ /dev/null @@ -1,274 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - - -class JsonApiDashboardPluginOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'created_by': 'createdBy', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_with_links.py deleted file mode 100644 index c98f8db60..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut - from gooddata_api_client.model.json_api_dashboard_plugin_out_attributes import JsonApiDashboardPluginOutAttributes - from gooddata_api_client.model.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiDashboardPluginOut'] = JsonApiDashboardPluginOut - globals()['JsonApiDashboardPluginOutAttributes'] = JsonApiDashboardPluginOutAttributes - globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiDashboardPluginOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DASHBOARDPLUGIN': "dashboardPlugin", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiDashboardPluginOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiDashboardPluginOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiDashboardPluginOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiDashboardPluginOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiDashboardPluginOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_with_links.pyi index 119d0b793..ff46d8366 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiDashboardPluginOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiDashboardPluginOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_patch.py deleted file mode 100644 index 19258f6b3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_patch.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dashboard_plugin_in_attributes import JsonApiDashboardPluginInAttributes - globals()['JsonApiDashboardPluginInAttributes'] = JsonApiDashboardPluginInAttributes - - -class JsonApiDashboardPluginPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DASHBOARDPLUGIN': "dashboardPlugin", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiDashboardPluginInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiDashboardPluginInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiDashboardPluginInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_patch_document.py deleted file mode 100644 index 6faa17cac..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dashboard_plugin_patch import JsonApiDashboardPluginPatch - globals()['JsonApiDashboardPluginPatch'] = JsonApiDashboardPluginPatch - - -class JsonApiDashboardPluginPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDashboardPluginPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiDashboardPluginPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiDashboardPluginPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_patch_document.pyi index 84716e895..d6b946259 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiDashboardPluginPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDashboardPluginPatch']: return JsonApiDashboardPluginPatch __annotations__ = { "data": data, } - + data: 'JsonApiDashboardPluginPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDashboardPluginPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDashboardPluginPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiDashboardPluginPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_dashboard_plugin_patch import JsonApiDashboardPluginPatch +from gooddata_api_client.models.json_api_dashboard_plugin_patch import JsonApiDashboardPluginPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id.py deleted file mode 100644 index 8274babc8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dashboard_plugin_in_attributes import JsonApiDashboardPluginInAttributes - globals()['JsonApiDashboardPluginInAttributes'] = JsonApiDashboardPluginInAttributes - - -class JsonApiDashboardPluginPostOptionalId(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DASHBOARDPLUGIN': "dashboardPlugin", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiDashboardPluginInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginPostOptionalId - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): Object type. defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiDashboardPluginInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginPostOptionalId - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): Object type. defaults to "dashboardPlugin", must be one of ["dashboardPlugin", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiDashboardPluginInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dashboardPlugin") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id_document.py deleted file mode 100644 index c4577287d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id import JsonApiDashboardPluginPostOptionalId - globals()['JsonApiDashboardPluginPostOptionalId'] = JsonApiDashboardPluginPostOptionalId - - -class JsonApiDashboardPluginPostOptionalIdDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDashboardPluginPostOptionalId,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiDashboardPluginPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDashboardPluginPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiDashboardPluginPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id_document.pyi index a237fa9f5..98fecedb1 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_post_optional_id_document.pyi @@ -38,38 +38,38 @@ class JsonApiDashboardPluginPostOptionalIdDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDashboardPluginPostOptionalId']: return JsonApiDashboardPluginPostOptionalId __annotations__ = { "data": data, } - + data: 'JsonApiDashboardPluginPostOptionalId' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDashboardPluginPostOptionalId': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDashboardPluginPostOptionalId': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiDashboardPluginPostOptionalIdDocument( **kwargs, ) -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id import JsonApiDashboardPluginPostOptionalId +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id import JsonApiDashboardPluginPostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_to_many_linkage.py deleted file mode 100644 index 206fd3a09..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dashboard_plugin_linkage import JsonApiDashboardPluginLinkage - globals()['JsonApiDashboardPluginLinkage'] = JsonApiDashboardPluginLinkage - - -class JsonApiDashboardPluginToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiDashboardPluginLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiDashboardPluginToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiDashboardPluginLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiDashboardPluginLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiDashboardPluginToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiDashboardPluginLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiDashboardPluginLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_to_many_linkage.pyi index e6c56453c..cfb592a45 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_to_many_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_to_many_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiDashboardPluginToManyLinkage( class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiDashboardPluginLinkage']: return JsonApiDashboardPluginLinkage @@ -56,4 +56,4 @@ class JsonApiDashboardPluginToManyLinkage( def __getitem__(self, i: int) -> 'JsonApiDashboardPluginLinkage': return super().__getitem__(i) -from gooddata_api_client.model.json_api_dashboard_plugin_linkage import JsonApiDashboardPluginLinkage +from gooddata_api_client.models.json_api_dashboard_plugin_linkage import JsonApiDashboardPluginLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out.py deleted file mode 100644 index ad7ea3ef5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_identifier_out_attributes import JsonApiDataSourceIdentifierOutAttributes - from gooddata_api_client.model.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta - globals()['JsonApiDataSourceIdentifierOutAttributes'] = JsonApiDataSourceIdentifierOutAttributes - globals()['JsonApiDataSourceIdentifierOutMeta'] = JsonApiDataSourceIdentifierOutMeta - - -class JsonApiDataSourceIdentifierOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASOURCEIDENTIFIER': "dataSourceIdentifier", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiDataSourceIdentifierOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiDataSourceIdentifierOutMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOut - a model defined in OpenAPI - - Args: - attributes (JsonApiDataSourceIdentifierOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dataSourceIdentifier", must be one of ["dataSourceIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiDataSourceIdentifierOutMeta): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataSourceIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOut - a model defined in OpenAPI - - Args: - attributes (JsonApiDataSourceIdentifierOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dataSourceIdentifier", must be one of ["dataSourceIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiDataSourceIdentifierOutMeta): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataSourceIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py deleted file mode 100644 index 0de851700..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py +++ /dev/null @@ -1,316 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiDataSourceIdentifierOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'POSTGRESQL': "POSTGRESQL", - 'REDSHIFT': "REDSHIFT", - 'VERTICA': "VERTICA", - 'SNOWFLAKE': "SNOWFLAKE", - 'ADS': "ADS", - 'BIGQUERY': "BIGQUERY", - 'MSSQL': "MSSQL", - 'PRESTO': "PRESTO", - 'DREMIO': "DREMIO", - 'DRILL': "DRILL", - 'GREENPLUM': "GREENPLUM", - 'AZURESQL': "AZURESQL", - 'SYNAPSESQL': "SYNAPSESQL", - 'DATABRICKS': "DATABRICKS", - 'GDSTORAGE': "GDSTORAGE", - 'CLICKHOUSE': "CLICKHOUSE", - 'MYSQL': "MYSQL", - 'MARIADB': "MARIADB", - 'ORACLE': "ORACLE", - 'PINOT': "PINOT", - 'SINGLESTORE': "SINGLESTORE", - 'MOTHERDUCK': "MOTHERDUCK", - 'FLEXCONNECT': "FLEXCONNECT", - 'STARROCKS': "STARROCKS", - 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", - }, - } - - validations = { - ('name',): { - 'max_length': 255, - }, - ('schema',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'schema': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'schema': 'schema', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, schema, type, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOutAttributes - a model defined in OpenAPI - - Args: - name (str): - schema (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.schema = schema - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, name, schema, type, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOutAttributes - a model defined in OpenAPI - - Args: - name (str): - schema (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.schema = schema - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_document.py deleted file mode 100644 index 0816d214d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_identifier_out import JsonApiDataSourceIdentifierOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiDataSourceIdentifierOut'] = JsonApiDataSourceIdentifierOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiDataSourceIdentifierOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDataSourceIdentifierOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiDataSourceIdentifierOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiDataSourceIdentifierOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_document.pyi index 232d27e42..50bdcca7c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiDataSourceIdentifierOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDataSourceIdentifierOut']: return JsonApiDataSourceIdentifierOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiDataSourceIdentifierOutDocument( "data": data, "links": links, } - + data: 'JsonApiDataSourceIdentifierOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDataSourceIdentifierOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDataSourceIdentifierOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiDataSourceIdentifierOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_data_source_identifier_out import JsonApiDataSourceIdentifierOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_data_source_identifier_out import JsonApiDataSourceIdentifierOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_list.py deleted file mode 100644 index 6f38cd5da..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_data_source_identifier_out_with_links import JsonApiDataSourceIdentifierOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiDataSourceIdentifierOutWithLinks'] = JsonApiDataSourceIdentifierOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiDataSourceIdentifierOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiDataSourceIdentifierOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOutList - a model defined in OpenAPI - - Args: - data ([JsonApiDataSourceIdentifierOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOutList - a model defined in OpenAPI - - Args: - data ([JsonApiDataSourceIdentifierOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_list.pyi index c8cc3b56c..dd4c1296a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiDataSourceIdentifierOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiDataSourceIdentifierOutWithLinks']: return JsonApiDataSourceIdentifierOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiDataSourceIdentifierOutWithLinks'], typing.List['JsonApiDataSourceIdentifierOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiDataSourceIdentifierOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiDataSourceIdentifierOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiDataSourceIdentifierOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiDataSourceIdentifierOutList( **kwargs, ) -from gooddata_api_client.model.json_api_data_source_identifier_out_with_links import JsonApiDataSourceIdentifierOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_data_source_identifier_out_with_links import JsonApiDataSourceIdentifierOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_meta.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_meta.py deleted file mode 100644 index 4e93966c4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_meta.py +++ /dev/null @@ -1,268 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiDataSourceIdentifierOutMeta(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('permissions',): { - 'MANAGE': "MANAGE", - 'USE': "USE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'permissions': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOutMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([str]): List of valid permissions for a logged-in user.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOutMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([str]): List of valid permissions for a logged-in user.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_with_links.py deleted file mode 100644 index 5cbdbfa87..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_with_links.py +++ /dev/null @@ -1,355 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_identifier_out import JsonApiDataSourceIdentifierOut - from gooddata_api_client.model.json_api_data_source_identifier_out_attributes import JsonApiDataSourceIdentifierOutAttributes - from gooddata_api_client.model.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiDataSourceIdentifierOut'] = JsonApiDataSourceIdentifierOut - globals()['JsonApiDataSourceIdentifierOutAttributes'] = JsonApiDataSourceIdentifierOutAttributes - globals()['JsonApiDataSourceIdentifierOutMeta'] = JsonApiDataSourceIdentifierOutMeta - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiDataSourceIdentifierOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASOURCEIDENTIFIER': "dataSourceIdentifier", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiDataSourceIdentifierOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiDataSourceIdentifierOutMeta,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiDataSourceIdentifierOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "dataSourceIdentifier", must be one of ["dataSourceIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiDataSourceIdentifierOutMeta): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataSourceIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIdentifierOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiDataSourceIdentifierOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "dataSourceIdentifier", must be one of ["dataSourceIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiDataSourceIdentifierOutMeta): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataSourceIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiDataSourceIdentifierOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_with_links.pyi index 7f7da7f92..5a6e665f8 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiDataSourceIdentifierOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiDataSourceIdentifierOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_data_source_identifier_out import JsonApiDataSourceIdentifierOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_data_source_identifier_out import JsonApiDataSourceIdentifierOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in.py deleted file mode 100644 index 8712da2ed..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_in_attributes import JsonApiDataSourceInAttributes - globals()['JsonApiDataSourceInAttributes'] = JsonApiDataSourceInAttributes - - -class JsonApiDataSourceIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASOURCE': "dataSource", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiDataSourceInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIn - a model defined in OpenAPI - - Args: - attributes (JsonApiDataSourceInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dataSource", must be one of ["dataSource", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataSource") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceIn - a model defined in OpenAPI - - Args: - attributes (JsonApiDataSourceInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dataSource", must be one of ["dataSource", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataSource") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes.py deleted file mode 100644 index 98b6ee87d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes.py +++ /dev/null @@ -1,391 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner - globals()['JsonApiDataSourceInAttributesParametersInner'] = JsonApiDataSourceInAttributesParametersInner - - -class JsonApiDataSourceInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'POSTGRESQL': "POSTGRESQL", - 'REDSHIFT': "REDSHIFT", - 'VERTICA': "VERTICA", - 'SNOWFLAKE': "SNOWFLAKE", - 'ADS': "ADS", - 'BIGQUERY': "BIGQUERY", - 'MSSQL': "MSSQL", - 'PRESTO': "PRESTO", - 'DREMIO': "DREMIO", - 'DRILL': "DRILL", - 'GREENPLUM': "GREENPLUM", - 'AZURESQL': "AZURESQL", - 'SYNAPSESQL': "SYNAPSESQL", - 'DATABRICKS': "DATABRICKS", - 'GDSTORAGE': "GDSTORAGE", - 'CLICKHOUSE': "CLICKHOUSE", - 'MYSQL': "MYSQL", - 'MARIADB': "MARIADB", - 'ORACLE': "ORACLE", - 'PINOT': "PINOT", - 'SINGLESTORE': "SINGLESTORE", - 'MOTHERDUCK': "MOTHERDUCK", - 'FLEXCONNECT': "FLEXCONNECT", - 'STARROCKS': "STARROCKS", - 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", - }, - ('cache_strategy',): { - 'None': None, - 'ALWAYS': "ALWAYS", - 'NEVER': "NEVER", - }, - } - - validations = { - ('name',): { - 'max_length': 255, - }, - ('schema',): { - 'max_length': 255, - }, - ('client_id',): { - 'max_length': 255, - }, - ('client_secret',): { - 'max_length': 255, - }, - ('password',): { - 'max_length': 255, - }, - ('private_key',): { - 'max_length': 15000, - }, - ('private_key_passphrase',): { - 'max_length': 255, - }, - ('token',): { - 'max_length': 10000, - }, - ('url',): { - 'max_length': 255, - }, - ('username',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'name': (str,), # noqa: E501 - 'schema': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'cache_strategy': (str, none_type,), # noqa: E501 - 'client_id': (str, none_type,), # noqa: E501 - 'client_secret': (str, none_type,), # noqa: E501 - 'parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 - 'password': (str, none_type,), # noqa: E501 - 'private_key': (str, none_type,), # noqa: E501 - 'private_key_passphrase': (str, none_type,), # noqa: E501 - 'token': (str, none_type,), # noqa: E501 - 'url': (str, none_type,), # noqa: E501 - 'username': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'schema': 'schema', # noqa: E501 - 'type': 'type', # noqa: E501 - 'cache_strategy': 'cacheStrategy', # noqa: E501 - 'client_id': 'clientId', # noqa: E501 - 'client_secret': 'clientSecret', # noqa: E501 - 'parameters': 'parameters', # noqa: E501 - 'password': 'password', # noqa: E501 - 'private_key': 'privateKey', # noqa: E501 - 'private_key_passphrase': 'privateKeyPassphrase', # noqa: E501 - 'token': 'token', # noqa: E501 - 'url': 'url', # noqa: E501 - 'username': 'username', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, schema, type, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceInAttributes - a model defined in OpenAPI - - Args: - name (str): User-facing name of the data source. - schema (str): The schema to use as the root of the data for the data source. - type (str): Type of the database providing the data for the data source. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 - client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 - client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 - parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Additional parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 - password (str, none_type): The password to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - private_key (str, none_type): The private key to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - private_key_passphrase (str, none_type): The passphrase used to encrypt the private key.. [optional] # noqa: E501 - token (str, none_type): The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).. [optional] # noqa: E501 - url (str, none_type): The URL of the database providing the data for the data source.. [optional] # noqa: E501 - username (str, none_type): The username to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.schema = schema - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, name, schema, type, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceInAttributes - a model defined in OpenAPI - - Args: - name (str): User-facing name of the data source. - schema (str): The schema to use as the root of the data for the data source. - type (str): Type of the database providing the data for the data source. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 - client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 - client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 - parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Additional parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 - password (str, none_type): The password to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - private_key (str, none_type): The private key to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - private_key_passphrase (str, none_type): The passphrase used to encrypt the private key.. [optional] # noqa: E501 - token (str, none_type): The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).. [optional] # noqa: E501 - url (str, none_type): The URL of the database providing the data for the data source.. [optional] # noqa: E501 - username (str, none_type): The username to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.schema = schema - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes_parameters_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes_parameters_inner.py deleted file mode 100644 index 334ebc4ff..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes_parameters_inner.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiDataSourceInAttributesParametersInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'value': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, value, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceInAttributesParametersInner - a model defined in OpenAPI - - Args: - name (str): - value (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, name, value, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceInAttributesParametersInner - a model defined in OpenAPI - - Args: - name (str): - value (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_document.py deleted file mode 100644 index 366298100..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_in import JsonApiDataSourceIn - globals()['JsonApiDataSourceIn'] = JsonApiDataSourceIn - - -class JsonApiDataSourceInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDataSourceIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceInDocument - a model defined in OpenAPI - - Args: - data (JsonApiDataSourceIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceInDocument - a model defined in OpenAPI - - Args: - data (JsonApiDataSourceIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_document.pyi index b228128bd..56f5df1a9 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiDataSourceInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDataSourceIn']: return JsonApiDataSourceIn __annotations__ = { "data": data, } - + data: 'JsonApiDataSourceIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDataSourceIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDataSourceIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiDataSourceInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_data_source_in import JsonApiDataSourceIn +from gooddata_api_client.models.json_api_data_source_in import JsonApiDataSourceIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out.py deleted file mode 100644 index 12dcedf1b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta - from gooddata_api_client.model.json_api_data_source_out_attributes import JsonApiDataSourceOutAttributes - globals()['JsonApiDataSourceIdentifierOutMeta'] = JsonApiDataSourceIdentifierOutMeta - globals()['JsonApiDataSourceOutAttributes'] = JsonApiDataSourceOutAttributes - - -class JsonApiDataSourceOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASOURCE': "dataSource", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiDataSourceOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiDataSourceIdentifierOutMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceOut - a model defined in OpenAPI - - Args: - attributes (JsonApiDataSourceOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dataSource", must be one of ["dataSource", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiDataSourceIdentifierOutMeta): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataSource") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceOut - a model defined in OpenAPI - - Args: - attributes (JsonApiDataSourceOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dataSource", must be one of ["dataSource", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiDataSourceIdentifierOutMeta): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataSource") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py deleted file mode 100644 index 5252b1b90..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py +++ /dev/null @@ -1,372 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner - globals()['JsonApiDataSourceInAttributesParametersInner'] = JsonApiDataSourceInAttributesParametersInner - - -class JsonApiDataSourceOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'POSTGRESQL': "POSTGRESQL", - 'REDSHIFT': "REDSHIFT", - 'VERTICA': "VERTICA", - 'SNOWFLAKE': "SNOWFLAKE", - 'ADS': "ADS", - 'BIGQUERY': "BIGQUERY", - 'MSSQL': "MSSQL", - 'PRESTO': "PRESTO", - 'DREMIO': "DREMIO", - 'DRILL': "DRILL", - 'GREENPLUM': "GREENPLUM", - 'AZURESQL': "AZURESQL", - 'SYNAPSESQL': "SYNAPSESQL", - 'DATABRICKS': "DATABRICKS", - 'GDSTORAGE': "GDSTORAGE", - 'CLICKHOUSE': "CLICKHOUSE", - 'MYSQL': "MYSQL", - 'MARIADB': "MARIADB", - 'ORACLE': "ORACLE", - 'PINOT': "PINOT", - 'SINGLESTORE': "SINGLESTORE", - 'MOTHERDUCK': "MOTHERDUCK", - 'FLEXCONNECT': "FLEXCONNECT", - 'STARROCKS': "STARROCKS", - 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", - }, - ('authentication_type',): { - 'None': None, - 'USERNAME_PASSWORD': "USERNAME_PASSWORD", - 'TOKEN': "TOKEN", - 'KEY_PAIR': "KEY_PAIR", - 'CLIENT_SECRET': "CLIENT_SECRET", - 'ACCESS_TOKEN': "ACCESS_TOKEN", - }, - ('cache_strategy',): { - 'None': None, - 'ALWAYS': "ALWAYS", - 'NEVER': "NEVER", - }, - } - - validations = { - ('name',): { - 'max_length': 255, - }, - ('schema',): { - 'max_length': 255, - }, - ('client_id',): { - 'max_length': 255, - }, - ('url',): { - 'max_length': 255, - }, - ('username',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'name': (str,), # noqa: E501 - 'schema': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'authentication_type': (str, none_type,), # noqa: E501 - 'cache_strategy': (str, none_type,), # noqa: E501 - 'client_id': (str, none_type,), # noqa: E501 - 'decoded_parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 - 'parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 - 'url': (str, none_type,), # noqa: E501 - 'username': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'schema': 'schema', # noqa: E501 - 'type': 'type', # noqa: E501 - 'authentication_type': 'authenticationType', # noqa: E501 - 'cache_strategy': 'cacheStrategy', # noqa: E501 - 'client_id': 'clientId', # noqa: E501 - 'decoded_parameters': 'decodedParameters', # noqa: E501 - 'parameters': 'parameters', # noqa: E501 - 'url': 'url', # noqa: E501 - 'username': 'username', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, schema, type, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceOutAttributes - a model defined in OpenAPI - - Args: - name (str): User-facing name of the data source. - schema (str): The schema to use as the root of the data for the data source. - type (str): Type of the database providing the data for the data source. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 - cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 - client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 - decoded_parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Decoded parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 - parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Additional parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 - url (str, none_type): The URL of the database providing the data for the data source.. [optional] # noqa: E501 - username (str, none_type): The username to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.schema = schema - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, name, schema, type, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceOutAttributes - a model defined in OpenAPI - - Args: - name (str): User-facing name of the data source. - schema (str): The schema to use as the root of the data for the data source. - type (str): Type of the database providing the data for the data source. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 - cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 - client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 - decoded_parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Decoded parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 - parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Additional parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 - url (str, none_type): The URL of the database providing the data for the data source.. [optional] # noqa: E501 - username (str, none_type): The username to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.schema = schema - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_document.py deleted file mode 100644 index cff60d6c7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_out import JsonApiDataSourceOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiDataSourceOut'] = JsonApiDataSourceOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiDataSourceOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDataSourceOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiDataSourceOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiDataSourceOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_document.pyi index c54244ffd..ceeb449ce 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiDataSourceOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDataSourceOut']: return JsonApiDataSourceOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiDataSourceOutDocument( "data": data, "links": links, } - + data: 'JsonApiDataSourceOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDataSourceOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDataSourceOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiDataSourceOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_data_source_out import JsonApiDataSourceOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_data_source_out import JsonApiDataSourceOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_list.py deleted file mode 100644 index cb4f5fcbd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_data_source_out_with_links import JsonApiDataSourceOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiDataSourceOutWithLinks'] = JsonApiDataSourceOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiDataSourceOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiDataSourceOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceOutList - a model defined in OpenAPI - - Args: - data ([JsonApiDataSourceOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceOutList - a model defined in OpenAPI - - Args: - data ([JsonApiDataSourceOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_list.pyi index 78109e038..6dfc19767 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiDataSourceOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiDataSourceOutWithLinks']: return JsonApiDataSourceOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiDataSourceOutWithLinks'], typing.List['JsonApiDataSourceOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiDataSourceOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiDataSourceOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiDataSourceOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiDataSourceOutList( **kwargs, ) -from gooddata_api_client.model.json_api_data_source_out_with_links import JsonApiDataSourceOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_data_source_out_with_links import JsonApiDataSourceOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_with_links.py deleted file mode 100644 index 26cd07105..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_with_links.py +++ /dev/null @@ -1,355 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta - from gooddata_api_client.model.json_api_data_source_out import JsonApiDataSourceOut - from gooddata_api_client.model.json_api_data_source_out_attributes import JsonApiDataSourceOutAttributes - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiDataSourceIdentifierOutMeta'] = JsonApiDataSourceIdentifierOutMeta - globals()['JsonApiDataSourceOut'] = JsonApiDataSourceOut - globals()['JsonApiDataSourceOutAttributes'] = JsonApiDataSourceOutAttributes - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiDataSourceOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASOURCE': "dataSource", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiDataSourceOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiDataSourceIdentifierOutMeta,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiDataSourceOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "dataSource", must be one of ["dataSource", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiDataSourceIdentifierOutMeta): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataSource") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDataSourceOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiDataSourceOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "dataSource", must be one of ["dataSource", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiDataSourceIdentifierOutMeta): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataSource") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiDataSourceOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_with_links.pyi index f6ea15cdb..9ab4d52f2 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiDataSourceOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiDataSourceOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_data_source_out import JsonApiDataSourceOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_data_source_out import JsonApiDataSourceOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch.py deleted file mode 100644 index 4798f0c9f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_patch_attributes import JsonApiDataSourcePatchAttributes - globals()['JsonApiDataSourcePatchAttributes'] = JsonApiDataSourcePatchAttributes - - -class JsonApiDataSourcePatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASOURCE': "dataSource", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiDataSourcePatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiDataSourcePatch - a model defined in OpenAPI - - Args: - attributes (JsonApiDataSourcePatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dataSource", must be one of ["dataSource", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataSource") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiDataSourcePatch - a model defined in OpenAPI - - Args: - attributes (JsonApiDataSourcePatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dataSource", must be one of ["dataSource", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataSource") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_attributes.py deleted file mode 100644 index 48460d0f7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_attributes.py +++ /dev/null @@ -1,381 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner - globals()['JsonApiDataSourceInAttributesParametersInner'] = JsonApiDataSourceInAttributesParametersInner - - -class JsonApiDataSourcePatchAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('cache_strategy',): { - 'None': None, - 'ALWAYS': "ALWAYS", - 'NEVER': "NEVER", - }, - ('type',): { - 'POSTGRESQL': "POSTGRESQL", - 'REDSHIFT': "REDSHIFT", - 'VERTICA': "VERTICA", - 'SNOWFLAKE': "SNOWFLAKE", - 'ADS': "ADS", - 'BIGQUERY': "BIGQUERY", - 'MSSQL': "MSSQL", - 'PRESTO': "PRESTO", - 'DREMIO': "DREMIO", - 'DRILL': "DRILL", - 'GREENPLUM': "GREENPLUM", - 'AZURESQL': "AZURESQL", - 'SYNAPSESQL': "SYNAPSESQL", - 'DATABRICKS': "DATABRICKS", - 'GDSTORAGE': "GDSTORAGE", - 'CLICKHOUSE': "CLICKHOUSE", - 'MYSQL': "MYSQL", - 'MARIADB': "MARIADB", - 'ORACLE': "ORACLE", - 'PINOT': "PINOT", - 'SINGLESTORE': "SINGLESTORE", - 'MOTHERDUCK': "MOTHERDUCK", - 'FLEXCONNECT': "FLEXCONNECT", - 'STARROCKS': "STARROCKS", - 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", - }, - } - - validations = { - ('client_id',): { - 'max_length': 255, - }, - ('client_secret',): { - 'max_length': 255, - }, - ('name',): { - 'max_length': 255, - }, - ('password',): { - 'max_length': 255, - }, - ('private_key',): { - 'max_length': 15000, - }, - ('private_key_passphrase',): { - 'max_length': 255, - }, - ('schema',): { - 'max_length': 255, - }, - ('token',): { - 'max_length': 10000, - }, - ('url',): { - 'max_length': 255, - }, - ('username',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'cache_strategy': (str, none_type,), # noqa: E501 - 'client_id': (str, none_type,), # noqa: E501 - 'client_secret': (str, none_type,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 - 'password': (str, none_type,), # noqa: E501 - 'private_key': (str, none_type,), # noqa: E501 - 'private_key_passphrase': (str, none_type,), # noqa: E501 - 'schema': (str,), # noqa: E501 - 'token': (str, none_type,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'url': (str, none_type,), # noqa: E501 - 'username': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'cache_strategy': 'cacheStrategy', # noqa: E501 - 'client_id': 'clientId', # noqa: E501 - 'client_secret': 'clientSecret', # noqa: E501 - 'name': 'name', # noqa: E501 - 'parameters': 'parameters', # noqa: E501 - 'password': 'password', # noqa: E501 - 'private_key': 'privateKey', # noqa: E501 - 'private_key_passphrase': 'privateKeyPassphrase', # noqa: E501 - 'schema': 'schema', # noqa: E501 - 'token': 'token', # noqa: E501 - 'type': 'type', # noqa: E501 - 'url': 'url', # noqa: E501 - 'username': 'username', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDataSourcePatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 - client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 - client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 - name (str): User-facing name of the data source.. [optional] # noqa: E501 - parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Additional parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 - password (str, none_type): The password to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - private_key (str, none_type): The private key to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - private_key_passphrase (str, none_type): The passphrase used to encrypt the private key.. [optional] # noqa: E501 - schema (str): The schema to use as the root of the data for the data source.. [optional] # noqa: E501 - token (str, none_type): The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).. [optional] # noqa: E501 - type (str): Type of the database providing the data for the data source.. [optional] # noqa: E501 - url (str, none_type): The URL of the database providing the data for the data source.. [optional] # noqa: E501 - username (str, none_type): The username to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDataSourcePatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 - client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 - client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 - name (str): User-facing name of the data source.. [optional] # noqa: E501 - parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Additional parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 - password (str, none_type): The password to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - private_key (str, none_type): The private key to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - private_key_passphrase (str, none_type): The passphrase used to encrypt the private key.. [optional] # noqa: E501 - schema (str): The schema to use as the root of the data for the data source.. [optional] # noqa: E501 - token (str, none_type): The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).. [optional] # noqa: E501 - type (str): Type of the database providing the data for the data source.. [optional] # noqa: E501 - url (str, none_type): The URL of the database providing the data for the data source.. [optional] # noqa: E501 - username (str, none_type): The username to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_document.py deleted file mode 100644 index 5655ec187..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_data_source_patch import JsonApiDataSourcePatch - globals()['JsonApiDataSourcePatch'] = JsonApiDataSourcePatch - - -class JsonApiDataSourcePatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDataSourcePatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourcePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiDataSourcePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDataSourcePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiDataSourcePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_document.pyi index b05c834d5..30bc2d690 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiDataSourcePatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDataSourcePatch']: return JsonApiDataSourcePatch __annotations__ = { "data": data, } - + data: 'JsonApiDataSourcePatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDataSourcePatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDataSourcePatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiDataSourcePatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_data_source_patch import JsonApiDataSourcePatch +from gooddata_api_client.models.json_api_data_source_patch import JsonApiDataSourcePatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_document.pyi index df554d3db..c535238cf 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiDataSourceTableOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDataSourceTableOut']: return JsonApiDataSourceTableOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiDataSourceTableOutDocument( "data": data, "links": links, } - + data: 'JsonApiDataSourceTableOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDataSourceTableOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDataSourceTableOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiDataSourceTableOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_data_source_table_out import JsonApiDataSourceTableOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_data_source_table_out import JsonApiDataSourceTableOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_list.pyi index ca8a2cbae..3efe3b640 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiDataSourceTableOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiDataSourceTableOutWithLinks']: return JsonApiDataSourceTableOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiDataSourceTableOutWithLinks'], typing.List['JsonApiDataSourceTableOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiDataSourceTableOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiDataSourceTableOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiDataSourceTableOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiDataSourceTableOutList( **kwargs, ) -from gooddata_api_client.model.json_api_data_source_table_out_with_links import JsonApiDataSourceTableOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_data_source_table_out_with_links import JsonApiDataSourceTableOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_with_links.pyi index 7004a90e2..8d89dc01b 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_table_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiDataSourceTableOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiDataSourceTableOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_data_source_table_out import JsonApiDataSourceTableOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_data_source_table_out import JsonApiDataSourceTableOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_linkage.py deleted file mode 100644 index 097dd3b5b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiDatasetLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASET': "dataset", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiDatasetLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiDatasetLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out.py deleted file mode 100644 index 7eca76592..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out.py +++ /dev/null @@ -1,310 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_dataset_out_attributes import JsonApiDatasetOutAttributes - from gooddata_api_client.model.json_api_dataset_out_relationships import JsonApiDatasetOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiDatasetOutAttributes'] = JsonApiDatasetOutAttributes - globals()['JsonApiDatasetOutRelationships'] = JsonApiDatasetOutRelationships - - -class JsonApiDatasetOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASET': "dataset", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiDatasetOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiDatasetOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOut - a model defined in OpenAPI - - Args: - attributes (JsonApiDatasetOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDatasetOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOut - a model defined in OpenAPI - - Args: - attributes (JsonApiDatasetOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDatasetOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out.pyi index 5e831927c..7c0cc032c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out.pyi @@ -1162,7 +1162,7 @@ class JsonApiDatasetOut( **kwargs, ) -from gooddata_api_client.model.dataset_reference_identifier import DatasetReferenceIdentifier -from gooddata_api_client.model.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage -from gooddata_api_client.model.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage -from gooddata_api_client.model.json_api_fact_to_many_linkage import JsonApiFactToManyLinkage +from gooddata_api_client.models.dataset_reference_identifier import DatasetReferenceIdentifier +from gooddata_api_client.models.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage +from gooddata_api_client.models.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage +from gooddata_api_client.models.json_api_fact_to_many_linkage import JsonApiFactToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes.py deleted file mode 100644 index acfbbf852..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes.py +++ /dev/null @@ -1,345 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dataset_out_attributes_grain_inner import JsonApiDatasetOutAttributesGrainInner - from gooddata_api_client.model.json_api_dataset_out_attributes_reference_properties_inner import JsonApiDatasetOutAttributesReferencePropertiesInner - from gooddata_api_client.model.json_api_dataset_out_attributes_sql import JsonApiDatasetOutAttributesSql - from gooddata_api_client.model.json_api_dataset_out_attributes_workspace_data_filter_columns_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner - from gooddata_api_client.model.json_api_dataset_out_attributes_workspace_data_filter_references_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner - globals()['JsonApiDatasetOutAttributesGrainInner'] = JsonApiDatasetOutAttributesGrainInner - globals()['JsonApiDatasetOutAttributesReferencePropertiesInner'] = JsonApiDatasetOutAttributesReferencePropertiesInner - globals()['JsonApiDatasetOutAttributesSql'] = JsonApiDatasetOutAttributesSql - globals()['JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner'] = JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner - globals()['JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner'] = JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner - - -class JsonApiDatasetOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'NORMAL': "NORMAL", - 'DATE': "DATE", - }, - } - - validations = { - ('data_source_table_id',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'data_source_table_id': (str,), # noqa: E501 - 'data_source_table_path': ([str],), # noqa: E501 - 'description': (str,), # noqa: E501 - 'grain': ([JsonApiDatasetOutAttributesGrainInner],), # noqa: E501 - 'precedence': (int,), # noqa: E501 - 'reference_properties': ([JsonApiDatasetOutAttributesReferencePropertiesInner],), # noqa: E501 - 'sql': (JsonApiDatasetOutAttributesSql,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - 'workspace_data_filter_columns': ([JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner],), # noqa: E501 - 'workspace_data_filter_references': ([JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'data_source_table_id': 'dataSourceTableId', # noqa: E501 - 'data_source_table_path': 'dataSourceTablePath', # noqa: E501 - 'description': 'description', # noqa: E501 - 'grain': 'grain', # noqa: E501 - 'precedence': 'precedence', # noqa: E501 - 'reference_properties': 'referenceProperties', # noqa: E501 - 'sql': 'sql', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - 'workspace_data_filter_columns': 'workspaceDataFilterColumns', # noqa: E501 - 'workspace_data_filter_references': 'workspaceDataFilterReferences', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributes - a model defined in OpenAPI - - Args: - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - data_source_table_id (str): [optional] # noqa: E501 - data_source_table_path ([str]): Path to database table.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - grain ([JsonApiDatasetOutAttributesGrainInner]): [optional] # noqa: E501 - precedence (int): [optional] # noqa: E501 - reference_properties ([JsonApiDatasetOutAttributesReferencePropertiesInner]): [optional] # noqa: E501 - sql (JsonApiDatasetOutAttributesSql): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - workspace_data_filter_columns ([JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner]): [optional] # noqa: E501 - workspace_data_filter_references ([JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, type, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributes - a model defined in OpenAPI - - Args: - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - data_source_table_id (str): [optional] # noqa: E501 - data_source_table_path ([str]): Path to database table.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - grain ([JsonApiDatasetOutAttributesGrainInner]): [optional] # noqa: E501 - precedence (int): [optional] # noqa: E501 - reference_properties ([JsonApiDatasetOutAttributesReferencePropertiesInner]): [optional] # noqa: E501 - sql (JsonApiDatasetOutAttributesSql): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - workspace_data_filter_columns ([JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner]): [optional] # noqa: E501 - workspace_data_filter_references ([JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_grain_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_grain_inner.py deleted file mode 100644 index f2062b651..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_grain_inner.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiDatasetOutAttributesGrainInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ATTRIBUTE': "attribute", - 'DATE': "date", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributesGrainInner - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributesGrainInner - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_reference_properties_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_reference_properties_inner.py deleted file mode 100644 index bb27bf267..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_reference_properties_inner.py +++ /dev/null @@ -1,305 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dataset_reference_identifier import DatasetReferenceIdentifier - from gooddata_api_client.model.reference_source_column import ReferenceSourceColumn - globals()['DatasetReferenceIdentifier'] = DatasetReferenceIdentifier - globals()['ReferenceSourceColumn'] = ReferenceSourceColumn - - -class JsonApiDatasetOutAttributesReferencePropertiesInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('source_column_data_types',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'identifier': (DatasetReferenceIdentifier,), # noqa: E501 - 'multivalue': (bool,), # noqa: E501 - 'source_column_data_types': ([str],), # noqa: E501 - 'source_columns': ([str],), # noqa: E501 - 'sources': ([ReferenceSourceColumn],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'identifier': 'identifier', # noqa: E501 - 'multivalue': 'multivalue', # noqa: E501 - 'source_column_data_types': 'sourceColumnDataTypes', # noqa: E501 - 'source_columns': 'sourceColumns', # noqa: E501 - 'sources': 'sources', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, identifier, multivalue, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributesReferencePropertiesInner - a model defined in OpenAPI - - Args: - identifier (DatasetReferenceIdentifier): - multivalue (bool): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - source_column_data_types ([str]): [optional] # noqa: E501 - source_columns ([str]): [optional] # noqa: E501 - sources ([ReferenceSourceColumn]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - self.multivalue = multivalue - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, identifier, multivalue, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributesReferencePropertiesInner - a model defined in OpenAPI - - Args: - identifier (DatasetReferenceIdentifier): - multivalue (bool): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - source_column_data_types ([str]): [optional] # noqa: E501 - source_columns ([str]): [optional] # noqa: E501 - sources ([ReferenceSourceColumn]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.identifier = identifier - self.multivalue = multivalue - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_sql.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_sql.py deleted file mode 100644 index cc2823140..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_sql.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiDatasetOutAttributesSql(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'data_source_id': (str,), # noqa: E501 - 'statement': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_source_id': 'dataSourceId', # noqa: E501 - 'statement': 'statement', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_source_id, statement, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributesSql - a model defined in OpenAPI - - Args: - data_source_id (str): - statement (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_source_id = data_source_id - self.statement = statement - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_source_id, statement, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributesSql - a model defined in OpenAPI - - Args: - data_source_id (str): - statement (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_source_id = data_source_id - self.statement = statement - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_workspace_data_filter_columns_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_workspace_data_filter_columns_inner.py deleted file mode 100644 index 4c2c0c3a0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_workspace_data_filter_columns_inner.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'data_type': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_type': 'dataType', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_type, name, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner - a model defined in OpenAPI - - Args: - data_type (str): - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_type = data_type - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_type, name, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner - a model defined in OpenAPI - - Args: - data_type (str): - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_type = data_type - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_workspace_data_filter_references_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_workspace_data_filter_references_inner.py deleted file mode 100644 index 0fedbc0a7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_attributes_workspace_data_filter_references_inner.py +++ /dev/null @@ -1,297 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier - globals()['DatasetWorkspaceDataFilterIdentifier'] = DatasetWorkspaceDataFilterIdentifier - - -class JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('filter_column_data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'filter_column': (str,), # noqa: E501 - 'filter_column_data_type': (str,), # noqa: E501 - 'filter_id': (DatasetWorkspaceDataFilterIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'filter_column': 'filterColumn', # noqa: E501 - 'filter_column_data_type': 'filterColumnDataType', # noqa: E501 - 'filter_id': 'filterId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, filter_column, filter_column_data_type, filter_id, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner - a model defined in OpenAPI - - Args: - filter_column (str): - filter_column_data_type (str): - filter_id (DatasetWorkspaceDataFilterIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter_column = filter_column - self.filter_column_data_type = filter_column_data_type - self.filter_id = filter_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, filter_column, filter_column_data_type, filter_id, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner - a model defined in OpenAPI - - Args: - filter_column (str): - filter_column_data_type (str): - filter_id (DatasetWorkspaceDataFilterIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter_column = filter_column - self.filter_column_data_type = filter_column_data_type - self.filter_id = filter_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_document.py deleted file mode 100644 index 9b9a606c5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dataset_out import JsonApiDatasetOut - from gooddata_api_client.model.json_api_dataset_out_includes import JsonApiDatasetOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiDatasetOut'] = JsonApiDatasetOut - globals()['JsonApiDatasetOutIncludes'] = JsonApiDatasetOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiDatasetOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiDatasetOut,), # noqa: E501 - 'included': ([JsonApiDatasetOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiDatasetOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiDatasetOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiDatasetOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiDatasetOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_document.pyi index dbd6c5427..4987afdcc 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiDatasetOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDatasetOut']: return JsonApiDatasetOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiDatasetOutIncludes']: return JsonApiDatasetOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiDatasetOutIncludes'], typing.List['JsonApiDatasetOutIncludes']], @@ -67,10 +67,10 @@ class JsonApiDatasetOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiDatasetOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiDatasetOutDocument( "included": included, "links": links, } - + data: 'JsonApiDatasetOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiDatasetOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_dataset_out import JsonApiDatasetOut -from gooddata_api_client.model.json_api_dataset_out_includes import JsonApiDatasetOutIncludes -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_dataset_out import JsonApiDatasetOut +from gooddata_api_client.models.json_api_dataset_out_includes import JsonApiDatasetOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_includes.py deleted file mode 100644 index 97c7467ee..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_includes.py +++ /dev/null @@ -1,368 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_aggregated_fact_out_with_links import JsonApiAggregatedFactOutWithLinks - from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks - from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks - from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks - from gooddata_api_client.model.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes - from gooddata_api_client.model.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships - from gooddata_api_client.model.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAggregatedFactOutWithLinks'] = JsonApiAggregatedFactOutWithLinks - globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks - globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks - globals()['JsonApiFactOutWithLinks'] = JsonApiFactOutWithLinks - globals()['JsonApiWorkspaceDataFilterInAttributes'] = JsonApiWorkspaceDataFilterInAttributes - globals()['JsonApiWorkspaceDataFilterInRelationships'] = JsonApiWorkspaceDataFilterInRelationships - globals()['JsonApiWorkspaceDataFilterOutWithLinks'] = JsonApiWorkspaceDataFilterOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiDatasetOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTER': "workspaceDataFilter", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiWorkspaceDataFilterInRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - 'attributes': (JsonApiWorkspaceDataFilterInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiWorkspaceDataFilterInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "workspaceDataFilter" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiWorkspaceDataFilterInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "workspaceDataFilter" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAggregatedFactOutWithLinks, - JsonApiAttributeOutWithLinks, - JsonApiDatasetOutWithLinks, - JsonApiFactOutWithLinks, - JsonApiWorkspaceDataFilterOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_includes.pyi index 4ee0080f8..7879a1e49 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_includes.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_includes.pyi @@ -35,7 +35,7 @@ class JsonApiDatasetOutIncludes( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -66,6 +66,6 @@ class JsonApiDatasetOutIncludes( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks -from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks -from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_list.py deleted file mode 100644 index 5798cfa4b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_dataset_out_includes import JsonApiDatasetOutIncludes - from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiDatasetOutIncludes'] = JsonApiDatasetOutIncludes - globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiDatasetOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiDatasetOutWithLinks],), # noqa: E501 - 'included': ([JsonApiDatasetOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutList - a model defined in OpenAPI - - Args: - data ([JsonApiDatasetOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiDatasetOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutList - a model defined in OpenAPI - - Args: - data ([JsonApiDatasetOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiDatasetOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_list.pyi index 179240617..7452e452b 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiDatasetOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiDatasetOutWithLinks']: return JsonApiDatasetOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiDatasetOutWithLinks'], typing.List['JsonApiDatasetOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiDatasetOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiDatasetOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiDatasetOutIncludes']: return JsonApiDatasetOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiDatasetOutIncludes'], typing.List['JsonApiDatasetOutIncludes']], @@ -91,10 +91,10 @@ class JsonApiDatasetOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiDatasetOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiDatasetOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,6 +158,6 @@ class JsonApiDatasetOutList( **kwargs, ) -from gooddata_api_client.model.json_api_dataset_out_includes import JsonApiDatasetOutIncludes -from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_dataset_out_includes import JsonApiDatasetOutIncludes +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships.py deleted file mode 100644 index b518ea522..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets - from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes - from gooddata_api_client.model.json_api_dataset_out_relationships_aggregated_facts import JsonApiDatasetOutRelationshipsAggregatedFacts - from gooddata_api_client.model.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts - from gooddata_api_client.model.json_api_dataset_out_relationships_workspace_data_filters import JsonApiDatasetOutRelationshipsWorkspaceDataFilters - globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets - globals()['JsonApiAttributeHierarchyOutRelationshipsAttributes'] = JsonApiAttributeHierarchyOutRelationshipsAttributes - globals()['JsonApiDatasetOutRelationshipsAggregatedFacts'] = JsonApiDatasetOutRelationshipsAggregatedFacts - globals()['JsonApiDatasetOutRelationshipsFacts'] = JsonApiDatasetOutRelationshipsFacts - globals()['JsonApiDatasetOutRelationshipsWorkspaceDataFilters'] = JsonApiDatasetOutRelationshipsWorkspaceDataFilters - - -class JsonApiDatasetOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'aggregated_facts': (JsonApiDatasetOutRelationshipsAggregatedFacts,), # noqa: E501 - 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 - 'facts': (JsonApiDatasetOutRelationshipsFacts,), # noqa: E501 - 'references': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 - 'workspace_data_filters': (JsonApiDatasetOutRelationshipsWorkspaceDataFilters,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'aggregated_facts': 'aggregatedFacts', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'facts': 'facts', # noqa: E501 - 'references': 'references', # noqa: E501 - 'workspace_data_filters': 'workspaceDataFilters', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aggregated_facts (JsonApiDatasetOutRelationshipsAggregatedFacts): [optional] # noqa: E501 - attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 - references (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - workspace_data_filters (JsonApiDatasetOutRelationshipsWorkspaceDataFilters): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aggregated_facts (JsonApiDatasetOutRelationshipsAggregatedFacts): [optional] # noqa: E501 - attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 - references (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - workspace_data_filters (JsonApiDatasetOutRelationshipsWorkspaceDataFilters): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_aggregated_facts.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_aggregated_facts.py deleted file mode 100644 index 9062e20e6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_aggregated_facts.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_to_many_linkage import JsonApiAggregatedFactToManyLinkage - globals()['JsonApiAggregatedFactToManyLinkage'] = JsonApiAggregatedFactToManyLinkage - - -class JsonApiDatasetOutRelationshipsAggregatedFacts(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAggregatedFactToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutRelationshipsAggregatedFacts - a model defined in OpenAPI - - Args: - data (JsonApiAggregatedFactToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutRelationshipsAggregatedFacts - a model defined in OpenAPI - - Args: - data (JsonApiAggregatedFactToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_facts.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_facts.py deleted file mode 100644 index 43b39cda2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_facts.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_fact_to_many_linkage import JsonApiFactToManyLinkage - globals()['JsonApiFactToManyLinkage'] = JsonApiFactToManyLinkage - - -class JsonApiDatasetOutRelationshipsFacts(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiFactToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutRelationshipsFacts - a model defined in OpenAPI - - Args: - data (JsonApiFactToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutRelationshipsFacts - a model defined in OpenAPI - - Args: - data (JsonApiFactToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_workspace_data_filters.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_workspace_data_filters.py deleted file mode 100644 index a472936cd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_workspace_data_filters.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_to_many_linkage import JsonApiWorkspaceDataFilterToManyLinkage - globals()['JsonApiWorkspaceDataFilterToManyLinkage'] = JsonApiWorkspaceDataFilterToManyLinkage - - -class JsonApiDatasetOutRelationshipsWorkspaceDataFilters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceDataFilterToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutRelationshipsWorkspaceDataFilters - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutRelationshipsWorkspaceDataFilters - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_with_links.py deleted file mode 100644 index de5592118..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_dataset_out import JsonApiDatasetOut - from gooddata_api_client.model.json_api_dataset_out_attributes import JsonApiDatasetOutAttributes - from gooddata_api_client.model.json_api_dataset_out_relationships import JsonApiDatasetOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiDatasetOut'] = JsonApiDatasetOut - globals()['JsonApiDatasetOutAttributes'] = JsonApiDatasetOutAttributes - globals()['JsonApiDatasetOutRelationships'] = JsonApiDatasetOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiDatasetOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASET': "dataset", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiDatasetOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiDatasetOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiDatasetOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDatasetOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiDatasetOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDatasetOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiDatasetOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_with_links.pyi index 9100554f8..cba662537 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiDatasetOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiDatasetOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_dataset_out import JsonApiDatasetOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_dataset_out import JsonApiDatasetOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_many_linkage.py deleted file mode 100644 index f228efdf0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dataset_linkage import JsonApiDatasetLinkage - globals()['JsonApiDatasetLinkage'] = JsonApiDatasetLinkage - - -class JsonApiDatasetToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiDatasetLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiDatasetToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiDatasetLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiDatasetLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiDatasetToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiDatasetLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiDatasetLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_many_linkage.pyi index d490f57bd..826548219 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_many_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_many_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiDatasetToManyLinkage( class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiDatasetLinkage']: return JsonApiDatasetLinkage @@ -56,4 +56,4 @@ class JsonApiDatasetToManyLinkage( def __getitem__(self, i: int) -> 'JsonApiDatasetLinkage': return super().__getitem__(i) -from gooddata_api_client.model.json_api_dataset_linkage import JsonApiDatasetLinkage +from gooddata_api_client.models.json_api_dataset_linkage import JsonApiDatasetLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_one_linkage.py deleted file mode 100644 index bee37aeae..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dataset_linkage import JsonApiDatasetLinkage - globals()['JsonApiDatasetLinkage'] = JsonApiDatasetLinkage - - -class JsonApiDatasetToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASET': "dataset", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiDatasetToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "dataset" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiDatasetToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "dataset" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiDatasetLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_one_linkage.pyi index f8d2e95d2..2e9875a08 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_one_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_to_one_linkage.pyi @@ -66,4 +66,4 @@ class JsonApiDatasetToOneLinkage( **kwargs, ) -from gooddata_api_client.model.json_api_dataset_linkage import JsonApiDatasetLinkage +from gooddata_api_client.models.json_api_dataset_linkage import JsonApiDatasetLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out.py deleted file mode 100644 index d03663ffc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_entitlement_out_attributes import JsonApiEntitlementOutAttributes - globals()['JsonApiEntitlementOutAttributes'] = JsonApiEntitlementOutAttributes - - -class JsonApiEntitlementOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ENTITLEMENT': "entitlement", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiEntitlementOutAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiEntitlementOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "entitlement", must be one of ["entitlement", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiEntitlementOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "entitlement") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiEntitlementOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "entitlement", must be one of ["entitlement", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiEntitlementOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "entitlement") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_attributes.py deleted file mode 100644 index 25d2c8faf..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_attributes.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiEntitlementOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('value',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'expiry': (date,), # noqa: E501 - 'value': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'expiry': 'expiry', # noqa: E501 - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiEntitlementOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - expiry (date): [optional] # noqa: E501 - value (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiEntitlementOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - expiry (date): [optional] # noqa: E501 - value (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_document.py deleted file mode 100644 index d95f87c8e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_entitlement_out import JsonApiEntitlementOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiEntitlementOut'] = JsonApiEntitlementOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiEntitlementOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiEntitlementOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiEntitlementOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiEntitlementOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiEntitlementOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiEntitlementOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_document.pyi index 3d42f869b..d65301f34 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiEntitlementOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiEntitlementOut']: return JsonApiEntitlementOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiEntitlementOutDocument( "data": data, "links": links, } - + data: 'JsonApiEntitlementOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiEntitlementOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiEntitlementOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiEntitlementOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_entitlement_out import JsonApiEntitlementOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_entitlement_out import JsonApiEntitlementOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_list.py deleted file mode 100644 index 51cc0441d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_entitlement_out_with_links import JsonApiEntitlementOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiEntitlementOutWithLinks'] = JsonApiEntitlementOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiEntitlementOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiEntitlementOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiEntitlementOutList - a model defined in OpenAPI - - Args: - data ([JsonApiEntitlementOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiEntitlementOutList - a model defined in OpenAPI - - Args: - data ([JsonApiEntitlementOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_list.pyi index 211b57690..8e3eb213d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiEntitlementOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiEntitlementOutWithLinks']: return JsonApiEntitlementOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiEntitlementOutWithLinks'], typing.List['JsonApiEntitlementOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiEntitlementOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiEntitlementOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiEntitlementOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiEntitlementOutList( **kwargs, ) -from gooddata_api_client.model.json_api_entitlement_out_with_links import JsonApiEntitlementOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_entitlement_out_with_links import JsonApiEntitlementOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_with_links.py deleted file mode 100644 index 9ecea8a72..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_entitlement_out import JsonApiEntitlementOut - from gooddata_api_client.model.json_api_entitlement_out_attributes import JsonApiEntitlementOutAttributes - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiEntitlementOut'] = JsonApiEntitlementOut - globals()['JsonApiEntitlementOutAttributes'] = JsonApiEntitlementOutAttributes - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiEntitlementOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ENTITLEMENT': "entitlement", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiEntitlementOutAttributes,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiEntitlementOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "entitlement", must be one of ["entitlement", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiEntitlementOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "entitlement") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiEntitlementOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "entitlement", must be one of ["entitlement", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiEntitlementOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "entitlement") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiEntitlementOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_with_links.pyi index 32bc62d96..9b260b603 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiEntitlementOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiEntitlementOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_entitlement_out import JsonApiEntitlementOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_entitlement_out import JsonApiEntitlementOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in.py deleted file mode 100644 index 578864702..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_definition_in_attributes import JsonApiExportDefinitionInAttributes - from gooddata_api_client.model.json_api_export_definition_in_relationships import JsonApiExportDefinitionInRelationships - globals()['JsonApiExportDefinitionInAttributes'] = JsonApiExportDefinitionInAttributes - globals()['JsonApiExportDefinitionInRelationships'] = JsonApiExportDefinitionInRelationships - - -class JsonApiExportDefinitionIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTDEFINITION': "exportDefinition", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiExportDefinitionInAttributes,), # noqa: E501 - 'relationships': (JsonApiExportDefinitionInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiExportDefinitionInAttributes): [optional] # noqa: E501 - relationships (JsonApiExportDefinitionInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiExportDefinitionInAttributes): [optional] # noqa: E501 - relationships (JsonApiExportDefinitionInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes.py deleted file mode 100644 index b8407888e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_definition_in_attributes_request_payload import JsonApiExportDefinitionInAttributesRequestPayload - globals()['JsonApiExportDefinitionInAttributesRequestPayload'] = JsonApiExportDefinitionInAttributesRequestPayload - - -class JsonApiExportDefinitionInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'request_payload': (JsonApiExportDefinitionInAttributesRequestPayload,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'description': 'description', # noqa: E501 - 'request_payload': 'requestPayload', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - request_payload (JsonApiExportDefinitionInAttributesRequestPayload): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - request_payload (JsonApiExportDefinitionInAttributesRequestPayload): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py deleted file mode 100644 index ba5e8c5d0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py +++ /dev/null @@ -1,371 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.custom_override import CustomOverride - from gooddata_api_client.model.json_node import JsonNode - from gooddata_api_client.model.settings import Settings - from gooddata_api_client.model.tabular_export_request import TabularExportRequest - from gooddata_api_client.model.visual_export_request import VisualExportRequest - globals()['CustomOverride'] = CustomOverride - globals()['JsonNode'] = JsonNode - globals()['Settings'] = Settings - globals()['TabularExportRequest'] = TabularExportRequest - globals()['VisualExportRequest'] = VisualExportRequest - - -class JsonApiExportDefinitionInAttributesRequestPayload(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('format',): { - 'CSV': "CSV", - 'XLSX': "XLSX", - 'HTML': "HTML", - 'PDF': "PDF", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'metadata': (JsonNode,), # noqa: E501 - 'custom_override': (CustomOverride,), # noqa: E501 - 'execution_result': (str,), # noqa: E501 - 'related_dashboard_id': (str,), # noqa: E501 - 'settings': (Settings,), # noqa: E501 - 'visualization_object': (str,), # noqa: E501 - 'visualization_object_custom_filters': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 - 'dashboard_id': (str,), # noqa: E501 - 'file_name': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'metadata': 'metadata', # noqa: E501 - 'custom_override': 'customOverride', # noqa: E501 - 'execution_result': 'executionResult', # noqa: E501 - 'related_dashboard_id': 'relatedDashboardId', # noqa: E501 - 'settings': 'settings', # noqa: E501 - 'visualization_object': 'visualizationObject', # noqa: E501 - 'visualization_object_custom_filters': 'visualizationObjectCustomFilters', # noqa: E501 - 'dashboard_id': 'dashboardId', # noqa: E501 - 'file_name': 'fileName', # noqa: E501 - 'format': 'format', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionInAttributesRequestPayload - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - metadata (JsonNode): [optional] # noqa: E501 - custom_override (CustomOverride): [optional] # noqa: E501 - execution_result (str): Execution result identifier.. [optional] # noqa: E501 - related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 - settings (Settings): [optional] # noqa: E501 - visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 - visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 - dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 - file_name (str): Filename of downloaded file without extension.. [optional] # noqa: E501 - format (str): Expected file format.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionInAttributesRequestPayload - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - metadata (JsonNode): [optional] # noqa: E501 - custom_override (CustomOverride): [optional] # noqa: E501 - execution_result (str): Execution result identifier.. [optional] # noqa: E501 - related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 - settings (Settings): [optional] # noqa: E501 - visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 - visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 - dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 - file_name (str): Filename of downloaded file without extension.. [optional] # noqa: E501 - format (str): Expected file format.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - TabularExportRequest, - VisualExportRequest, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_document.py deleted file mode 100644 index fcb1fa996..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_definition_in import JsonApiExportDefinitionIn - globals()['JsonApiExportDefinitionIn'] = JsonApiExportDefinitionIn - - -class JsonApiExportDefinitionInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiExportDefinitionIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionInDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportDefinitionIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionInDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportDefinitionIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_relationships.py deleted file mode 100644 index 6d5318387..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_relationships.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard - from gooddata_api_client.model.json_api_export_definition_in_relationships_visualization_object import JsonApiExportDefinitionInRelationshipsVisualizationObject - globals()['JsonApiAutomationInRelationshipsAnalyticalDashboard'] = JsonApiAutomationInRelationshipsAnalyticalDashboard - globals()['JsonApiExportDefinitionInRelationshipsVisualizationObject'] = JsonApiExportDefinitionInRelationshipsVisualizationObject - - -class JsonApiExportDefinitionInRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'analytical_dashboard': (JsonApiAutomationInRelationshipsAnalyticalDashboard,), # noqa: E501 - 'visualization_object': (JsonApiExportDefinitionInRelationshipsVisualizationObject,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 - 'visualization_object': 'visualizationObject', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - visualization_object (JsonApiExportDefinitionInRelationshipsVisualizationObject): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - visualization_object (JsonApiExportDefinitionInRelationshipsVisualizationObject): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_relationships_visualization_object.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_relationships_visualization_object.py deleted file mode 100644 index 517d9ae9c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_relationships_visualization_object.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage - globals()['JsonApiVisualizationObjectToOneLinkage'] = JsonApiVisualizationObjectToOneLinkage - - -class JsonApiExportDefinitionInRelationshipsVisualizationObject(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiVisualizationObjectToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionInRelationshipsVisualizationObject - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionInRelationshipsVisualizationObject - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_linkage.py deleted file mode 100644 index 1d3b5a279..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiExportDefinitionLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTDEFINITION': "exportDefinition", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out.py deleted file mode 100644 index 51e410ee3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_export_definition_out_attributes import JsonApiExportDefinitionOutAttributes - from gooddata_api_client.model.json_api_export_definition_out_relationships import JsonApiExportDefinitionOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiExportDefinitionOutAttributes'] = JsonApiExportDefinitionOutAttributes - globals()['JsonApiExportDefinitionOutRelationships'] = JsonApiExportDefinitionOutRelationships - - -class JsonApiExportDefinitionOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTDEFINITION': "exportDefinition", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiExportDefinitionOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiExportDefinitionOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiExportDefinitionOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiExportDefinitionOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiExportDefinitionOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiExportDefinitionOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_attributes.py deleted file mode 100644 index 09e266d1f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_attributes.py +++ /dev/null @@ -1,300 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_definition_in_attributes_request_payload import JsonApiExportDefinitionInAttributesRequestPayload - globals()['JsonApiExportDefinitionInAttributesRequestPayload'] = JsonApiExportDefinitionInAttributesRequestPayload - - -class JsonApiExportDefinitionOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 - 'request_payload': (JsonApiExportDefinitionInAttributesRequestPayload,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'description': 'description', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'request_payload': 'requestPayload', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - request_payload (JsonApiExportDefinitionInAttributesRequestPayload): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - request_payload (JsonApiExportDefinitionInAttributesRequestPayload): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_document.py deleted file mode 100644 index 02c9df7d7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_definition_out import JsonApiExportDefinitionOut - from gooddata_api_client.model.json_api_export_definition_out_includes import JsonApiExportDefinitionOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiExportDefinitionOut'] = JsonApiExportDefinitionOut - globals()['JsonApiExportDefinitionOutIncludes'] = JsonApiExportDefinitionOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiExportDefinitionOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiExportDefinitionOut,), # noqa: E501 - 'included': ([JsonApiExportDefinitionOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportDefinitionOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiExportDefinitionOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportDefinitionOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiExportDefinitionOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_includes.py deleted file mode 100644 index 5b308aee7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_includes.py +++ /dev/null @@ -1,365 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks - from gooddata_api_client.model.json_api_automation_out_relationships import JsonApiAutomationOutRelationships - from gooddata_api_client.model.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks - from gooddata_api_client.model.json_api_user_identifier_out_attributes import JsonApiUserIdentifierOutAttributes - from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks - from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAnalyticalDashboardOutWithLinks'] = JsonApiAnalyticalDashboardOutWithLinks - globals()['JsonApiAutomationOutRelationships'] = JsonApiAutomationOutRelationships - globals()['JsonApiAutomationOutWithLinks'] = JsonApiAutomationOutWithLinks - globals()['JsonApiUserIdentifierOutAttributes'] = JsonApiUserIdentifierOutAttributes - globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks - globals()['JsonApiVisualizationObjectOutWithLinks'] = JsonApiVisualizationObjectOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiExportDefinitionOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERIDENTIFIER': "userIdentifier", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAutomationOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - 'attributes': (JsonApiUserIdentifierOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAutomationOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiUserIdentifierOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "userIdentifier" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAutomationOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiUserIdentifierOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "userIdentifier" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAnalyticalDashboardOutWithLinks, - JsonApiAutomationOutWithLinks, - JsonApiUserIdentifierOutWithLinks, - JsonApiVisualizationObjectOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_list.py deleted file mode 100644 index c0757e1a0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_export_definition_out_includes import JsonApiExportDefinitionOutIncludes - from gooddata_api_client.model.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiExportDefinitionOutIncludes'] = JsonApiExportDefinitionOutIncludes - globals()['JsonApiExportDefinitionOutWithLinks'] = JsonApiExportDefinitionOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiExportDefinitionOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiExportDefinitionOutWithLinks],), # noqa: E501 - 'included': ([JsonApiExportDefinitionOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutList - a model defined in OpenAPI - - Args: - data ([JsonApiExportDefinitionOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiExportDefinitionOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutList - a model defined in OpenAPI - - Args: - data ([JsonApiExportDefinitionOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiExportDefinitionOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_relationships.py deleted file mode 100644 index 45d3e3952..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_relationships.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - from gooddata_api_client.model.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard - from gooddata_api_client.model.json_api_automation_result_out_relationships_automation import JsonApiAutomationResultOutRelationshipsAutomation - from gooddata_api_client.model.json_api_export_definition_in_relationships_visualization_object import JsonApiExportDefinitionInRelationshipsVisualizationObject - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - globals()['JsonApiAutomationInRelationshipsAnalyticalDashboard'] = JsonApiAutomationInRelationshipsAnalyticalDashboard - globals()['JsonApiAutomationResultOutRelationshipsAutomation'] = JsonApiAutomationResultOutRelationshipsAutomation - globals()['JsonApiExportDefinitionInRelationshipsVisualizationObject'] = JsonApiExportDefinitionInRelationshipsVisualizationObject - - -class JsonApiExportDefinitionOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'analytical_dashboard': (JsonApiAutomationInRelationshipsAnalyticalDashboard,), # noqa: E501 - 'automation': (JsonApiAutomationResultOutRelationshipsAutomation,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'visualization_object': (JsonApiExportDefinitionInRelationshipsVisualizationObject,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 - 'automation': 'automation', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - 'visualization_object': 'visualizationObject', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - automation (JsonApiAutomationResultOutRelationshipsAutomation): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - visualization_object (JsonApiExportDefinitionInRelationshipsVisualizationObject): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - automation (JsonApiAutomationResultOutRelationshipsAutomation): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - visualization_object (JsonApiExportDefinitionInRelationshipsVisualizationObject): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_with_links.py deleted file mode 100644 index 80206b751..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_export_definition_out import JsonApiExportDefinitionOut - from gooddata_api_client.model.json_api_export_definition_out_attributes import JsonApiExportDefinitionOutAttributes - from gooddata_api_client.model.json_api_export_definition_out_relationships import JsonApiExportDefinitionOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiExportDefinitionOut'] = JsonApiExportDefinitionOut - globals()['JsonApiExportDefinitionOutAttributes'] = JsonApiExportDefinitionOutAttributes - globals()['JsonApiExportDefinitionOutRelationships'] = JsonApiExportDefinitionOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiExportDefinitionOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTDEFINITION': "exportDefinition", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiExportDefinitionOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiExportDefinitionOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiExportDefinitionOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiExportDefinitionOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiExportDefinitionOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiExportDefinitionOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiExportDefinitionOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch.py deleted file mode 100644 index c1bebe219..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_definition_in_attributes import JsonApiExportDefinitionInAttributes - from gooddata_api_client.model.json_api_export_definition_in_relationships import JsonApiExportDefinitionInRelationships - globals()['JsonApiExportDefinitionInAttributes'] = JsonApiExportDefinitionInAttributes - globals()['JsonApiExportDefinitionInRelationships'] = JsonApiExportDefinitionInRelationships - - -class JsonApiExportDefinitionPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTDEFINITION': "exportDefinition", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiExportDefinitionInAttributes,), # noqa: E501 - 'relationships': (JsonApiExportDefinitionInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiExportDefinitionInAttributes): [optional] # noqa: E501 - relationships (JsonApiExportDefinitionInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiExportDefinitionInAttributes): [optional] # noqa: E501 - relationships (JsonApiExportDefinitionInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch_document.py deleted file mode 100644 index ec540b6c9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_definition_patch import JsonApiExportDefinitionPatch - globals()['JsonApiExportDefinitionPatch'] = JsonApiExportDefinitionPatch - - -class JsonApiExportDefinitionPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiExportDefinitionPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportDefinitionPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportDefinitionPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id.py deleted file mode 100644 index 32ca1e089..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id.py +++ /dev/null @@ -1,300 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_definition_in_attributes import JsonApiExportDefinitionInAttributes - from gooddata_api_client.model.json_api_export_definition_in_relationships import JsonApiExportDefinitionInRelationships - globals()['JsonApiExportDefinitionInAttributes'] = JsonApiExportDefinitionInAttributes - globals()['JsonApiExportDefinitionInRelationships'] = JsonApiExportDefinitionInRelationships - - -class JsonApiExportDefinitionPostOptionalId(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTDEFINITION': "exportDefinition", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiExportDefinitionInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'relationships': (JsonApiExportDefinitionInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionPostOptionalId - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): Object type. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiExportDefinitionInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - relationships (JsonApiExportDefinitionInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionPostOptionalId - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): Object type. defaults to "exportDefinition", must be one of ["exportDefinition", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiExportDefinitionInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - relationships (JsonApiExportDefinitionInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportDefinition") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id_document.py deleted file mode 100644 index 0ba130ce6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_definition_post_optional_id import JsonApiExportDefinitionPostOptionalId - globals()['JsonApiExportDefinitionPostOptionalId'] = JsonApiExportDefinitionPostOptionalId - - -class JsonApiExportDefinitionPostOptionalIdDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiExportDefinitionPostOptionalId,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportDefinitionPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiExportDefinitionPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportDefinitionPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_to_many_linkage.py deleted file mode 100644 index 72c70a2f4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_definition_linkage import JsonApiExportDefinitionLinkage - globals()['JsonApiExportDefinitionLinkage'] = JsonApiExportDefinitionLinkage - - -class JsonApiExportDefinitionToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiExportDefinitionLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiExportDefinitionToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiExportDefinitionLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiExportDefinitionLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiExportDefinitionToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiExportDefinitionLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiExportDefinitionLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in.py deleted file mode 100644 index 409962041..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes - globals()['JsonApiExportTemplateInAttributes'] = JsonApiExportTemplateInAttributes - - -class JsonApiExportTemplateIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTTEMPLATE': "exportTemplate", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiExportTemplateInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateIn - a model defined in OpenAPI - - Args: - attributes (JsonApiExportTemplateInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "exportTemplate") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateIn - a model defined in OpenAPI - - Args: - attributes (JsonApiExportTemplateInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "exportTemplate") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes.py deleted file mode 100644 index 076631ef4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes.py +++ /dev/null @@ -1,289 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_template_in_attributes_dashboard_slides_template import JsonApiExportTemplateInAttributesDashboardSlidesTemplate - from gooddata_api_client.model.json_api_export_template_in_attributes_widget_slides_template import JsonApiExportTemplateInAttributesWidgetSlidesTemplate - globals()['JsonApiExportTemplateInAttributesDashboardSlidesTemplate'] = JsonApiExportTemplateInAttributesDashboardSlidesTemplate - globals()['JsonApiExportTemplateInAttributesWidgetSlidesTemplate'] = JsonApiExportTemplateInAttributesWidgetSlidesTemplate - - -class JsonApiExportTemplateInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'name': (str,), # noqa: E501 - 'dashboard_slides_template': (JsonApiExportTemplateInAttributesDashboardSlidesTemplate,), # noqa: E501 - 'widget_slides_template': (JsonApiExportTemplateInAttributesWidgetSlidesTemplate,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'dashboard_slides_template': 'dashboardSlidesTemplate', # noqa: E501 - 'widget_slides_template': 'widgetSlidesTemplate', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateInAttributes - a model defined in OpenAPI - - Args: - name (str): User-facing name of the Slides template. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_slides_template (JsonApiExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 - widget_slides_template (JsonApiExportTemplateInAttributesWidgetSlidesTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, name, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateInAttributes - a model defined in OpenAPI - - Args: - name (str): User-facing name of the Slides template. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_slides_template (JsonApiExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 - widget_slides_template (JsonApiExportTemplateInAttributesWidgetSlidesTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_dashboard_slides_template.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_dashboard_slides_template.py deleted file mode 100644 index 7eac8f33e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_dashboard_slides_template.py +++ /dev/null @@ -1,305 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.content_slide_template import ContentSlideTemplate - from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate - from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate - from gooddata_api_client.model.section_slide_template import SectionSlideTemplate - globals()['ContentSlideTemplate'] = ContentSlideTemplate - globals()['CoverSlideTemplate'] = CoverSlideTemplate - globals()['IntroSlideTemplate'] = IntroSlideTemplate - globals()['SectionSlideTemplate'] = SectionSlideTemplate - - -class JsonApiExportTemplateInAttributesDashboardSlidesTemplate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('applied_on',): { - 'PDF': "PDF", - 'PPTX': "PPTX", - }, - } - - validations = { - ('applied_on',): { - 'min_items': 1, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'applied_on': ([str],), # noqa: E501 - 'content_slide': (ContentSlideTemplate,), # noqa: E501 - 'cover_slide': (CoverSlideTemplate,), # noqa: E501 - 'intro_slide': (IntroSlideTemplate,), # noqa: E501 - 'section_slide': (SectionSlideTemplate,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'applied_on': 'appliedOn', # noqa: E501 - 'content_slide': 'contentSlide', # noqa: E501 - 'cover_slide': 'coverSlide', # noqa: E501 - 'intro_slide': 'introSlide', # noqa: E501 - 'section_slide': 'sectionSlide', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateInAttributesDashboardSlidesTemplate - a model defined in OpenAPI - - Args: - applied_on ([str]): Export types this template applies to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content_slide (ContentSlideTemplate): [optional] # noqa: E501 - cover_slide (CoverSlideTemplate): [optional] # noqa: E501 - intro_slide (IntroSlideTemplate): [optional] # noqa: E501 - section_slide (SectionSlideTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.applied_on = applied_on - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, applied_on, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateInAttributesDashboardSlidesTemplate - a model defined in OpenAPI - - Args: - applied_on ([str]): Export types this template applies to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content_slide (ContentSlideTemplate): [optional] # noqa: E501 - cover_slide (CoverSlideTemplate): [optional] # noqa: E501 - intro_slide (IntroSlideTemplate): [optional] # noqa: E501 - section_slide (SectionSlideTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.applied_on = applied_on - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_widget_slides_template.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_widget_slides_template.py deleted file mode 100644 index c8b291bcc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_widget_slides_template.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.content_slide_template import ContentSlideTemplate - globals()['ContentSlideTemplate'] = ContentSlideTemplate - - -class JsonApiExportTemplateInAttributesWidgetSlidesTemplate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('applied_on',): { - 'PDF': "PDF", - 'PPTX': "PPTX", - }, - } - - validations = { - ('applied_on',): { - 'min_items': 1, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'applied_on': ([str],), # noqa: E501 - 'content_slide': (ContentSlideTemplate,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'applied_on': 'appliedOn', # noqa: E501 - 'content_slide': 'contentSlide', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateInAttributesWidgetSlidesTemplate - a model defined in OpenAPI - - Args: - applied_on ([str]): Export types this template applies to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content_slide (ContentSlideTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.applied_on = applied_on - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, applied_on, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateInAttributesWidgetSlidesTemplate - a model defined in OpenAPI - - Args: - applied_on ([str]): Export types this template applies to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content_slide (ContentSlideTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.applied_on = applied_on - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_document.py deleted file mode 100644 index f9f6af75a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_template_in import JsonApiExportTemplateIn - globals()['JsonApiExportTemplateIn'] = JsonApiExportTemplateIn - - -class JsonApiExportTemplateInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiExportTemplateIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateInDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportTemplateIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateInDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportTemplateIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out.py deleted file mode 100644 index fd5b37d8c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes - globals()['JsonApiExportTemplateInAttributes'] = JsonApiExportTemplateInAttributes - - -class JsonApiExportTemplateOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTTEMPLATE': "exportTemplate", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiExportTemplateInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateOut - a model defined in OpenAPI - - Args: - attributes (JsonApiExportTemplateInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "exportTemplate") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateOut - a model defined in OpenAPI - - Args: - attributes (JsonApiExportTemplateInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "exportTemplate") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_document.py deleted file mode 100644 index 118649bc9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_template_out import JsonApiExportTemplateOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiExportTemplateOut'] = JsonApiExportTemplateOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiExportTemplateOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiExportTemplateOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportTemplateOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportTemplateOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.py deleted file mode 100644 index 6dfd20078..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_export_template_out_with_links import JsonApiExportTemplateOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiExportTemplateOutWithLinks'] = JsonApiExportTemplateOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiExportTemplateOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiExportTemplateOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateOutList - a model defined in OpenAPI - - Args: - data ([JsonApiExportTemplateOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateOutList - a model defined in OpenAPI - - Args: - data ([JsonApiExportTemplateOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_with_links.py deleted file mode 100644 index 624440082..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes - from gooddata_api_client.model.json_api_export_template_out import JsonApiExportTemplateOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiExportTemplateInAttributes'] = JsonApiExportTemplateInAttributes - globals()['JsonApiExportTemplateOut'] = JsonApiExportTemplateOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiExportTemplateOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTTEMPLATE': "exportTemplate", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiExportTemplateInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiExportTemplateInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportTemplate") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplateOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiExportTemplateInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportTemplate") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiExportTemplateOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch.py deleted file mode 100644 index 05afc5827..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_template_patch_attributes import JsonApiExportTemplatePatchAttributes - globals()['JsonApiExportTemplatePatchAttributes'] = JsonApiExportTemplatePatchAttributes - - -class JsonApiExportTemplatePatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTTEMPLATE': "exportTemplate", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiExportTemplatePatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplatePatch - a model defined in OpenAPI - - Args: - attributes (JsonApiExportTemplatePatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "exportTemplate") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplatePatch - a model defined in OpenAPI - - Args: - attributes (JsonApiExportTemplatePatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "exportTemplate") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_attributes.py deleted file mode 100644 index 350a1f0f8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_attributes.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_template_in_attributes_dashboard_slides_template import JsonApiExportTemplateInAttributesDashboardSlidesTemplate - from gooddata_api_client.model.json_api_export_template_in_attributes_widget_slides_template import JsonApiExportTemplateInAttributesWidgetSlidesTemplate - globals()['JsonApiExportTemplateInAttributesDashboardSlidesTemplate'] = JsonApiExportTemplateInAttributesDashboardSlidesTemplate - globals()['JsonApiExportTemplateInAttributesWidgetSlidesTemplate'] = JsonApiExportTemplateInAttributesWidgetSlidesTemplate - - -class JsonApiExportTemplatePatchAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dashboard_slides_template': (JsonApiExportTemplateInAttributesDashboardSlidesTemplate,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'widget_slides_template': (JsonApiExportTemplateInAttributesWidgetSlidesTemplate,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dashboard_slides_template': 'dashboardSlidesTemplate', # noqa: E501 - 'name': 'name', # noqa: E501 - 'widget_slides_template': 'widgetSlidesTemplate', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplatePatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_slides_template (JsonApiExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 - name (str): User-facing name of the Slides template.. [optional] # noqa: E501 - widget_slides_template (JsonApiExportTemplateInAttributesWidgetSlidesTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplatePatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_slides_template (JsonApiExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 - name (str): User-facing name of the Slides template.. [optional] # noqa: E501 - widget_slides_template (JsonApiExportTemplateInAttributesWidgetSlidesTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_document.py deleted file mode 100644 index 7301a717d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_template_patch import JsonApiExportTemplatePatch - globals()['JsonApiExportTemplatePatch'] = JsonApiExportTemplatePatch - - -class JsonApiExportTemplatePatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiExportTemplatePatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplatePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportTemplatePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplatePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportTemplatePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id.py deleted file mode 100644 index bbad2489d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes - globals()['JsonApiExportTemplateInAttributes'] = JsonApiExportTemplateInAttributes - - -class JsonApiExportTemplatePostOptionalId(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'EXPORTTEMPLATE': "exportTemplate", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiExportTemplateInAttributes,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplatePostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiExportTemplateInAttributes): - - Keyword Args: - type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportTemplate") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplatePostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiExportTemplateInAttributes): - - Keyword Args: - type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "exportTemplate") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id_document.py deleted file mode 100644 index 5b8f778ba..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId - globals()['JsonApiExportTemplatePostOptionalId'] = JsonApiExportTemplatePostOptionalId - - -class JsonApiExportTemplatePostOptionalIdDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiExportTemplatePostOptionalId,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplatePostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportTemplatePostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiExportTemplatePostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiExportTemplatePostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_linkage.py deleted file mode 100644 index b9ce007a2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiFactLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FACT': "fact", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiFactLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "fact", must be one of ["fact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "fact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiFactLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "fact", must be one of ["fact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "fact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out.py deleted file mode 100644 index c977d12ca..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_fact_out_attributes import JsonApiFactOutAttributes - from gooddata_api_client.model.json_api_fact_out_relationships import JsonApiFactOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiFactOutAttributes'] = JsonApiFactOutAttributes - globals()['JsonApiFactOutRelationships'] = JsonApiFactOutRelationships - - -class JsonApiFactOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FACT': "fact", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiFactOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiFactOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiFactOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "fact", must be one of ["fact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "fact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiFactOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "fact", must be one of ["fact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "fact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out.pyi index 90235e444..c43881dae 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out.pyi @@ -41,91 +41,91 @@ class JsonApiFactOut( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACT(cls): return cls("fact") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: areRelationsValid = schemas.BoolSchema - - + + class description( schemas.StrSchema ): pass - - + + class sourceColumn( schemas.StrSchema ): pass - - + + class sourceColumnDataType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def INT(cls): return cls("INT") - + @schemas.classproperty def STRING(cls): return cls("STRING") - + @schemas.classproperty def DATE(cls): return cls("DATE") - + @schemas.classproperty def NUMERIC(cls): return cls("NUMERIC") - + @schemas.classproperty def TIMESTAMP(cls): return cls("TIMESTAMP") - + @schemas.classproperty def TIMESTAMP_TZ(cls): return cls("TIMESTAMP_TZ") - + @schemas.classproperty def BOOLEAN(cls): return cls("BOOLEAN") - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -136,11 +136,11 @@ class JsonApiFactOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): @@ -153,58 +153,58 @@ class JsonApiFactOut( "tags": tags, "title": title, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sourceColumn"]) -> MetaOapg.properties.sourceColumn: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> MetaOapg.properties.sourceColumnDataType: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "sourceColumn", "sourceColumnDataType", "tags", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sourceColumn"]) -> typing.Union[MetaOapg.properties.sourceColumn, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> typing.Union[MetaOapg.properties.sourceColumnDataType, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "sourceColumn", "sourceColumnDataType", "tags", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -229,42 +229,42 @@ class JsonApiFactOut( _configuration=_configuration, **kwargs, ) - - + + class meta( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class origin( schemas.DictSchema ): - - + + class MetaOapg: required = { "originType", "originId", } - + class properties: originId = schemas.StrSchema - - + + class originType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") - + @schemas.classproperty def PARENT(cls): return cls("PARENT") @@ -272,37 +272,37 @@ class JsonApiFactOut( "originId": originId, "originType": originType, } - + originType: MetaOapg.properties.originType originId: MetaOapg.properties.originId - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -322,28 +322,28 @@ class JsonApiFactOut( __annotations__ = { "origin": origin, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -358,60 +358,60 @@ class JsonApiFactOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class dataset( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDatasetToOneLinkage']: return JsonApiDatasetToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiDatasetToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -429,28 +429,28 @@ class JsonApiFactOut( __annotations__ = { "dataset": dataset, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataset"]) -> MetaOapg.properties.dataset: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataset", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataset"]) -> typing.Union[MetaOapg.properties.dataset, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataset", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -472,54 +472,54 @@ class JsonApiFactOut( "meta": meta, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -544,4 +544,4 @@ class JsonApiFactOut( **kwargs, ) -from gooddata_api_client.model.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage +from gooddata_api_client.models.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_attributes.py deleted file mode 100644 index e901c2579..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_attributes.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiFactOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('source_column_data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('source_column',): { - 'max_length': 255, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'source_column': (str,), # noqa: E501 - 'source_column_data_type': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'source_column': 'sourceColumn', # noqa: E501 - 'source_column_data_type': 'sourceColumnDataType', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiFactOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - source_column (str): [optional] # noqa: E501 - source_column_data_type (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiFactOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - source_column (str): [optional] # noqa: E501 - source_column_data_type (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_document.py deleted file mode 100644 index f38dcdde7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks - from gooddata_api_client.model.json_api_fact_out import JsonApiFactOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks - globals()['JsonApiFactOut'] = JsonApiFactOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiFactOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiFactOut,), # noqa: E501 - 'included': ([JsonApiDatasetOutWithLinks],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFactOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiFactOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiDatasetOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFactOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiFactOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiDatasetOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_document.pyi index dafa2bd29..e613eacaf 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiFactOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiFactOut']: return JsonApiFactOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiDatasetOutWithLinks']: return JsonApiDatasetOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiDatasetOutWithLinks'], typing.List['JsonApiDatasetOutWithLinks']], @@ -67,10 +67,10 @@ class JsonApiFactOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiDatasetOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiFactOutDocument( "included": included, "links": links, } - + data: 'JsonApiFactOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiFactOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks -from gooddata_api_client.model.json_api_fact_out import JsonApiFactOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_fact_out import JsonApiFactOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_list.py deleted file mode 100644 index 4d59677f0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks - from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks - globals()['JsonApiFactOutWithLinks'] = JsonApiFactOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiFactOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiFactOutWithLinks],), # noqa: E501 - 'included': ([JsonApiDatasetOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFactOutList - a model defined in OpenAPI - - Args: - data ([JsonApiFactOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiDatasetOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFactOutList - a model defined in OpenAPI - - Args: - data ([JsonApiFactOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiDatasetOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_list.pyi index 8c5efffb3..2ea501d50 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_list.pyi @@ -158,6 +158,6 @@ class JsonApiFactOutList( **kwargs, ) -from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks -from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_relationships.py deleted file mode 100644 index fff978109..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_relationships.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_relationships_dataset import JsonApiAggregatedFactOutRelationshipsDataset - globals()['JsonApiAggregatedFactOutRelationshipsDataset'] = JsonApiAggregatedFactOutRelationshipsDataset - - -class JsonApiFactOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dataset': (JsonApiAggregatedFactOutRelationshipsDataset,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dataset': 'dataset', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiFactOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dataset (JsonApiAggregatedFactOutRelationshipsDataset): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiFactOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dataset (JsonApiAggregatedFactOutRelationshipsDataset): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_with_links.py deleted file mode 100644 index f70b65e36..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_fact_out import JsonApiFactOut - from gooddata_api_client.model.json_api_fact_out_attributes import JsonApiFactOutAttributes - from gooddata_api_client.model.json_api_fact_out_relationships import JsonApiFactOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiFactOut'] = JsonApiFactOut - globals()['JsonApiFactOutAttributes'] = JsonApiFactOutAttributes - globals()['JsonApiFactOutRelationships'] = JsonApiFactOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiFactOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FACT': "fact", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiFactOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiFactOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiFactOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "fact", must be one of ["fact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "fact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiFactOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "fact", must be one of ["fact", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "fact") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiFactOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_with_links.pyi index 35a6e0556..61bc23c94 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiFactOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiFactOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_fact_out import JsonApiFactOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_fact_out import JsonApiFactOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_many_linkage.py deleted file mode 100644 index cca4b3dfc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_fact_linkage import JsonApiFactLinkage - globals()['JsonApiFactLinkage'] = JsonApiFactLinkage - - -class JsonApiFactToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiFactLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiFactToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiFactLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiFactLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiFactToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiFactLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiFactLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_many_linkage.pyi index c7c65d705..71bca292f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_many_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_many_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiFactToManyLinkage( class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiFactLinkage']: return JsonApiFactLinkage @@ -56,4 +56,4 @@ class JsonApiFactToManyLinkage( def __getitem__(self, i: int) -> 'JsonApiFactLinkage': return super().__getitem__(i) -from gooddata_api_client.model.json_api_fact_linkage import JsonApiFactLinkage +from gooddata_api_client.models.json_api_fact_linkage import JsonApiFactLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_one_linkage.py deleted file mode 100644 index 1b434c3e1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_fact_linkage import JsonApiFactLinkage - globals()['JsonApiFactLinkage'] = JsonApiFactLinkage - - -class JsonApiFactToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FACT': "fact", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiFactToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "fact" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiFactToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "fact" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiFactLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_in.py deleted file mode 100644 index 9abbecc66..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_in.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes - globals()['JsonApiAnalyticalDashboardInAttributes'] = JsonApiAnalyticalDashboardInAttributes - - -class JsonApiFilterContextIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FILTERCONTEXT': "filterContext", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAnalyticalDashboardInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextIn - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextIn - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_in_document.py deleted file mode 100644 index aaa3fd1bc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_context_in import JsonApiFilterContextIn - globals()['JsonApiFilterContextIn'] = JsonApiFilterContextIn - - -class JsonApiFilterContextInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiFilterContextIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextInDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterContextIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextInDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterContextIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_in_document.pyi index d55f1971e..b4684917f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiFilterContextInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiFilterContextIn']: return JsonApiFilterContextIn __annotations__ = { "data": data, } - + data: 'JsonApiFilterContextIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterContextIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterContextIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiFilterContextInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_filter_context_in import JsonApiFilterContextIn +from gooddata_api_client.models.json_api_filter_context_in import JsonApiFilterContextIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_linkage.py deleted file mode 100644 index f03982fb6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiFilterContextLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FILTERCONTEXT': "filterContext", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out.py deleted file mode 100644 index 07f5ddfa5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out.py +++ /dev/null @@ -1,310 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes - from gooddata_api_client.model.json_api_filter_context_out_relationships import JsonApiFilterContextOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAnalyticalDashboardInAttributes'] = JsonApiAnalyticalDashboardInAttributes - globals()['JsonApiFilterContextOutRelationships'] = JsonApiFilterContextOutRelationships - - -class JsonApiFilterContextOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FILTERCONTEXT': "filterContext", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAnalyticalDashboardInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiFilterContextOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOut - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiFilterContextOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOut - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiFilterContextOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out.pyi index 5c48233f1..d674507b8 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out.pyi @@ -41,52 +41,52 @@ class JsonApiFilterContextOut( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FILTER_CONTEXT(cls): return cls("filterContext") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: areRelationsValid = schemas.BoolSchema content = schemas.DictSchema - - + + class description( schemas.StrSchema ): pass - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -97,11 +97,11 @@ class JsonApiFilterContextOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): @@ -113,52 +113,52 @@ class JsonApiFilterContextOut( "tags": tags, "title": title, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -181,42 +181,42 @@ class JsonApiFilterContextOut( _configuration=_configuration, **kwargs, ) - - + + class meta( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class origin( schemas.DictSchema ): - - + + class MetaOapg: required = { "originType", "originId", } - + class properties: originId = schemas.StrSchema - - + + class originType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") - + @schemas.classproperty def PARENT(cls): return cls("PARENT") @@ -224,37 +224,37 @@ class JsonApiFilterContextOut( "originId": originId, "originType": originType, } - + originType: MetaOapg.properties.originType originId: MetaOapg.properties.originId - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -274,28 +274,28 @@ class JsonApiFilterContextOut( __annotations__ = { "origin": origin, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -310,60 +310,60 @@ class JsonApiFilterContextOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiAttributeToManyLinkage']: return JsonApiAttributeToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiAttributeToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -378,50 +378,50 @@ class JsonApiFilterContextOut( _configuration=_configuration, **kwargs, ) - - + + class datasets( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDatasetToManyLinkage']: return JsonApiDatasetToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiDatasetToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -436,50 +436,50 @@ class JsonApiFilterContextOut( _configuration=_configuration, **kwargs, ) - - + + class labels( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiLabelToManyLinkage']: return JsonApiLabelToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiLabelToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -499,40 +499,40 @@ class JsonApiFilterContextOut( "datasets": datasets, "labels": labels, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["datasets"]) -> MetaOapg.properties.datasets: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["labels"]) -> MetaOapg.properties.labels: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "datasets", "labels", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["datasets"]) -> typing.Union[MetaOapg.properties.datasets, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["labels"]) -> typing.Union[MetaOapg.properties.labels, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "datasets", "labels", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -558,54 +558,54 @@ class JsonApiFilterContextOut( "meta": meta, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -630,6 +630,6 @@ class JsonApiFilterContextOut( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage -from gooddata_api_client.model.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage -from gooddata_api_client.model.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage +from gooddata_api_client.models.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage +from gooddata_api_client.models.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage +from gooddata_api_client.models.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_document.py deleted file mode 100644 index 38c8e1b3f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_context_out import JsonApiFilterContextOut - from gooddata_api_client.model.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiFilterContextOut'] = JsonApiFilterContextOut - globals()['JsonApiFilterContextOutIncludes'] = JsonApiFilterContextOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiFilterContextOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiFilterContextOut,), # noqa: E501 - 'included': ([JsonApiFilterContextOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterContextOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiFilterContextOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterContextOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiFilterContextOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_document.pyi index a52a88de5..7c49d330d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiFilterContextOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiFilterContextOut']: return JsonApiFilterContextOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiFilterContextOutIncludes']: return JsonApiFilterContextOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiFilterContextOutIncludes'], typing.List['JsonApiFilterContextOutIncludes']], @@ -67,10 +67,10 @@ class JsonApiFilterContextOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiFilterContextOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiFilterContextOutDocument( "included": included, "links": links, } - + data: 'JsonApiFilterContextOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterContextOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterContextOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiFilterContextOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_filter_context_out import JsonApiFilterContextOut -from gooddata_api_client.model.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_filter_context_out import JsonApiFilterContextOut +from gooddata_api_client.models.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_includes.py deleted file mode 100644 index 02cadb19a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_includes.py +++ /dev/null @@ -1,362 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks - from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks - from gooddata_api_client.model.json_api_label_out_attributes import JsonApiLabelOutAttributes - from gooddata_api_client.model.json_api_label_out_relationships import JsonApiLabelOutRelationships - from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks - globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks - globals()['JsonApiLabelOutAttributes'] = JsonApiLabelOutAttributes - globals()['JsonApiLabelOutRelationships'] = JsonApiLabelOutRelationships - globals()['JsonApiLabelOutWithLinks'] = JsonApiLabelOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiFilterContextOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'LABEL': "label", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiLabelOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - 'attributes': (JsonApiLabelOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "label" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "label" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAttributeOutWithLinks, - JsonApiDatasetOutWithLinks, - JsonApiLabelOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_includes.pyi index 3e32ff620..10d45e513 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_includes.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_includes.pyi @@ -35,7 +35,7 @@ class JsonApiFilterContextOutIncludes( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -66,6 +66,6 @@ class JsonApiFilterContextOutIncludes( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks -from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks -from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_list.py deleted file mode 100644 index 12566fe80..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes - from gooddata_api_client.model.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiFilterContextOutIncludes'] = JsonApiFilterContextOutIncludes - globals()['JsonApiFilterContextOutWithLinks'] = JsonApiFilterContextOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiFilterContextOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiFilterContextOutWithLinks],), # noqa: E501 - 'included': ([JsonApiFilterContextOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOutList - a model defined in OpenAPI - - Args: - data ([JsonApiFilterContextOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiFilterContextOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOutList - a model defined in OpenAPI - - Args: - data ([JsonApiFilterContextOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiFilterContextOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_list.pyi index 72f0fceae..ddf5b235e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiFilterContextOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiFilterContextOutWithLinks']: return JsonApiFilterContextOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiFilterContextOutWithLinks'], typing.List['JsonApiFilterContextOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiFilterContextOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiFilterContextOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiFilterContextOutIncludes']: return JsonApiFilterContextOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiFilterContextOutIncludes'], typing.List['JsonApiFilterContextOutIncludes']], @@ -91,10 +91,10 @@ class JsonApiFilterContextOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiFilterContextOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiFilterContextOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,6 +158,6 @@ class JsonApiFilterContextOutList( **kwargs, ) -from gooddata_api_client.model.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes -from gooddata_api_client.model.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes +from gooddata_api_client.models.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_relationships.py deleted file mode 100644 index 0bebd66bc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_relationships.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels - from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes - globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets - globals()['JsonApiAnalyticalDashboardOutRelationshipsLabels'] = JsonApiAnalyticalDashboardOutRelationshipsLabels - globals()['JsonApiAttributeHierarchyOutRelationshipsAttributes'] = JsonApiAttributeHierarchyOutRelationshipsAttributes - - -class JsonApiFilterContextOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 - 'datasets': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 - 'labels': (JsonApiAnalyticalDashboardOutRelationshipsLabels,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'datasets': 'datasets', # noqa: E501 - 'labels': 'labels', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_with_links.py deleted file mode 100644 index c0849e8f5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes - from gooddata_api_client.model.json_api_filter_context_out import JsonApiFilterContextOut - from gooddata_api_client.model.json_api_filter_context_out_relationships import JsonApiFilterContextOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAnalyticalDashboardInAttributes'] = JsonApiAnalyticalDashboardInAttributes - globals()['JsonApiFilterContextOut'] = JsonApiFilterContextOut - globals()['JsonApiFilterContextOutRelationships'] = JsonApiFilterContextOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiFilterContextOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FILTERCONTEXT': "filterContext", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAnalyticalDashboardInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiFilterContextOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiFilterContextOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiFilterContextOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiFilterContextOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_with_links.pyi index 640f5da23..f1a6afa57 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiFilterContextOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiFilterContextOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_filter_context_out import JsonApiFilterContextOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_filter_context_out import JsonApiFilterContextOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_patch.py deleted file mode 100644 index 057ecb10f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_patch.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_patch_attributes import JsonApiAnalyticalDashboardPatchAttributes - globals()['JsonApiAnalyticalDashboardPatchAttributes'] = JsonApiAnalyticalDashboardPatchAttributes - - -class JsonApiFilterContextPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FILTERCONTEXT': "filterContext", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAnalyticalDashboardPatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_patch_document.py deleted file mode 100644 index a55c24b4f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_context_patch import JsonApiFilterContextPatch - globals()['JsonApiFilterContextPatch'] = JsonApiFilterContextPatch - - -class JsonApiFilterContextPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiFilterContextPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterContextPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterContextPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_patch_document.pyi index 8f7e937ee..eb908d73a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiFilterContextPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiFilterContextPatch']: return JsonApiFilterContextPatch __annotations__ = { "data": data, } - + data: 'JsonApiFilterContextPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterContextPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterContextPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiFilterContextPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_filter_context_patch import JsonApiFilterContextPatch +from gooddata_api_client.models.json_api_filter_context_patch import JsonApiFilterContextPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_post_optional_id.py deleted file mode 100644 index 800b19623..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_post_optional_id.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes - globals()['JsonApiAnalyticalDashboardInAttributes'] = JsonApiAnalyticalDashboardInAttributes - - -class JsonApiFilterContextPostOptionalId(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FILTERCONTEXT': "filterContext", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAnalyticalDashboardInAttributes,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - - Keyword Args: - type (str): Object type. defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiAnalyticalDashboardInAttributes): - - Keyword Args: - type (str): Object type. defaults to "filterContext", must be one of ["filterContext", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterContext") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_post_optional_id_document.py deleted file mode 100644 index 479f64172..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_post_optional_id_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_context_post_optional_id import JsonApiFilterContextPostOptionalId - globals()['JsonApiFilterContextPostOptionalId'] = JsonApiFilterContextPostOptionalId - - -class JsonApiFilterContextPostOptionalIdDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiFilterContextPostOptionalId,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterContextPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterContextPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterContextPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_post_optional_id_document.pyi index d0ebaf6f1..db82d242d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_post_optional_id_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_post_optional_id_document.pyi @@ -38,38 +38,38 @@ class JsonApiFilterContextPostOptionalIdDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiFilterContextPostOptionalId']: return JsonApiFilterContextPostOptionalId __annotations__ = { "data": data, } - + data: 'JsonApiFilterContextPostOptionalId' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterContextPostOptionalId': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterContextPostOptionalId': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiFilterContextPostOptionalIdDocument( **kwargs, ) -from gooddata_api_client.model.json_api_filter_context_post_optional_id import JsonApiFilterContextPostOptionalId +from gooddata_api_client.models.json_api_filter_context_post_optional_id import JsonApiFilterContextPostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_to_many_linkage.py deleted file mode 100644 index b5abf59da..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_context_linkage import JsonApiFilterContextLinkage - globals()['JsonApiFilterContextLinkage'] = JsonApiFilterContextLinkage - - -class JsonApiFilterContextToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiFilterContextLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiFilterContextToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiFilterContextLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiFilterContextLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiFilterContextToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiFilterContextLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiFilterContextLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_to_many_linkage.pyi index b1c34222c..c0175e883 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_to_many_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_to_many_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiFilterContextToManyLinkage( class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiFilterContextLinkage']: return JsonApiFilterContextLinkage @@ -56,4 +56,4 @@ class JsonApiFilterContextToManyLinkage( def __getitem__(self, i: int) -> 'JsonApiFilterContextLinkage': return super().__getitem__(i) -from gooddata_api_client.model.json_api_filter_context_linkage import JsonApiFilterContextLinkage +from gooddata_api_client.models.json_api_filter_context_linkage import JsonApiFilterContextLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in.py deleted file mode 100644 index d167b2e7d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes - from gooddata_api_client.model.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships - globals()['JsonApiFilterViewInAttributes'] = JsonApiFilterViewInAttributes - globals()['JsonApiFilterViewInRelationships'] = JsonApiFilterViewInRelationships - - -class JsonApiFilterViewIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FILTERVIEW': "filterView", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiFilterViewInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'relationships': (JsonApiFilterViewInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewIn - a model defined in OpenAPI - - Args: - attributes (JsonApiFilterViewInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterView", must be one of ["filterView", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiFilterViewInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterView") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewIn - a model defined in OpenAPI - - Args: - attributes (JsonApiFilterViewInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterView", must be one of ["filterView", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiFilterViewInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterView") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_attributes.py deleted file mode 100644 index 53197a42b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_attributes.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiFilterViewInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('title',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'title': (str,), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_default': (bool,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'title': 'title', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_default': 'isDefault', # noqa: E501 - 'tags': 'tags', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, title, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewInAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The respective filter context. - title (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_default (bool): Indicator whether the filter view should by applied by default.. [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, title, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewInAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The respective filter context. - title (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_default (bool): Indicator whether the filter view should by applied by default.. [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_document.py deleted file mode 100644 index cdb54e124..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_view_in import JsonApiFilterViewIn - globals()['JsonApiFilterViewIn'] = JsonApiFilterViewIn - - -class JsonApiFilterViewInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiFilterViewIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewInDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterViewIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewInDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterViewIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_relationships.py deleted file mode 100644 index 55dc853af..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_relationships.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard - from gooddata_api_client.model.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser - globals()['JsonApiAutomationInRelationshipsAnalyticalDashboard'] = JsonApiAutomationInRelationshipsAnalyticalDashboard - globals()['JsonApiFilterViewInRelationshipsUser'] = JsonApiFilterViewInRelationshipsUser - - -class JsonApiFilterViewInRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'analytical_dashboard': (JsonApiAutomationInRelationshipsAnalyticalDashboard,), # noqa: E501 - 'user': (JsonApiFilterViewInRelationshipsUser,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 - 'user': 'user', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - user (JsonApiFilterViewInRelationshipsUser): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - user (JsonApiFilterViewInRelationshipsUser): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_relationships_user.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_relationships_user.py deleted file mode 100644 index 71ccc3ec6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_relationships_user.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_to_one_linkage import JsonApiUserToOneLinkage - globals()['JsonApiUserToOneLinkage'] = JsonApiUserToOneLinkage - - -class JsonApiFilterViewInRelationshipsUser(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewInRelationshipsUser - a model defined in OpenAPI - - Args: - data (JsonApiUserToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewInRelationshipsUser - a model defined in OpenAPI - - Args: - data (JsonApiUserToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out.py deleted file mode 100644 index ab3de9815..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes - from gooddata_api_client.model.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships - globals()['JsonApiFilterViewInAttributes'] = JsonApiFilterViewInAttributes - globals()['JsonApiFilterViewInRelationships'] = JsonApiFilterViewInRelationships - - -class JsonApiFilterViewOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FILTERVIEW': "filterView", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiFilterViewInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'relationships': (JsonApiFilterViewInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewOut - a model defined in OpenAPI - - Args: - attributes (JsonApiFilterViewInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterView", must be one of ["filterView", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiFilterViewInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterView") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewOut - a model defined in OpenAPI - - Args: - attributes (JsonApiFilterViewInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterView", must be one of ["filterView", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiFilterViewInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterView") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_document.py deleted file mode 100644 index 0fc28f5b3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_view_out import JsonApiFilterViewOut - from gooddata_api_client.model.json_api_filter_view_out_includes import JsonApiFilterViewOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiFilterViewOut'] = JsonApiFilterViewOut - globals()['JsonApiFilterViewOutIncludes'] = JsonApiFilterViewOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiFilterViewOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiFilterViewOut,), # noqa: E501 - 'included': ([JsonApiFilterViewOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterViewOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiFilterViewOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterViewOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiFilterViewOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_includes.py deleted file mode 100644 index a41782712..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_includes.py +++ /dev/null @@ -1,359 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_meta import JsonApiAnalyticalDashboardOutMeta - from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks - from gooddata_api_client.model.json_api_user_in_attributes import JsonApiUserInAttributes - from gooddata_api_client.model.json_api_user_in_relationships import JsonApiUserInRelationships - from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAnalyticalDashboardOutMeta'] = JsonApiAnalyticalDashboardOutMeta - globals()['JsonApiAnalyticalDashboardOutWithLinks'] = JsonApiAnalyticalDashboardOutWithLinks - globals()['JsonApiUserInAttributes'] = JsonApiUserInAttributes - globals()['JsonApiUserInRelationships'] = JsonApiUserInRelationships - globals()['JsonApiUserOutWithLinks'] = JsonApiUserOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiFilterViewOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USER': "user", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'meta': (JsonApiAnalyticalDashboardOutMeta,), # noqa: E501 - 'relationships': (JsonApiUserInRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - 'attributes': (JsonApiUserInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAnalyticalDashboardOutMeta): [optional] # noqa: E501 - relationships (JsonApiUserInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiUserInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "user" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAnalyticalDashboardOutMeta): [optional] # noqa: E501 - relationships (JsonApiUserInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiUserInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "user" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAnalyticalDashboardOutWithLinks, - JsonApiUserOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_list.py deleted file mode 100644 index c29066388..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_filter_view_out_includes import JsonApiFilterViewOutIncludes - from gooddata_api_client.model.json_api_filter_view_out_with_links import JsonApiFilterViewOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiFilterViewOutIncludes'] = JsonApiFilterViewOutIncludes - globals()['JsonApiFilterViewOutWithLinks'] = JsonApiFilterViewOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiFilterViewOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiFilterViewOutWithLinks],), # noqa: E501 - 'included': ([JsonApiFilterViewOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewOutList - a model defined in OpenAPI - - Args: - data ([JsonApiFilterViewOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiFilterViewOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewOutList - a model defined in OpenAPI - - Args: - data ([JsonApiFilterViewOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiFilterViewOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_with_links.py deleted file mode 100644 index 68177af84..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_with_links.py +++ /dev/null @@ -1,355 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes - from gooddata_api_client.model.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships - from gooddata_api_client.model.json_api_filter_view_out import JsonApiFilterViewOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiFilterViewInAttributes'] = JsonApiFilterViewInAttributes - globals()['JsonApiFilterViewInRelationships'] = JsonApiFilterViewInRelationships - globals()['JsonApiFilterViewOut'] = JsonApiFilterViewOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiFilterViewOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FILTERVIEW': "filterView", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiFilterViewInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'relationships': (JsonApiFilterViewInRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiFilterViewInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "filterView", must be one of ["filterView", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiFilterViewInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterView") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiFilterViewInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "filterView", must be one of ["filterView", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiFilterViewInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterView") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiFilterViewOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch.py deleted file mode 100644 index 72188e84b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships - from gooddata_api_client.model.json_api_filter_view_patch_attributes import JsonApiFilterViewPatchAttributes - globals()['JsonApiFilterViewInRelationships'] = JsonApiFilterViewInRelationships - globals()['JsonApiFilterViewPatchAttributes'] = JsonApiFilterViewPatchAttributes - - -class JsonApiFilterViewPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'FILTERVIEW': "filterView", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiFilterViewPatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'relationships': (JsonApiFilterViewInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiFilterViewPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterView", must be one of ["filterView", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiFilterViewInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterView") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiFilterViewPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "filterView", must be one of ["filterView", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiFilterViewInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "filterView") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch_attributes.py deleted file mode 100644 index b8ce41c65..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch_attributes.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiFilterViewPatchAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_default': (bool,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'content': 'content', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_default': 'isDefault', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The respective filter context.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_default (bool): Indicator whether the filter view should by applied by default.. [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The respective filter context.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_default (bool): Indicator whether the filter view should by applied by default.. [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch_document.py deleted file mode 100644 index b89467cdf..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_view_patch import JsonApiFilterViewPatch - globals()['JsonApiFilterViewPatch'] = JsonApiFilterViewPatch - - -class JsonApiFilterViewPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiFilterViewPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterViewPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiFilterViewPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiFilterViewPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in.py deleted file mode 100644 index 150730d8e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes - globals()['JsonApiIdentityProviderInAttributes'] = JsonApiIdentityProviderInAttributes - - -class JsonApiIdentityProviderIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'IDENTITYPROVIDER': "identityProvider", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiIdentityProviderInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiIdentityProviderInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiIdentityProviderInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in_attributes.py deleted file mode 100644 index 8867f8509..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in_attributes.py +++ /dev/null @@ -1,332 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiIdentityProviderInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('idp_type',): { - 'MANAGED_IDP': "MANAGED_IDP", - 'FIM_IDP': "FIM_IDP", - 'DEX_IDP': "DEX_IDP", - 'CUSTOM_IDP': "CUSTOM_IDP", - }, - } - - validations = { - ('custom_claim_mapping',): { - }, - ('oauth_client_id',): { - 'max_length': 255, - }, - ('oauth_client_secret',): { - 'max_length': 255, - }, - ('oauth_custom_auth_attributes',): { - }, - ('oauth_issuer_id',): { - 'max_length': 255, - }, - ('oauth_issuer_location',): { - 'max_length': 255, - }, - ('oauth_subject_id_claim',): { - 'max_length': 255, - }, - ('saml_metadata',): { - 'max_length': 15000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'custom_claim_mapping': ({str: (str,)},), # noqa: E501 - 'identifiers': ([str],), # noqa: E501 - 'idp_type': (str,), # noqa: E501 - 'oauth_client_id': (str,), # noqa: E501 - 'oauth_client_secret': (str,), # noqa: E501 - 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 - 'oauth_custom_scopes': ([str], none_type,), # noqa: E501 - 'oauth_issuer_id': (str,), # noqa: E501 - 'oauth_issuer_location': (str,), # noqa: E501 - 'oauth_subject_id_claim': (str,), # noqa: E501 - 'saml_metadata': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'custom_claim_mapping': 'customClaimMapping', # noqa: E501 - 'identifiers': 'identifiers', # noqa: E501 - 'idp_type': 'idpType', # noqa: E501 - 'oauth_client_id': 'oauthClientId', # noqa: E501 - 'oauth_client_secret': 'oauthClientSecret', # noqa: E501 - 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 - 'oauth_custom_scopes': 'oauthCustomScopes', # noqa: E501 - 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 - 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 - 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 - 'saml_metadata': 'samlMetadata', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_claim_mapping ({str: (str,)}): Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.. [optional] # noqa: E501 - identifiers ([str]): List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.. [optional] # noqa: E501 - idp_type (str): Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.. [optional] # noqa: E501 - oauth_client_id (str): The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_client_secret (str): The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): The location of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - saml_metadata (str): Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_claim_mapping ({str: (str,)}): Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.. [optional] # noqa: E501 - identifiers ([str]): List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.. [optional] # noqa: E501 - idp_type (str): Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.. [optional] # noqa: E501 - oauth_client_id (str): The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_client_secret (str): The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): The location of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - saml_metadata (str): Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in_document.py deleted file mode 100644 index cec635fc6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_identity_provider_in import JsonApiIdentityProviderIn - globals()['JsonApiIdentityProviderIn'] = JsonApiIdentityProviderIn - - -class JsonApiIdentityProviderInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiIdentityProviderIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderInDocument - a model defined in OpenAPI - - Args: - data (JsonApiIdentityProviderIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderInDocument - a model defined in OpenAPI - - Args: - data (JsonApiIdentityProviderIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_linkage.py deleted file mode 100644 index 02b7bfa06..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiIdentityProviderLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'IDENTITYPROVIDER': "identityProvider", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out.py deleted file mode 100644 index d5ad16172..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_identity_provider_out_attributes import JsonApiIdentityProviderOutAttributes - globals()['JsonApiIdentityProviderOutAttributes'] = JsonApiIdentityProviderOutAttributes - - -class JsonApiIdentityProviderOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'IDENTITYPROVIDER': "identityProvider", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiIdentityProviderOutAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiIdentityProviderOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiIdentityProviderOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_attributes.py deleted file mode 100644 index 43be9330c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_attributes.py +++ /dev/null @@ -1,318 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiIdentityProviderOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('idp_type',): { - 'MANAGED_IDP': "MANAGED_IDP", - 'FIM_IDP': "FIM_IDP", - 'DEX_IDP': "DEX_IDP", - 'CUSTOM_IDP': "CUSTOM_IDP", - }, - } - - validations = { - ('custom_claim_mapping',): { - }, - ('oauth_client_id',): { - 'max_length': 255, - }, - ('oauth_custom_auth_attributes',): { - }, - ('oauth_issuer_id',): { - 'max_length': 255, - }, - ('oauth_issuer_location',): { - 'max_length': 255, - }, - ('oauth_subject_id_claim',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'custom_claim_mapping': ({str: (str,)},), # noqa: E501 - 'identifiers': ([str],), # noqa: E501 - 'idp_type': (str,), # noqa: E501 - 'oauth_client_id': (str,), # noqa: E501 - 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 - 'oauth_custom_scopes': ([str], none_type,), # noqa: E501 - 'oauth_issuer_id': (str,), # noqa: E501 - 'oauth_issuer_location': (str,), # noqa: E501 - 'oauth_subject_id_claim': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'custom_claim_mapping': 'customClaimMapping', # noqa: E501 - 'identifiers': 'identifiers', # noqa: E501 - 'idp_type': 'idpType', # noqa: E501 - 'oauth_client_id': 'oauthClientId', # noqa: E501 - 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 - 'oauth_custom_scopes': 'oauthCustomScopes', # noqa: E501 - 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 - 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 - 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_claim_mapping ({str: (str,)}): Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.. [optional] # noqa: E501 - identifiers ([str]): List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.. [optional] # noqa: E501 - idp_type (str): Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.. [optional] # noqa: E501 - oauth_client_id (str): The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): The location of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_claim_mapping ({str: (str,)}): Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.. [optional] # noqa: E501 - identifiers ([str]): List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.. [optional] # noqa: E501 - idp_type (str): Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.. [optional] # noqa: E501 - oauth_client_id (str): The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): The location of your OIDC provider. This field is mandatory for OIDC IdP.. [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_document.py deleted file mode 100644 index 793e4ed55..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_identity_provider_out import JsonApiIdentityProviderOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiIdentityProviderOut'] = JsonApiIdentityProviderOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiIdentityProviderOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiIdentityProviderOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiIdentityProviderOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiIdentityProviderOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_list.py deleted file mode 100644 index 6d29e4570..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_identity_provider_out_with_links import JsonApiIdentityProviderOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiIdentityProviderOutWithLinks'] = JsonApiIdentityProviderOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiIdentityProviderOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiIdentityProviderOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderOutList - a model defined in OpenAPI - - Args: - data ([JsonApiIdentityProviderOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderOutList - a model defined in OpenAPI - - Args: - data ([JsonApiIdentityProviderOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_with_links.py deleted file mode 100644 index c0e5f5039..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_identity_provider_out import JsonApiIdentityProviderOut - from gooddata_api_client.model.json_api_identity_provider_out_attributes import JsonApiIdentityProviderOutAttributes - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiIdentityProviderOut'] = JsonApiIdentityProviderOut - globals()['JsonApiIdentityProviderOutAttributes'] = JsonApiIdentityProviderOutAttributes - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiIdentityProviderOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'IDENTITYPROVIDER': "identityProvider", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiIdentityProviderOutAttributes,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiIdentityProviderOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiIdentityProviderOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiIdentityProviderOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch.py deleted file mode 100644 index 46844937b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes - globals()['JsonApiIdentityProviderInAttributes'] = JsonApiIdentityProviderInAttributes - - -class JsonApiIdentityProviderPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'IDENTITYPROVIDER': "identityProvider", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiIdentityProviderInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiIdentityProviderInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "identityProvider", must be one of ["identityProvider", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiIdentityProviderInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "identityProvider") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch_document.py deleted file mode 100644 index 61dcd7d6d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_identity_provider_patch import JsonApiIdentityProviderPatch - globals()['JsonApiIdentityProviderPatch'] = JsonApiIdentityProviderPatch - - -class JsonApiIdentityProviderPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiIdentityProviderPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiIdentityProviderPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiIdentityProviderPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_to_one_linkage.py deleted file mode 100644 index 86b767d49..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_identity_provider_linkage import JsonApiIdentityProviderLinkage - globals()['JsonApiIdentityProviderLinkage'] = JsonApiIdentityProviderLinkage - - -class JsonApiIdentityProviderToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'IDENTITYPROVIDER': "identityProvider", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "identityProvider" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiIdentityProviderToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "identityProvider" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiIdentityProviderLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in.py deleted file mode 100644 index b5bd2d2b2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_jwk_in_attributes import JsonApiJwkInAttributes - globals()['JsonApiJwkInAttributes'] = JsonApiJwkInAttributes - - -class JsonApiJwkIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'JWK': "jwk", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiJwkInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiJwkIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "jwk", must be one of ["jwk", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiJwkInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "jwk") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiJwkIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "jwk", must be one of ["jwk", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiJwkInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "jwk") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes.py deleted file mode 100644 index 6b18c68e8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_jwk_in_attributes_content import JsonApiJwkInAttributesContent - globals()['JsonApiJwkInAttributesContent'] = JsonApiJwkInAttributesContent - - -class JsonApiJwkInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (JsonApiJwkInAttributesContent,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiJwkInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content (JsonApiJwkInAttributesContent): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiJwkInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content (JsonApiJwkInAttributesContent): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py deleted file mode 100644 index 47aec8f18..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py +++ /dev/null @@ -1,366 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.rsa_specification import RsaSpecification - globals()['RsaSpecification'] = RsaSpecification - - -class JsonApiJwkInAttributesContent(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('alg',): { - 'RS256': "RS256", - 'RS384': "RS384", - 'RS512': "RS512", - }, - ('kty',): { - 'RSA': "RSA", - }, - ('use',): { - 'SIG': "sig", - }, - } - - validations = { - ('kid',): { - 'max_length': 255, - 'min_length': 0, - 'regex': { - 'pattern': r'^[^.]', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'x5c': ([str],), # noqa: E501 - 'x5t': (str,), # noqa: E501 - 'alg': (str,), # noqa: E501 - 'e': (str,), # noqa: E501 - 'kid': (str,), # noqa: E501 - 'kty': (str,), # noqa: E501 - 'n': (str,), # noqa: E501 - 'use': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'x5c': 'x5c', # noqa: E501 - 'x5t': 'x5t', # noqa: E501 - 'alg': 'alg', # noqa: E501 - 'e': 'e', # noqa: E501 - 'kid': 'kid', # noqa: E501 - 'kty': 'kty', # noqa: E501 - 'n': 'n', # noqa: E501 - 'use': 'use', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiJwkInAttributesContent - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - x5c ([str]): [optional] # noqa: E501 - x5t (str): [optional] # noqa: E501 - alg (str): [optional] # noqa: E501 - e (str): [optional] # noqa: E501 - kid (str): [optional] # noqa: E501 - kty (str): [optional] if omitted the server will use the default value of "RSA" # noqa: E501 - n (str): [optional] # noqa: E501 - use (str): [optional] if omitted the server will use the default value of "sig" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiJwkInAttributesContent - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - x5c ([str]): [optional] # noqa: E501 - x5t (str): [optional] # noqa: E501 - alg (str): [optional] # noqa: E501 - e (str): [optional] # noqa: E501 - kid (str): [optional] # noqa: E501 - kty (str): [optional] if omitted the server will use the default value of "RSA" # noqa: E501 - n (str): [optional] # noqa: E501 - use (str): [optional] if omitted the server will use the default value of "sig" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - RsaSpecification, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_document.py deleted file mode 100644 index be7abc512..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_jwk_in import JsonApiJwkIn - globals()['JsonApiJwkIn'] = JsonApiJwkIn - - -class JsonApiJwkInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiJwkIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiJwkInDocument - a model defined in OpenAPI - - Args: - data (JsonApiJwkIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiJwkInDocument - a model defined in OpenAPI - - Args: - data (JsonApiJwkIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out.py deleted file mode 100644 index ee76c437c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_jwk_in_attributes import JsonApiJwkInAttributes - globals()['JsonApiJwkInAttributes'] = JsonApiJwkInAttributes - - -class JsonApiJwkOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'JWK': "jwk", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiJwkInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiJwkOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "jwk", must be one of ["jwk", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiJwkInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "jwk") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiJwkOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "jwk", must be one of ["jwk", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiJwkInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "jwk") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_document.py deleted file mode 100644 index c5b45d2b4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_jwk_out import JsonApiJwkOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiJwkOut'] = JsonApiJwkOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiJwkOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiJwkOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiJwkOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiJwkOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiJwkOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiJwkOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_list.py deleted file mode 100644 index a789806f1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_jwk_out_with_links import JsonApiJwkOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiJwkOutWithLinks'] = JsonApiJwkOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiJwkOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiJwkOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiJwkOutList - a model defined in OpenAPI - - Args: - data ([JsonApiJwkOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiJwkOutList - a model defined in OpenAPI - - Args: - data ([JsonApiJwkOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_with_links.py deleted file mode 100644 index af95a8ff0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_jwk_in_attributes import JsonApiJwkInAttributes - from gooddata_api_client.model.json_api_jwk_out import JsonApiJwkOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiJwkInAttributes'] = JsonApiJwkInAttributes - globals()['JsonApiJwkOut'] = JsonApiJwkOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiJwkOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'JWK': "jwk", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiJwkInAttributes,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiJwkOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "jwk", must be one of ["jwk", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiJwkInAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "jwk") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiJwkOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "jwk", must be one of ["jwk", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiJwkInAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "jwk") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiJwkOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch.py deleted file mode 100644 index 606fe189d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_jwk_in_attributes import JsonApiJwkInAttributes - globals()['JsonApiJwkInAttributes'] = JsonApiJwkInAttributes - - -class JsonApiJwkPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'JWK': "jwk", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiJwkInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiJwkPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "jwk", must be one of ["jwk", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiJwkInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "jwk") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiJwkPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "jwk", must be one of ["jwk", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiJwkInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "jwk") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch_document.py deleted file mode 100644 index 5758d48bd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_jwk_patch import JsonApiJwkPatch - globals()['JsonApiJwkPatch'] = JsonApiJwkPatch - - -class JsonApiJwkPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiJwkPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiJwkPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiJwkPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiJwkPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiJwkPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_linkage.py deleted file mode 100644 index 8aabd522b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiLabelLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'LABEL': "label", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiLabelLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "label", must be one of ["label", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "label") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiLabelLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "label", must be one of ["label", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "label") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out.py deleted file mode 100644 index 2c59a3a9f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_label_out_attributes import JsonApiLabelOutAttributes - from gooddata_api_client.model.json_api_label_out_relationships import JsonApiLabelOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiLabelOutAttributes'] = JsonApiLabelOutAttributes - globals()['JsonApiLabelOutRelationships'] = JsonApiLabelOutRelationships - - -class JsonApiLabelOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'LABEL': "label", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiLabelOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiLabelOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiLabelOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "label", must be one of ["label", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "label") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiLabelOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "label", must be one of ["label", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "label") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_label_out.pyi index 51a2bd3ca..c307ef5b7 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_out.pyi @@ -41,92 +41,92 @@ class JsonApiLabelOut( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def LABEL(cls): return cls("label") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: areRelationsValid = schemas.BoolSchema - - + + class description( schemas.StrSchema ): pass primary = schemas.BoolSchema - - + + class sourceColumn( schemas.StrSchema ): pass - - + + class sourceColumnDataType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def INT(cls): return cls("INT") - + @schemas.classproperty def STRING(cls): return cls("STRING") - + @schemas.classproperty def DATE(cls): return cls("DATE") - + @schemas.classproperty def NUMERIC(cls): return cls("NUMERIC") - + @schemas.classproperty def TIMESTAMP(cls): return cls("TIMESTAMP") - + @schemas.classproperty def TIMESTAMP_TZ(cls): return cls("TIMESTAMP_TZ") - + @schemas.classproperty def BOOLEAN(cls): return cls("BOOLEAN") - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -137,38 +137,38 @@ class JsonApiLabelOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): pass - - + + class valueType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def TEXT(cls): return cls("TEXT") - + @schemas.classproperty def HYPERLINK(cls): return cls("HYPERLINK") - + @schemas.classproperty def GEO(cls): return cls("GEO") - + @schemas.classproperty def GEO_LONGITUDE(cls): return cls("GEO_LONGITUDE") - + @schemas.classproperty def GEO_LATITUDE(cls): return cls("GEO_LATITUDE") @@ -182,70 +182,70 @@ class JsonApiLabelOut( "title": title, "valueType": valueType, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["primary"]) -> MetaOapg.properties.primary: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sourceColumn"]) -> MetaOapg.properties.sourceColumn: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> MetaOapg.properties.sourceColumnDataType: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["valueType"]) -> MetaOapg.properties.valueType: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "primary", "sourceColumn", "sourceColumnDataType", "tags", "title", "valueType", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["primary"]) -> typing.Union[MetaOapg.properties.primary, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sourceColumn"]) -> typing.Union[MetaOapg.properties.sourceColumn, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> typing.Union[MetaOapg.properties.sourceColumnDataType, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["valueType"]) -> typing.Union[MetaOapg.properties.valueType, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "primary", "sourceColumn", "sourceColumnDataType", "tags", "title", "valueType", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -274,42 +274,42 @@ class JsonApiLabelOut( _configuration=_configuration, **kwargs, ) - - + + class meta( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class origin( schemas.DictSchema ): - - + + class MetaOapg: required = { "originType", "originId", } - + class properties: originId = schemas.StrSchema - - + + class originType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") - + @schemas.classproperty def PARENT(cls): return cls("PARENT") @@ -317,37 +317,37 @@ class JsonApiLabelOut( "originId": originId, "originType": originType, } - + originType: MetaOapg.properties.originType originId: MetaOapg.properties.originId - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -367,28 +367,28 @@ class JsonApiLabelOut( __annotations__ = { "origin": origin, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -403,60 +403,60 @@ class JsonApiLabelOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class attribute( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiAttributeToOneLinkage']: return JsonApiAttributeToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiAttributeToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -474,28 +474,28 @@ class JsonApiLabelOut( __annotations__ = { "attribute": attribute, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> MetaOapg.properties.attribute: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attribute", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> typing.Union[MetaOapg.properties.attribute, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attribute", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -517,54 +517,54 @@ class JsonApiLabelOut( "meta": meta, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -589,4 +589,4 @@ class JsonApiLabelOut( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_to_one_linkage import JsonApiAttributeToOneLinkage +from gooddata_api_client.models.json_api_attribute_to_one_linkage import JsonApiAttributeToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes.py deleted file mode 100644 index a726f5383..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes.py +++ /dev/null @@ -1,322 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiLabelOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('source_column_data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - ('value_type',): { - 'TEXT': "TEXT", - 'HYPERLINK': "HYPERLINK", - 'GEO': "GEO", - 'GEO_LONGITUDE': "GEO_LONGITUDE", - 'GEO_LATITUDE': "GEO_LATITUDE", - 'IMAGE': "IMAGE", - }, - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('source_column',): { - 'max_length': 255, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'primary': (bool,), # noqa: E501 - 'source_column': (str,), # noqa: E501 - 'source_column_data_type': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - 'value_type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'primary': 'primary', # noqa: E501 - 'source_column': 'sourceColumn', # noqa: E501 - 'source_column_data_type': 'sourceColumnDataType', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - 'value_type': 'valueType', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - primary (bool): [optional] # noqa: E501 - source_column (str): [optional] # noqa: E501 - source_column_data_type (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - value_type (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - primary (bool): [optional] # noqa: E501 - source_column (str): [optional] # noqa: E501 - source_column_data_type (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - value_type (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_document.py deleted file mode 100644 index e944d53aa..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks - from gooddata_api_client.model.json_api_label_out import JsonApiLabelOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks - globals()['JsonApiLabelOut'] = JsonApiLabelOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiLabelOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiLabelOut,), # noqa: E501 - 'included': ([JsonApiAttributeOutWithLinks],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiLabelOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiLabelOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_document.pyi index 885013d9e..a705736a1 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_document.pyi @@ -134,6 +134,6 @@ class JsonApiLabelOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks -from gooddata_api_client.model.json_api_label_out import JsonApiLabelOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_label_out import JsonApiLabelOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_list.py deleted file mode 100644 index a20fa93a1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks - from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks - globals()['JsonApiLabelOutWithLinks'] = JsonApiLabelOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiLabelOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiLabelOutWithLinks],), # noqa: E501 - 'included': ([JsonApiAttributeOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutList - a model defined in OpenAPI - - Args: - data ([JsonApiLabelOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutList - a model defined in OpenAPI - - Args: - data ([JsonApiLabelOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiAttributeOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_list.pyi index bc3afa73f..1dfdff31a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiLabelOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiLabelOutWithLinks']: return JsonApiLabelOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiLabelOutWithLinks'], typing.List['JsonApiLabelOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiLabelOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiLabelOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiAttributeOutWithLinks']: return JsonApiAttributeOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiAttributeOutWithLinks'], typing.List['JsonApiAttributeOutWithLinks']], @@ -91,10 +91,10 @@ class JsonApiLabelOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiAttributeOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiLabelOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,6 +158,6 @@ class JsonApiLabelOutList( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks -from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_relationships.py deleted file mode 100644 index 624aede73..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_relationships.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_label_out_relationships_attribute import JsonApiLabelOutRelationshipsAttribute - globals()['JsonApiLabelOutRelationshipsAttribute'] = JsonApiLabelOutRelationshipsAttribute - - -class JsonApiLabelOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute': (JsonApiLabelOutRelationshipsAttribute,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute': 'attribute', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute (JsonApiLabelOutRelationshipsAttribute): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute (JsonApiLabelOutRelationshipsAttribute): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_relationships_attribute.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_relationships_attribute.py deleted file mode 100644 index 22290f3bb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_relationships_attribute.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_attribute_to_one_linkage import JsonApiAttributeToOneLinkage - globals()['JsonApiAttributeToOneLinkage'] = JsonApiAttributeToOneLinkage - - -class JsonApiLabelOutRelationshipsAttribute(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiAttributeToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutRelationshipsAttribute - a model defined in OpenAPI - - Args: - data (JsonApiAttributeToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutRelationshipsAttribute - a model defined in OpenAPI - - Args: - data (JsonApiAttributeToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_with_links.py deleted file mode 100644 index bf71e00d4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_label_out import JsonApiLabelOut - from gooddata_api_client.model.json_api_label_out_attributes import JsonApiLabelOutAttributes - from gooddata_api_client.model.json_api_label_out_relationships import JsonApiLabelOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiLabelOut'] = JsonApiLabelOut - globals()['JsonApiLabelOutAttributes'] = JsonApiLabelOutAttributes - globals()['JsonApiLabelOutRelationships'] = JsonApiLabelOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiLabelOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'LABEL': "label", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiLabelOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiLabelOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "label", must be one of ["label", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "label") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiLabelOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "label", must be one of ["label", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "label") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiLabelOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_with_links.pyi index d9011551f..33edf7635 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiLabelOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiLabelOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_label_out import JsonApiLabelOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_label_out import JsonApiLabelOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_to_many_linkage.py deleted file mode 100644 index 7fd000aec..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_label_linkage import JsonApiLabelLinkage - globals()['JsonApiLabelLinkage'] = JsonApiLabelLinkage - - -class JsonApiLabelToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiLabelLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiLabelToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiLabelLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiLabelLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiLabelToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiLabelLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiLabelLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_label_to_many_linkage.pyi index af57aa66b..e51a93f9d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_to_many_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_to_many_linkage.pyi @@ -56,4 +56,4 @@ class JsonApiLabelToManyLinkage( def __getitem__(self, i: int) -> 'JsonApiLabelLinkage': return super().__getitem__(i) -from gooddata_api_client.model.json_api_label_linkage import JsonApiLabelLinkage +from gooddata_api_client.models.json_api_label_linkage import JsonApiLabelLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_to_one_linkage.py deleted file mode 100644 index 37f210462..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_label_linkage import JsonApiLabelLinkage - globals()['JsonApiLabelLinkage'] = JsonApiLabelLinkage - - -class JsonApiLabelToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'LABEL': "label", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiLabelToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "label" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiLabelToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "label" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiLabelLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_label_to_one_linkage.pyi index fd04e4c44..0f7889c3a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_to_one_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_to_one_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiLabelToOneLinkage( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -66,4 +66,4 @@ class JsonApiLabelToOneLinkage( **kwargs, ) -from gooddata_api_client.model.json_api_label_linkage import JsonApiLabelLinkage +from gooddata_api_client.models.json_api_label_linkage import JsonApiLabelLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in.py deleted file mode 100644 index 8647b9935..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_llm_endpoint_in_attributes import JsonApiLlmEndpointInAttributes - globals()['JsonApiLlmEndpointInAttributes'] = JsonApiLlmEndpointInAttributes - - -class JsonApiLlmEndpointIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'LLMENDPOINT': "llmEndpoint", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiLlmEndpointInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointIn - a model defined in OpenAPI - - Args: - attributes (JsonApiLlmEndpointInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "llmEndpoint", must be one of ["llmEndpoint", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "llmEndpoint") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointIn - a model defined in OpenAPI - - Args: - attributes (JsonApiLlmEndpointInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "llmEndpoint", must be one of ["llmEndpoint", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "llmEndpoint") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in_attributes.py deleted file mode 100644 index 99ba87736..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in_attributes.py +++ /dev/null @@ -1,311 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiLlmEndpointInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('provider',): { - 'OPENAI': "OPENAI", - 'AZURE_OPENAI': "AZURE_OPENAI", - }, - } - - validations = { - ('title',): { - 'max_length': 255, - }, - ('token',): { - 'max_length': 10000, - }, - ('base_url',): { - 'max_length': 255, - }, - ('llm_model',): { - 'max_length': 255, - }, - ('llm_organization',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'title': (str,), # noqa: E501 - 'token': (str,), # noqa: E501 - 'base_url': (str, none_type,), # noqa: E501 - 'llm_model': (str,), # noqa: E501 - 'llm_organization': (str, none_type,), # noqa: E501 - 'provider': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'title': 'title', # noqa: E501 - 'token': 'token', # noqa: E501 - 'base_url': 'baseUrl', # noqa: E501 - 'llm_model': 'llmModel', # noqa: E501 - 'llm_organization': 'llmOrganization', # noqa: E501 - 'provider': 'provider', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, title, token, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointInAttributes - a model defined in OpenAPI - - Args: - title (str): User-facing title of the LLM Provider. - token (str): The token to use to connect to the LLM provider. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom LLM endpoint.. [optional] # noqa: E501 - llm_model (str): LLM Model. We provide a default model for each provider, but you can override it here.. [optional] # noqa: E501 - llm_organization (str, none_type): Organization in LLM provider.. [optional] # noqa: E501 - provider (str): LLM Provider.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - self.token = token - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, title, token, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointInAttributes - a model defined in OpenAPI - - Args: - title (str): User-facing title of the LLM Provider. - token (str): The token to use to connect to the LLM provider. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom LLM endpoint.. [optional] # noqa: E501 - llm_model (str): LLM Model. We provide a default model for each provider, but you can override it here.. [optional] # noqa: E501 - llm_organization (str, none_type): Organization in LLM provider.. [optional] # noqa: E501 - provider (str): LLM Provider.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - self.token = token - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in_document.py deleted file mode 100644 index 3fc291295..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_llm_endpoint_in import JsonApiLlmEndpointIn - globals()['JsonApiLlmEndpointIn'] = JsonApiLlmEndpointIn - - -class JsonApiLlmEndpointInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiLlmEndpointIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointInDocument - a model defined in OpenAPI - - Args: - data (JsonApiLlmEndpointIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointInDocument - a model defined in OpenAPI - - Args: - data (JsonApiLlmEndpointIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out.py deleted file mode 100644 index a9850660e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_llm_endpoint_out_attributes import JsonApiLlmEndpointOutAttributes - globals()['JsonApiLlmEndpointOutAttributes'] = JsonApiLlmEndpointOutAttributes - - -class JsonApiLlmEndpointOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'LLMENDPOINT': "llmEndpoint", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiLlmEndpointOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointOut - a model defined in OpenAPI - - Args: - attributes (JsonApiLlmEndpointOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "llmEndpoint", must be one of ["llmEndpoint", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "llmEndpoint") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointOut - a model defined in OpenAPI - - Args: - attributes (JsonApiLlmEndpointOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "llmEndpoint", must be one of ["llmEndpoint", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "llmEndpoint") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_attributes.py deleted file mode 100644 index 9faf5ad22..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_attributes.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiLlmEndpointOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('provider',): { - 'OPENAI': "OPENAI", - 'AZURE_OPENAI': "AZURE_OPENAI", - }, - } - - validations = { - ('title',): { - 'max_length': 255, - }, - ('base_url',): { - 'max_length': 255, - }, - ('llm_model',): { - 'max_length': 255, - }, - ('llm_organization',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'title': (str,), # noqa: E501 - 'base_url': (str, none_type,), # noqa: E501 - 'llm_model': (str,), # noqa: E501 - 'llm_organization': (str, none_type,), # noqa: E501 - 'provider': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'title': 'title', # noqa: E501 - 'base_url': 'baseUrl', # noqa: E501 - 'llm_model': 'llmModel', # noqa: E501 - 'llm_organization': 'llmOrganization', # noqa: E501 - 'provider': 'provider', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, title, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointOutAttributes - a model defined in OpenAPI - - Args: - title (str): User-facing title of the LLM Provider. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom LLM endpoint.. [optional] # noqa: E501 - llm_model (str): LLM Model. We provide a default model for each provider, but you can override it here.. [optional] # noqa: E501 - llm_organization (str, none_type): Organization in LLM provider.. [optional] # noqa: E501 - provider (str): LLM Provider.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, title, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointOutAttributes - a model defined in OpenAPI - - Args: - title (str): User-facing title of the LLM Provider. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom LLM endpoint.. [optional] # noqa: E501 - llm_model (str): LLM Model. We provide a default model for each provider, but you can override it here.. [optional] # noqa: E501 - llm_organization (str, none_type): Organization in LLM provider.. [optional] # noqa: E501 - provider (str): LLM Provider.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_document.py deleted file mode 100644 index d58654b56..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_llm_endpoint_out import JsonApiLlmEndpointOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiLlmEndpointOut'] = JsonApiLlmEndpointOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiLlmEndpointOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiLlmEndpointOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiLlmEndpointOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiLlmEndpointOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_list.py deleted file mode 100644 index f8aec527c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_llm_endpoint_out_with_links import JsonApiLlmEndpointOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiLlmEndpointOutWithLinks'] = JsonApiLlmEndpointOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiLlmEndpointOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiLlmEndpointOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointOutList - a model defined in OpenAPI - - Args: - data ([JsonApiLlmEndpointOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointOutList - a model defined in OpenAPI - - Args: - data ([JsonApiLlmEndpointOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_with_links.py deleted file mode 100644 index bf298968f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_llm_endpoint_out import JsonApiLlmEndpointOut - from gooddata_api_client.model.json_api_llm_endpoint_out_attributes import JsonApiLlmEndpointOutAttributes - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiLlmEndpointOut'] = JsonApiLlmEndpointOut - globals()['JsonApiLlmEndpointOutAttributes'] = JsonApiLlmEndpointOutAttributes - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiLlmEndpointOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'LLMENDPOINT': "llmEndpoint", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiLlmEndpointOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiLlmEndpointOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "llmEndpoint", must be one of ["llmEndpoint", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "llmEndpoint") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiLlmEndpointOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "llmEndpoint", must be one of ["llmEndpoint", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "llmEndpoint") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiLlmEndpointOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch.py deleted file mode 100644 index 2d5a040e8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_llm_endpoint_patch_attributes import JsonApiLlmEndpointPatchAttributes - globals()['JsonApiLlmEndpointPatchAttributes'] = JsonApiLlmEndpointPatchAttributes - - -class JsonApiLlmEndpointPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'LLMENDPOINT': "llmEndpoint", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiLlmEndpointPatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiLlmEndpointPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "llmEndpoint", must be one of ["llmEndpoint", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "llmEndpoint") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiLlmEndpointPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "llmEndpoint", must be one of ["llmEndpoint", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "llmEndpoint") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch_attributes.py deleted file mode 100644 index 75ee7d976..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch_attributes.py +++ /dev/null @@ -1,303 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiLlmEndpointPatchAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('provider',): { - 'OPENAI': "OPENAI", - 'AZURE_OPENAI': "AZURE_OPENAI", - }, - } - - validations = { - ('base_url',): { - 'max_length': 255, - }, - ('llm_model',): { - 'max_length': 255, - }, - ('llm_organization',): { - 'max_length': 255, - }, - ('title',): { - 'max_length': 255, - }, - ('token',): { - 'max_length': 10000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'base_url': (str, none_type,), # noqa: E501 - 'llm_model': (str,), # noqa: E501 - 'llm_organization': (str, none_type,), # noqa: E501 - 'provider': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'token': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'base_url': 'baseUrl', # noqa: E501 - 'llm_model': 'llmModel', # noqa: E501 - 'llm_organization': 'llmOrganization', # noqa: E501 - 'provider': 'provider', # noqa: E501 - 'title': 'title', # noqa: E501 - 'token': 'token', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom LLM endpoint.. [optional] # noqa: E501 - llm_model (str): LLM Model. We provide a default model for each provider, but you can override it here.. [optional] # noqa: E501 - llm_organization (str, none_type): Organization in LLM provider.. [optional] # noqa: E501 - provider (str): LLM Provider.. [optional] # noqa: E501 - title (str): User-facing title of the LLM Provider.. [optional] # noqa: E501 - token (str): The token to use to connect to the LLM provider.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom LLM endpoint.. [optional] # noqa: E501 - llm_model (str): LLM Model. We provide a default model for each provider, but you can override it here.. [optional] # noqa: E501 - llm_organization (str, none_type): Organization in LLM provider.. [optional] # noqa: E501 - provider (str): LLM Provider.. [optional] # noqa: E501 - title (str): User-facing title of the LLM Provider.. [optional] # noqa: E501 - token (str): The token to use to connect to the LLM provider.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch_document.py deleted file mode 100644 index af95c27d6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_llm_endpoint_patch import JsonApiLlmEndpointPatch - globals()['JsonApiLlmEndpointPatch'] = JsonApiLlmEndpointPatch - - -class JsonApiLlmEndpointPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiLlmEndpointPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiLlmEndpointPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiLlmEndpointPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiLlmEndpointPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_in.py deleted file mode 100644 index 2dfdd1060..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_in_attributes import JsonApiMetricInAttributes - globals()['JsonApiMetricInAttributes'] = JsonApiMetricInAttributes - - -class JsonApiMetricIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'METRIC': "metric", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiMetricInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiMetricIn - a model defined in OpenAPI - - Args: - attributes (JsonApiMetricInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiMetricIn - a model defined in OpenAPI - - Args: - attributes (JsonApiMetricInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes.py deleted file mode 100644 index ce2b334d1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent - globals()['JsonApiMetricInAttributesContent'] = JsonApiMetricInAttributesContent - - -class JsonApiMetricInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (JsonApiMetricInAttributesContent,), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 - """JsonApiMetricInAttributes - a model defined in OpenAPI - - Args: - content (JsonApiMetricInAttributesContent): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, *args, **kwargs): # noqa: E501 - """JsonApiMetricInAttributes - a model defined in OpenAPI - - Args: - content (JsonApiMetricInAttributesContent): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes_content.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes_content.py deleted file mode 100644 index d3530548d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes_content.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiMetricInAttributesContent(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('maql',): { - 'max_length': 10000, - }, - ('format',): { - 'max_length': 2048, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'maql': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'maql': 'maql', # noqa: E501 - 'format': 'format', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, maql, *args, **kwargs): # noqa: E501 - """JsonApiMetricInAttributesContent - a model defined in OpenAPI - - Args: - maql (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.maql = maql - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, maql, *args, **kwargs): # noqa: E501 - """JsonApiMetricInAttributesContent - a model defined in OpenAPI - - Args: - maql (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.maql = maql - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_document.py deleted file mode 100644 index 71397fb87..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_in import JsonApiMetricIn - globals()['JsonApiMetricIn'] = JsonApiMetricIn - - -class JsonApiMetricInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiMetricIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiMetricInDocument - a model defined in OpenAPI - - Args: - data (JsonApiMetricIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiMetricInDocument - a model defined in OpenAPI - - Args: - data (JsonApiMetricIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_document.pyi index 462a5f268..09311bb7e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_document.pyi @@ -86,4 +86,4 @@ class JsonApiMetricInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_metric_in import JsonApiMetricIn +from gooddata_api_client.models.json_api_metric_in import JsonApiMetricIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_linkage.py deleted file mode 100644 index 460a37ecc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiMetricLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'METRIC': "metric", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiMetricLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiMetricLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out.py deleted file mode 100644 index 7ff40e868..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out.py +++ /dev/null @@ -1,310 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_metric_out_attributes import JsonApiMetricOutAttributes - from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiMetricOutAttributes'] = JsonApiMetricOutAttributes - globals()['JsonApiMetricOutRelationships'] = JsonApiMetricOutRelationships - - -class JsonApiMetricOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'METRIC': "metric", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiMetricOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiMetricOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiMetricOut - a model defined in OpenAPI - - Args: - attributes (JsonApiMetricOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiMetricOut - a model defined in OpenAPI - - Args: - attributes (JsonApiMetricOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out.pyi index 1487ec1b8..dc35afe9e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out.pyi @@ -42,43 +42,43 @@ class JsonApiMetricOut( "id", "type", } - + class properties: - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: required = { "content", } - + class properties: areRelationsValid = schemas.BoolSchema - - + + class content( schemas.DictSchema ): - - + + class MetaOapg: required = { "maql", } - + class properties: - - + + class format( schemas.StrSchema ): pass - - + + class maql( schemas.StrSchema ): @@ -87,36 +87,36 @@ class JsonApiMetricOut( "format": format, "maql": maql, } - + maql: MetaOapg.properties.maql - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["format", "maql", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> typing.Union[MetaOapg.properties.format, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["format", "maql", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -133,22 +133,22 @@ class JsonApiMetricOut( _configuration=_configuration, **kwargs, ) - - + + class description( schemas.StrSchema ): pass - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -159,11 +159,11 @@ class JsonApiMetricOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): @@ -175,54 +175,54 @@ class JsonApiMetricOut( "tags": tags, "title": title, } - + content: MetaOapg.properties.content - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -245,58 +245,58 @@ class JsonApiMetricOut( _configuration=_configuration, **kwargs, ) - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def METRIC(cls): return cls("metric") - - + + class meta( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class origin( schemas.DictSchema ): - - + + class MetaOapg: required = { "originType", "originId", } - + class properties: originId = schemas.StrSchema - - + + class originType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") - + @schemas.classproperty def PARENT(cls): return cls("PARENT") @@ -304,37 +304,37 @@ class JsonApiMetricOut( "originId": originId, "originType": originType, } - + originType: MetaOapg.properties.originType originId: MetaOapg.properties.originId - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -354,28 +354,28 @@ class JsonApiMetricOut( __annotations__ = { "origin": origin, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -390,60 +390,60 @@ class JsonApiMetricOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiAttributeToManyLinkage']: return JsonApiAttributeToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiAttributeToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -458,50 +458,50 @@ class JsonApiMetricOut( _configuration=_configuration, **kwargs, ) - - + + class datasets( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDatasetToManyLinkage']: return JsonApiDatasetToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiDatasetToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -516,50 +516,50 @@ class JsonApiMetricOut( _configuration=_configuration, **kwargs, ) - - + + class facts( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiFactToManyLinkage']: return JsonApiFactToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiFactToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -574,50 +574,50 @@ class JsonApiMetricOut( _configuration=_configuration, **kwargs, ) - - + + class labels( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiLabelToManyLinkage']: return JsonApiLabelToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiLabelToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -632,50 +632,50 @@ class JsonApiMetricOut( _configuration=_configuration, **kwargs, ) - - + + class metrics( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiMetricToManyLinkage']: return JsonApiMetricToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiMetricToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -697,52 +697,52 @@ class JsonApiMetricOut( "labels": labels, "metrics": metrics, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["datasets"]) -> MetaOapg.properties.datasets: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["facts"]) -> MetaOapg.properties.facts: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["labels"]) -> MetaOapg.properties.labels: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "datasets", "facts", "labels", "metrics", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["datasets"]) -> typing.Union[MetaOapg.properties.datasets, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["facts"]) -> typing.Union[MetaOapg.properties.facts, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["labels"]) -> typing.Union[MetaOapg.properties.labels, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "datasets", "facts", "labels", "metrics", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -772,55 +772,55 @@ class JsonApiMetricOut( "meta": meta, "relationships": relationships, } - + attributes: MetaOapg.properties.attributes id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "meta", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "meta", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -845,8 +845,8 @@ class JsonApiMetricOut( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage -from gooddata_api_client.model.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage -from gooddata_api_client.model.json_api_fact_to_many_linkage import JsonApiFactToManyLinkage -from gooddata_api_client.model.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage -from gooddata_api_client.model.json_api_metric_to_many_linkage import JsonApiMetricToManyLinkage +from gooddata_api_client.models.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage +from gooddata_api_client.models.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage +from gooddata_api_client.models.json_api_fact_to_many_linkage import JsonApiFactToManyLinkage +from gooddata_api_client.models.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage +from gooddata_api_client.models.json_api_metric_to_many_linkage import JsonApiMetricToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_attributes.py deleted file mode 100644 index dd87c1444..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_attributes.py +++ /dev/null @@ -1,310 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent - globals()['JsonApiMetricInAttributesContent'] = JsonApiMetricInAttributesContent - - -class JsonApiMetricOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'content': (JsonApiMetricInAttributesContent,), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutAttributes - a model defined in OpenAPI - - Args: - content (JsonApiMetricInAttributesContent): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutAttributes - a model defined in OpenAPI - - Args: - content (JsonApiMetricInAttributesContent): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.py deleted file mode 100644 index 80593a1b9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_out import JsonApiMetricOut - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiMetricOut'] = JsonApiMetricOut - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiMetricOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiMetricOut,), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiMetricOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiMetricOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.pyi index 77503e0af..9f7d92320 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiMetricOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiMetricOut']: return JsonApiMetricOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiMetricOutIncludes']: return JsonApiMetricOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiMetricOutIncludes'], typing.List['JsonApiMetricOutIncludes']], @@ -67,10 +67,10 @@ class JsonApiMetricOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiMetricOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiMetricOutDocument( "included": included, "links": links, } - + data: 'JsonApiMetricOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiMetricOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_metric_out import JsonApiMetricOut -from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_metric_out import JsonApiMetricOut +from gooddata_api_client.models.json_api_metric_out_includes import JsonApiMetricOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.py deleted file mode 100644 index cc941bc44..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.py +++ /dev/null @@ -1,371 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks - from gooddata_api_client.model.json_api_dataset_out_attributes import JsonApiDatasetOutAttributes - from gooddata_api_client.model.json_api_dataset_out_relationships import JsonApiDatasetOutRelationships - from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks - from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks - from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks - from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks - from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks - globals()['JsonApiDatasetOutAttributes'] = JsonApiDatasetOutAttributes - globals()['JsonApiDatasetOutRelationships'] = JsonApiDatasetOutRelationships - globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks - globals()['JsonApiFactOutWithLinks'] = JsonApiFactOutWithLinks - globals()['JsonApiLabelOutWithLinks'] = JsonApiLabelOutWithLinks - globals()['JsonApiMetricOutWithLinks'] = JsonApiMetricOutWithLinks - globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiMetricOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASET': "dataset", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'links': (ObjectLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiDatasetOutRelationships,), # noqa: E501 - 'attributes': (JsonApiDatasetOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDatasetOutRelationships): [optional] # noqa: E501 - attributes (JsonApiDatasetOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "dataset" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiDatasetOutRelationships): [optional] # noqa: E501 - attributes (JsonApiDatasetOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "dataset" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAttributeOutWithLinks, - JsonApiDatasetOutWithLinks, - JsonApiFactOutWithLinks, - JsonApiLabelOutWithLinks, - JsonApiMetricOutWithLinks, - JsonApiUserIdentifierOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.pyi index 45f72f0c8..1559d2894 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.pyi @@ -35,7 +35,7 @@ class JsonApiMetricOutIncludes( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -68,8 +68,8 @@ class JsonApiMetricOutIncludes( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks -from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks -from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks -from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks -from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.json_api_metric_out_with_links import JsonApiMetricOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.py deleted file mode 100644 index 7e38c3294..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes - from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes - globals()['JsonApiMetricOutWithLinks'] = JsonApiMetricOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiMetricOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiMetricOutWithLinks],), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutList - a model defined in OpenAPI - - Args: - data ([JsonApiMetricOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutList - a model defined in OpenAPI - - Args: - data ([JsonApiMetricOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.pyi index 2e14a4a8b..9f736459b 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiMetricOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiMetricOutWithLinks']: return JsonApiMetricOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiMetricOutWithLinks'], typing.List['JsonApiMetricOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiMetricOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiMetricOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiMetricOutIncludes']: return JsonApiMetricOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiMetricOutIncludes'], typing.List['JsonApiMetricOutIncludes']], @@ -91,10 +91,10 @@ class JsonApiMetricOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiMetricOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiMetricOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,6 +158,6 @@ class JsonApiMetricOutList( **kwargs, ) -from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes -from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_metric_out_includes import JsonApiMetricOutIncludes +from gooddata_api_client.models.json_api_metric_out_with_links import JsonApiMetricOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_relationships.py deleted file mode 100644 index 5c3ebc5c8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_relationships.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics - from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes - from gooddata_api_client.model.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets - globals()['JsonApiAnalyticalDashboardOutRelationshipsLabels'] = JsonApiAnalyticalDashboardOutRelationshipsLabels - globals()['JsonApiAnalyticalDashboardOutRelationshipsMetrics'] = JsonApiAnalyticalDashboardOutRelationshipsMetrics - globals()['JsonApiAttributeHierarchyOutRelationshipsAttributes'] = JsonApiAttributeHierarchyOutRelationshipsAttributes - globals()['JsonApiDatasetOutRelationshipsFacts'] = JsonApiDatasetOutRelationshipsFacts - - -class JsonApiMetricOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'datasets': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 - 'facts': (JsonApiDatasetOutRelationshipsFacts,), # noqa: E501 - 'labels': (JsonApiAnalyticalDashboardOutRelationshipsLabels,), # noqa: E501 - 'metrics': (JsonApiAnalyticalDashboardOutRelationshipsMetrics,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'datasets': 'datasets', # noqa: E501 - 'facts': 'facts', # noqa: E501 - 'labels': 'labels', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 - labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 - metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 - labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 - metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_with_links.py deleted file mode 100644 index 97b662ae5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_metric_out import JsonApiMetricOut - from gooddata_api_client.model.json_api_metric_out_attributes import JsonApiMetricOutAttributes - from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiMetricOut'] = JsonApiMetricOut - globals()['JsonApiMetricOutAttributes'] = JsonApiMetricOutAttributes - globals()['JsonApiMetricOutRelationships'] = JsonApiMetricOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiMetricOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'METRIC': "metric", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiMetricOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiMetricOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiMetricOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiMetricOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiMetricOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_with_links.pyi index 31a52099c..9b5b81a02 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiMetricOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiMetricOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_metric_out import JsonApiMetricOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_metric_out import JsonApiMetricOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch.py deleted file mode 100644 index a7f5e553f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_patch_attributes import JsonApiMetricPatchAttributes - globals()['JsonApiMetricPatchAttributes'] = JsonApiMetricPatchAttributes - - -class JsonApiMetricPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'METRIC': "metric", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiMetricPatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiMetricPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiMetricPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiMetricPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiMetricPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_attributes.py deleted file mode 100644 index e76b86442..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_attributes.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent - globals()['JsonApiMetricInAttributesContent'] = JsonApiMetricInAttributesContent - - -class JsonApiMetricPatchAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'content': (JsonApiMetricInAttributesContent,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'content': 'content', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiMetricPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content (JsonApiMetricInAttributesContent): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiMetricPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content (JsonApiMetricInAttributesContent): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_document.py deleted file mode 100644 index c21a4d6c8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_patch import JsonApiMetricPatch - globals()['JsonApiMetricPatch'] = JsonApiMetricPatch - - -class JsonApiMetricPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiMetricPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiMetricPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiMetricPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiMetricPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiMetricPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_document.pyi index 9631941af..a4f84e5fe 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiMetricPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiMetricPatch']: return JsonApiMetricPatch __annotations__ = { "data": data, } - + data: 'JsonApiMetricPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiMetricPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_metric_patch import JsonApiMetricPatch +from gooddata_api_client.models.json_api_metric_patch import JsonApiMetricPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_post_optional_id.py deleted file mode 100644 index 86e21f148..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_post_optional_id.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_in_attributes import JsonApiMetricInAttributes - globals()['JsonApiMetricInAttributes'] = JsonApiMetricInAttributes - - -class JsonApiMetricPostOptionalId(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'METRIC': "metric", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiMetricInAttributes,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 - """JsonApiMetricPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiMetricInAttributes): - - Keyword Args: - type (str): Object type. defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, *args, **kwargs): # noqa: E501 - """JsonApiMetricPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiMetricInAttributes): - - Keyword Args: - type (str): Object type. defaults to "metric", must be one of ["metric", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "metric") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_post_optional_id_document.py deleted file mode 100644 index b8698904f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_post_optional_id_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_post_optional_id import JsonApiMetricPostOptionalId - globals()['JsonApiMetricPostOptionalId'] = JsonApiMetricPostOptionalId - - -class JsonApiMetricPostOptionalIdDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiMetricPostOptionalId,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiMetricPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiMetricPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiMetricPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiMetricPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_metric_post_optional_id_document.pyi index 2f14f21d6..b6af3c1c6 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_post_optional_id_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_post_optional_id_document.pyi @@ -38,38 +38,38 @@ class JsonApiMetricPostOptionalIdDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiMetricPostOptionalId']: return JsonApiMetricPostOptionalId __annotations__ = { "data": data, } - + data: 'JsonApiMetricPostOptionalId' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricPostOptionalId': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricPostOptionalId': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiMetricPostOptionalIdDocument( **kwargs, ) -from gooddata_api_client.model.json_api_metric_post_optional_id import JsonApiMetricPostOptionalId +from gooddata_api_client.models.json_api_metric_post_optional_id import JsonApiMetricPostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_to_many_linkage.py deleted file mode 100644 index 6a5e44fc3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_linkage import JsonApiMetricLinkage - globals()['JsonApiMetricLinkage'] = JsonApiMetricLinkage - - -class JsonApiMetricToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiMetricLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiMetricToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiMetricLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiMetricLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiMetricToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiMetricLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiMetricLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_metric_to_many_linkage.pyi index 577ffa60e..8976ddc01 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_to_many_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_to_many_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiMetricToManyLinkage( class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiMetricLinkage']: return JsonApiMetricLinkage @@ -56,4 +56,4 @@ class JsonApiMetricToManyLinkage( def __getitem__(self, i: int) -> 'JsonApiMetricLinkage': return super().__getitem__(i) -from gooddata_api_client.model.json_api_metric_linkage import JsonApiMetricLinkage +from gooddata_api_client.models.json_api_metric_linkage import JsonApiMetricLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out.py deleted file mode 100644 index c82e5d404..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_identifier_out_attributes import JsonApiNotificationChannelIdentifierOutAttributes - globals()['JsonApiNotificationChannelIdentifierOutAttributes'] = JsonApiNotificationChannelIdentifierOutAttributes - - -class JsonApiNotificationChannelIdentifierOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'NOTIFICATIONCHANNELIDENTIFIER': "notificationChannelIdentifier", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiNotificationChannelIdentifierOutAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIdentifierOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "notificationChannelIdentifier", must be one of ["notificationChannelIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelIdentifierOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannelIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIdentifierOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "notificationChannelIdentifier", must be one of ["notificationChannelIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelIdentifierOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannelIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_attributes.py deleted file mode 100644 index 3cd18a400..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_attributes.py +++ /dev/null @@ -1,293 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiNotificationChannelIdentifierOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('allowed_recipients',): { - 'CREATOR': "CREATOR", - 'INTERNAL': "INTERNAL", - 'EXTERNAL': "EXTERNAL", - }, - ('destination_type',): { - 'WEBHOOK': "WEBHOOK", - 'SMTP': "SMTP", - 'DEFAULT_SMTP': "DEFAULT_SMTP", - 'IN_PLATFORM': "IN_PLATFORM", - }, - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'allowed_recipients': (str,), # noqa: E501 - 'description': (str, none_type,), # noqa: E501 - 'destination_type': (str,), # noqa: E501 - 'name': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'allowed_recipients': 'allowedRecipients', # noqa: E501 - 'description': 'description', # noqa: E501 - 'destination_type': 'destinationType', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIdentifierOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_recipients (str): Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization . [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - destination_type (str): [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIdentifierOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_recipients (str): Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization . [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - destination_type (str): [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_document.py deleted file mode 100644 index b7a36300f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_identifier_out import JsonApiNotificationChannelIdentifierOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiNotificationChannelIdentifierOut'] = JsonApiNotificationChannelIdentifierOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiNotificationChannelIdentifierOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiNotificationChannelIdentifierOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIdentifierOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelIdentifierOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIdentifierOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelIdentifierOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_list.py deleted file mode 100644 index 1175189b6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_notification_channel_identifier_out_with_links import JsonApiNotificationChannelIdentifierOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiNotificationChannelIdentifierOutWithLinks'] = JsonApiNotificationChannelIdentifierOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiNotificationChannelIdentifierOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiNotificationChannelIdentifierOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIdentifierOutList - a model defined in OpenAPI - - Args: - data ([JsonApiNotificationChannelIdentifierOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIdentifierOutList - a model defined in OpenAPI - - Args: - data ([JsonApiNotificationChannelIdentifierOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_with_links.py deleted file mode 100644 index d266e1886..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_identifier_out import JsonApiNotificationChannelIdentifierOut - from gooddata_api_client.model.json_api_notification_channel_identifier_out_attributes import JsonApiNotificationChannelIdentifierOutAttributes - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiNotificationChannelIdentifierOut'] = JsonApiNotificationChannelIdentifierOut - globals()['JsonApiNotificationChannelIdentifierOutAttributes'] = JsonApiNotificationChannelIdentifierOutAttributes - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiNotificationChannelIdentifierOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'NOTIFICATIONCHANNELIDENTIFIER': "notificationChannelIdentifier", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiNotificationChannelIdentifierOutAttributes,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIdentifierOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "notificationChannelIdentifier", must be one of ["notificationChannelIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelIdentifierOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannelIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIdentifierOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "notificationChannelIdentifier", must be one of ["notificationChannelIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelIdentifierOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannelIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiNotificationChannelIdentifierOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in.py deleted file mode 100644 index a4c262d05..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_in_attributes import JsonApiNotificationChannelInAttributes - globals()['JsonApiNotificationChannelInAttributes'] = JsonApiNotificationChannelInAttributes - - -class JsonApiNotificationChannelIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'NOTIFICATIONCHANNEL': "notificationChannel", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiNotificationChannelInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_attributes.py deleted file mode 100644 index 7717d6ba1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_attributes.py +++ /dev/null @@ -1,324 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_in_attributes_destination import JsonApiNotificationChannelInAttributesDestination - globals()['JsonApiNotificationChannelInAttributesDestination'] = JsonApiNotificationChannelInAttributesDestination - - -class JsonApiNotificationChannelInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('allowed_recipients',): { - 'CREATOR': "CREATOR", - 'INTERNAL': "INTERNAL", - 'EXTERNAL': "EXTERNAL", - }, - ('dashboard_link_visibility',): { - 'HIDDEN': "HIDDEN", - 'INTERNAL_ONLY': "INTERNAL_ONLY", - 'ALL': "ALL", - }, - ('in_platform_notification',): { - 'DISABLED': "DISABLED", - 'ENABLED': "ENABLED", - }, - } - - validations = { - ('custom_dashboard_url',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('name',): { - 'max_length': 255, - }, - ('notification_source',): { - 'max_length': 10000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'allowed_recipients': (str,), # noqa: E501 - 'custom_dashboard_url': (str,), # noqa: E501 - 'dashboard_link_visibility': (str,), # noqa: E501 - 'description': (str, none_type,), # noqa: E501 - 'destination': (JsonApiNotificationChannelInAttributesDestination,), # noqa: E501 - 'in_platform_notification': (str,), # noqa: E501 - 'name': (str, none_type,), # noqa: E501 - 'notification_source': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'allowed_recipients': 'allowedRecipients', # noqa: E501 - 'custom_dashboard_url': 'customDashboardUrl', # noqa: E501 - 'dashboard_link_visibility': 'dashboardLinkVisibility', # noqa: E501 - 'description': 'description', # noqa: E501 - 'destination': 'destination', # noqa: E501 - 'in_platform_notification': 'inPlatformNotification', # noqa: E501 - 'name': 'name', # noqa: E501 - 'notification_source': 'notificationSource', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_recipients (str): Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization . [optional] # noqa: E501 - custom_dashboard_url (str): Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} . [optional] # noqa: E501 - dashboard_link_visibility (str): Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link . [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - destination (JsonApiNotificationChannelInAttributesDestination): [optional] # noqa: E501 - in_platform_notification (str): In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications . [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - notification_source (str): Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} . [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_recipients (str): Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization . [optional] # noqa: E501 - custom_dashboard_url (str): Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} . [optional] # noqa: E501 - dashboard_link_visibility (str): Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link . [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - destination (JsonApiNotificationChannelInAttributesDestination): [optional] # noqa: E501 - in_platform_notification (str): In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications . [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - notification_source (str): Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} . [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_attributes_destination.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_attributes_destination.py deleted file mode 100644 index d6cc96a30..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_attributes_destination.py +++ /dev/null @@ -1,384 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.default_smtp import DefaultSmtp - from gooddata_api_client.model.in_platform import InPlatform - from gooddata_api_client.model.smtp import Smtp - from gooddata_api_client.model.webhook import Webhook - globals()['DefaultSmtp'] = DefaultSmtp - globals()['InPlatform'] = InPlatform - globals()['Smtp'] = Smtp - globals()['Webhook'] = Webhook - - -class JsonApiNotificationChannelInAttributesDestination(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('port',): { - '25': 25, - '465': 465, - '587': 587, - '2525': 2525, - }, - ('type',): { - 'WEBHOOK': "WEBHOOK", - }, - } - - validations = { - ('token',): { - 'max_length': 10000, - }, - ('url',): { - 'max_length': 255, - 'regex': { - 'pattern': r'https?\:\/\/.*', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'from_email': (str,), # noqa: E501 - 'from_email_name': (str,), # noqa: E501 - 'host': (str,), # noqa: E501 - 'password': (str,), # noqa: E501 - 'port': (int,), # noqa: E501 - 'username': (str,), # noqa: E501 - 'has_token': (bool, none_type,), # noqa: E501 - 'token': (str, none_type,), # noqa: E501 - 'url': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'from_email': 'fromEmail', # noqa: E501 - 'from_email_name': 'fromEmailName', # noqa: E501 - 'host': 'host', # noqa: E501 - 'password': 'password', # noqa: E501 - 'port': 'port', # noqa: E501 - 'username': 'username', # noqa: E501 - 'has_token': 'hasToken', # noqa: E501 - 'token': 'token', # noqa: E501 - 'url': 'url', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - 'has_token', # noqa: E501 - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelInAttributesDestination - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "WEBHOOK" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelInAttributesDestination - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "WEBHOOK" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - DefaultSmtp, - InPlatform, - Smtp, - Webhook, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_document.py deleted file mode 100644 index 08f66df8d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_in import JsonApiNotificationChannelIn - globals()['JsonApiNotificationChannelIn'] = JsonApiNotificationChannelIn - - -class JsonApiNotificationChannelInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiNotificationChannelIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelInDocument - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelInDocument - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_linkage.py deleted file mode 100644 index c21411e67..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiNotificationChannelLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'NOTIFICATIONCHANNEL': "notificationChannel", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out.py deleted file mode 100644 index 5eb57fd0b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_out_attributes import JsonApiNotificationChannelOutAttributes - globals()['JsonApiNotificationChannelOutAttributes'] = JsonApiNotificationChannelOutAttributes - - -class JsonApiNotificationChannelOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'NOTIFICATIONCHANNEL': "notificationChannel", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiNotificationChannelOutAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_attributes.py deleted file mode 100644 index 3454871ad..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_attributes.py +++ /dev/null @@ -1,335 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_in_attributes_destination import JsonApiNotificationChannelInAttributesDestination - globals()['JsonApiNotificationChannelInAttributesDestination'] = JsonApiNotificationChannelInAttributesDestination - - -class JsonApiNotificationChannelOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('allowed_recipients',): { - 'CREATOR': "CREATOR", - 'INTERNAL': "INTERNAL", - 'EXTERNAL': "EXTERNAL", - }, - ('dashboard_link_visibility',): { - 'HIDDEN': "HIDDEN", - 'INTERNAL_ONLY': "INTERNAL_ONLY", - 'ALL': "ALL", - }, - ('destination_type',): { - 'None': None, - 'WEBHOOK': "WEBHOOK", - 'SMTP': "SMTP", - 'DEFAULT_SMTP': "DEFAULT_SMTP", - 'IN_PLATFORM': "IN_PLATFORM", - }, - ('in_platform_notification',): { - 'DISABLED': "DISABLED", - 'ENABLED': "ENABLED", - }, - } - - validations = { - ('custom_dashboard_url',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('name',): { - 'max_length': 255, - }, - ('notification_source',): { - 'max_length': 10000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'allowed_recipients': (str,), # noqa: E501 - 'custom_dashboard_url': (str,), # noqa: E501 - 'dashboard_link_visibility': (str,), # noqa: E501 - 'description': (str, none_type,), # noqa: E501 - 'destination': (JsonApiNotificationChannelInAttributesDestination,), # noqa: E501 - 'destination_type': (str, none_type,), # noqa: E501 - 'in_platform_notification': (str,), # noqa: E501 - 'name': (str, none_type,), # noqa: E501 - 'notification_source': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'allowed_recipients': 'allowedRecipients', # noqa: E501 - 'custom_dashboard_url': 'customDashboardUrl', # noqa: E501 - 'dashboard_link_visibility': 'dashboardLinkVisibility', # noqa: E501 - 'description': 'description', # noqa: E501 - 'destination': 'destination', # noqa: E501 - 'destination_type': 'destinationType', # noqa: E501 - 'in_platform_notification': 'inPlatformNotification', # noqa: E501 - 'name': 'name', # noqa: E501 - 'notification_source': 'notificationSource', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_recipients (str): Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization . [optional] # noqa: E501 - custom_dashboard_url (str): Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} . [optional] # noqa: E501 - dashboard_link_visibility (str): Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link . [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - destination (JsonApiNotificationChannelInAttributesDestination): [optional] # noqa: E501 - destination_type (str, none_type): [optional] # noqa: E501 - in_platform_notification (str): In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications . [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - notification_source (str): Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} . [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_recipients (str): Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization . [optional] # noqa: E501 - custom_dashboard_url (str): Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} . [optional] # noqa: E501 - dashboard_link_visibility (str): Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link . [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - destination (JsonApiNotificationChannelInAttributesDestination): [optional] # noqa: E501 - destination_type (str, none_type): [optional] # noqa: E501 - in_platform_notification (str): In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications . [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - notification_source (str): Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} . [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_document.py deleted file mode 100644 index 4ceb3157c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_out import JsonApiNotificationChannelOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiNotificationChannelOut'] = JsonApiNotificationChannelOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiNotificationChannelOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiNotificationChannelOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_list.py deleted file mode 100644 index 04056b5b2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiNotificationChannelOutWithLinks'] = JsonApiNotificationChannelOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiNotificationChannelOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiNotificationChannelOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelOutList - a model defined in OpenAPI - - Args: - data ([JsonApiNotificationChannelOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelOutList - a model defined in OpenAPI - - Args: - data ([JsonApiNotificationChannelOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_with_links.py deleted file mode 100644 index d453211ed..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_out import JsonApiNotificationChannelOut - from gooddata_api_client.model.json_api_notification_channel_out_attributes import JsonApiNotificationChannelOutAttributes - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiNotificationChannelOut'] = JsonApiNotificationChannelOut - globals()['JsonApiNotificationChannelOutAttributes'] = JsonApiNotificationChannelOutAttributes - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiNotificationChannelOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'NOTIFICATIONCHANNEL': "notificationChannel", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiNotificationChannelOutAttributes,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiNotificationChannelOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch.py deleted file mode 100644 index 317033a27..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_in_attributes import JsonApiNotificationChannelInAttributes - globals()['JsonApiNotificationChannelInAttributes'] = JsonApiNotificationChannelInAttributes - - -class JsonApiNotificationChannelPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'NOTIFICATIONCHANNEL': "notificationChannel", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiNotificationChannelInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch_document.py deleted file mode 100644 index 9ebe88489..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_patch import JsonApiNotificationChannelPatch - globals()['JsonApiNotificationChannelPatch'] = JsonApiNotificationChannelPatch - - -class JsonApiNotificationChannelPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiNotificationChannelPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id.py deleted file mode 100644 index ce3fe1ca4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_in_attributes import JsonApiNotificationChannelInAttributes - globals()['JsonApiNotificationChannelInAttributes'] = JsonApiNotificationChannelInAttributes - - -class JsonApiNotificationChannelPostOptionalId(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'NOTIFICATIONCHANNEL': "notificationChannel", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiNotificationChannelInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelPostOptionalId - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): Object type. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelPostOptionalId - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): Object type. defaults to "notificationChannel", must be one of ["notificationChannel", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiNotificationChannelInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "notificationChannel") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id_document.py deleted file mode 100644 index 64b852b3a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_post_optional_id import JsonApiNotificationChannelPostOptionalId - globals()['JsonApiNotificationChannelPostOptionalId'] = JsonApiNotificationChannelPostOptionalId - - -class JsonApiNotificationChannelPostOptionalIdDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiNotificationChannelPostOptionalId,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiNotificationChannelPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_to_one_linkage.py deleted file mode 100644 index fe255ec6f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_notification_channel_linkage import JsonApiNotificationChannelLinkage - globals()['JsonApiNotificationChannelLinkage'] = JsonApiNotificationChannelLinkage - - -class JsonApiNotificationChannelToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'NOTIFICATIONCHANNEL': "notificationChannel", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "notificationChannel" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiNotificationChannelToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "notificationChannel" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiNotificationChannelLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_in.py deleted file mode 100644 index 471c44c50..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_in_attributes import JsonApiOrganizationInAttributes - from gooddata_api_client.model.json_api_organization_in_relationships import JsonApiOrganizationInRelationships - globals()['JsonApiOrganizationInAttributes'] = JsonApiOrganizationInAttributes - globals()['JsonApiOrganizationInRelationships'] = JsonApiOrganizationInRelationships - - -class JsonApiOrganizationIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ORGANIZATION': "organization", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationInAttributes,), # noqa: E501 - 'relationships': (JsonApiOrganizationInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organization", must be one of ["organization", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationInAttributes): [optional] # noqa: E501 - relationships (JsonApiOrganizationInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organization") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organization", must be one of ["organization", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationInAttributes): [optional] # noqa: E501 - relationships (JsonApiOrganizationInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organization") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_attributes.py deleted file mode 100644 index 1b70c8f62..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_attributes.py +++ /dev/null @@ -1,334 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiOrganizationInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('early_access',): { - 'max_length': 255, - }, - ('hostname',): { - 'max_length': 255, - }, - ('name',): { - 'max_length': 255, - }, - ('oauth_client_id',): { - 'max_length': 255, - }, - ('oauth_client_secret',): { - 'max_length': 255, - }, - ('oauth_custom_auth_attributes',): { - }, - ('oauth_issuer_id',): { - 'max_length': 255, - }, - ('oauth_issuer_location',): { - 'max_length': 255, - }, - ('oauth_subject_id_claim',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'allowed_origins': ([str],), # noqa: E501 - 'early_access': (str, none_type,), # noqa: E501 - 'early_access_values': ([str], none_type,), # noqa: E501 - 'hostname': (str,), # noqa: E501 - 'name': (str, none_type,), # noqa: E501 - 'oauth_client_id': (str,), # noqa: E501 - 'oauth_client_secret': (str,), # noqa: E501 - 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 - 'oauth_custom_scopes': ([str], none_type,), # noqa: E501 - 'oauth_issuer_id': (str,), # noqa: E501 - 'oauth_issuer_location': (str,), # noqa: E501 - 'oauth_subject_id_claim': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'allowed_origins': 'allowedOrigins', # noqa: E501 - 'early_access': 'earlyAccess', # noqa: E501 - 'early_access_values': 'earlyAccessValues', # noqa: E501 - 'hostname': 'hostname', # noqa: E501 - 'name': 'name', # noqa: E501 - 'oauth_client_id': 'oauthClientId', # noqa: E501 - 'oauth_client_secret': 'oauthClientSecret', # noqa: E501 - 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 - 'oauth_custom_scopes': 'oauthCustomScopes', # noqa: E501 - 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 - 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 - 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_origins ([str]): [optional] # noqa: E501 - early_access (str, none_type): The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.. [optional] # noqa: E501 - early_access_values ([str], none_type): The early access feature identifiers. They are used to enable experimental features.. [optional] # noqa: E501 - hostname (str): [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - oauth_client_id (str): [optional] # noqa: E501 - oauth_client_secret (str): [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_origins ([str]): [optional] # noqa: E501 - early_access (str, none_type): The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.. [optional] # noqa: E501 - early_access_values ([str], none_type): The early access feature identifiers. They are used to enable experimental features.. [optional] # noqa: E501 - hostname (str): [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - oauth_client_id (str): [optional] # noqa: E501 - oauth_client_secret (str): [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_document.py deleted file mode 100644 index 242606b37..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_in import JsonApiOrganizationIn - globals()['JsonApiOrganizationIn'] = JsonApiOrganizationIn - - -class JsonApiOrganizationInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiOrganizationIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationInDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationInDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_document.pyi index eb6f87794..f9fcb4106 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiOrganizationInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiOrganizationIn']: return JsonApiOrganizationIn __annotations__ = { "data": data, } - + data: 'JsonApiOrganizationIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiOrganizationIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiOrganizationIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiOrganizationInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_organization_in import JsonApiOrganizationIn +from gooddata_api_client.models.json_api_organization_in import JsonApiOrganizationIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_relationships.py deleted file mode 100644 index 8e94bc1a5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_relationships.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_in_relationships_identity_provider import JsonApiOrganizationInRelationshipsIdentityProvider - globals()['JsonApiOrganizationInRelationshipsIdentityProvider'] = JsonApiOrganizationInRelationshipsIdentityProvider - - -class JsonApiOrganizationInRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'identity_provider': (JsonApiOrganizationInRelationshipsIdentityProvider,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'identity_provider': 'identityProvider', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - identity_provider (JsonApiOrganizationInRelationshipsIdentityProvider): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - identity_provider (JsonApiOrganizationInRelationshipsIdentityProvider): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_relationships_identity_provider.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_relationships_identity_provider.py deleted file mode 100644 index 2a0f14240..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_relationships_identity_provider.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_identity_provider_to_one_linkage import JsonApiIdentityProviderToOneLinkage - globals()['JsonApiIdentityProviderToOneLinkage'] = JsonApiIdentityProviderToOneLinkage - - -class JsonApiOrganizationInRelationshipsIdentityProvider(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiIdentityProviderToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationInRelationshipsIdentityProvider - a model defined in OpenAPI - - Args: - data (JsonApiIdentityProviderToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationInRelationshipsIdentityProvider - a model defined in OpenAPI - - Args: - data (JsonApiIdentityProviderToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out.py deleted file mode 100644 index 7b7b29129..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_out_attributes import JsonApiOrganizationOutAttributes - from gooddata_api_client.model.json_api_organization_out_meta import JsonApiOrganizationOutMeta - from gooddata_api_client.model.json_api_organization_out_relationships import JsonApiOrganizationOutRelationships - globals()['JsonApiOrganizationOutAttributes'] = JsonApiOrganizationOutAttributes - globals()['JsonApiOrganizationOutMeta'] = JsonApiOrganizationOutMeta - globals()['JsonApiOrganizationOutRelationships'] = JsonApiOrganizationOutRelationships - - -class JsonApiOrganizationOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ORGANIZATION': "organization", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationOutAttributes,), # noqa: E501 - 'meta': (JsonApiOrganizationOutMeta,), # noqa: E501 - 'relationships': (JsonApiOrganizationOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organization", must be one of ["organization", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationOutAttributes): [optional] # noqa: E501 - meta (JsonApiOrganizationOutMeta): [optional] # noqa: E501 - relationships (JsonApiOrganizationOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organization") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organization", must be one of ["organization", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationOutAttributes): [optional] # noqa: E501 - meta (JsonApiOrganizationOutMeta): [optional] # noqa: E501 - relationships (JsonApiOrganizationOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organization") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out.pyi index 9c4dfc881..5ddd52c5e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out.pyi @@ -41,44 +41,44 @@ class JsonApiOrganizationOut( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORGANIZATION(cls): return cls("organization") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class allowedOrigins( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -89,41 +89,41 @@ class JsonApiOrganizationOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class earlyAccess( schemas.StrSchema ): pass - - + + class hostname( schemas.StrSchema ): pass - - + + class name( schemas.StrSchema ): pass - - + + class oauthClientId( schemas.StrSchema ): pass - - + + class oauthIssuerId( schemas.StrSchema ): pass - - + + class oauthIssuerLocation( schemas.StrSchema ): @@ -137,64 +137,64 @@ class JsonApiOrganizationOut( "oauthIssuerId": oauthIssuerId, "oauthIssuerLocation": oauthIssuerLocation, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["allowedOrigins"]) -> MetaOapg.properties.allowedOrigins: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["earlyAccess"]) -> MetaOapg.properties.earlyAccess: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["hostname"]) -> MetaOapg.properties.hostname: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["oauthClientId"]) -> MetaOapg.properties.oauthClientId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["oauthIssuerId"]) -> MetaOapg.properties.oauthIssuerId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> MetaOapg.properties.oauthIssuerLocation: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["allowedOrigins", "earlyAccess", "hostname", "name", "oauthClientId", "oauthIssuerId", "oauthIssuerLocation", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["allowedOrigins"]) -> typing.Union[MetaOapg.properties.allowedOrigins, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["earlyAccess"]) -> typing.Union[MetaOapg.properties.earlyAccess, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["hostname"]) -> typing.Union[MetaOapg.properties.hostname, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["oauthClientId"]) -> typing.Union[MetaOapg.properties.oauthClientId, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerId"]) -> typing.Union[MetaOapg.properties.oauthIssuerId, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> typing.Union[MetaOapg.properties.oauthIssuerLocation, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["allowedOrigins", "earlyAccess", "hostname", "name", "oauthClientId", "oauthIssuerId", "oauthIssuerLocation", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -221,35 +221,35 @@ class JsonApiOrganizationOut( _configuration=_configuration, **kwargs, ) - - + + class meta( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def MANAGE(cls): return cls("MANAGE") - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -260,34 +260,34 @@ class JsonApiOrganizationOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) __annotations__ = { "permissions": permissions, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["permissions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["permissions", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -302,60 +302,60 @@ class JsonApiOrganizationOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class bootstrapUser( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserToOneLinkage']: return JsonApiUserToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -370,50 +370,50 @@ class JsonApiOrganizationOut( _configuration=_configuration, **kwargs, ) - - + + class bootstrapUserGroup( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupToOneLinkage']: return JsonApiUserGroupToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -432,34 +432,34 @@ class JsonApiOrganizationOut( "bootstrapUser": bootstrapUser, "bootstrapUserGroup": bootstrapUserGroup, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["bootstrapUser"]) -> MetaOapg.properties.bootstrapUser: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["bootstrapUserGroup"]) -> MetaOapg.properties.bootstrapUserGroup: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["bootstrapUser", "bootstrapUserGroup", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["bootstrapUser"]) -> typing.Union[MetaOapg.properties.bootstrapUser, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["bootstrapUserGroup"]) -> typing.Union[MetaOapg.properties.bootstrapUserGroup, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["bootstrapUser", "bootstrapUserGroup", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -483,54 +483,54 @@ class JsonApiOrganizationOut( "meta": meta, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -555,5 +555,5 @@ class JsonApiOrganizationOut( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage -from gooddata_api_client.model.json_api_user_to_one_linkage import JsonApiUserToOneLinkage +from gooddata_api_client.models.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage +from gooddata_api_client.models.json_api_user_to_one_linkage import JsonApiUserToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes.py deleted file mode 100644 index 44930cd85..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes.py +++ /dev/null @@ -1,337 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_out_attributes_cache_settings import JsonApiOrganizationOutAttributesCacheSettings - globals()['JsonApiOrganizationOutAttributesCacheSettings'] = JsonApiOrganizationOutAttributesCacheSettings - - -class JsonApiOrganizationOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('early_access',): { - 'max_length': 255, - }, - ('hostname',): { - 'max_length': 255, - }, - ('name',): { - 'max_length': 255, - }, - ('oauth_client_id',): { - 'max_length': 255, - }, - ('oauth_custom_auth_attributes',): { - }, - ('oauth_issuer_id',): { - 'max_length': 255, - }, - ('oauth_issuer_location',): { - 'max_length': 255, - }, - ('oauth_subject_id_claim',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'allowed_origins': ([str],), # noqa: E501 - 'cache_settings': (JsonApiOrganizationOutAttributesCacheSettings,), # noqa: E501 - 'early_access': (str, none_type,), # noqa: E501 - 'early_access_values': ([str], none_type,), # noqa: E501 - 'hostname': (str,), # noqa: E501 - 'name': (str, none_type,), # noqa: E501 - 'oauth_client_id': (str,), # noqa: E501 - 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 - 'oauth_custom_scopes': ([str], none_type,), # noqa: E501 - 'oauth_issuer_id': (str,), # noqa: E501 - 'oauth_issuer_location': (str,), # noqa: E501 - 'oauth_subject_id_claim': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'allowed_origins': 'allowedOrigins', # noqa: E501 - 'cache_settings': 'cacheSettings', # noqa: E501 - 'early_access': 'earlyAccess', # noqa: E501 - 'early_access_values': 'earlyAccessValues', # noqa: E501 - 'hostname': 'hostname', # noqa: E501 - 'name': 'name', # noqa: E501 - 'oauth_client_id': 'oauthClientId', # noqa: E501 - 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 - 'oauth_custom_scopes': 'oauthCustomScopes', # noqa: E501 - 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 - 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 - 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_origins ([str]): [optional] # noqa: E501 - cache_settings (JsonApiOrganizationOutAttributesCacheSettings): [optional] # noqa: E501 - early_access (str, none_type): The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.. [optional] # noqa: E501 - early_access_values ([str], none_type): The early access feature identifiers. They are used to enable experimental features.. [optional] # noqa: E501 - hostname (str): [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - oauth_client_id (str): [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_origins ([str]): [optional] # noqa: E501 - cache_settings (JsonApiOrganizationOutAttributesCacheSettings): [optional] # noqa: E501 - early_access (str, none_type): The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.. [optional] # noqa: E501 - early_access_values ([str], none_type): The early access feature identifiers. They are used to enable experimental features.. [optional] # noqa: E501 - hostname (str): [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - oauth_client_id (str): [optional] # noqa: E501 - oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 - oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 - oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 - oauth_issuer_location (str): [optional] # noqa: E501 - oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes_cache_settings.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes_cache_settings.py deleted file mode 100644 index cc7051a89..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes_cache_settings.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiOrganizationOutAttributesCacheSettings(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('cache_strategy',): { - 'DURABLE': "DURABLE", - 'EPHEMERAL': "EPHEMERAL", - }, - } - - validations = { - ('cache_strategy',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'cache_strategy': (str,), # noqa: E501 - 'extra_cache_budget': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'cache_strategy': 'cacheStrategy', # noqa: E501 - 'extra_cache_budget': 'extraCacheBudget', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutAttributesCacheSettings - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_strategy (str): [optional] # noqa: E501 - extra_cache_budget (int): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutAttributesCacheSettings - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_strategy (str): [optional] # noqa: E501 - extra_cache_budget (int): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_document.py deleted file mode 100644 index 14d3ebd89..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_out import JsonApiOrganizationOut - from gooddata_api_client.model.json_api_organization_out_includes import JsonApiOrganizationOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiOrganizationOut'] = JsonApiOrganizationOut - globals()['JsonApiOrganizationOutIncludes'] = JsonApiOrganizationOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiOrganizationOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiOrganizationOut,), # noqa: E501 - 'included': ([JsonApiOrganizationOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiOrganizationOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiOrganizationOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_document.pyi index 80e1e6b0b..4abdf193b 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_document.pyi @@ -134,6 +134,6 @@ class JsonApiOrganizationOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_organization_out import JsonApiOrganizationOut -from gooddata_api_client.model.json_api_organization_out_includes import JsonApiOrganizationOutIncludes -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_organization_out import JsonApiOrganizationOut +from gooddata_api_client.models.json_api_organization_out_includes import JsonApiOrganizationOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_includes.py deleted file mode 100644 index f71afe680..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_includes.py +++ /dev/null @@ -1,356 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_identity_provider_out_attributes import JsonApiIdentityProviderOutAttributes - from gooddata_api_client.model.json_api_identity_provider_out_with_links import JsonApiIdentityProviderOutWithLinks - from gooddata_api_client.model.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships - from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks - from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiIdentityProviderOutAttributes'] = JsonApiIdentityProviderOutAttributes - globals()['JsonApiIdentityProviderOutWithLinks'] = JsonApiIdentityProviderOutWithLinks - globals()['JsonApiUserGroupInRelationships'] = JsonApiUserGroupInRelationships - globals()['JsonApiUserGroupOutWithLinks'] = JsonApiUserGroupOutWithLinks - globals()['JsonApiUserOutWithLinks'] = JsonApiUserOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiOrganizationOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'IDENTITYPROVIDER': "identityProvider", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiIdentityProviderOutAttributes,), # noqa: E501 - 'relationships': (JsonApiUserGroupInRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiIdentityProviderOutAttributes): [optional] # noqa: E501 - relationships (JsonApiUserGroupInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "identityProvider" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiIdentityProviderOutAttributes): [optional] # noqa: E501 - relationships (JsonApiUserGroupInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "identityProvider" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiIdentityProviderOutWithLinks, - JsonApiUserGroupOutWithLinks, - JsonApiUserOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_includes.pyi index 0f907afe6..9669aac7c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_includes.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_includes.pyi @@ -35,7 +35,7 @@ class JsonApiOrganizationOutIncludes( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -65,5 +65,5 @@ class JsonApiOrganizationOutIncludes( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks -from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_meta.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_meta.py deleted file mode 100644 index cbd10176e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_meta.py +++ /dev/null @@ -1,268 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiOrganizationOutMeta(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('permissions',): { - 'MANAGE': "MANAGE", - 'SELF_CREATE_TOKEN': "SELF_CREATE_TOKEN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'permissions': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([str]): List of valid permissions for a logged-in user.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([str]): List of valid permissions for a logged-in user.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_relationships.py deleted file mode 100644 index 2acb2ac6d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_relationships.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser - from gooddata_api_client.model.json_api_organization_in_relationships_identity_provider import JsonApiOrganizationInRelationshipsIdentityProvider - from gooddata_api_client.model.json_api_organization_out_relationships_bootstrap_user_group import JsonApiOrganizationOutRelationshipsBootstrapUserGroup - globals()['JsonApiFilterViewInRelationshipsUser'] = JsonApiFilterViewInRelationshipsUser - globals()['JsonApiOrganizationInRelationshipsIdentityProvider'] = JsonApiOrganizationInRelationshipsIdentityProvider - globals()['JsonApiOrganizationOutRelationshipsBootstrapUserGroup'] = JsonApiOrganizationOutRelationshipsBootstrapUserGroup - - -class JsonApiOrganizationOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'bootstrap_user': (JsonApiFilterViewInRelationshipsUser,), # noqa: E501 - 'bootstrap_user_group': (JsonApiOrganizationOutRelationshipsBootstrapUserGroup,), # noqa: E501 - 'identity_provider': (JsonApiOrganizationInRelationshipsIdentityProvider,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'bootstrap_user': 'bootstrapUser', # noqa: E501 - 'bootstrap_user_group': 'bootstrapUserGroup', # noqa: E501 - 'identity_provider': 'identityProvider', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - bootstrap_user (JsonApiFilterViewInRelationshipsUser): [optional] # noqa: E501 - bootstrap_user_group (JsonApiOrganizationOutRelationshipsBootstrapUserGroup): [optional] # noqa: E501 - identity_provider (JsonApiOrganizationInRelationshipsIdentityProvider): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - bootstrap_user (JsonApiFilterViewInRelationshipsUser): [optional] # noqa: E501 - bootstrap_user_group (JsonApiOrganizationOutRelationshipsBootstrapUserGroup): [optional] # noqa: E501 - identity_provider (JsonApiOrganizationInRelationshipsIdentityProvider): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_relationships_bootstrap_user_group.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_relationships_bootstrap_user_group.py deleted file mode 100644 index ea7c60fba..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_relationships_bootstrap_user_group.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage - globals()['JsonApiUserGroupToOneLinkage'] = JsonApiUserGroupToOneLinkage - - -class JsonApiOrganizationOutRelationshipsBootstrapUserGroup(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserGroupToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutRelationshipsBootstrapUserGroup - a model defined in OpenAPI - - Args: - data (JsonApiUserGroupToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationOutRelationshipsBootstrapUserGroup - a model defined in OpenAPI - - Args: - data (JsonApiUserGroupToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_patch.py deleted file mode 100644 index 0d4d6c111..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_patch.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_in_attributes import JsonApiOrganizationInAttributes - from gooddata_api_client.model.json_api_organization_in_relationships import JsonApiOrganizationInRelationships - globals()['JsonApiOrganizationInAttributes'] = JsonApiOrganizationInAttributes - globals()['JsonApiOrganizationInRelationships'] = JsonApiOrganizationInRelationships - - -class JsonApiOrganizationPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ORGANIZATION': "organization", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationInAttributes,), # noqa: E501 - 'relationships': (JsonApiOrganizationInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organization", must be one of ["organization", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationInAttributes): [optional] # noqa: E501 - relationships (JsonApiOrganizationInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organization") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organization", must be one of ["organization", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationInAttributes): [optional] # noqa: E501 - relationships (JsonApiOrganizationInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organization") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_patch_document.py deleted file mode 100644 index e0300a230..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_patch import JsonApiOrganizationPatch - globals()['JsonApiOrganizationPatch'] = JsonApiOrganizationPatch - - -class JsonApiOrganizationPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiOrganizationPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_organization_patch_document.pyi index 9d5678a5f..04eca3403 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiOrganizationPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiOrganizationPatch']: return JsonApiOrganizationPatch __annotations__ = { "data": data, } - + data: 'JsonApiOrganizationPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiOrganizationPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiOrganizationPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiOrganizationPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_organization_patch import JsonApiOrganizationPatch +from gooddata_api_client.models.json_api_organization_patch import JsonApiOrganizationPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in.py deleted file mode 100644 index 988f11f5e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - - -class JsonApiOrganizationSettingIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ORGANIZATIONSETTING': "organizationSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organizationSetting", must be one of ["organizationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organizationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organizationSetting", must be one of ["organizationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organizationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py deleted file mode 100644 index 0518d4a95..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py +++ /dev/null @@ -1,300 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiOrganizationSettingInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'TIMEZONE': "TIMEZONE", - 'ACTIVE_THEME': "ACTIVE_THEME", - 'ACTIVE_COLOR_PALETTE': "ACTIVE_COLOR_PALETTE", - 'ACTIVE_LLM_ENDPOINT': "ACTIVE_LLM_ENDPOINT", - 'WHITE_LABELING': "WHITE_LABELING", - 'LOCALE': "LOCALE", - 'METADATA_LOCALE': "METADATA_LOCALE", - 'FORMAT_LOCALE': "FORMAT_LOCALE", - 'MAPBOX_TOKEN': "MAPBOX_TOKEN", - 'AG_GRID_TOKEN': "AG_GRID_TOKEN", - 'WEEK_START': "WEEK_START", - 'SHOW_HIDDEN_CATALOG_ITEMS': "SHOW_HIDDEN_CATALOG_ITEMS", - 'OPERATOR_OVERRIDES': "OPERATOR_OVERRIDES", - 'TIMEZONE_VALIDATION_ENABLED': "TIMEZONE_VALIDATION_ENABLED", - 'OPENAI_CONFIG': "OPENAI_CONFIG", - 'ENABLE_FILE_ANALYTICS': "ENABLE_FILE_ANALYTICS", - 'ALERT': "ALERT", - 'SEPARATORS': "SEPARATORS", - 'DATE_FILTER_CONFIG': "DATE_FILTER_CONFIG", - 'JIT_PROVISIONING': "JIT_PROVISIONING", - 'JWT_JIT_PROVISIONING': "JWT_JIT_PROVISIONING", - 'DASHBOARD_FILTERS_APPLY_MODE': "DASHBOARD_FILTERS_APPLY_MODE", - 'ENABLE_SLIDES_EXPORT': "ENABLE_SLIDES_EXPORT", - 'AI_RATE_LIMIT': "AI_RATE_LIMIT", - 'ATTACHMENT_SIZE_LIMIT': "ATTACHMENT_SIZE_LIMIT", - 'ATTACHMENT_LINK_TTL': "ATTACHMENT_LINK_TTL", - 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE': "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS': "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - 'ENABLE_AUTOMATION_EVALUATION_MODE': "ENABLE_AUTOMATION_EVALUATION_MODE", - 'REGISTERED_PLUGGABLE_APPLICATIONS': "REGISTERED_PLUGGABLE_APPLICATIONS", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - type (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - type (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_document.py deleted file mode 100644 index 140f75cca..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in import JsonApiOrganizationSettingIn - globals()['JsonApiOrganizationSettingIn'] = JsonApiOrganizationSettingIn - - -class JsonApiOrganizationSettingInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiOrganizationSettingIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingInDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationSettingIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingInDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationSettingIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_document.pyi index 1bfc332ac..00ad1036d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiOrganizationSettingInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiOrganizationSettingIn']: return JsonApiOrganizationSettingIn __annotations__ = { "data": data, } - + data: 'JsonApiOrganizationSettingIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiOrganizationSettingIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiOrganizationSettingIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiOrganizationSettingInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_organization_setting_in import JsonApiOrganizationSettingIn +from gooddata_api_client.models.json_api_organization_setting_in import JsonApiOrganizationSettingIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out.py deleted file mode 100644 index 31a427fbe..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - - -class JsonApiOrganizationSettingOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ORGANIZATIONSETTING': "organizationSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organizationSetting", must be one of ["organizationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organizationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organizationSetting", must be one of ["organizationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organizationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_document.py deleted file mode 100644 index 109aec745..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_out import JsonApiOrganizationSettingOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiOrganizationSettingOut'] = JsonApiOrganizationSettingOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiOrganizationSettingOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiOrganizationSettingOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationSettingOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationSettingOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_document.pyi index 1e3478049..01f7ae748 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiOrganizationSettingOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiOrganizationSettingOut']: return JsonApiOrganizationSettingOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiOrganizationSettingOutDocument( "data": data, "links": links, } - + data: 'JsonApiOrganizationSettingOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiOrganizationSettingOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiOrganizationSettingOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiOrganizationSettingOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_organization_setting_out import JsonApiOrganizationSettingOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_organization_setting_out import JsonApiOrganizationSettingOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_list.py deleted file mode 100644 index 339eca486..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_organization_setting_out_with_links import JsonApiOrganizationSettingOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiOrganizationSettingOutWithLinks'] = JsonApiOrganizationSettingOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiOrganizationSettingOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiOrganizationSettingOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingOutList - a model defined in OpenAPI - - Args: - data ([JsonApiOrganizationSettingOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingOutList - a model defined in OpenAPI - - Args: - data ([JsonApiOrganizationSettingOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_list.pyi index dbc1c5e0c..4f73877d3 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiOrganizationSettingOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiOrganizationSettingOutWithLinks']: return JsonApiOrganizationSettingOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiOrganizationSettingOutWithLinks'], typing.List['JsonApiOrganizationSettingOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiOrganizationSettingOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiOrganizationSettingOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiOrganizationSettingOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiOrganizationSettingOutList( **kwargs, ) -from gooddata_api_client.model.json_api_organization_setting_out_with_links import JsonApiOrganizationSettingOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_organization_setting_out_with_links import JsonApiOrganizationSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_with_links.py deleted file mode 100644 index acd24ffad..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - from gooddata_api_client.model.json_api_organization_setting_out import JsonApiOrganizationSettingOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingOut'] = JsonApiOrganizationSettingOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiOrganizationSettingOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ORGANIZATIONSETTING': "organizationSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "organizationSetting", must be one of ["organizationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organizationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "organizationSetting", must be one of ["organizationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organizationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiOrganizationSettingOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_with_links.pyi index 3829de7d4..06c8656c9 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiOrganizationSettingOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiOrganizationSettingOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_organization_setting_out import JsonApiOrganizationSettingOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_organization_setting_out import JsonApiOrganizationSettingOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_patch.py deleted file mode 100644 index a3d6ddfe5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_patch.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - - -class JsonApiOrganizationSettingPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'ORGANIZATIONSETTING': "organizationSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organizationSetting", must be one of ["organizationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organizationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "organizationSetting", must be one of ["organizationSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "organizationSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_patch_document.py deleted file mode 100644 index cccc26f50..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_patch import JsonApiOrganizationSettingPatch - globals()['JsonApiOrganizationSettingPatch'] = JsonApiOrganizationSettingPatch - - -class JsonApiOrganizationSettingPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiOrganizationSettingPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationSettingPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiOrganizationSettingPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiOrganizationSettingPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_patch_document.pyi index 79d9e9e3a..c7660d25c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiOrganizationSettingPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiOrganizationSettingPatch']: return JsonApiOrganizationSettingPatch __annotations__ = { "data": data, } - + data: 'JsonApiOrganizationSettingPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiOrganizationSettingPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiOrganizationSettingPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiOrganizationSettingPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_organization_setting_patch import JsonApiOrganizationSettingPatch +from gooddata_api_client.models.json_api_organization_setting_patch import JsonApiOrganizationSettingPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_theme_in.py deleted file mode 100644 index 695f8c45a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_in.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes - globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes - - -class JsonApiThemeIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'THEME': "theme", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiThemeIn - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "theme", must be one of ["theme", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "theme") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiThemeIn - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "theme", must be one of ["theme", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "theme") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_theme_in_document.py deleted file mode 100644 index 2ced6112a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_theme_in import JsonApiThemeIn - globals()['JsonApiThemeIn'] = JsonApiThemeIn - - -class JsonApiThemeInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiThemeIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiThemeInDocument - a model defined in OpenAPI - - Args: - data (JsonApiThemeIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiThemeInDocument - a model defined in OpenAPI - - Args: - data (JsonApiThemeIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_theme_in_document.pyi index b101620d0..c0cf433ef 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_theme_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiThemeInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiThemeIn']: return JsonApiThemeIn __annotations__ = { "data": data, } - + data: 'JsonApiThemeIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiThemeIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiThemeIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiThemeInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_theme_in import JsonApiThemeIn +from gooddata_api_client.models.json_api_theme_in import JsonApiThemeIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out.py deleted file mode 100644 index 8f8d2565e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes - globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes - - -class JsonApiThemeOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'THEME': "theme", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiThemeOut - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "theme", must be one of ["theme", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "theme") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiThemeOut - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "theme", must be one of ["theme", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "theme") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_document.py deleted file mode 100644 index b61d619c6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_theme_out import JsonApiThemeOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiThemeOut'] = JsonApiThemeOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiThemeOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiThemeOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiThemeOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiThemeOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiThemeOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiThemeOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_document.pyi index 0d05d0127..152814229 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiThemeOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiThemeOut']: return JsonApiThemeOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiThemeOutDocument( "data": data, "links": links, } - + data: 'JsonApiThemeOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiThemeOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiThemeOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiThemeOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_theme_out import JsonApiThemeOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_theme_out import JsonApiThemeOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_list.py deleted file mode 100644 index 074d6a354..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_theme_out_with_links import JsonApiThemeOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiThemeOutWithLinks'] = JsonApiThemeOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiThemeOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiThemeOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiThemeOutList - a model defined in OpenAPI - - Args: - data ([JsonApiThemeOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiThemeOutList - a model defined in OpenAPI - - Args: - data ([JsonApiThemeOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_list.pyi index 8a8547d3e..9ed74bf37 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiThemeOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiThemeOutWithLinks']: return JsonApiThemeOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiThemeOutWithLinks'], typing.List['JsonApiThemeOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiThemeOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiThemeOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiThemeOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiThemeOutList( **kwargs, ) -from gooddata_api_client.model.json_api_theme_out_with_links import JsonApiThemeOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_theme_out_with_links import JsonApiThemeOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_with_links.py deleted file mode 100644 index 6a42205c4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes - from gooddata_api_client.model.json_api_theme_out import JsonApiThemeOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes - globals()['JsonApiThemeOut'] = JsonApiThemeOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiThemeOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'THEME': "theme", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiThemeOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "theme", must be one of ["theme", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "theme") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiThemeOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiColorPaletteInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "theme", must be one of ["theme", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "theme") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiThemeOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_with_links.pyi index 6a966678c..57dbcd7d2 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiThemeOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiThemeOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_theme_out import JsonApiThemeOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_theme_out import JsonApiThemeOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_theme_patch.py deleted file mode 100644 index 36a2fd9e5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_patch.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_color_palette_patch_attributes import JsonApiColorPalettePatchAttributes - globals()['JsonApiColorPalettePatchAttributes'] = JsonApiColorPalettePatchAttributes - - -class JsonApiThemePatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'THEME': "theme", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiColorPalettePatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiThemePatch - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPalettePatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "theme", must be one of ["theme", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "theme") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiThemePatch - a model defined in OpenAPI - - Args: - attributes (JsonApiColorPalettePatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "theme", must be one of ["theme", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "theme") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_theme_patch_document.py deleted file mode 100644 index 5e8326993..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_theme_patch import JsonApiThemePatch - globals()['JsonApiThemePatch'] = JsonApiThemePatch - - -class JsonApiThemePatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiThemePatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiThemePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiThemePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiThemePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiThemePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_theme_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_theme_patch_document.pyi index ae3d39b16..6464ea364 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_theme_patch_document.pyi @@ -86,4 +86,4 @@ class JsonApiThemePatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_theme_patch import JsonApiThemePatch +from gooddata_api_client.models.json_api_theme_patch import JsonApiThemePatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in.py deleted file mode 100644 index a8138770f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes - from gooddata_api_client.model.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships - globals()['JsonApiUserDataFilterInAttributes'] = JsonApiUserDataFilterInAttributes - globals()['JsonApiUserDataFilterInRelationships'] = JsonApiUserDataFilterInRelationships - - -class JsonApiUserDataFilterIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERDATAFILTER': "userDataFilter", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiUserDataFilterInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'relationships': (JsonApiUserDataFilterInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterIn - a model defined in OpenAPI - - Args: - attributes (JsonApiUserDataFilterInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userDataFilter", must be one of ["userDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiUserDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterIn - a model defined in OpenAPI - - Args: - attributes (JsonApiUserDataFilterInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userDataFilter", must be one of ["userDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiUserDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in.pyi index 5b75a4cf3..b05994537 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in.pyi @@ -42,44 +42,44 @@ class JsonApiUserDataFilterIn( "id", "type", } - + class properties: - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: required = { "maql", } - + class properties: areRelationsValid = schemas.BoolSchema - - + + class description( schemas.StrSchema ): pass - - + + class maql( schemas.StrSchema ): pass - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -90,11 +90,11 @@ class JsonApiUserDataFilterIn( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): @@ -106,54 +106,54 @@ class JsonApiUserDataFilterIn( "tags": tags, "title": title, } - + maql: MetaOapg.properties.maql - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "maql", "tags", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "maql", "tags", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -176,76 +176,76 @@ class JsonApiUserDataFilterIn( _configuration=_configuration, **kwargs, ) - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_DATA_FILTER(cls): return cls("userDataFilter") - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class user( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserToOneLinkage']: return JsonApiUserToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -260,50 +260,50 @@ class JsonApiUserDataFilterIn( _configuration=_configuration, **kwargs, ) - - + + class userGroup( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupToOneLinkage']: return JsonApiUserGroupToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -322,34 +322,34 @@ class JsonApiUserDataFilterIn( "user": user, "userGroup": userGroup, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["user"]) -> MetaOapg.properties.user: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroup"]) -> MetaOapg.properties.userGroup: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["user", "userGroup", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["user"]) -> typing.Union[MetaOapg.properties.user, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroup"]) -> typing.Union[MetaOapg.properties.userGroup, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["user", "userGroup", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -372,49 +372,49 @@ class JsonApiUserDataFilterIn( "type": type, "relationships": relationships, } - + attributes: MetaOapg.properties.attributes id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -437,5 +437,5 @@ class JsonApiUserDataFilterIn( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage -from gooddata_api_client.model.json_api_user_to_one_linkage import JsonApiUserToOneLinkage +from gooddata_api_client.models.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage +from gooddata_api_client.models.json_api_user_to_one_linkage import JsonApiUserToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_attributes.py deleted file mode 100644 index 611fc9d3c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_attributes.py +++ /dev/null @@ -1,295 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiUserDataFilterInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('maql',): { - 'max_length': 10000, - }, - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'maql': (str,), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'maql': 'maql', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'description': 'description', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, maql, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterInAttributes - a model defined in OpenAPI - - Args: - maql (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.maql = maql - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, maql, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterInAttributes - a model defined in OpenAPI - - Args: - maql (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.maql = maql - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_document.py deleted file mode 100644 index 8fc788db8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_data_filter_in import JsonApiUserDataFilterIn - globals()['JsonApiUserDataFilterIn'] = JsonApiUserDataFilterIn - - -class JsonApiUserDataFilterInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserDataFilterIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterInDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserDataFilterIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterInDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserDataFilterIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_document.pyi index 5490b28d1..86727f5d3 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiUserDataFilterInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserDataFilterIn']: return JsonApiUserDataFilterIn __annotations__ = { "data": data, } - + data: 'JsonApiUserDataFilterIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserDataFilterIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserDataFilterIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiUserDataFilterInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_data_filter_in import JsonApiUserDataFilterIn +from gooddata_api_client.models.json_api_user_data_filter_in import JsonApiUserDataFilterIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_relationships.py deleted file mode 100644 index 69d42b85f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_in_relationships.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser - from gooddata_api_client.model.json_api_organization_out_relationships_bootstrap_user_group import JsonApiOrganizationOutRelationshipsBootstrapUserGroup - globals()['JsonApiFilterViewInRelationshipsUser'] = JsonApiFilterViewInRelationshipsUser - globals()['JsonApiOrganizationOutRelationshipsBootstrapUserGroup'] = JsonApiOrganizationOutRelationshipsBootstrapUserGroup - - -class JsonApiUserDataFilterInRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'user': (JsonApiFilterViewInRelationshipsUser,), # noqa: E501 - 'user_group': (JsonApiOrganizationOutRelationshipsBootstrapUserGroup,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'user': 'user', # noqa: E501 - 'user_group': 'userGroup', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - user (JsonApiFilterViewInRelationshipsUser): [optional] # noqa: E501 - user_group (JsonApiOrganizationOutRelationshipsBootstrapUserGroup): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - user (JsonApiFilterViewInRelationshipsUser): [optional] # noqa: E501 - user_group (JsonApiOrganizationOutRelationshipsBootstrapUserGroup): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out.py deleted file mode 100644 index 5db83abe2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out.py +++ /dev/null @@ -1,310 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes - from gooddata_api_client.model.json_api_user_data_filter_out_relationships import JsonApiUserDataFilterOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiUserDataFilterInAttributes'] = JsonApiUserDataFilterInAttributes - globals()['JsonApiUserDataFilterOutRelationships'] = JsonApiUserDataFilterOutRelationships - - -class JsonApiUserDataFilterOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERDATAFILTER': "userDataFilter", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiUserDataFilterInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiUserDataFilterOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOut - a model defined in OpenAPI - - Args: - attributes (JsonApiUserDataFilterInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userDataFilter", must be one of ["userDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiUserDataFilterOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOut - a model defined in OpenAPI - - Args: - attributes (JsonApiUserDataFilterInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userDataFilter", must be one of ["userDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiUserDataFilterOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out.pyi index e151e743d..7d21fcb7b 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out.pyi @@ -42,44 +42,44 @@ class JsonApiUserDataFilterOut( "id", "type", } - + class properties: - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: required = { "maql", } - + class properties: areRelationsValid = schemas.BoolSchema - - + + class description( schemas.StrSchema ): pass - - + + class maql( schemas.StrSchema ): pass - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -90,11 +90,11 @@ class JsonApiUserDataFilterOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): @@ -106,54 +106,54 @@ class JsonApiUserDataFilterOut( "tags": tags, "title": title, } - + maql: MetaOapg.properties.maql - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "maql", "tags", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "maql", "tags", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -176,58 +176,58 @@ class JsonApiUserDataFilterOut( _configuration=_configuration, **kwargs, ) - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_DATA_FILTER(cls): return cls("userDataFilter") - - + + class meta( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class origin( schemas.DictSchema ): - - + + class MetaOapg: required = { "originType", "originId", } - + class properties: originId = schemas.StrSchema - - + + class originType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") - + @schemas.classproperty def PARENT(cls): return cls("PARENT") @@ -235,37 +235,37 @@ class JsonApiUserDataFilterOut( "originId": originId, "originType": originType, } - + originType: MetaOapg.properties.originType originId: MetaOapg.properties.originId - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -285,28 +285,28 @@ class JsonApiUserDataFilterOut( __annotations__ = { "origin": origin, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -321,60 +321,60 @@ class JsonApiUserDataFilterOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiAttributeToManyLinkage']: return JsonApiAttributeToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiAttributeToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -389,50 +389,50 @@ class JsonApiUserDataFilterOut( _configuration=_configuration, **kwargs, ) - - + + class datasets( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDatasetToManyLinkage']: return JsonApiDatasetToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiDatasetToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -447,50 +447,50 @@ class JsonApiUserDataFilterOut( _configuration=_configuration, **kwargs, ) - - + + class facts( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiFactToManyLinkage']: return JsonApiFactToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiFactToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -505,50 +505,50 @@ class JsonApiUserDataFilterOut( _configuration=_configuration, **kwargs, ) - - + + class labels( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiLabelToManyLinkage']: return JsonApiLabelToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiLabelToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -563,50 +563,50 @@ class JsonApiUserDataFilterOut( _configuration=_configuration, **kwargs, ) - - + + class metrics( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiMetricToManyLinkage']: return JsonApiMetricToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiMetricToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -621,50 +621,50 @@ class JsonApiUserDataFilterOut( _configuration=_configuration, **kwargs, ) - - + + class user( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserToOneLinkage']: return JsonApiUserToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -679,50 +679,50 @@ class JsonApiUserDataFilterOut( _configuration=_configuration, **kwargs, ) - - + + class userGroup( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupToOneLinkage']: return JsonApiUserGroupToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -746,64 +746,64 @@ class JsonApiUserDataFilterOut( "user": user, "userGroup": userGroup, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["datasets"]) -> MetaOapg.properties.datasets: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["facts"]) -> MetaOapg.properties.facts: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["labels"]) -> MetaOapg.properties.labels: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["user"]) -> MetaOapg.properties.user: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroup"]) -> MetaOapg.properties.userGroup: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "datasets", "facts", "labels", "metrics", "user", "userGroup", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["datasets"]) -> typing.Union[MetaOapg.properties.datasets, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["facts"]) -> typing.Union[MetaOapg.properties.facts, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["labels"]) -> typing.Union[MetaOapg.properties.labels, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["user"]) -> typing.Union[MetaOapg.properties.user, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroup"]) -> typing.Union[MetaOapg.properties.userGroup, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "datasets", "facts", "labels", "metrics", "user", "userGroup", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -837,55 +837,55 @@ class JsonApiUserDataFilterOut( "meta": meta, "relationships": relationships, } - + attributes: MetaOapg.properties.attributes id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "meta", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "meta", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -910,10 +910,10 @@ class JsonApiUserDataFilterOut( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage -from gooddata_api_client.model.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage -from gooddata_api_client.model.json_api_fact_to_many_linkage import JsonApiFactToManyLinkage -from gooddata_api_client.model.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage -from gooddata_api_client.model.json_api_metric_to_many_linkage import JsonApiMetricToManyLinkage -from gooddata_api_client.model.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage -from gooddata_api_client.model.json_api_user_to_one_linkage import JsonApiUserToOneLinkage +from gooddata_api_client.models.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage +from gooddata_api_client.models.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage +from gooddata_api_client.models.json_api_fact_to_many_linkage import JsonApiFactToManyLinkage +from gooddata_api_client.models.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage +from gooddata_api_client.models.json_api_metric_to_many_linkage import JsonApiMetricToManyLinkage +from gooddata_api_client.models.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage +from gooddata_api_client.models.json_api_user_to_one_linkage import JsonApiUserToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_document.py deleted file mode 100644 index 124c9b58b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_data_filter_out import JsonApiUserDataFilterOut - from gooddata_api_client.model.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiUserDataFilterOut'] = JsonApiUserDataFilterOut - globals()['JsonApiUserDataFilterOutIncludes'] = JsonApiUserDataFilterOutIncludes - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiUserDataFilterOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserDataFilterOut,), # noqa: E501 - 'included': ([JsonApiUserDataFilterOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserDataFilterOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserDataFilterOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserDataFilterOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserDataFilterOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_document.pyi index 7ed16a7e0..42e6433fd 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiUserDataFilterOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserDataFilterOut']: return JsonApiUserDataFilterOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiUserDataFilterOutIncludes']: return JsonApiUserDataFilterOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiUserDataFilterOutIncludes'], typing.List['JsonApiUserDataFilterOutIncludes']], @@ -67,10 +67,10 @@ class JsonApiUserDataFilterOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiUserDataFilterOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiUserDataFilterOutDocument( "included": included, "links": links, } - + data: 'JsonApiUserDataFilterOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserDataFilterOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserDataFilterOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiUserDataFilterOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_data_filter_out import JsonApiUserDataFilterOut -from gooddata_api_client.model.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_user_data_filter_out import JsonApiUserDataFilterOut +from gooddata_api_client.models.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_includes.py deleted file mode 100644 index 6bd0cbfde..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_includes.py +++ /dev/null @@ -1,374 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks - from gooddata_api_client.model.json_api_dataset_out_attributes import JsonApiDatasetOutAttributes - from gooddata_api_client.model.json_api_dataset_out_relationships import JsonApiDatasetOutRelationships - from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks - from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks - from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks - from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks - from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks - from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks - globals()['JsonApiDatasetOutAttributes'] = JsonApiDatasetOutAttributes - globals()['JsonApiDatasetOutRelationships'] = JsonApiDatasetOutRelationships - globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks - globals()['JsonApiFactOutWithLinks'] = JsonApiFactOutWithLinks - globals()['JsonApiLabelOutWithLinks'] = JsonApiLabelOutWithLinks - globals()['JsonApiMetricOutWithLinks'] = JsonApiMetricOutWithLinks - globals()['JsonApiUserGroupOutWithLinks'] = JsonApiUserGroupOutWithLinks - globals()['JsonApiUserOutWithLinks'] = JsonApiUserOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiUserDataFilterOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASET': "dataset", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'relationships': (JsonApiDatasetOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'attributes': (JsonApiDatasetOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiDatasetOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - attributes (JsonApiDatasetOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "dataset" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiDatasetOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - attributes (JsonApiDatasetOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "dataset" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAttributeOutWithLinks, - JsonApiDatasetOutWithLinks, - JsonApiFactOutWithLinks, - JsonApiLabelOutWithLinks, - JsonApiMetricOutWithLinks, - JsonApiUserGroupOutWithLinks, - JsonApiUserOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_includes.pyi index 78dfa185b..2752f67c5 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_includes.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_includes.pyi @@ -35,7 +35,7 @@ class JsonApiUserDataFilterOutIncludes( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -70,10 +70,10 @@ class JsonApiUserDataFilterOutIncludes( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks -from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks -from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks -from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks -from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks -from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks -from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.json_api_metric_out_with_links import JsonApiMetricOutWithLinks +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_list.py deleted file mode 100644 index 38fa9b790..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes - from gooddata_api_client.model.json_api_user_data_filter_out_with_links import JsonApiUserDataFilterOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiUserDataFilterOutIncludes'] = JsonApiUserDataFilterOutIncludes - globals()['JsonApiUserDataFilterOutWithLinks'] = JsonApiUserDataFilterOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiUserDataFilterOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiUserDataFilterOutWithLinks],), # noqa: E501 - 'included': ([JsonApiUserDataFilterOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOutList - a model defined in OpenAPI - - Args: - data ([JsonApiUserDataFilterOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserDataFilterOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOutList - a model defined in OpenAPI - - Args: - data ([JsonApiUserDataFilterOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserDataFilterOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_list.pyi index 86a40ecb9..37b9e5d79 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiUserDataFilterOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiUserDataFilterOutWithLinks']: return JsonApiUserDataFilterOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiUserDataFilterOutWithLinks'], typing.List['JsonApiUserDataFilterOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiUserDataFilterOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiUserDataFilterOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiUserDataFilterOutIncludes']: return JsonApiUserDataFilterOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiUserDataFilterOutIncludes'], typing.List['JsonApiUserDataFilterOutIncludes']], @@ -91,10 +91,10 @@ class JsonApiUserDataFilterOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiUserDataFilterOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiUserDataFilterOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,6 +158,6 @@ class JsonApiUserDataFilterOutList( **kwargs, ) -from gooddata_api_client.model.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes -from gooddata_api_client.model.json_api_user_data_filter_out_with_links import JsonApiUserDataFilterOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes +from gooddata_api_client.models.json_api_user_data_filter_out_with_links import JsonApiUserDataFilterOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_relationships.py deleted file mode 100644 index 990a13736..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_relationships.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics - from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes - from gooddata_api_client.model.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts - from gooddata_api_client.model.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser - from gooddata_api_client.model.json_api_organization_out_relationships_bootstrap_user_group import JsonApiOrganizationOutRelationshipsBootstrapUserGroup - globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets - globals()['JsonApiAnalyticalDashboardOutRelationshipsLabels'] = JsonApiAnalyticalDashboardOutRelationshipsLabels - globals()['JsonApiAnalyticalDashboardOutRelationshipsMetrics'] = JsonApiAnalyticalDashboardOutRelationshipsMetrics - globals()['JsonApiAttributeHierarchyOutRelationshipsAttributes'] = JsonApiAttributeHierarchyOutRelationshipsAttributes - globals()['JsonApiDatasetOutRelationshipsFacts'] = JsonApiDatasetOutRelationshipsFacts - globals()['JsonApiFilterViewInRelationshipsUser'] = JsonApiFilterViewInRelationshipsUser - globals()['JsonApiOrganizationOutRelationshipsBootstrapUserGroup'] = JsonApiOrganizationOutRelationshipsBootstrapUserGroup - - -class JsonApiUserDataFilterOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 - 'datasets': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 - 'facts': (JsonApiDatasetOutRelationshipsFacts,), # noqa: E501 - 'labels': (JsonApiAnalyticalDashboardOutRelationshipsLabels,), # noqa: E501 - 'metrics': (JsonApiAnalyticalDashboardOutRelationshipsMetrics,), # noqa: E501 - 'user': (JsonApiFilterViewInRelationshipsUser,), # noqa: E501 - 'user_group': (JsonApiOrganizationOutRelationshipsBootstrapUserGroup,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'datasets': 'datasets', # noqa: E501 - 'facts': 'facts', # noqa: E501 - 'labels': 'labels', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'user': 'user', # noqa: E501 - 'user_group': 'userGroup', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 - labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 - metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 - user (JsonApiFilterViewInRelationshipsUser): [optional] # noqa: E501 - user_group (JsonApiOrganizationOutRelationshipsBootstrapUserGroup): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 - labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 - metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 - user (JsonApiFilterViewInRelationshipsUser): [optional] # noqa: E501 - user_group (JsonApiOrganizationOutRelationshipsBootstrapUserGroup): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_with_links.py deleted file mode 100644 index 4d918d3b4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes - from gooddata_api_client.model.json_api_user_data_filter_out import JsonApiUserDataFilterOut - from gooddata_api_client.model.json_api_user_data_filter_out_relationships import JsonApiUserDataFilterOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiUserDataFilterInAttributes'] = JsonApiUserDataFilterInAttributes - globals()['JsonApiUserDataFilterOut'] = JsonApiUserDataFilterOut - globals()['JsonApiUserDataFilterOutRelationships'] = JsonApiUserDataFilterOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiUserDataFilterOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERDATAFILTER': "userDataFilter", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiUserDataFilterInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiUserDataFilterOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiUserDataFilterInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "userDataFilter", must be one of ["userDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiUserDataFilterOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiUserDataFilterInAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "userDataFilter", must be one of ["userDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiUserDataFilterOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiUserDataFilterOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_with_links.pyi index b788f5e24..183ba4be9 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiUserDataFilterOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiUserDataFilterOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_user_data_filter_out import JsonApiUserDataFilterOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_user_data_filter_out import JsonApiUserDataFilterOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch.py deleted file mode 100644 index 17eda7d48..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships - from gooddata_api_client.model.json_api_user_data_filter_patch_attributes import JsonApiUserDataFilterPatchAttributes - globals()['JsonApiUserDataFilterInRelationships'] = JsonApiUserDataFilterInRelationships - globals()['JsonApiUserDataFilterPatchAttributes'] = JsonApiUserDataFilterPatchAttributes - - -class JsonApiUserDataFilterPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERDATAFILTER': "userDataFilter", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiUserDataFilterPatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'relationships': (JsonApiUserDataFilterInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiUserDataFilterPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userDataFilter", must be one of ["userDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiUserDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiUserDataFilterPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userDataFilter", must be one of ["userDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - relationships (JsonApiUserDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch.pyi index 9102b715d..ae85316af 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch.pyi @@ -42,41 +42,41 @@ class JsonApiUserDataFilterPatch( "id", "type", } - + class properties: - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: areRelationsValid = schemas.BoolSchema - - + + class description( schemas.StrSchema ): pass - - + + class maql( schemas.StrSchema ): pass - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -87,11 +87,11 @@ class JsonApiUserDataFilterPatch( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): @@ -103,52 +103,52 @@ class JsonApiUserDataFilterPatch( "tags": tags, "title": title, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "maql", "tags", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["maql"]) -> typing.Union[MetaOapg.properties.maql, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "maql", "tags", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -171,76 +171,76 @@ class JsonApiUserDataFilterPatch( _configuration=_configuration, **kwargs, ) - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_DATA_FILTER(cls): return cls("userDataFilter") - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class user( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserToOneLinkage']: return JsonApiUserToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -255,50 +255,50 @@ class JsonApiUserDataFilterPatch( _configuration=_configuration, **kwargs, ) - - + + class userGroup( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupToOneLinkage']: return JsonApiUserGroupToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -317,34 +317,34 @@ class JsonApiUserDataFilterPatch( "user": user, "userGroup": userGroup, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["user"]) -> MetaOapg.properties.user: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroup"]) -> MetaOapg.properties.userGroup: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["user", "userGroup", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["user"]) -> typing.Union[MetaOapg.properties.user, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroup"]) -> typing.Union[MetaOapg.properties.userGroup, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["user", "userGroup", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -367,49 +367,49 @@ class JsonApiUserDataFilterPatch( "type": type, "relationships": relationships, } - + attributes: MetaOapg.properties.attributes id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -432,5 +432,5 @@ class JsonApiUserDataFilterPatch( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage -from gooddata_api_client.model.json_api_user_to_one_linkage import JsonApiUserToOneLinkage +from gooddata_api_client.models.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage +from gooddata_api_client.models.json_api_user_to_one_linkage import JsonApiUserToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch_attributes.py deleted file mode 100644 index bd3c18bc9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch_attributes.py +++ /dev/null @@ -1,289 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiUserDataFilterPatchAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('maql',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'maql': (str,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'description': 'description', # noqa: E501 - 'maql': 'maql', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - maql (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - maql (str): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch_document.py deleted file mode 100644 index 6dc376ade..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_data_filter_patch import JsonApiUserDataFilterPatch - globals()['JsonApiUserDataFilterPatch'] = JsonApiUserDataFilterPatch - - -class JsonApiUserDataFilterPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserDataFilterPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserDataFilterPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserDataFilterPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch_document.pyi index 2de0522a2..4275d40a1 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiUserDataFilterPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserDataFilterPatch']: return JsonApiUserDataFilterPatch __annotations__ = { "data": data, } - + data: 'JsonApiUserDataFilterPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserDataFilterPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserDataFilterPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiUserDataFilterPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_data_filter_patch import JsonApiUserDataFilterPatch +from gooddata_api_client.models.json_api_user_data_filter_patch import JsonApiUserDataFilterPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id.py deleted file mode 100644 index 3286c4565..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes - from gooddata_api_client.model.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships - globals()['JsonApiUserDataFilterInAttributes'] = JsonApiUserDataFilterInAttributes - globals()['JsonApiUserDataFilterInRelationships'] = JsonApiUserDataFilterInRelationships - - -class JsonApiUserDataFilterPostOptionalId(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERDATAFILTER': "userDataFilter", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiUserDataFilterInAttributes,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'relationships': (JsonApiUserDataFilterInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiUserDataFilterInAttributes): - - Keyword Args: - type (str): Object type. defaults to "userDataFilter", must be one of ["userDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - relationships (JsonApiUserDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiUserDataFilterInAttributes): - - Keyword Args: - type (str): Object type. defaults to "userDataFilter", must be one of ["userDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - relationships (JsonApiUserDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id.pyi index 25437f343..28f3026c3 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id.pyi @@ -41,44 +41,44 @@ class JsonApiUserDataFilterPostOptionalId( "attributes", "type", } - + class properties: - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: required = { "maql", } - + class properties: areRelationsValid = schemas.BoolSchema - - + + class description( schemas.StrSchema ): pass - - + + class maql( schemas.StrSchema ): pass - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -89,11 +89,11 @@ class JsonApiUserDataFilterPostOptionalId( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): @@ -105,54 +105,54 @@ class JsonApiUserDataFilterPostOptionalId( "tags": tags, "title": title, } - + maql: MetaOapg.properties.maql - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "maql", "tags", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "maql", "tags", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -175,76 +175,76 @@ class JsonApiUserDataFilterPostOptionalId( _configuration=_configuration, **kwargs, ) - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_DATA_FILTER(cls): return cls("userDataFilter") - - + + class id( schemas.StrSchema ): pass - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class user( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserToOneLinkage']: return JsonApiUserToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -259,50 +259,50 @@ class JsonApiUserDataFilterPostOptionalId( _configuration=_configuration, **kwargs, ) - - + + class userGroup( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupToOneLinkage']: return JsonApiUserGroupToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -321,34 +321,34 @@ class JsonApiUserDataFilterPostOptionalId( "user": user, "userGroup": userGroup, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["user"]) -> MetaOapg.properties.user: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroup"]) -> MetaOapg.properties.userGroup: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["user", "userGroup", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["user"]) -> typing.Union[MetaOapg.properties.user, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroup"]) -> typing.Union[MetaOapg.properties.userGroup, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["user", "userGroup", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -371,48 +371,48 @@ class JsonApiUserDataFilterPostOptionalId( "id": id, "relationships": relationships, } - + attributes: MetaOapg.properties.attributes type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "type", "id", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> typing.Union[MetaOapg.properties.id, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "type", "id", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -435,5 +435,5 @@ class JsonApiUserDataFilterPostOptionalId( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage -from gooddata_api_client.model.json_api_user_to_one_linkage import JsonApiUserToOneLinkage +from gooddata_api_client.models.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage +from gooddata_api_client.models.json_api_user_to_one_linkage import JsonApiUserToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id_document.py deleted file mode 100644 index ff169e162..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_data_filter_post_optional_id import JsonApiUserDataFilterPostOptionalId - globals()['JsonApiUserDataFilterPostOptionalId'] = JsonApiUserDataFilterPostOptionalId - - -class JsonApiUserDataFilterPostOptionalIdDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserDataFilterPostOptionalId,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserDataFilterPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserDataFilterPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserDataFilterPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id_document.pyi index 719afe3bd..9d604c6a8 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_post_optional_id_document.pyi @@ -38,38 +38,38 @@ class JsonApiUserDataFilterPostOptionalIdDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserDataFilterPostOptionalId']: return JsonApiUserDataFilterPostOptionalId __annotations__ = { "data": data, } - + data: 'JsonApiUserDataFilterPostOptionalId' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserDataFilterPostOptionalId': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserDataFilterPostOptionalId': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiUserDataFilterPostOptionalIdDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id import JsonApiUserDataFilterPostOptionalId +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id import JsonApiUserDataFilterPostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in.py deleted file mode 100644 index 60fff4957..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes - from gooddata_api_client.model.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships - globals()['JsonApiUserGroupInAttributes'] = JsonApiUserGroupInAttributes - globals()['JsonApiUserGroupInRelationships'] = JsonApiUserGroupInRelationships - - -class JsonApiUserGroupIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERGROUP': "userGroup", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiUserGroupInAttributes,), # noqa: E501 - 'relationships': (JsonApiUserGroupInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserGroupInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserGroupInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserGroupInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserGroupInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in.pyi index a3467fe6b..f12992d37 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in.pyi @@ -41,36 +41,36 @@ class JsonApiUserGroupIn( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class name( schemas.StrSchema ): @@ -78,28 +78,28 @@ class JsonApiUserGroupIn( __annotations__ = { "name": name, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["name", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["name", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -114,60 +114,60 @@ class JsonApiUserGroupIn( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class parents( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupToManyLinkage']: return JsonApiUserGroupToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -185,28 +185,28 @@ class JsonApiUserGroupIn( __annotations__ = { "parents": parents, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["parents"]) -> MetaOapg.properties.parents: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["parents", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["parents"]) -> typing.Union[MetaOapg.properties.parents, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["parents", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -227,48 +227,48 @@ class JsonApiUserGroupIn( "attributes": attributes, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -291,4 +291,4 @@ class JsonApiUserGroupIn( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage +from gooddata_api_client.models.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_attributes.py deleted file mode 100644 index 65081a729..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_attributes.py +++ /dev/null @@ -1,267 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiUserGroupInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('name',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_document.py deleted file mode 100644 index 7a6c0658b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_in import JsonApiUserGroupIn - globals()['JsonApiUserGroupIn'] = JsonApiUserGroupIn - - -class JsonApiUserGroupInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserGroupIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupInDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserGroupIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupInDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserGroupIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_document.pyi index ce7e78d5d..de7676570 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiUserGroupInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupIn']: return JsonApiUserGroupIn __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiUserGroupInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_in import JsonApiUserGroupIn +from gooddata_api_client.models.json_api_user_group_in import JsonApiUserGroupIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_relationships.py deleted file mode 100644 index 73f2e2f64..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_relationships.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_in_relationships_parents import JsonApiUserGroupInRelationshipsParents - globals()['JsonApiUserGroupInRelationshipsParents'] = JsonApiUserGroupInRelationshipsParents - - -class JsonApiUserGroupInRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'parents': (JsonApiUserGroupInRelationshipsParents,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'parents': 'parents', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - parents (JsonApiUserGroupInRelationshipsParents): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - parents (JsonApiUserGroupInRelationshipsParents): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_relationships_parents.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_relationships_parents.py deleted file mode 100644 index e9fb6e8c5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_in_relationships_parents.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage - globals()['JsonApiUserGroupToManyLinkage'] = JsonApiUserGroupToManyLinkage - - -class JsonApiUserGroupInRelationshipsParents(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserGroupToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupInRelationshipsParents - a model defined in OpenAPI - - Args: - data (JsonApiUserGroupToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupInRelationshipsParents - a model defined in OpenAPI - - Args: - data (JsonApiUserGroupToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_linkage.py deleted file mode 100644 index 3992d66f5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiUserGroupLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERGROUP': "userGroup", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out.py deleted file mode 100644 index fff4ac780..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes - from gooddata_api_client.model.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships - globals()['JsonApiUserGroupInAttributes'] = JsonApiUserGroupInAttributes - globals()['JsonApiUserGroupInRelationships'] = JsonApiUserGroupInRelationships - - -class JsonApiUserGroupOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERGROUP': "userGroup", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiUserGroupInAttributes,), # noqa: E501 - 'relationships': (JsonApiUserGroupInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserGroupInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserGroupInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserGroupInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserGroupInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out.pyi index 4f41c22f5..81b76a52e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out.pyi @@ -41,36 +41,36 @@ class JsonApiUserGroupOut( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class name( schemas.StrSchema ): @@ -78,28 +78,28 @@ class JsonApiUserGroupOut( __annotations__ = { "name": name, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["name", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["name", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -114,60 +114,60 @@ class JsonApiUserGroupOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class parents( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupToManyLinkage']: return JsonApiUserGroupToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -185,28 +185,28 @@ class JsonApiUserGroupOut( __annotations__ = { "parents": parents, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["parents"]) -> MetaOapg.properties.parents: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["parents", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["parents"]) -> typing.Union[MetaOapg.properties.parents, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["parents", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -227,48 +227,48 @@ class JsonApiUserGroupOut( "attributes": attributes, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -291,4 +291,4 @@ class JsonApiUserGroupOut( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage +from gooddata_api_client.models.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_document.py deleted file mode 100644 index 9569323ba..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_out import JsonApiUserGroupOut - from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiUserGroupOut'] = JsonApiUserGroupOut - globals()['JsonApiUserGroupOutWithLinks'] = JsonApiUserGroupOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiUserGroupOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserGroupOut,), # noqa: E501 - 'included': ([JsonApiUserGroupOutWithLinks],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserGroupOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserGroupOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_document.pyi index 22f95ed6c..3a1fcb68c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiUserGroupOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupOut']: return JsonApiUserGroupOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiUserGroupOutWithLinks']: return JsonApiUserGroupOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiUserGroupOutWithLinks'], typing.List['JsonApiUserGroupOutWithLinks']], @@ -67,10 +67,10 @@ class JsonApiUserGroupOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiUserGroupOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiUserGroupOutDocument( "included": included, "links": links, } - + data: 'JsonApiUserGroupOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiUserGroupOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_out import JsonApiUserGroupOut -from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_user_group_out import JsonApiUserGroupOut +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_list.py deleted file mode 100644 index d4de57b58..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_list.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiUserGroupOutWithLinks'] = JsonApiUserGroupOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiUserGroupOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiUserGroupOutWithLinks],), # noqa: E501 - 'included': ([JsonApiUserGroupOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupOutList - a model defined in OpenAPI - - Args: - data ([JsonApiUserGroupOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupOutList - a model defined in OpenAPI - - Args: - data ([JsonApiUserGroupOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_list.pyi index 298ab1015..2f5b5cefb 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_list.pyi @@ -158,5 +158,5 @@ class JsonApiUserGroupOutList( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_with_links.py deleted file mode 100644 index 1542e38d4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_with_links.py +++ /dev/null @@ -1,355 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes - from gooddata_api_client.model.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships - from gooddata_api_client.model.json_api_user_group_out import JsonApiUserGroupOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiUserGroupInAttributes'] = JsonApiUserGroupInAttributes - globals()['JsonApiUserGroupInRelationships'] = JsonApiUserGroupInRelationships - globals()['JsonApiUserGroupOut'] = JsonApiUserGroupOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiUserGroupOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERGROUP': "userGroup", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiUserGroupInAttributes,), # noqa: E501 - 'relationships': (JsonApiUserGroupInRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserGroupInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserGroupInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserGroupInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserGroupInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiUserGroupOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_with_links.pyi index 4eb88b26b..408d2a03c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiUserGroupOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiUserGroupOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_out import JsonApiUserGroupOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_user_group_out import JsonApiUserGroupOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch.py deleted file mode 100644 index 21e49e787..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes - from gooddata_api_client.model.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships - globals()['JsonApiUserGroupInAttributes'] = JsonApiUserGroupInAttributes - globals()['JsonApiUserGroupInRelationships'] = JsonApiUserGroupInRelationships - - -class JsonApiUserGroupPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERGROUP': "userGroup", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiUserGroupInAttributes,), # noqa: E501 - 'relationships': (JsonApiUserGroupInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserGroupInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserGroupInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userGroup", must be one of ["userGroup", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserGroupInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserGroupInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userGroup") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch.pyi index 53dd5c3ad..3d03b0080 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch.pyi @@ -41,36 +41,36 @@ class JsonApiUserGroupPatch( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class name( schemas.StrSchema ): @@ -78,28 +78,28 @@ class JsonApiUserGroupPatch( __annotations__ = { "name": name, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["name", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["name", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -114,60 +114,60 @@ class JsonApiUserGroupPatch( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class parents( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupToManyLinkage']: return JsonApiUserGroupToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -185,28 +185,28 @@ class JsonApiUserGroupPatch( __annotations__ = { "parents": parents, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["parents"]) -> MetaOapg.properties.parents: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["parents", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["parents"]) -> typing.Union[MetaOapg.properties.parents, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["parents", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -227,48 +227,48 @@ class JsonApiUserGroupPatch( "attributes": attributes, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -291,4 +291,4 @@ class JsonApiUserGroupPatch( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage +from gooddata_api_client.models.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch_document.py deleted file mode 100644 index e16f2e6f9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_patch import JsonApiUserGroupPatch - globals()['JsonApiUserGroupPatch'] = JsonApiUserGroupPatch - - -class JsonApiUserGroupPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserGroupPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserGroupPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserGroupPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch_document.pyi index 4e076ab93..d0a14d990 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiUserGroupPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupPatch']: return JsonApiUserGroupPatch __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiUserGroupPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_patch import JsonApiUserGroupPatch +from gooddata_api_client.models.json_api_user_group_patch import JsonApiUserGroupPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_many_linkage.py deleted file mode 100644 index e82b41825..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_linkage import JsonApiUserGroupLinkage - globals()['JsonApiUserGroupLinkage'] = JsonApiUserGroupLinkage - - -class JsonApiUserGroupToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiUserGroupLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiUserGroupToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiUserGroupLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiUserGroupLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiUserGroupToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiUserGroupLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiUserGroupLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_many_linkage.pyi index ff5e46765..e18940207 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_many_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_many_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiUserGroupToManyLinkage( class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiUserGroupLinkage']: return JsonApiUserGroupLinkage @@ -56,4 +56,4 @@ class JsonApiUserGroupToManyLinkage( def __getitem__(self, i: int) -> 'JsonApiUserGroupLinkage': return super().__getitem__(i) -from gooddata_api_client.model.json_api_user_group_linkage import JsonApiUserGroupLinkage +from gooddata_api_client.models.json_api_user_group_linkage import JsonApiUserGroupLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_one_linkage.py deleted file mode 100644 index 423629448..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_linkage import JsonApiUserGroupLinkage - globals()['JsonApiUserGroupLinkage'] = JsonApiUserGroupLinkage - - -class JsonApiUserGroupToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERGROUP': "userGroup", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "userGroup" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserGroupToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "userGroup" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiUserGroupLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_one_linkage.pyi index afea127e7..0adeca999 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_one_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_to_one_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiUserGroupToOneLinkage( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -66,4 +66,4 @@ class JsonApiUserGroupToOneLinkage( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_linkage import JsonApiUserGroupLinkage +from gooddata_api_client.models.json_api_user_group_linkage import JsonApiUserGroupLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_linkage.py deleted file mode 100644 index a222046c1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiUserIdentifierLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERIDENTIFIER': "userIdentifier", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "userIdentifier", must be one of ["userIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "userIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "userIdentifier", must be one of ["userIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "userIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out.py deleted file mode 100644 index 38fcb0ce0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_identifier_out_attributes import JsonApiUserIdentifierOutAttributes - globals()['JsonApiUserIdentifierOutAttributes'] = JsonApiUserIdentifierOutAttributes - - -class JsonApiUserIdentifierOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERIDENTIFIER': "userIdentifier", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiUserIdentifierOutAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userIdentifier", must be one of ["userIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserIdentifierOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userIdentifier", must be one of ["userIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserIdentifierOutAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_attributes.py deleted file mode 100644 index 37236fe2e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_attributes.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiUserIdentifierOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('email',): { - 'max_length': 255, - }, - ('firstname',): { - 'max_length': 255, - }, - ('lastname',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'email': (str,), # noqa: E501 - 'firstname': (str,), # noqa: E501 - 'lastname': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'email': 'email', # noqa: E501 - 'firstname': 'firstname', # noqa: E501 - 'lastname': 'lastname', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - email (str): [optional] # noqa: E501 - firstname (str): [optional] # noqa: E501 - lastname (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierOutAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - email (str): [optional] # noqa: E501 - firstname (str): [optional] # noqa: E501 - lastname (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_document.py deleted file mode 100644 index a5b58f5c6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_identifier_out import JsonApiUserIdentifierOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiUserIdentifierOut'] = JsonApiUserIdentifierOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiUserIdentifierOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserIdentifierOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserIdentifierOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserIdentifierOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_list.py deleted file mode 100644 index 90a652672..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiUserIdentifierOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierOutList - a model defined in OpenAPI - - Args: - data ([JsonApiUserIdentifierOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierOutList - a model defined in OpenAPI - - Args: - data ([JsonApiUserIdentifierOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_with_links.py deleted file mode 100644 index 4489f8fdd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_identifier_out import JsonApiUserIdentifierOut - from gooddata_api_client.model.json_api_user_identifier_out_attributes import JsonApiUserIdentifierOutAttributes - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiUserIdentifierOut'] = JsonApiUserIdentifierOut - globals()['JsonApiUserIdentifierOutAttributes'] = JsonApiUserIdentifierOutAttributes - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiUserIdentifierOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERIDENTIFIER': "userIdentifier", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiUserIdentifierOutAttributes,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "userIdentifier", must be one of ["userIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserIdentifierOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "userIdentifier", must be one of ["userIdentifier", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserIdentifierOutAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userIdentifier") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiUserIdentifierOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_to_one_linkage.py deleted file mode 100644 index e328613a2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_identifier_linkage import JsonApiUserIdentifierLinkage - globals()['JsonApiUserIdentifierLinkage'] = JsonApiUserIdentifierLinkage - - -class JsonApiUserIdentifierToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERIDENTIFIER': "userIdentifier", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "userIdentifier" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserIdentifierToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "userIdentifier" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiUserIdentifierLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_in.py deleted file mode 100644 index 35066c069..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_in.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_in_attributes import JsonApiUserInAttributes - from gooddata_api_client.model.json_api_user_in_relationships import JsonApiUserInRelationships - globals()['JsonApiUserInAttributes'] = JsonApiUserInAttributes - globals()['JsonApiUserInRelationships'] = JsonApiUserInRelationships - - -class JsonApiUserIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USER': "user", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiUserInAttributes,), # noqa: E501 - 'relationships': (JsonApiUserInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_in.pyi index 89137e8b3..95cea670f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_in.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_in.pyi @@ -41,54 +41,54 @@ class JsonApiUserIn( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER(cls): return cls("user") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class authenticationId( schemas.StrSchema ): pass - - + + class email( schemas.StrSchema ): pass - - + + class firstname( schemas.StrSchema ): pass - - + + class lastname( schemas.StrSchema ): @@ -99,46 +99,46 @@ class JsonApiUserIn( "firstname": firstname, "lastname": lastname, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["authenticationId"]) -> MetaOapg.properties.authenticationId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["firstname"]) -> MetaOapg.properties.firstname: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["lastname"]) -> MetaOapg.properties.lastname: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["authenticationId", "email", "firstname", "lastname", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["authenticationId"]) -> typing.Union[MetaOapg.properties.authenticationId, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> typing.Union[MetaOapg.properties.email, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["firstname"]) -> typing.Union[MetaOapg.properties.firstname, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["lastname"]) -> typing.Union[MetaOapg.properties.lastname, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["authenticationId", "email", "firstname", "lastname", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -159,60 +159,60 @@ class JsonApiUserIn( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class userGroups( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupToManyLinkage']: return JsonApiUserGroupToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -230,28 +230,28 @@ class JsonApiUserIn( __annotations__ = { "userGroups": userGroups, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["userGroups", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroups"]) -> typing.Union[MetaOapg.properties.userGroups, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userGroups", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -272,48 +272,48 @@ class JsonApiUserIn( "attributes": attributes, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -336,4 +336,4 @@ class JsonApiUserIn( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage +from gooddata_api_client.models.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_in_attributes.py deleted file mode 100644 index eb9ec07e0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_in_attributes.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiUserInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('authentication_id',): { - 'max_length': 255, - }, - ('email',): { - 'max_length': 255, - }, - ('firstname',): { - 'max_length': 255, - }, - ('lastname',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'authentication_id': (str,), # noqa: E501 - 'email': (str,), # noqa: E501 - 'firstname': (str,), # noqa: E501 - 'lastname': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'authentication_id': 'authenticationId', # noqa: E501 - 'email': 'email', # noqa: E501 - 'firstname': 'firstname', # noqa: E501 - 'lastname': 'lastname', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - authentication_id (str): [optional] # noqa: E501 - email (str): [optional] # noqa: E501 - firstname (str): [optional] # noqa: E501 - lastname (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - authentication_id (str): [optional] # noqa: E501 - email (str): [optional] # noqa: E501 - firstname (str): [optional] # noqa: E501 - lastname (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_in_document.py deleted file mode 100644 index 886b50047..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_in import JsonApiUserIn - globals()['JsonApiUserIn'] = JsonApiUserIn - - -class JsonApiUserInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserInDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserInDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_in_document.pyi index 31d23699c..ec1009897 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiUserInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserIn']: return JsonApiUserIn __annotations__ = { "data": data, } - + data: 'JsonApiUserIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiUserInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_in import JsonApiUserIn +from gooddata_api_client.models.json_api_user_in import JsonApiUserIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_in_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_in_relationships.py deleted file mode 100644 index a065bcc53..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_in_relationships.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_in_relationships_parents import JsonApiUserGroupInRelationshipsParents - globals()['JsonApiUserGroupInRelationshipsParents'] = JsonApiUserGroupInRelationshipsParents - - -class JsonApiUserInRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'user_groups': (JsonApiUserGroupInRelationshipsParents,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'user_groups': 'userGroups', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - user_groups (JsonApiUserGroupInRelationshipsParents): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - user_groups (JsonApiUserGroupInRelationshipsParents): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_linkage.py deleted file mode 100644 index c696f1824..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiUserLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USER': "user", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_out.py deleted file mode 100644 index 7c820e757..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_out.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_in_attributes import JsonApiUserInAttributes - from gooddata_api_client.model.json_api_user_in_relationships import JsonApiUserInRelationships - globals()['JsonApiUserInAttributes'] = JsonApiUserInAttributes - globals()['JsonApiUserInRelationships'] = JsonApiUserInRelationships - - -class JsonApiUserOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USER': "user", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiUserInAttributes,), # noqa: E501 - 'relationships': (JsonApiUserInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_out.pyi index 819c2c1de..4844109d9 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_out.pyi @@ -41,54 +41,54 @@ class JsonApiUserOut( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER(cls): return cls("user") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class authenticationId( schemas.StrSchema ): pass - - + + class email( schemas.StrSchema ): pass - - + + class firstname( schemas.StrSchema ): pass - - + + class lastname( schemas.StrSchema ): @@ -99,46 +99,46 @@ class JsonApiUserOut( "firstname": firstname, "lastname": lastname, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["authenticationId"]) -> MetaOapg.properties.authenticationId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["firstname"]) -> MetaOapg.properties.firstname: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["lastname"]) -> MetaOapg.properties.lastname: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["authenticationId", "email", "firstname", "lastname", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["authenticationId"]) -> typing.Union[MetaOapg.properties.authenticationId, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> typing.Union[MetaOapg.properties.email, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["firstname"]) -> typing.Union[MetaOapg.properties.firstname, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["lastname"]) -> typing.Union[MetaOapg.properties.lastname, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["authenticationId", "email", "firstname", "lastname", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -159,60 +159,60 @@ class JsonApiUserOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class userGroups( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserGroupToManyLinkage']: return JsonApiUserGroupToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiUserGroupToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserGroupToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -230,28 +230,28 @@ class JsonApiUserOut( __annotations__ = { "userGroups": userGroups, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["userGroups", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["userGroups"]) -> typing.Union[MetaOapg.properties.userGroups, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userGroups", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -272,48 +272,48 @@ class JsonApiUserOut( "attributes": attributes, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -336,4 +336,4 @@ class JsonApiUserOut( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage +from gooddata_api_client.models.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_out_document.py deleted file mode 100644 index bf91724af..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks - from gooddata_api_client.model.json_api_user_out import JsonApiUserOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiUserGroupOutWithLinks'] = JsonApiUserGroupOutWithLinks - globals()['JsonApiUserOut'] = JsonApiUserOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiUserOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserOut,), # noqa: E501 - 'included': ([JsonApiUserGroupOutWithLinks],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_out_document.pyi index d9d8d5fdf..9d87b1bfc 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiUserOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserOut']: return JsonApiUserOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiUserGroupOutWithLinks']: return JsonApiUserGroupOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiUserGroupOutWithLinks'], typing.List['JsonApiUserGroupOutWithLinks']], @@ -67,10 +67,10 @@ class JsonApiUserOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiUserGroupOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiUserOutDocument( "included": included, "links": links, } - + data: 'JsonApiUserOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiUserOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks -from gooddata_api_client.model.json_api_user_out import JsonApiUserOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.json_api_user_out import JsonApiUserOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_out_list.py deleted file mode 100644 index 4fc448ce2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks - from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiUserGroupOutWithLinks'] = JsonApiUserGroupOutWithLinks - globals()['JsonApiUserOutWithLinks'] = JsonApiUserOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiUserOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiUserOutWithLinks],), # noqa: E501 - 'included': ([JsonApiUserGroupOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserOutList - a model defined in OpenAPI - - Args: - data ([JsonApiUserOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserOutList - a model defined in OpenAPI - - Args: - data ([JsonApiUserOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_out_list.pyi index 8468d583b..577819506 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiUserOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiUserOutWithLinks']: return JsonApiUserOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiUserOutWithLinks'], typing.List['JsonApiUserOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiUserOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiUserOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiUserGroupOutWithLinks']: return JsonApiUserGroupOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiUserGroupOutWithLinks'], typing.List['JsonApiUserGroupOutWithLinks']], @@ -91,10 +91,10 @@ class JsonApiUserOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiUserGroupOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiUserOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,6 +158,6 @@ class JsonApiUserOutList( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks -from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_out_with_links.py deleted file mode 100644 index 002a384f9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_with_links.py +++ /dev/null @@ -1,355 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_in_attributes import JsonApiUserInAttributes - from gooddata_api_client.model.json_api_user_in_relationships import JsonApiUserInRelationships - from gooddata_api_client.model.json_api_user_out import JsonApiUserOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiUserInAttributes'] = JsonApiUserInAttributes - globals()['JsonApiUserInRelationships'] = JsonApiUserInRelationships - globals()['JsonApiUserOut'] = JsonApiUserOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiUserOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USER': "user", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiUserInAttributes,), # noqa: E501 - 'relationships': (JsonApiUserInRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiUserOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_out_with_links.pyi index 249fb236a..6b9f90cbd 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiUserOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiUserOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_user_out import JsonApiUserOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_user_out import JsonApiUserOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_patch.py deleted file mode 100644 index 80faeb33c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_patch.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_in_attributes import JsonApiUserInAttributes - from gooddata_api_client.model.json_api_user_in_relationships import JsonApiUserInRelationships - globals()['JsonApiUserInAttributes'] = JsonApiUserInAttributes - globals()['JsonApiUserInRelationships'] = JsonApiUserInRelationships - - -class JsonApiUserPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USER': "user", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiUserInAttributes,), # noqa: E501 - 'relationships': (JsonApiUserInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "user", must be one of ["user", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiUserInAttributes): [optional] # noqa: E501 - relationships (JsonApiUserInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "user") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_patch.pyi index 6302b504c..66dbba57c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_patch.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_patch.pyi @@ -336,4 +336,4 @@ class JsonApiUserPatch( **kwargs, ) -from gooddata_api_client.model.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage +from gooddata_api_client.models.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_patch_document.py deleted file mode 100644 index 2daae72a9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_patch import JsonApiUserPatch - globals()['JsonApiUserPatch'] = JsonApiUserPatch - - -class JsonApiUserPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_patch_document.pyi index e812f418a..281ae4c64 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_patch_document.pyi @@ -86,4 +86,4 @@ class JsonApiUserPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_patch import JsonApiUserPatch +from gooddata_api_client.models.json_api_user_patch import JsonApiUserPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in.py deleted file mode 100644 index faa70c25a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - - -class JsonApiUserSettingIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERSETTING': "userSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userSetting", must be one of ["userSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userSetting", must be one of ["userSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_document.py deleted file mode 100644 index ceb872794..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_setting_in import JsonApiUserSettingIn - globals()['JsonApiUserSettingIn'] = JsonApiUserSettingIn - - -class JsonApiUserSettingInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserSettingIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingInDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserSettingIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingInDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserSettingIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_document.pyi index a9744cdec..88ef820ad 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiUserSettingInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserSettingIn']: return JsonApiUserSettingIn __annotations__ = { "data": data, } - + data: 'JsonApiUserSettingIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserSettingIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserSettingIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiUserSettingInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_setting_in import JsonApiUserSettingIn +from gooddata_api_client.models.json_api_user_setting_in import JsonApiUserSettingIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out.py deleted file mode 100644 index 4d0cda2b6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - - -class JsonApiUserSettingOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERSETTING': "userSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userSetting", must be one of ["userSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "userSetting", must be one of ["userSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_document.py deleted file mode 100644 index 875fb9b4c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_setting_out import JsonApiUserSettingOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiUserSettingOut'] = JsonApiUserSettingOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiUserSettingOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiUserSettingOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserSettingOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiUserSettingOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_document.pyi index adbb49158..13a6bb5d5 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_document.pyi @@ -38,13 +38,13 @@ class JsonApiUserSettingOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiUserSettingOut']: return JsonApiUserSettingOut - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -52,35 +52,35 @@ class JsonApiUserSettingOutDocument( "data": data, "links": links, } - + data: 'JsonApiUserSettingOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserSettingOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserSettingOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -99,5 +99,5 @@ class JsonApiUserSettingOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_user_setting_out import JsonApiUserSettingOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_user_setting_out import JsonApiUserSettingOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_list.py deleted file mode 100644 index c26b64b04..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_user_setting_out_with_links import JsonApiUserSettingOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiUserSettingOutWithLinks'] = JsonApiUserSettingOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiUserSettingOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiUserSettingOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingOutList - a model defined in OpenAPI - - Args: - data ([JsonApiUserSettingOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingOutList - a model defined in OpenAPI - - Args: - data ([JsonApiUserSettingOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_list.pyi index 8eef8752f..0639eef2c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiUserSettingOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiUserSettingOutWithLinks']: return JsonApiUserSettingOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiUserSettingOutWithLinks'], typing.List['JsonApiUserSettingOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiUserSettingOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiUserSettingOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiUserSettingOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiUserSettingOutList( **kwargs, ) -from gooddata_api_client.model.json_api_user_setting_out_with_links import JsonApiUserSettingOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_user_setting_out_with_links import JsonApiUserSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_with_links.py deleted file mode 100644 index 8793fa0bc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_with_links.py +++ /dev/null @@ -1,349 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - from gooddata_api_client.model.json_api_user_setting_out import JsonApiUserSettingOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - globals()['JsonApiUserSettingOut'] = JsonApiUserSettingOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiUserSettingOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USERSETTING': "userSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "userSetting", must be one of ["userSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserSettingOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "userSetting", must be one of ["userSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "userSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiUserSettingOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_with_links.pyi index a4adb5368..e68102c40 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiUserSettingOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiUserSettingOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_user_setting_out import JsonApiUserSettingOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_user_setting_out import JsonApiUserSettingOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_to_many_linkage.py deleted file mode 100644 index 540a66ecb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_linkage import JsonApiUserLinkage - globals()['JsonApiUserLinkage'] = JsonApiUserLinkage - - -class JsonApiUserToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiUserLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiUserToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiUserLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiUserLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiUserToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiUserLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiUserLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_to_one_linkage.py deleted file mode 100644 index 3a29cd136..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_user_linkage import JsonApiUserLinkage - globals()['JsonApiUserLinkage'] = JsonApiUserLinkage - - -class JsonApiUserToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'USER': "user", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiUserToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "user" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiUserToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "user" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiUserLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_to_one_linkage.pyi index 96bc917b8..ca73f0bce 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_to_one_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_to_one_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiUserToOneLinkage( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -66,4 +66,4 @@ class JsonApiUserToOneLinkage( **kwargs, ) -from gooddata_api_client.model.json_api_user_linkage import JsonApiUserLinkage +from gooddata_api_client.models.json_api_user_linkage import JsonApiUserLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in.py deleted file mode 100644 index 673a39145..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_visualization_object_in_attributes import JsonApiVisualizationObjectInAttributes - globals()['JsonApiVisualizationObjectInAttributes'] = JsonApiVisualizationObjectInAttributes - - -class JsonApiVisualizationObjectIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'VISUALIZATIONOBJECT': "visualizationObject", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiVisualizationObjectInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectIn - a model defined in OpenAPI - - Args: - attributes (JsonApiVisualizationObjectInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectIn - a model defined in OpenAPI - - Args: - attributes (JsonApiVisualizationObjectInAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_attributes.py deleted file mode 100644 index 52fad07ff..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_attributes.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiVisualizationObjectInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectInAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectInAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_document.py deleted file mode 100644 index ee08a6301..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_visualization_object_in import JsonApiVisualizationObjectIn - globals()['JsonApiVisualizationObjectIn'] = JsonApiVisualizationObjectIn - - -class JsonApiVisualizationObjectInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiVisualizationObjectIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectInDocument - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectInDocument - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_document.pyi index d3e9af291..d8239462c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiVisualizationObjectInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiVisualizationObjectIn']: return JsonApiVisualizationObjectIn __annotations__ = { "data": data, } - + data: 'JsonApiVisualizationObjectIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiVisualizationObjectInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_visualization_object_in import JsonApiVisualizationObjectIn +from gooddata_api_client.models.json_api_visualization_object_in import JsonApiVisualizationObjectIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_linkage.py deleted file mode 100644 index cfeae735a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiVisualizationObjectLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'VISUALIZATIONOBJECT': "visualizationObject", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out.py deleted file mode 100644 index 5cbb922c9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out.py +++ /dev/null @@ -1,310 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships - from gooddata_api_client.model.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiMetricOutRelationships'] = JsonApiMetricOutRelationships - globals()['JsonApiVisualizationObjectOutAttributes'] = JsonApiVisualizationObjectOutAttributes - - -class JsonApiVisualizationObjectOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'VISUALIZATIONOBJECT': "visualizationObject", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiVisualizationObjectOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiMetricOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectOut - a model defined in OpenAPI - - Args: - attributes (JsonApiVisualizationObjectOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectOut - a model defined in OpenAPI - - Args: - attributes (JsonApiVisualizationObjectOutAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out.pyi index e694b71a6..13d71f701 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out.pyi @@ -41,52 +41,52 @@ class JsonApiVisualizationObjectOut( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def VISUALIZATION_OBJECT(cls): return cls("visualizationObject") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: areRelationsValid = schemas.BoolSchema content = schemas.DictSchema - - + + class description( schemas.StrSchema ): pass - - + + class tags( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -97,11 +97,11 @@ class JsonApiVisualizationObjectOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): @@ -113,52 +113,52 @@ class JsonApiVisualizationObjectOut( "tags": tags, "title": title, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -181,42 +181,42 @@ class JsonApiVisualizationObjectOut( _configuration=_configuration, **kwargs, ) - - + + class meta( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class origin( schemas.DictSchema ): - - + + class MetaOapg: required = { "originType", "originId", } - + class properties: originId = schemas.StrSchema - - + + class originType( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") - + @schemas.classproperty def PARENT(cls): return cls("PARENT") @@ -224,37 +224,37 @@ class JsonApiVisualizationObjectOut( "originId": originId, "originType": originType, } - + originType: MetaOapg.properties.originType originId: MetaOapg.properties.originId - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -274,28 +274,28 @@ class JsonApiVisualizationObjectOut( __annotations__ = { "origin": origin, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -310,60 +310,60 @@ class JsonApiVisualizationObjectOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiAttributeToManyLinkage']: return JsonApiAttributeToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiAttributeToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -378,50 +378,50 @@ class JsonApiVisualizationObjectOut( _configuration=_configuration, **kwargs, ) - - + + class datasets( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiDatasetToManyLinkage']: return JsonApiDatasetToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiDatasetToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -436,50 +436,50 @@ class JsonApiVisualizationObjectOut( _configuration=_configuration, **kwargs, ) - - + + class facts( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiFactToManyLinkage']: return JsonApiFactToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiFactToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -494,50 +494,50 @@ class JsonApiVisualizationObjectOut( _configuration=_configuration, **kwargs, ) - - + + class labels( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiLabelToManyLinkage']: return JsonApiLabelToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiLabelToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -552,50 +552,50 @@ class JsonApiVisualizationObjectOut( _configuration=_configuration, **kwargs, ) - - + + class metrics( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiMetricToManyLinkage']: return JsonApiMetricToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiMetricToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -617,52 +617,52 @@ class JsonApiVisualizationObjectOut( "labels": labels, "metrics": metrics, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["datasets"]) -> MetaOapg.properties.datasets: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["facts"]) -> MetaOapg.properties.facts: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["labels"]) -> MetaOapg.properties.labels: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "datasets", "facts", "labels", "metrics", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["datasets"]) -> typing.Union[MetaOapg.properties.datasets, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["facts"]) -> typing.Union[MetaOapg.properties.facts, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["labels"]) -> typing.Union[MetaOapg.properties.labels, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "datasets", "facts", "labels", "metrics", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -692,54 +692,54 @@ class JsonApiVisualizationObjectOut( "meta": meta, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -764,8 +764,8 @@ class JsonApiVisualizationObjectOut( **kwargs, ) -from gooddata_api_client.model.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage -from gooddata_api_client.model.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage -from gooddata_api_client.model.json_api_fact_to_many_linkage import JsonApiFactToManyLinkage -from gooddata_api_client.model.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage -from gooddata_api_client.model.json_api_metric_to_many_linkage import JsonApiMetricToManyLinkage +from gooddata_api_client.models.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage +from gooddata_api_client.models.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage +from gooddata_api_client.models.json_api_fact_to_many_linkage import JsonApiFactToManyLinkage +from gooddata_api_client.models.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage +from gooddata_api_client.models.json_api_metric_to_many_linkage import JsonApiMetricToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_attributes.py deleted file mode 100644 index 9bf8d32a0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_attributes.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiVisualizationObjectOutAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'are_relations_valid': (bool,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectOutAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, content, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectOutAttributes - a model defined in OpenAPI - - Args: - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.content = content - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.py deleted file mode 100644 index 60ba9cea1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes - from gooddata_api_client.model.json_api_visualization_object_out import JsonApiVisualizationObjectOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes - globals()['JsonApiVisualizationObjectOut'] = JsonApiVisualizationObjectOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiVisualizationObjectOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiVisualizationObjectOut,), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.pyi index ed725b4a1..95b6d4df9 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiVisualizationObjectOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiVisualizationObjectOut']: return JsonApiVisualizationObjectOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiMetricOutIncludes']: return JsonApiMetricOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiMetricOutIncludes'], typing.List['JsonApiMetricOutIncludes']], @@ -67,10 +67,10 @@ class JsonApiVisualizationObjectOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiMetricOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiVisualizationObjectOutDocument( "included": included, "links": links, } - + data: 'JsonApiVisualizationObjectOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiVisualizationObjectOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes -from gooddata_api_client.model.json_api_visualization_object_out import JsonApiVisualizationObjectOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_metric_out_includes import JsonApiMetricOutIncludes +from gooddata_api_client.models.json_api_visualization_object_out import JsonApiVisualizationObjectOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.py deleted file mode 100644 index 55693b5f8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes - from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes - globals()['JsonApiVisualizationObjectOutWithLinks'] = JsonApiVisualizationObjectOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiVisualizationObjectOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiVisualizationObjectOutWithLinks],), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectOutList - a model defined in OpenAPI - - Args: - data ([JsonApiVisualizationObjectOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectOutList - a model defined in OpenAPI - - Args: - data ([JsonApiVisualizationObjectOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.pyi index 7890d3039..6a561f9c6 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiVisualizationObjectOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiVisualizationObjectOutWithLinks']: return JsonApiVisualizationObjectOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiVisualizationObjectOutWithLinks'], typing.List['JsonApiVisualizationObjectOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiVisualizationObjectOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiVisualizationObjectOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiMetricOutIncludes']: return JsonApiMetricOutIncludes - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiMetricOutIncludes'], typing.List['JsonApiMetricOutIncludes']], @@ -91,10 +91,10 @@ class JsonApiVisualizationObjectOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiMetricOutIncludes': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiVisualizationObjectOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,6 +158,6 @@ class JsonApiVisualizationObjectOutList( **kwargs, ) -from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes -from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_metric_out_includes import JsonApiMetricOutIncludes +from gooddata_api_client.models.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_with_links.py deleted file mode 100644 index a5a3ccc57..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships - from gooddata_api_client.model.json_api_visualization_object_out import JsonApiVisualizationObjectOut - from gooddata_api_client.model.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiMetricOutRelationships'] = JsonApiMetricOutRelationships - globals()['JsonApiVisualizationObjectOut'] = JsonApiVisualizationObjectOut - globals()['JsonApiVisualizationObjectOutAttributes'] = JsonApiVisualizationObjectOutAttributes - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiVisualizationObjectOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'VISUALIZATIONOBJECT': "visualizationObject", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiVisualizationObjectOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiMetricOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiVisualizationObjectOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectOutWithLinks - a model defined in OpenAPI - - Keyword Args: - attributes (JsonApiVisualizationObjectOutAttributes): - id (str): API identifier of an object - type (str): Object type. defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiVisualizationObjectOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_with_links.pyi index ba6a66df8..842cb2b0b 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiVisualizationObjectOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiVisualizationObjectOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_visualization_object_out import JsonApiVisualizationObjectOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_visualization_object_out import JsonApiVisualizationObjectOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch.py deleted file mode 100644 index db1411d7c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_visualization_object_patch_attributes import JsonApiVisualizationObjectPatchAttributes - globals()['JsonApiVisualizationObjectPatchAttributes'] = JsonApiVisualizationObjectPatchAttributes - - -class JsonApiVisualizationObjectPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'VISUALIZATIONOBJECT': "visualizationObject", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiVisualizationObjectPatchAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiVisualizationObjectPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectPatch - a model defined in OpenAPI - - Args: - attributes (JsonApiVisualizationObjectPatchAttributes): - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_attributes.py deleted file mode 100644 index 0656b4c65..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_attributes.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiVisualizationObjectPatchAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'are_relations_valid': (bool,), # noqa: E501 - 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'are_relations_valid': 'areRelationsValid', # noqa: E501 - 'content': 'content', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectPatchAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - are_relations_valid (bool): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - is_hidden (bool): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_document.py deleted file mode 100644 index 81fc9b8d5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_visualization_object_patch import JsonApiVisualizationObjectPatch - globals()['JsonApiVisualizationObjectPatch'] = JsonApiVisualizationObjectPatch - - -class JsonApiVisualizationObjectPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiVisualizationObjectPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_document.pyi index 7eecd7a62..f65920f4a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiVisualizationObjectPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiVisualizationObjectPatch']: return JsonApiVisualizationObjectPatch __annotations__ = { "data": data, } - + data: 'JsonApiVisualizationObjectPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiVisualizationObjectPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_visualization_object_patch import JsonApiVisualizationObjectPatch +from gooddata_api_client.models.json_api_visualization_object_patch import JsonApiVisualizationObjectPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_post_optional_id.py deleted file mode 100644 index a3973d2d9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_post_optional_id.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_visualization_object_in_attributes import JsonApiVisualizationObjectInAttributes - globals()['JsonApiVisualizationObjectInAttributes'] = JsonApiVisualizationObjectInAttributes - - -class JsonApiVisualizationObjectPostOptionalId(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'VISUALIZATIONOBJECT': "visualizationObject", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': (JsonApiVisualizationObjectInAttributes,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiVisualizationObjectInAttributes): - - Keyword Args: - type (str): Object type. defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectPostOptionalId - a model defined in OpenAPI - - Args: - attributes (JsonApiVisualizationObjectInAttributes): - - Keyword Args: - type (str): Object type. defaults to "visualizationObject", must be one of ["visualizationObject", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "visualizationObject") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_post_optional_id_document.py deleted file mode 100644 index b93decd6c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_post_optional_id_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_visualization_object_post_optional_id import JsonApiVisualizationObjectPostOptionalId - globals()['JsonApiVisualizationObjectPostOptionalId'] = JsonApiVisualizationObjectPostOptionalId - - -class JsonApiVisualizationObjectPostOptionalIdDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiVisualizationObjectPostOptionalId,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiVisualizationObjectPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_post_optional_id_document.pyi index ced8f4a11..8020629a6 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_post_optional_id_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_post_optional_id_document.pyi @@ -38,38 +38,38 @@ class JsonApiVisualizationObjectPostOptionalIdDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiVisualizationObjectPostOptionalId']: return JsonApiVisualizationObjectPostOptionalId __annotations__ = { "data": data, } - + data: 'JsonApiVisualizationObjectPostOptionalId' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectPostOptionalId': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectPostOptionalId': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiVisualizationObjectPostOptionalIdDocument( **kwargs, ) -from gooddata_api_client.model.json_api_visualization_object_post_optional_id import JsonApiVisualizationObjectPostOptionalId +from gooddata_api_client.models.json_api_visualization_object_post_optional_id import JsonApiVisualizationObjectPostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_many_linkage.py deleted file mode 100644 index a31b221b1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage - globals()['JsonApiVisualizationObjectLinkage'] = JsonApiVisualizationObjectLinkage - - -class JsonApiVisualizationObjectToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiVisualizationObjectLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiVisualizationObjectToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiVisualizationObjectLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiVisualizationObjectLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiVisualizationObjectToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiVisualizationObjectLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiVisualizationObjectLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_many_linkage.pyi index 58b708adb..8a06d201d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_many_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_many_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiVisualizationObjectToManyLinkage( class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiVisualizationObjectLinkage']: return JsonApiVisualizationObjectLinkage @@ -56,4 +56,4 @@ class JsonApiVisualizationObjectToManyLinkage( def __getitem__(self, i: int) -> 'JsonApiVisualizationObjectLinkage': return super().__getitem__(i) -from gooddata_api_client.model.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage +from gooddata_api_client.models.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_one_linkage.py deleted file mode 100644 index 2e088e11d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage - globals()['JsonApiVisualizationObjectLinkage'] = JsonApiVisualizationObjectLinkage - - -class JsonApiVisualizationObjectToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'VISUALIZATIONOBJECT': "visualizationObject", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "visualizationObject" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiVisualizationObjectToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "visualizationObject" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiVisualizationObjectLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.py deleted file mode 100644 index 46026361f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_out_attributes import JsonApiAutomationOutAttributes - from gooddata_api_client.model.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships - globals()['JsonApiAutomationOutAttributes'] = JsonApiAutomationOutAttributes - globals()['JsonApiWorkspaceAutomationOutRelationships'] = JsonApiWorkspaceAutomationOutRelationships - - -class JsonApiWorkspaceAutomationOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEAUTOMATION': "workspaceAutomation", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAutomationOutAttributes,), # noqa: E501 - 'relationships': (JsonApiWorkspaceAutomationOutRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceAutomation", must be one of ["workspaceAutomation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationOutAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceAutomationOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceAutomation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceAutomation", must be one of ["workspaceAutomation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationOutAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceAutomationOutRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceAutomation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_includes.py deleted file mode 100644 index ebf907810..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_includes.py +++ /dev/null @@ -1,374 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks - from gooddata_api_client.model.json_api_automation_result_out_attributes import JsonApiAutomationResultOutAttributes - from gooddata_api_client.model.json_api_automation_result_out_relationships import JsonApiAutomationResultOutRelationships - from gooddata_api_client.model.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks - from gooddata_api_client.model.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks - from gooddata_api_client.model.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks - from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks - from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks - from gooddata_api_client.model.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiAnalyticalDashboardOutWithLinks'] = JsonApiAnalyticalDashboardOutWithLinks - globals()['JsonApiAutomationResultOutAttributes'] = JsonApiAutomationResultOutAttributes - globals()['JsonApiAutomationResultOutRelationships'] = JsonApiAutomationResultOutRelationships - globals()['JsonApiAutomationResultOutWithLinks'] = JsonApiAutomationResultOutWithLinks - globals()['JsonApiExportDefinitionOutWithLinks'] = JsonApiExportDefinitionOutWithLinks - globals()['JsonApiNotificationChannelOutWithLinks'] = JsonApiNotificationChannelOutWithLinks - globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks - globals()['JsonApiUserOutWithLinks'] = JsonApiUserOutWithLinks - globals()['JsonApiWorkspaceOutWithLinks'] = JsonApiWorkspaceOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiWorkspaceAutomationOutIncludes(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'AUTOMATIONRESULT': "automationResult", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAutomationResultOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - 'attributes': (JsonApiAutomationResultOutAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAutomationResultOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiAutomationResultOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "automationResult" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOutIncludes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAutomationResultOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiAutomationResultOutAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "automationResult" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiAnalyticalDashboardOutWithLinks, - JsonApiAutomationResultOutWithLinks, - JsonApiExportDefinitionOutWithLinks, - JsonApiNotificationChannelOutWithLinks, - JsonApiUserIdentifierOutWithLinks, - JsonApiUserOutWithLinks, - JsonApiWorkspaceOutWithLinks, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_list.py deleted file mode 100644 index 870df883d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_workspace_automation_out_includes import JsonApiWorkspaceAutomationOutIncludes - from gooddata_api_client.model.json_api_workspace_automation_out_with_links import JsonApiWorkspaceAutomationOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiWorkspaceAutomationOutIncludes'] = JsonApiWorkspaceAutomationOutIncludes - globals()['JsonApiWorkspaceAutomationOutWithLinks'] = JsonApiWorkspaceAutomationOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiWorkspaceAutomationOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiWorkspaceAutomationOutWithLinks],), # noqa: E501 - 'included': ([JsonApiWorkspaceAutomationOutIncludes],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOutList - a model defined in OpenAPI - - Args: - data ([JsonApiWorkspaceAutomationOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceAutomationOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOutList - a model defined in OpenAPI - - Args: - data ([JsonApiWorkspaceAutomationOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceAutomationOutIncludes]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_relationships.py deleted file mode 100644 index 1608b606e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_relationships.py +++ /dev/null @@ -1,310 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - from gooddata_api_client.model.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard - from gooddata_api_client.model.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions - from gooddata_api_client.model.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel - from gooddata_api_client.model.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients - from gooddata_api_client.model.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults - from gooddata_api_client.model.json_api_workspace_automation_out_relationships_workspace import JsonApiWorkspaceAutomationOutRelationshipsWorkspace - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - globals()['JsonApiAutomationInRelationshipsAnalyticalDashboard'] = JsonApiAutomationInRelationshipsAnalyticalDashboard - globals()['JsonApiAutomationInRelationshipsExportDefinitions'] = JsonApiAutomationInRelationshipsExportDefinitions - globals()['JsonApiAutomationInRelationshipsNotificationChannel'] = JsonApiAutomationInRelationshipsNotificationChannel - globals()['JsonApiAutomationInRelationshipsRecipients'] = JsonApiAutomationInRelationshipsRecipients - globals()['JsonApiAutomationOutRelationshipsAutomationResults'] = JsonApiAutomationOutRelationshipsAutomationResults - globals()['JsonApiWorkspaceAutomationOutRelationshipsWorkspace'] = JsonApiWorkspaceAutomationOutRelationshipsWorkspace - - -class JsonApiWorkspaceAutomationOutRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'analytical_dashboard': (JsonApiAutomationInRelationshipsAnalyticalDashboard,), # noqa: E501 - 'automation_results': (JsonApiAutomationOutRelationshipsAutomationResults,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'export_definitions': (JsonApiAutomationInRelationshipsExportDefinitions,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'notification_channel': (JsonApiAutomationInRelationshipsNotificationChannel,), # noqa: E501 - 'recipients': (JsonApiAutomationInRelationshipsRecipients,), # noqa: E501 - 'workspace': (JsonApiWorkspaceAutomationOutRelationshipsWorkspace,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 - 'automation_results': 'automationResults', # noqa: E501 - 'created_by': 'createdBy', # noqa: E501 - 'export_definitions': 'exportDefinitions', # noqa: E501 - 'modified_by': 'modifiedBy', # noqa: E501 - 'notification_channel': 'notificationChannel', # noqa: E501 - 'recipients': 'recipients', # noqa: E501 - 'workspace': 'workspace', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 - recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 - workspace (JsonApiWorkspaceAutomationOutRelationshipsWorkspace): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOutRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 - recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 - workspace (JsonApiWorkspaceAutomationOutRelationshipsWorkspace): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_relationships_workspace.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_relationships_workspace.py deleted file mode 100644 index 1e88a1b53..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_relationships_workspace.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage - globals()['JsonApiWorkspaceToOneLinkage'] = JsonApiWorkspaceToOneLinkage - - -class JsonApiWorkspaceAutomationOutRelationshipsWorkspace(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOutRelationshipsWorkspace - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOutRelationshipsWorkspace - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.py deleted file mode 100644 index ab0244692..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.py +++ /dev/null @@ -1,355 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_automation_out_attributes import JsonApiAutomationOutAttributes - from gooddata_api_client.model.json_api_workspace_automation_out import JsonApiWorkspaceAutomationOut - from gooddata_api_client.model.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAutomationOutAttributes'] = JsonApiAutomationOutAttributes - globals()['JsonApiWorkspaceAutomationOut'] = JsonApiWorkspaceAutomationOut - globals()['JsonApiWorkspaceAutomationOutRelationships'] = JsonApiWorkspaceAutomationOutRelationships - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiWorkspaceAutomationOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEAUTOMATION': "workspaceAutomation", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAutomationOutAttributes,), # noqa: E501 - 'relationships': (JsonApiWorkspaceAutomationOutRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "workspaceAutomation", must be one of ["workspaceAutomation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationOutAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceAutomationOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceAutomation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceAutomationOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "workspaceAutomation", must be one of ["workspaceAutomation", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiAutomationOutAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceAutomationOutRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceAutomation") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiWorkspaceAutomationOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in.py deleted file mode 100644 index cac3e0fbf..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes - from gooddata_api_client.model.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships - globals()['JsonApiWorkspaceDataFilterInAttributes'] = JsonApiWorkspaceDataFilterInAttributes - globals()['JsonApiWorkspaceDataFilterInRelationships'] = JsonApiWorkspaceDataFilterInRelationships - - -class JsonApiWorkspaceDataFilterIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTER': "workspaceDataFilter", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceDataFilterInAttributes,), # noqa: E501 - 'relationships': (JsonApiWorkspaceDataFilterInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in.pyi index 85d06bfef..eec0076b0 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in.pyi @@ -41,48 +41,48 @@ class JsonApiWorkspaceDataFilterIn( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACE_DATA_FILTER(cls): return cls("workspaceDataFilter") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class columnName( schemas.StrSchema ): pass - - + + class description( schemas.StrSchema ): pass - - + + class title( schemas.StrSchema ): @@ -92,40 +92,40 @@ class JsonApiWorkspaceDataFilterIn( "description": description, "title": title, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["columnName"]) -> MetaOapg.properties.columnName: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["columnName", "description", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["columnName"]) -> typing.Union[MetaOapg.properties.columnName, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["columnName", "description", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -144,60 +144,60 @@ class JsonApiWorkspaceDataFilterIn( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class filterSettings( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceDataFilterSettingToManyLinkage']: return JsonApiWorkspaceDataFilterSettingToManyLinkage __annotations__ = { "data": data, } - + data: 'JsonApiWorkspaceDataFilterSettingToManyLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterSettingToManyLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterSettingToManyLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -215,28 +215,28 @@ class JsonApiWorkspaceDataFilterIn( __annotations__ = { "filterSettings": filterSettings, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["filterSettings"]) -> MetaOapg.properties.filterSettings: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["filterSettings", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["filterSettings"]) -> typing.Union[MetaOapg.properties.filterSettings, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["filterSettings", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -257,48 +257,48 @@ class JsonApiWorkspaceDataFilterIn( "attributes": attributes, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -321,4 +321,4 @@ class JsonApiWorkspaceDataFilterIn( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_setting_to_many_linkage import JsonApiWorkspaceDataFilterSettingToManyLinkage +from gooddata_api_client.models.json_api_workspace_data_filter_setting_to_many_linkage import JsonApiWorkspaceDataFilterSettingToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_attributes.py deleted file mode 100644 index 18a4d9c3e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_attributes.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiWorkspaceDataFilterInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('column_name',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'column_name': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'column_name': 'columnName', # noqa: E501 - 'description': 'description', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - column_name (str): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - column_name (str): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_document.py deleted file mode 100644 index b3c66bb0b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_in import JsonApiWorkspaceDataFilterIn - globals()['JsonApiWorkspaceDataFilterIn'] = JsonApiWorkspaceDataFilterIn - - -class JsonApiWorkspaceDataFilterInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceDataFilterIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterInDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterInDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_document.pyi index 5e91db0cc..7ad431bf2 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiWorkspaceDataFilterInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceDataFilterIn']: return JsonApiWorkspaceDataFilterIn __annotations__ = { "data": data, } - + data: 'JsonApiWorkspaceDataFilterIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiWorkspaceDataFilterInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_in import JsonApiWorkspaceDataFilterIn +from gooddata_api_client.models.json_api_workspace_data_filter_in import JsonApiWorkspaceDataFilterIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_relationships.py deleted file mode 100644 index 7a64cd2b2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_relationships.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_in_relationships_filter_settings import JsonApiWorkspaceDataFilterInRelationshipsFilterSettings - globals()['JsonApiWorkspaceDataFilterInRelationshipsFilterSettings'] = JsonApiWorkspaceDataFilterInRelationshipsFilterSettings - - -class JsonApiWorkspaceDataFilterInRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'filter_settings': (JsonApiWorkspaceDataFilterInRelationshipsFilterSettings,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'filter_settings': 'filterSettings', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - filter_settings (JsonApiWorkspaceDataFilterInRelationshipsFilterSettings): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - filter_settings (JsonApiWorkspaceDataFilterInRelationshipsFilterSettings): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_relationships_filter_settings.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_relationships_filter_settings.py deleted file mode 100644 index cd2ad41cd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_in_relationships_filter_settings.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_setting_to_many_linkage import JsonApiWorkspaceDataFilterSettingToManyLinkage - globals()['JsonApiWorkspaceDataFilterSettingToManyLinkage'] = JsonApiWorkspaceDataFilterSettingToManyLinkage - - -class JsonApiWorkspaceDataFilterInRelationshipsFilterSettings(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceDataFilterSettingToManyLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterInRelationshipsFilterSettings - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterSettingToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterInRelationshipsFilterSettings - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterSettingToManyLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_linkage.py deleted file mode 100644 index bfdfe5c0b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiWorkspaceDataFilterLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTER': "workspaceDataFilter", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out.py deleted file mode 100644 index 2017a6842..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes - from gooddata_api_client.model.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiWorkspaceDataFilterInAttributes'] = JsonApiWorkspaceDataFilterInAttributes - globals()['JsonApiWorkspaceDataFilterInRelationships'] = JsonApiWorkspaceDataFilterInRelationships - - -class JsonApiWorkspaceDataFilterOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTER': "workspaceDataFilter", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceDataFilterInAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiWorkspaceDataFilterInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out.pyi index ee5afc910..57a92829d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out.pyi @@ -321,4 +321,4 @@ class JsonApiWorkspaceDataFilterOut( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_setting_to_many_linkage import JsonApiWorkspaceDataFilterSettingToManyLinkage +from gooddata_api_client.models.json_api_workspace_data_filter_setting_to_many_linkage import JsonApiWorkspaceDataFilterSettingToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_document.py deleted file mode 100644 index 370909507..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut - from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiWorkspaceDataFilterOut'] = JsonApiWorkspaceDataFilterOut - globals()['JsonApiWorkspaceDataFilterSettingOutWithLinks'] = JsonApiWorkspaceDataFilterSettingOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiWorkspaceDataFilterOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceDataFilterOut,), # noqa: E501 - 'included': ([JsonApiWorkspaceDataFilterSettingOutWithLinks],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceDataFilterSettingOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceDataFilterSettingOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_document.pyi index 82b7a0b4c..2d150c3a3 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiWorkspaceDataFilterOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceDataFilterOut']: return JsonApiWorkspaceDataFilterOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiWorkspaceDataFilterSettingOutWithLinks']: return JsonApiWorkspaceDataFilterSettingOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiWorkspaceDataFilterSettingOutWithLinks'], typing.List['JsonApiWorkspaceDataFilterSettingOutWithLinks']], @@ -67,10 +67,10 @@ class JsonApiWorkspaceDataFilterOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiWorkspaceDataFilterSettingOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiWorkspaceDataFilterOutDocument( "included": included, "links": links, } - + data: 'JsonApiWorkspaceDataFilterOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiWorkspaceDataFilterOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_list.py deleted file mode 100644 index eef3d0118..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks - from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiWorkspaceDataFilterOutWithLinks'] = JsonApiWorkspaceDataFilterOutWithLinks - globals()['JsonApiWorkspaceDataFilterSettingOutWithLinks'] = JsonApiWorkspaceDataFilterSettingOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiWorkspaceDataFilterOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiWorkspaceDataFilterOutWithLinks],), # noqa: E501 - 'included': ([JsonApiWorkspaceDataFilterSettingOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterOutList - a model defined in OpenAPI - - Args: - data ([JsonApiWorkspaceDataFilterOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceDataFilterSettingOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterOutList - a model defined in OpenAPI - - Args: - data ([JsonApiWorkspaceDataFilterOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceDataFilterSettingOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_list.pyi index 4131f1f30..d0ba37701 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiWorkspaceDataFilterOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiWorkspaceDataFilterOutWithLinks']: return JsonApiWorkspaceDataFilterOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiWorkspaceDataFilterOutWithLinks'], typing.List['JsonApiWorkspaceDataFilterOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiWorkspaceDataFilterOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiWorkspaceDataFilterOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiWorkspaceDataFilterSettingOutWithLinks']: return JsonApiWorkspaceDataFilterSettingOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiWorkspaceDataFilterSettingOutWithLinks'], typing.List['JsonApiWorkspaceDataFilterSettingOutWithLinks']], @@ -91,10 +91,10 @@ class JsonApiWorkspaceDataFilterOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiWorkspaceDataFilterSettingOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiWorkspaceDataFilterOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,6 +158,6 @@ class JsonApiWorkspaceDataFilterOutList( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_with_links.py deleted file mode 100644 index 024176d52..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes - from gooddata_api_client.model.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships - from gooddata_api_client.model.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiWorkspaceDataFilterInAttributes'] = JsonApiWorkspaceDataFilterInAttributes - globals()['JsonApiWorkspaceDataFilterInRelationships'] = JsonApiWorkspaceDataFilterInRelationships - globals()['JsonApiWorkspaceDataFilterOut'] = JsonApiWorkspaceDataFilterOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiWorkspaceDataFilterOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTER': "workspaceDataFilter", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceDataFilterInAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiWorkspaceDataFilterInRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiWorkspaceDataFilterOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_with_links.pyi index 9638ece5f..598886202 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiWorkspaceDataFilterOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiWorkspaceDataFilterOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch.py deleted file mode 100644 index c045fc1bf..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes - from gooddata_api_client.model.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships - globals()['JsonApiWorkspaceDataFilterInAttributes'] = JsonApiWorkspaceDataFilterInAttributes - globals()['JsonApiWorkspaceDataFilterInRelationships'] = JsonApiWorkspaceDataFilterInRelationships - - -class JsonApiWorkspaceDataFilterPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTER': "workspaceDataFilter", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceDataFilterInAttributes,), # noqa: E501 - 'relationships': (JsonApiWorkspaceDataFilterInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilter", must be one of ["workspaceDataFilter", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilter") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch.pyi index 14421d486..bdc46fb1d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch.pyi @@ -321,4 +321,4 @@ class JsonApiWorkspaceDataFilterPatch( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_setting_to_many_linkage import JsonApiWorkspaceDataFilterSettingToManyLinkage +from gooddata_api_client.models.json_api_workspace_data_filter_setting_to_many_linkage import JsonApiWorkspaceDataFilterSettingToManyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch_document.py deleted file mode 100644 index b13e0eba2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_patch import JsonApiWorkspaceDataFilterPatch - globals()['JsonApiWorkspaceDataFilterPatch'] = JsonApiWorkspaceDataFilterPatch - - -class JsonApiWorkspaceDataFilterPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceDataFilterPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch_document.pyi index 813421fd1..e0b675b0f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiWorkspaceDataFilterPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceDataFilterPatch']: return JsonApiWorkspaceDataFilterPatch __annotations__ = { "data": data, } - + data: 'JsonApiWorkspaceDataFilterPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiWorkspaceDataFilterPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_patch import JsonApiWorkspaceDataFilterPatch +from gooddata_api_client.models.json_api_workspace_data_filter_patch import JsonApiWorkspaceDataFilterPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in.py deleted file mode 100644 index 26bf6da0c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes - from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships - globals()['JsonApiWorkspaceDataFilterSettingInAttributes'] = JsonApiWorkspaceDataFilterSettingInAttributes - globals()['JsonApiWorkspaceDataFilterSettingInRelationships'] = JsonApiWorkspaceDataFilterSettingInRelationships - - -class JsonApiWorkspaceDataFilterSettingIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTERSETTING': "workspaceDataFilterSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceDataFilterSettingInAttributes,), # noqa: E501 - 'relationships': (JsonApiWorkspaceDataFilterSettingInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilterSetting", must be one of ["workspaceDataFilterSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterSettingInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterSettingInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilterSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilterSetting", must be one of ["workspaceDataFilterSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterSettingInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterSettingInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilterSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_attributes.py deleted file mode 100644 index 92f3bfbe2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_attributes.py +++ /dev/null @@ -1,278 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiWorkspaceDataFilterSettingInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 10000, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'description': (str,), # noqa: E501 - 'filter_values': ([str],), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'description': 'description', # noqa: E501 - 'filter_values': 'filterValues', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): [optional] # noqa: E501 - filter_values ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): [optional] # noqa: E501 - filter_values ([str]): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_document.py deleted file mode 100644 index f8a42e571..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_setting_in import JsonApiWorkspaceDataFilterSettingIn - globals()['JsonApiWorkspaceDataFilterSettingIn'] = JsonApiWorkspaceDataFilterSettingIn - - -class JsonApiWorkspaceDataFilterSettingInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceDataFilterSettingIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingInDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterSettingIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingInDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterSettingIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_relationships.py deleted file mode 100644 index 499f0c7a1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_relationships.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter import JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter - globals()['JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter'] = JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter - - -class JsonApiWorkspaceDataFilterSettingInRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'workspace_data_filter': (JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'workspace_data_filter': 'workspaceDataFilter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - workspace_data_filter (JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - workspace_data_filter (JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter.py deleted file mode 100644 index 9752cd0dd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_to_one_linkage import JsonApiWorkspaceDataFilterToOneLinkage - globals()['JsonApiWorkspaceDataFilterToOneLinkage'] = JsonApiWorkspaceDataFilterToOneLinkage - - -class JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceDataFilterToOneLinkage,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterToOneLinkage): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_linkage.py deleted file mode 100644 index c8db6b4c1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiWorkspaceDataFilterSettingLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTERSETTING': "workspaceDataFilterSetting", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "workspaceDataFilterSetting", must be one of ["workspaceDataFilterSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "workspaceDataFilterSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "workspaceDataFilterSetting", must be one of ["workspaceDataFilterSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "workspaceDataFilterSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out.py deleted file mode 100644 index bd5981fdd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes - from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiWorkspaceDataFilterSettingInAttributes'] = JsonApiWorkspaceDataFilterSettingInAttributes - globals()['JsonApiWorkspaceDataFilterSettingInRelationships'] = JsonApiWorkspaceDataFilterSettingInRelationships - - -class JsonApiWorkspaceDataFilterSettingOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTERSETTING': "workspaceDataFilterSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceDataFilterSettingInAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiWorkspaceDataFilterSettingInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilterSetting", must be one of ["workspaceDataFilterSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterSettingInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterSettingInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilterSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilterSetting", must be one of ["workspaceDataFilterSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterSettingInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterSettingInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilterSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out.pyi index 50a5a3c26..e099578bd 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out.pyi @@ -41,50 +41,50 @@ class JsonApiWorkspaceDataFilterSettingOut( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACE_DATA_FILTER_SETTING(cls): return cls("workspaceDataFilterSetting") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class description( schemas.StrSchema ): pass - - + + class filterValues( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -95,11 +95,11 @@ class JsonApiWorkspaceDataFilterSettingOut( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class title( schemas.StrSchema ): @@ -109,40 +109,40 @@ class JsonApiWorkspaceDataFilterSettingOut( "filterValues": filterValues, "title": title, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["filterValues"]) -> MetaOapg.properties.filterValues: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "filterValues", "title", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["filterValues"]) -> typing.Union[MetaOapg.properties.filterValues, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "filterValues", "title", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -161,60 +161,60 @@ class JsonApiWorkspaceDataFilterSettingOut( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class workspaceDataFilter( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceDataFilterToOneLinkage']: return JsonApiWorkspaceDataFilterToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiWorkspaceDataFilterToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -232,28 +232,28 @@ class JsonApiWorkspaceDataFilterSettingOut( __annotations__ = { "workspaceDataFilter": workspaceDataFilter, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["workspaceDataFilter"]) -> MetaOapg.properties.workspaceDataFilter: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["workspaceDataFilter", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["workspaceDataFilter"]) -> typing.Union[MetaOapg.properties.workspaceDataFilter, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["workspaceDataFilter", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -274,48 +274,48 @@ class JsonApiWorkspaceDataFilterSettingOut( "attributes": attributes, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -338,4 +338,4 @@ class JsonApiWorkspaceDataFilterSettingOut( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_to_one_linkage import JsonApiWorkspaceDataFilterToOneLinkage +from gooddata_api_client.models.json_api_workspace_data_filter_to_one_linkage import JsonApiWorkspaceDataFilterToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.py deleted file mode 100644 index 8cf426cb8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks - from gooddata_api_client.model.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiWorkspaceDataFilterOutWithLinks'] = JsonApiWorkspaceDataFilterOutWithLinks - globals()['JsonApiWorkspaceDataFilterSettingOut'] = JsonApiWorkspaceDataFilterSettingOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiWorkspaceDataFilterSettingOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceDataFilterSettingOut,), # noqa: E501 - 'included': ([JsonApiWorkspaceDataFilterOutWithLinks],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterSettingOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceDataFilterOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterSettingOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceDataFilterOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.pyi index ba82cbcfc..103a7a2e5 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiWorkspaceDataFilterSettingOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceDataFilterSettingOut']: return JsonApiWorkspaceDataFilterSettingOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiWorkspaceDataFilterOutWithLinks']: return JsonApiWorkspaceDataFilterOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiWorkspaceDataFilterOutWithLinks'], typing.List['JsonApiWorkspaceDataFilterOutWithLinks']], @@ -67,10 +67,10 @@ class JsonApiWorkspaceDataFilterSettingOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiWorkspaceDataFilterOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiWorkspaceDataFilterSettingOutDocument( "included": included, "links": links, } - + data: 'JsonApiWorkspaceDataFilterSettingOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterSettingOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterSettingOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiWorkspaceDataFilterSettingOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_list.py deleted file mode 100644 index 74885e505..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_list.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks - from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiWorkspaceDataFilterOutWithLinks'] = JsonApiWorkspaceDataFilterOutWithLinks - globals()['JsonApiWorkspaceDataFilterSettingOutWithLinks'] = JsonApiWorkspaceDataFilterSettingOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiWorkspaceDataFilterSettingOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiWorkspaceDataFilterSettingOutWithLinks],), # noqa: E501 - 'included': ([JsonApiWorkspaceDataFilterOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingOutList - a model defined in OpenAPI - - Args: - data ([JsonApiWorkspaceDataFilterSettingOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceDataFilterOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingOutList - a model defined in OpenAPI - - Args: - data ([JsonApiWorkspaceDataFilterSettingOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceDataFilterOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_list.pyi index c392b4104..1001b0d43 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiWorkspaceDataFilterSettingOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiWorkspaceDataFilterSettingOutWithLinks']: return JsonApiWorkspaceDataFilterSettingOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiWorkspaceDataFilterSettingOutWithLinks'], typing.List['JsonApiWorkspaceDataFilterSettingOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiWorkspaceDataFilterSettingOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiWorkspaceDataFilterSettingOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiWorkspaceDataFilterOutWithLinks']: return JsonApiWorkspaceDataFilterOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiWorkspaceDataFilterOutWithLinks'], typing.List['JsonApiWorkspaceDataFilterOutWithLinks']], @@ -91,10 +91,10 @@ class JsonApiWorkspaceDataFilterSettingOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiWorkspaceDataFilterOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiWorkspaceDataFilterSettingOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,6 +158,6 @@ class JsonApiWorkspaceDataFilterSettingOutList( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_with_links.py deleted file mode 100644 index 6629fe693..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes - from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships - from gooddata_api_client.model.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiWorkspaceDataFilterSettingInAttributes'] = JsonApiWorkspaceDataFilterSettingInAttributes - globals()['JsonApiWorkspaceDataFilterSettingInRelationships'] = JsonApiWorkspaceDataFilterSettingInRelationships - globals()['JsonApiWorkspaceDataFilterSettingOut'] = JsonApiWorkspaceDataFilterSettingOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiWorkspaceDataFilterSettingOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTERSETTING': "workspaceDataFilterSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceDataFilterSettingInAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiWorkspaceDataFilterSettingInRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "workspaceDataFilterSetting", must be one of ["workspaceDataFilterSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterSettingInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterSettingInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilterSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "workspaceDataFilterSetting", must be one of ["workspaceDataFilterSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterSettingInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterSettingInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilterSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiWorkspaceDataFilterSettingOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_with_links.pyi index 87520d075..32a7ace20 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiWorkspaceDataFilterSettingOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiWorkspaceDataFilterSettingOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch.py deleted file mode 100644 index 461eced29..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes - from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships - globals()['JsonApiWorkspaceDataFilterSettingInAttributes'] = JsonApiWorkspaceDataFilterSettingInAttributes - globals()['JsonApiWorkspaceDataFilterSettingInRelationships'] = JsonApiWorkspaceDataFilterSettingInRelationships - - -class JsonApiWorkspaceDataFilterSettingPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTERSETTING': "workspaceDataFilterSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceDataFilterSettingInAttributes,), # noqa: E501 - 'relationships': (JsonApiWorkspaceDataFilterSettingInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilterSetting", must be one of ["workspaceDataFilterSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterSettingInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterSettingInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilterSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceDataFilterSetting", must be one of ["workspaceDataFilterSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceDataFilterSettingInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceDataFilterSettingInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceDataFilterSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch_document.py deleted file mode 100644 index b2b4aecf3..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch import JsonApiWorkspaceDataFilterSettingPatch - globals()['JsonApiWorkspaceDataFilterSettingPatch'] = JsonApiWorkspaceDataFilterSettingPatch - - -class JsonApiWorkspaceDataFilterSettingPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceDataFilterSettingPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterSettingPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterSettingPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceDataFilterSettingPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_to_many_linkage.py deleted file mode 100644 index dc2ebd7fb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_setting_linkage import JsonApiWorkspaceDataFilterSettingLinkage - globals()['JsonApiWorkspaceDataFilterSettingLinkage'] = JsonApiWorkspaceDataFilterSettingLinkage - - -class JsonApiWorkspaceDataFilterSettingToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiWorkspaceDataFilterSettingLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiWorkspaceDataFilterSettingToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiWorkspaceDataFilterSettingLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiWorkspaceDataFilterSettingLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiWorkspaceDataFilterSettingToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiWorkspaceDataFilterSettingLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiWorkspaceDataFilterSettingLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_to_many_linkage.pyi index ffe591b21..6b1ff49c3 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_to_many_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_to_many_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiWorkspaceDataFilterSettingToManyLinkage( class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiWorkspaceDataFilterSettingLinkage']: return JsonApiWorkspaceDataFilterSettingLinkage @@ -56,4 +56,4 @@ class JsonApiWorkspaceDataFilterSettingToManyLinkage( def __getitem__(self, i: int) -> 'JsonApiWorkspaceDataFilterSettingLinkage': return super().__getitem__(i) -from gooddata_api_client.model.json_api_workspace_data_filter_setting_linkage import JsonApiWorkspaceDataFilterSettingLinkage +from gooddata_api_client.models.json_api_workspace_data_filter_setting_linkage import JsonApiWorkspaceDataFilterSettingLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_many_linkage.py deleted file mode 100644 index da2271ea4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_many_linkage.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_linkage import JsonApiWorkspaceDataFilterLinkage - globals()['JsonApiWorkspaceDataFilterLinkage'] = JsonApiWorkspaceDataFilterLinkage - - -class JsonApiWorkspaceDataFilterToManyLinkage(ModelSimple): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': ([JsonApiWorkspaceDataFilterLinkage],), - } - - @cached_property - def discriminator(): - return None - - - attribute_map = {} - - read_only_vars = set() - - _composed_schemas = None - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """JsonApiWorkspaceDataFilterToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiWorkspaceDataFilterLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiWorkspaceDataFilterLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """JsonApiWorkspaceDataFilterToManyLinkage - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([JsonApiWorkspaceDataFilterLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - - Keyword Args: - value ([JsonApiWorkspaceDataFilterLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_one_linkage.py deleted file mode 100644 index 8123bc89c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_data_filter_linkage import JsonApiWorkspaceDataFilterLinkage - globals()['JsonApiWorkspaceDataFilterLinkage'] = JsonApiWorkspaceDataFilterLinkage - - -class JsonApiWorkspaceDataFilterToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACEDATAFILTER': "workspaceDataFilter", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "workspaceDataFilter" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceDataFilterToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "workspaceDataFilter" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiWorkspaceDataFilterLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_one_linkage.pyi index a890e7251..350b1860c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_one_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_one_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiWorkspaceDataFilterToOneLinkage( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -66,4 +66,4 @@ class JsonApiWorkspaceDataFilterToOneLinkage( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_data_filter_linkage import JsonApiWorkspaceDataFilterLinkage +from gooddata_api_client.models.json_api_workspace_data_filter_linkage import JsonApiWorkspaceDataFilterLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in.py deleted file mode 100644 index 5a466a969..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes - from gooddata_api_client.model.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships - globals()['JsonApiWorkspaceInAttributes'] = JsonApiWorkspaceInAttributes - globals()['JsonApiWorkspaceInRelationships'] = JsonApiWorkspaceInRelationships - - -class JsonApiWorkspaceIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACE': "workspace", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceInAttributes,), # noqa: E501 - 'relationships': (JsonApiWorkspaceInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in.pyi index c595eec50..a545ce4bb 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in.pyi @@ -41,54 +41,54 @@ class JsonApiWorkspaceIn( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACE(cls): return cls("workspace") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class description( schemas.StrSchema ): pass - - + + class earlyAccess( schemas.StrSchema ): pass - - + + class name( schemas.StrSchema ): pass - - + + class prefix( schemas.StrSchema ): @@ -99,46 +99,46 @@ class JsonApiWorkspaceIn( "name": name, "prefix": prefix, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["earlyAccess"]) -> MetaOapg.properties.earlyAccess: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["prefix"]) -> MetaOapg.properties.prefix: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "earlyAccess", "name", "prefix", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["earlyAccess"]) -> typing.Union[MetaOapg.properties.earlyAccess, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["prefix"]) -> typing.Union[MetaOapg.properties.prefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "earlyAccess", "name", "prefix", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -159,60 +159,60 @@ class JsonApiWorkspaceIn( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class parent( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceToOneLinkage']: return JsonApiWorkspaceToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiWorkspaceToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -230,28 +230,28 @@ class JsonApiWorkspaceIn( __annotations__ = { "parent": parent, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["parent"]) -> MetaOapg.properties.parent: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["parent", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["parent"]) -> typing.Union[MetaOapg.properties.parent, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["parent", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -272,48 +272,48 @@ class JsonApiWorkspaceIn( "attributes": attributes, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -336,4 +336,4 @@ class JsonApiWorkspaceIn( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage +from gooddata_api_client.models.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_attributes.py deleted file mode 100644 index 663da38c7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_attributes.py +++ /dev/null @@ -1,309 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_in_attributes_data_source import JsonApiWorkspaceInAttributesDataSource - globals()['JsonApiWorkspaceInAttributesDataSource'] = JsonApiWorkspaceInAttributesDataSource - - -class JsonApiWorkspaceInAttributes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('description',): { - 'max_length': 255, - }, - ('early_access',): { - 'max_length': 255, - }, - ('name',): { - 'max_length': 255, - }, - ('prefix',): { - 'max_length': 255, - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'cache_extra_limit': (int,), # noqa: E501 - 'data_source': (JsonApiWorkspaceInAttributesDataSource,), # noqa: E501 - 'description': (str, none_type,), # noqa: E501 - 'early_access': (str, none_type,), # noqa: E501 - 'early_access_values': ([str], none_type,), # noqa: E501 - 'name': (str, none_type,), # noqa: E501 - 'prefix': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'cache_extra_limit': 'cacheExtraLimit', # noqa: E501 - 'data_source': 'dataSource', # noqa: E501 - 'description': 'description', # noqa: E501 - 'early_access': 'earlyAccess', # noqa: E501 - 'early_access_values': 'earlyAccessValues', # noqa: E501 - 'name': 'name', # noqa: E501 - 'prefix': 'prefix', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_extra_limit (int): [optional] # noqa: E501 - data_source (JsonApiWorkspaceInAttributesDataSource): [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - early_access (str, none_type): The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.. [optional] # noqa: E501 - early_access_values ([str], none_type): The early access feature identifiers. They are used to enable experimental features.. [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - prefix (str, none_type): Custom prefix of entity identifiers in workspace. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceInAttributes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - cache_extra_limit (int): [optional] # noqa: E501 - data_source (JsonApiWorkspaceInAttributesDataSource): [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - early_access (str, none_type): The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.. [optional] # noqa: E501 - early_access_values ([str], none_type): The early access feature identifiers. They are used to enable experimental features.. [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - prefix (str, none_type): Custom prefix of entity identifiers in workspace. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_attributes_data_source.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_attributes_data_source.py deleted file mode 100644 index a5370a8c0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_attributes_data_source.py +++ /dev/null @@ -1,274 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiWorkspaceInAttributesDataSource(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'schema_path': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'schema_path': 'schemaPath', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceInAttributesDataSource - a model defined in OpenAPI - - Args: - id (str): The ID of the used data source. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - schema_path ([str]): The full schema path as array of its path parts. Will be rendered as subPath1.subPath2.... [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceInAttributesDataSource - a model defined in OpenAPI - - Args: - id (str): The ID of the used data source. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - schema_path ([str]): The full schema path as array of its path parts. Will be rendered as subPath1.subPath2.... [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_document.py deleted file mode 100644 index f29b24093..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_in import JsonApiWorkspaceIn - globals()['JsonApiWorkspaceIn'] = JsonApiWorkspaceIn - - -class JsonApiWorkspaceInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceInDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceInDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_document.pyi index c59080e37..253026fb8 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiWorkspaceInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceIn']: return JsonApiWorkspaceIn __annotations__ = { "data": data, } - + data: 'JsonApiWorkspaceIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiWorkspaceInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_in import JsonApiWorkspaceIn +from gooddata_api_client.models.json_api_workspace_in import JsonApiWorkspaceIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_relationships.py deleted file mode 100644 index 58a9be330..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_in_relationships.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_automation_out_relationships_workspace import JsonApiWorkspaceAutomationOutRelationshipsWorkspace - globals()['JsonApiWorkspaceAutomationOutRelationshipsWorkspace'] = JsonApiWorkspaceAutomationOutRelationshipsWorkspace - - -class JsonApiWorkspaceInRelationships(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'parent': (JsonApiWorkspaceAutomationOutRelationshipsWorkspace,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'parent': 'parent', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - parent (JsonApiWorkspaceAutomationOutRelationshipsWorkspace): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceInRelationships - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - parent (JsonApiWorkspaceAutomationOutRelationshipsWorkspace): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_linkage.py deleted file mode 100644 index dd1ca214a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_linkage.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiWorkspaceLinkage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACE': "workspace", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceLinkage - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - type (str): defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out.py deleted file mode 100644 index 65794d693..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes - from gooddata_api_client.model.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships - from gooddata_api_client.model.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta - globals()['JsonApiWorkspaceInAttributes'] = JsonApiWorkspaceInAttributes - globals()['JsonApiWorkspaceInRelationships'] = JsonApiWorkspaceInRelationships - globals()['JsonApiWorkspaceOutMeta'] = JsonApiWorkspaceOutMeta - - -class JsonApiWorkspaceOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACE': "workspace", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceInAttributes,), # noqa: E501 - 'meta': (JsonApiWorkspaceOutMeta,), # noqa: E501 - 'relationships': (JsonApiWorkspaceInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 - meta (JsonApiWorkspaceOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 - meta (JsonApiWorkspaceOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out.pyi index 55908c7c8..4f3fb0f3b 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out.pyi @@ -534,4 +534,4 @@ class JsonApiWorkspaceOut( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage +from gooddata_api_client.models.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_document.py deleted file mode 100644 index bf19ab726..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_document.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_out import JsonApiWorkspaceOut - from gooddata_api_client.model.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiWorkspaceOut'] = JsonApiWorkspaceOut - globals()['JsonApiWorkspaceOutWithLinks'] = JsonApiWorkspaceOutWithLinks - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiWorkspaceOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceOut,), # noqa: E501 - 'included': ([JsonApiWorkspaceOutWithLinks],), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_document.pyi index 5dd985fea..b7e0cff11 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_document.pyi @@ -38,25 +38,25 @@ class JsonApiWorkspaceOutDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceOut']: return JsonApiWorkspaceOut - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiWorkspaceOutWithLinks']: return JsonApiWorkspaceOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiWorkspaceOutWithLinks'], typing.List['JsonApiWorkspaceOutWithLinks']], @@ -67,10 +67,10 @@ class JsonApiWorkspaceOutDocument( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiWorkspaceOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks @@ -79,41 +79,41 @@ class JsonApiWorkspaceOutDocument( "included": included, "links": links, } - + data: 'JsonApiWorkspaceOut' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceOut': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceOut': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -134,6 +134,6 @@ class JsonApiWorkspaceOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_out import JsonApiWorkspaceOut -from gooddata_api_client.model.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_workspace_out import JsonApiWorkspaceOut +from gooddata_api_client.models.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_list.py deleted file mode 100644 index aaf1172b5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_list.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiWorkspaceOutWithLinks'] = JsonApiWorkspaceOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiWorkspaceOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - ('included',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiWorkspaceOutWithLinks],), # noqa: E501 - 'included': ([JsonApiWorkspaceOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'included': 'included', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutList - a model defined in OpenAPI - - Args: - data ([JsonApiWorkspaceOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutList - a model defined in OpenAPI - - Args: - data ([JsonApiWorkspaceOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - included ([JsonApiWorkspaceOutWithLinks]): Included resources. [optional] # noqa: E501 - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_list.pyi index adf0596e9..33b15a52d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiWorkspaceOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiWorkspaceOutWithLinks']: return JsonApiWorkspaceOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiWorkspaceOutWithLinks'], typing.List['JsonApiWorkspaceOutWithLinks']], @@ -65,22 +65,22 @@ class JsonApiWorkspaceOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiWorkspaceOutWithLinks': return super().__getitem__(i) - - + + class included( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiWorkspaceOutWithLinks']: return JsonApiWorkspaceOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiWorkspaceOutWithLinks'], typing.List['JsonApiWorkspaceOutWithLinks']], @@ -91,10 +91,10 @@ class JsonApiWorkspaceOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiWorkspaceOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -103,41 +103,41 @@ class JsonApiWorkspaceOutList( "included": included, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -158,5 +158,5 @@ class JsonApiWorkspaceOutList( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta.py deleted file mode 100644 index 5771a0633..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta.py +++ /dev/null @@ -1,297 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_out_meta_config import JsonApiWorkspaceOutMetaConfig - from gooddata_api_client.model.json_api_workspace_out_meta_data_model import JsonApiWorkspaceOutMetaDataModel - from gooddata_api_client.model.json_api_workspace_out_meta_hierarchy import JsonApiWorkspaceOutMetaHierarchy - globals()['JsonApiWorkspaceOutMetaConfig'] = JsonApiWorkspaceOutMetaConfig - globals()['JsonApiWorkspaceOutMetaDataModel'] = JsonApiWorkspaceOutMetaDataModel - globals()['JsonApiWorkspaceOutMetaHierarchy'] = JsonApiWorkspaceOutMetaHierarchy - - -class JsonApiWorkspaceOutMeta(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('permissions',): { - 'MANAGE': "MANAGE", - 'ANALYZE': "ANALYZE", - 'EXPORT': "EXPORT", - 'EXPORT_TABULAR': "EXPORT_TABULAR", - 'EXPORT_PDF': "EXPORT_PDF", - 'CREATE_AUTOMATION': "CREATE_AUTOMATION", - 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", - 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'config': (JsonApiWorkspaceOutMetaConfig,), # noqa: E501 - 'data_model': (JsonApiWorkspaceOutMetaDataModel,), # noqa: E501 - 'hierarchy': (JsonApiWorkspaceOutMetaHierarchy,), # noqa: E501 - 'permissions': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'config': 'config', # noqa: E501 - 'data_model': 'dataModel', # noqa: E501 - 'hierarchy': 'hierarchy', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - config (JsonApiWorkspaceOutMetaConfig): [optional] # noqa: E501 - data_model (JsonApiWorkspaceOutMetaDataModel): [optional] # noqa: E501 - hierarchy (JsonApiWorkspaceOutMetaHierarchy): [optional] # noqa: E501 - permissions ([str]): List of valid permissions for a logged-in user.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - config (JsonApiWorkspaceOutMetaConfig): [optional] # noqa: E501 - data_model (JsonApiWorkspaceOutMetaDataModel): [optional] # noqa: E501 - hierarchy (JsonApiWorkspaceOutMetaHierarchy): [optional] # noqa: E501 - permissions ([str]): List of valid permissions for a logged-in user.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta_config.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta_config.py deleted file mode 100644 index 01f7b6641..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta_config.py +++ /dev/null @@ -1,272 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiWorkspaceOutMetaConfig(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'approximate_count_available': (bool,), # noqa: E501 - 'data_sampling_available': (bool,), # noqa: E501 - 'show_all_values_on_dates_available': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'approximate_count_available': 'approximateCountAvailable', # noqa: E501 - 'data_sampling_available': 'dataSamplingAvailable', # noqa: E501 - 'show_all_values_on_dates_available': 'showAllValuesOnDatesAvailable', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutMetaConfig - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - approximate_count_available (bool): is approximate count enabled - based on type of data-source connected to this workspace. [optional] if omitted the server will use the default value of False # noqa: E501 - data_sampling_available (bool): is sampling enabled - based on type of data-source connected to this workspace. [optional] if omitted the server will use the default value of False # noqa: E501 - show_all_values_on_dates_available (bool): is 'show all values' displayed for dates - based on type of data-source connected to this workspace. [optional] if omitted the server will use the default value of False # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutMetaConfig - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - approximate_count_available (bool): is approximate count enabled - based on type of data-source connected to this workspace. [optional] if omitted the server will use the default value of False # noqa: E501 - data_sampling_available (bool): is sampling enabled - based on type of data-source connected to this workspace. [optional] if omitted the server will use the default value of False # noqa: E501 - show_all_values_on_dates_available (bool): is 'show all values' displayed for dates - based on type of data-source connected to this workspace. [optional] if omitted the server will use the default value of False # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta_data_model.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta_data_model.py deleted file mode 100644 index ec8c6f53e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta_data_model.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiWorkspaceOutMetaDataModel(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'dataset_count': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dataset_count': 'datasetCount', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dataset_count, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutMetaDataModel - a model defined in OpenAPI - - Args: - dataset_count (int): include the number of dataset of each workspace - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dataset_count = dataset_count - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dataset_count, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutMetaDataModel - a model defined in OpenAPI - - Args: - dataset_count (int): include the number of dataset of each workspace - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dataset_count = dataset_count - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta_hierarchy.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta_hierarchy.py deleted file mode 100644 index 0a3392cf9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta_hierarchy.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonApiWorkspaceOutMetaHierarchy(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'children_count': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'children_count': 'childrenCount', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, children_count, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutMetaHierarchy - a model defined in OpenAPI - - Args: - children_count (int): include the number of direct children of each workspace - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.children_count = children_count - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, children_count, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutMetaHierarchy - a model defined in OpenAPI - - Args: - children_count (int): include the number of direct children of each workspace - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.children_count = children_count - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_with_links.py deleted file mode 100644 index 9adfff6af..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_with_links.py +++ /dev/null @@ -1,361 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes - from gooddata_api_client.model.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships - from gooddata_api_client.model.json_api_workspace_out import JsonApiWorkspaceOut - from gooddata_api_client.model.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiWorkspaceInAttributes'] = JsonApiWorkspaceInAttributes - globals()['JsonApiWorkspaceInRelationships'] = JsonApiWorkspaceInRelationships - globals()['JsonApiWorkspaceOut'] = JsonApiWorkspaceOut - globals()['JsonApiWorkspaceOutMeta'] = JsonApiWorkspaceOutMeta - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiWorkspaceOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACE': "workspace", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceInAttributes,), # noqa: E501 - 'meta': (JsonApiWorkspaceOutMeta,), # noqa: E501 - 'relationships': (JsonApiWorkspaceInRelationships,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 - meta (JsonApiWorkspaceOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 - meta (JsonApiWorkspaceOutMeta): [optional] # noqa: E501 - relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiWorkspaceOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_with_links.pyi index d7aba1875..31d7d46bf 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiWorkspaceOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiWorkspaceOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_out import JsonApiWorkspaceOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_workspace_out import JsonApiWorkspaceOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch.py deleted file mode 100644 index 9a24ccc62..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes - from gooddata_api_client.model.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships - globals()['JsonApiWorkspaceInAttributes'] = JsonApiWorkspaceInAttributes - globals()['JsonApiWorkspaceInRelationships'] = JsonApiWorkspaceInRelationships - - -class JsonApiWorkspacePatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACE': "workspace", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceInAttributes,), # noqa: E501 - 'relationships': (JsonApiWorkspaceInRelationships,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspacePatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspacePatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 - relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch.pyi index e1c9a693c..a90e21755 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch.pyi @@ -41,54 +41,54 @@ class JsonApiWorkspacePatch( "id", "type", } - + class properties: - - + + class id( schemas.StrSchema ): pass - - + + class type( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACE(cls): return cls("workspace") - - + + class attributes( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class description( schemas.StrSchema ): pass - - + + class earlyAccess( schemas.StrSchema ): pass - - + + class name( schemas.StrSchema ): pass - - + + class prefix( schemas.StrSchema ): @@ -99,46 +99,46 @@ class JsonApiWorkspacePatch( "name": name, "prefix": prefix, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["earlyAccess"]) -> MetaOapg.properties.earlyAccess: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["prefix"]) -> MetaOapg.properties.prefix: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "earlyAccess", "name", "prefix", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["earlyAccess"]) -> typing.Union[MetaOapg.properties.earlyAccess, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["prefix"]) -> typing.Union[MetaOapg.properties.prefix, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "earlyAccess", "name", "prefix", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -159,60 +159,60 @@ class JsonApiWorkspacePatch( _configuration=_configuration, **kwargs, ) - - + + class relationships( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: - - + + class parent( schemas.DictSchema ): - - + + class MetaOapg: required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceToOneLinkage']: return JsonApiWorkspaceToOneLinkage __annotations__ = { "data": data, } - + data: 'JsonApiWorkspaceToOneLinkage' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceToOneLinkage': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceToOneLinkage': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -230,28 +230,28 @@ class JsonApiWorkspacePatch( __annotations__ = { "parent": parent, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["parent"]) -> MetaOapg.properties.parent: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["parent", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["parent"]) -> typing.Union[MetaOapg.properties.parent, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["parent", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -272,48 +272,48 @@ class JsonApiWorkspacePatch( "attributes": attributes, "relationships": relationships, } - + id: MetaOapg.properties.id type: MetaOapg.properties.type - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -336,4 +336,4 @@ class JsonApiWorkspacePatch( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage +from gooddata_api_client.models.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch_document.py deleted file mode 100644 index b75ecb199..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_patch import JsonApiWorkspacePatch - globals()['JsonApiWorkspacePatch'] = JsonApiWorkspacePatch - - -class JsonApiWorkspacePatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspacePatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspacePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspacePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspacePatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspacePatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch_document.pyi index f0eebe5b1..9343d606d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiWorkspacePatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspacePatch']: return JsonApiWorkspacePatch __annotations__ = { "data": data, } - + data: 'JsonApiWorkspacePatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspacePatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspacePatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiWorkspacePatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_patch import JsonApiWorkspacePatch +from gooddata_api_client.models.json_api_workspace_patch import JsonApiWorkspacePatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in.py deleted file mode 100644 index f86f1ac13..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - - -class JsonApiWorkspaceSettingIn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACESETTING': "workspaceSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceSetting", must be one of ["workspaceSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingIn - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceSetting", must be one of ["workspaceSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in_document.py deleted file mode 100644 index bb9d3b3d2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_setting_in import JsonApiWorkspaceSettingIn - globals()['JsonApiWorkspaceSettingIn'] = JsonApiWorkspaceSettingIn - - -class JsonApiWorkspaceSettingInDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceSettingIn,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingInDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceSettingIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingInDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceSettingIn): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in_document.pyi index e02d2b7bd..580331a7c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in_document.pyi @@ -38,38 +38,38 @@ class JsonApiWorkspaceSettingInDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceSettingIn']: return JsonApiWorkspaceSettingIn __annotations__ = { "data": data, } - + data: 'JsonApiWorkspaceSettingIn' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceSettingIn': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceSettingIn': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiWorkspaceSettingInDocument( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_setting_in import JsonApiWorkspaceSettingIn +from gooddata_api_client.models.json_api_workspace_setting_in import JsonApiWorkspaceSettingIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out.py deleted file mode 100644 index 91a07a48b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - - -class JsonApiWorkspaceSettingOut(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACESETTING': "workspaceSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceSetting", must be one of ["workspaceSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingOut - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceSetting", must be one of ["workspaceSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_document.py deleted file mode 100644 index 9d7259f8e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_document.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut - from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiWorkspaceSettingOut'] = JsonApiWorkspaceSettingOut - globals()['ObjectLinks'] = ObjectLinks - - -class JsonApiWorkspaceSettingOutDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceSettingOut,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceSettingOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingOutDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceSettingOut): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_document.pyi index 8b9e50ec6..140885136 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_document.pyi @@ -99,5 +99,5 @@ class JsonApiWorkspaceSettingOutDocument( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_list.py deleted file mode 100644 index 4ca5def2c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_list.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_workspace_setting_out_with_links import JsonApiWorkspaceSettingOutWithLinks - from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiWorkspaceSettingOutWithLinks'] = JsonApiWorkspaceSettingOutWithLinks - globals()['ListLinks'] = ListLinks - - -class JsonApiWorkspaceSettingOutList(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('data',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([JsonApiWorkspaceSettingOutWithLinks],), # noqa: E501 - 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingOutList - a model defined in OpenAPI - - Args: - data ([JsonApiWorkspaceSettingOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingOutList - a model defined in OpenAPI - - Args: - data ([JsonApiWorkspaceSettingOutWithLinks]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_list.pyi index 98ba7c7cf..fa97e015f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_list.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_list.pyi @@ -40,21 +40,21 @@ class JsonApiWorkspaceSettingOutList( required = { "data", } - + class properties: - - + + class data( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['JsonApiWorkspaceSettingOutWithLinks']: return JsonApiWorkspaceSettingOutWithLinks - + def __new__( cls, _arg: typing.Union[typing.Tuple['JsonApiWorkspaceSettingOutWithLinks'], typing.List['JsonApiWorkspaceSettingOutWithLinks']], @@ -65,10 +65,10 @@ class JsonApiWorkspaceSettingOutList( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'JsonApiWorkspaceSettingOutWithLinks': return super().__getitem__(i) - + @staticmethod def links() -> typing.Type['ListLinks']: return ListLinks @@ -76,35 +76,35 @@ class JsonApiWorkspaceSettingOutList( "data": data, "links": links, } - + data: MetaOapg.properties.data - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -123,5 +123,5 @@ class JsonApiWorkspaceSettingOutList( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_setting_out_with_links import JsonApiWorkspaceSettingOutWithLinks -from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.models.json_api_workspace_setting_out_with_links import JsonApiWorkspaceSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_with_links.py deleted file mode 100644 index e0fcec1e5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_with_links.py +++ /dev/null @@ -1,355 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - from gooddata_api_client.model.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut - from gooddata_api_client.model.object_links import ObjectLinks - from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - globals()['JsonApiWorkspaceSettingOut'] = JsonApiWorkspaceSettingOut - globals()['ObjectLinks'] = ObjectLinks - globals()['ObjectLinksContainer'] = ObjectLinksContainer - - -class JsonApiWorkspaceSettingOutWithLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACESETTING': "workspaceSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'meta': 'meta', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "workspaceSetting", must be one of ["workspaceSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingOutWithLinks - a model defined in OpenAPI - - Keyword Args: - id (str): API identifier of an object - type (str): Object type. defaults to "workspaceSetting", must be one of ["workspaceSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - links (ObjectLinks): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - JsonApiWorkspaceSettingOut, - ObjectLinksContainer, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_with_links.pyi index 5958d2a0c..c873e7ab3 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_with_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_with_links.pyi @@ -35,7 +35,7 @@ class JsonApiWorkspaceSettingOutWithLinks( class MetaOapg: - + @classmethod @functools.lru_cache() def all_of(cls): @@ -65,5 +65,5 @@ class JsonApiWorkspaceSettingOutWithLinks( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut -from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut +from gooddata_api_client.models.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch.py deleted file mode 100644 index 8c7fb324b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - - -class JsonApiWorkspaceSettingPatch(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACESETTING': "workspaceSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceSetting", must be one of ["workspaceSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingPatch - a model defined in OpenAPI - - Args: - id (str): API identifier of an object - - Keyword Args: - type (str): Object type. defaults to "workspaceSetting", must be one of ["workspaceSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch_document.py deleted file mode 100644 index e72c1d82c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_setting_patch import JsonApiWorkspaceSettingPatch - globals()['JsonApiWorkspaceSettingPatch'] = JsonApiWorkspaceSettingPatch - - -class JsonApiWorkspaceSettingPatchDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceSettingPatch,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceSettingPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingPatchDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceSettingPatch): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch_document.pyi index 991c6c122..3b1e17cb8 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch_document.pyi @@ -38,38 +38,38 @@ class JsonApiWorkspaceSettingPatchDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceSettingPatch']: return JsonApiWorkspaceSettingPatch __annotations__ = { "data": data, } - + data: 'JsonApiWorkspaceSettingPatch' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceSettingPatch': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceSettingPatch': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiWorkspaceSettingPatchDocument( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_setting_patch import JsonApiWorkspaceSettingPatch +from gooddata_api_client.models.json_api_workspace_setting_patch import JsonApiWorkspaceSettingPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id.py deleted file mode 100644 index 1e88a7caf..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes - - -class JsonApiWorkspaceSettingPostOptionalId(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACESETTING': "workspaceSetting", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingPostOptionalId - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): Object type. defaults to "workspaceSetting", must be one of ["workspaceSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingPostOptionalId - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): Object type. defaults to "workspaceSetting", must be one of ["workspaceSetting", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 - id (str): API identifier of an object. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "workspaceSetting") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id_document.py deleted file mode 100644 index acb9e3a9c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id_document.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_setting_post_optional_id import JsonApiWorkspaceSettingPostOptionalId - globals()['JsonApiWorkspaceSettingPostOptionalId'] = JsonApiWorkspaceSettingPostOptionalId - - -class JsonApiWorkspaceSettingPostOptionalIdDocument(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiWorkspaceSettingPostOptionalId,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceSettingPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceSettingPostOptionalIdDocument - a model defined in OpenAPI - - Args: - data (JsonApiWorkspaceSettingPostOptionalId): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id_document.pyi index ec7cda4a5..8b51cbd6a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id_document.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id_document.pyi @@ -38,38 +38,38 @@ class JsonApiWorkspaceSettingPostOptionalIdDocument( required = { "data", } - + class properties: - + @staticmethod def data() -> typing.Type['JsonApiWorkspaceSettingPostOptionalId']: return JsonApiWorkspaceSettingPostOptionalId __annotations__ = { "data": data, } - + data: 'JsonApiWorkspaceSettingPostOptionalId' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceSettingPostOptionalId': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceSettingPostOptionalId': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class JsonApiWorkspaceSettingPostOptionalIdDocument( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id import JsonApiWorkspaceSettingPostOptionalId +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id import JsonApiWorkspaceSettingPostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_to_one_linkage.py deleted file mode 100644 index c7354fee0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_to_one_linkage.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_api_workspace_linkage import JsonApiWorkspaceLinkage - globals()['JsonApiWorkspaceLinkage'] = JsonApiWorkspaceLinkage - - -class JsonApiWorkspaceToOneLinkage(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACE': "workspace", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "workspace" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiWorkspaceToOneLinkage - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "workspace" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - JsonApiWorkspaceLinkage, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_to_one_linkage.pyi index 34ffa6daf..7ab0d39da 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_to_one_linkage.pyi +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_to_one_linkage.pyi @@ -37,7 +37,7 @@ class JsonApiWorkspaceToOneLinkage( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -66,4 +66,4 @@ class JsonApiWorkspaceToOneLinkage( **kwargs, ) -from gooddata_api_client.model.json_api_workspace_linkage import JsonApiWorkspaceLinkage +from gooddata_api_client.models.json_api_workspace_linkage import JsonApiWorkspaceLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_node.py b/gooddata-api-client/gooddata_api_client/model/json_node.py deleted file mode 100644 index 92e6feae1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/json_node.py +++ /dev/null @@ -1,262 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class JsonNode(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('value',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonNode - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """JsonNode - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.py b/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.py deleted file mode 100644 index 389692cf7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.py +++ /dev/null @@ -1,334 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_format import AttributeFormat - from gooddata_api_client.model.rest_api_identifier import RestApiIdentifier - globals()['AttributeFormat'] = AttributeFormat - globals()['RestApiIdentifier'] = RestApiIdentifier - - -class KeyDriversDimension(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularity',): { - 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", - 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", - 'HOUR_OF_DAY': "HOUR_OF_DAY", - 'DAY_OF_WEEK': "DAY_OF_WEEK", - 'DAY_OF_MONTH': "DAY_OF_MONTH", - 'DAY_OF_QUARTER': "DAY_OF_QUARTER", - 'DAY_OF_YEAR': "DAY_OF_YEAR", - 'WEEK_OF_YEAR': "WEEK_OF_YEAR", - 'MONTH_OF_YEAR': "MONTH_OF_YEAR", - 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", - }, - ('value_type',): { - 'TEXT': "TEXT", - 'HYPERLINK': "HYPERLINK", - 'GEO': "GEO", - 'GEO_LONGITUDE': "GEO_LONGITUDE", - 'GEO_LATITUDE': "GEO_LATITUDE", - 'IMAGE': "IMAGE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute': (RestApiIdentifier,), # noqa: E501 - 'attribute_name': (str,), # noqa: E501 - 'label': (RestApiIdentifier,), # noqa: E501 - 'label_name': (str,), # noqa: E501 - 'format': (AttributeFormat,), # noqa: E501 - 'granularity': (str,), # noqa: E501 - 'value_type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute': 'attribute', # noqa: E501 - 'attribute_name': 'attributeName', # noqa: E501 - 'label': 'label', # noqa: E501 - 'label_name': 'labelName', # noqa: E501 - 'format': 'format', # noqa: E501 - 'granularity': 'granularity', # noqa: E501 - 'value_type': 'valueType', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute, attribute_name, label, label_name, *args, **kwargs): # noqa: E501 - """KeyDriversDimension - a model defined in OpenAPI - - Args: - attribute (RestApiIdentifier): - attribute_name (str): - label (RestApiIdentifier): - label_name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (AttributeFormat): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - value_type (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - self.attribute_name = attribute_name - self.label = label - self.label_name = label_name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attribute, attribute_name, label, label_name, *args, **kwargs): # noqa: E501 - """KeyDriversDimension - a model defined in OpenAPI - - Args: - attribute (RestApiIdentifier): - attribute_name (str): - label (RestApiIdentifier): - label_name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (AttributeFormat): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - value_type (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - self.attribute_name = attribute_name - self.label = label - self.label_name = label_name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/key_drivers_request.py b/gooddata-api-client/gooddata_api_client/model/key_drivers_request.py deleted file mode 100644 index 1941f1963..000000000 --- a/gooddata-api-client/gooddata_api_client/model/key_drivers_request.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.measure_item import MeasureItem - globals()['MeasureItem'] = MeasureItem - - -class KeyDriversRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('sort_direction',): { - 'ASC': "ASC", - 'DESC': "DESC", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'metric': (MeasureItem,), # noqa: E501 - 'aux_metrics': ([MeasureItem],), # noqa: E501 - 'sort_direction': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'metric': 'metric', # noqa: E501 - 'aux_metrics': 'auxMetrics', # noqa: E501 - 'sort_direction': 'sortDirection', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, metric, *args, **kwargs): # noqa: E501 - """KeyDriversRequest - a model defined in OpenAPI - - Args: - metric (MeasureItem): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aux_metrics ([MeasureItem]): Additional metrics to be included in the computation, but excluded from the analysis.. [optional] # noqa: E501 - sort_direction (str): Sorting elements - ascending/descending order.. [optional] if omitted the server will use the default value of "DESC" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.metric = metric - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, metric, *args, **kwargs): # noqa: E501 - """KeyDriversRequest - a model defined in OpenAPI - - Args: - metric (MeasureItem): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aux_metrics ([MeasureItem]): Additional metrics to be included in the computation, but excluded from the analysis.. [optional] # noqa: E501 - sort_direction (str): Sorting elements - ascending/descending order.. [optional] if omitted the server will use the default value of "DESC" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.metric = metric - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/key_drivers_response.py b/gooddata-api-client/gooddata_api_client/model/key_drivers_response.py deleted file mode 100644 index 8c4052808..000000000 --- a/gooddata-api-client/gooddata_api_client/model/key_drivers_response.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.execution_links import ExecutionLinks - from gooddata_api_client.model.key_drivers_dimension import KeyDriversDimension - globals()['ExecutionLinks'] = ExecutionLinks - globals()['KeyDriversDimension'] = KeyDriversDimension - - -class KeyDriversResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dimensions': ([KeyDriversDimension],), # noqa: E501 - 'links': (ExecutionLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dimensions': 'dimensions', # noqa: E501 - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dimensions, links, *args, **kwargs): # noqa: E501 - """KeyDriversResponse - a model defined in OpenAPI - - Args: - dimensions ([KeyDriversDimension]): - links (ExecutionLinks): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dimensions = dimensions - self.links = links - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dimensions, links, *args, **kwargs): # noqa: E501 - """KeyDriversResponse - a model defined in OpenAPI - - Args: - dimensions ([KeyDriversDimension]): - links (ExecutionLinks): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dimensions = dimensions - self.links = links - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/key_drivers_result.py b/gooddata-api-client/gooddata_api_client/model/key_drivers_result.py deleted file mode 100644 index 4b3fd604f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/key_drivers_result.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class KeyDriversResult(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'data': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """KeyDriversResult - a model defined in OpenAPI - - Args: - data ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """KeyDriversResult - a model defined in OpenAPI - - Args: - data ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/label_identifier.py b/gooddata-api-client/gooddata_api_client/model/label_identifier.py deleted file mode 100644 index ee9cff094..000000000 --- a/gooddata-api-client/gooddata_api_client/model/label_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class LabelIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'LABEL': "label", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """LabelIdentifier - a model defined in OpenAPI - - Args: - id (str): Label ID. - - Keyword Args: - type (str): A type of the label.. defaults to "label", must be one of ["label", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "label") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """LabelIdentifier - a model defined in OpenAPI - - Args: - id (str): Label ID. - - Keyword Args: - type (str): A type of the label.. defaults to "label", must be one of ["label", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "label") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/list_links.py b/gooddata-api-client/gooddata_api_client/model/list_links.py deleted file mode 100644 index 13b32bdc8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/list_links.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.list_links_all_of import ListLinksAllOf - from gooddata_api_client.model.object_links import ObjectLinks - globals()['ListLinksAllOf'] = ListLinksAllOf - globals()['ObjectLinks'] = ObjectLinks - - -class ListLinks(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - '_self': (str,), # noqa: E501 - 'next': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - '_self': 'self', # noqa: E501 - 'next': 'next', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ListLinks - a model defined in OpenAPI - - Keyword Args: - _self (str): A string containing the link's URL. - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - next (str): A string containing the link's URL for the next page of data.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ListLinks - a model defined in OpenAPI - - Keyword Args: - _self (str): A string containing the link's URL. - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - next (str): A string containing the link's URL for the next page of data.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ListLinksAllOf, - ObjectLinks, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/list_links.pyi b/gooddata-api-client/gooddata_api_client/model/list_links.pyi index 0431ec3e3..9a5581241 100644 --- a/gooddata-api-client/gooddata_api_client/model/list_links.pyi +++ b/gooddata-api-client/gooddata_api_client/model/list_links.pyi @@ -35,42 +35,42 @@ class ListLinks( class MetaOapg: - - + + class all_of_1( schemas.DictSchema ): - - + + class MetaOapg: - + class properties: next = schemas.StrSchema __annotations__ = { "next": next, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["next"]) -> MetaOapg.properties.next: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["next", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["next"]) -> typing.Union[MetaOapg.properties.next, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["next", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -85,7 +85,7 @@ class ListLinks( _configuration=_configuration, **kwargs, ) - + @classmethod @functools.lru_cache() def all_of(cls): @@ -115,4 +115,4 @@ class ListLinks( **kwargs, ) -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/list_links_all_of.py b/gooddata-api-client/gooddata_api_client/model/list_links_all_of.py deleted file mode 100644 index b309bc22b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/list_links_all_of.py +++ /dev/null @@ -1,264 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ListLinksAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'next': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'next': 'next', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ListLinksAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - next (str): A string containing the link's URL for the next page of data.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ListLinksAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - next (str): A string containing the link's URL for the next page of data.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/local_identifier.py b/gooddata-api-client/gooddata_api_client/model/local_identifier.py deleted file mode 100644 index 5a5313c68..000000000 --- a/gooddata-api-client/gooddata_api_client/model/local_identifier.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class LocalIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('format',): { - 'max_length': 2048, - }, - ('title',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'local_identifier': (str,), # noqa: E501 - 'format': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'local_identifier': 'localIdentifier', # noqa: E501 - 'format': 'format', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, local_identifier, *args, **kwargs): # noqa: E501 - """LocalIdentifier - a model defined in OpenAPI - - Args: - local_identifier (str): Local identifier of the metric to be compared. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (str, none_type): Metric format.. [optional] if omitted the server will use the default value of "#,##0.00" # noqa: E501 - title (str, none_type): Metric title.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, local_identifier, *args, **kwargs): # noqa: E501 - """LocalIdentifier - a model defined in OpenAPI - - Args: - local_identifier (str): Local identifier of the metric to be compared. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (str, none_type): Metric format.. [optional] if omitted the server will use the default value of "#,##0.00" # noqa: E501 - title (str, none_type): Metric title.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/locale_request.py b/gooddata-api-client/gooddata_api_client/model/locale_request.py deleted file mode 100644 index dae7d1eed..000000000 --- a/gooddata-api-client/gooddata_api_client/model/locale_request.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class LocaleRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'locale': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'locale': 'locale', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, locale, *args, **kwargs): # noqa: E501 - """LocaleRequest - a model defined in OpenAPI - - Args: - locale (str): Requested locale in the form of language tag (see RFC 5646). - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.locale = locale - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, locale, *args, **kwargs): # noqa: E501 - """LocaleRequest - a model defined in OpenAPI - - Args: - locale (str): Requested locale in the form of language tag (see RFC 5646). - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.locale = locale - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/manage_dashboard_permissions_request_inner.py b/gooddata-api-client/gooddata_api_client/model/manage_dashboard_permissions_request_inner.py deleted file mode 100644 index 72b4aa6ad..000000000 --- a/gooddata-api-client/gooddata_api_client/model/manage_dashboard_permissions_request_inner.py +++ /dev/null @@ -1,340 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - from gooddata_api_client.model.assignee_rule import AssigneeRule - from gooddata_api_client.model.permissions_for_assignee import PermissionsForAssignee - from gooddata_api_client.model.permissions_for_assignee_rule import PermissionsForAssigneeRule - globals()['AssigneeIdentifier'] = AssigneeIdentifier - globals()['AssigneeRule'] = AssigneeRule - globals()['PermissionsForAssignee'] = PermissionsForAssignee - globals()['PermissionsForAssigneeRule'] = PermissionsForAssigneeRule - - -class ManageDashboardPermissionsRequestInner(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('permissions',): { - 'EDIT': "EDIT", - 'SHARE': "SHARE", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'permissions': ([str],), # noqa: E501 - 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 - 'assignee_rule': (AssigneeRule,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'permissions': 'permissions', # noqa: E501 - 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 - 'assignee_rule': 'assigneeRule', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ManageDashboardPermissionsRequestInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([str]): [optional] # noqa: E501 - assignee_identifier (AssigneeIdentifier): [optional] # noqa: E501 - assignee_rule (AssigneeRule): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ManageDashboardPermissionsRequestInner - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([str]): [optional] # noqa: E501 - assignee_identifier (AssigneeIdentifier): [optional] # noqa: E501 - assignee_rule (AssigneeRule): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - PermissionsForAssignee, - PermissionsForAssigneeRule, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/measure_definition.py b/gooddata-api-client/gooddata_api_client/model/measure_definition.py deleted file mode 100644 index e7d2b88db..000000000 --- a/gooddata-api-client/gooddata_api_client/model/measure_definition.py +++ /dev/null @@ -1,355 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.arithmetic_measure_definition import ArithmeticMeasureDefinition - from gooddata_api_client.model.arithmetic_measure_definition_arithmetic_measure import ArithmeticMeasureDefinitionArithmeticMeasure - from gooddata_api_client.model.inline_measure_definition import InlineMeasureDefinition - from gooddata_api_client.model.inline_measure_definition_inline import InlineMeasureDefinitionInline - from gooddata_api_client.model.pop_dataset_measure_definition_previous_period_measure import PopDatasetMeasureDefinitionPreviousPeriodMeasure - from gooddata_api_client.model.pop_date_measure_definition_over_period_measure import PopDateMeasureDefinitionOverPeriodMeasure - from gooddata_api_client.model.pop_measure_definition import PopMeasureDefinition - from gooddata_api_client.model.simple_measure_definition import SimpleMeasureDefinition - from gooddata_api_client.model.simple_measure_definition_measure import SimpleMeasureDefinitionMeasure - globals()['ArithmeticMeasureDefinition'] = ArithmeticMeasureDefinition - globals()['ArithmeticMeasureDefinitionArithmeticMeasure'] = ArithmeticMeasureDefinitionArithmeticMeasure - globals()['InlineMeasureDefinition'] = InlineMeasureDefinition - globals()['InlineMeasureDefinitionInline'] = InlineMeasureDefinitionInline - globals()['PopDatasetMeasureDefinitionPreviousPeriodMeasure'] = PopDatasetMeasureDefinitionPreviousPeriodMeasure - globals()['PopDateMeasureDefinitionOverPeriodMeasure'] = PopDateMeasureDefinitionOverPeriodMeasure - globals()['PopMeasureDefinition'] = PopMeasureDefinition - globals()['SimpleMeasureDefinition'] = SimpleMeasureDefinition - globals()['SimpleMeasureDefinitionMeasure'] = SimpleMeasureDefinitionMeasure - - -class MeasureDefinition(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'inline': (InlineMeasureDefinitionInline,), # noqa: E501 - 'arithmetic_measure': (ArithmeticMeasureDefinitionArithmeticMeasure,), # noqa: E501 - 'measure': (SimpleMeasureDefinitionMeasure,), # noqa: E501 - 'previous_period_measure': (PopDatasetMeasureDefinitionPreviousPeriodMeasure,), # noqa: E501 - 'over_period_measure': (PopDateMeasureDefinitionOverPeriodMeasure,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'inline': 'inline', # noqa: E501 - 'arithmetic_measure': 'arithmeticMeasure', # noqa: E501 - 'measure': 'measure', # noqa: E501 - 'previous_period_measure': 'previousPeriodMeasure', # noqa: E501 - 'over_period_measure': 'overPeriodMeasure', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """MeasureDefinition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - inline (InlineMeasureDefinitionInline): [optional] # noqa: E501 - arithmetic_measure (ArithmeticMeasureDefinitionArithmeticMeasure): [optional] # noqa: E501 - measure (SimpleMeasureDefinitionMeasure): [optional] # noqa: E501 - previous_period_measure (PopDatasetMeasureDefinitionPreviousPeriodMeasure): [optional] # noqa: E501 - over_period_measure (PopDateMeasureDefinitionOverPeriodMeasure): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """MeasureDefinition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - inline (InlineMeasureDefinitionInline): [optional] # noqa: E501 - arithmetic_measure (ArithmeticMeasureDefinitionArithmeticMeasure): [optional] # noqa: E501 - measure (SimpleMeasureDefinitionMeasure): [optional] # noqa: E501 - previous_period_measure (PopDatasetMeasureDefinitionPreviousPeriodMeasure): [optional] # noqa: E501 - over_period_measure (PopDateMeasureDefinitionOverPeriodMeasure): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - ArithmeticMeasureDefinition, - InlineMeasureDefinition, - PopMeasureDefinition, - SimpleMeasureDefinition, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/measure_definition.pyi b/gooddata-api-client/gooddata_api_client/model/measure_definition.pyi index 6ccc80197..8c5d534dc 100644 --- a/gooddata-api-client/gooddata_api_client/model/measure_definition.pyi +++ b/gooddata-api-client/gooddata_api_client/model/measure_definition.pyi @@ -38,7 +38,7 @@ class MeasureDefinition( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -70,7 +70,7 @@ class MeasureDefinition( **kwargs, ) -from gooddata_api_client.model.arithmetic_measure_definition import ArithmeticMeasureDefinition -from gooddata_api_client.model.inline_measure_definition import InlineMeasureDefinition -from gooddata_api_client.model.pop_measure_definition import PopMeasureDefinition -from gooddata_api_client.model.simple_measure_definition import SimpleMeasureDefinition +from gooddata_api_client.models.arithmetic_measure_definition import ArithmeticMeasureDefinition +from gooddata_api_client.models.inline_measure_definition import InlineMeasureDefinition +from gooddata_api_client.models.pop_measure_definition import PopMeasureDefinition +from gooddata_api_client.models.simple_measure_definition import SimpleMeasureDefinition diff --git a/gooddata-api-client/gooddata_api_client/model/measure_execution_result_header.py b/gooddata-api-client/gooddata_api_client/model/measure_execution_result_header.py deleted file mode 100644 index cd6c98894..000000000 --- a/gooddata-api-client/gooddata_api_client/model/measure_execution_result_header.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.measure_result_header import MeasureResultHeader - globals()['MeasureResultHeader'] = MeasureResultHeader - - -class MeasureExecutionResultHeader(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'measure_header': (MeasureResultHeader,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'measure_header': 'measureHeader', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, measure_header, *args, **kwargs): # noqa: E501 - """MeasureExecutionResultHeader - a model defined in OpenAPI - - Args: - measure_header (MeasureResultHeader): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure_header = measure_header - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, measure_header, *args, **kwargs): # noqa: E501 - """MeasureExecutionResultHeader - a model defined in OpenAPI - - Args: - measure_header (MeasureResultHeader): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure_header = measure_header - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/measure_execution_result_header.pyi b/gooddata-api-client/gooddata_api_client/model/measure_execution_result_header.pyi index 0194c95d5..d00953396 100644 --- a/gooddata-api-client/gooddata_api_client/model/measure_execution_result_header.pyi +++ b/gooddata-api-client/gooddata_api_client/model/measure_execution_result_header.pyi @@ -86,4 +86,4 @@ class MeasureExecutionResultHeader( **kwargs, ) -from gooddata_api_client.model.measure_result_header import MeasureResultHeader +from gooddata_api_client.models.measure_result_header import MeasureResultHeader diff --git a/gooddata-api-client/gooddata_api_client/model/measure_group_headers.py b/gooddata-api-client/gooddata_api_client/model/measure_group_headers.py deleted file mode 100644 index 9bbe6d2fa..000000000 --- a/gooddata-api-client/gooddata_api_client/model/measure_group_headers.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.measure_header import MeasureHeader - globals()['MeasureHeader'] = MeasureHeader - - -class MeasureGroupHeaders(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'measure_group_headers': ([MeasureHeader],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'measure_group_headers': 'measureGroupHeaders', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """MeasureGroupHeaders - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - measure_group_headers ([MeasureHeader]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """MeasureGroupHeaders - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - measure_group_headers ([MeasureHeader]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/measure_group_headers.pyi b/gooddata-api-client/gooddata_api_client/model/measure_group_headers.pyi index b841b735d..8e800280e 100644 --- a/gooddata-api-client/gooddata_api_client/model/measure_group_headers.pyi +++ b/gooddata-api-client/gooddata_api_client/model/measure_group_headers.pyi @@ -103,4 +103,4 @@ class MeasureGroupHeaders( **kwargs, ) -from gooddata_api_client.model.measure_header_out import MeasureHeaderOut +from gooddata_api_client.models.measure_header_out import MeasureHeaderOut diff --git a/gooddata-api-client/gooddata_api_client/model/measure_header.py b/gooddata-api-client/gooddata_api_client/model/measure_header.py deleted file mode 100644 index 11d216cbd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/measure_header.py +++ /dev/null @@ -1,278 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class MeasureHeader(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'local_identifier': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'local_identifier': 'localIdentifier', # noqa: E501 - 'format': 'format', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, local_identifier, *args, **kwargs): # noqa: E501 - """MeasureHeader - a model defined in OpenAPI - - Args: - local_identifier (str): Local identifier of the measure this header relates to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (str): Format to be used to format the measure data.. [optional] # noqa: E501 - name (str): Name of the measure.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, local_identifier, *args, **kwargs): # noqa: E501 - """MeasureHeader - a model defined in OpenAPI - - Args: - local_identifier (str): Local identifier of the measure this header relates to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - format (str): Format to be used to format the measure data.. [optional] # noqa: E501 - name (str): Name of the measure.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/measure_item.py b/gooddata-api-client/gooddata_api_client/model/measure_item.py deleted file mode 100644 index aa26f1814..000000000 --- a/gooddata-api-client/gooddata_api_client/model/measure_item.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.measure_item_definition import MeasureItemDefinition - globals()['MeasureItemDefinition'] = MeasureItemDefinition - - -class MeasureItem(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('local_identifier',): { - 'regex': { - 'pattern': r'^[.a-zA-Z0-9_-]+$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'definition': (MeasureItemDefinition,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'definition': 'definition', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, definition, local_identifier, *args, **kwargs): # noqa: E501 - """MeasureItem - a model defined in OpenAPI - - Args: - definition (MeasureItemDefinition): - local_identifier (str): Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.definition = definition - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, definition, local_identifier, *args, **kwargs): # noqa: E501 - """MeasureItem - a model defined in OpenAPI - - Args: - definition (MeasureItemDefinition): - local_identifier (str): Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.definition = definition - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/measure_item.pyi b/gooddata-api-client/gooddata_api_client/model/measure_item.pyi index 049a467c1..5414b6896 100644 --- a/gooddata-api-client/gooddata_api_client/model/measure_item.pyi +++ b/gooddata-api-client/gooddata_api_client/model/measure_item.pyi @@ -39,14 +39,14 @@ class MeasureItem( "localIdentifier", "definition", } - + class properties: - + @staticmethod def definition() -> typing.Type['MeasureDefinition']: return MeasureDefinition - - + + class localIdentifier( schemas.StrSchema ): @@ -55,36 +55,36 @@ class MeasureItem( "definition": definition, "localIdentifier": localIdentifier, } - + localIdentifier: MetaOapg.properties.localIdentifier definition: 'MeasureDefinition' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["definition"]) -> 'MeasureDefinition': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["definition", "localIdentifier", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["definition"]) -> 'MeasureDefinition': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["definition", "localIdentifier", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -103,4 +103,4 @@ class MeasureItem( **kwargs, ) -from gooddata_api_client.model.measure_definition import MeasureDefinition +from gooddata_api_client.models.measure_definition import MeasureDefinition diff --git a/gooddata-api-client/gooddata_api_client/model/measure_item_definition.py b/gooddata-api-client/gooddata_api_client/model/measure_item_definition.py deleted file mode 100644 index b6def417f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/measure_item_definition.py +++ /dev/null @@ -1,354 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.arithmetic_measure_definition import ArithmeticMeasureDefinition - from gooddata_api_client.model.arithmetic_measure_definition_arithmetic_measure import ArithmeticMeasureDefinitionArithmeticMeasure - from gooddata_api_client.model.inline_measure_definition import InlineMeasureDefinition - from gooddata_api_client.model.inline_measure_definition_inline import InlineMeasureDefinitionInline - from gooddata_api_client.model.pop_dataset_measure_definition import PopDatasetMeasureDefinition - from gooddata_api_client.model.pop_dataset_measure_definition_previous_period_measure import PopDatasetMeasureDefinitionPreviousPeriodMeasure - from gooddata_api_client.model.pop_date_measure_definition import PopDateMeasureDefinition - from gooddata_api_client.model.pop_date_measure_definition_over_period_measure import PopDateMeasureDefinitionOverPeriodMeasure - from gooddata_api_client.model.pop_measure_definition import PopMeasureDefinition - from gooddata_api_client.model.simple_measure_definition import SimpleMeasureDefinition - from gooddata_api_client.model.simple_measure_definition_measure import SimpleMeasureDefinitionMeasure - globals()['ArithmeticMeasureDefinition'] = ArithmeticMeasureDefinition - globals()['ArithmeticMeasureDefinitionArithmeticMeasure'] = ArithmeticMeasureDefinitionArithmeticMeasure - globals()['InlineMeasureDefinition'] = InlineMeasureDefinition - globals()['InlineMeasureDefinitionInline'] = InlineMeasureDefinitionInline - globals()['PopDatasetMeasureDefinition'] = PopDatasetMeasureDefinition - globals()['PopDatasetMeasureDefinitionPreviousPeriodMeasure'] = PopDatasetMeasureDefinitionPreviousPeriodMeasure - globals()['PopDateMeasureDefinition'] = PopDateMeasureDefinition - globals()['PopDateMeasureDefinitionOverPeriodMeasure'] = PopDateMeasureDefinitionOverPeriodMeasure - globals()['PopMeasureDefinition'] = PopMeasureDefinition - globals()['SimpleMeasureDefinition'] = SimpleMeasureDefinition - globals()['SimpleMeasureDefinitionMeasure'] = SimpleMeasureDefinitionMeasure - - -class MeasureItemDefinition(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'arithmetic_measure': (ArithmeticMeasureDefinitionArithmeticMeasure,), # noqa: E501 - 'inline': (InlineMeasureDefinitionInline,), # noqa: E501 - 'previous_period_measure': (PopDatasetMeasureDefinitionPreviousPeriodMeasure,), # noqa: E501 - 'over_period_measure': (PopDateMeasureDefinitionOverPeriodMeasure,), # noqa: E501 - 'measure': (SimpleMeasureDefinitionMeasure,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'arithmetic_measure': 'arithmeticMeasure', # noqa: E501 - 'inline': 'inline', # noqa: E501 - 'previous_period_measure': 'previousPeriodMeasure', # noqa: E501 - 'over_period_measure': 'overPeriodMeasure', # noqa: E501 - 'measure': 'measure', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """MeasureItemDefinition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - arithmetic_measure (ArithmeticMeasureDefinitionArithmeticMeasure): [optional] # noqa: E501 - inline (InlineMeasureDefinitionInline): [optional] # noqa: E501 - previous_period_measure (PopDatasetMeasureDefinitionPreviousPeriodMeasure): [optional] # noqa: E501 - over_period_measure (PopDateMeasureDefinitionOverPeriodMeasure): [optional] # noqa: E501 - measure (SimpleMeasureDefinitionMeasure): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """MeasureItemDefinition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - arithmetic_measure (ArithmeticMeasureDefinitionArithmeticMeasure): [optional] # noqa: E501 - inline (InlineMeasureDefinitionInline): [optional] # noqa: E501 - previous_period_measure (PopDatasetMeasureDefinitionPreviousPeriodMeasure): [optional] # noqa: E501 - over_period_measure (PopDateMeasureDefinitionOverPeriodMeasure): [optional] # noqa: E501 - measure (SimpleMeasureDefinitionMeasure): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - ArithmeticMeasureDefinition, - InlineMeasureDefinition, - PopDatasetMeasureDefinition, - PopDateMeasureDefinition, - PopMeasureDefinition, - SimpleMeasureDefinition, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/measure_result_header.py b/gooddata-api-client/gooddata_api_client/model/measure_result_header.py deleted file mode 100644 index b8e2f86ab..000000000 --- a/gooddata-api-client/gooddata_api_client/model/measure_result_header.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class MeasureResultHeader(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'measure_index': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'measure_index': 'measureIndex', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, measure_index, *args, **kwargs): # noqa: E501 - """MeasureResultHeader - a model defined in OpenAPI - - Args: - measure_index (int): Metric index. Starts at 0. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure_index = measure_index - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, measure_index, *args, **kwargs): # noqa: E501 - """MeasureResultHeader - a model defined in OpenAPI - - Args: - measure_index (int): Metric index. Starts at 0. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure_index = measure_index - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/measure_value_filter.py b/gooddata-api-client/gooddata_api_client/model/measure_value_filter.py deleted file mode 100644 index 559a24513..000000000 --- a/gooddata-api-client/gooddata_api_client/model/measure_value_filter.py +++ /dev/null @@ -1,331 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.comparison_measure_value_filter import ComparisonMeasureValueFilter - from gooddata_api_client.model.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter - from gooddata_api_client.model.range_measure_value_filter import RangeMeasureValueFilter - from gooddata_api_client.model.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter - globals()['ComparisonMeasureValueFilter'] = ComparisonMeasureValueFilter - globals()['ComparisonMeasureValueFilterComparisonMeasureValueFilter'] = ComparisonMeasureValueFilterComparisonMeasureValueFilter - globals()['RangeMeasureValueFilter'] = RangeMeasureValueFilter - globals()['RangeMeasureValueFilterRangeMeasureValueFilter'] = RangeMeasureValueFilterRangeMeasureValueFilter - - -class MeasureValueFilter(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'comparison_measure_value_filter': (ComparisonMeasureValueFilterComparisonMeasureValueFilter,), # noqa: E501 - 'range_measure_value_filter': (RangeMeasureValueFilterRangeMeasureValueFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'comparison_measure_value_filter': 'comparisonMeasureValueFilter', # noqa: E501 - 'range_measure_value_filter': 'rangeMeasureValueFilter', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """MeasureValueFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """MeasureValueFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - ComparisonMeasureValueFilter, - RangeMeasureValueFilter, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/measure_value_filter.pyi b/gooddata-api-client/gooddata_api_client/model/measure_value_filter.pyi index 24486f184..2fc206cdd 100644 --- a/gooddata-api-client/gooddata_api_client/model/measure_value_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/measure_value_filter.pyi @@ -38,7 +38,7 @@ class MeasureValueFilter( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -68,5 +68,5 @@ class MeasureValueFilter( **kwargs, ) -from gooddata_api_client.model.comparison_measure_value_filter import ComparisonMeasureValueFilter -from gooddata_api_client.model.range_measure_value_filter import RangeMeasureValueFilter +from gooddata_api_client.models.comparison_measure_value_filter import ComparisonMeasureValueFilter +from gooddata_api_client.models.range_measure_value_filter import RangeMeasureValueFilter diff --git a/gooddata-api-client/gooddata_api_client/model/memory_item.py b/gooddata-api-client/gooddata_api_client/model/memory_item.py deleted file mode 100644 index f20ee5e6d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/memory_item.py +++ /dev/null @@ -1,307 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.memory_item_use_cases import MemoryItemUseCases - globals()['MemoryItemUseCases'] = MemoryItemUseCases - - -class MemoryItem(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('strategy',): { - 'ALLWAYS': "MEMORY_ITEM_STRATEGY_ALLWAYS", - 'NEVER': "MEMORY_ITEM_STRATEGY_NEVER", - 'AUTO': "MEMORY_ITEM_STRATEGY_AUTO", - }, - } - - validations = { - ('id',): { - 'max_length': 255, - }, - ('instruction',): { - 'max_length': 255, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'instruction': (str,), # noqa: E501 - 'keywords': ([str],), # noqa: E501 - 'strategy': (str,), # noqa: E501 - 'use_cases': (MemoryItemUseCases,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'instruction': 'instruction', # noqa: E501 - 'keywords': 'keywords', # noqa: E501 - 'strategy': 'strategy', # noqa: E501 - 'use_cases': 'useCases', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, instruction, keywords, *args, **kwargs): # noqa: E501 - """MemoryItem - a model defined in OpenAPI - - Args: - id (str): Memory item ID - instruction (str): Instruction that will be injected into the prompt. - keywords ([str]): List of keywords used to match the memory item. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - strategy (str): Defines the application strategy.. [optional] # noqa: E501 - use_cases (MemoryItemUseCases): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.instruction = instruction - self.keywords = keywords - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, instruction, keywords, *args, **kwargs): # noqa: E501 - """MemoryItem - a model defined in OpenAPI - - Args: - id (str): Memory item ID - instruction (str): Instruction that will be injected into the prompt. - keywords ([str]): List of keywords used to match the memory item. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - strategy (str): Defines the application strategy.. [optional] # noqa: E501 - use_cases (MemoryItemUseCases): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.instruction = instruction - self.keywords = keywords - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/memory_item_use_cases.py b/gooddata-api-client/gooddata_api_client/model/memory_item_use_cases.py deleted file mode 100644 index 7131951c2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/memory_item_use_cases.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class MemoryItemUseCases(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'general': (bool,), # noqa: E501 - 'howto': (bool,), # noqa: E501 - 'keywords': (bool,), # noqa: E501 - 'metric': (bool,), # noqa: E501 - 'normalize': (bool,), # noqa: E501 - 'router': (bool,), # noqa: E501 - 'search': (bool,), # noqa: E501 - 'visualization': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'general': 'general', # noqa: E501 - 'howto': 'howto', # noqa: E501 - 'keywords': 'keywords', # noqa: E501 - 'metric': 'metric', # noqa: E501 - 'normalize': 'normalize', # noqa: E501 - 'router': 'router', # noqa: E501 - 'search': 'search', # noqa: E501 - 'visualization': 'visualization', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, general, howto, keywords, metric, normalize, router, search, visualization, *args, **kwargs): # noqa: E501 - """MemoryItemUseCases - a model defined in OpenAPI - - Args: - general (bool): Apply this memory item to the general answer prompt. - howto (bool): Apply this memory item to the how-to prompt. - keywords (bool): Apply this memory item to the search keyword extraction prompt. - metric (bool): Apply this memory item to the metric selection prompt. - normalize (bool): Apply this memory item to the normalize prompt. - router (bool): Appy this memory item to the router prompt. - search (bool): Apply this memory item to the search prompt. - visualization (bool): Apply this memory item to the visualization prompt. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.general = general - self.howto = howto - self.keywords = keywords - self.metric = metric - self.normalize = normalize - self.router = router - self.search = search - self.visualization = visualization - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, general, howto, keywords, metric, normalize, router, search, visualization, *args, **kwargs): # noqa: E501 - """MemoryItemUseCases - a model defined in OpenAPI - - Args: - general (bool): Apply this memory item to the general answer prompt. - howto (bool): Apply this memory item to the how-to prompt. - keywords (bool): Apply this memory item to the search keyword extraction prompt. - metric (bool): Apply this memory item to the metric selection prompt. - normalize (bool): Apply this memory item to the normalize prompt. - router (bool): Appy this memory item to the router prompt. - search (bool): Apply this memory item to the search prompt. - visualization (bool): Apply this memory item to the visualization prompt. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.general = general - self.howto = howto - self.keywords = keywords - self.metric = metric - self.normalize = normalize - self.router = router - self.search = search - self.visualization = visualization - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/metric.py b/gooddata-api-client/gooddata_api_client/model/metric.py deleted file mode 100644 index 69df26fe1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/metric.py +++ /dev/null @@ -1,299 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class Metric(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'METRIC': "metric", - 'FACT': "fact", - 'ATTRIBUTE': "attribute", - }, - ('agg_function',): { - 'COUNT': "COUNT", - 'SUM': "SUM", - 'MIN': "MIN", - 'MAX': "MAX", - 'AVG': "AVG", - 'MEDIAN': "MEDIAN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'agg_function': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'type': 'type', # noqa: E501 - 'agg_function': 'aggFunction', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, title, type, *args, **kwargs): # noqa: E501 - """Metric - a model defined in OpenAPI - - Args: - id (str): ID of the object - title (str): Title of metric. - type (str): Object type - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - agg_function (str): Agg function. Empty if a stored metric is used.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, title, type, *args, **kwargs): # noqa: E501 - """Metric - a model defined in OpenAPI - - Args: - id (str): ID of the object - title (str): Title of metric. - type (str): Object type - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - agg_function (str): Agg function. Empty if a stored metric is used.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/metric_record.py b/gooddata-api-client/gooddata_api_client/model/metric_record.py deleted file mode 100644 index dd65219f9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/metric_record.py +++ /dev/null @@ -1,274 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class MetricRecord(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'value': (float,), # noqa: E501 - 'formatted_value': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'value': 'value', # noqa: E501 - 'formatted_value': 'formattedValue', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, value, *args, **kwargs): # noqa: E501 - """MetricRecord - a model defined in OpenAPI - - Args: - value (float): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - formatted_value (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, value, *args, **kwargs): # noqa: E501 - """MetricRecord - a model defined in OpenAPI - - Args: - value (float): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - formatted_value (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/negative_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/negative_attribute_filter.py deleted file mode 100644 index 1fbcbcfbb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/negative_attribute_filter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter - globals()['NegativeAttributeFilterNegativeAttributeFilter'] = NegativeAttributeFilterNegativeAttributeFilter - - -class NegativeAttributeFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, negative_attribute_filter, *args, **kwargs): # noqa: E501 - """NegativeAttributeFilter - a model defined in OpenAPI - - Args: - negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.negative_attribute_filter = negative_attribute_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, negative_attribute_filter, *args, **kwargs): # noqa: E501 - """NegativeAttributeFilter - a model defined in OpenAPI - - Args: - negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.negative_attribute_filter = negative_attribute_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/negative_attribute_filter.pyi b/gooddata-api-client/gooddata_api_client/model/negative_attribute_filter.pyi index ba6a265ab..9aa3799ec 100644 --- a/gooddata-api-client/gooddata_api_client/model/negative_attribute_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/negative_attribute_filter.pyi @@ -40,28 +40,28 @@ class NegativeAttributeFilter( required = { "negativeAttributeFilter", } - + class properties: - - + + class negativeAttributeFilter( schemas.DictSchema ): - - + + class MetaOapg: required = { "notIn", "label", } - + class properties: applyOnResult = schemas.BoolSchema - + @staticmethod def label() -> typing.Type['AfmIdentifier']: return AfmIdentifier - + @staticmethod def notIn() -> typing.Type['AttributeFilterElements']: return AttributeFilterElements @@ -70,43 +70,43 @@ class NegativeAttributeFilter( "label": label, "notIn": notIn, } - + notIn: 'AttributeFilterElements' label: 'AfmIdentifier' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["applyOnResult"]) -> MetaOapg.properties.applyOnResult: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["label"]) -> 'AfmIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["notIn"]) -> 'AttributeFilterElements': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "label", "notIn", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["applyOnResult"]) -> typing.Union[MetaOapg.properties.applyOnResult, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["label"]) -> 'AfmIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["notIn"]) -> 'AttributeFilterElements': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "label", "notIn", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -128,29 +128,29 @@ class NegativeAttributeFilter( __annotations__ = { "negativeAttributeFilter": negativeAttributeFilter, } - + negativeAttributeFilter: MetaOapg.properties.negativeAttributeFilter - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["negativeAttributeFilter"]) -> MetaOapg.properties.negativeAttributeFilter: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["negativeAttributeFilter", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["negativeAttributeFilter"]) -> MetaOapg.properties.negativeAttributeFilter: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["negativeAttributeFilter", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -167,5 +167,5 @@ class NegativeAttributeFilter( **kwargs, ) -from gooddata_api_client.model.afm_identifier import AfmIdentifier -from gooddata_api_client.model.attribute_filter_elements import AttributeFilterElements +from gooddata_api_client.models.afm_identifier import AfmIdentifier +from gooddata_api_client.models.attribute_filter_elements import AttributeFilterElements diff --git a/gooddata-api-client/gooddata_api_client/model/negative_attribute_filter_negative_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/negative_attribute_filter_negative_attribute_filter.py deleted file mode 100644 index a7eed4428..000000000 --- a/gooddata-api-client/gooddata_api_client/model/negative_attribute_filter_negative_attribute_filter.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_identifier import AfmIdentifier - from gooddata_api_client.model.attribute_filter_elements import AttributeFilterElements - globals()['AfmIdentifier'] = AfmIdentifier - globals()['AttributeFilterElements'] = AttributeFilterElements - - -class NegativeAttributeFilterNegativeAttributeFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'label': (AfmIdentifier,), # noqa: E501 - 'not_in': (AttributeFilterElements,), # noqa: E501 - 'apply_on_result': (bool,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'label': 'label', # noqa: E501 - 'not_in': 'notIn', # noqa: E501 - 'apply_on_result': 'applyOnResult', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, label, not_in, *args, **kwargs): # noqa: E501 - """NegativeAttributeFilterNegativeAttributeFilter - a model defined in OpenAPI - - Args: - label (AfmIdentifier): - not_in (AttributeFilterElements): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.label = label - self.not_in = not_in - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, label, not_in, *args, **kwargs): # noqa: E501 - """NegativeAttributeFilterNegativeAttributeFilter - a model defined in OpenAPI - - Args: - label (AfmIdentifier): - not_in (AttributeFilterElements): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.label = label - self.not_in = not_in - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/note.py b/gooddata-api-client/gooddata_api_client/model/note.py deleted file mode 100644 index d87208d1a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/note.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class Note(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('applies_to',): { - 'SOURCE': "SOURCE", - 'TARGET': "TARGET", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'applies_to': (str,), # noqa: E501 - 'category': (str,), # noqa: E501 - 'content': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'other_attributes': ({str: (str,)},), # noqa: E501 - 'priority': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'applies_to': 'appliesTo', # noqa: E501 - 'category': 'category', # noqa: E501 - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - 'other_attributes': 'otherAttributes', # noqa: E501 - 'priority': 'priority', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """Note - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - applies_to (str): [optional] # noqa: E501 - category (str): [optional] # noqa: E501 - content (str): [optional] # noqa: E501 - id (str): [optional] # noqa: E501 - other_attributes ({str: (str,)}): [optional] # noqa: E501 - priority (int): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """Note - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - applies_to (str): [optional] # noqa: E501 - category (str): [optional] # noqa: E501 - content (str): [optional] # noqa: E501 - id (str): [optional] # noqa: E501 - other_attributes ({str: (str,)}): [optional] # noqa: E501 - priority (int): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/notes.py b/gooddata-api-client/gooddata_api_client/model/notes.py deleted file mode 100644 index e3e7b9e30..000000000 --- a/gooddata-api-client/gooddata_api_client/model/notes.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.note import Note - globals()['Note'] = Note - - -class Notes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'note': ([Note],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'note': 'note', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, note, *args, **kwargs): # noqa: E501 - """Notes - a model defined in OpenAPI - - Args: - note ([Note]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.note = note - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, note, *args, **kwargs): # noqa: E501 - """Notes - a model defined in OpenAPI - - Args: - note ([Note]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.note = note - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/notification.py b/gooddata-api-client/gooddata_api_client/model/notification.py deleted file mode 100644 index 305144c6a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/notification.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.notification_data import NotificationData - globals()['NotificationData'] = NotificationData - - -class Notification(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'created_at': (datetime,), # noqa: E501 - 'data': (NotificationData,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'is_read': (bool,), # noqa: E501 - 'automation_id': (str,), # noqa: E501 - 'workspace_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'created_at': 'createdAt', # noqa: E501 - 'data': 'data', # noqa: E501 - 'id': 'id', # noqa: E501 - 'is_read': 'isRead', # noqa: E501 - 'automation_id': 'automationId', # noqa: E501 - 'workspace_id': 'workspaceId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, created_at, data, id, is_read, *args, **kwargs): # noqa: E501 - """Notification - a model defined in OpenAPI - - Args: - created_at (datetime): - data (NotificationData): - id (str): - is_read (bool): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - automation_id (str): [optional] # noqa: E501 - workspace_id (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.created_at = created_at - self.data = data - self.id = id - self.is_read = is_read - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, created_at, data, id, is_read, *args, **kwargs): # noqa: E501 - """Notification - a model defined in OpenAPI - - Args: - created_at (datetime): - data (NotificationData): - id (str): - is_read (bool): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - automation_id (str): [optional] # noqa: E501 - workspace_id (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.created_at = created_at - self.data = data - self.id = id - self.is_read = is_read - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/notification_channel_destination.py b/gooddata-api-client/gooddata_api_client/model/notification_channel_destination.py deleted file mode 100644 index 09f74e5f2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/notification_channel_destination.py +++ /dev/null @@ -1,381 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.default_smtp import DefaultSmtp - from gooddata_api_client.model.in_platform import InPlatform - from gooddata_api_client.model.smtp import Smtp - from gooddata_api_client.model.webhook import Webhook - globals()['DefaultSmtp'] = DefaultSmtp - globals()['InPlatform'] = InPlatform - globals()['Smtp'] = Smtp - globals()['Webhook'] = Webhook - - -class NotificationChannelDestination(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('port',): { - '25': 25, - '465': 465, - '587': 587, - '2525': 2525, - }, - } - - validations = { - ('token',): { - 'max_length': 10000, - }, - ('url',): { - 'max_length': 255, - 'regex': { - 'pattern': r'https?\:\/\/.*', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'has_token': (bool, none_type,), # noqa: E501 - 'token': (str, none_type,), # noqa: E501 - 'url': (str,), # noqa: E501 - 'from_email': (str,), # noqa: E501 - 'from_email_name': (str,), # noqa: E501 - 'host': (str,), # noqa: E501 - 'password': (str,), # noqa: E501 - 'port': (int,), # noqa: E501 - 'username': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'has_token': 'hasToken', # noqa: E501 - 'token': 'token', # noqa: E501 - 'url': 'url', # noqa: E501 - 'from_email': 'fromEmail', # noqa: E501 - 'from_email_name': 'fromEmailName', # noqa: E501 - 'host': 'host', # noqa: E501 - 'password': 'password', # noqa: E501 - 'port': 'port', # noqa: E501 - 'username': 'username', # noqa: E501 - } - - read_only_vars = { - 'has_token', # noqa: E501 - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """NotificationChannelDestination - a model defined in OpenAPI - - Keyword Args: - type (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - from_email (str): E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """NotificationChannelDestination - a model defined in OpenAPI - - Keyword Args: - type (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - from_email (str): E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - DefaultSmtp, - InPlatform, - Smtp, - Webhook, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/notification_content.py b/gooddata-api-client/gooddata_api_client/model/notification_content.py deleted file mode 100644 index acf1a390d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/notification_content.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.automation_notification import AutomationNotification - from gooddata_api_client.model.test_notification import TestNotification - globals()['AutomationNotification'] = AutomationNotification - globals()['TestNotification'] = TestNotification - - -class NotificationContent(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - lazy_import() - val = { - 'AUTOMATION': AutomationNotification, - 'AutomationNotification': AutomationNotification, - 'TEST': TestNotification, - 'TestNotification': TestNotification, - } - if not val: - return None - return {'type': val} - - attribute_map = { - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """NotificationContent - a model defined in OpenAPI - - Args: - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, type, *args, **kwargs): # noqa: E501 - """NotificationContent - a model defined in OpenAPI - - Args: - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/notification_data.py b/gooddata-api-client/gooddata_api_client/model/notification_data.py deleted file mode 100644 index 1cfb66b77..000000000 --- a/gooddata-api-client/gooddata_api_client/model/notification_data.py +++ /dev/null @@ -1,341 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.automation_notification import AutomationNotification - from gooddata_api_client.model.test_notification import TestNotification - from gooddata_api_client.model.webhook_message import WebhookMessage - globals()['AutomationNotification'] = AutomationNotification - globals()['TestNotification'] = TestNotification - globals()['WebhookMessage'] = WebhookMessage - - -class NotificationData(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'message': (str,), # noqa: E501 - 'content': (WebhookMessage,), # noqa: E501 - } - - @cached_property - def discriminator(): - lazy_import() - val = { - 'AUTOMATION': AutomationNotification, - 'AutomationNotification': AutomationNotification, - 'TEST': TestNotification, - 'TestNotification': TestNotification, - } - if not val: - return None - return {'type': val} - - attribute_map = { - 'type': 'type', # noqa: E501 - 'message': 'message', # noqa: E501 - 'content': 'content', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """NotificationData - a model defined in OpenAPI - - Keyword Args: - type (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - message (str): [optional] # noqa: E501 - content (WebhookMessage): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """NotificationData - a model defined in OpenAPI - - Keyword Args: - type (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - message (str): [optional] # noqa: E501 - content (WebhookMessage): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AutomationNotification, - TestNotification, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/notification_filter.py b/gooddata-api-client/gooddata_api_client/model/notification_filter.py deleted file mode 100644 index 3f77cd810..000000000 --- a/gooddata-api-client/gooddata_api_client/model/notification_filter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class NotificationFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'filter': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'filter': 'filter', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, filter, title, *args, **kwargs): # noqa: E501 - """NotificationFilter - a model defined in OpenAPI - - Args: - filter (str): - title (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter = filter - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, filter, title, *args, **kwargs): # noqa: E501 - """NotificationFilter - a model defined in OpenAPI - - Args: - filter (str): - title (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.filter = filter - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/notifications.py b/gooddata-api-client/gooddata_api_client/model/notifications.py deleted file mode 100644 index d17e12fad..000000000 --- a/gooddata-api-client/gooddata_api_client/model/notifications.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.notification import Notification - from gooddata_api_client.model.notifications_meta import NotificationsMeta - globals()['Notification'] = Notification - globals()['NotificationsMeta'] = NotificationsMeta - - -class Notifications(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([Notification],), # noqa: E501 - 'meta': (NotificationsMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, meta, *args, **kwargs): # noqa: E501 - """Notifications - a model defined in OpenAPI - - Args: - data ([Notification]): - meta (NotificationsMeta): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - self.meta = meta - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, meta, *args, **kwargs): # noqa: E501 - """Notifications - a model defined in OpenAPI - - Args: - data ([Notification]): - meta (NotificationsMeta): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - self.meta = meta - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/notifications_meta.py b/gooddata-api-client/gooddata_api_client/model/notifications_meta.py deleted file mode 100644 index dcab676a8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/notifications_meta.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.notifications_meta_total import NotificationsMetaTotal - globals()['NotificationsMetaTotal'] = NotificationsMetaTotal - - -class NotificationsMeta(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'total': (NotificationsMetaTotal,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'total': 'total', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """NotificationsMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - total (NotificationsMetaTotal): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """NotificationsMeta - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - total (NotificationsMetaTotal): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/notifications_meta_total.py b/gooddata-api-client/gooddata_api_client/model/notifications_meta_total.py deleted file mode 100644 index 5c1b26219..000000000 --- a/gooddata-api-client/gooddata_api_client/model/notifications_meta_total.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class NotificationsMetaTotal(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'all': (int,), # noqa: E501 - 'unread': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'all': 'all', # noqa: E501 - 'unread': 'unread', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, all, unread, *args, **kwargs): # noqa: E501 - """NotificationsMetaTotal - a model defined in OpenAPI - - Args: - all (int): - unread (int): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.all = all - self.unread = unread - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, all, unread, *args, **kwargs): # noqa: E501 - """NotificationsMetaTotal - a model defined in OpenAPI - - Args: - all (int): - unread (int): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.all = all - self.unread = unread - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/object_links.py b/gooddata-api-client/gooddata_api_client/model/object_links.py deleted file mode 100644 index 2b05b6b58..000000000 --- a/gooddata-api-client/gooddata_api_client/model/object_links.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ObjectLinks(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - '_self': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - '_self': 'self', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, _self, *args, **kwargs): # noqa: E501 - """ObjectLinks - a model defined in OpenAPI - - Args: - _self (str): A string containing the link's URL. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self._self = _self - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, _self, *args, **kwargs): # noqa: E501 - """ObjectLinks - a model defined in OpenAPI - - Args: - _self (str): A string containing the link's URL. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self._self = _self - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/object_links_container.py b/gooddata-api-client/gooddata_api_client/model/object_links_container.py deleted file mode 100644 index db0b8efc2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/object_links_container.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.object_links import ObjectLinks - globals()['ObjectLinks'] = ObjectLinks - - -class ObjectLinksContainer(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'links': (ObjectLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ObjectLinksContainer - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ObjectLinksContainer - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - links (ObjectLinks): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/object_links_container.pyi b/gooddata-api-client/gooddata_api_client/model/object_links_container.pyi index b0f41693e..f7909b75a 100644 --- a/gooddata-api-client/gooddata_api_client/model/object_links_container.pyi +++ b/gooddata-api-client/gooddata_api_client/model/object_links_container.pyi @@ -35,36 +35,36 @@ class ObjectLinksContainer( class MetaOapg: - + class properties: - + @staticmethod def links() -> typing.Type['ObjectLinks']: return ObjectLinks __annotations__ = { "links": links, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["links", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["links", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -81,4 +81,4 @@ class ObjectLinksContainer( **kwargs, ) -from gooddata_api_client.model.object_links import ObjectLinks +from gooddata_api_client.models.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/organization_automation_identifier.py b/gooddata-api-client/gooddata_api_client/model/organization_automation_identifier.py deleted file mode 100644 index 2f8c98fd4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/organization_automation_identifier.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class OrganizationAutomationIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'workspace_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'workspace_id': 'workspaceId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, workspace_id, *args, **kwargs): # noqa: E501 - """OrganizationAutomationIdentifier - a model defined in OpenAPI - - Args: - id (str): - workspace_id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.workspace_id = workspace_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, workspace_id, *args, **kwargs): # noqa: E501 - """OrganizationAutomationIdentifier - a model defined in OpenAPI - - Args: - id (str): - workspace_id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.workspace_id = workspace_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/organization_automation_management_bulk_request.py b/gooddata-api-client/gooddata_api_client/model/organization_automation_management_bulk_request.py deleted file mode 100644 index 3ca8cb2b4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/organization_automation_management_bulk_request.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.organization_automation_identifier import OrganizationAutomationIdentifier - globals()['OrganizationAutomationIdentifier'] = OrganizationAutomationIdentifier - - -class OrganizationAutomationManagementBulkRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'automations': ([OrganizationAutomationIdentifier],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'automations': 'automations', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, automations, *args, **kwargs): # noqa: E501 - """OrganizationAutomationManagementBulkRequest - a model defined in OpenAPI - - Args: - automations ([OrganizationAutomationIdentifier]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.automations = automations - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, automations, *args, **kwargs): # noqa: E501 - """OrganizationAutomationManagementBulkRequest - a model defined in OpenAPI - - Args: - automations ([OrganizationAutomationIdentifier]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.automations = automations - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/organization_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/organization_permission_assignment.py deleted file mode 100644 index dbb2a0554..000000000 --- a/gooddata-api-client/gooddata_api_client/model/organization_permission_assignment.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - globals()['AssigneeIdentifier'] = AssigneeIdentifier - - -class OrganizationPermissionAssignment(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('permissions',): { - 'MANAGE': "MANAGE", - 'SELF_CREATE_TOKEN': "SELF_CREATE_TOKEN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 - 'permissions': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, assignee_identifier, permissions, *args, **kwargs): # noqa: E501 - """OrganizationPermissionAssignment - a model defined in OpenAPI - - Args: - assignee_identifier (AssigneeIdentifier): - permissions ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee_identifier = assignee_identifier - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, assignee_identifier, permissions, *args, **kwargs): # noqa: E501 - """OrganizationPermissionAssignment - a model defined in OpenAPI - - Args: - assignee_identifier (AssigneeIdentifier): - permissions ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee_identifier = assignee_identifier - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/over.py b/gooddata-api-client/gooddata_api_client/model/over.py deleted file mode 100644 index ddafbea07..000000000 --- a/gooddata-api-client/gooddata_api_client/model/over.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.identifier_ref import IdentifierRef - globals()['IdentifierRef'] = IdentifierRef - - -class Over(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attributes': ([IdentifierRef],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 - """Over - a model defined in OpenAPI - - Args: - attributes ([IdentifierRef]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attributes, *args, **kwargs): # noqa: E501 - """Over - a model defined in OpenAPI - - Args: - attributes ([IdentifierRef]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attributes = attributes - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/page_metadata.py b/gooddata-api-client/gooddata_api_client/model/page_metadata.py deleted file mode 100644 index 261e59532..000000000 --- a/gooddata-api-client/gooddata_api_client/model/page_metadata.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class PageMetadata(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'number': (int,), # noqa: E501 - 'size': (int,), # noqa: E501 - 'total_elements': (int,), # noqa: E501 - 'total_pages': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'number': 'number', # noqa: E501 - 'size': 'size', # noqa: E501 - 'total_elements': 'totalElements', # noqa: E501 - 'total_pages': 'totalPages', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """PageMetadata - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - number (int): The number of the current page. [optional] # noqa: E501 - size (int): The size of the current page. [optional] # noqa: E501 - total_elements (int): The total number of elements. [optional] # noqa: E501 - total_pages (int): The total number of pages. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PageMetadata - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - number (int): The number of the current page. [optional] # noqa: E501 - size (int): The size of the current page. [optional] # noqa: E501 - total_elements (int): The total number of elements. [optional] # noqa: E501 - total_pages (int): The total number of pages. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/paging.py b/gooddata-api-client/gooddata_api_client/model/paging.py deleted file mode 100644 index ee9452d33..000000000 --- a/gooddata-api-client/gooddata_api_client/model/paging.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class Paging(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'count': (int,), # noqa: E501 - 'offset': (int,), # noqa: E501 - 'total': (int,), # noqa: E501 - 'next': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'count': 'count', # noqa: E501 - 'offset': 'offset', # noqa: E501 - 'total': 'total', # noqa: E501 - 'next': 'next', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, count, offset, total, *args, **kwargs): # noqa: E501 - """Paging - a model defined in OpenAPI - - Args: - count (int): Count of items in this page. - offset (int): Offset of this page. - total (int): Count of returnable items ignoring paging. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - next (str): Link to next page, or null if this is last page.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.count = count - self.offset = offset - self.total = total - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, count, offset, total, *args, **kwargs): # noqa: E501 - """Paging - a model defined in OpenAPI - - Args: - count (int): Count of items in this page. - offset (int): Offset of this page. - total (int): Count of returnable items ignoring paging. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - next (str): Link to next page, or null if this is last page.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.count = count - self.offset = offset - self.total = total - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/parameter.py b/gooddata-api-client/gooddata_api_client/model/parameter.py deleted file mode 100644 index b727cb29f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/parameter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class Parameter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'value': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, value, *args, **kwargs): # noqa: E501 - """Parameter - a model defined in OpenAPI - - Args: - name (str): - value (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, name, value, *args, **kwargs): # noqa: E501 - """Parameter - a model defined in OpenAPI - - Args: - name (str): - value (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pdf_table_style.py b/gooddata-api-client/gooddata_api_client/model/pdf_table_style.py deleted file mode 100644 index 3bb9e21a4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pdf_table_style.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.pdf_table_style_property import PdfTableStyleProperty - globals()['PdfTableStyleProperty'] = PdfTableStyleProperty - - -class PdfTableStyle(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'selector': (str,), # noqa: E501 - 'properties': ([PdfTableStyleProperty],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'selector': 'selector', # noqa: E501 - 'properties': 'properties', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, selector, *args, **kwargs): # noqa: E501 - """PdfTableStyle - a model defined in OpenAPI - - Args: - selector (str): CSS selector where to apply given properties. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - properties ([PdfTableStyleProperty]): List of CSS properties.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.selector = selector - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, selector, *args, **kwargs): # noqa: E501 - """PdfTableStyle - a model defined in OpenAPI - - Args: - selector (str): CSS selector where to apply given properties. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - properties ([PdfTableStyleProperty]): List of CSS properties.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.selector = selector - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pdf_table_style_property.py b/gooddata-api-client/gooddata_api_client/model/pdf_table_style_property.py deleted file mode 100644 index 94058d40d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pdf_table_style_property.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class PdfTableStyleProperty(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'key': (str,), # noqa: E501 - 'value': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'key': 'key', # noqa: E501 - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, key, value, *args, **kwargs): # noqa: E501 - """PdfTableStyleProperty - a model defined in OpenAPI - - Args: - key (str): CSS property key. - value (str): CSS property value. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.key = key - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, key, value, *args, **kwargs): # noqa: E501 - """PdfTableStyleProperty - a model defined in OpenAPI - - Args: - key (str): CSS property key. - value (str): CSS property value. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.key = key - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pdm_ldm_request.py b/gooddata-api-client/gooddata_api_client/model/pdm_ldm_request.py deleted file mode 100644 index 4dae6455f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pdm_ldm_request.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_table import DeclarativeTable - from gooddata_api_client.model.pdm_sql import PdmSql - from gooddata_api_client.model.table_override import TableOverride - globals()['DeclarativeTable'] = DeclarativeTable - globals()['PdmSql'] = PdmSql - globals()['TableOverride'] = TableOverride - - -class PdmLdmRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'sqls': ([PdmSql],), # noqa: E501 - 'table_overrides': ([TableOverride],), # noqa: E501 - 'tables': ([DeclarativeTable],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'sqls': 'sqls', # noqa: E501 - 'table_overrides': 'tableOverrides', # noqa: E501 - 'tables': 'tables', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """PdmLdmRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - sqls ([PdmSql]): List of SQL datasets.. [optional] # noqa: E501 - table_overrides ([TableOverride]): (BETA) List of table overrides.. [optional] # noqa: E501 - tables ([DeclarativeTable]): List of physical database tables.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PdmLdmRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - sqls ([PdmSql]): List of SQL datasets.. [optional] # noqa: E501 - table_overrides ([TableOverride]): (BETA) List of table overrides.. [optional] # noqa: E501 - tables ([DeclarativeTable]): List of physical database tables.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pdm_ldm_request.pyi b/gooddata-api-client/gooddata_api_client/model/pdm_ldm_request.pyi index d249b70c7..a41417948 100644 --- a/gooddata-api-client/gooddata_api_client/model/pdm_ldm_request.pyi +++ b/gooddata-api-client/gooddata_api_client/model/pdm_ldm_request.pyi @@ -37,21 +37,21 @@ class PdmLdmRequest( class MetaOapg: - + class properties: - - + + class sqls( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['PdmSql']: return PdmSql - + def __new__( cls, _arg: typing.Union[typing.Tuple['PdmSql'], typing.List['PdmSql']], @@ -62,33 +62,33 @@ class PdmLdmRequest( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'PdmSql': return super().__getitem__(i) __annotations__ = { "sqls": sqls, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["sqls"]) -> MetaOapg.properties.sqls: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["sqls", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["sqls"]) -> typing.Union[MetaOapg.properties.sqls, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["sqls", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -105,4 +105,4 @@ class PdmLdmRequest( **kwargs, ) -from gooddata_api_client.model.pdm_sql import PdmSql +from gooddata_api_client.models.pdm_sql import PdmSql diff --git a/gooddata-api-client/gooddata_api_client/model/pdm_sql.py b/gooddata-api-client/gooddata_api_client/model/pdm_sql.py deleted file mode 100644 index 565090e1c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pdm_sql.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.sql_column import SqlColumn - globals()['SqlColumn'] = SqlColumn - - -class PdmSql(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'statement': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'columns': ([SqlColumn],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'statement': 'statement', # noqa: E501 - 'title': 'title', # noqa: E501 - 'columns': 'columns', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, statement, title, *args, **kwargs): # noqa: E501 - """PdmSql - a model defined in OpenAPI - - Args: - statement (str): SQL statement. - title (str): SQL dataset title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - columns ([SqlColumn]): Columns defining SQL dataset.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.statement = statement - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, statement, title, *args, **kwargs): # noqa: E501 - """PdmSql - a model defined in OpenAPI - - Args: - statement (str): SQL statement. - title (str): SQL dataset title. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - columns ([SqlColumn]): Columns defining SQL dataset.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.statement = statement - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pdm_sql.pyi b/gooddata-api-client/gooddata_api_client/model/pdm_sql.pyi index ef912c6d0..5d8e73dff 100644 --- a/gooddata-api-client/gooddata_api_client/model/pdm_sql.pyi +++ b/gooddata-api-client/gooddata_api_client/model/pdm_sql.pyi @@ -41,23 +41,23 @@ class PdmSql( "statement", "title", } - + class properties: statement = schemas.StrSchema title = schemas.StrSchema - - + + class columns( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['SqlColumn']: return SqlColumn - + def __new__( cls, _arg: typing.Union[typing.Tuple['SqlColumn'], typing.List['SqlColumn']], @@ -68,7 +68,7 @@ class PdmSql( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'SqlColumn': return super().__getitem__(i) __annotations__ = { @@ -76,42 +76,42 @@ class PdmSql( "title": title, "columns": columns, } - + statement: MetaOapg.properties.statement title: MetaOapg.properties.title - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["statement"]) -> MetaOapg.properties.statement: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["statement", "title", "columns", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["statement"]) -> MetaOapg.properties.statement: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["statement", "title", "columns", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -132,4 +132,4 @@ class PdmSql( **kwargs, ) -from gooddata_api_client.model.sql_column import SqlColumn +from gooddata_api_client.models.sql_column import SqlColumn diff --git a/gooddata-api-client/gooddata_api_client/model/permissions_assignment.py b/gooddata-api-client/gooddata_api_client/model/permissions_assignment.py deleted file mode 100644 index 1e7eae843..000000000 --- a/gooddata-api-client/gooddata_api_client/model/permissions_assignment.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - from gooddata_api_client.model.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment - from gooddata_api_client.model.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment - globals()['AssigneeIdentifier'] = AssigneeIdentifier - globals()['UserManagementDataSourcePermissionAssignment'] = UserManagementDataSourcePermissionAssignment - globals()['UserManagementWorkspacePermissionAssignment'] = UserManagementWorkspacePermissionAssignment - - -class PermissionsAssignment(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignees': ([AssigneeIdentifier],), # noqa: E501 - 'data_sources': ([UserManagementDataSourcePermissionAssignment],), # noqa: E501 - 'workspaces': ([UserManagementWorkspacePermissionAssignment],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignees': 'assignees', # noqa: E501 - 'data_sources': 'dataSources', # noqa: E501 - 'workspaces': 'workspaces', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, assignees, *args, **kwargs): # noqa: E501 - """PermissionsAssignment - a model defined in OpenAPI - - Args: - assignees ([AssigneeIdentifier]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_sources ([UserManagementDataSourcePermissionAssignment]): [optional] # noqa: E501 - workspaces ([UserManagementWorkspacePermissionAssignment]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignees = assignees - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, assignees, *args, **kwargs): # noqa: E501 - """PermissionsAssignment - a model defined in OpenAPI - - Args: - assignees ([AssigneeIdentifier]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_sources ([UserManagementDataSourcePermissionAssignment]): [optional] # noqa: E501 - workspaces ([UserManagementWorkspacePermissionAssignment]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignees = assignees - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee.py b/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee.py deleted file mode 100644 index 0e4fb2e89..000000000 --- a/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee.py +++ /dev/null @@ -1,334 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - from gooddata_api_client.model.dashboard_permissions_assignment import DashboardPermissionsAssignment - from gooddata_api_client.model.permissions_for_assignee_all_of import PermissionsForAssigneeAllOf - globals()['AssigneeIdentifier'] = AssigneeIdentifier - globals()['DashboardPermissionsAssignment'] = DashboardPermissionsAssignment - globals()['PermissionsForAssigneeAllOf'] = PermissionsForAssigneeAllOf - - -class PermissionsForAssignee(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('permissions',): { - 'EDIT': "EDIT", - 'SHARE': "SHARE", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'permissions': ([str],), # noqa: E501 - 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'permissions': 'permissions', # noqa: E501 - 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """PermissionsForAssignee - a model defined in OpenAPI - - Keyword Args: - permissions ([str]): - assignee_identifier (AssigneeIdentifier): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PermissionsForAssignee - a model defined in OpenAPI - - Keyword Args: - permissions ([str]): - assignee_identifier (AssigneeIdentifier): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - DashboardPermissionsAssignment, - PermissionsForAssigneeAllOf, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee.pyi b/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee.pyi index ed7d617e2..57184d7ae 100644 --- a/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee.pyi +++ b/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee.pyi @@ -41,39 +41,39 @@ class PermissionsForAssignee( "assigneeIdentifier", "permissions", } - + class properties: - + @staticmethod def assigneeIdentifier() -> typing.Type['AssigneeIdentifier']: return AssigneeIdentifier - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def EDIT(cls): return cls("EDIT") - + @schemas.classproperty def SHARE(cls): return cls("SHARE") - + @schemas.classproperty def VIEW(cls): return cls("VIEW") - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -84,43 +84,43 @@ class PermissionsForAssignee( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) __annotations__ = { "assigneeIdentifier": assigneeIdentifier, "permissions": permissions, } - + assigneeIdentifier: 'AssigneeIdentifier' permissions: MetaOapg.properties.permissions - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["assigneeIdentifier"]) -> 'AssigneeIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assigneeIdentifier", "permissions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["assigneeIdentifier"]) -> 'AssigneeIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assigneeIdentifier", "permissions", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -139,4 +139,4 @@ class PermissionsForAssignee( **kwargs, ) -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee_all_of.py b/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee_all_of.py deleted file mode 100644 index e3230b392..000000000 --- a/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee_all_of.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - globals()['AssigneeIdentifier'] = AssigneeIdentifier - - -class PermissionsForAssigneeAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """PermissionsForAssigneeAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - assignee_identifier (AssigneeIdentifier): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PermissionsForAssigneeAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - assignee_identifier (AssigneeIdentifier): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee_rule.py b/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee_rule.py deleted file mode 100644 index 320b6cb96..000000000 --- a/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee_rule.py +++ /dev/null @@ -1,334 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_rule import AssigneeRule - from gooddata_api_client.model.dashboard_permissions_assignment import DashboardPermissionsAssignment - from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee_rule_all_of import DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf - globals()['AssigneeRule'] = AssigneeRule - globals()['DashboardPermissionsAssignment'] = DashboardPermissionsAssignment - globals()['DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf'] = DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf - - -class PermissionsForAssigneeRule(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('permissions',): { - 'EDIT': "EDIT", - 'SHARE': "SHARE", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'permissions': ([str],), # noqa: E501 - 'assignee_rule': (AssigneeRule,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'permissions': 'permissions', # noqa: E501 - 'assignee_rule': 'assigneeRule', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """PermissionsForAssigneeRule - a model defined in OpenAPI - - Keyword Args: - permissions ([str]): - assignee_rule (AssigneeRule): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PermissionsForAssigneeRule - a model defined in OpenAPI - - Keyword Args: - permissions ([str]): - assignee_rule (AssigneeRule): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - DashboardPermissionsAssignment, - DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/platform_usage.py b/gooddata-api-client/gooddata_api_client/model/platform_usage.py deleted file mode 100644 index c7177d50a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/platform_usage.py +++ /dev/null @@ -1,278 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class PlatformUsage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('name',): { - 'USERCOUNT': "UserCount", - 'WORKSPACECOUNT': "WorkspaceCount", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'count': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'count': 'count', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 - """PlatformUsage - a model defined in OpenAPI - - Args: - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - count (int): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, name, *args, **kwargs): # noqa: E501 - """PlatformUsage - a model defined in OpenAPI - - Args: - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - count (int): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/platform_usage_request.py b/gooddata-api-client/gooddata_api_client/model/platform_usage_request.py deleted file mode 100644 index 8567f3944..000000000 --- a/gooddata-api-client/gooddata_api_client/model/platform_usage_request.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class PlatformUsageRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('usage_item_names',): { - 'USERCOUNT': "UserCount", - 'WORKSPACECOUNT': "WorkspaceCount", - }, - } - - validations = { - ('usage_item_names',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'usage_item_names': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'usage_item_names': 'usageItemNames', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, usage_item_names, *args, **kwargs): # noqa: E501 - """PlatformUsageRequest - a model defined in OpenAPI - - Args: - usage_item_names ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.usage_item_names = usage_item_names - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, usage_item_names, *args, **kwargs): # noqa: E501 - """PlatformUsageRequest - a model defined in OpenAPI - - Args: - usage_item_names ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.usage_item_names = usage_item_names - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pop_dataset.py b/gooddata-api-client/gooddata_api_client/model/pop_dataset.py deleted file mode 100644 index 173411247..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pop_dataset.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_dataset import AfmObjectIdentifierDataset - globals()['AfmObjectIdentifierDataset'] = AfmObjectIdentifierDataset - - -class PopDataset(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dataset': (AfmObjectIdentifierDataset,), # noqa: E501 - 'periods_ago': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dataset': 'dataset', # noqa: E501 - 'periods_ago': 'periodsAgo', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dataset, periods_ago, *args, **kwargs): # noqa: E501 - """PopDataset - a model defined in OpenAPI - - Args: - dataset (AfmObjectIdentifierDataset): - periods_ago (int): Number of periods ago to calculate the previous period for. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dataset = dataset - self.periods_ago = periods_ago - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dataset, periods_ago, *args, **kwargs): # noqa: E501 - """PopDataset - a model defined in OpenAPI - - Args: - dataset (AfmObjectIdentifierDataset): - periods_ago (int): Number of periods ago to calculate the previous period for. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dataset = dataset - self.periods_ago = periods_ago - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pop_dataset.pyi b/gooddata-api-client/gooddata_api_client/model/pop_dataset.pyi index 3ad91c7fc..dfcacb851 100644 --- a/gooddata-api-client/gooddata_api_client/model/pop_dataset.pyi +++ b/gooddata-api-client/gooddata_api_client/model/pop_dataset.pyi @@ -39,9 +39,9 @@ class PopDataset( "periodsAgo", "dataset", } - + class properties: - + @staticmethod def dataset() -> typing.Type['AfmObjectIdentifierDataset']: return AfmObjectIdentifierDataset @@ -50,36 +50,36 @@ class PopDataset( "dataset": dataset, "periodsAgo": periodsAgo, } - + periodsAgo: MetaOapg.properties.periodsAgo dataset: 'AfmObjectIdentifierDataset' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataset"]) -> 'AfmObjectIdentifierDataset': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["periodsAgo"]) -> MetaOapg.properties.periodsAgo: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataset", "periodsAgo", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataset"]) -> 'AfmObjectIdentifierDataset': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["periodsAgo"]) -> MetaOapg.properties.periodsAgo: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataset", "periodsAgo", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -98,4 +98,4 @@ class PopDataset( **kwargs, ) -from gooddata_api_client.model.afm_object_identifier_dataset import AfmObjectIdentifierDataset +from gooddata_api_client.models.afm_object_identifier_dataset import AfmObjectIdentifierDataset diff --git a/gooddata-api-client/gooddata_api_client/model/pop_dataset_measure_definition.py b/gooddata-api-client/gooddata_api_client/model/pop_dataset_measure_definition.py deleted file mode 100644 index 02ffe0b97..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pop_dataset_measure_definition.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.pop_dataset_measure_definition_previous_period_measure import PopDatasetMeasureDefinitionPreviousPeriodMeasure - globals()['PopDatasetMeasureDefinitionPreviousPeriodMeasure'] = PopDatasetMeasureDefinitionPreviousPeriodMeasure - - -class PopDatasetMeasureDefinition(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'previous_period_measure': (PopDatasetMeasureDefinitionPreviousPeriodMeasure,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'previous_period_measure': 'previousPeriodMeasure', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, previous_period_measure, *args, **kwargs): # noqa: E501 - """PopDatasetMeasureDefinition - a model defined in OpenAPI - - Args: - previous_period_measure (PopDatasetMeasureDefinitionPreviousPeriodMeasure): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.previous_period_measure = previous_period_measure - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, previous_period_measure, *args, **kwargs): # noqa: E501 - """PopDatasetMeasureDefinition - a model defined in OpenAPI - - Args: - previous_period_measure (PopDatasetMeasureDefinitionPreviousPeriodMeasure): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.previous_period_measure = previous_period_measure - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pop_dataset_measure_definition.pyi b/gooddata-api-client/gooddata_api_client/model/pop_dataset_measure_definition.pyi index 9260694f8..9b5f0859c 100644 --- a/gooddata-api-client/gooddata_api_client/model/pop_dataset_measure_definition.pyi +++ b/gooddata-api-client/gooddata_api_client/model/pop_dataset_measure_definition.pyi @@ -179,5 +179,5 @@ class PopDatasetMeasureDefinition( **kwargs, ) -from gooddata_api_client.model.afm_local_identifier import AfmLocalIdentifier -from gooddata_api_client.model.pop_dataset import PopDataset +from gooddata_api_client.models.afm_local_identifier import AfmLocalIdentifier +from gooddata_api_client.models.pop_dataset import PopDataset diff --git a/gooddata-api-client/gooddata_api_client/model/pop_dataset_measure_definition_previous_period_measure.py b/gooddata-api-client/gooddata_api_client/model/pop_dataset_measure_definition_previous_period_measure.py deleted file mode 100644 index de46e94d2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pop_dataset_measure_definition_previous_period_measure.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_local_identifier import AfmLocalIdentifier - from gooddata_api_client.model.pop_dataset import PopDataset - globals()['AfmLocalIdentifier'] = AfmLocalIdentifier - globals()['PopDataset'] = PopDataset - - -class PopDatasetMeasureDefinitionPreviousPeriodMeasure(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'date_datasets': ([PopDataset],), # noqa: E501 - 'measure_identifier': (AfmLocalIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'date_datasets': 'dateDatasets', # noqa: E501 - 'measure_identifier': 'measureIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, date_datasets, measure_identifier, *args, **kwargs): # noqa: E501 - """PopDatasetMeasureDefinitionPreviousPeriodMeasure - a model defined in OpenAPI - - Args: - date_datasets ([PopDataset]): Specification of which date data sets to use for determining the period to calculate the previous period for. - measure_identifier (AfmLocalIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.date_datasets = date_datasets - self.measure_identifier = measure_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, date_datasets, measure_identifier, *args, **kwargs): # noqa: E501 - """PopDatasetMeasureDefinitionPreviousPeriodMeasure - a model defined in OpenAPI - - Args: - date_datasets ([PopDataset]): Specification of which date data sets to use for determining the period to calculate the previous period for. - measure_identifier (AfmLocalIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.date_datasets = date_datasets - self.measure_identifier = measure_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pop_date.py b/gooddata-api-client/gooddata_api_client/model/pop_date.py deleted file mode 100644 index e7b8a7a5f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pop_date.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_attribute import AfmObjectIdentifierAttribute - globals()['AfmObjectIdentifierAttribute'] = AfmObjectIdentifierAttribute - - -class PopDate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute': (AfmObjectIdentifierAttribute,), # noqa: E501 - 'periods_ago': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute': 'attribute', # noqa: E501 - 'periods_ago': 'periodsAgo', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute, periods_ago, *args, **kwargs): # noqa: E501 - """PopDate - a model defined in OpenAPI - - Args: - attribute (AfmObjectIdentifierAttribute): - periods_ago (int): Number of periods ago to calculate the previous period for. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - self.periods_ago = periods_ago - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attribute, periods_ago, *args, **kwargs): # noqa: E501 - """PopDate - a model defined in OpenAPI - - Args: - attribute (AfmObjectIdentifierAttribute): - periods_ago (int): Number of periods ago to calculate the previous period for. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - self.periods_ago = periods_ago - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pop_date.pyi b/gooddata-api-client/gooddata_api_client/model/pop_date.pyi index 3970a928e..8a54baa2b 100644 --- a/gooddata-api-client/gooddata_api_client/model/pop_date.pyi +++ b/gooddata-api-client/gooddata_api_client/model/pop_date.pyi @@ -39,9 +39,9 @@ class PopDate( "periodsAgo", "attribute", } - + class properties: - + @staticmethod def attribute() -> typing.Type['AfmObjectIdentifierAttribute']: return AfmObjectIdentifierAttribute @@ -50,36 +50,36 @@ class PopDate( "attribute": attribute, "periodsAgo": periodsAgo, } - + periodsAgo: MetaOapg.properties.periodsAgo attribute: 'AfmObjectIdentifierAttribute' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> 'AfmObjectIdentifierAttribute': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["periodsAgo"]) -> MetaOapg.properties.periodsAgo: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attribute", "periodsAgo", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> 'AfmObjectIdentifierAttribute': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["periodsAgo"]) -> MetaOapg.properties.periodsAgo: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attribute", "periodsAgo", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -98,4 +98,4 @@ class PopDate( **kwargs, ) -from gooddata_api_client.model.afm_object_identifier_attribute import AfmObjectIdentifierAttribute +from gooddata_api_client.models.afm_object_identifier_attribute import AfmObjectIdentifierAttribute diff --git a/gooddata-api-client/gooddata_api_client/model/pop_date_measure_definition.py b/gooddata-api-client/gooddata_api_client/model/pop_date_measure_definition.py deleted file mode 100644 index dd97d169d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pop_date_measure_definition.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.pop_date_measure_definition_over_period_measure import PopDateMeasureDefinitionOverPeriodMeasure - globals()['PopDateMeasureDefinitionOverPeriodMeasure'] = PopDateMeasureDefinitionOverPeriodMeasure - - -class PopDateMeasureDefinition(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'over_period_measure': (PopDateMeasureDefinitionOverPeriodMeasure,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'over_period_measure': 'overPeriodMeasure', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, over_period_measure, *args, **kwargs): # noqa: E501 - """PopDateMeasureDefinition - a model defined in OpenAPI - - Args: - over_period_measure (PopDateMeasureDefinitionOverPeriodMeasure): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.over_period_measure = over_period_measure - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, over_period_measure, *args, **kwargs): # noqa: E501 - """PopDateMeasureDefinition - a model defined in OpenAPI - - Args: - over_period_measure (PopDateMeasureDefinitionOverPeriodMeasure): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.over_period_measure = over_period_measure - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pop_date_measure_definition.pyi b/gooddata-api-client/gooddata_api_client/model/pop_date_measure_definition.pyi index e50ac4ff9..927bccdec 100644 --- a/gooddata-api-client/gooddata_api_client/model/pop_date_measure_definition.pyi +++ b/gooddata-api-client/gooddata_api_client/model/pop_date_measure_definition.pyi @@ -40,35 +40,35 @@ class PopDateMeasureDefinition( required = { "overPeriodMeasure", } - + class properties: - - + + class overPeriodMeasure( schemas.DictSchema ): - - + + class MetaOapg: required = { "measureIdentifier", "dateAttributes", } - + class properties: - - + + class dateAttributes( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['PopDate']: return PopDate - + def __new__( cls, _arg: typing.Union[typing.Tuple['PopDate'], typing.List['PopDate']], @@ -79,10 +79,10 @@ class PopDateMeasureDefinition( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'PopDate': return super().__getitem__(i) - + @staticmethod def measureIdentifier() -> typing.Type['AfmLocalIdentifier']: return AfmLocalIdentifier @@ -90,37 +90,37 @@ class PopDateMeasureDefinition( "dateAttributes": dateAttributes, "measureIdentifier": measureIdentifier, } - + measureIdentifier: 'AfmLocalIdentifier' dateAttributes: MetaOapg.properties.dateAttributes - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dateAttributes"]) -> MetaOapg.properties.dateAttributes: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["measureIdentifier"]) -> 'AfmLocalIdentifier': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dateAttributes", "measureIdentifier", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dateAttributes"]) -> MetaOapg.properties.dateAttributes: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["measureIdentifier"]) -> 'AfmLocalIdentifier': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dateAttributes", "measureIdentifier", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -140,29 +140,29 @@ class PopDateMeasureDefinition( __annotations__ = { "overPeriodMeasure": overPeriodMeasure, } - + overPeriodMeasure: MetaOapg.properties.overPeriodMeasure - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["overPeriodMeasure"]) -> MetaOapg.properties.overPeriodMeasure: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["overPeriodMeasure", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["overPeriodMeasure"]) -> MetaOapg.properties.overPeriodMeasure: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["overPeriodMeasure", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -179,5 +179,5 @@ class PopDateMeasureDefinition( **kwargs, ) -from gooddata_api_client.model.afm_local_identifier import AfmLocalIdentifier -from gooddata_api_client.model.pop_date import PopDate +from gooddata_api_client.models.afm_local_identifier import AfmLocalIdentifier +from gooddata_api_client.models.pop_date import PopDate diff --git a/gooddata-api-client/gooddata_api_client/model/pop_date_measure_definition_over_period_measure.py b/gooddata-api-client/gooddata_api_client/model/pop_date_measure_definition_over_period_measure.py deleted file mode 100644 index dbc7ff11f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pop_date_measure_definition_over_period_measure.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_local_identifier import AfmLocalIdentifier - from gooddata_api_client.model.pop_date import PopDate - globals()['AfmLocalIdentifier'] = AfmLocalIdentifier - globals()['PopDate'] = PopDate - - -class PopDateMeasureDefinitionOverPeriodMeasure(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'date_attributes': ([PopDate],), # noqa: E501 - 'measure_identifier': (AfmLocalIdentifier,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'date_attributes': 'dateAttributes', # noqa: E501 - 'measure_identifier': 'measureIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, date_attributes, measure_identifier, *args, **kwargs): # noqa: E501 - """PopDateMeasureDefinitionOverPeriodMeasure - a model defined in OpenAPI - - Args: - date_attributes ([PopDate]): Attributes to use for determining the period to calculate the PoP for. - measure_identifier (AfmLocalIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.date_attributes = date_attributes - self.measure_identifier = measure_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, date_attributes, measure_identifier, *args, **kwargs): # noqa: E501 - """PopDateMeasureDefinitionOverPeriodMeasure - a model defined in OpenAPI - - Args: - date_attributes ([PopDate]): Attributes to use for determining the period to calculate the PoP for. - measure_identifier (AfmLocalIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.date_attributes = date_attributes - self.measure_identifier = measure_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pop_measure_definition.py b/gooddata-api-client/gooddata_api_client/model/pop_measure_definition.py deleted file mode 100644 index c2f162062..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pop_measure_definition.py +++ /dev/null @@ -1,331 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.pop_dataset_measure_definition import PopDatasetMeasureDefinition - from gooddata_api_client.model.pop_dataset_measure_definition_previous_period_measure import PopDatasetMeasureDefinitionPreviousPeriodMeasure - from gooddata_api_client.model.pop_date_measure_definition import PopDateMeasureDefinition - from gooddata_api_client.model.pop_date_measure_definition_over_period_measure import PopDateMeasureDefinitionOverPeriodMeasure - globals()['PopDatasetMeasureDefinition'] = PopDatasetMeasureDefinition - globals()['PopDatasetMeasureDefinitionPreviousPeriodMeasure'] = PopDatasetMeasureDefinitionPreviousPeriodMeasure - globals()['PopDateMeasureDefinition'] = PopDateMeasureDefinition - globals()['PopDateMeasureDefinitionOverPeriodMeasure'] = PopDateMeasureDefinitionOverPeriodMeasure - - -class PopMeasureDefinition(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'previous_period_measure': (PopDatasetMeasureDefinitionPreviousPeriodMeasure,), # noqa: E501 - 'over_period_measure': (PopDateMeasureDefinitionOverPeriodMeasure,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'previous_period_measure': 'previousPeriodMeasure', # noqa: E501 - 'over_period_measure': 'overPeriodMeasure', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """PopMeasureDefinition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - previous_period_measure (PopDatasetMeasureDefinitionPreviousPeriodMeasure): [optional] # noqa: E501 - over_period_measure (PopDateMeasureDefinitionOverPeriodMeasure): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PopMeasureDefinition - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - previous_period_measure (PopDatasetMeasureDefinitionPreviousPeriodMeasure): [optional] # noqa: E501 - over_period_measure (PopDateMeasureDefinitionOverPeriodMeasure): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - PopDatasetMeasureDefinition, - PopDateMeasureDefinition, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/pop_measure_definition.pyi b/gooddata-api-client/gooddata_api_client/model/pop_measure_definition.pyi index e4d2c6380..b950b19cd 100644 --- a/gooddata-api-client/gooddata_api_client/model/pop_measure_definition.pyi +++ b/gooddata-api-client/gooddata_api_client/model/pop_measure_definition.pyi @@ -66,5 +66,5 @@ class PopMeasureDefinition( **kwargs, ) -from gooddata_api_client.model.pop_dataset_measure_definition import PopDatasetMeasureDefinition -from gooddata_api_client.model.pop_date_measure_definition import PopDateMeasureDefinition +from gooddata_api_client.models.pop_dataset_measure_definition import PopDatasetMeasureDefinition +from gooddata_api_client.models.pop_date_measure_definition import PopDateMeasureDefinition diff --git a/gooddata-api-client/gooddata_api_client/model/positive_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/positive_attribute_filter.py deleted file mode 100644 index 8699c8a95..000000000 --- a/gooddata-api-client/gooddata_api_client/model/positive_attribute_filter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter - globals()['PositiveAttributeFilterPositiveAttributeFilter'] = PositiveAttributeFilterPositiveAttributeFilter - - -class PositiveAttributeFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'positive_attribute_filter': (PositiveAttributeFilterPositiveAttributeFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'positive_attribute_filter': 'positiveAttributeFilter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, positive_attribute_filter, *args, **kwargs): # noqa: E501 - """PositiveAttributeFilter - a model defined in OpenAPI - - Args: - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.positive_attribute_filter = positive_attribute_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, positive_attribute_filter, *args, **kwargs): # noqa: E501 - """PositiveAttributeFilter - a model defined in OpenAPI - - Args: - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.positive_attribute_filter = positive_attribute_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/positive_attribute_filter.pyi b/gooddata-api-client/gooddata_api_client/model/positive_attribute_filter.pyi index e9a62a3a0..9278372b5 100644 --- a/gooddata-api-client/gooddata_api_client/model/positive_attribute_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/positive_attribute_filter.pyi @@ -40,28 +40,28 @@ class PositiveAttributeFilter( required = { "positiveAttributeFilter", } - + class properties: - - + + class positiveAttributeFilter( schemas.DictSchema ): - - + + class MetaOapg: required = { "in", "label", } - + class properties: applyOnResult = schemas.BoolSchema - + @staticmethod def _in() -> typing.Type['AttributeFilterElements']: return AttributeFilterElements - + @staticmethod def label() -> typing.Type['AfmIdentifier']: return AfmIdentifier @@ -70,42 +70,42 @@ class PositiveAttributeFilter( "in": _in, "label": label, } - + label: 'AfmIdentifier' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["applyOnResult"]) -> MetaOapg.properties.applyOnResult: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["in"]) -> 'AttributeFilterElements': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["label"]) -> 'AfmIdentifier': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "in", "label", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["applyOnResult"]) -> typing.Union[MetaOapg.properties.applyOnResult, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["in"]) -> 'AttributeFilterElements': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["label"]) -> 'AfmIdentifier': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "in", "label", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -125,29 +125,29 @@ class PositiveAttributeFilter( __annotations__ = { "positiveAttributeFilter": positiveAttributeFilter, } - + positiveAttributeFilter: MetaOapg.properties.positiveAttributeFilter - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["positiveAttributeFilter"]) -> MetaOapg.properties.positiveAttributeFilter: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["positiveAttributeFilter", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["positiveAttributeFilter"]) -> MetaOapg.properties.positiveAttributeFilter: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["positiveAttributeFilter", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -164,5 +164,5 @@ class PositiveAttributeFilter( **kwargs, ) -from gooddata_api_client.model.afm_identifier import AfmIdentifier -from gooddata_api_client.model.attribute_filter_elements import AttributeFilterElements +from gooddata_api_client.models.afm_identifier import AfmIdentifier +from gooddata_api_client.models.attribute_filter_elements import AttributeFilterElements diff --git a/gooddata-api-client/gooddata_api_client/model/positive_attribute_filter_positive_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/positive_attribute_filter_positive_attribute_filter.py deleted file mode 100644 index ae53d56f8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/positive_attribute_filter_positive_attribute_filter.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_identifier import AfmIdentifier - from gooddata_api_client.model.attribute_filter_elements import AttributeFilterElements - globals()['AfmIdentifier'] = AfmIdentifier - globals()['AttributeFilterElements'] = AttributeFilterElements - - -class PositiveAttributeFilterPositiveAttributeFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - '_in': (AttributeFilterElements,), # noqa: E501 - 'label': (AfmIdentifier,), # noqa: E501 - 'apply_on_result': (bool,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - '_in': 'in', # noqa: E501 - 'label': 'label', # noqa: E501 - 'apply_on_result': 'applyOnResult', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, _in, label, *args, **kwargs): # noqa: E501 - """PositiveAttributeFilterPositiveAttributeFilter - a model defined in OpenAPI - - Args: - _in (AttributeFilterElements): - label (AfmIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self._in = _in - self.label = label - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, _in, label, *args, **kwargs): # noqa: E501 - """PositiveAttributeFilterPositiveAttributeFilter - a model defined in OpenAPI - - Args: - _in (AttributeFilterElements): - label (AfmIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self._in = _in - self.label = label - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/quality_issue.py b/gooddata-api-client/gooddata_api_client/model/quality_issue.py deleted file mode 100644 index 57e0d91aa..000000000 --- a/gooddata-api-client/gooddata_api_client/model/quality_issue.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.quality_issue_object import QualityIssueObject - globals()['QualityIssueObject'] = QualityIssueObject - - -class QualityIssue(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'code': (str,), # noqa: E501 - 'detail': ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)},), # noqa: E501 - 'objects': ([QualityIssueObject],), # noqa: E501 - 'severity': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'code': 'code', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'objects': 'objects', # noqa: E501 - 'severity': 'severity', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, code, detail, objects, severity, *args, **kwargs): # noqa: E501 - """QualityIssue - a model defined in OpenAPI - - Args: - code (str): - detail ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}): - objects ([QualityIssueObject]): - severity (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.code = code - self.detail = detail - self.objects = objects - self.severity = severity - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, code, detail, objects, severity, *args, **kwargs): # noqa: E501 - """QualityIssue - a model defined in OpenAPI - - Args: - code (str): - detail ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}): - objects ([QualityIssueObject]): - severity (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.code = code - self.detail = detail - self.objects = objects - self.severity = severity - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/quality_issue_object.py b/gooddata-api-client/gooddata_api_client/model/quality_issue_object.py deleted file mode 100644 index 6e440868b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/quality_issue_object.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class QualityIssueObject(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """QualityIssueObject - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """QualityIssueObject - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/range.py b/gooddata-api-client/gooddata_api_client/model/range.py deleted file mode 100644 index 6e11580ab..000000000 --- a/gooddata-api-client/gooddata_api_client/model/range.py +++ /dev/null @@ -1,300 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.local_identifier import LocalIdentifier - from gooddata_api_client.model.value import Value - globals()['LocalIdentifier'] = LocalIdentifier - globals()['Value'] = Value - - -class Range(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('operator',): { - 'BETWEEN': "BETWEEN", - 'NOT_BETWEEN': "NOT_BETWEEN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - '_from': (Value,), # noqa: E501 - 'measure': (LocalIdentifier,), # noqa: E501 - 'operator': (str,), # noqa: E501 - 'to': (Value,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - '_from': 'from', # noqa: E501 - 'measure': 'measure', # noqa: E501 - 'operator': 'operator', # noqa: E501 - 'to': 'to', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, _from, measure, operator, to, *args, **kwargs): # noqa: E501 - """Range - a model defined in OpenAPI - - Args: - _from (Value): - measure (LocalIdentifier): - operator (str): - to (Value): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self._from = _from - self.measure = measure - self.operator = operator - self.to = to - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, _from, measure, operator, to, *args, **kwargs): # noqa: E501 - """Range - a model defined in OpenAPI - - Args: - _from (Value): - measure (LocalIdentifier): - operator (str): - to (Value): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self._from = _from - self.measure = measure - self.operator = operator - self.to = to - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/range_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/model/range_measure_value_filter.py deleted file mode 100644 index 61e176497..000000000 --- a/gooddata-api-client/gooddata_api_client/model/range_measure_value_filter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter - globals()['RangeMeasureValueFilterRangeMeasureValueFilter'] = RangeMeasureValueFilterRangeMeasureValueFilter - - -class RangeMeasureValueFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'range_measure_value_filter': (RangeMeasureValueFilterRangeMeasureValueFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'range_measure_value_filter': 'rangeMeasureValueFilter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, range_measure_value_filter, *args, **kwargs): # noqa: E501 - """RangeMeasureValueFilter - a model defined in OpenAPI - - Args: - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.range_measure_value_filter = range_measure_value_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, range_measure_value_filter, *args, **kwargs): # noqa: E501 - """RangeMeasureValueFilter - a model defined in OpenAPI - - Args: - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.range_measure_value_filter = range_measure_value_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/range_measure_value_filter.pyi b/gooddata-api-client/gooddata_api_client/model/range_measure_value_filter.pyi index 579ae4acc..de01e7056 100644 --- a/gooddata-api-client/gooddata_api_client/model/range_measure_value_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/range_measure_value_filter.pyi @@ -40,15 +40,15 @@ class RangeMeasureValueFilter( required = { "rangeMeasureValueFilter", } - + class properties: - - + + class rangeMeasureValueFilter( schemas.DictSchema ): - - + + class MetaOapg: required = { "measure", @@ -56,25 +56,25 @@ class RangeMeasureValueFilter( "to", "operator", } - + class properties: applyOnResult = schemas.BoolSchema _from = schemas.NumberSchema - + @staticmethod def measure() -> typing.Type['AfmIdentifier']: return AfmIdentifier - - + + class operator( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def BETWEEN(cls): return cls("BETWEEN") - + @schemas.classproperty def NOT_BETWEEN(cls): return cls("NOT_BETWEEN") @@ -88,62 +88,62 @@ class RangeMeasureValueFilter( "to": to, "treatNullValuesAs": treatNullValuesAs, } - + measure: 'AfmIdentifier' to: MetaOapg.properties.to operator: MetaOapg.properties.operator - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["applyOnResult"]) -> MetaOapg.properties.applyOnResult: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["measure"]) -> 'AfmIdentifier': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["treatNullValuesAs"]) -> MetaOapg.properties.treatNullValuesAs: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "from", "measure", "operator", "to", "treatNullValuesAs", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["applyOnResult"]) -> typing.Union[MetaOapg.properties.applyOnResult, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["measure"]) -> 'AfmIdentifier': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["treatNullValuesAs"]) -> typing.Union[MetaOapg.properties.treatNullValuesAs, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "from", "measure", "operator", "to", "treatNullValuesAs", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -169,29 +169,29 @@ class RangeMeasureValueFilter( __annotations__ = { "rangeMeasureValueFilter": rangeMeasureValueFilter, } - + rangeMeasureValueFilter: MetaOapg.properties.rangeMeasureValueFilter - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["rangeMeasureValueFilter"]) -> MetaOapg.properties.rangeMeasureValueFilter: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["rangeMeasureValueFilter", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["rangeMeasureValueFilter"]) -> MetaOapg.properties.rangeMeasureValueFilter: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["rangeMeasureValueFilter", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -208,4 +208,4 @@ class RangeMeasureValueFilter( **kwargs, ) -from gooddata_api_client.model.afm_identifier import AfmIdentifier +from gooddata_api_client.models.afm_identifier import AfmIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/range_measure_value_filter_range_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/model/range_measure_value_filter_range_measure_value_filter.py deleted file mode 100644 index 5e6bf5d7c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/range_measure_value_filter_range_measure_value_filter.py +++ /dev/null @@ -1,314 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_identifier import AfmIdentifier - globals()['AfmIdentifier'] = AfmIdentifier - - -class RangeMeasureValueFilterRangeMeasureValueFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('operator',): { - 'BETWEEN': "BETWEEN", - 'NOT_BETWEEN': "NOT_BETWEEN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - '_from': (float,), # noqa: E501 - 'measure': (AfmIdentifier,), # noqa: E501 - 'operator': (str,), # noqa: E501 - 'to': (float,), # noqa: E501 - 'apply_on_result': (bool,), # noqa: E501 - 'dimensionality': ([AfmIdentifier],), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - 'treat_null_values_as': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - '_from': 'from', # noqa: E501 - 'measure': 'measure', # noqa: E501 - 'operator': 'operator', # noqa: E501 - 'to': 'to', # noqa: E501 - 'apply_on_result': 'applyOnResult', # noqa: E501 - 'dimensionality': 'dimensionality', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - 'treat_null_values_as': 'treatNullValuesAs', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, _from, measure, operator, to, *args, **kwargs): # noqa: E501 - """RangeMeasureValueFilterRangeMeasureValueFilter - a model defined in OpenAPI - - Args: - _from (float): - measure (AfmIdentifier): - operator (str): - to (float): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - dimensionality ([AfmIdentifier]): References to the attributes to be used when filtering.. [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - treat_null_values_as (float): A value that will be substituted for null values in the metric for the comparisons.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self._from = _from - self.measure = measure - self.operator = operator - self.to = to - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, _from, measure, operator, to, *args, **kwargs): # noqa: E501 - """RangeMeasureValueFilterRangeMeasureValueFilter - a model defined in OpenAPI - - Args: - _from (float): - measure (AfmIdentifier): - operator (str): - to (float): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - dimensionality ([AfmIdentifier]): References to the attributes to be used when filtering.. [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - treat_null_values_as (float): A value that will be substituted for null values in the metric for the comparisons.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self._from = _from - self.measure = measure - self.operator = operator - self.to = to - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/range_wrapper.py b/gooddata-api-client/gooddata_api_client/model/range_wrapper.py deleted file mode 100644 index 4a9c9476c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/range_wrapper.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.range import Range - globals()['Range'] = Range - - -class RangeWrapper(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'range': (Range,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'range': 'range', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, range, *args, **kwargs): # noqa: E501 - """RangeWrapper - a model defined in OpenAPI - - Args: - range (Range): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.range = range - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, range, *args, **kwargs): # noqa: E501 - """RangeWrapper - a model defined in OpenAPI - - Args: - range (Range): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.range = range - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/ranking_filter.py b/gooddata-api-client/gooddata_api_client/model/ranking_filter.py deleted file mode 100644 index 1f424f85f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/ranking_filter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.ranking_filter_ranking_filter import RankingFilterRankingFilter - globals()['RankingFilterRankingFilter'] = RankingFilterRankingFilter - - -class RankingFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'ranking_filter': (RankingFilterRankingFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'ranking_filter': 'rankingFilter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, ranking_filter, *args, **kwargs): # noqa: E501 - """RankingFilter - a model defined in OpenAPI - - Args: - ranking_filter (RankingFilterRankingFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.ranking_filter = ranking_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, ranking_filter, *args, **kwargs): # noqa: E501 - """RankingFilter - a model defined in OpenAPI - - Args: - ranking_filter (RankingFilterRankingFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.ranking_filter = ranking_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/ranking_filter.pyi b/gooddata-api-client/gooddata_api_client/model/ranking_filter.pyi index 2e3b868fc..63b215578 100644 --- a/gooddata-api-client/gooddata_api_client/model/ranking_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/ranking_filter.pyi @@ -40,37 +40,37 @@ class RankingFilter( required = { "rankingFilter", } - + class properties: - - + + class rankingFilter( schemas.DictSchema ): - - + + class MetaOapg: required = { "measures", "value", "operator", } - + class properties: applyOnResult = schemas.BoolSchema - - + + class measures( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['AfmIdentifier']: return AfmIdentifier - + def __new__( cls, _arg: typing.Union[typing.Tuple['AfmIdentifier'], typing.List['AfmIdentifier']], @@ -81,20 +81,20 @@ class RankingFilter( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'AfmIdentifier': return super().__getitem__(i) - - + + class operator( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def TOP(cls): return cls("TOP") - + @schemas.classproperty def BOTTOM(cls): return cls("BOTTOM") @@ -105,50 +105,50 @@ class RankingFilter( "operator": operator, "value": value, } - + measures: MetaOapg.properties.measures value: MetaOapg.properties.value operator: MetaOapg.properties.operator - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["applyOnResult"]) -> MetaOapg.properties.applyOnResult: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["measures"]) -> MetaOapg.properties.measures: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "measures", "operator", "value", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["applyOnResult"]) -> typing.Union[MetaOapg.properties.applyOnResult, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["measures"]) -> MetaOapg.properties.measures: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "measures", "operator", "value", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -172,29 +172,29 @@ class RankingFilter( __annotations__ = { "rankingFilter": rankingFilter, } - + rankingFilter: MetaOapg.properties.rankingFilter - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["rankingFilter"]) -> MetaOapg.properties.rankingFilter: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["rankingFilter", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["rankingFilter"]) -> MetaOapg.properties.rankingFilter: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["rankingFilter", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -211,4 +211,4 @@ class RankingFilter( **kwargs, ) -from gooddata_api_client.model.afm_identifier import AfmIdentifier +from gooddata_api_client.models.afm_identifier import AfmIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/ranking_filter_ranking_filter.py b/gooddata-api-client/gooddata_api_client/model/ranking_filter_ranking_filter.py deleted file mode 100644 index 03dcfa6d8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/ranking_filter_ranking_filter.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_identifier import AfmIdentifier - globals()['AfmIdentifier'] = AfmIdentifier - - -class RankingFilterRankingFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('operator',): { - 'TOP': "TOP", - 'BOTTOM': "BOTTOM", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'measures': ([AfmIdentifier],), # noqa: E501 - 'operator': (str,), # noqa: E501 - 'value': (int,), # noqa: E501 - 'apply_on_result': (bool,), # noqa: E501 - 'dimensionality': ([AfmIdentifier],), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'measures': 'measures', # noqa: E501 - 'operator': 'operator', # noqa: E501 - 'value': 'value', # noqa: E501 - 'apply_on_result': 'applyOnResult', # noqa: E501 - 'dimensionality': 'dimensionality', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, measures, operator, value, *args, **kwargs): # noqa: E501 - """RankingFilterRankingFilter - a model defined in OpenAPI - - Args: - measures ([AfmIdentifier]): References to the metrics to be used when filtering. - operator (str): The type of ranking to use, TOP or BOTTOM. - value (int): Number of top/bottom values to filter. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - dimensionality ([AfmIdentifier]): References to the attributes to be used when filtering.. [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measures = measures - self.operator = operator - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, measures, operator, value, *args, **kwargs): # noqa: E501 - """RankingFilterRankingFilter - a model defined in OpenAPI - - Args: - measures ([AfmIdentifier]): References to the metrics to be used when filtering. - operator (str): The type of ranking to use, TOP or BOTTOM. - value (int): Number of top/bottom values to filter. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - dimensionality ([AfmIdentifier]): References to the attributes to be used when filtering.. [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measures = measures - self.operator = operator - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/raw_custom_label.py b/gooddata-api-client/gooddata_api_client/model/raw_custom_label.py deleted file mode 100644 index e961048d5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/raw_custom_label.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class RawCustomLabel(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, title, *args, **kwargs): # noqa: E501 - """RawCustomLabel - a model defined in OpenAPI - - Args: - title (str): Override value. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, title, *args, **kwargs): # noqa: E501 - """RawCustomLabel - a model defined in OpenAPI - - Args: - title (str): Override value. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/raw_custom_metric.py b/gooddata-api-client/gooddata_api_client/model/raw_custom_metric.py deleted file mode 100644 index 0ffa16c40..000000000 --- a/gooddata-api-client/gooddata_api_client/model/raw_custom_metric.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class RawCustomMetric(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, title, *args, **kwargs): # noqa: E501 - """RawCustomMetric - a model defined in OpenAPI - - Args: - title (str): Metric title override. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, title, *args, **kwargs): # noqa: E501 - """RawCustomMetric - a model defined in OpenAPI - - Args: - title (str): Metric title override. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/raw_custom_override.py b/gooddata-api-client/gooddata_api_client/model/raw_custom_override.py deleted file mode 100644 index f6a62320a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/raw_custom_override.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.raw_custom_label import RawCustomLabel - from gooddata_api_client.model.raw_custom_metric import RawCustomMetric - globals()['RawCustomLabel'] = RawCustomLabel - globals()['RawCustomMetric'] = RawCustomMetric - - -class RawCustomOverride(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'labels': ({str: (RawCustomLabel,)},), # noqa: E501 - 'metrics': ({str: (RawCustomMetric,)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'labels': 'labels', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RawCustomOverride - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - labels ({str: (RawCustomLabel,)}): Map of CustomLabels with keys used as placeholders in export result.. [optional] # noqa: E501 - metrics ({str: (RawCustomMetric,)}): Map of CustomMetrics with keys used as placeholders in export result.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """RawCustomOverride - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - labels ({str: (RawCustomLabel,)}): Map of CustomLabels with keys used as placeholders in export result.. [optional] # noqa: E501 - metrics ({str: (RawCustomMetric,)}): Map of CustomMetrics with keys used as placeholders in export result.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/raw_export_automation_request.py b/gooddata-api-client/gooddata_api_client/model/raw_export_automation_request.py deleted file mode 100644 index 64ba5d050..000000000 --- a/gooddata-api-client/gooddata_api_client/model/raw_export_automation_request.py +++ /dev/null @@ -1,311 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm import AFM - from gooddata_api_client.model.execution_settings import ExecutionSettings - from gooddata_api_client.model.json_node import JsonNode - from gooddata_api_client.model.raw_custom_override import RawCustomOverride - globals()['AFM'] = AFM - globals()['ExecutionSettings'] = ExecutionSettings - globals()['JsonNode'] = JsonNode - globals()['RawCustomOverride'] = RawCustomOverride - - -class RawExportAutomationRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('format',): { - 'ARROW_FILE': "ARROW_FILE", - 'ARROW_STREAM': "ARROW_STREAM", - 'CSV': "CSV", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'execution': (AFM,), # noqa: E501 - 'file_name': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - 'custom_override': (RawCustomOverride,), # noqa: E501 - 'execution_settings': (ExecutionSettings,), # noqa: E501 - 'metadata': (JsonNode,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'execution': 'execution', # noqa: E501 - 'file_name': 'fileName', # noqa: E501 - 'format': 'format', # noqa: E501 - 'custom_override': 'customOverride', # noqa: E501 - 'execution_settings': 'executionSettings', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, execution, file_name, format, *args, **kwargs): # noqa: E501 - """RawExportAutomationRequest - a model defined in OpenAPI - - Args: - execution (AFM): - file_name (str): Filename of downloaded file without extension. - format (str): Requested resulting file type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_override (RawCustomOverride): [optional] # noqa: E501 - execution_settings (ExecutionSettings): [optional] # noqa: E501 - metadata (JsonNode): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.execution = execution - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, execution, file_name, format, *args, **kwargs): # noqa: E501 - """RawExportAutomationRequest - a model defined in OpenAPI - - Args: - execution (AFM): - file_name (str): Filename of downloaded file without extension. - format (str): Requested resulting file type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_override (RawCustomOverride): [optional] # noqa: E501 - execution_settings (ExecutionSettings): [optional] # noqa: E501 - metadata (JsonNode): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.execution = execution - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/raw_export_request.py b/gooddata-api-client/gooddata_api_client/model/raw_export_request.py deleted file mode 100644 index a88a0cba4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/raw_export_request.py +++ /dev/null @@ -1,305 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm import AFM - from gooddata_api_client.model.execution_settings import ExecutionSettings - from gooddata_api_client.model.raw_custom_override import RawCustomOverride - globals()['AFM'] = AFM - globals()['ExecutionSettings'] = ExecutionSettings - globals()['RawCustomOverride'] = RawCustomOverride - - -class RawExportRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('format',): { - 'ARROW_FILE': "ARROW_FILE", - 'ARROW_STREAM': "ARROW_STREAM", - 'CSV': "CSV", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'execution': (AFM,), # noqa: E501 - 'file_name': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - 'custom_override': (RawCustomOverride,), # noqa: E501 - 'execution_settings': (ExecutionSettings,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'execution': 'execution', # noqa: E501 - 'file_name': 'fileName', # noqa: E501 - 'format': 'format', # noqa: E501 - 'custom_override': 'customOverride', # noqa: E501 - 'execution_settings': 'executionSettings', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, execution, file_name, format, *args, **kwargs): # noqa: E501 - """RawExportRequest - a model defined in OpenAPI - - Args: - execution (AFM): - file_name (str): Filename of downloaded file without extension. - format (str): Requested resulting file type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_override (RawCustomOverride): [optional] # noqa: E501 - execution_settings (ExecutionSettings): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.execution = execution - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, execution, file_name, format, *args, **kwargs): # noqa: E501 - """RawExportRequest - a model defined in OpenAPI - - Args: - execution (AFM): - file_name (str): Filename of downloaded file without extension. - format (str): Requested resulting file type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_override (RawCustomOverride): [optional] # noqa: E501 - execution_settings (ExecutionSettings): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.execution = execution - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/reference_identifier.py b/gooddata-api-client/gooddata_api_client/model/reference_identifier.py deleted file mode 100644 index ac418586f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/reference_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ReferenceIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'DATASET': "dataset", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """ReferenceIdentifier - a model defined in OpenAPI - - Args: - id (str): Reference ID. - - Keyword Args: - type (str): A type of the reference.. defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """ReferenceIdentifier - a model defined in OpenAPI - - Args: - id (str): Reference ID. - - Keyword Args: - type (str): A type of the reference.. defaults to "dataset", must be one of ["dataset", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "dataset") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/reference_source_column.py b/gooddata-api-client/gooddata_api_client/model/reference_source_column.py deleted file mode 100644 index ca9021be5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/reference_source_column.py +++ /dev/null @@ -1,295 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dataset_grain import DatasetGrain - globals()['DatasetGrain'] = DatasetGrain - - -class ReferenceSourceColumn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'column': (str,), # noqa: E501 - 'target': (DatasetGrain,), # noqa: E501 - 'data_type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'column': 'column', # noqa: E501 - 'target': 'target', # noqa: E501 - 'data_type': 'dataType', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, column, target, *args, **kwargs): # noqa: E501 - """ReferenceSourceColumn - a model defined in OpenAPI - - Args: - column (str): - target (DatasetGrain): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_type (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column = column - self.target = target - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, column, target, *args, **kwargs): # noqa: E501 - """ReferenceSourceColumn - a model defined in OpenAPI - - Args: - column (str): - target (DatasetGrain): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_type (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column = column - self.target = target - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/relative.py b/gooddata-api-client/gooddata_api_client/model/relative.py deleted file mode 100644 index 8b1ae1829..000000000 --- a/gooddata-api-client/gooddata_api_client/model/relative.py +++ /dev/null @@ -1,295 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.arithmetic_measure import ArithmeticMeasure - from gooddata_api_client.model.value import Value - globals()['ArithmeticMeasure'] = ArithmeticMeasure - globals()['Value'] = Value - - -class Relative(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('operator',): { - 'INCREASES_BY': "INCREASES_BY", - 'DECREASES_BY': "DECREASES_BY", - 'CHANGES_BY': "CHANGES_BY", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'measure': (ArithmeticMeasure,), # noqa: E501 - 'operator': (str,), # noqa: E501 - 'threshold': (Value,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'measure': 'measure', # noqa: E501 - 'operator': 'operator', # noqa: E501 - 'threshold': 'threshold', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, measure, operator, threshold, *args, **kwargs): # noqa: E501 - """Relative - a model defined in OpenAPI - - Args: - measure (ArithmeticMeasure): - operator (str): Relative condition operator. INCREASES_BY - the metric increases by the specified value. DECREASES_BY - the metric decreases by the specified value. CHANGES_BY - the metric increases or decreases by the specified value. - threshold (Value): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure = measure - self.operator = operator - self.threshold = threshold - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, measure, operator, threshold, *args, **kwargs): # noqa: E501 - """Relative - a model defined in OpenAPI - - Args: - measure (ArithmeticMeasure): - operator (str): Relative condition operator. INCREASES_BY - the metric increases by the specified value. DECREASES_BY - the metric decreases by the specified value. CHANGES_BY - the metric increases or decreases by the specified value. - threshold (Value): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure = measure - self.operator = operator - self.threshold = threshold - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/relative_bounded_date_filter.py b/gooddata-api-client/gooddata_api_client/model/relative_bounded_date_filter.py deleted file mode 100644 index 2e24800fd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/relative_bounded_date_filter.py +++ /dev/null @@ -1,303 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class RelativeBoundedDateFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularity',): { - 'ALL_TIME_GRANULARITY': "ALL_TIME_GRANULARITY", - 'GDC.TIME.YEAR': "GDC.time.year", - 'GDC.TIME.WEEK_US': "GDC.time.week_us", - 'GDC.TIME.WEEK_IN_YEAR': "GDC.time.week_in_year", - 'GDC.TIME.WEEK_IN_QUARTER': "GDC.time.week_in_quarter", - 'GDC.TIME.WEEK': "GDC.time.week", - 'GDC.TIME.EUWEEK_IN_YEAR': "GDC.time.euweek_in_year", - 'GDC.TIME.EUWEEK_IN_QUARTER': "GDC.time.euweek_in_quarter", - 'GDC.TIME.QUARTER': "GDC.time.quarter", - 'GDC.TIME.QUARTER_IN_YEAR': "GDC.time.quarter_in_year", - 'GDC.TIME.MONTH': "GDC.time.month", - 'GDC.TIME.MONTH_IN_QUARTER': "GDC.time.month_in_quarter", - 'GDC.TIME.MONTH_IN_YEAR': "GDC.time.month_in_year", - 'GDC.TIME.DAY_IN_YEAR': "GDC.time.day_in_year", - 'GDC.TIME.DAY_IN_QUARTER': "GDC.time.day_in_quarter", - 'GDC.TIME.DAY_IN_MONTH': "GDC.time.day_in_month", - 'GDC.TIME.DAY_IN_WEEK': "GDC.time.day_in_week", - 'GDC.TIME.DAY_IN_EUWEEK': "GDC.time.day_in_euweek", - 'GDC.TIME.DATE': "GDC.time.date", - 'GDC.TIME.HOUR': "GDC.time.hour", - 'GDC.TIME.HOUR_IN_DAY': "GDC.time.hour_in_day", - 'GDC.TIME.MINUTE': "GDC.time.minute", - 'GDC.TIME.MINUTE_IN_HOUR': "GDC.time.minute_in_hour", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'granularity': (str,), # noqa: E501 - '_from': (int,), # noqa: E501 - 'to': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'granularity': 'granularity', # noqa: E501 - '_from': 'from', # noqa: E501 - 'to': 'to', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, granularity, *args, **kwargs): # noqa: E501 - """RelativeBoundedDateFilter - a model defined in OpenAPI - - Args: - granularity (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - _from (int): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.granularity = granularity - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, granularity, *args, **kwargs): # noqa: E501 - """RelativeBoundedDateFilter - a model defined in OpenAPI - - Args: - granularity (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - _from (int): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.granularity = granularity - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/relative_date_filter.py b/gooddata-api-client/gooddata_api_client/model/relative_date_filter.py deleted file mode 100644 index 8de03016f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/relative_date_filter.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter - globals()['RelativeDateFilterRelativeDateFilter'] = RelativeDateFilterRelativeDateFilter - - -class RelativeDateFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'relative_date_filter': 'relativeDateFilter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, relative_date_filter, *args, **kwargs): # noqa: E501 - """RelativeDateFilter - a model defined in OpenAPI - - Args: - relative_date_filter (RelativeDateFilterRelativeDateFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.relative_date_filter = relative_date_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, relative_date_filter, *args, **kwargs): # noqa: E501 - """RelativeDateFilter - a model defined in OpenAPI - - Args: - relative_date_filter (RelativeDateFilterRelativeDateFilter): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.relative_date_filter = relative_date_filter - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/relative_date_filter.pyi b/gooddata-api-client/gooddata_api_client/model/relative_date_filter.pyi index 0f69504b0..88ae91d82 100644 --- a/gooddata-api-client/gooddata_api_client/model/relative_date_filter.pyi +++ b/gooddata-api-client/gooddata_api_client/model/relative_date_filter.pyi @@ -40,15 +40,15 @@ class RelativeDateFilter( required = { "relativeDateFilter", } - + class properties: - - + + class relativeDateFilter( schemas.DictSchema ): - - + + class MetaOapg: required = { "granularity", @@ -56,77 +56,77 @@ class RelativeDateFilter( "to", "dataset", } - + class properties: applyOnResult = schemas.BoolSchema - + @staticmethod def dataset() -> typing.Type['AfmObjectIdentifierDataset']: return AfmObjectIdentifierDataset _from = schemas.Int32Schema - - + + class granularity( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def MINUTE(cls): return cls("MINUTE") - + @schemas.classproperty def HOUR(cls): return cls("HOUR") - + @schemas.classproperty def DAY(cls): return cls("DAY") - + @schemas.classproperty def WEEK(cls): return cls("WEEK") - + @schemas.classproperty def MONTH(cls): return cls("MONTH") - + @schemas.classproperty def QUARTER(cls): return cls("QUARTER") - + @schemas.classproperty def YEAR(cls): return cls("YEAR") - + @schemas.classproperty def MINUTE_OF_HOUR(cls): return cls("MINUTE_OF_HOUR") - + @schemas.classproperty def HOUR_OF_DAY(cls): return cls("HOUR_OF_DAY") - + @schemas.classproperty def DAY_OF_WEEK(cls): return cls("DAY_OF_WEEK") - + @schemas.classproperty def DAY_OF_MONTH(cls): return cls("DAY_OF_MONTH") - + @schemas.classproperty def DAY_OF_YEAR(cls): return cls("DAY_OF_YEAR") - + @schemas.classproperty def WEEK_OF_YEAR(cls): return cls("WEEK_OF_YEAR") - + @schemas.classproperty def MONTH_OF_YEAR(cls): return cls("MONTH_OF_YEAR") - + @schemas.classproperty def QUARTER_OF_YEAR(cls): return cls("QUARTER_OF_YEAR") @@ -138,56 +138,56 @@ class RelativeDateFilter( "granularity": granularity, "to": to, } - + granularity: MetaOapg.properties.granularity to: MetaOapg.properties.to dataset: 'AfmObjectIdentifierDataset' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["applyOnResult"]) -> MetaOapg.properties.applyOnResult: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataset"]) -> 'AfmObjectIdentifierDataset': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "dataset", "from", "granularity", "to", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["applyOnResult"]) -> typing.Union[MetaOapg.properties.applyOnResult, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataset"]) -> 'AfmObjectIdentifierDataset': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "dataset", "from", "granularity", "to", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -211,29 +211,29 @@ class RelativeDateFilter( __annotations__ = { "relativeDateFilter": relativeDateFilter, } - + relativeDateFilter: MetaOapg.properties.relativeDateFilter - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["relativeDateFilter"]) -> MetaOapg.properties.relativeDateFilter: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["relativeDateFilter", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["relativeDateFilter"]) -> MetaOapg.properties.relativeDateFilter: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["relativeDateFilter", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -250,4 +250,4 @@ class RelativeDateFilter( **kwargs, ) -from gooddata_api_client.model.afm_object_identifier_dataset import AfmObjectIdentifierDataset +from gooddata_api_client.models.afm_object_identifier_dataset import AfmObjectIdentifierDataset diff --git a/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py b/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py deleted file mode 100644 index 4ff37b0ce..000000000 --- a/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py +++ /dev/null @@ -1,326 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_dataset import AfmObjectIdentifierDataset - from gooddata_api_client.model.bounded_filter import BoundedFilter - globals()['AfmObjectIdentifierDataset'] = AfmObjectIdentifierDataset - globals()['BoundedFilter'] = BoundedFilter - - -class RelativeDateFilterRelativeDateFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('granularity',): { - 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", - 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", - 'HOUR_OF_DAY': "HOUR_OF_DAY", - 'DAY_OF_WEEK': "DAY_OF_WEEK", - 'DAY_OF_MONTH': "DAY_OF_MONTH", - 'DAY_OF_QUARTER': "DAY_OF_QUARTER", - 'DAY_OF_YEAR': "DAY_OF_YEAR", - 'WEEK_OF_YEAR': "WEEK_OF_YEAR", - 'MONTH_OF_YEAR': "MONTH_OF_YEAR", - 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dataset': (AfmObjectIdentifierDataset,), # noqa: E501 - '_from': (int,), # noqa: E501 - 'granularity': (str,), # noqa: E501 - 'to': (int,), # noqa: E501 - 'apply_on_result': (bool,), # noqa: E501 - 'bounded_filter': (BoundedFilter,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dataset': 'dataset', # noqa: E501 - '_from': 'from', # noqa: E501 - 'granularity': 'granularity', # noqa: E501 - 'to': 'to', # noqa: E501 - 'apply_on_result': 'applyOnResult', # noqa: E501 - 'bounded_filter': 'boundedFilter', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dataset, _from, granularity, to, *args, **kwargs): # noqa: E501 - """RelativeDateFilterRelativeDateFilter - a model defined in OpenAPI - - Args: - dataset (AfmObjectIdentifierDataset): - _from (int): Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). - granularity (str): Date granularity specifying particular date attribute in given dimension. - to (int): End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - bounded_filter (BoundedFilter): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dataset = dataset - self._from = _from - self.granularity = granularity - self.to = to - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dataset, _from, granularity, to, *args, **kwargs): # noqa: E501 - """RelativeDateFilterRelativeDateFilter - a model defined in OpenAPI - - Args: - dataset (AfmObjectIdentifierDataset): - _from (int): Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). - granularity (str): Date granularity specifying particular date attribute in given dimension. - to (int): End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - apply_on_result (bool): [optional] # noqa: E501 - bounded_filter (BoundedFilter): [optional] # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dataset = dataset - self._from = _from - self.granularity = granularity - self.to = to - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/relative_wrapper.py b/gooddata-api-client/gooddata_api_client/model/relative_wrapper.py deleted file mode 100644 index b3cd8c139..000000000 --- a/gooddata-api-client/gooddata_api_client/model/relative_wrapper.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.relative import Relative - globals()['Relative'] = Relative - - -class RelativeWrapper(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'relative': (Relative,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'relative': 'relative', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, relative, *args, **kwargs): # noqa: E501 - """RelativeWrapper - a model defined in OpenAPI - - Args: - relative (Relative): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.relative = relative - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, relative, *args, **kwargs): # noqa: E501 - """RelativeWrapper - a model defined in OpenAPI - - Args: - relative (Relative): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.relative = relative - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/resolve_settings_request.py b/gooddata-api-client/gooddata_api_client/model/resolve_settings_request.py deleted file mode 100644 index 500a9ed31..000000000 --- a/gooddata-api-client/gooddata_api_client/model/resolve_settings_request.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ResolveSettingsRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'settings': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'settings': 'settings', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, settings, *args, **kwargs): # noqa: E501 - """ResolveSettingsRequest - a model defined in OpenAPI - - Args: - settings ([str]): An array of setting IDs to resolve. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.settings = settings - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, settings, *args, **kwargs): # noqa: E501 - """ResolveSettingsRequest - a model defined in OpenAPI - - Args: - settings ([str]): An array of setting IDs to resolve. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.settings = settings - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoint.py b/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoint.py deleted file mode 100644 index 50c9ee7ba..000000000 --- a/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoint.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ResolvedLlmEndpoint(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 - """ResolvedLlmEndpoint - a model defined in OpenAPI - - Args: - id (str): Endpoint Id - title (str): Endpoint Title - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, title, *args, **kwargs): # noqa: E501 - """ResolvedLlmEndpoint - a model defined in OpenAPI - - Args: - id (str): Endpoint Id - title (str): Endpoint Title - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoints.py b/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoints.py deleted file mode 100644 index c9e0f9cf6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoints.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.resolved_llm_endpoint import ResolvedLlmEndpoint - globals()['ResolvedLlmEndpoint'] = ResolvedLlmEndpoint - - -class ResolvedLlmEndpoints(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ([ResolvedLlmEndpoint],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """ResolvedLlmEndpoints - a model defined in OpenAPI - - Args: - data ([ResolvedLlmEndpoint]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """ResolvedLlmEndpoints - a model defined in OpenAPI - - Args: - data ([ResolvedLlmEndpoint]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py deleted file mode 100644 index 213c7c112..000000000 --- a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py +++ /dev/null @@ -1,316 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_node import JsonNode - globals()['JsonNode'] = JsonNode - - -class ResolvedSetting(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'TIMEZONE': "TIMEZONE", - 'ACTIVE_THEME': "ACTIVE_THEME", - 'ACTIVE_COLOR_PALETTE': "ACTIVE_COLOR_PALETTE", - 'ACTIVE_LLM_ENDPOINT': "ACTIVE_LLM_ENDPOINT", - 'WHITE_LABELING': "WHITE_LABELING", - 'LOCALE': "LOCALE", - 'METADATA_LOCALE': "METADATA_LOCALE", - 'FORMAT_LOCALE': "FORMAT_LOCALE", - 'MAPBOX_TOKEN': "MAPBOX_TOKEN", - 'AG_GRID_TOKEN': "AG_GRID_TOKEN", - 'WEEK_START': "WEEK_START", - 'SHOW_HIDDEN_CATALOG_ITEMS': "SHOW_HIDDEN_CATALOG_ITEMS", - 'OPERATOR_OVERRIDES': "OPERATOR_OVERRIDES", - 'TIMEZONE_VALIDATION_ENABLED': "TIMEZONE_VALIDATION_ENABLED", - 'OPENAI_CONFIG': "OPENAI_CONFIG", - 'ENABLE_FILE_ANALYTICS': "ENABLE_FILE_ANALYTICS", - 'ALERT': "ALERT", - 'SEPARATORS': "SEPARATORS", - 'DATE_FILTER_CONFIG': "DATE_FILTER_CONFIG", - 'JIT_PROVISIONING': "JIT_PROVISIONING", - 'JWT_JIT_PROVISIONING': "JWT_JIT_PROVISIONING", - 'DASHBOARD_FILTERS_APPLY_MODE': "DASHBOARD_FILTERS_APPLY_MODE", - 'ENABLE_SLIDES_EXPORT': "ENABLE_SLIDES_EXPORT", - 'AI_RATE_LIMIT': "AI_RATE_LIMIT", - 'ATTACHMENT_SIZE_LIMIT': "ATTACHMENT_SIZE_LIMIT", - 'ATTACHMENT_LINK_TTL': "ATTACHMENT_LINK_TTL", - 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE': "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS': "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - 'ENABLE_AUTOMATION_EVALUATION_MODE': "ENABLE_AUTOMATION_EVALUATION_MODE", - 'REGISTERED_PLUGGABLE_APPLICATIONS': "REGISTERED_PLUGGABLE_APPLICATIONS", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'content': (JsonNode,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'content': 'content', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """ResolvedSetting - a model defined in OpenAPI - - Args: - id (str): Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content (JsonNode): [optional] # noqa: E501 - type (str): Type of the setting.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """ResolvedSetting - a model defined in OpenAPI - - Args: - id (str): Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content (JsonNode): [optional] # noqa: E501 - type (str): Type of the setting.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/rest_api_identifier.py b/gooddata-api-client/gooddata_api_client/model/rest_api_identifier.py deleted file mode 100644 index 4b8e4e36d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/rest_api_identifier.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class RestApiIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """RestApiIdentifier - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """RestApiIdentifier - a model defined in OpenAPI - - Args: - id (str): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/result_cache_metadata.py b/gooddata-api-client/gooddata_api_client/model/result_cache_metadata.py deleted file mode 100644 index dc26ed7f4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/result_cache_metadata.py +++ /dev/null @@ -1,298 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm import AFM - from gooddata_api_client.model.execution_response import ExecutionResponse - from gooddata_api_client.model.result_spec import ResultSpec - globals()['AFM'] = AFM - globals()['ExecutionResponse'] = ExecutionResponse - globals()['ResultSpec'] = ResultSpec - - -class ResultCacheMetadata(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'afm': (AFM,), # noqa: E501 - 'execution_response': (ExecutionResponse,), # noqa: E501 - 'result_size': (int,), # noqa: E501 - 'result_spec': (ResultSpec,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'afm': 'afm', # noqa: E501 - 'execution_response': 'executionResponse', # noqa: E501 - 'result_size': 'resultSize', # noqa: E501 - 'result_spec': 'resultSpec', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, afm, execution_response, result_size, result_spec, *args, **kwargs): # noqa: E501 - """ResultCacheMetadata - a model defined in OpenAPI - - Args: - afm (AFM): - execution_response (ExecutionResponse): - result_size (int): - result_spec (ResultSpec): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.afm = afm - self.execution_response = execution_response - self.result_size = result_size - self.result_spec = result_spec - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, afm, execution_response, result_size, result_spec, *args, **kwargs): # noqa: E501 - """ResultCacheMetadata - a model defined in OpenAPI - - Args: - afm (AFM): - execution_response (ExecutionResponse): - result_size (int): - result_spec (ResultSpec): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.afm = afm - self.execution_response = execution_response - self.result_size = result_size - self.result_spec = result_spec - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/result_cache_metadata.pyi b/gooddata-api-client/gooddata_api_client/model/result_cache_metadata.pyi index 12451dcfe..b6eb3d224 100644 --- a/gooddata-api-client/gooddata_api_client/model/result_cache_metadata.pyi +++ b/gooddata-api-client/gooddata_api_client/model/result_cache_metadata.pyi @@ -43,18 +43,18 @@ class ResultCacheMetadata( "resultSize", "afm", } - + class properties: - + @staticmethod def afm() -> typing.Type['AFM']: return AFM - + @staticmethod def executionResponse() -> typing.Type['ExecutionResponse']: return ExecutionResponse resultSize = schemas.Int64Schema - + @staticmethod def resultSpec() -> typing.Type['ResultSpec']: return ResultSpec @@ -64,50 +64,50 @@ class ResultCacheMetadata( "resultSize": resultSize, "resultSpec": resultSpec, } - + executionResponse: 'ExecutionResponse' resultSpec: 'ResultSpec' resultSize: MetaOapg.properties.resultSize afm: 'AFM' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["afm"]) -> 'AFM': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["executionResponse"]) -> 'ExecutionResponse': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["resultSize"]) -> MetaOapg.properties.resultSize: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["resultSpec"]) -> 'ResultSpec': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["afm", "executionResponse", "resultSize", "resultSpec", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["afm"]) -> 'AFM': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["executionResponse"]) -> 'ExecutionResponse': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["resultSize"]) -> MetaOapg.properties.resultSize: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["resultSpec"]) -> 'ResultSpec': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["afm", "executionResponse", "resultSize", "resultSpec", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -130,6 +130,6 @@ class ResultCacheMetadata( **kwargs, ) -from gooddata_api_client.model.afm import AFM -from gooddata_api_client.model.execution_response import ExecutionResponse -from gooddata_api_client.model.result_spec import ResultSpec +from gooddata_api_client.models.afm import AFM +from gooddata_api_client.models.execution_response import ExecutionResponse +from gooddata_api_client.models.result_spec import ResultSpec diff --git a/gooddata-api-client/gooddata_api_client/model/result_dimension.py b/gooddata-api-client/gooddata_api_client/model/result_dimension.py deleted file mode 100644 index f1478ef92..000000000 --- a/gooddata-api-client/gooddata_api_client/model/result_dimension.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.result_dimension_header import ResultDimensionHeader - globals()['ResultDimensionHeader'] = ResultDimensionHeader - - -class ResultDimension(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'headers': ([ResultDimensionHeader],), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'headers': 'headers', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, headers, local_identifier, *args, **kwargs): # noqa: E501 - """ResultDimension - a model defined in OpenAPI - - Args: - headers ([ResultDimensionHeader]): - local_identifier (str): Local identifier of the dimension. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.headers = headers - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, headers, local_identifier, *args, **kwargs): # noqa: E501 - """ResultDimension - a model defined in OpenAPI - - Args: - headers ([ResultDimensionHeader]): - local_identifier (str): Local identifier of the dimension. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.headers = headers - self.local_identifier = local_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/result_dimension.pyi b/gooddata-api-client/gooddata_api_client/model/result_dimension.pyi index c0f269c81..54eb821ef 100644 --- a/gooddata-api-client/gooddata_api_client/model/result_dimension.pyi +++ b/gooddata-api-client/gooddata_api_client/model/result_dimension.pyi @@ -39,21 +39,21 @@ class ResultDimension( "headers", "localIdentifier", } - + class properties: - - + + class headers( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['ResultDimensionHeader']: return ResultDimensionHeader - + def __new__( cls, _arg: typing.Union[typing.Tuple['ResultDimensionHeader'], typing.List['ResultDimensionHeader']], @@ -64,7 +64,7 @@ class ResultDimension( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'ResultDimensionHeader': return super().__getitem__(i) localIdentifier = schemas.StrSchema @@ -72,36 +72,36 @@ class ResultDimension( "headers": headers, "localIdentifier": localIdentifier, } - + headers: MetaOapg.properties.headers localIdentifier: MetaOapg.properties.localIdentifier - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["headers"]) -> MetaOapg.properties.headers: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["headers", "localIdentifier", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["headers"]) -> MetaOapg.properties.headers: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["headers", "localIdentifier", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -120,4 +120,4 @@ class ResultDimension( **kwargs, ) -from gooddata_api_client.model.result_dimension_header import ResultDimensionHeader +from gooddata_api_client.models.result_dimension_header import ResultDimensionHeader diff --git a/gooddata-api-client/gooddata_api_client/model/result_dimension_header.py b/gooddata-api-client/gooddata_api_client/model/result_dimension_header.py deleted file mode 100644 index 8d65a7d7a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/result_dimension_header.py +++ /dev/null @@ -1,331 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_header import AttributeHeader - from gooddata_api_client.model.attribute_header_attribute_header import AttributeHeaderAttributeHeader - from gooddata_api_client.model.measure_group_headers import MeasureGroupHeaders - from gooddata_api_client.model.measure_header import MeasureHeader - globals()['AttributeHeader'] = AttributeHeader - globals()['AttributeHeaderAttributeHeader'] = AttributeHeaderAttributeHeader - globals()['MeasureGroupHeaders'] = MeasureGroupHeaders - globals()['MeasureHeader'] = MeasureHeader - - -class ResultDimensionHeader(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'measure_group_headers': ([MeasureHeader],), # noqa: E501 - 'attribute_header': (AttributeHeaderAttributeHeader,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'measure_group_headers': 'measureGroupHeaders', # noqa: E501 - 'attribute_header': 'attributeHeader', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ResultDimensionHeader - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - measure_group_headers ([MeasureHeader]): [optional] # noqa: E501 - attribute_header (AttributeHeaderAttributeHeader): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ResultDimensionHeader - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - measure_group_headers ([MeasureHeader]): [optional] # noqa: E501 - attribute_header (AttributeHeaderAttributeHeader): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AttributeHeader, - MeasureGroupHeaders, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/result_dimension_header.pyi b/gooddata-api-client/gooddata_api_client/model/result_dimension_header.pyi index 14942d522..9b97d1e91 100644 --- a/gooddata-api-client/gooddata_api_client/model/result_dimension_header.pyi +++ b/gooddata-api-client/gooddata_api_client/model/result_dimension_header.pyi @@ -36,7 +36,7 @@ class ResultDimensionHeader( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -66,5 +66,5 @@ class ResultDimensionHeader( **kwargs, ) -from gooddata_api_client.model.attribute_header_out import AttributeHeaderOut -from gooddata_api_client.model.measure_group_headers import MeasureGroupHeaders +from gooddata_api_client.models.attribute_header_out import AttributeHeaderOut +from gooddata_api_client.models.measure_group_headers import MeasureGroupHeaders diff --git a/gooddata-api-client/gooddata_api_client/model/result_spec.py b/gooddata-api-client/gooddata_api_client/model/result_spec.py deleted file mode 100644 index b137eaa50..000000000 --- a/gooddata-api-client/gooddata_api_client/model/result_spec.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.dimension import Dimension - from gooddata_api_client.model.total import Total - globals()['Dimension'] = Dimension - globals()['Total'] = Total - - -class ResultSpec(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'dimensions': ([Dimension],), # noqa: E501 - 'totals': ([Total],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dimensions': 'dimensions', # noqa: E501 - 'totals': 'totals', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dimensions, *args, **kwargs): # noqa: E501 - """ResultSpec - a model defined in OpenAPI - - Args: - dimensions ([Dimension]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - totals ([Total]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dimensions = dimensions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dimensions, *args, **kwargs): # noqa: E501 - """ResultSpec - a model defined in OpenAPI - - Args: - dimensions ([Dimension]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - totals ([Total]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dimensions = dimensions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/result_spec.pyi b/gooddata-api-client/gooddata_api_client/model/result_spec.pyi index cce2d27c5..2185c0ea0 100644 --- a/gooddata-api-client/gooddata_api_client/model/result_spec.pyi +++ b/gooddata-api-client/gooddata_api_client/model/result_spec.pyi @@ -40,21 +40,21 @@ class ResultSpec( required = { "dimensions", } - + class properties: - - + + class dimensions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['Dimension']: return Dimension - + def __new__( cls, _arg: typing.Union[typing.Tuple['Dimension'], typing.List['Dimension']], @@ -65,22 +65,22 @@ class ResultSpec( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'Dimension': return super().__getitem__(i) - - + + class totals( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['Total']: return Total - + def __new__( cls, _arg: typing.Union[typing.Tuple['Total'], typing.List['Total']], @@ -91,42 +91,42 @@ class ResultSpec( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'Total': return super().__getitem__(i) __annotations__ = { "dimensions": dimensions, "totals": totals, } - + dimensions: MetaOapg.properties.dimensions - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dimensions"]) -> MetaOapg.properties.dimensions: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["totals"]) -> MetaOapg.properties.totals: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dimensions", "totals", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dimensions"]) -> MetaOapg.properties.dimensions: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["totals"]) -> typing.Union[MetaOapg.properties.totals, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dimensions", "totals", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -145,5 +145,5 @@ class ResultSpec( **kwargs, ) -from gooddata_api_client.model.dimension import Dimension -from gooddata_api_client.model.total import Total +from gooddata_api_client.models.dimension import Dimension +from gooddata_api_client.models.total import Total diff --git a/gooddata-api-client/gooddata_api_client/model/route_result.py b/gooddata-api-client/gooddata_api_client/model/route_result.py deleted file mode 100644 index 9d1b4607d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/route_result.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class RouteResult(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('use_case',): { - 'INVALID': "INVALID", - 'GENERAL': "GENERAL", - 'SEARCH': "SEARCH", - 'CREATE_VISUALIZATION': "CREATE_VISUALIZATION", - 'EXTEND_VISUALIZATION': "EXTEND_VISUALIZATION", - 'HOWTO': "HOWTO", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'reasoning': (str,), # noqa: E501 - 'use_case': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'reasoning': 'reasoning', # noqa: E501 - 'use_case': 'useCase', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, reasoning, use_case, *args, **kwargs): # noqa: E501 - """RouteResult - a model defined in OpenAPI - - Args: - reasoning (str): Explanation why LLM picked this use case. - use_case (str): Use case where LLM routed based on question. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.reasoning = reasoning - self.use_case = use_case - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, reasoning, use_case, *args, **kwargs): # noqa: E501 - """RouteResult - a model defined in OpenAPI - - Args: - reasoning (str): Explanation why LLM picked this use case. - use_case (str): Use case where LLM routed based on question. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.reasoning = reasoning - self.use_case = use_case - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/rsa_specification.py b/gooddata-api-client/gooddata_api_client/model/rsa_specification.py deleted file mode 100644 index e6283d481..000000000 --- a/gooddata-api-client/gooddata_api_client/model/rsa_specification.py +++ /dev/null @@ -1,330 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class RsaSpecification(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('alg',): { - 'RS256': "RS256", - 'RS384': "RS384", - 'RS512': "RS512", - }, - ('kty',): { - 'RSA': "RSA", - }, - ('use',): { - 'SIG': "sig", - }, - } - - validations = { - ('kid',): { - 'max_length': 255, - 'min_length': 0, - 'regex': { - 'pattern': r'^[^.]', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'alg': (str,), # noqa: E501 - 'e': (str,), # noqa: E501 - 'kid': (str,), # noqa: E501 - 'kty': (str,), # noqa: E501 - 'n': (str,), # noqa: E501 - 'use': (str,), # noqa: E501 - 'x5c': ([str],), # noqa: E501 - 'x5t': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'alg': 'alg', # noqa: E501 - 'e': 'e', # noqa: E501 - 'kid': 'kid', # noqa: E501 - 'kty': 'kty', # noqa: E501 - 'n': 'n', # noqa: E501 - 'use': 'use', # noqa: E501 - 'x5c': 'x5c', # noqa: E501 - 'x5t': 'x5t', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, alg, e, kid, n, *args, **kwargs): # noqa: E501 - """RsaSpecification - a model defined in OpenAPI - - Args: - alg (str): - e (str): - kid (str): - n (str): - - Keyword Args: - kty (str): defaults to "RSA", must be one of ["RSA", ] # noqa: E501 - use (str): defaults to "sig", must be one of ["sig", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - x5c ([str]): [optional] # noqa: E501 - x5t (str): [optional] # noqa: E501 - """ - - kty = kwargs.get('kty', "RSA") - use = kwargs.get('use', "sig") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.alg = alg - self.e = e - self.kid = kid - self.kty = kty - self.n = n - self.use = use - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, alg, e, kid, n, *args, **kwargs): # noqa: E501 - """RsaSpecification - a model defined in OpenAPI - - Args: - alg (str): - e (str): - kid (str): - n (str): - - Keyword Args: - kty (str): defaults to "RSA", must be one of ["RSA", ] # noqa: E501 - use (str): defaults to "sig", must be one of ["sig", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - x5c ([str]): [optional] # noqa: E501 - x5t (str): [optional] # noqa: E501 - """ - - kty = kwargs.get('kty', "RSA") - use = kwargs.get('use', "sig") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.alg = alg - self.e = e - self.kid = kid - self.kty = kty - self.n = n - self.use = use - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/rule_permission.py b/gooddata-api-client/gooddata_api_client/model/rule_permission.py deleted file mode 100644 index 1eb60c551..000000000 --- a/gooddata-api-client/gooddata_api_client/model/rule_permission.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.granted_permission import GrantedPermission - globals()['GrantedPermission'] = GrantedPermission - - -class RulePermission(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'permissions': ([GrantedPermission],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RulePermission - a model defined in OpenAPI - - Args: - type (str): Type of the rule - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([GrantedPermission]): Permissions granted by the rule. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, type, *args, **kwargs): # noqa: E501 - """RulePermission - a model defined in OpenAPI - - Args: - type (str): Type of the rule - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - permissions ([GrantedPermission]): Permissions granted by the rule. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/running_section.py b/gooddata-api-client/gooddata_api_client/model/running_section.py deleted file mode 100644 index 239c5489e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/running_section.py +++ /dev/null @@ -1,268 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class RunningSection(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'left': (str, none_type,), # noqa: E501 - 'right': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'left': 'left', # noqa: E501 - 'right': 'right', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RunningSection - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - left (str, none_type): Either {{logo}} variable or custom text with combination of other variables.. [optional] # noqa: E501 - right (str, none_type): Either {{logo}} variable or custom text with combination of other variables.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """RunningSection - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - left (str, none_type): Either {{logo}} variable or custom text with combination of other variables.. [optional] # noqa: E501 - right (str, none_type): Either {{logo}} variable or custom text with combination of other variables.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/saved_visualization.py b/gooddata-api-client/gooddata_api_client/model/saved_visualization.py deleted file mode 100644 index f97c45546..000000000 --- a/gooddata-api-client/gooddata_api_client/model/saved_visualization.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class SavedVisualization(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'created_visualization_id': (str,), # noqa: E501 - 'saved_visualization_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'created_visualization_id': 'createdVisualizationId', # noqa: E501 - 'saved_visualization_id': 'savedVisualizationId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, created_visualization_id, saved_visualization_id, *args, **kwargs): # noqa: E501 - """SavedVisualization - a model defined in OpenAPI - - Args: - created_visualization_id (str): Created visualization ID. - saved_visualization_id (str): Saved visualization ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.created_visualization_id = created_visualization_id - self.saved_visualization_id = saved_visualization_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, created_visualization_id, saved_visualization_id, *args, **kwargs): # noqa: E501 - """SavedVisualization - a model defined in OpenAPI - - Args: - created_visualization_id (str): Created visualization ID. - saved_visualization_id (str): Saved visualization ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.created_visualization_id = created_visualization_id - self.saved_visualization_id = saved_visualization_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/scan_request.py b/gooddata-api-client/gooddata_api_client/model/scan_request.py deleted file mode 100644 index 43fe22ece..000000000 --- a/gooddata-api-client/gooddata_api_client/model/scan_request.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ScanRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'scan_tables': (bool,), # noqa: E501 - 'scan_views': (bool,), # noqa: E501 - 'separator': (str,), # noqa: E501 - 'schemata': ([str],), # noqa: E501 - 'table_prefix': (str,), # noqa: E501 - 'view_prefix': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'scan_tables': 'scanTables', # noqa: E501 - 'scan_views': 'scanViews', # noqa: E501 - 'separator': 'separator', # noqa: E501 - 'schemata': 'schemata', # noqa: E501 - 'table_prefix': 'tablePrefix', # noqa: E501 - 'view_prefix': 'viewPrefix', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, scan_tables, scan_views, separator, *args, **kwargs): # noqa: E501 - """ScanRequest - a model defined in OpenAPI - - Args: - scan_tables (bool): A flag indicating whether the tables should be scanned. - scan_views (bool): A flag indicating whether the views should be scanned. - separator (str): A separator between prefixes and the names. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - schemata ([str]): What schemata will be scanned.. [optional] # noqa: E501 - table_prefix (str): Tables starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.. [optional] # noqa: E501 - view_prefix (str): Views starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.scan_tables = scan_tables - self.scan_views = scan_views - self.separator = separator - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, scan_tables, scan_views, separator, *args, **kwargs): # noqa: E501 - """ScanRequest - a model defined in OpenAPI - - Args: - scan_tables (bool): A flag indicating whether the tables should be scanned. - scan_views (bool): A flag indicating whether the views should be scanned. - separator (str): A separator between prefixes and the names. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - schemata ([str]): What schemata will be scanned.. [optional] # noqa: E501 - table_prefix (str): Tables starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.. [optional] # noqa: E501 - view_prefix (str): Views starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.scan_tables = scan_tables - self.scan_views = scan_views - self.separator = separator - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/scan_result_pdm.py b/gooddata-api-client/gooddata_api_client/model/scan_result_pdm.py deleted file mode 100644 index b965be370..000000000 --- a/gooddata-api-client/gooddata_api_client/model/scan_result_pdm.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.declarative_tables import DeclarativeTables - from gooddata_api_client.model.table_warning import TableWarning - globals()['DeclarativeTables'] = DeclarativeTables - globals()['TableWarning'] = TableWarning - - -class ScanResultPdm(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'pdm': (DeclarativeTables,), # noqa: E501 - 'warnings': ([TableWarning],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'pdm': 'pdm', # noqa: E501 - 'warnings': 'warnings', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, pdm, warnings, *args, **kwargs): # noqa: E501 - """ScanResultPdm - a model defined in OpenAPI - - Args: - pdm (DeclarativeTables): - warnings ([TableWarning]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.pdm = pdm - self.warnings = warnings - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, pdm, warnings, *args, **kwargs): # noqa: E501 - """ScanResultPdm - a model defined in OpenAPI - - Args: - pdm (DeclarativeTables): - warnings ([TableWarning]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.pdm = pdm - self.warnings = warnings - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/scan_result_pdm.pyi b/gooddata-api-client/gooddata_api_client/model/scan_result_pdm.pyi index 3a73ebcb7..ebecc06a5 100644 --- a/gooddata-api-client/gooddata_api_client/model/scan_result_pdm.pyi +++ b/gooddata-api-client/gooddata_api_client/model/scan_result_pdm.pyi @@ -41,25 +41,25 @@ class ScanResultPdm( "warnings", "pdm", } - + class properties: - + @staticmethod def pdm() -> typing.Type['DeclarativeTables']: return DeclarativeTables - - + + class warnings( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['TableWarning']: return TableWarning - + def __new__( cls, _arg: typing.Union[typing.Tuple['TableWarning'], typing.List['TableWarning']], @@ -70,43 +70,43 @@ class ScanResultPdm( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'TableWarning': return super().__getitem__(i) __annotations__ = { "pdm": pdm, "warnings": warnings, } - + warnings: MetaOapg.properties.warnings pdm: 'DeclarativeTables' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["pdm"]) -> 'DeclarativeTables': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["warnings"]) -> MetaOapg.properties.warnings: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["pdm", "warnings", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["pdm"]) -> 'DeclarativeTables': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["warnings"]) -> MetaOapg.properties.warnings: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["pdm", "warnings", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -125,5 +125,5 @@ class ScanResultPdm( **kwargs, ) -from gooddata_api_client.model.declarative_tables import DeclarativeTables -from gooddata_api_client.model.table_warning import TableWarning +from gooddata_api_client.models.declarative_tables import DeclarativeTables +from gooddata_api_client.models.table_warning import TableWarning diff --git a/gooddata-api-client/gooddata_api_client/model/scan_sql_request.py b/gooddata-api-client/gooddata_api_client/model/scan_sql_request.py deleted file mode 100644 index d7239068d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/scan_sql_request.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ScanSqlRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'sql': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'sql': 'sql', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, sql, *args, **kwargs): # noqa: E501 - """ScanSqlRequest - a model defined in OpenAPI - - Args: - sql (str): SQL query to be analyzed. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.sql = sql - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, sql, *args, **kwargs): # noqa: E501 - """ScanSqlRequest - a model defined in OpenAPI - - Args: - sql (str): SQL query to be analyzed. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.sql = sql - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/scan_sql_response.py b/gooddata-api-client/gooddata_api_client/model/scan_sql_response.py deleted file mode 100644 index 230eb20ff..000000000 --- a/gooddata-api-client/gooddata_api_client/model/scan_sql_response.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.sql_column import SqlColumn - globals()['SqlColumn'] = SqlColumn - - -class ScanSqlResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'columns': ([SqlColumn],), # noqa: E501 - 'data_preview': ([[str, none_type]],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'columns': 'columns', # noqa: E501 - 'data_preview': 'dataPreview', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, columns, *args, **kwargs): # noqa: E501 - """ScanSqlResponse - a model defined in OpenAPI - - Args: - columns ([SqlColumn]): Array of columns with types. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_preview ([[str, none_type]]): Array of rows where each row is another array of string values.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.columns = columns - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, columns, *args, **kwargs): # noqa: E501 - """ScanSqlResponse - a model defined in OpenAPI - - Args: - columns ([SqlColumn]): Array of columns with types. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_preview ([[str, none_type]]): Array of rows where each row is another array of string values.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.columns = columns - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/scan_sql_response.pyi b/gooddata-api-client/gooddata_api_client/model/scan_sql_response.pyi index a78e02d25..ac4b60d78 100644 --- a/gooddata-api-client/gooddata_api_client/model/scan_sql_response.pyi +++ b/gooddata-api-client/gooddata_api_client/model/scan_sql_response.pyi @@ -40,21 +40,21 @@ class ScanSqlResponse( required = { "columns", } - + class properties: - - + + class columns( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['SqlColumn']: return SqlColumn - + def __new__( cls, _arg: typing.Union[typing.Tuple['SqlColumn'], typing.List['SqlColumn']], @@ -65,35 +65,35 @@ class ScanSqlResponse( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'SqlColumn': return super().__getitem__(i) - - + + class dataPreview( schemas.ListSchema ): - - + + class MetaOapg: - - + + class items( schemas.ListSchema ): - - + + class MetaOapg: - - + + class items( schemas.StrBase, schemas.NoneBase, schemas.Schema, schemas.NoneStrMixin ): - - + + def __new__( cls, *_args: typing.Union[None, str, ], @@ -104,7 +104,7 @@ class ScanSqlResponse( *_args, _configuration=_configuration, ) - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, str, ]], typing.List[typing.Union[MetaOapg.items, None, str, ]]], @@ -115,10 +115,10 @@ class ScanSqlResponse( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, list, tuple, ]], typing.List[typing.Union[MetaOapg.items, list, tuple, ]]], @@ -129,42 +129,42 @@ class ScanSqlResponse( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) __annotations__ = { "columns": columns, "dataPreview": dataPreview, } - + columns: MetaOapg.properties.columns - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataPreview"]) -> MetaOapg.properties.dataPreview: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["columns", "dataPreview", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataPreview"]) -> typing.Union[MetaOapg.properties.dataPreview, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["columns", "dataPreview", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -183,4 +183,4 @@ class ScanSqlResponse( **kwargs, ) -from gooddata_api_client.model.sql_column import SqlColumn +from gooddata_api_client.models.sql_column import SqlColumn diff --git a/gooddata-api-client/gooddata_api_client/model/search_relationship_object.py b/gooddata-api-client/gooddata_api_client/model/search_relationship_object.py deleted file mode 100644 index 29db5456f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/search_relationship_object.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class SearchRelationshipObject(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'source_object_id': (str,), # noqa: E501 - 'source_object_title': (str,), # noqa: E501 - 'source_object_type': (str,), # noqa: E501 - 'source_workspace_id': (str,), # noqa: E501 - 'target_object_id': (str,), # noqa: E501 - 'target_object_title': (str,), # noqa: E501 - 'target_object_type': (str,), # noqa: E501 - 'target_workspace_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'source_object_id': 'sourceObjectId', # noqa: E501 - 'source_object_title': 'sourceObjectTitle', # noqa: E501 - 'source_object_type': 'sourceObjectType', # noqa: E501 - 'source_workspace_id': 'sourceWorkspaceId', # noqa: E501 - 'target_object_id': 'targetObjectId', # noqa: E501 - 'target_object_title': 'targetObjectTitle', # noqa: E501 - 'target_object_type': 'targetObjectType', # noqa: E501 - 'target_workspace_id': 'targetWorkspaceId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, source_object_id, source_object_title, source_object_type, source_workspace_id, target_object_id, target_object_title, target_object_type, target_workspace_id, *args, **kwargs): # noqa: E501 - """SearchRelationshipObject - a model defined in OpenAPI - - Args: - source_object_id (str): Source object ID. - source_object_title (str): Source object title. - source_object_type (str): Source object type, e.g. dashboard. - source_workspace_id (str): Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located. - target_object_id (str): Target object ID. - target_object_title (str): Target object title. - target_object_type (str): Target object type, e.g. visualization. - target_workspace_id (str): Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.source_object_id = source_object_id - self.source_object_title = source_object_title - self.source_object_type = source_object_type - self.source_workspace_id = source_workspace_id - self.target_object_id = target_object_id - self.target_object_title = target_object_title - self.target_object_type = target_object_type - self.target_workspace_id = target_workspace_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, source_object_id, source_object_title, source_object_type, source_workspace_id, target_object_id, target_object_title, target_object_type, target_workspace_id, *args, **kwargs): # noqa: E501 - """SearchRelationshipObject - a model defined in OpenAPI - - Args: - source_object_id (str): Source object ID. - source_object_title (str): Source object title. - source_object_type (str): Source object type, e.g. dashboard. - source_workspace_id (str): Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located. - target_object_id (str): Target object ID. - target_object_title (str): Target object title. - target_object_type (str): Target object type, e.g. visualization. - target_workspace_id (str): Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.source_object_id = source_object_id - self.source_object_title = source_object_title - self.source_object_type = source_object_type - self.source_workspace_id = source_workspace_id - self.target_object_id = target_object_id - self.target_object_title = target_object_title - self.target_object_type = target_object_type - self.target_workspace_id = target_workspace_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/search_request.py b/gooddata-api-client/gooddata_api_client/model/search_request.py deleted file mode 100644 index 477dc1372..000000000 --- a/gooddata-api-client/gooddata_api_client/model/search_request.py +++ /dev/null @@ -1,307 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class SearchRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('object_types',): { - 'ATTRIBUTE': "attribute", - 'METRIC': "metric", - 'FACT': "fact", - 'LABEL': "label", - 'DATE': "date", - 'DATASET': "dataset", - 'VISUALIZATION': "visualization", - 'DASHBOARD': "dashboard", - }, - } - - validations = { - ('question',): { - 'max_length': 1000, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'question': (str,), # noqa: E501 - 'deep_search': (bool,), # noqa: E501 - 'include_hidden': (bool,), # noqa: E501 - 'limit': (int,), # noqa: E501 - 'object_types': ([str],), # noqa: E501 - 'relevant_score_threshold': (float,), # noqa: E501 - 'title_to_descriptor_ratio': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'question': 'question', # noqa: E501 - 'deep_search': 'deepSearch', # noqa: E501 - 'include_hidden': 'includeHidden', # noqa: E501 - 'limit': 'limit', # noqa: E501 - 'object_types': 'objectTypes', # noqa: E501 - 'relevant_score_threshold': 'relevantScoreThreshold', # noqa: E501 - 'title_to_descriptor_ratio': 'titleToDescriptorRatio', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, question, *args, **kwargs): # noqa: E501 - """SearchRequest - a model defined in OpenAPI - - Args: - question (str): Keyword/sentence is input for search. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - deep_search (bool): Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.. [optional] if omitted the server will use the default value of False # noqa: E501 - include_hidden (bool): If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.. [optional] if omitted the server will use the default value of False # noqa: E501 - limit (int): Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested.. [optional] if omitted the server will use the default value of 10 # noqa: E501 - object_types ([str]): List of object types to search for.. [optional] # noqa: E501 - relevant_score_threshold (float): Score, above which we return found objects. Below this score objects are not relevant.. [optional] if omitted the server will use the default value of 0.3 # noqa: E501 - title_to_descriptor_ratio (float): Temporary for experiments. Ratio of title score to descriptor score.. [optional] if omitted the server will use the default value of 0.7 # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.question = question - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, question, *args, **kwargs): # noqa: E501 - """SearchRequest - a model defined in OpenAPI - - Args: - question (str): Keyword/sentence is input for search. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - deep_search (bool): Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.. [optional] if omitted the server will use the default value of False # noqa: E501 - include_hidden (bool): If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.. [optional] if omitted the server will use the default value of False # noqa: E501 - limit (int): Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested.. [optional] if omitted the server will use the default value of 10 # noqa: E501 - object_types ([str]): List of object types to search for.. [optional] # noqa: E501 - relevant_score_threshold (float): Score, above which we return found objects. Below this score objects are not relevant.. [optional] if omitted the server will use the default value of 0.3 # noqa: E501 - title_to_descriptor_ratio (float): Temporary for experiments. Ratio of title score to descriptor score.. [optional] if omitted the server will use the default value of 0.7 # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.question = question - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/search_result.py b/gooddata-api-client/gooddata_api_client/model/search_result.py deleted file mode 100644 index d7bb3f07f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/search_result.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.search_relationship_object import SearchRelationshipObject - from gooddata_api_client.model.search_result_object import SearchResultObject - globals()['SearchRelationshipObject'] = SearchRelationshipObject - globals()['SearchResultObject'] = SearchResultObject - - -class SearchResult(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'reasoning': (str,), # noqa: E501 - 'relationships': ([SearchRelationshipObject],), # noqa: E501 - 'results': ([SearchResultObject],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'reasoning': 'reasoning', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'results': 'results', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, reasoning, relationships, results, *args, **kwargs): # noqa: E501 - """SearchResult - a model defined in OpenAPI - - Args: - reasoning (str): If something is not working properly this field will contain explanation. - relationships ([SearchRelationshipObject]): - results ([SearchResultObject]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.reasoning = reasoning - self.relationships = relationships - self.results = results - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, reasoning, relationships, results, *args, **kwargs): # noqa: E501 - """SearchResult - a model defined in OpenAPI - - Args: - reasoning (str): If something is not working properly this field will contain explanation. - relationships ([SearchRelationshipObject]): - results ([SearchResultObject]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.reasoning = reasoning - self.relationships = relationships - self.results = results - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/search_result_object.py b/gooddata-api-client/gooddata_api_client/model/search_result_object.py deleted file mode 100644 index 49425a56e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/search_result_object.py +++ /dev/null @@ -1,330 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class SearchResultObject(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('tags',): { - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'workspace_id': (str,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'is_hidden': (bool,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 - 'score': (float,), # noqa: E501 - 'score_descriptor': (float,), # noqa: E501 - 'score_exact_match': (int,), # noqa: E501 - 'score_title': (float,), # noqa: E501 - 'tags': ([str],), # noqa: E501 - 'visualization_url': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'type': 'type', # noqa: E501 - 'workspace_id': 'workspaceId', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'description': 'description', # noqa: E501 - 'is_hidden': 'isHidden', # noqa: E501 - 'modified_at': 'modifiedAt', # noqa: E501 - 'score': 'score', # noqa: E501 - 'score_descriptor': 'scoreDescriptor', # noqa: E501 - 'score_exact_match': 'scoreExactMatch', # noqa: E501 - 'score_title': 'scoreTitle', # noqa: E501 - 'tags': 'tags', # noqa: E501 - 'visualization_url': 'visualizationUrl', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, title, type, workspace_id, *args, **kwargs): # noqa: E501 - """SearchResultObject - a model defined in OpenAPI - - Args: - id (str): Object ID. - title (str): Object title. - type (str): Object type, e.g. dashboard. - workspace_id (str): Workspace ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (datetime): Timestamp when object was created.. [optional] # noqa: E501 - description (str): Object description.. [optional] # noqa: E501 - is_hidden (bool): If true, this object is hidden from AI search results by default.. [optional] # noqa: E501 - modified_at (datetime): Timestamp when object was last modified.. [optional] # noqa: E501 - score (float): Result score calculated by a similarity search algorithm (cosine_distance).. [optional] # noqa: E501 - score_descriptor (float): Result score for descriptor containing(now) description and tags.. [optional] # noqa: E501 - score_exact_match (int): Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.. [optional] # noqa: E501 - score_title (float): Result score for object title.. [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - visualization_url (str): If the object is visualization, this field defines the type of visualization.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - self.type = type - self.workspace_id = workspace_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, title, type, workspace_id, *args, **kwargs): # noqa: E501 - """SearchResultObject - a model defined in OpenAPI - - Args: - id (str): Object ID. - title (str): Object title. - type (str): Object type, e.g. dashboard. - workspace_id (str): Workspace ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - created_at (datetime): Timestamp when object was created.. [optional] # noqa: E501 - description (str): Object description.. [optional] # noqa: E501 - is_hidden (bool): If true, this object is hidden from AI search results by default.. [optional] # noqa: E501 - modified_at (datetime): Timestamp when object was last modified.. [optional] # noqa: E501 - score (float): Result score calculated by a similarity search algorithm (cosine_distance).. [optional] # noqa: E501 - score_descriptor (float): Result score for descriptor containing(now) description and tags.. [optional] # noqa: E501 - score_exact_match (int): Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.. [optional] # noqa: E501 - score_title (float): Result score for object title.. [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - visualization_url (str): If the object is visualization, this field defines the type of visualization.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.title = title - self.type = type - self.workspace_id = workspace_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/section_slide_template.py b/gooddata-api-client/gooddata_api_client/model/section_slide_template.py deleted file mode 100644 index 7c5111cf2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/section_slide_template.py +++ /dev/null @@ -1,278 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.running_section import RunningSection - globals()['RunningSection'] = RunningSection - - -class SectionSlideTemplate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'background_image': (bool,), # noqa: E501 - 'footer': (RunningSection,), # noqa: E501 - 'header': (RunningSection,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'background_image': 'backgroundImage', # noqa: E501 - 'footer': 'footer', # noqa: E501 - 'header': 'header', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """SectionSlideTemplate - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 - footer (RunningSection): [optional] # noqa: E501 - header (RunningSection): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """SectionSlideTemplate - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 - footer (RunningSection): [optional] # noqa: E501 - header (RunningSection): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/settings.py b/gooddata-api-client/gooddata_api_client/model/settings.py deleted file mode 100644 index 0cbfc02b0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/settings.py +++ /dev/null @@ -1,311 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.pdf_table_style import PdfTableStyle - globals()['PdfTableStyle'] = PdfTableStyle - - -class Settings(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('page_orientation',): { - 'PORTRAIT': "PORTRAIT", - 'LANDSCAPE': "LANDSCAPE", - }, - ('page_size',): { - 'A3': "A3", - 'A4': "A4", - 'LETTER': "LETTER", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'export_info': (bool,), # noqa: E501 - 'merge_headers': (bool,), # noqa: E501 - 'page_orientation': (str,), # noqa: E501 - 'page_size': (str,), # noqa: E501 - 'pdf_page_size': (str,), # noqa: E501 - 'pdf_table_style': ([PdfTableStyle],), # noqa: E501 - 'pdf_top_left_content': (str,), # noqa: E501 - 'pdf_top_right_content': (str,), # noqa: E501 - 'show_filters': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'export_info': 'exportInfo', # noqa: E501 - 'merge_headers': 'mergeHeaders', # noqa: E501 - 'page_orientation': 'pageOrientation', # noqa: E501 - 'page_size': 'pageSize', # noqa: E501 - 'pdf_page_size': 'pdfPageSize', # noqa: E501 - 'pdf_table_style': 'pdfTableStyle', # noqa: E501 - 'pdf_top_left_content': 'pdfTopLeftContent', # noqa: E501 - 'pdf_top_right_content': 'pdfTopRightContent', # noqa: E501 - 'show_filters': 'showFilters', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """Settings - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - export_info (bool): If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF). [optional] if omitted the server will use the default value of False # noqa: E501 - merge_headers (bool): Merge equal headers in neighbouring cells. (XLSX). [optional] # noqa: E501 - page_orientation (str): Set page orientation. (PDF). [optional] if omitted the server will use the default value of "PORTRAIT" # noqa: E501 - page_size (str): Set page size. (PDF). [optional] if omitted the server will use the default value of "A4" # noqa: E501 - pdf_page_size (str): Page size and orientation. (PDF). [optional] # noqa: E501 - pdf_table_style ([PdfTableStyle]): Custom CSS styles for the table. (PDF, HTML). [optional] # noqa: E501 - pdf_top_left_content (str): Top left header content. (PDF). [optional] # noqa: E501 - pdf_top_right_content (str): Top right header content. (PDF). [optional] # noqa: E501 - show_filters (bool): Print applied filters on top of the document. (PDF/HTML when visualizationObject is given). [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """Settings - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - export_info (bool): If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF). [optional] if omitted the server will use the default value of False # noqa: E501 - merge_headers (bool): Merge equal headers in neighbouring cells. (XLSX). [optional] # noqa: E501 - page_orientation (str): Set page orientation. (PDF). [optional] if omitted the server will use the default value of "PORTRAIT" # noqa: E501 - page_size (str): Set page size. (PDF). [optional] if omitted the server will use the default value of "A4" # noqa: E501 - pdf_page_size (str): Page size and orientation. (PDF). [optional] # noqa: E501 - pdf_table_style ([PdfTableStyle]): Custom CSS styles for the table. (PDF, HTML). [optional] # noqa: E501 - pdf_top_left_content (str): Top left header content. (PDF). [optional] # noqa: E501 - pdf_top_right_content (str): Top right header content. (PDF). [optional] # noqa: E501 - show_filters (bool): Print applied filters on top of the document. (PDF/HTML when visualizationObject is given). [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/simple_measure_definition.py b/gooddata-api-client/gooddata_api_client/model/simple_measure_definition.py deleted file mode 100644 index f3bd98080..000000000 --- a/gooddata-api-client/gooddata_api_client/model/simple_measure_definition.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.simple_measure_definition_measure import SimpleMeasureDefinitionMeasure - globals()['SimpleMeasureDefinitionMeasure'] = SimpleMeasureDefinitionMeasure - - -class SimpleMeasureDefinition(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'measure': (SimpleMeasureDefinitionMeasure,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'measure': 'measure', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, measure, *args, **kwargs): # noqa: E501 - """SimpleMeasureDefinition - a model defined in OpenAPI - - Args: - measure (SimpleMeasureDefinitionMeasure): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure = measure - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, measure, *args, **kwargs): # noqa: E501 - """SimpleMeasureDefinition - a model defined in OpenAPI - - Args: - measure (SimpleMeasureDefinitionMeasure): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.measure = measure - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/simple_measure_definition.pyi b/gooddata-api-client/gooddata_api_client/model/simple_measure_definition.pyi index 5d651c2fa..673b72f24 100644 --- a/gooddata-api-client/gooddata_api_client/model/simple_measure_definition.pyi +++ b/gooddata-api-client/gooddata_api_client/model/simple_measure_definition.pyi @@ -38,73 +38,73 @@ class SimpleMeasureDefinition( required = { "measure", } - + class properties: - - + + class measure( schemas.DictSchema ): - - + + class MetaOapg: required = { "item", } - + class properties: - - + + class aggregation( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def SUM(cls): return cls("SUM") - + @schemas.classproperty def COUNT(cls): return cls("COUNT") - + @schemas.classproperty def AVG(cls): return cls("AVG") - + @schemas.classproperty def MIN(cls): return cls("MIN") - + @schemas.classproperty def MAX(cls): return cls("MAX") - + @schemas.classproperty def MEDIAN(cls): return cls("MEDIAN") - + @schemas.classproperty def RUNSUM(cls): return cls("RUNSUM") - + @schemas.classproperty def APPROXIMATE_COUNT(cls): return cls("APPROXIMATE_COUNT") computeRatio = schemas.BoolSchema - - + + class filters( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['FilterDefinitionForSimpleMeasure']: return FilterDefinitionForSimpleMeasure - + def __new__( cls, _arg: typing.Union[typing.Tuple['FilterDefinitionForSimpleMeasure'], typing.List['FilterDefinitionForSimpleMeasure']], @@ -115,10 +115,10 @@ class SimpleMeasureDefinition( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'FilterDefinitionForSimpleMeasure': return super().__getitem__(i) - + @staticmethod def item() -> typing.Type['AfmObjectIdentifierCore']: return AfmObjectIdentifierCore @@ -128,48 +128,48 @@ class SimpleMeasureDefinition( "filters": filters, "item": item, } - + item: 'AfmObjectIdentifierCore' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["aggregation"]) -> MetaOapg.properties.aggregation: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["computeRatio"]) -> MetaOapg.properties.computeRatio: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["item"]) -> 'AfmObjectIdentifierCore': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["aggregation", "computeRatio", "filters", "item", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["aggregation"]) -> typing.Union[MetaOapg.properties.aggregation, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["computeRatio"]) -> typing.Union[MetaOapg.properties.computeRatio, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> typing.Union[MetaOapg.properties.filters, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["item"]) -> 'AfmObjectIdentifierCore': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["aggregation", "computeRatio", "filters", "item", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -193,29 +193,29 @@ class SimpleMeasureDefinition( __annotations__ = { "measure": measure, } - + measure: MetaOapg.properties.measure - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["measure"]) -> MetaOapg.properties.measure: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["measure", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["measure"]) -> MetaOapg.properties.measure: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["measure", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -232,5 +232,5 @@ class SimpleMeasureDefinition( **kwargs, ) -from gooddata_api_client.model.afm_object_identifier_core import AfmObjectIdentifierCore -from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure +from gooddata_api_client.models.afm_object_identifier_core import AfmObjectIdentifierCore +from gooddata_api_client.models.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure diff --git a/gooddata-api-client/gooddata_api_client/model/simple_measure_definition_measure.py b/gooddata-api-client/gooddata_api_client/model/simple_measure_definition_measure.py deleted file mode 100644 index 6f3358e81..000000000 --- a/gooddata-api-client/gooddata_api_client/model/simple_measure_definition_measure.py +++ /dev/null @@ -1,300 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.afm_object_identifier_core import AfmObjectIdentifierCore - from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure - globals()['AfmObjectIdentifierCore'] = AfmObjectIdentifierCore - globals()['FilterDefinitionForSimpleMeasure'] = FilterDefinitionForSimpleMeasure - - -class SimpleMeasureDefinitionMeasure(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('aggregation',): { - 'SUM': "SUM", - 'COUNT': "COUNT", - 'AVG': "AVG", - 'MIN': "MIN", - 'MAX': "MAX", - 'MEDIAN': "MEDIAN", - 'RUNSUM': "RUNSUM", - 'APPROXIMATE_COUNT': "APPROXIMATE_COUNT", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'item': (AfmObjectIdentifierCore,), # noqa: E501 - 'aggregation': (str,), # noqa: E501 - 'compute_ratio': (bool,), # noqa: E501 - 'filters': ([FilterDefinitionForSimpleMeasure],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'item': 'item', # noqa: E501 - 'aggregation': 'aggregation', # noqa: E501 - 'compute_ratio': 'computeRatio', # noqa: E501 - 'filters': 'filters', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, item, *args, **kwargs): # noqa: E501 - """SimpleMeasureDefinitionMeasure - a model defined in OpenAPI - - Args: - item (AfmObjectIdentifierCore): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aggregation (str): Definition of aggregation type of the metric.. [optional] # noqa: E501 - compute_ratio (bool): If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).. [optional] if omitted the server will use the default value of False # noqa: E501 - filters ([FilterDefinitionForSimpleMeasure]): Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.item = item - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, item, *args, **kwargs): # noqa: E501 - """SimpleMeasureDefinitionMeasure - a model defined in OpenAPI - - Args: - item (AfmObjectIdentifierCore): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aggregation (str): Definition of aggregation type of the metric.. [optional] # noqa: E501 - compute_ratio (bool): If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).. [optional] if omitted the server will use the default value of False # noqa: E501 - filters ([FilterDefinitionForSimpleMeasure]): Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.item = item - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/skeleton.py b/gooddata-api-client/gooddata_api_client/model/skeleton.py deleted file mode 100644 index b0300b8e4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/skeleton.py +++ /dev/null @@ -1,268 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class Skeleton(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'content': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 - 'href': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'content': 'content', # noqa: E501 - 'href': 'href', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """Skeleton - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501 - href (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """Skeleton - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501 - href (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/slides_export_request.py b/gooddata-api-client/gooddata_api_client/model/slides_export_request.py deleted file mode 100644 index fb5d9037b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/slides_export_request.py +++ /dev/null @@ -1,315 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.json_node import JsonNode - globals()['JsonNode'] = JsonNode - - -class SlidesExportRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('format',): { - 'PDF': "PDF", - 'PPTX': "PPTX", - }, - } - - validations = { - ('template_id',): { - 'max_length': 255, - }, - ('visualization_ids',): { - 'max_items': 1, - }, - ('widget_ids',): { - 'max_items': 1, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'file_name': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - 'dashboard_id': (str,), # noqa: E501 - 'metadata': (JsonNode,), # noqa: E501 - 'template_id': (str, none_type,), # noqa: E501 - 'visualization_ids': ([str],), # noqa: E501 - 'widget_ids': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'file_name': 'fileName', # noqa: E501 - 'format': 'format', # noqa: E501 - 'dashboard_id': 'dashboardId', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - 'template_id': 'templateId', # noqa: E501 - 'visualization_ids': 'visualizationIds', # noqa: E501 - 'widget_ids': 'widgetIds', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, file_name, format, *args, **kwargs): # noqa: E501 - """SlidesExportRequest - a model defined in OpenAPI - - Args: - file_name (str): File name to be used for retrieving the pdf document. - format (str): Requested resulting file type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 - metadata (JsonNode): [optional] # noqa: E501 - template_id (str, none_type): Export template identifier.. [optional] # noqa: E501 - visualization_ids ([str]): List of visualization ids to be exported. Note that only one visualization is currently supported.. [optional] # noqa: E501 - widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, file_name, format, *args, **kwargs): # noqa: E501 - """SlidesExportRequest - a model defined in OpenAPI - - Args: - file_name (str): File name to be used for retrieving the pdf document. - format (str): Requested resulting file type. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 - metadata (JsonNode): [optional] # noqa: E501 - template_id (str, none_type): Export template identifier.. [optional] # noqa: E501 - visualization_ids ([str]): List of visualization ids to be exported. Note that only one visualization is currently supported.. [optional] # noqa: E501 - widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/smart_function_response.py b/gooddata-api-client/gooddata_api_client/model/smart_function_response.py deleted file mode 100644 index 1d159e985..000000000 --- a/gooddata-api-client/gooddata_api_client/model/smart_function_response.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.execution_links import ExecutionLinks - globals()['ExecutionLinks'] = ExecutionLinks - - -class SmartFunctionResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'links': (ExecutionLinks,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'links': 'links', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, links, *args, **kwargs): # noqa: E501 - """SmartFunctionResponse - a model defined in OpenAPI - - Args: - links (ExecutionLinks): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.links = links - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, links, *args, **kwargs): # noqa: E501 - """SmartFunctionResponse - a model defined in OpenAPI - - Args: - links (ExecutionLinks): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.links = links - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/smtp.py b/gooddata-api-client/gooddata_api_client/model/smtp.py deleted file mode 100644 index 99f8a4e39..000000000 --- a/gooddata-api-client/gooddata_api_client/model/smtp.py +++ /dev/null @@ -1,355 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.smtp_all_of import SmtpAllOf - globals()['SmtpAllOf'] = SmtpAllOf - - -class Smtp(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'SMTP': "SMTP", - }, - ('port',): { - '25': 25, - '465': 465, - '587': 587, - '2525': 2525, - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'from_email': (str,), # noqa: E501 - 'from_email_name': (str,), # noqa: E501 - 'host': (str,), # noqa: E501 - 'password': (str,), # noqa: E501 - 'port': (int,), # noqa: E501 - 'username': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'from_email': 'fromEmail', # noqa: E501 - 'from_email_name': 'fromEmailName', # noqa: E501 - 'host': 'host', # noqa: E501 - 'password': 'password', # noqa: E501 - 'port': 'port', # noqa: E501 - 'username': 'username', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """Smtp - a model defined in OpenAPI - - Keyword Args: - type (str): The destination type.. defaults to "SMTP", must be one of ["SMTP", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "SMTP") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """Smtp - a model defined in OpenAPI - - Keyword Args: - type (str): The destination type.. defaults to "SMTP", must be one of ["SMTP", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "SMTP") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - SmtpAllOf, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/smtp_all_of.py b/gooddata-api-client/gooddata_api_client/model/smtp_all_of.py deleted file mode 100644 index c074613bb..000000000 --- a/gooddata-api-client/gooddata_api_client/model/smtp_all_of.py +++ /dev/null @@ -1,297 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class SmtpAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('port',): { - '25': 25, - '465': 465, - '587': 587, - '2525': 2525, - }, - ('type',): { - 'SMTP': "SMTP", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'from_email': (str,), # noqa: E501 - 'from_email_name': (str,), # noqa: E501 - 'host': (str,), # noqa: E501 - 'password': (str,), # noqa: E501 - 'port': (int,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'username': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'from_email': 'fromEmail', # noqa: E501 - 'from_email_name': 'fromEmailName', # noqa: E501 - 'host': 'host', # noqa: E501 - 'password': 'password', # noqa: E501 - 'port': 'port', # noqa: E501 - 'type': 'type', # noqa: E501 - 'username': 'username', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """SmtpAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "SMTP" # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """SmtpAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - from_email (str): E-mail address to send notifications from.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "SMTP" # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/sort_key.py b/gooddata-api-client/gooddata_api_client/model/sort_key.py deleted file mode 100644 index 354facf32..000000000 --- a/gooddata-api-client/gooddata_api_client/model/sort_key.py +++ /dev/null @@ -1,340 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.sort_key_attribute import SortKeyAttribute - from gooddata_api_client.model.sort_key_attribute_attribute import SortKeyAttributeAttribute - from gooddata_api_client.model.sort_key_total import SortKeyTotal - from gooddata_api_client.model.sort_key_total_total import SortKeyTotalTotal - from gooddata_api_client.model.sort_key_value import SortKeyValue - from gooddata_api_client.model.sort_key_value_value import SortKeyValueValue - globals()['SortKeyAttribute'] = SortKeyAttribute - globals()['SortKeyAttributeAttribute'] = SortKeyAttributeAttribute - globals()['SortKeyTotal'] = SortKeyTotal - globals()['SortKeyTotalTotal'] = SortKeyTotalTotal - globals()['SortKeyValue'] = SortKeyValue - globals()['SortKeyValueValue'] = SortKeyValueValue - - -class SortKey(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute': (SortKeyAttributeAttribute,), # noqa: E501 - 'value': (SortKeyValueValue,), # noqa: E501 - 'total': (SortKeyTotalTotal,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute': 'attribute', # noqa: E501 - 'value': 'value', # noqa: E501 - 'total': 'total', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """SortKey - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute (SortKeyAttributeAttribute): [optional] # noqa: E501 - value (SortKeyValueValue): [optional] # noqa: E501 - total (SortKeyTotalTotal): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """SortKey - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - attribute (SortKeyAttributeAttribute): [optional] # noqa: E501 - value (SortKeyValueValue): [optional] # noqa: E501 - total (SortKeyTotalTotal): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - SortKeyAttribute, - SortKeyTotal, - SortKeyValue, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/sort_key.pyi b/gooddata-api-client/gooddata_api_client/model/sort_key.pyi index ab4b6edda..866f04885 100644 --- a/gooddata-api-client/gooddata_api_client/model/sort_key.pyi +++ b/gooddata-api-client/gooddata_api_client/model/sort_key.pyi @@ -36,7 +36,7 @@ class SortKey( class MetaOapg: - + @classmethod @functools.lru_cache() def one_of(cls): @@ -67,6 +67,6 @@ class SortKey( **kwargs, ) -from gooddata_api_client.model.sort_key_attribute import SortKeyAttribute -from gooddata_api_client.model.sort_key_total import SortKeyTotal -from gooddata_api_client.model.sort_key_value import SortKeyValue +from gooddata_api_client.models.sort_key_attribute import SortKeyAttribute +from gooddata_api_client.models.sort_key_total import SortKeyTotal +from gooddata_api_client.models.sort_key_value import SortKeyValue diff --git a/gooddata-api-client/gooddata_api_client/model/sort_key_attribute.py b/gooddata-api-client/gooddata_api_client/model/sort_key_attribute.py deleted file mode 100644 index cae4f64ce..000000000 --- a/gooddata-api-client/gooddata_api_client/model/sort_key_attribute.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.sort_key_attribute_attribute import SortKeyAttributeAttribute - globals()['SortKeyAttributeAttribute'] = SortKeyAttributeAttribute - - -class SortKeyAttribute(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'attribute': (SortKeyAttributeAttribute,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute': 'attribute', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute, *args, **kwargs): # noqa: E501 - """SortKeyAttribute - a model defined in OpenAPI - - Args: - attribute (SortKeyAttributeAttribute): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attribute, *args, **kwargs): # noqa: E501 - """SortKeyAttribute - a model defined in OpenAPI - - Args: - attribute (SortKeyAttributeAttribute): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute = attribute - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/sort_key_attribute_attribute.py b/gooddata-api-client/gooddata_api_client/model/sort_key_attribute_attribute.py deleted file mode 100644 index e36b95334..000000000 --- a/gooddata-api-client/gooddata_api_client/model/sort_key_attribute_attribute.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class SortKeyAttributeAttribute(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('direction',): { - 'ASC': "ASC", - 'DESC': "DESC", - }, - ('sort_type',): { - 'DEFAULT': "DEFAULT", - 'LABEL': "LABEL", - 'ATTRIBUTE': "ATTRIBUTE", - 'AREA': "AREA", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'attribute_identifier': (str,), # noqa: E501 - 'direction': (str,), # noqa: E501 - 'sort_type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attribute_identifier': 'attributeIdentifier', # noqa: E501 - 'direction': 'direction', # noqa: E501 - 'sort_type': 'sortType', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute_identifier, *args, **kwargs): # noqa: E501 - """SortKeyAttributeAttribute - a model defined in OpenAPI - - Args: - attribute_identifier (str): Item reference (to 'itemIdentifiers') referencing, which item should be used for sorting. Only references to attributes are allowed. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - direction (str): Sorting elements - ascending/descending order.. [optional] # noqa: E501 - sort_type (str): Mechanism by which this attribute should be sorted. Available options are: - DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) - LABEL: sorting by this label values - ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label) - ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions.. [optional] if omitted the server will use the default value of "DEFAULT" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute_identifier = attribute_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, attribute_identifier, *args, **kwargs): # noqa: E501 - """SortKeyAttributeAttribute - a model defined in OpenAPI - - Args: - attribute_identifier (str): Item reference (to 'itemIdentifiers') referencing, which item should be used for sorting. Only references to attributes are allowed. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - direction (str): Sorting elements - ascending/descending order.. [optional] # noqa: E501 - sort_type (str): Mechanism by which this attribute should be sorted. Available options are: - DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) - LABEL: sorting by this label values - ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label) - ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions.. [optional] if omitted the server will use the default value of "DEFAULT" # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.attribute_identifier = attribute_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/sort_key_total.py b/gooddata-api-client/gooddata_api_client/model/sort_key_total.py deleted file mode 100644 index bae028ecd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/sort_key_total.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.sort_key_total_total import SortKeyTotalTotal - globals()['SortKeyTotalTotal'] = SortKeyTotalTotal - - -class SortKeyTotal(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'total': (SortKeyTotalTotal,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'total': 'total', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, total, *args, **kwargs): # noqa: E501 - """SortKeyTotal - a model defined in OpenAPI - - Args: - total (SortKeyTotalTotal): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total = total - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, total, *args, **kwargs): # noqa: E501 - """SortKeyTotal - a model defined in OpenAPI - - Args: - total (SortKeyTotalTotal): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total = total - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/sort_key_total.pyi b/gooddata-api-client/gooddata_api_client/model/sort_key_total.pyi index af84ca425..953ea1442 100644 --- a/gooddata-api-client/gooddata_api_client/model/sort_key_total.pyi +++ b/gooddata-api-client/gooddata_api_client/model/sort_key_total.pyi @@ -40,36 +40,36 @@ class SortKeyTotal( required = { "total", } - + class properties: - - + + class total( schemas.DictSchema ): - - + + class MetaOapg: required = { "totalIdentifier", } - + class properties: - + @staticmethod def dataColumnLocators() -> typing.Type['DataColumnLocators']: return DataColumnLocators - - + + class direction( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ASC(cls): return cls("ASC") - + @schemas.classproperty def DESC(cls): return cls("DESC") @@ -79,42 +79,42 @@ class SortKeyTotal( "direction": direction, "totalIdentifier": totalIdentifier, } - + totalIdentifier: MetaOapg.properties.totalIdentifier - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataColumnLocators"]) -> 'DataColumnLocators': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["direction"]) -> MetaOapg.properties.direction: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["totalIdentifier"]) -> MetaOapg.properties.totalIdentifier: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataColumnLocators", "direction", "totalIdentifier", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataColumnLocators"]) -> typing.Union['DataColumnLocators', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["direction"]) -> typing.Union[MetaOapg.properties.direction, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["totalIdentifier"]) -> MetaOapg.properties.totalIdentifier: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataColumnLocators", "direction", "totalIdentifier", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -136,29 +136,29 @@ class SortKeyTotal( __annotations__ = { "total": total, } - + total: MetaOapg.properties.total - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["total"]) -> MetaOapg.properties.total: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["total", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["total"]) -> MetaOapg.properties.total: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["total", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -175,4 +175,4 @@ class SortKeyTotal( **kwargs, ) -from gooddata_api_client.model.data_column_locators import DataColumnLocators +from gooddata_api_client.models.data_column_locators import DataColumnLocators diff --git a/gooddata-api-client/gooddata_api_client/model/sort_key_total_total.py b/gooddata-api-client/gooddata_api_client/model/sort_key_total_total.py deleted file mode 100644 index 33d92bde1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/sort_key_total_total.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.data_column_locators import DataColumnLocators - globals()['DataColumnLocators'] = DataColumnLocators - - -class SortKeyTotalTotal(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('direction',): { - 'ASC': "ASC", - 'DESC': "DESC", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'total_identifier': (str,), # noqa: E501 - 'data_column_locators': (DataColumnLocators,), # noqa: E501 - 'direction': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'total_identifier': 'totalIdentifier', # noqa: E501 - 'data_column_locators': 'dataColumnLocators', # noqa: E501 - 'direction': 'direction', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, total_identifier, *args, **kwargs): # noqa: E501 - """SortKeyTotalTotal - a model defined in OpenAPI - - Args: - total_identifier (str): Local identifier of the total to sort by. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_column_locators (DataColumnLocators): [optional] # noqa: E501 - direction (str): Sorting elements - ascending/descending order.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_identifier = total_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, total_identifier, *args, **kwargs): # noqa: E501 - """SortKeyTotalTotal - a model defined in OpenAPI - - Args: - total_identifier (str): Local identifier of the total to sort by. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data_column_locators (DataColumnLocators): [optional] # noqa: E501 - direction (str): Sorting elements - ascending/descending order.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_identifier = total_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/sort_key_value.py b/gooddata-api-client/gooddata_api_client/model/sort_key_value.py deleted file mode 100644 index 1681264d6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/sort_key_value.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.sort_key_value_value import SortKeyValueValue - globals()['SortKeyValueValue'] = SortKeyValueValue - - -class SortKeyValue(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'value': (SortKeyValueValue,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, value, *args, **kwargs): # noqa: E501 - """SortKeyValue - a model defined in OpenAPI - - Args: - value (SortKeyValueValue): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, value, *args, **kwargs): # noqa: E501 - """SortKeyValue - a model defined in OpenAPI - - Args: - value (SortKeyValueValue): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/sort_key_value.pyi b/gooddata-api-client/gooddata_api_client/model/sort_key_value.pyi index 30fe0cf33..4cb19ffd6 100644 --- a/gooddata-api-client/gooddata_api_client/model/sort_key_value.pyi +++ b/gooddata-api-client/gooddata_api_client/model/sort_key_value.pyi @@ -40,36 +40,36 @@ class SortKeyValue( required = { "value", } - + class properties: - - + + class value( schemas.DictSchema ): - - + + class MetaOapg: required = { "dataColumnLocators", } - + class properties: - + @staticmethod def dataColumnLocators() -> typing.Type['DataColumnLocators']: return DataColumnLocators - - + + class direction( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ASC(cls): return cls("ASC") - + @schemas.classproperty def DESC(cls): return cls("DESC") @@ -77,36 +77,36 @@ class SortKeyValue( "dataColumnLocators": dataColumnLocators, "direction": direction, } - + dataColumnLocators: 'DataColumnLocators' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["dataColumnLocators"]) -> 'DataColumnLocators': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["direction"]) -> MetaOapg.properties.direction: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataColumnLocators", "direction", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["dataColumnLocators"]) -> 'DataColumnLocators': ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["direction"]) -> typing.Union[MetaOapg.properties.direction, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataColumnLocators", "direction", ], str]): return super().get_item_oapg(name) - - + + def __new__( cls, *_args: typing.Union[dict, frozendict.frozendict, ], @@ -126,29 +126,29 @@ class SortKeyValue( __annotations__ = { "value": value, } - + value: MetaOapg.properties.value - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["value", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["value", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -165,4 +165,4 @@ class SortKeyValue( **kwargs, ) -from gooddata_api_client.model.data_column_locators import DataColumnLocators +from gooddata_api_client.models.data_column_locators import DataColumnLocators diff --git a/gooddata-api-client/gooddata_api_client/model/sort_key_value_value.py b/gooddata-api-client/gooddata_api_client/model/sort_key_value_value.py deleted file mode 100644 index 65c7f2434..000000000 --- a/gooddata-api-client/gooddata_api_client/model/sort_key_value_value.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.data_column_locators import DataColumnLocators - globals()['DataColumnLocators'] = DataColumnLocators - - -class SortKeyValueValue(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('direction',): { - 'ASC': "ASC", - 'DESC': "DESC", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data_column_locators': (DataColumnLocators,), # noqa: E501 - 'direction': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_column_locators': 'dataColumnLocators', # noqa: E501 - 'direction': 'direction', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_column_locators, *args, **kwargs): # noqa: E501 - """SortKeyValueValue - a model defined in OpenAPI - - Args: - data_column_locators (DataColumnLocators): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - direction (str): Sorting elements - ascending/descending order.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_column_locators = data_column_locators - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_column_locators, *args, **kwargs): # noqa: E501 - """SortKeyValueValue - a model defined in OpenAPI - - Args: - data_column_locators (DataColumnLocators): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - direction (str): Sorting elements - ascending/descending order.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_column_locators = data_column_locators - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/sql_column.py b/gooddata-api-client/gooddata_api_client/model/sql_column.py deleted file mode 100644 index 0af95da4d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/sql_column.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class SqlColumn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('data_type',): { - 'INT': "INT", - 'STRING': "STRING", - 'DATE': "DATE", - 'NUMERIC': "NUMERIC", - 'TIMESTAMP': "TIMESTAMP", - 'TIMESTAMP_TZ': "TIMESTAMP_TZ", - 'BOOLEAN': "BOOLEAN", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'data_type': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_type': 'dataType', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_type, name, *args, **kwargs): # noqa: E501 - """SqlColumn - a model defined in OpenAPI - - Args: - data_type (str): Column type - name (str): Column name - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_type = data_type - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_type, name, *args, **kwargs): # noqa: E501 - """SqlColumn - a model defined in OpenAPI - - Args: - data_type (str): Column type - name (str): Column name - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_type = data_type - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/sql_query.py b/gooddata-api-client/gooddata_api_client/model/sql_query.py deleted file mode 100644 index 8949a2cb8..000000000 --- a/gooddata-api-client/gooddata_api_client/model/sql_query.py +++ /dev/null @@ -1,323 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.column_location import ColumnLocation - from gooddata_api_client.model.sql_query_all_of import SqlQueryAllOf - globals()['ColumnLocation'] = ColumnLocation - globals()['SqlQueryAllOf'] = SqlQueryAllOf - - -class SqlQuery(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'sql': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'sql': 'sql', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """SqlQuery - a model defined in OpenAPI - - Keyword Args: - sql (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """SqlQuery - a model defined in OpenAPI - - Keyword Args: - sql (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ColumnLocation, - SqlQueryAllOf, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/sql_query_all_of.py b/gooddata-api-client/gooddata_api_client/model/sql_query_all_of.py deleted file mode 100644 index a7ab583e2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/sql_query_all_of.py +++ /dev/null @@ -1,264 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class SqlQueryAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'sql': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'sql': 'sql', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """SqlQueryAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - sql (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """SqlQueryAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - sql (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/suggestion.py b/gooddata-api-client/gooddata_api_client/model/suggestion.py deleted file mode 100644 index c69045453..000000000 --- a/gooddata-api-client/gooddata_api_client/model/suggestion.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class Suggestion(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'label': (str,), # noqa: E501 - 'query': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'label': 'label', # noqa: E501 - 'query': 'query', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, label, query, *args, **kwargs): # noqa: E501 - """Suggestion - a model defined in OpenAPI - - Args: - label (str): Suggestion button label - query (str): Suggestion query - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.label = label - self.query = query - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, label, query, *args, **kwargs): # noqa: E501 - """Suggestion - a model defined in OpenAPI - - Args: - label (str): Suggestion button label - query (str): Suggestion query - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.label = label - self.query = query - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/switch_identity_provider_request.py b/gooddata-api-client/gooddata_api_client/model/switch_identity_provider_request.py deleted file mode 100644 index 08ce23f97..000000000 --- a/gooddata-api-client/gooddata_api_client/model/switch_identity_provider_request.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class SwitchIdentityProviderRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'idp_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'idp_id': 'idpId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, idp_id, *args, **kwargs): # noqa: E501 - """SwitchIdentityProviderRequest - a model defined in OpenAPI - - Args: - idp_id (str): Identity provider ID to set as active for the organization. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.idp_id = idp_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, idp_id, *args, **kwargs): # noqa: E501 - """SwitchIdentityProviderRequest - a model defined in OpenAPI - - Args: - idp_id (str): Identity provider ID to set as active for the organization. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.idp_id = idp_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/table.py b/gooddata-api-client/gooddata_api_client/model/table.py deleted file mode 100644 index 5e47c5d77..000000000 --- a/gooddata-api-client/gooddata_api_client/model/table.py +++ /dev/null @@ -1,323 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.column_location import ColumnLocation - from gooddata_api_client.model.table_all_of import TableAllOf - globals()['ColumnLocation'] = ColumnLocation - globals()['TableAllOf'] = TableAllOf - - -class Table(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'table_name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'table_name': 'tableName', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """Table - a model defined in OpenAPI - - Keyword Args: - table_name (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """Table - a model defined in OpenAPI - - Keyword Args: - table_name (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ColumnLocation, - TableAllOf, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/table_all_of.py b/gooddata-api-client/gooddata_api_client/model/table_all_of.py deleted file mode 100644 index 328990346..000000000 --- a/gooddata-api-client/gooddata_api_client/model/table_all_of.py +++ /dev/null @@ -1,264 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class TableAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'table_name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'table_name': 'tableName', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """TableAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - table_name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """TableAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - table_name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/table_override.py b/gooddata-api-client/gooddata_api_client/model/table_override.py deleted file mode 100644 index fe442931e..000000000 --- a/gooddata-api-client/gooddata_api_client/model/table_override.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.column_override import ColumnOverride - globals()['ColumnOverride'] = ColumnOverride - - -class TableOverride(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'columns': ([ColumnOverride],), # noqa: E501 - 'path': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'columns': 'columns', # noqa: E501 - 'path': 'path', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, columns, path, *args, **kwargs): # noqa: E501 - """TableOverride - a model defined in OpenAPI - - Args: - columns ([ColumnOverride]): An array of column overrides - path ([str]): Path for the table. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.columns = columns - self.path = path - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, columns, path, *args, **kwargs): # noqa: E501 - """TableOverride - a model defined in OpenAPI - - Args: - columns ([ColumnOverride]): An array of column overrides - path ([str]): Path for the table. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.columns = columns - self.path = path - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/table_warning.py b/gooddata-api-client/gooddata_api_client/model/table_warning.py deleted file mode 100644 index 27d807d49..000000000 --- a/gooddata-api-client/gooddata_api_client/model/table_warning.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.column_warning import ColumnWarning - globals()['ColumnWarning'] = ColumnWarning - - -class TableWarning(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'columns': ([ColumnWarning],), # noqa: E501 - 'name': (str,), # noqa: E501 - 'message': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'columns': 'columns', # noqa: E501 - 'name': 'name', # noqa: E501 - 'message': 'message', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, columns, name, *args, **kwargs): # noqa: E501 - """TableWarning - a model defined in OpenAPI - - Args: - columns ([ColumnWarning]): - name (str): Table name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - message (str): Warning message related to the table.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.columns = columns - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, columns, name, *args, **kwargs): # noqa: E501 - """TableWarning - a model defined in OpenAPI - - Args: - columns ([ColumnWarning]): - name (str): Table name. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - message (str): Warning message related to the table.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.columns = columns - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/table_warning.pyi b/gooddata-api-client/gooddata_api_client/model/table_warning.pyi index 82f6c273e..16fa14222 100644 --- a/gooddata-api-client/gooddata_api_client/model/table_warning.pyi +++ b/gooddata-api-client/gooddata_api_client/model/table_warning.pyi @@ -41,21 +41,21 @@ class TableWarning( "columns", "name", } - + class properties: - - + + class columns( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['ColumnWarning']: return ColumnWarning - + def __new__( cls, _arg: typing.Union[typing.Tuple['ColumnWarning'], typing.List['ColumnWarning']], @@ -66,19 +66,19 @@ class TableWarning( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'ColumnWarning': return super().__getitem__(i) - - + + class name( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -89,19 +89,19 @@ class TableWarning( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) - - + + class message( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -112,7 +112,7 @@ class TableWarning( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) __annotations__ = { @@ -120,42 +120,42 @@ class TableWarning( "name": name, "message": message, } - + columns: MetaOapg.properties.columns name: MetaOapg.properties.name - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["columns", "name", "message", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["message"]) -> typing.Union[MetaOapg.properties.message, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["columns", "name", "message", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -176,4 +176,4 @@ class TableWarning( **kwargs, ) -from gooddata_api_client.model.column_warning import ColumnWarning +from gooddata_api_client.models.column_warning import ColumnWarning diff --git a/gooddata-api-client/gooddata_api_client/model/tabular_export_request.py b/gooddata-api-client/gooddata_api_client/model/tabular_export_request.py deleted file mode 100644 index a9e41b998..000000000 --- a/gooddata-api-client/gooddata_api_client/model/tabular_export_request.py +++ /dev/null @@ -1,320 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.custom_override import CustomOverride - from gooddata_api_client.model.json_node import JsonNode - from gooddata_api_client.model.settings import Settings - globals()['CustomOverride'] = CustomOverride - globals()['JsonNode'] = JsonNode - globals()['Settings'] = Settings - - -class TabularExportRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('format',): { - 'CSV': "CSV", - 'XLSX': "XLSX", - 'HTML': "HTML", - 'PDF': "PDF", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'file_name': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - 'custom_override': (CustomOverride,), # noqa: E501 - 'execution_result': (str,), # noqa: E501 - 'metadata': (JsonNode,), # noqa: E501 - 'related_dashboard_id': (str,), # noqa: E501 - 'settings': (Settings,), # noqa: E501 - 'visualization_object': (str,), # noqa: E501 - 'visualization_object_custom_filters': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'file_name': 'fileName', # noqa: E501 - 'format': 'format', # noqa: E501 - 'custom_override': 'customOverride', # noqa: E501 - 'execution_result': 'executionResult', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - 'related_dashboard_id': 'relatedDashboardId', # noqa: E501 - 'settings': 'settings', # noqa: E501 - 'visualization_object': 'visualizationObject', # noqa: E501 - 'visualization_object_custom_filters': 'visualizationObjectCustomFilters', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, file_name, format, *args, **kwargs): # noqa: E501 - """TabularExportRequest - a model defined in OpenAPI - - Args: - file_name (str): Filename of downloaded file without extension. - format (str): Expected file format. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_override (CustomOverride): [optional] # noqa: E501 - execution_result (str): Execution result identifier.. [optional] # noqa: E501 - metadata (JsonNode): [optional] # noqa: E501 - related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 - settings (Settings): [optional] # noqa: E501 - visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 - visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, file_name, format, *args, **kwargs): # noqa: E501 - """TabularExportRequest - a model defined in OpenAPI - - Args: - file_name (str): Filename of downloaded file without extension. - format (str): Expected file format. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - custom_override (CustomOverride): [optional] # noqa: E501 - execution_result (str): Execution result identifier.. [optional] # noqa: E501 - metadata (JsonNode): [optional] # noqa: E501 - related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 - settings (Settings): [optional] # noqa: E501 - visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 - visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.file_name = file_name - self.format = format - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/tabular_export_request.pyi b/gooddata-api-client/gooddata_api_client/model/tabular_export_request.pyi index 727806dc0..50467ad5f 100644 --- a/gooddata-api-client/gooddata_api_client/model/tabular_export_request.pyi +++ b/gooddata-api-client/gooddata_api_client/model/tabular_export_request.pyi @@ -42,29 +42,29 @@ class TabularExportRequest( "executionResult", "format", } - + class properties: executionResult = schemas.StrSchema fileName = schemas.StrSchema - - + + class format( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def CSV(cls): return cls("CSV") - + @schemas.classproperty def XLSX(cls): return cls("XLSX") - + @staticmethod def customOverride() -> typing.Type['CustomOverride']: return CustomOverride - + @staticmethod def settings() -> typing.Type['Settings']: return Settings @@ -75,55 +75,55 @@ class TabularExportRequest( "customOverride": customOverride, "settings": settings, } - + fileName: MetaOapg.properties.fileName executionResult: MetaOapg.properties.executionResult format: MetaOapg.properties.format - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["executionResult"]) -> MetaOapg.properties.executionResult: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["customOverride"]) -> 'CustomOverride': ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["settings"]) -> 'Settings': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["executionResult", "fileName", "format", "customOverride", "settings", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["executionResult"]) -> MetaOapg.properties.executionResult: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["customOverride"]) -> typing.Union['CustomOverride', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["settings"]) -> typing.Union['Settings', schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["executionResult", "fileName", "format", "customOverride", "settings", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -148,5 +148,5 @@ class TabularExportRequest( **kwargs, ) -from gooddata_api_client.model.custom_override import CustomOverride -from gooddata_api_client.model.settings import Settings +from gooddata_api_client.models.custom_override import CustomOverride +from gooddata_api_client.models.settings import Settings diff --git a/gooddata-api-client/gooddata_api_client/model/test_definition_request.py b/gooddata-api-client/gooddata_api_client/model/test_definition_request.py deleted file mode 100644 index 405f5e6f7..000000000 --- a/gooddata-api-client/gooddata_api_client/model/test_definition_request.py +++ /dev/null @@ -1,344 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.data_source_parameter import DataSourceParameter - globals()['DataSourceParameter'] = DataSourceParameter - - -class TestDefinitionRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'POSTGRESQL': "POSTGRESQL", - 'REDSHIFT': "REDSHIFT", - 'VERTICA': "VERTICA", - 'SNOWFLAKE': "SNOWFLAKE", - 'ADS': "ADS", - 'BIGQUERY': "BIGQUERY", - 'MSSQL': "MSSQL", - 'PRESTO': "PRESTO", - 'DREMIO': "DREMIO", - 'DRILL': "DRILL", - 'GREENPLUM': "GREENPLUM", - 'AZURESQL': "AZURESQL", - 'SYNAPSESQL': "SYNAPSESQL", - 'DATABRICKS': "DATABRICKS", - 'GDSTORAGE': "GDSTORAGE", - 'CLICKHOUSE': "CLICKHOUSE", - 'MYSQL': "MYSQL", - 'MARIADB': "MARIADB", - 'ORACLE': "ORACLE", - 'PINOT': "PINOT", - 'SINGLESTORE': "SINGLESTORE", - 'MOTHERDUCK': "MOTHERDUCK", - 'FLEXCONNECT': "FLEXCONNECT", - 'STARROCKS': "STARROCKS", - 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'client_id': (str,), # noqa: E501 - 'client_secret': (str,), # noqa: E501 - 'parameters': ([DataSourceParameter],), # noqa: E501 - 'password': (str,), # noqa: E501 - 'private_key': (str,), # noqa: E501 - 'private_key_passphrase': (str,), # noqa: E501 - 'schema': (str,), # noqa: E501 - 'token': (str,), # noqa: E501 - 'url': (str,), # noqa: E501 - 'username': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'client_id': 'clientId', # noqa: E501 - 'client_secret': 'clientSecret', # noqa: E501 - 'parameters': 'parameters', # noqa: E501 - 'password': 'password', # noqa: E501 - 'private_key': 'privateKey', # noqa: E501 - 'private_key_passphrase': 'privateKeyPassphrase', # noqa: E501 - 'schema': 'schema', # noqa: E501 - 'token': 'token', # noqa: E501 - 'url': 'url', # noqa: E501 - 'username': 'username', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """TestDefinitionRequest - a model defined in OpenAPI - - Args: - type (str): Type of database, where test should connect to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - client_id (str): Id for client based authentication for data sources which supports it.. [optional] # noqa: E501 - client_secret (str): Secret for client based authentication for data sources which supports it.. [optional] # noqa: E501 - parameters ([DataSourceParameter]): [optional] # noqa: E501 - password (str): Database user password.. [optional] # noqa: E501 - private_key (str): Private key for data sources which supports key-pair authentication.. [optional] # noqa: E501 - private_key_passphrase (str): Passphrase for a encrypted version of a private key.. [optional] # noqa: E501 - schema (str): Database schema.. [optional] # noqa: E501 - token (str): Secret for token based authentication for data sources which supports it.. [optional] # noqa: E501 - url (str): URL to database in JDBC format, where test should connect to.. [optional] # noqa: E501 - username (str): Database user name.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, type, *args, **kwargs): # noqa: E501 - """TestDefinitionRequest - a model defined in OpenAPI - - Args: - type (str): Type of database, where test should connect to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - client_id (str): Id for client based authentication for data sources which supports it.. [optional] # noqa: E501 - client_secret (str): Secret for client based authentication for data sources which supports it.. [optional] # noqa: E501 - parameters ([DataSourceParameter]): [optional] # noqa: E501 - password (str): Database user password.. [optional] # noqa: E501 - private_key (str): Private key for data sources which supports key-pair authentication.. [optional] # noqa: E501 - private_key_passphrase (str): Passphrase for a encrypted version of a private key.. [optional] # noqa: E501 - schema (str): Database schema.. [optional] # noqa: E501 - token (str): Secret for token based authentication for data sources which supports it.. [optional] # noqa: E501 - url (str): URL to database in JDBC format, where test should connect to.. [optional] # noqa: E501 - username (str): Database user name.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/test_definition_request.pyi b/gooddata-api-client/gooddata_api_client/model/test_definition_request.pyi index 43c628499..2778e07b8 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_definition_request.pyi +++ b/gooddata-api-client/gooddata_api_client/model/test_definition_request.pyi @@ -231,4 +231,4 @@ class TestDefinitionRequest( **kwargs, ) -from gooddata_api_client.model.data_source_parameter import DataSourceParameter +from gooddata_api_client.models.data_source_parameter import DataSourceParameter diff --git a/gooddata-api-client/gooddata_api_client/model/test_destination_request.py b/gooddata-api-client/gooddata_api_client/model/test_destination_request.py deleted file mode 100644 index 965eb81d5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/test_destination_request.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient - from gooddata_api_client.model.declarative_notification_channel_destination import DeclarativeNotificationChannelDestination - globals()['AutomationExternalRecipient'] = AutomationExternalRecipient - globals()['DeclarativeNotificationChannelDestination'] = DeclarativeNotificationChannelDestination - - -class TestDestinationRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('external_recipients',): { - 'max_items': 1, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'destination': (DeclarativeNotificationChannelDestination,), # noqa: E501 - 'external_recipients': ([AutomationExternalRecipient], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'destination': 'destination', # noqa: E501 - 'external_recipients': 'externalRecipients', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, destination, *args, **kwargs): # noqa: E501 - """TestDestinationRequest - a model defined in OpenAPI - - Args: - destination (DeclarativeNotificationChannelDestination): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - external_recipients ([AutomationExternalRecipient], none_type): External recipients of the test result.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.destination = destination - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, destination, *args, **kwargs): # noqa: E501 - """TestDestinationRequest - a model defined in OpenAPI - - Args: - destination (DeclarativeNotificationChannelDestination): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - external_recipients ([AutomationExternalRecipient], none_type): External recipients of the test result.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.destination = destination - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/test_notification.py b/gooddata-api-client/gooddata_api_client/model/test_notification.py deleted file mode 100644 index f96bb0540..000000000 --- a/gooddata-api-client/gooddata_api_client/model/test_notification.py +++ /dev/null @@ -1,337 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.automation_notification import AutomationNotification - from gooddata_api_client.model.notification_content import NotificationContent - from gooddata_api_client.model.test_notification import TestNotification - from gooddata_api_client.model.test_notification_all_of import TestNotificationAllOf - globals()['AutomationNotification'] = AutomationNotification - globals()['NotificationContent'] = NotificationContent - globals()['TestNotification'] = TestNotification - globals()['TestNotificationAllOf'] = TestNotificationAllOf - - -class TestNotification(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'message': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - lazy_import() - val = { - 'AUTOMATION': AutomationNotification, - 'TEST': TestNotification, - } - if not val: - return None - return {'type': val} - - attribute_map = { - 'message': 'message', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """TestNotification - a model defined in OpenAPI - - Keyword Args: - message (str): - type (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """TestNotification - a model defined in OpenAPI - - Keyword Args: - message (str): - type (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - NotificationContent, - TestNotificationAllOf, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/test_notification_all_of.py b/gooddata-api-client/gooddata_api_client/model/test_notification_all_of.py deleted file mode 100644 index 364d99719..000000000 --- a/gooddata-api-client/gooddata_api_client/model/test_notification_all_of.py +++ /dev/null @@ -1,264 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class TestNotificationAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'message': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'message': 'message', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """TestNotificationAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - message (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """TestNotificationAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - message (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/test_query_duration.py b/gooddata-api-client/gooddata_api_client/model/test_query_duration.py deleted file mode 100644 index efb2fb413..000000000 --- a/gooddata-api-client/gooddata_api_client/model/test_query_duration.py +++ /dev/null @@ -1,274 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class TestQueryDuration(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'simple_select': (int,), # noqa: E501 - 'create_cache_table': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'simple_select': 'simpleSelect', # noqa: E501 - 'create_cache_table': 'createCacheTable', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, simple_select, *args, **kwargs): # noqa: E501 - """TestQueryDuration - a model defined in OpenAPI - - Args: - simple_select (int): Field containing duration of a test select query on a data source. In milliseconds. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - create_cache_table (int): Field containing duration of a test 'create table as select' query on a datasource. In milliseconds. The field is omitted if a data source doesn't support caching.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.simple_select = simple_select - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, simple_select, *args, **kwargs): # noqa: E501 - """TestQueryDuration - a model defined in OpenAPI - - Args: - simple_select (int): Field containing duration of a test select query on a data source. In milliseconds. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - create_cache_table (int): Field containing duration of a test 'create table as select' query on a datasource. In milliseconds. The field is omitted if a data source doesn't support caching.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.simple_select = simple_select - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/test_request.py b/gooddata-api-client/gooddata_api_client/model/test_request.py deleted file mode 100644 index e253b31e1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/test_request.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.data_source_parameter import DataSourceParameter - globals()['DataSourceParameter'] = DataSourceParameter - - -class TestRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'client_id': (str,), # noqa: E501 - 'client_secret': (str,), # noqa: E501 - 'parameters': ([DataSourceParameter],), # noqa: E501 - 'password': (str,), # noqa: E501 - 'private_key': (str,), # noqa: E501 - 'private_key_passphrase': (str,), # noqa: E501 - 'schema': (str,), # noqa: E501 - 'token': (str,), # noqa: E501 - 'url': (str,), # noqa: E501 - 'username': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'client_id': 'clientId', # noqa: E501 - 'client_secret': 'clientSecret', # noqa: E501 - 'parameters': 'parameters', # noqa: E501 - 'password': 'password', # noqa: E501 - 'private_key': 'privateKey', # noqa: E501 - 'private_key_passphrase': 'privateKeyPassphrase', # noqa: E501 - 'schema': 'schema', # noqa: E501 - 'token': 'token', # noqa: E501 - 'url': 'url', # noqa: E501 - 'username': 'username', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """TestRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - client_id (str): Id for client based authentication for data sources which supports it.. [optional] # noqa: E501 - client_secret (str): Secret for client based authentication for data sources which supports it.. [optional] # noqa: E501 - parameters ([DataSourceParameter]): [optional] # noqa: E501 - password (str): Database user password.. [optional] # noqa: E501 - private_key (str): Private key for data sources which supports key-pair authentication.. [optional] # noqa: E501 - private_key_passphrase (str): Passphrase for a encrypted version of a private key.. [optional] # noqa: E501 - schema (str): Database schema.. [optional] # noqa: E501 - token (str): Secret for token based authentication for data sources which supports it.. [optional] # noqa: E501 - url (str): URL to database in JDBC format, where test should connect to.. [optional] # noqa: E501 - username (str): Database user name.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """TestRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - client_id (str): Id for client based authentication for data sources which supports it.. [optional] # noqa: E501 - client_secret (str): Secret for client based authentication for data sources which supports it.. [optional] # noqa: E501 - parameters ([DataSourceParameter]): [optional] # noqa: E501 - password (str): Database user password.. [optional] # noqa: E501 - private_key (str): Private key for data sources which supports key-pair authentication.. [optional] # noqa: E501 - private_key_passphrase (str): Passphrase for a encrypted version of a private key.. [optional] # noqa: E501 - schema (str): Database schema.. [optional] # noqa: E501 - token (str): Secret for token based authentication for data sources which supports it.. [optional] # noqa: E501 - url (str): URL to database in JDBC format, where test should connect to.. [optional] # noqa: E501 - username (str): Database user name.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/test_request.pyi b/gooddata-api-client/gooddata_api_client/model/test_request.pyi index cf4649ff1..6ff9b977c 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_request.pyi +++ b/gooddata-api-client/gooddata_api_client/model/test_request.pyi @@ -37,18 +37,18 @@ class TestRequest( class MetaOapg: - + class properties: - - + + class cachePath( schemas.ListSchema ): - - + + class MetaOapg: items = schemas.StrSchema - + def __new__( cls, _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], @@ -59,23 +59,23 @@ class TestRequest( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> MetaOapg.items: return super().__getitem__(i) enableCaching = schemas.BoolSchema - - + + class parameters( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['DataSourceParameter']: return DataSourceParameter - + def __new__( cls, _arg: typing.Union[typing.Tuple['DataSourceParameter'], typing.List['DataSourceParameter']], @@ -86,7 +86,7 @@ class TestRequest( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'DataSourceParameter': return super().__getitem__(i) password = schemas.StrSchema @@ -104,69 +104,69 @@ class TestRequest( "url": url, "username": username, } - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["cachePath"]) -> MetaOapg.properties.cachePath: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["enableCaching"]) -> MetaOapg.properties.enableCaching: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["parameters"]) -> MetaOapg.properties.parameters: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["password"]) -> MetaOapg.properties.password: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["schema"]) -> MetaOapg.properties.schema: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["token"]) -> MetaOapg.properties.token: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["url"]) -> MetaOapg.properties.url: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["username"]) -> MetaOapg.properties.username: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["cachePath", "enableCaching", "parameters", "password", "schema", "token", "url", "username", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["cachePath"]) -> typing.Union[MetaOapg.properties.cachePath, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["enableCaching"]) -> typing.Union[MetaOapg.properties.enableCaching, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["parameters"]) -> typing.Union[MetaOapg.properties.parameters, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["password"]) -> typing.Union[MetaOapg.properties.password, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["schema"]) -> typing.Union[MetaOapg.properties.schema, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["token"]) -> typing.Union[MetaOapg.properties.token, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["url"]) -> typing.Union[MetaOapg.properties.url, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["username"]) -> typing.Union[MetaOapg.properties.username, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["cachePath", "enableCaching", "parameters", "password", "schema", "token", "url", "username", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -197,4 +197,4 @@ class TestRequest( **kwargs, ) -from gooddata_api_client.model.data_source_parameter import DataSourceParameter +from gooddata_api_client.models.data_source_parameter import DataSourceParameter diff --git a/gooddata-api-client/gooddata_api_client/model/test_response.py b/gooddata-api-client/gooddata_api_client/model/test_response.py deleted file mode 100644 index 5f27b1b02..000000000 --- a/gooddata-api-client/gooddata_api_client/model/test_response.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.test_query_duration import TestQueryDuration - globals()['TestQueryDuration'] = TestQueryDuration - - -class TestResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'successful': (bool,), # noqa: E501 - 'error': (str,), # noqa: E501 - 'query_duration_millis': (TestQueryDuration,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'successful': 'successful', # noqa: E501 - 'error': 'error', # noqa: E501 - 'query_duration_millis': 'queryDurationMillis', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, successful, *args, **kwargs): # noqa: E501 - """TestResponse - a model defined in OpenAPI - - Args: - successful (bool): A flag indicating whether test passed or not. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - error (str): Field containing more details in case of a failure. Details are available to a privileged user only.. [optional] # noqa: E501 - query_duration_millis (TestQueryDuration): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.successful = successful - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, successful, *args, **kwargs): # noqa: E501 - """TestResponse - a model defined in OpenAPI - - Args: - successful (bool): A flag indicating whether test passed or not. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - error (str): Field containing more details in case of a failure. Details are available to a privileged user only.. [optional] # noqa: E501 - query_duration_millis (TestQueryDuration): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.successful = successful - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/test_response.pyi b/gooddata-api-client/gooddata_api_client/model/test_response.pyi index 7c9183553..e897b744e 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_response.pyi +++ b/gooddata-api-client/gooddata_api_client/model/test_response.pyi @@ -108,4 +108,4 @@ class TestResponse( **kwargs, ) -from gooddata_api_client.model.test_query_duration import TestQueryDuration +from gooddata_api_client.models.test_query_duration import TestQueryDuration diff --git a/gooddata-api-client/gooddata_api_client/model/total.py b/gooddata-api-client/gooddata_api_client/model/total.py deleted file mode 100644 index 1de8b8e57..000000000 --- a/gooddata-api-client/gooddata_api_client/model/total.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.total_dimension import TotalDimension - globals()['TotalDimension'] = TotalDimension - - -class Total(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('function',): { - 'SUM': "SUM", - 'MIN': "MIN", - 'MAX': "MAX", - 'AVG': "AVG", - 'MED': "MED", - 'NAT': "NAT", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'function': (str,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - 'metric': (str,), # noqa: E501 - 'total_dimensions': ([TotalDimension],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'function': 'function', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - 'metric': 'metric', # noqa: E501 - 'total_dimensions': 'totalDimensions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, function, local_identifier, metric, total_dimensions, *args, **kwargs): # noqa: E501 - """Total - a model defined in OpenAPI - - Args: - function (str): Aggregation function to compute the total. - local_identifier (str): Total identification within this request. Used e.g. in sorting by a total. - metric (str): The metric for which the total will be computed - total_dimensions ([TotalDimension]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.function = function - self.local_identifier = local_identifier - self.metric = metric - self.total_dimensions = total_dimensions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, function, local_identifier, metric, total_dimensions, *args, **kwargs): # noqa: E501 - """Total - a model defined in OpenAPI - - Args: - function (str): Aggregation function to compute the total. - local_identifier (str): Total identification within this request. Used e.g. in sorting by a total. - metric (str): The metric for which the total will be computed - total_dimensions ([TotalDimension]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.function = function - self.local_identifier = local_identifier - self.metric = metric - self.total_dimensions = total_dimensions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/total.pyi b/gooddata-api-client/gooddata_api_client/model/total.pyi index 4420eadf3..add6a8da1 100644 --- a/gooddata-api-client/gooddata_api_client/model/total.pyi +++ b/gooddata-api-client/gooddata_api_client/model/total.pyi @@ -43,49 +43,49 @@ class Total( "function", "localIdentifier", } - + class properties: - - + + class function( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def SUM(cls): return cls("SUM") - + @schemas.classproperty def MIN(cls): return cls("MIN") - + @schemas.classproperty def MAX(cls): return cls("MAX") - + @schemas.classproperty def AVG(cls): return cls("AVG") - + @schemas.classproperty def MED(cls): return cls("MED") localIdentifier = schemas.StrSchema metric = schemas.StrSchema - - + + class totalDimensions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['TotalDimension']: return TotalDimension - + def __new__( cls, _arg: typing.Union[typing.Tuple['TotalDimension'], typing.List['TotalDimension']], @@ -96,7 +96,7 @@ class Total( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'TotalDimension': return super().__getitem__(i) __annotations__ = { @@ -105,50 +105,50 @@ class Total( "metric": metric, "totalDimensions": totalDimensions, } - + metric: MetaOapg.properties.metric totalDimensions: MetaOapg.properties.totalDimensions function: MetaOapg.properties.function localIdentifier: MetaOapg.properties.localIdentifier - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["function"]) -> MetaOapg.properties.function: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["totalDimensions"]) -> MetaOapg.properties.totalDimensions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["function", "localIdentifier", "metric", "totalDimensions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["function"]) -> MetaOapg.properties.function: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["totalDimensions"]) -> MetaOapg.properties.totalDimensions: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["function", "localIdentifier", "metric", "totalDimensions", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -171,4 +171,4 @@ class Total( **kwargs, ) -from gooddata_api_client.model.total_dimension import TotalDimension +from gooddata_api_client.models.total_dimension import TotalDimension diff --git a/gooddata-api-client/gooddata_api_client/model/total_dimension.py b/gooddata-api-client/gooddata_api_client/model/total_dimension.py deleted file mode 100644 index caa50c81c..000000000 --- a/gooddata-api-client/gooddata_api_client/model/total_dimension.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class TotalDimension(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('dimension_identifier',): { - 'regex': { - 'pattern': r'^[.a-zA-Z0-9_-]+$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'dimension_identifier': (str,), # noqa: E501 - 'total_dimension_items': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dimension_identifier': 'dimensionIdentifier', # noqa: E501 - 'total_dimension_items': 'totalDimensionItems', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dimension_identifier, total_dimension_items, *args, **kwargs): # noqa: E501 - """TotalDimension - a model defined in OpenAPI - - Args: - dimension_identifier (str): An identifier of a dimension for which the total will be computed. - total_dimension_items ([str]): List of dimension items which will be used for total computation. The total is a grand total in this dimension if the list is empty or it includes the first dimension item from the dimension definition, and its data and header will be returned in a separate `ExecutionResultGrandTotal` structure. Otherwise, it is a subtotal and the data will be integrated into the main result. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dimension_identifier = dimension_identifier - self.total_dimension_items = total_dimension_items - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dimension_identifier, total_dimension_items, *args, **kwargs): # noqa: E501 - """TotalDimension - a model defined in OpenAPI - - Args: - dimension_identifier (str): An identifier of a dimension for which the total will be computed. - total_dimension_items ([str]): List of dimension items which will be used for total computation. The total is a grand total in this dimension if the list is empty or it includes the first dimension item from the dimension definition, and its data and header will be returned in a separate `ExecutionResultGrandTotal` structure. Otherwise, it is a subtotal and the data will be integrated into the main result. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dimension_identifier = dimension_identifier - self.total_dimension_items = total_dimension_items - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/total_execution_result_header.py b/gooddata-api-client/gooddata_api_client/model/total_execution_result_header.py deleted file mode 100644 index 54b4e0c35..000000000 --- a/gooddata-api-client/gooddata_api_client/model/total_execution_result_header.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.total_result_header import TotalResultHeader - globals()['TotalResultHeader'] = TotalResultHeader - - -class TotalExecutionResultHeader(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'total_header': (TotalResultHeader,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'total_header': 'totalHeader', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, total_header, *args, **kwargs): # noqa: E501 - """TotalExecutionResultHeader - a model defined in OpenAPI - - Args: - total_header (TotalResultHeader): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_header = total_header - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, total_header, *args, **kwargs): # noqa: E501 - """TotalExecutionResultHeader - a model defined in OpenAPI - - Args: - total_header (TotalResultHeader): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_header = total_header - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/total_execution_result_header.pyi b/gooddata-api-client/gooddata_api_client/model/total_execution_result_header.pyi index 46bb97a88..651ce3bf8 100644 --- a/gooddata-api-client/gooddata_api_client/model/total_execution_result_header.pyi +++ b/gooddata-api-client/gooddata_api_client/model/total_execution_result_header.pyi @@ -38,38 +38,38 @@ class TotalExecutionResultHeader( required = { "totalHeader", } - + class properties: - + @staticmethod def totalHeader() -> typing.Type['TotalResultHeader']: return TotalResultHeader __annotations__ = { "totalHeader": totalHeader, } - + totalHeader: 'TotalResultHeader' - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["totalHeader"]) -> 'TotalResultHeader': ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["totalHeader", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["totalHeader"]) -> 'TotalResultHeader': ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["totalHeader", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -86,4 +86,4 @@ class TotalExecutionResultHeader( **kwargs, ) -from gooddata_api_client.model.total_result_header import TotalResultHeader +from gooddata_api_client.models.total_result_header import TotalResultHeader diff --git a/gooddata-api-client/gooddata_api_client/model/total_result_header.py b/gooddata-api-client/gooddata_api_client/model/total_result_header.py deleted file mode 100644 index 6d60327b2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/total_result_header.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class TotalResultHeader(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'function': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'function': 'function', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, function, *args, **kwargs): # noqa: E501 - """TotalResultHeader - a model defined in OpenAPI - - Args: - function (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.function = function - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, function, *args, **kwargs): # noqa: E501 - """TotalResultHeader - a model defined in OpenAPI - - Args: - function (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.function = function - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/trigger_automation_request.py b/gooddata-api-client/gooddata_api_client/model/trigger_automation_request.py deleted file mode 100644 index c44427d88..000000000 --- a/gooddata-api-client/gooddata_api_client/model/trigger_automation_request.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.ad_hoc_automation import AdHocAutomation - globals()['AdHocAutomation'] = AdHocAutomation - - -class TriggerAutomationRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'automation': (AdHocAutomation,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'automation': 'automation', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, automation, *args, **kwargs): # noqa: E501 - """TriggerAutomationRequest - a model defined in OpenAPI - - Args: - automation (AdHocAutomation): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.automation = automation - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, automation, *args, **kwargs): # noqa: E501 - """TriggerAutomationRequest - a model defined in OpenAPI - - Args: - automation (AdHocAutomation): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.automation = automation - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_assignee.py b/gooddata-api-client/gooddata_api_client/model/user_assignee.py deleted file mode 100644 index 1b181fb7d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_assignee.py +++ /dev/null @@ -1,278 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class UserAssignee(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'email': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'email': 'email', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """UserAssignee - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - email (str): User email address. [optional] # noqa: E501 - name (str): User name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """UserAssignee - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - email (str): User email address. [optional] # noqa: E501 - name (str): User name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_context.py b/gooddata-api-client/gooddata_api_client/model/user_context.py deleted file mode 100644 index d31d32383..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_context.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.active_object_identification import ActiveObjectIdentification - globals()['ActiveObjectIdentification'] = ActiveObjectIdentification - - -class UserContext(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'active_object': (ActiveObjectIdentification,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'active_object': 'activeObject', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, active_object, *args, **kwargs): # noqa: E501 - """UserContext - a model defined in OpenAPI - - Args: - active_object (ActiveObjectIdentification): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.active_object = active_object - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, active_object, *args, **kwargs): # noqa: E501 - """UserContext - a model defined in OpenAPI - - Args: - active_object (ActiveObjectIdentification): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.active_object = active_object - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_group_assignee.py b/gooddata-api-client/gooddata_api_client/model/user_group_assignee.py deleted file mode 100644 index 562b6fba0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_group_assignee.py +++ /dev/null @@ -1,274 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class UserGroupAssignee(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """UserGroupAssignee - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): User group name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """UserGroupAssignee - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): User group name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_group_identifier.py b/gooddata-api-client/gooddata_api_client/model/user_group_identifier.py deleted file mode 100644 index 668cb021b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_group_identifier.py +++ /dev/null @@ -1,274 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class UserGroupIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """UserGroupIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """UserGroupIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_group_permission.py b/gooddata-api-client/gooddata_api_client/model/user_group_permission.py deleted file mode 100644 index aacca9f70..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_group_permission.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.granted_permission import GrantedPermission - globals()['GrantedPermission'] = GrantedPermission - - -class UserGroupPermission(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'permissions': ([GrantedPermission],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """UserGroupPermission - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Name of the user group. [optional] # noqa: E501 - permissions ([GrantedPermission]): Permissions granted to the user group. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """UserGroupPermission - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Name of the user group. [optional] # noqa: E501 - permissions ([GrantedPermission]): Permissions granted to the user group. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_group_permission.pyi b/gooddata-api-client/gooddata_api_client/model/user_group_permission.pyi index 7d1065508..a9d7d59d0 100644 --- a/gooddata-api-client/gooddata_api_client/model/user_group_permission.pyi +++ b/gooddata-api-client/gooddata_api_client/model/user_group_permission.pyi @@ -40,23 +40,23 @@ class UserGroupPermission( required = { "id", } - + class properties: id = schemas.StrSchema name = schemas.StrSchema - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['GrantedPermission']: return GrantedPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['GrantedPermission'], typing.List['GrantedPermission']], @@ -67,7 +67,7 @@ class UserGroupPermission( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'GrantedPermission': return super().__getitem__(i) __annotations__ = { @@ -75,41 +75,41 @@ class UserGroupPermission( "name": name, "permissions": permissions, } - + id: MetaOapg.properties.id - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "name", "permissions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "name", "permissions", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -130,4 +130,4 @@ class UserGroupPermission( **kwargs, ) -from gooddata_api_client.model.granted_permission import GrantedPermission +from gooddata_api_client.models.granted_permission import GrantedPermission diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_data_source_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/user_management_data_source_permission_assignment.py deleted file mode 100644 index b1e5dcda9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_management_data_source_permission_assignment.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class UserManagementDataSourcePermissionAssignment(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('permissions',): { - 'MANAGE': "MANAGE", - 'USE': "USE", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'permissions': ([str],), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - 'name', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, permissions, *args, **kwargs): # noqa: E501 - """UserManagementDataSourcePermissionAssignment - a model defined in OpenAPI - - Args: - id (str): Id of the datasource - permissions ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Name of the datasource. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, permissions, *args, **kwargs): # noqa: E501 - """UserManagementDataSourcePermissionAssignment - a model defined in OpenAPI - - Args: - id (str): Id of the datasource - permissions ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Name of the datasource. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_permission_assignments.py b/gooddata-api-client/gooddata_api_client/model/user_management_permission_assignments.py deleted file mode 100644 index b4de7f443..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_management_permission_assignments.py +++ /dev/null @@ -1,284 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment - from gooddata_api_client.model.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment - globals()['UserManagementDataSourcePermissionAssignment'] = UserManagementDataSourcePermissionAssignment - globals()['UserManagementWorkspacePermissionAssignment'] = UserManagementWorkspacePermissionAssignment - - -class UserManagementPermissionAssignments(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data_sources': ([UserManagementDataSourcePermissionAssignment],), # noqa: E501 - 'workspaces': ([UserManagementWorkspacePermissionAssignment],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_sources': 'dataSources', # noqa: E501 - 'workspaces': 'workspaces', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_sources, workspaces, *args, **kwargs): # noqa: E501 - """UserManagementPermissionAssignments - a model defined in OpenAPI - - Args: - data_sources ([UserManagementDataSourcePermissionAssignment]): - workspaces ([UserManagementWorkspacePermissionAssignment]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_sources = data_sources - self.workspaces = workspaces - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_sources, workspaces, *args, **kwargs): # noqa: E501 - """UserManagementPermissionAssignments - a model defined in OpenAPI - - Args: - data_sources ([UserManagementDataSourcePermissionAssignment]): - workspaces ([UserManagementWorkspacePermissionAssignment]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_sources = data_sources - self.workspaces = workspaces - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_user_group_member.py b/gooddata-api-client/gooddata_api_client/model/user_management_user_group_member.py deleted file mode 100644 index 32af540dc..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_management_user_group_member.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class UserManagementUserGroupMember(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - 'name', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """UserManagementUserGroupMember - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """UserManagementUserGroupMember - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_user_group_members.py b/gooddata-api-client/gooddata_api_client/model/user_management_user_group_members.py deleted file mode 100644 index ed1437a20..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_management_user_group_members.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.user_management_user_group_member import UserManagementUserGroupMember - globals()['UserManagementUserGroupMember'] = UserManagementUserGroupMember - - -class UserManagementUserGroupMembers(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'members': ([UserManagementUserGroupMember],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'members': 'members', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, members, *args, **kwargs): # noqa: E501 - """UserManagementUserGroupMembers - a model defined in OpenAPI - - Args: - members ([UserManagementUserGroupMember]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.members = members - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, members, *args, **kwargs): # noqa: E501 - """UserManagementUserGroupMembers - a model defined in OpenAPI - - Args: - members ([UserManagementUserGroupMember]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.members = members - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_user_groups.py b/gooddata-api-client/gooddata_api_client/model/user_management_user_groups.py deleted file mode 100644 index f47906cbe..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_management_user_groups.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.user_management_user_groups_item import UserManagementUserGroupsItem - globals()['UserManagementUserGroupsItem'] = UserManagementUserGroupsItem - - -class UserManagementUserGroups(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'total_count': (int,), # noqa: E501 - 'user_groups': ([UserManagementUserGroupsItem],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'total_count': 'totalCount', # noqa: E501 - 'user_groups': 'userGroups', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, total_count, user_groups, *args, **kwargs): # noqa: E501 - """UserManagementUserGroups - a model defined in OpenAPI - - Args: - total_count (int): Total number of groups - user_groups ([UserManagementUserGroupsItem]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_count = total_count - self.user_groups = user_groups - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, total_count, user_groups, *args, **kwargs): # noqa: E501 - """UserManagementUserGroups - a model defined in OpenAPI - - Args: - total_count (int): Total number of groups - user_groups ([UserManagementUserGroupsItem]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_count = total_count - self.user_groups = user_groups - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_user_groups_item.py b/gooddata-api-client/gooddata_api_client/model/user_management_user_groups_item.py deleted file mode 100644 index 436a1b907..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_management_user_groups_item.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment - from gooddata_api_client.model.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment - globals()['UserManagementDataSourcePermissionAssignment'] = UserManagementDataSourcePermissionAssignment - globals()['UserManagementWorkspacePermissionAssignment'] = UserManagementWorkspacePermissionAssignment - - -class UserManagementUserGroupsItem(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data_sources': ([UserManagementDataSourcePermissionAssignment],), # noqa: E501 - 'id': (str,), # noqa: E501 - 'organization_admin': (bool,), # noqa: E501 - 'user_count': (int,), # noqa: E501 - 'workspaces': ([UserManagementWorkspacePermissionAssignment],), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_sources': 'dataSources', # noqa: E501 - 'id': 'id', # noqa: E501 - 'organization_admin': 'organizationAdmin', # noqa: E501 - 'user_count': 'userCount', # noqa: E501 - 'workspaces': 'workspaces', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_sources, id, organization_admin, user_count, workspaces, *args, **kwargs): # noqa: E501 - """UserManagementUserGroupsItem - a model defined in OpenAPI - - Args: - data_sources ([UserManagementDataSourcePermissionAssignment]): - id (str): - organization_admin (bool): Is group organization admin - user_count (int): The number of users belonging to the group - workspaces ([UserManagementWorkspacePermissionAssignment]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Group name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_sources = data_sources - self.id = id - self.organization_admin = organization_admin - self.user_count = user_count - self.workspaces = workspaces - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_sources, id, organization_admin, user_count, workspaces, *args, **kwargs): # noqa: E501 - """UserManagementUserGroupsItem - a model defined in OpenAPI - - Args: - data_sources ([UserManagementDataSourcePermissionAssignment]): - id (str): - organization_admin (bool): Is group organization admin - user_count (int): The number of users belonging to the group - workspaces ([UserManagementWorkspacePermissionAssignment]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Group name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_sources = data_sources - self.id = id - self.organization_admin = organization_admin - self.user_count = user_count - self.workspaces = workspaces - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_users.py b/gooddata-api-client/gooddata_api_client/model/user_management_users.py deleted file mode 100644 index 6ef58120d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_management_users.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.user_management_users_item import UserManagementUsersItem - globals()['UserManagementUsersItem'] = UserManagementUsersItem - - -class UserManagementUsers(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'total_count': (int,), # noqa: E501 - 'users': ([UserManagementUsersItem],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'total_count': 'totalCount', # noqa: E501 - 'users': 'users', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, total_count, users, *args, **kwargs): # noqa: E501 - """UserManagementUsers - a model defined in OpenAPI - - Args: - total_count (int): The total number of users is based on applied filters. - users ([UserManagementUsersItem]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_count = total_count - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, total_count, users, *args, **kwargs): # noqa: E501 - """UserManagementUsers - a model defined in OpenAPI - - Args: - total_count (int): The total number of users is based on applied filters. - users ([UserManagementUsersItem]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_count = total_count - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_users_item.py b/gooddata-api-client/gooddata_api_client/model/user_management_users_item.py deleted file mode 100644 index 766712b00..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_management_users_item.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.user_group_identifier import UserGroupIdentifier - from gooddata_api_client.model.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment - from gooddata_api_client.model.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment - globals()['UserGroupIdentifier'] = UserGroupIdentifier - globals()['UserManagementDataSourcePermissionAssignment'] = UserManagementDataSourcePermissionAssignment - globals()['UserManagementWorkspacePermissionAssignment'] = UserManagementWorkspacePermissionAssignment - - -class UserManagementUsersItem(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data_sources': ([UserManagementDataSourcePermissionAssignment],), # noqa: E501 - 'id': (str,), # noqa: E501 - 'organization_admin': (bool,), # noqa: E501 - 'user_groups': ([UserGroupIdentifier],), # noqa: E501 - 'workspaces': ([UserManagementWorkspacePermissionAssignment],), # noqa: E501 - 'email': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data_sources': 'dataSources', # noqa: E501 - 'id': 'id', # noqa: E501 - 'organization_admin': 'organizationAdmin', # noqa: E501 - 'user_groups': 'userGroups', # noqa: E501 - 'workspaces': 'workspaces', # noqa: E501 - 'email': 'email', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data_sources, id, organization_admin, user_groups, workspaces, *args, **kwargs): # noqa: E501 - """UserManagementUsersItem - a model defined in OpenAPI - - Args: - data_sources ([UserManagementDataSourcePermissionAssignment]): - id (str): - organization_admin (bool): Is user organization admin - user_groups ([UserGroupIdentifier]): - workspaces ([UserManagementWorkspacePermissionAssignment]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - email (str): User email address. [optional] # noqa: E501 - name (str): User name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_sources = data_sources - self.id = id - self.organization_admin = organization_admin - self.user_groups = user_groups - self.workspaces = workspaces - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data_sources, id, organization_admin, user_groups, workspaces, *args, **kwargs): # noqa: E501 - """UserManagementUsersItem - a model defined in OpenAPI - - Args: - data_sources ([UserManagementDataSourcePermissionAssignment]): - id (str): - organization_admin (bool): Is user organization admin - user_groups ([UserGroupIdentifier]): - workspaces ([UserManagementWorkspacePermissionAssignment]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - email (str): User email address. [optional] # noqa: E501 - name (str): User name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data_sources = data_sources - self.id = id - self.organization_admin = organization_admin - self.user_groups = user_groups - self.workspaces = workspaces - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.py deleted file mode 100644 index 3f48d6fa5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.py +++ /dev/null @@ -1,309 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class UserManagementWorkspacePermissionAssignment(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('hierarchy_permissions',): { - 'MANAGE': "MANAGE", - 'ANALYZE': "ANALYZE", - 'EXPORT': "EXPORT", - 'EXPORT_TABULAR': "EXPORT_TABULAR", - 'EXPORT_PDF': "EXPORT_PDF", - 'CREATE_AUTOMATION': "CREATE_AUTOMATION", - 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", - 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", - 'VIEW': "VIEW", - }, - ('permissions',): { - 'MANAGE': "MANAGE", - 'ANALYZE': "ANALYZE", - 'EXPORT': "EXPORT", - 'EXPORT_TABULAR': "EXPORT_TABULAR", - 'EXPORT_PDF': "EXPORT_PDF", - 'CREATE_AUTOMATION': "CREATE_AUTOMATION", - 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", - 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'hierarchy_permissions': ([str],), # noqa: E501 - 'id': (str,), # noqa: E501 - 'permissions': ([str],), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'hierarchy_permissions': 'hierarchyPermissions', # noqa: E501 - 'id': 'id', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - 'name', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, hierarchy_permissions, id, permissions, *args, **kwargs): # noqa: E501 - """UserManagementWorkspacePermissionAssignment - a model defined in OpenAPI - - Args: - hierarchy_permissions ([str]): - id (str): - permissions ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.hierarchy_permissions = hierarchy_permissions - self.id = id - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, hierarchy_permissions, id, permissions, *args, **kwargs): # noqa: E501 - """UserManagementWorkspacePermissionAssignment - a model defined in OpenAPI - - Args: - hierarchy_permissions ([str]): - id (str): - permissions ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.hierarchy_permissions = hierarchy_permissions - self.id = id - self.permissions = permissions - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_permission.py b/gooddata-api-client/gooddata_api_client/model/user_permission.py deleted file mode 100644 index 7ad623efa..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_permission.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.granted_permission import GrantedPermission - globals()['GrantedPermission'] = GrantedPermission - - -class UserPermission(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'email': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'permissions': ([GrantedPermission],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'email': 'email', # noqa: E501 - 'name': 'name', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """UserPermission - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - email (str): User email address. [optional] # noqa: E501 - name (str): Name of user. [optional] # noqa: E501 - permissions ([GrantedPermission]): Permissions granted to the user. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """UserPermission - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - email (str): User email address. [optional] # noqa: E501 - name (str): Name of user. [optional] # noqa: E501 - permissions ([GrantedPermission]): Permissions granted to the user. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_permission.pyi b/gooddata-api-client/gooddata_api_client/model/user_permission.pyi index afd18036a..946089cd3 100644 --- a/gooddata-api-client/gooddata_api_client/model/user_permission.pyi +++ b/gooddata-api-client/gooddata_api_client/model/user_permission.pyi @@ -40,24 +40,24 @@ class UserPermission( required = { "id", } - + class properties: id = schemas.StrSchema email = schemas.StrSchema name = schemas.StrSchema - - + + class permissions( schemas.ListSchema ): - - + + class MetaOapg: - + @staticmethod def items() -> typing.Type['GrantedPermission']: return GrantedPermission - + def __new__( cls, _arg: typing.Union[typing.Tuple['GrantedPermission'], typing.List['GrantedPermission']], @@ -68,7 +68,7 @@ class UserPermission( _arg, _configuration=_configuration, ) - + def __getitem__(self, i: int) -> 'GrantedPermission': return super().__getitem__(i) __annotations__ = { @@ -77,47 +77,47 @@ class UserPermission( "name": name, "permissions": permissions, } - + id: MetaOapg.properties.id - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... - + @typing.overload def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... - + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "email", "name", "permissions", ], str]): # dict_instance[name] accessor return super().__getitem__(name) - - + + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> typing.Union[MetaOapg.properties.email, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... - + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "email", "name", "permissions", ], str]): return super().get_item_oapg(name) - + def __new__( cls, @@ -140,4 +140,4 @@ class UserPermission( **kwargs, ) -from gooddata_api_client.model.granted_permission import GrantedPermission +from gooddata_api_client.models.granted_permission import GrantedPermission diff --git a/gooddata-api-client/gooddata_api_client/model/validate_by_item.py b/gooddata-api-client/gooddata_api_client/model/validate_by_item.py deleted file mode 100644 index 0ce8015d4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/validate_by_item.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ValidateByItem(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - ('type',): { - 'regex': { - 'pattern': r'^(label)|(attribute)|(fact)|(metric)$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """ValidateByItem - a model defined in OpenAPI - - Args: - id (str): Specifies entity used for valid elements computation. - type (str): Specifies entity type which could be label, attribute, fact, or metric. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """ValidateByItem - a model defined in OpenAPI - - Args: - id (str): Specifies entity used for valid elements computation. - type (str): Specifies entity type which could be label, attribute, fact, or metric. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_by_id_request.py b/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_by_id_request.py deleted file mode 100644 index acaae9d94..000000000 --- a/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_by_id_request.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ValidateLLMEndpointByIdRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'base_url': (str,), # noqa: E501 - 'llm_model': (str,), # noqa: E501 - 'llm_organization': (str,), # noqa: E501 - 'provider': (str,), # noqa: E501 - 'token': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'base_url': 'baseUrl', # noqa: E501 - 'llm_model': 'llmModel', # noqa: E501 - 'llm_organization': 'llmOrganization', # noqa: E501 - 'provider': 'provider', # noqa: E501 - 'token': 'token', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ValidateLLMEndpointByIdRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - base_url (str): Base URL for the LLM endpoint validation. [optional] # noqa: E501 - llm_model (str): LLM model for the LLM endpoint validation. [optional] # noqa: E501 - llm_organization (str): Organization name for the LLM endpoint validation. [optional] # noqa: E501 - provider (str): Provider for the LLM endpoint validation. [optional] # noqa: E501 - token (str): Token for the LLM endpoint validation. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ValidateLLMEndpointByIdRequest - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - base_url (str): Base URL for the LLM endpoint validation. [optional] # noqa: E501 - llm_model (str): LLM model for the LLM endpoint validation. [optional] # noqa: E501 - llm_organization (str): Organization name for the LLM endpoint validation. [optional] # noqa: E501 - provider (str): Provider for the LLM endpoint validation. [optional] # noqa: E501 - token (str): Token for the LLM endpoint validation. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_request.py b/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_request.py deleted file mode 100644 index d992bf2de..000000000 --- a/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_request.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ValidateLLMEndpointRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'provider': (str,), # noqa: E501 - 'token': (str,), # noqa: E501 - 'base_url': (str,), # noqa: E501 - 'llm_model': (str,), # noqa: E501 - 'llm_organization': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'provider': 'provider', # noqa: E501 - 'token': 'token', # noqa: E501 - 'base_url': 'baseUrl', # noqa: E501 - 'llm_model': 'llmModel', # noqa: E501 - 'llm_organization': 'llmOrganization', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, provider, token, *args, **kwargs): # noqa: E501 - """ValidateLLMEndpointRequest - a model defined in OpenAPI - - Args: - provider (str): Provider for the LLM endpoint validation - token (str): Token for the LLM endpoint validation - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - base_url (str): Base URL for the LLM endpoint validation. [optional] # noqa: E501 - llm_model (str): LLM model for the LLM endpoint validation. [optional] # noqa: E501 - llm_organization (str): Organization name for the LLM endpoint validation. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.provider = provider - self.token = token - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, provider, token, *args, **kwargs): # noqa: E501 - """ValidateLLMEndpointRequest - a model defined in OpenAPI - - Args: - provider (str): Provider for the LLM endpoint validation - token (str): Token for the LLM endpoint validation - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - base_url (str): Base URL for the LLM endpoint validation. [optional] # noqa: E501 - llm_model (str): LLM model for the LLM endpoint validation. [optional] # noqa: E501 - llm_organization (str): Organization name for the LLM endpoint validation. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.provider = provider - self.token = token - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_response.py b/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_response.py deleted file mode 100644 index 20db40776..000000000 --- a/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_response.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ValidateLLMEndpointResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'message': (str,), # noqa: E501 - 'successful': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'message': 'message', # noqa: E501 - 'successful': 'successful', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, message, successful, *args, **kwargs): # noqa: E501 - """ValidateLLMEndpointResponse - a model defined in OpenAPI - - Args: - message (str): Additional message about the LLM endpoint validation - successful (bool): Whether the LLM endpoint validation was successful - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.message = message - self.successful = successful - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, message, successful, *args, **kwargs): # noqa: E501 - """ValidateLLMEndpointResponse - a model defined in OpenAPI - - Args: - message (str): Additional message about the LLM endpoint validation - successful (bool): Whether the LLM endpoint validation was successful - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.message = message - self.successful = successful - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/value.py b/gooddata-api-client/gooddata_api_client/model/value.py deleted file mode 100644 index b75fe031d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/value.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class Value(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'value': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'value': 'value', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, value, *args, **kwargs): # noqa: E501 - """Value - a model defined in OpenAPI - - Args: - value (float): Value of the alert threshold to compare the metric to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, value, *args, **kwargs): # noqa: E501 - """Value - a model defined in OpenAPI - - Args: - value (float): Value of the alert threshold to compare the metric to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.value = value - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/visible_filter.py b/gooddata-api-client/gooddata_api_client/model/visible_filter.py deleted file mode 100644 index 443df540f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/visible_filter.py +++ /dev/null @@ -1,272 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class VisibleFilter(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'is_all_time_date_filter': (bool,), # noqa: E501 - 'local_identifier': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'is_all_time_date_filter': 'isAllTimeDateFilter', # noqa: E501 - 'local_identifier': 'localIdentifier', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """VisibleFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - is_all_time_date_filter (bool): Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.. [optional] if omitted the server will use the default value of False # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """VisibleFilter - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - is_all_time_date_filter (bool): Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.. [optional] if omitted the server will use the default value of False # noqa: E501 - local_identifier (str): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/visual_export_request.py b/gooddata-api-client/gooddata_api_client/model/visual_export_request.py deleted file mode 100644 index 6b756431d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/visual_export_request.py +++ /dev/null @@ -1,280 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class VisualExportRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'dashboard_id': (str,), # noqa: E501 - 'file_name': (str,), # noqa: E501 - 'metadata': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dashboard_id': 'dashboardId', # noqa: E501 - 'file_name': 'fileName', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dashboard_id, file_name, *args, **kwargs): # noqa: E501 - """VisualExportRequest - a model defined in OpenAPI - - Args: - dashboard_id (str): Dashboard identifier - file_name (str): File name to be used for retrieving the pdf document. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Metadata definition in free-form JSON format.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dashboard_id = dashboard_id - self.file_name = file_name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dashboard_id, file_name, *args, **kwargs): # noqa: E501 - """VisualExportRequest - a model defined in OpenAPI - - Args: - dashboard_id (str): Dashboard identifier - file_name (str): File name to be used for retrieving the pdf document. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Metadata definition in free-form JSON format.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dashboard_id = dashboard_id - self.file_name = file_name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/webhook.py b/gooddata-api-client/gooddata_api_client/model/webhook.py deleted file mode 100644 index 1f6193a61..000000000 --- a/gooddata-api-client/gooddata_api_client/model/webhook.py +++ /dev/null @@ -1,347 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.webhook_all_of import WebhookAllOf - globals()['WebhookAllOf'] = WebhookAllOf - - -class Webhook(ModelComposed): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WEBHOOK': "WEBHOOK", - }, - } - - validations = { - ('token',): { - 'max_length': 10000, - }, - ('url',): { - 'max_length': 255, - 'regex': { - 'pattern': r'https?\:\/\/.*', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'type': (str,), # noqa: E501 - 'has_token': (bool, none_type,), # noqa: E501 - 'token': (str, none_type,), # noqa: E501 - 'url': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'has_token': 'hasToken', # noqa: E501 - 'token': 'token', # noqa: E501 - 'url': 'url', # noqa: E501 - } - - read_only_vars = { - 'has_token', # noqa: E501 - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """Webhook - a model defined in OpenAPI - - Keyword Args: - type (str): The destination type.. defaults to "WEBHOOK", must be one of ["WEBHOOK", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "WEBHOOK") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """Webhook - a model defined in OpenAPI - - Keyword Args: - type (str): The destination type.. defaults to "WEBHOOK", must be one of ["WEBHOOK", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "WEBHOOK") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - WebhookAllOf, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/webhook_all_of.py b/gooddata-api-client/gooddata_api_client/model/webhook_all_of.py deleted file mode 100644 index 709c6dcae..000000000 --- a/gooddata-api-client/gooddata_api_client/model/webhook_all_of.py +++ /dev/null @@ -1,289 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class WebhookAllOf(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WEBHOOK': "WEBHOOK", - }, - } - - validations = { - ('token',): { - 'max_length': 10000, - }, - ('url',): { - 'max_length': 255, - 'regex': { - 'pattern': r'https?\:\/\/.*', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'has_token': (bool, none_type,), # noqa: E501 - 'token': (str, none_type,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'url': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'has_token': 'hasToken', # noqa: E501 - 'token': 'token', # noqa: E501 - 'type': 'type', # noqa: E501 - 'url': 'url', # noqa: E501 - } - - read_only_vars = { - 'has_token', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """WebhookAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "WEBHOOK" # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """WebhookAllOf - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "WEBHOOK" # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/webhook_automation_info.py b/gooddata-api-client/gooddata_api_client/model/webhook_automation_info.py deleted file mode 100644 index f30536832..000000000 --- a/gooddata-api-client/gooddata_api_client/model/webhook_automation_info.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class WebhookAutomationInfo(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'dashboard_url': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'is_custom_dashboard_url': (bool,), # noqa: E501 - 'dashboard_title': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dashboard_url': 'dashboardURL', # noqa: E501 - 'id': 'id', # noqa: E501 - 'is_custom_dashboard_url': 'isCustomDashboardURL', # noqa: E501 - 'dashboard_title': 'dashboardTitle', # noqa: E501 - 'title': 'title', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dashboard_url, id, is_custom_dashboard_url, *args, **kwargs): # noqa: E501 - """WebhookAutomationInfo - a model defined in OpenAPI - - Args: - dashboard_url (str): - id (str): - is_custom_dashboard_url (bool): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_title (str): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dashboard_url = dashboard_url - self.id = id - self.is_custom_dashboard_url = is_custom_dashboard_url - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, dashboard_url, id, is_custom_dashboard_url, *args, **kwargs): # noqa: E501 - """WebhookAutomationInfo - a model defined in OpenAPI - - Args: - dashboard_url (str): - id (str): - is_custom_dashboard_url (bool): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dashboard_title (str): [optional] # noqa: E501 - title (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.dashboard_url = dashboard_url - self.id = id - self.is_custom_dashboard_url = is_custom_dashboard_url - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/webhook_message.py b/gooddata-api-client/gooddata_api_client/model/webhook_message.py deleted file mode 100644 index c971143a2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/webhook_message.py +++ /dev/null @@ -1,292 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.webhook_message_data import WebhookMessageData - globals()['WebhookMessageData'] = WebhookMessageData - - -class WebhookMessage(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'COMPLETED': "automation-task.completed", - 'LIMIT-EXCEEDED': "automation-task.limit-exceeded", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (WebhookMessageData,), # noqa: E501 - 'timestamp': (datetime,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'timestamp': 'timestamp', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, timestamp, type, *args, **kwargs): # noqa: E501 - """WebhookMessage - a model defined in OpenAPI - - Args: - data (WebhookMessageData): - timestamp (datetime): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - self.timestamp = timestamp - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, timestamp, type, *args, **kwargs): # noqa: E501 - """WebhookMessage - a model defined in OpenAPI - - Args: - data (WebhookMessageData): - timestamp (datetime): - type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - self.timestamp = timestamp - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/webhook_message_data.py b/gooddata-api-client/gooddata_api_client/model/webhook_message_data.py deleted file mode 100644 index c6d5e21a0..000000000 --- a/gooddata-api-client/gooddata_api_client/model/webhook_message_data.py +++ /dev/null @@ -1,332 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.alert_description import AlertDescription - from gooddata_api_client.model.export_result import ExportResult - from gooddata_api_client.model.notification_filter import NotificationFilter - from gooddata_api_client.model.webhook_automation_info import WebhookAutomationInfo - from gooddata_api_client.model.webhook_recipient import WebhookRecipient - globals()['AlertDescription'] = AlertDescription - globals()['ExportResult'] = ExportResult - globals()['NotificationFilter'] = NotificationFilter - globals()['WebhookAutomationInfo'] = WebhookAutomationInfo - globals()['WebhookRecipient'] = WebhookRecipient - - -class WebhookMessageData(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'automation': (WebhookAutomationInfo,), # noqa: E501 - 'alert': (AlertDescription,), # noqa: E501 - 'dashboard_tabular_exports': ([ExportResult],), # noqa: E501 - 'details': ({str: (str,)},), # noqa: E501 - 'filters': ([NotificationFilter],), # noqa: E501 - 'image_exports': ([ExportResult],), # noqa: E501 - 'notification_source': (str,), # noqa: E501 - 'raw_exports': ([ExportResult],), # noqa: E501 - 'recipients': ([WebhookRecipient],), # noqa: E501 - 'remaining_action_count': (int,), # noqa: E501 - 'slides_exports': ([ExportResult],), # noqa: E501 - 'tabular_exports': ([ExportResult],), # noqa: E501 - 'visual_exports': ([ExportResult],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'automation': 'automation', # noqa: E501 - 'alert': 'alert', # noqa: E501 - 'dashboard_tabular_exports': 'dashboardTabularExports', # noqa: E501 - 'details': 'details', # noqa: E501 - 'filters': 'filters', # noqa: E501 - 'image_exports': 'imageExports', # noqa: E501 - 'notification_source': 'notificationSource', # noqa: E501 - 'raw_exports': 'rawExports', # noqa: E501 - 'recipients': 'recipients', # noqa: E501 - 'remaining_action_count': 'remainingActionCount', # noqa: E501 - 'slides_exports': 'slidesExports', # noqa: E501 - 'tabular_exports': 'tabularExports', # noqa: E501 - 'visual_exports': 'visualExports', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, automation, *args, **kwargs): # noqa: E501 - """WebhookMessageData - a model defined in OpenAPI - - Args: - automation (WebhookAutomationInfo): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - alert (AlertDescription): [optional] # noqa: E501 - dashboard_tabular_exports ([ExportResult]): [optional] # noqa: E501 - details ({str: (str,)}): [optional] # noqa: E501 - filters ([NotificationFilter]): [optional] # noqa: E501 - image_exports ([ExportResult]): [optional] # noqa: E501 - notification_source (str): [optional] # noqa: E501 - raw_exports ([ExportResult]): [optional] # noqa: E501 - recipients ([WebhookRecipient]): [optional] # noqa: E501 - remaining_action_count (int): [optional] # noqa: E501 - slides_exports ([ExportResult]): [optional] # noqa: E501 - tabular_exports ([ExportResult]): [optional] # noqa: E501 - visual_exports ([ExportResult]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.automation = automation - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, automation, *args, **kwargs): # noqa: E501 - """WebhookMessageData - a model defined in OpenAPI - - Args: - automation (WebhookAutomationInfo): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - alert (AlertDescription): [optional] # noqa: E501 - dashboard_tabular_exports ([ExportResult]): [optional] # noqa: E501 - details ({str: (str,)}): [optional] # noqa: E501 - filters ([NotificationFilter]): [optional] # noqa: E501 - image_exports ([ExportResult]): [optional] # noqa: E501 - notification_source (str): [optional] # noqa: E501 - raw_exports ([ExportResult]): [optional] # noqa: E501 - recipients ([WebhookRecipient]): [optional] # noqa: E501 - remaining_action_count (int): [optional] # noqa: E501 - slides_exports ([ExportResult]): [optional] # noqa: E501 - tabular_exports ([ExportResult]): [optional] # noqa: E501 - visual_exports ([ExportResult]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.automation = automation - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/webhook_recipient.py b/gooddata-api-client/gooddata_api_client/model/webhook_recipient.py deleted file mode 100644 index 56634f388..000000000 --- a/gooddata-api-client/gooddata_api_client/model/webhook_recipient.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class WebhookRecipient(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'email': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'email': 'email', # noqa: E501 - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, email, id, *args, **kwargs): # noqa: E501 - """WebhookRecipient - a model defined in OpenAPI - - Args: - email (str): - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.email = email - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, email, id, *args, **kwargs): # noqa: E501 - """WebhookRecipient - a model defined in OpenAPI - - Args: - email (str): - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.email = email - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/widget_slides_template.py b/gooddata-api-client/gooddata_api_client/model/widget_slides_template.py deleted file mode 100644 index b958de7aa..000000000 --- a/gooddata-api-client/gooddata_api_client/model/widget_slides_template.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.content_slide_template import ContentSlideTemplate - globals()['ContentSlideTemplate'] = ContentSlideTemplate - - -class WidgetSlidesTemplate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('applied_on',): { - 'PDF': "PDF", - 'PPTX': "PPTX", - }, - } - - validations = { - ('applied_on',): { - 'min_items': 1, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = True - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'applied_on': ([str],), # noqa: E501 - 'content_slide': (ContentSlideTemplate,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'applied_on': 'appliedOn', # noqa: E501 - 'content_slide': 'contentSlide', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 - """WidgetSlidesTemplate - a model defined in OpenAPI - - Args: - applied_on ([str]): Export types this template applies to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content_slide (ContentSlideTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.applied_on = applied_on - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, applied_on, *args, **kwargs): # noqa: E501 - """WidgetSlidesTemplate - a model defined in OpenAPI - - Args: - applied_on ([str]): Export types this template applies to. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - content_slide (ContentSlideTemplate): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.applied_on = applied_on - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_automation_identifier.py b/gooddata-api-client/gooddata_api_client/model/workspace_automation_identifier.py deleted file mode 100644 index 96efc9be5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workspace_automation_identifier.py +++ /dev/null @@ -1,270 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class WorkspaceAutomationIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """WorkspaceAutomationIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """WorkspaceAutomationIdentifier - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_automation_management_bulk_request.py b/gooddata-api-client/gooddata_api_client/model/workspace_automation_management_bulk_request.py deleted file mode 100644 index 9e3181892..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workspace_automation_management_bulk_request.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.workspace_automation_identifier import WorkspaceAutomationIdentifier - globals()['WorkspaceAutomationIdentifier'] = WorkspaceAutomationIdentifier - - -class WorkspaceAutomationManagementBulkRequest(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'automations': ([WorkspaceAutomationIdentifier],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'automations': 'automations', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, automations, *args, **kwargs): # noqa: E501 - """WorkspaceAutomationManagementBulkRequest - a model defined in OpenAPI - - Args: - automations ([WorkspaceAutomationIdentifier]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.automations = automations - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, automations, *args, **kwargs): # noqa: E501 - """WorkspaceAutomationManagementBulkRequest - a model defined in OpenAPI - - Args: - automations ([WorkspaceAutomationIdentifier]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.automations = automations - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_data_source.py b/gooddata-api-client/gooddata_api_client/model/workspace_data_source.py deleted file mode 100644 index 96cf65f9b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workspace_data_source.py +++ /dev/null @@ -1,274 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class WorkspaceDataSource(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'schema_path': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'schema_path': 'schemaPath', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """WorkspaceDataSource - a model defined in OpenAPI - - Args: - id (str): The ID of the used data source. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - schema_path ([str]): The full schema path as array of its path parts. Will be rendered as subPath1.subPath2.... [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """WorkspaceDataSource - a model defined in OpenAPI - - Args: - id (str): The ID of the used data source. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - schema_path ([str]): The full schema path as array of its path parts. Will be rendered as subPath1.subPath2.... [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_identifier.py b/gooddata-api-client/gooddata_api_client/model/workspace_identifier.py deleted file mode 100644 index bfd04d5e2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workspace_identifier.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class WorkspaceIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('type',): { - 'WORKSPACE': "workspace", - }, - } - - validations = { - ('id',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """WorkspaceIdentifier - a model defined in OpenAPI - - Args: - id (str): Identifier of the workspace. - - Keyword Args: - type (str): A type.. defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """WorkspaceIdentifier - a model defined in OpenAPI - - Args: - id (str): Identifier of the workspace. - - Keyword Args: - type (str): A type.. defaults to "workspace", must be one of ["workspace", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - type = kwargs.get('type', "workspace") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/workspace_permission_assignment.py deleted file mode 100644 index 6b463d1af..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workspace_permission_assignment.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier - globals()['AssigneeIdentifier'] = AssigneeIdentifier - - -class WorkspacePermissionAssignment(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('hierarchy_permissions',): { - 'MANAGE': "MANAGE", - 'ANALYZE': "ANALYZE", - 'EXPORT': "EXPORT", - 'EXPORT_TABULAR': "EXPORT_TABULAR", - 'EXPORT_PDF': "EXPORT_PDF", - 'CREATE_AUTOMATION': "CREATE_AUTOMATION", - 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", - 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", - 'VIEW': "VIEW", - }, - ('permissions',): { - 'MANAGE': "MANAGE", - 'ANALYZE': "ANALYZE", - 'EXPORT': "EXPORT", - 'EXPORT_TABULAR': "EXPORT_TABULAR", - 'EXPORT_PDF': "EXPORT_PDF", - 'CREATE_AUTOMATION': "CREATE_AUTOMATION", - 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", - 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", - 'VIEW': "VIEW", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 - 'hierarchy_permissions': ([str],), # noqa: E501 - 'permissions': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 - 'hierarchy_permissions': 'hierarchyPermissions', # noqa: E501 - 'permissions': 'permissions', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, assignee_identifier, *args, **kwargs): # noqa: E501 - """WorkspacePermissionAssignment - a model defined in OpenAPI - - Args: - assignee_identifier (AssigneeIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - hierarchy_permissions ([str]): [optional] # noqa: E501 - permissions ([str]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee_identifier = assignee_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, assignee_identifier, *args, **kwargs): # noqa: E501 - """WorkspacePermissionAssignment - a model defined in OpenAPI - - Args: - assignee_identifier (AssigneeIdentifier): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - hierarchy_permissions ([str]): [optional] # noqa: E501 - permissions ([str]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.assignee_identifier = assignee_identifier - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_user.py b/gooddata-api-client/gooddata_api_client/model/workspace_user.py deleted file mode 100644 index 5697a2ebd..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workspace_user.py +++ /dev/null @@ -1,278 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class WorkspaceUser(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'email': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'email': 'email', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """WorkspaceUser - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - email (str): User email address. [optional] # noqa: E501 - name (str): User name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """WorkspaceUser - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - email (str): User email address. [optional] # noqa: E501 - name (str): User name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_user_group.py b/gooddata-api-client/gooddata_api_client/model/workspace_user_group.py deleted file mode 100644 index 28e245936..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workspace_user_group.py +++ /dev/null @@ -1,274 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class WorkspaceUserGroup(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """WorkspaceUserGroup - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Group name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """WorkspaceUserGroup - a model defined in OpenAPI - - Args: - id (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Group name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_user_groups.py b/gooddata-api-client/gooddata_api_client/model/workspace_user_groups.py deleted file mode 100644 index 00923239b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workspace_user_groups.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.workspace_user_group import WorkspaceUserGroup - globals()['WorkspaceUserGroup'] = WorkspaceUserGroup - - -class WorkspaceUserGroups(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'total_count': (int,), # noqa: E501 - 'user_groups': ([WorkspaceUserGroup],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'total_count': 'totalCount', # noqa: E501 - 'user_groups': 'userGroups', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, total_count, user_groups, *args, **kwargs): # noqa: E501 - """WorkspaceUserGroups - a model defined in OpenAPI - - Args: - total_count (int): Total number of groups - user_groups ([WorkspaceUserGroup]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_count = total_count - self.user_groups = user_groups - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, total_count, user_groups, *args, **kwargs): # noqa: E501 - """WorkspaceUserGroups - a model defined in OpenAPI - - Args: - total_count (int): Total number of groups - user_groups ([WorkspaceUserGroup]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_count = total_count - self.user_groups = user_groups - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_users.py b/gooddata-api-client/gooddata_api_client/model/workspace_users.py deleted file mode 100644 index 265f01d5a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workspace_users.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.workspace_user import WorkspaceUser - globals()['WorkspaceUser'] = WorkspaceUser - - -class WorkspaceUsers(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'total_count': (int,), # noqa: E501 - 'users': ([WorkspaceUser],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'total_count': 'totalCount', # noqa: E501 - 'users': 'users', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, total_count, users, *args, **kwargs): # noqa: E501 - """WorkspaceUsers - a model defined in OpenAPI - - Args: - total_count (int): The total number of users is based on applied filters. - users ([WorkspaceUser]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_count = total_count - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, total_count, users, *args, **kwargs): # noqa: E501 - """WorkspaceUsers - a model defined in OpenAPI - - Args: - total_count (int): The total number of users is based on applied filters. - users ([WorkspaceUser]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.total_count = total_count - self.users = users - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/xliff.py b/gooddata-api-client/gooddata_api_client/model/xliff.py deleted file mode 100644 index ab6600299..000000000 --- a/gooddata-api-client/gooddata_api_client/model/xliff.py +++ /dev/null @@ -1,296 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.file import File - globals()['File'] = File - - -class Xliff(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'file': ([File],), # noqa: E501 - 'other_attributes': ({str: (str,)},), # noqa: E501 - 'space': (str,), # noqa: E501 - 'src_lang': (str,), # noqa: E501 - 'trg_lang': (str,), # noqa: E501 - 'version': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'file': 'file', # noqa: E501 - 'other_attributes': 'otherAttributes', # noqa: E501 - 'space': 'space', # noqa: E501 - 'src_lang': 'srcLang', # noqa: E501 - 'trg_lang': 'trgLang', # noqa: E501 - 'version': 'version', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, file, *args, **kwargs): # noqa: E501 - """Xliff - a model defined in OpenAPI - - Args: - file ([File]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - other_attributes ({str: (str,)}): [optional] # noqa: E501 - space (str): [optional] # noqa: E501 - src_lang (str): [optional] # noqa: E501 - trg_lang (str): [optional] # noqa: E501 - version (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.file = file - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, file, *args, **kwargs): # noqa: E501 - """Xliff - a model defined in OpenAPI - - Args: - file ([File]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - other_attributes ({str: (str,)}): [optional] # noqa: E501 - space (str): [optional] # noqa: E501 - src_lang (str): [optional] # noqa: E501 - trg_lang (str): [optional] # noqa: E501 - version (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.file = file - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model_utils.py b/gooddata-api-client/gooddata_api_client/model_utils.py deleted file mode 100644 index bc91bd70e..000000000 --- a/gooddata-api-client/gooddata_api_client/model_utils.py +++ /dev/null @@ -1,2067 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -from datetime import date, datetime # noqa: F401 -from copy import deepcopy -import inspect -import io -import os -import pprint -import re -import tempfile -import uuid - -from dateutil.parser import parse - -from gooddata_api_client.exceptions import ( - ApiKeyError, - ApiAttributeError, - ApiTypeError, - ApiValueError, -) - -from gooddata_api_client.configuration import ConversionConfiguration - -none_type = type(None) -file_type = io.IOBase - - -def convert_js_args_to_python_args(fn): - from functools import wraps - @wraps(fn) - def wrapped_init(_self_sanitized, *args, **kwargs): - """ - An attribute named `self` received from the api will conflicts with the reserved `self` - parameter of a class method. During generation, `self` attributes are mapped - to `_self_sanitized` in models. Here, we name `_self_sanitized` instead of `self` to avoid conflicts. - """ - spec_property_naming = kwargs.get('_spec_property_naming', False) - if spec_property_naming: - kwargs = change_keys_js_to_python(kwargs, _self_sanitized if isinstance(_self_sanitized, type) else _self_sanitized.__class__) - return fn(_self_sanitized, *args, **kwargs) - return wrapped_init - - -class cached_property(object): - # this caches the result of the function call for fn with no inputs - # use this as a decorator on function methods that you want converted - # into cached properties - result_key = '_results' - - def __init__(self, fn): - self._fn = fn - - def __get__(self, instance, cls=None): - if self.result_key in vars(self): - return vars(self)[self.result_key] - else: - result = self._fn() - setattr(self, self.result_key, result) - return result - - -PRIMITIVE_TYPES = (list, float, int, bool, datetime, date, str, file_type) - -def allows_single_value_input(cls): - """ - This function returns True if the input composed schema model or any - descendant model allows a value only input - This is true for cases where oneOf contains items like: - oneOf: - - float - - NumberWithValidation - - StringEnum - - ArrayModel - - null - TODO: lru_cache this - """ - if ( - issubclass(cls, ModelSimple) or - cls in PRIMITIVE_TYPES - ): - return True - elif issubclass(cls, ModelComposed): - if not cls._composed_schemas['oneOf']: - return False - return any(allows_single_value_input(c) for c in cls._composed_schemas['oneOf']) - return False - -def composed_model_input_classes(cls): - """ - This function returns a list of the possible models that can be accepted as - inputs. - TODO: lru_cache this - """ - if issubclass(cls, ModelSimple) or cls in PRIMITIVE_TYPES: - return [cls] - elif issubclass(cls, ModelNormal): - if cls.discriminator is None: - return [cls] - else: - return get_discriminated_classes(cls) - elif issubclass(cls, ModelComposed): - if not cls._composed_schemas['oneOf']: - return [] - if cls.discriminator is None: - input_classes = [] - for c in cls._composed_schemas['oneOf']: - input_classes.extend(composed_model_input_classes(c)) - return input_classes - else: - return get_discriminated_classes(cls) - return [] - - -class OpenApiModel(object): - """The base class for all OpenAPIModels""" - - def set_attribute(self, name, value): - # this is only used to set properties on self - - path_to_item = [] - if self._path_to_item: - path_to_item.extend(self._path_to_item) - path_to_item.append(name) - - if name in self.openapi_types: - required_types_mixed = self.openapi_types[name] - elif self.additional_properties_type is None: - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - path_to_item - ) - elif self.additional_properties_type is not None: - required_types_mixed = self.additional_properties_type - - if get_simple_class(name) != str: - error_msg = type_error_message( - var_name=name, - var_value=name, - valid_classes=(str,), - key_type=True - ) - raise ApiTypeError( - error_msg, - path_to_item=path_to_item, - valid_classes=(str,), - key_type=True - ) - - if self._check_type: - value = validate_and_convert_types( - value, required_types_mixed, path_to_item, self._spec_property_naming, - self._check_type, configuration=self._configuration) - if (name,) in self.allowed_values: - check_allowed_values( - self.allowed_values, - (name,), - value - ) - if (name,) in self.validations: - check_validations( - self.validations, - (name,), - value, - self._configuration - ) - self.__dict__['_data_store'][name] = value - - def __repr__(self): - """For `print` and `pprint`""" - return self.to_str() - - def __ne__(self, other): - """Returns true if both objects are not equal""" - return not self == other - - def __setattr__(self, attr, value): - """set the value of an attribute using dot notation: `instance.attr = val`""" - self[attr] = value - - def __getattr__(self, attr): - """get the value of an attribute using dot notation: `instance.attr`""" - return self.__getitem__(attr) - - def __copy__(self): - cls = self.__class__ - if self.get("_spec_property_naming", False): - return cls._new_from_openapi_data(**self.__dict__) - else: - return cls.__new__(cls, **self.__dict__) - - def __deepcopy__(self, memo): - cls = self.__class__ - - if self.get("_spec_property_naming", False): - new_inst = cls._new_from_openapi_data() - else: - new_inst = cls.__new__(cls) - - for k, v in self.__dict__.items(): - setattr(new_inst, k, deepcopy(v, memo)) - return new_inst - - - def __new__(cls, *args, **kwargs): - # this function uses the discriminator to - # pick a new schema/class to instantiate because a discriminator - # propertyName value was passed in - - if len(args) == 1: - arg = args[0] - if arg is None and is_type_nullable(cls): - # The input data is the 'null' value and the type is nullable. - return None - - if issubclass(cls, ModelComposed) and allows_single_value_input(cls): - model_kwargs = {} - oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) - return oneof_instance - - - visited_composed_classes = kwargs.get('_visited_composed_classes', ()) - if ( - cls.discriminator is None or - cls in visited_composed_classes - ): - # Use case 1: this openapi schema (cls) does not have a discriminator - # Use case 2: we have already visited this class before and are sure that we - # want to instantiate it this time. We have visited this class deserializing - # a payload with a discriminator. During that process we traveled through - # this class but did not make an instance of it. Now we are making an - # instance of a composed class which contains cls in it, so this time make an instance of cls. - # - # Here's an example of use case 2: If Animal has a discriminator - # petType and we pass in "Dog", and the class Dog - # allOf includes Animal, we move through Animal - # once using the discriminator, and pick Dog. - # Then in the composed schema dog Dog, we will make an instance of the - # Animal class (because Dal has allOf: Animal) but this time we won't travel - # through Animal's discriminator because we passed in - # _visited_composed_classes = (Animal,) - - return super(OpenApiModel, cls).__new__(cls) - - # Get the name and value of the discriminator property. - # The discriminator name is obtained from the discriminator meta-data - # and the discriminator value is obtained from the input data. - discr_propertyname_py = list(cls.discriminator.keys())[0] - discr_propertyname_js = cls.attribute_map[discr_propertyname_py] - if discr_propertyname_js in kwargs: - discr_value = kwargs[discr_propertyname_js] - elif discr_propertyname_py in kwargs: - discr_value = kwargs[discr_propertyname_py] - else: - # The input data does not contain the discriminator property. - path_to_item = kwargs.get('_path_to_item', ()) - raise ApiValueError( - "Cannot deserialize input data due to missing discriminator. " - "The discriminator property '%s' is missing at path: %s" % - (discr_propertyname_js, path_to_item) - ) - - # Implementation note: the last argument to get_discriminator_class - # is a list of visited classes. get_discriminator_class may recursively - # call itself and update the list of visited classes, and the initial - # value must be an empty list. Hence not using 'visited_composed_classes' - new_cls = get_discriminator_class( - cls, discr_propertyname_py, discr_value, []) - if new_cls is None: - path_to_item = kwargs.get('_path_to_item', ()) - disc_prop_value = kwargs.get( - discr_propertyname_js, kwargs.get(discr_propertyname_py)) - raise ApiValueError( - "Cannot deserialize input data due to invalid discriminator " - "value. The OpenAPI document has no mapping for discriminator " - "property '%s'='%s' at path: %s" % - (discr_propertyname_js, disc_prop_value, path_to_item) - ) - - if new_cls in visited_composed_classes: - # if we are making an instance of a composed schema Descendent - # which allOf includes Ancestor, then Ancestor contains - # a discriminator that includes Descendent. - # So if we make an instance of Descendent, we have to make an - # instance of Ancestor to hold the allOf properties. - # This code detects that use case and makes the instance of Ancestor - # For example: - # When making an instance of Dog, _visited_composed_classes = (Dog,) - # then we make an instance of Animal to include in dog._composed_instances - # so when we are here, cls is Animal - # cls.discriminator != None - # cls not in _visited_composed_classes - # new_cls = Dog - # but we know we know that we already have Dog - # because it is in visited_composed_classes - # so make Animal here - return super(OpenApiModel, cls).__new__(cls) - - # Build a list containing all oneOf and anyOf descendants. - oneof_anyof_classes = None - if cls._composed_schemas is not None: - oneof_anyof_classes = ( - cls._composed_schemas.get('oneOf', ()) + - cls._composed_schemas.get('anyOf', ())) - oneof_anyof_child = new_cls in oneof_anyof_classes - kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) - - if cls._composed_schemas.get('allOf') and oneof_anyof_child: - # Validate that we can make self because when we make the - # new_cls it will not include the allOf validations in self - self_inst = super(OpenApiModel, cls).__new__(cls) - self_inst.__init__(*args, **kwargs) - - if kwargs.get("_spec_property_naming", False): - # when true, implies new is from deserialization - new_inst = new_cls._new_from_openapi_data(*args, **kwargs) - else: - new_inst = new_cls.__new__(new_cls, *args, **kwargs) - new_inst.__init__(*args, **kwargs) - - return new_inst - - - @classmethod - @convert_js_args_to_python_args - def _new_from_openapi_data(cls, *args, **kwargs): - # this function uses the discriminator to - # pick a new schema/class to instantiate because a discriminator - # propertyName value was passed in - - if len(args) == 1: - arg = args[0] - if arg is None and is_type_nullable(cls): - # The input data is the 'null' value and the type is nullable. - return None - - if issubclass(cls, ModelComposed) and allows_single_value_input(cls): - model_kwargs = {} - oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) - return oneof_instance - - - visited_composed_classes = kwargs.get('_visited_composed_classes', ()) - if ( - cls.discriminator is None or - cls in visited_composed_classes - ): - # Use case 1: this openapi schema (cls) does not have a discriminator - # Use case 2: we have already visited this class before and are sure that we - # want to instantiate it this time. We have visited this class deserializing - # a payload with a discriminator. During that process we traveled through - # this class but did not make an instance of it. Now we are making an - # instance of a composed class which contains cls in it, so this time make an instance of cls. - # - # Here's an example of use case 2: If Animal has a discriminator - # petType and we pass in "Dog", and the class Dog - # allOf includes Animal, we move through Animal - # once using the discriminator, and pick Dog. - # Then in the composed schema dog Dog, we will make an instance of the - # Animal class (because Dal has allOf: Animal) but this time we won't travel - # through Animal's discriminator because we passed in - # _visited_composed_classes = (Animal,) - - return cls._from_openapi_data(*args, **kwargs) - - # Get the name and value of the discriminator property. - # The discriminator name is obtained from the discriminator meta-data - # and the discriminator value is obtained from the input data. - discr_propertyname_py = list(cls.discriminator.keys())[0] - discr_propertyname_js = cls.attribute_map[discr_propertyname_py] - if discr_propertyname_js in kwargs: - discr_value = kwargs[discr_propertyname_js] - elif discr_propertyname_py in kwargs: - discr_value = kwargs[discr_propertyname_py] - else: - # The input data does not contain the discriminator property. - path_to_item = kwargs.get('_path_to_item', ()) - raise ApiValueError( - "Cannot deserialize input data due to missing discriminator. " - "The discriminator property '%s' is missing at path: %s" % - (discr_propertyname_js, path_to_item) - ) - - # Implementation note: the last argument to get_discriminator_class - # is a list of visited classes. get_discriminator_class may recursively - # call itself and update the list of visited classes, and the initial - # value must be an empty list. Hence not using 'visited_composed_classes' - new_cls = get_discriminator_class( - cls, discr_propertyname_py, discr_value, []) - if new_cls is None: - path_to_item = kwargs.get('_path_to_item', ()) - disc_prop_value = kwargs.get( - discr_propertyname_js, kwargs.get(discr_propertyname_py)) - raise ApiValueError( - "Cannot deserialize input data due to invalid discriminator " - "value. The OpenAPI document has no mapping for discriminator " - "property '%s'='%s' at path: %s" % - (discr_propertyname_js, disc_prop_value, path_to_item) - ) - - if new_cls in visited_composed_classes: - # if we are making an instance of a composed schema Descendent - # which allOf includes Ancestor, then Ancestor contains - # a discriminator that includes Descendent. - # So if we make an instance of Descendent, we have to make an - # instance of Ancestor to hold the allOf properties. - # This code detects that use case and makes the instance of Ancestor - # For example: - # When making an instance of Dog, _visited_composed_classes = (Dog,) - # then we make an instance of Animal to include in dog._composed_instances - # so when we are here, cls is Animal - # cls.discriminator != None - # cls not in _visited_composed_classes - # new_cls = Dog - # but we know we know that we already have Dog - # because it is in visited_composed_classes - # so make Animal here - return cls._from_openapi_data(*args, **kwargs) - - # Build a list containing all oneOf and anyOf descendants. - oneof_anyof_classes = None - if cls._composed_schemas is not None: - oneof_anyof_classes = ( - cls._composed_schemas.get('oneOf', ()) + - cls._composed_schemas.get('anyOf', ())) - oneof_anyof_child = new_cls in oneof_anyof_classes - kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) - - if cls._composed_schemas.get('allOf') and oneof_anyof_child: - # Validate that we can make self because when we make the - # new_cls it will not include the allOf validations in self - self_inst = cls._from_openapi_data(*args, **kwargs) - - - new_inst = new_cls._new_from_openapi_data(*args, **kwargs) - return new_inst - - -class ModelSimple(OpenApiModel): - """the parent class of models whose type != object in their - swagger/openapi""" - - def __setitem__(self, name, value): - """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" - if name in self.required_properties: - self.__dict__[name] = value - return - - self.set_attribute(name, value) - - def get(self, name, default=None): - """returns the value of an attribute or some default value if the attribute was not set""" - if name in self.required_properties: - return self.__dict__[name] - - return self.__dict__['_data_store'].get(name, default) - - def __getitem__(self, name): - """get the value of an attribute using square-bracket notation: `instance[attr]`""" - if name in self: - return self.get(name) - - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - - def __contains__(self, name): - """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" - if name in self.required_properties: - return name in self.__dict__ - - return name in self.__dict__['_data_store'] - - def to_str(self): - """Returns the string representation of the model""" - return str(self.value) - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, self.__class__): - return False - - this_val = self._data_store['value'] - that_val = other._data_store['value'] - types = set() - types.add(this_val.__class__) - types.add(that_val.__class__) - vals_equal = this_val == that_val - return vals_equal - - -class ModelNormal(OpenApiModel): - """the parent class of models whose type == object in their - swagger/openapi""" - - def __setitem__(self, name, value): - """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" - if name in self.required_properties: - self.__dict__[name] = value - return - - self.set_attribute(name, value) - - def get(self, name, default=None): - """returns the value of an attribute or some default value if the attribute was not set""" - if name in self.required_properties: - return self.__dict__[name] - - return self.__dict__['_data_store'].get(name, default) - - def __getitem__(self, name): - """get the value of an attribute using square-bracket notation: `instance[attr]`""" - if name in self: - return self.get(name) - - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - - def __contains__(self, name): - """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" - if name in self.required_properties: - return name in self.__dict__ - - return name in self.__dict__['_data_store'] - - def to_dict(self, camel_case=False): - """Returns the model properties as a dict""" - return model_to_dict(self, serialize=camel_case) - - @classmethod - def from_dict(cls, dictionary, camel_case=True): - dictionary_cpy = deepcopy(dictionary) - return validate_and_convert_types(dictionary_cpy, (cls,), ['received_data'], camel_case, True, ConversionConfiguration.get_configuration()) - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, self.__class__): - return False - - if not set(self._data_store.keys()) == set(other._data_store.keys()): - return False - for _var_name, this_val in self._data_store.items(): - that_val = other._data_store[_var_name] - types = set() - types.add(this_val.__class__) - types.add(that_val.__class__) - vals_equal = this_val == that_val - if not vals_equal: - return False - return True - - - -class ModelComposed(OpenApiModel): - """the parent class of models whose type == object in their - swagger/openapi and have oneOf/allOf/anyOf - - When one sets a property we use var_name_to_model_instances to store the value in - the correct class instances + run any type checking + validation code. - When one gets a property we use var_name_to_model_instances to get the value - from the correct class instances. - This allows multiple composed schemas to contain the same property with additive - constraints on the value. - - _composed_schemas (dict) stores the anyOf/allOf/oneOf classes - key (str): allOf/oneOf/anyOf - value (list): the classes in the XOf definition. - Note: none_type can be included when the openapi document version >= 3.1.0 - _composed_instances (list): stores a list of instances of the composed schemas - defined in _composed_schemas. When properties are accessed in the self instance, - they are returned from the self._data_store or the data stores in the instances - in self._composed_schemas - _var_name_to_model_instances (dict): maps between a variable name on self and - the composed instances (self included) which contain that data - key (str): property name - value (list): list of class instances, self or instances in _composed_instances - which contain the value that the key is referring to. - """ - - def __setitem__(self, name, value): - """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" - if name in self.required_properties: - self.__dict__[name] = value - return - - """ - Use cases: - 1. additional_properties_type is None (additionalProperties == False in spec) - Check for property presence in self.openapi_types - if not present then throw an error - if present set in self, set attribute - always set on composed schemas - 2. additional_properties_type exists - set attribute on self - always set on composed schemas - """ - if self.additional_properties_type is None: - """ - For an attribute to exist on a composed schema it must: - - fulfill schema_requirements in the self composed schema not considering oneOf/anyOf/allOf schemas AND - - fulfill schema_requirements in each oneOf/anyOf/allOf schemas - - schema_requirements: - For an attribute to exist on a schema it must: - - be present in properties at the schema OR - - have additionalProperties unset (defaults additionalProperties = any type) OR - - have additionalProperties set - """ - if name not in self.openapi_types: - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - # attribute must be set on self and composed instances - self.set_attribute(name, value) - for model_instance in self._composed_instances: - setattr(model_instance, name, value) - if name not in self._var_name_to_model_instances: - # we assigned an additional property - self.__dict__['_var_name_to_model_instances'][name] = self._composed_instances + [self] - return None - - __unset_attribute_value__ = object() - - def get(self, name, default=None): - """returns the value of an attribute or some default value if the attribute was not set""" - if name in self.required_properties: - return self.__dict__[name] - - # get the attribute from the correct instance - model_instances = self._var_name_to_model_instances.get(name) - values = [] - # A composed model stores self and child (oneof/anyOf/allOf) models under - # self._var_name_to_model_instances. - # Any property must exist in self and all model instances - # The value stored in all model instances must be the same - if model_instances: - for model_instance in model_instances: - if name in model_instance._data_store: - v = model_instance._data_store[name] - if v not in values: - values.append(v) - len_values = len(values) - if len_values == 0: - return default - elif len_values == 1: - return values[0] - elif len_values > 1: - raise ApiValueError( - "Values stored for property {0} in {1} differ when looking " - "at self and self's composed instances. All values must be " - "the same".format(name, type(self).__name__), - [e for e in [self._path_to_item, name] if e] - ) - - def __getitem__(self, name): - """get the value of an attribute using square-bracket notation: `instance[attr]`""" - value = self.get(name, self.__unset_attribute_value__) - if value is self.__unset_attribute_value__: - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - return value - - def __contains__(self, name): - """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" - - if name in self.required_properties: - return name in self.__dict__ - - model_instances = self._var_name_to_model_instances.get( - name, self._additional_properties_model_instances) - - if model_instances: - for model_instance in model_instances: - if name in model_instance._data_store: - return True - - return False - - def to_dict(self, camel_case=False): - """Returns the model properties as a dict""" - return model_to_dict(self, serialize=camel_case) - - @classmethod - def from_dict(cls, dictionary, camel_case=True): - dictionary_cpy = deepcopy(dictionary) - return validate_and_convert_types(dictionary_cpy, (cls,), ['received_data'], camel_case, True, ConversionConfiguration.get_configuration()) - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, self.__class__): - return False - - if not set(self._data_store.keys()) == set(other._data_store.keys()): - return False - for _var_name, this_val in self._data_store.items(): - that_val = other._data_store[_var_name] - types = set() - types.add(this_val.__class__) - types.add(that_val.__class__) - vals_equal = this_val == that_val - if not vals_equal: - return False - return True - - - -COERCION_INDEX_BY_TYPE = { - ModelComposed: 0, - ModelNormal: 1, - ModelSimple: 2, - none_type: 3, # The type of 'None'. - list: 4, - dict: 5, - float: 6, - int: 7, - bool: 8, - datetime: 9, - date: 10, - str: 11, - file_type: 12, # 'file_type' is an alias for the built-in 'file' or 'io.IOBase' type. -} - -# these are used to limit what type conversions we try to do -# when we have a valid type already and we want to try converting -# to another type -UPCONVERSION_TYPE_PAIRS = ( - (str, datetime), - (str, date), - (int, float), # A float may be serialized as an integer, e.g. '3' is a valid serialized float. - (list, ModelComposed), - (dict, ModelComposed), - (str, ModelComposed), - (int, ModelComposed), - (float, ModelComposed), - (list, ModelComposed), - (list, ModelNormal), - (dict, ModelNormal), - (str, ModelSimple), - (int, ModelSimple), - (float, ModelSimple), - (list, ModelSimple), -) - -COERCIBLE_TYPE_PAIRS = { - False: ( # client instantiation of a model with client data - # (dict, ModelComposed), - # (list, ModelComposed), - # (dict, ModelNormal), - # (list, ModelNormal), - # (str, ModelSimple), - # (int, ModelSimple), - # (float, ModelSimple), - # (list, ModelSimple), - # (str, int), - # (str, float), - # (str, datetime), - # (str, date), - # (int, str), - # (float, str), - ), - True: ( # server -> client data - (dict, ModelComposed), - (list, ModelComposed), - (dict, ModelNormal), - (list, ModelNormal), - (str, ModelSimple), - (int, ModelSimple), - (float, ModelSimple), - (list, ModelSimple), - # (str, int), - # (str, float), - (str, datetime), - (str, date), - # (int, str), - # (float, str), - (str, file_type) - ), -} - - -def get_simple_class(input_value): - """Returns an input_value's simple class that we will use for type checking - Python2: - float and int will return int, where int is the python3 int backport - str and unicode will return str, where str is the python3 str backport - Note: float and int ARE both instances of int backport - Note: str_py2 and unicode_py2 are NOT both instances of str backport - - Args: - input_value (class/class_instance): the item for which we will return - the simple class - """ - if isinstance(input_value, type): - # input_value is a class - return input_value - elif isinstance(input_value, tuple): - return tuple - elif isinstance(input_value, list): - return list - elif isinstance(input_value, dict): - return dict - elif isinstance(input_value, none_type): - return none_type - elif isinstance(input_value, file_type): - return file_type - elif isinstance(input_value, bool): - # this must be higher than the int check because - # isinstance(True, int) == True - return bool - elif isinstance(input_value, int): - return int - elif isinstance(input_value, datetime): - # this must be higher than the date check because - # isinstance(datetime_instance, date) == True - return datetime - elif isinstance(input_value, date): - return date - elif isinstance(input_value, str): - return str - return type(input_value) - - -def check_allowed_values(allowed_values, input_variable_path, input_values): - """Raises an exception if the input_values are not allowed - - Args: - allowed_values (dict): the allowed_values dict - input_variable_path (tuple): the path to the input variable - input_values (list/str/int/float/date/datetime): the values that we - are checking to see if they are in allowed_values - """ - these_allowed_values = list(allowed_values[input_variable_path].values()) - if (isinstance(input_values, list) - and not set(input_values).issubset( - set(these_allowed_values))): - invalid_values = ", ".join( - map(str, set(input_values) - set(these_allowed_values))), - raise ApiValueError( - "Invalid values for `%s` [%s], must be a subset of [%s]" % - ( - input_variable_path[0], - invalid_values, - ", ".join(map(str, these_allowed_values)) - ) - ) - elif (isinstance(input_values, dict) - and not set( - input_values.keys()).issubset(set(these_allowed_values))): - invalid_values = ", ".join( - map(str, set(input_values.keys()) - set(these_allowed_values))) - raise ApiValueError( - "Invalid keys in `%s` [%s], must be a subset of [%s]" % - ( - input_variable_path[0], - invalid_values, - ", ".join(map(str, these_allowed_values)) - ) - ) - elif (not isinstance(input_values, (list, dict)) - and input_values not in these_allowed_values): - raise ApiValueError( - "Invalid value for `%s` (%s), must be one of %s" % - ( - input_variable_path[0], - input_values, - these_allowed_values - ) - ) - - -def is_json_validation_enabled(schema_keyword, configuration=None): - """Returns true if JSON schema validation is enabled for the specified - validation keyword. This can be used to skip JSON schema structural validation - as requested in the configuration. - - Args: - schema_keyword (string): the name of a JSON schema validation keyword. - configuration (Configuration): the configuration class. - """ - - return (configuration is None or - not hasattr(configuration, '_disabled_client_side_validations') or - schema_keyword not in configuration._disabled_client_side_validations) - - -def check_validations( - validations, input_variable_path, input_values, - configuration=None): - """Raises an exception if the input_values are invalid - - Args: - validations (dict): the validation dictionary. - input_variable_path (tuple): the path to the input variable. - input_values (list/str/int/float/date/datetime): the values that we - are checking. - configuration (Configuration): the configuration class. - """ - - if input_values is None: - return - - current_validations = validations[input_variable_path] - if (is_json_validation_enabled('multipleOf', configuration) and - 'multiple_of' in current_validations and - isinstance(input_values, (int, float)) and - not (float(input_values) / current_validations['multiple_of']).is_integer()): - # Note 'multipleOf' will be as good as the floating point arithmetic. - raise ApiValueError( - "Invalid value for `%s`, value must be a multiple of " - "`%s`" % ( - input_variable_path[0], - current_validations['multiple_of'] - ) - ) - - if (is_json_validation_enabled('maxLength', configuration) and - 'max_length' in current_validations and - len(input_values) > current_validations['max_length']): - raise ApiValueError( - "Invalid value for `%s`, length must be less than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['max_length'] - ) - ) - - if (is_json_validation_enabled('minLength', configuration) and - 'min_length' in current_validations and - len(input_values) < current_validations['min_length']): - raise ApiValueError( - "Invalid value for `%s`, length must be greater than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['min_length'] - ) - ) - - if (is_json_validation_enabled('maxItems', configuration) and - 'max_items' in current_validations and - len(input_values) > current_validations['max_items']): - raise ApiValueError( - "Invalid value for `%s`, number of items must be less than or " - "equal to `%s`" % ( - input_variable_path[0], - current_validations['max_items'] - ) - ) - - if (is_json_validation_enabled('minItems', configuration) and - 'min_items' in current_validations and - len(input_values) < current_validations['min_items']): - raise ValueError( - "Invalid value for `%s`, number of items must be greater than or " - "equal to `%s`" % ( - input_variable_path[0], - current_validations['min_items'] - ) - ) - - items = ('exclusive_maximum', 'inclusive_maximum', 'exclusive_minimum', - 'inclusive_minimum') - if (any(item in current_validations for item in items)): - if isinstance(input_values, list): - max_val = max(input_values) - min_val = min(input_values) - elif isinstance(input_values, dict): - max_val = max(input_values.values()) - min_val = min(input_values.values()) - else: - max_val = input_values - min_val = input_values - - if (is_json_validation_enabled('exclusiveMaximum', configuration) and - 'exclusive_maximum' in current_validations and - max_val >= current_validations['exclusive_maximum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value less than `%s`" % ( - input_variable_path[0], - current_validations['exclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('maximum', configuration) and - 'inclusive_maximum' in current_validations and - max_val > current_validations['inclusive_maximum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value less than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['inclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('exclusiveMinimum', configuration) and - 'exclusive_minimum' in current_validations and - min_val <= current_validations['exclusive_minimum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value greater than `%s`" % - ( - input_variable_path[0], - current_validations['exclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('minimum', configuration) and - 'inclusive_minimum' in current_validations and - min_val < current_validations['inclusive_minimum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value greater than or equal " - "to `%s`" % ( - input_variable_path[0], - current_validations['inclusive_minimum'] - ) - ) - flags = current_validations.get('regex', {}).get('flags', 0) - if (is_json_validation_enabled('pattern', configuration) and - 'regex' in current_validations and - not re.search(current_validations['regex']['pattern'], - input_values, flags=flags)): - err_msg = r"Invalid value for `%s`, must match regular expression `%s`" % ( - input_variable_path[0], - current_validations['regex']['pattern'] - ) - if flags != 0: - # Don't print the regex flags if the flags are not - # specified in the OAS document. - err_msg = r"%s with flags=`%s`" % (err_msg, flags) - raise ApiValueError(err_msg) - - -def order_response_types(required_types): - """Returns the required types sorted in coercion order - - Args: - required_types (list/tuple): collection of classes or instance of - list or dict with class information inside it. - - Returns: - (list): coercion order sorted collection of classes or instance - of list or dict with class information inside it. - """ - - def index_getter(class_or_instance): - if isinstance(class_or_instance, list): - return COERCION_INDEX_BY_TYPE[list] - elif isinstance(class_or_instance, dict): - return COERCION_INDEX_BY_TYPE[dict] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelComposed)): - return COERCION_INDEX_BY_TYPE[ModelComposed] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelNormal)): - return COERCION_INDEX_BY_TYPE[ModelNormal] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelSimple)): - return COERCION_INDEX_BY_TYPE[ModelSimple] - elif class_or_instance in COERCION_INDEX_BY_TYPE: - return COERCION_INDEX_BY_TYPE[class_or_instance] - raise ApiValueError("Unsupported type: %s" % class_or_instance) - - sorted_types = sorted( - required_types, - key=lambda class_or_instance: index_getter(class_or_instance) - ) - return sorted_types - - -def remove_uncoercible(required_types_classes, current_item, spec_property_naming, - must_convert=True): - """Only keeps the type conversions that are possible - - Args: - required_types_classes (tuple): tuple of classes that are required - these should be ordered by COERCION_INDEX_BY_TYPE - spec_property_naming (bool): True if the variable names in the input - data are serialized names as specified in the OpenAPI document. - False if the variables names in the input data are python - variable names in PEP-8 snake case. - current_item (any): the current item (input data) to be converted - - Keyword Args: - must_convert (bool): if True the item to convert is of the wrong - type and we want a big list of coercibles - if False, we want a limited list of coercibles - - Returns: - (list): the remaining coercible required types, classes only - """ - current_type_simple = get_simple_class(current_item) - - results_classes = [] - for required_type_class in required_types_classes: - # convert our models to OpenApiModel - required_type_class_simplified = required_type_class - if isinstance(required_type_class_simplified, type): - if issubclass(required_type_class_simplified, ModelComposed): - required_type_class_simplified = ModelComposed - elif issubclass(required_type_class_simplified, ModelNormal): - required_type_class_simplified = ModelNormal - elif issubclass(required_type_class_simplified, ModelSimple): - required_type_class_simplified = ModelSimple - - if required_type_class_simplified == current_type_simple: - # don't consider converting to one's own class - continue - - class_pair = (current_type_simple, required_type_class_simplified) - if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[spec_property_naming]: - results_classes.append(required_type_class) - elif class_pair in UPCONVERSION_TYPE_PAIRS: - results_classes.append(required_type_class) - return results_classes - -def get_discriminated_classes(cls): - """ - Returns all the classes that a discriminator converts to - TODO: lru_cache this - """ - possible_classes = [] - key = list(cls.discriminator.keys())[0] - if is_type_nullable(cls): - possible_classes.append(cls) - for discr_cls in cls.discriminator[key].values(): - if hasattr(discr_cls, 'discriminator') and discr_cls.discriminator is not None: - possible_classes.extend(get_discriminated_classes(discr_cls)) - else: - possible_classes.append(discr_cls) - return possible_classes - - -def get_possible_classes(cls, from_server_context): - # TODO: lru_cache this - possible_classes = [cls] - if from_server_context: - return possible_classes - if hasattr(cls, 'discriminator') and cls.discriminator is not None: - possible_classes = [] - possible_classes.extend(get_discriminated_classes(cls)) - elif issubclass(cls, ModelComposed): - possible_classes.extend(composed_model_input_classes(cls)) - return possible_classes - - -def get_required_type_classes(required_types_mixed, spec_property_naming): - """Converts the tuple required_types into a tuple and a dict described - below - - Args: - required_types_mixed (tuple/list): will contain either classes or - instance of list or dict - spec_property_naming (bool): if True these values came from the - server, and we use the data types in our endpoints. - If False, we are client side and we need to include - oneOf and discriminator classes inside the data types in our endpoints - - Returns: - (valid_classes, dict_valid_class_to_child_types_mixed): - valid_classes (tuple): the valid classes that the current item - should be - dict_valid_class_to_child_types_mixed (dict): - valid_class (class): this is the key - child_types_mixed (list/dict/tuple): describes the valid child - types - """ - valid_classes = [] - child_req_types_by_current_type = {} - for required_type in required_types_mixed: - if isinstance(required_type, list): - valid_classes.append(list) - child_req_types_by_current_type[list] = required_type - elif isinstance(required_type, tuple): - valid_classes.append(tuple) - child_req_types_by_current_type[tuple] = required_type - elif isinstance(required_type, dict): - valid_classes.append(dict) - child_req_types_by_current_type[dict] = required_type[str] - else: - valid_classes.extend(get_possible_classes(required_type, spec_property_naming)) - return tuple(valid_classes), child_req_types_by_current_type - - -def change_keys_js_to_python(input_dict, model_class): - """ - Converts from javascript_key keys in the input_dict to python_keys in - the output dict using the mapping in model_class. - If the input_dict contains a key which does not declared in the model_class, - the key is added to the output dict as is. The assumption is the model_class - may have undeclared properties (additionalProperties attribute in the OAS - document). - """ - - if getattr(model_class, 'attribute_map', None) is None: - return input_dict - output_dict = {} - reversed_attr_map = {value: key for key, value in - model_class.attribute_map.items()} - for javascript_key, value in input_dict.items(): - python_key = reversed_attr_map.get(javascript_key) - if python_key is None: - # if the key is unknown, it is in error or it is an - # additionalProperties variable - python_key = javascript_key - output_dict[python_key] = value - return output_dict - - -def get_type_error(var_value, path_to_item, valid_classes, key_type=False): - error_msg = type_error_message( - var_name=path_to_item[-1], - var_value=var_value, - valid_classes=valid_classes, - key_type=key_type - ) - return ApiTypeError( - error_msg, - path_to_item=path_to_item, - valid_classes=valid_classes, - key_type=key_type - ) - - -def deserialize_primitive(data, klass, path_to_item): - """Deserializes string to primitive type. - - :param data: str/int/float - :param klass: str/class the class to convert to - - :return: int, float, str, bool, date, datetime - """ - additional_message = "" - try: - if klass in {datetime, date}: - additional_message = ( - "If you need your parameter to have a fallback " - "string value, please set its type as `type: {}` in your " - "spec. That allows the value to be any type. " - ) - if klass == datetime: - if len(data) < 8: - raise ValueError("This is not a datetime") - # The string should be in iso8601 datetime format. - parsed_datetime = parse(data) - date_only = ( - parsed_datetime.hour == 0 and - parsed_datetime.minute == 0 and - parsed_datetime.second == 0 and - parsed_datetime.tzinfo is None and - 8 <= len(data) <= 10 - ) - if date_only: - raise ValueError("This is a date, not a datetime") - return parsed_datetime - elif klass == date: - if len(data) < 8: - raise ValueError("This is not a date") - return parse(data).date() - else: - converted_value = klass(data) - if isinstance(data, str) and klass == float: - if str(converted_value) != data: - # '7' -> 7.0 -> '7.0' != '7' - raise ValueError('This is not a float') - return converted_value - except (OverflowError, ValueError) as ex: - # parse can raise OverflowError - raise ApiValueError( - "{0}Failed to parse {1} as {2}".format( - additional_message, repr(data), klass.__name__ - ), - path_to_item=path_to_item - ) from ex - - -def get_discriminator_class(model_class, - discr_name, - discr_value, cls_visited): - """Returns the child class specified by the discriminator. - - Args: - model_class (OpenApiModel): the model class. - discr_name (string): the name of the discriminator property. - discr_value (any): the discriminator value. - cls_visited (list): list of model classes that have been visited. - Used to determine the discriminator class without - visiting circular references indefinitely. - - Returns: - used_model_class (class/None): the chosen child class that will be used - to deserialize the data, for example dog.Dog. - If a class is not found, None is returned. - """ - - if model_class in cls_visited: - # The class has already been visited and no suitable class was found. - return None - cls_visited.append(model_class) - used_model_class = None - if discr_name in model_class.discriminator: - class_name_to_discr_class = model_class.discriminator[discr_name] - used_model_class = class_name_to_discr_class.get(discr_value) - if used_model_class is None: - # We didn't find a discriminated class in class_name_to_discr_class. - # So look in the ancestor or descendant discriminators - # The discriminator mapping may exist in a descendant (anyOf, oneOf) - # or ancestor (allOf). - # Ancestor example: in the GrandparentAnimal -> ParentPet -> ChildCat - # hierarchy, the discriminator mappings may be defined at any level - # in the hierarchy. - # Descendant example: mammal -> whale/zebra/Pig -> BasquePig/DanishPig - # if we try to make BasquePig from mammal, we need to travel through - # the oneOf descendant discriminators to find BasquePig - descendant_classes = model_class._composed_schemas.get('oneOf', ()) + \ - model_class._composed_schemas.get('anyOf', ()) - ancestor_classes = model_class._composed_schemas.get('allOf', ()) - possible_classes = descendant_classes + ancestor_classes - for cls in possible_classes: - # Check if the schema has inherited discriminators. - if hasattr(cls, 'discriminator') and cls.discriminator is not None: - used_model_class = get_discriminator_class( - cls, discr_name, discr_value, cls_visited) - if used_model_class is not None: - return used_model_class - return used_model_class - - -def deserialize_model(model_data, model_class, path_to_item, check_type, - configuration, spec_property_naming): - """Deserializes model_data to model instance. - - Args: - model_data (int/str/float/bool/none_type/list/dict): data to instantiate the model - model_class (OpenApiModel): the model class - path_to_item (list): path to the model in the received data - check_type (bool): whether to check the data tupe for the values in - the model - configuration (Configuration): the instance to use to convert files - spec_property_naming (bool): True if the variable names in the input - data are serialized names as specified in the OpenAPI document. - False if the variables names in the input data are python - variable names in PEP-8 snake case. - - Returns: - model instance - - Raise: - ApiTypeError - ApiValueError - ApiKeyError - """ - - kw_args = dict(_check_type=check_type, - _path_to_item=path_to_item, - _configuration=configuration, - _spec_property_naming=spec_property_naming) - - if issubclass(model_class, ModelSimple): - return model_class._new_from_openapi_data(model_data, **kw_args) - elif isinstance(model_data, list): - return model_class._new_from_openapi_data(*model_data, **kw_args) - if isinstance(model_data, dict): - kw_args.update(model_data) - return model_class._new_from_openapi_data(**kw_args) - elif isinstance(model_data, PRIMITIVE_TYPES): - return model_class._new_from_openapi_data(model_data, **kw_args) - - -def deserialize_file(response_data, configuration, content_disposition=None): - """Deserializes body to file - - Saves response body into a file in a temporary folder, - using the filename from the `Content-Disposition` header if provided. - - Args: - param response_data (str): the file data to write - configuration (Configuration): the instance to use to convert files - - Keyword Args: - content_disposition (str): the value of the Content-Disposition - header - - Returns: - (file_type): the deserialized file which is open - The user is responsible for closing and reading the file - """ - fd, path = tempfile.mkstemp(dir=configuration.temp_folder_path) - os.close(fd) - os.remove(path) - - if content_disposition: - filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', - content_disposition, - flags=re.I) - if filename is not None: - filename = filename.group(1) - else: - filename = "default_" + str(uuid.uuid4()) - - path = os.path.join(os.path.dirname(path), filename) - - with open(path, "wb") as f: - if isinstance(response_data, str): - # change str to bytes so we can write it - response_data = response_data.encode('utf-8') - f.write(response_data) - - f = open(path, "rb") - return f - - -def attempt_convert_item(input_value, valid_classes, path_to_item, - configuration, spec_property_naming, key_type=False, - must_convert=False, check_type=True): - """ - Args: - input_value (any): the data to convert - valid_classes (any): the classes that are valid - path_to_item (list): the path to the item to convert - configuration (Configuration): the instance to use to convert files - spec_property_naming (bool): True if the variable names in the input - data are serialized names as specified in the OpenAPI document. - False if the variables names in the input data are python - variable names in PEP-8 snake case. - key_type (bool): if True we need to convert a key type (not supported) - must_convert (bool): if True we must convert - check_type (bool): if True we check the type or the returned data in - ModelComposed/ModelNormal/ModelSimple instances - - Returns: - instance (any) the fixed item - - Raises: - ApiTypeError - ApiValueError - ApiKeyError - """ - valid_classes_ordered = order_response_types(valid_classes) - valid_classes_coercible = remove_uncoercible( - valid_classes_ordered, input_value, spec_property_naming) - if not valid_classes_coercible or key_type: - # we do not handle keytype errors, json will take care - # of this for us - if configuration is None or not configuration.discard_unknown_keys: - raise get_type_error(input_value, path_to_item, valid_classes, - key_type=key_type) - for valid_class in valid_classes_coercible: - try: - if issubclass(valid_class, OpenApiModel): - return deserialize_model(input_value, valid_class, - path_to_item, check_type, - configuration, spec_property_naming) - elif valid_class == file_type: - return deserialize_file(input_value, configuration) - return deserialize_primitive(input_value, valid_class, - path_to_item) - except (ApiTypeError, ApiValueError, ApiKeyError) as conversion_exc: - if must_convert: - raise conversion_exc - # if we have conversion errors when must_convert == False - # we ignore the exception and move on to the next class - continue - # we were unable to convert, must_convert == False - return input_value - - -def is_type_nullable(input_type): - """ - Returns true if None is an allowed value for the specified input_type. - - A type is nullable if at least one of the following conditions is true: - 1. The OAS 'nullable' attribute has been specified, - 1. The type is the 'null' type, - 1. The type is a anyOf/oneOf composed schema, and a child schema is - the 'null' type. - Args: - input_type (type): the class of the input_value that we are - checking - Returns: - bool - """ - if input_type is none_type: - return True - if issubclass(input_type, OpenApiModel) and input_type._nullable: - return True - if issubclass(input_type, ModelComposed): - # If oneOf/anyOf, check if the 'null' type is one of the allowed types. - for t in input_type._composed_schemas.get('oneOf', ()): - if is_type_nullable(t): return True - for t in input_type._composed_schemas.get('anyOf', ()): - if is_type_nullable(t): return True - return False - - -def is_valid_type(input_class_simple, valid_classes): - """ - Args: - input_class_simple (class): the class of the input_value that we are - checking - valid_classes (tuple): the valid classes that the current item - should be - Returns: - bool - """ - if issubclass(input_class_simple, OpenApiModel) and \ - valid_classes == (bool, date, datetime, dict, float, int, list, str, none_type,): - return True - valid_type = input_class_simple in valid_classes - if not valid_type and ( - issubclass(input_class_simple, OpenApiModel) or - input_class_simple is none_type): - for valid_class in valid_classes: - if input_class_simple is none_type and is_type_nullable(valid_class): - # Schema is oneOf/anyOf and the 'null' type is one of the allowed types. - return True - if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator): - continue - discr_propertyname_py = list(valid_class.discriminator.keys())[0] - discriminator_classes = ( - valid_class.discriminator[discr_propertyname_py].values() - ) - valid_type = is_valid_type(input_class_simple, discriminator_classes) - if valid_type: - return True - return valid_type - - -def validate_and_convert_types(input_value, required_types_mixed, path_to_item, - spec_property_naming, _check_type, configuration=None): - """Raises a TypeError is there is a problem, otherwise returns value - - Args: - input_value (any): the data to validate/convert - required_types_mixed (list/dict/tuple): A list of - valid classes, or a list tuples of valid classes, or a dict where - the value is a tuple of value classes - path_to_item: (list) the path to the data being validated - this stores a list of keys or indices to get to the data being - validated - spec_property_naming (bool): True if the variable names in the input - data are serialized names as specified in the OpenAPI document. - False if the variables names in the input data are python - variable names in PEP-8 snake case. - _check_type: (boolean) if true, type will be checked and conversion - will be attempted. - configuration: (Configuration): the configuration class to use - when converting file_type items. - If passed, conversion will be attempted when possible - If not passed, no conversions will be attempted and - exceptions will be raised - - Returns: - the correctly typed value - - Raises: - ApiTypeError - """ - results = get_required_type_classes(required_types_mixed, spec_property_naming) - valid_classes, child_req_types_by_current_type = results - - input_class_simple = get_simple_class(input_value) - valid_type = is_valid_type(input_class_simple, valid_classes) - if not valid_type: - if (configuration - or (input_class_simple == dict - and not dict in valid_classes)): - # if input_value is not valid_type try to convert it - converted_instance = attempt_convert_item( - input_value, - valid_classes, - path_to_item, - configuration, - spec_property_naming, - key_type=False, - must_convert=True, - check_type=_check_type - ) - return converted_instance - else: - raise get_type_error(input_value, path_to_item, valid_classes, - key_type=False) - - # input_value's type is in valid_classes - if len(valid_classes) > 1 and configuration: - # there are valid classes which are not the current class - valid_classes_coercible = remove_uncoercible( - valid_classes, input_value, spec_property_naming, must_convert=False) - if valid_classes_coercible: - converted_instance = attempt_convert_item( - input_value, - valid_classes_coercible, - path_to_item, - configuration, - spec_property_naming, - key_type=False, - must_convert=False, - check_type=_check_type - ) - return converted_instance - - if child_req_types_by_current_type == {}: - # all types are of the required types and there are no more inner - # variables left to look at - return input_value - inner_required_types = child_req_types_by_current_type.get( - type(input_value) - ) - if inner_required_types is None: - # for this type, there are not more inner variables left to look at - return input_value - if isinstance(input_value, list): - if input_value == []: - # allow an empty list - return input_value - for index, inner_value in enumerate(input_value): - inner_path = list(path_to_item) - inner_path.append(index) - input_value[index] = validate_and_convert_types( - inner_value, - inner_required_types, - inner_path, - spec_property_naming, - _check_type, - configuration=configuration - ) - elif isinstance(input_value, dict): - if input_value == {}: - # allow an empty dict - return input_value - for inner_key, inner_val in input_value.items(): - inner_path = list(path_to_item) - inner_path.append(inner_key) - if get_simple_class(inner_key) != str: - raise get_type_error(inner_key, inner_path, valid_classes, - key_type=True) - input_value[inner_key] = validate_and_convert_types( - inner_val, - inner_required_types, - inner_path, - spec_property_naming, - _check_type, - configuration=configuration - ) - return input_value - - -def model_to_dict(model_instance, serialize=True): - """Returns the model properties as a dict - - Args: - model_instance (one of your model instances): the model instance that - will be converted to a dict. - - Keyword Args: - serialize (bool): if True, the keys in the dict will be values from - attribute_map - """ - result = {} - extract_item = lambda item: (item[0], model_to_dict(item[1], serialize=serialize)) if hasattr(item[1], '_data_store') else item - - model_instances = [model_instance] - if model_instance._composed_schemas: - model_instances.extend(model_instance._composed_instances) - seen_json_attribute_names = set() - used_fallback_python_attribute_names = set() - py_to_json_map = {} - for model_instance in model_instances: - for attr, value in model_instance._data_store.items(): - if serialize: - # we use get here because additional property key names do not - # exist in attribute_map - try: - attr = model_instance.attribute_map[attr] - py_to_json_map.update(model_instance.attribute_map) - seen_json_attribute_names.add(attr) - except KeyError: - used_fallback_python_attribute_names.add(attr) - if isinstance(value, list): - if not value: - # empty list or None - result[attr] = value - else: - res = [] - for v in value: - if isinstance(v, PRIMITIVE_TYPES) or v is None: - res.append(v) - elif isinstance(v, ModelSimple): - res.append(v.value) - elif isinstance(v, dict): - res.append(dict(map( - extract_item, - v.items() - ))) - else: - res.append(model_to_dict(v, serialize=serialize)) - result[attr] = res - elif isinstance(value, dict): - result[attr] = dict(map( - extract_item, - value.items() - )) - elif isinstance(value, ModelSimple): - result[attr] = value.value - elif hasattr(value, '_data_store'): - result[attr] = model_to_dict(value, serialize=serialize) - else: - result[attr] = value - if serialize: - for python_key in used_fallback_python_attribute_names: - json_key = py_to_json_map.get(python_key) - if json_key is None: - continue - if python_key == json_key: - continue - json_key_assigned_no_need_for_python_key = json_key in seen_json_attribute_names - if json_key_assigned_no_need_for_python_key: - del result[python_key] - - return result - - -def type_error_message(var_value=None, var_name=None, valid_classes=None, - key_type=None): - """ - Keyword Args: - var_value (any): the variable which has the type_error - var_name (str): the name of the variable which has the typ error - valid_classes (tuple): the accepted classes for current_item's - value - key_type (bool): False if our value is a value in a dict - True if it is a key in a dict - False if our item is an item in a list - """ - key_or_value = 'value' - if key_type: - key_or_value = 'key' - valid_classes_phrase = get_valid_classes_phrase(valid_classes) - msg = ( - "Invalid type for variable '{0}'. Required {1} type {2} and " - "passed type was {3}".format( - var_name, - key_or_value, - valid_classes_phrase, - type(var_value).__name__, - ) - ) - return msg - - -def get_valid_classes_phrase(input_classes): - """Returns a string phrase describing what types are allowed - """ - all_classes = list(input_classes) - all_classes = sorted(all_classes, key=lambda cls: cls.__name__) - all_class_names = [cls.__name__ for cls in all_classes] - if len(all_class_names) == 1: - return 'is {0}'.format(all_class_names[0]) - return "is one of [{0}]".format(", ".join(all_class_names)) - - -def get_allof_instances(self, model_args, constant_args): - """ - Args: - self: the class we are handling - model_args (dict): var_name to var_value - used to make instances - constant_args (dict): - metadata arguments: - _check_type - _path_to_item - _spec_property_naming - _configuration - _visited_composed_classes - - Returns - composed_instances (list) - """ - composed_instances = [] - for allof_class in self._composed_schemas['allOf']: - - try: - if constant_args.get('_spec_property_naming'): - allof_instance = allof_class._from_openapi_data(**model_args, **constant_args) - else: - allof_instance = allof_class(**model_args, **constant_args) - composed_instances.append(allof_instance) - except Exception as ex: - raise ApiValueError( - "Invalid inputs given to generate an instance of '%s'. The " - "input data was invalid for the allOf schema '%s' in the composed " - "schema '%s'. Error=%s" % ( - allof_class.__name__, - allof_class.__name__, - self.__class__.__name__, - str(ex) - ) - ) from ex - return composed_instances - - -def get_oneof_instance(cls, model_kwargs, constant_kwargs, model_arg=None): - """ - Find the oneOf schema that matches the input data (e.g. payload). - If exactly one schema matches the input data, an instance of that schema - is returned. - If zero or more than one schema match the input data, an exception is raised. - In OAS 3.x, the payload MUST, by validation, match exactly one of the - schemas described by oneOf. - - Args: - cls: the class we are handling - model_kwargs (dict): var_name to var_value - The input data, e.g. the payload that must match a oneOf schema - in the OpenAPI document. - constant_kwargs (dict): var_name to var_value - args that every model requires, including configuration, server - and path to item. - - Kwargs: - model_arg: (int, float, bool, str, date, datetime, ModelSimple, None): - the value to assign to a primitive class or ModelSimple class - Notes: - - this is only passed in when oneOf includes types which are not object - - None is used to suppress handling of model_arg, nullable models are handled in __new__ - - Returns - oneof_instance (instance) - """ - if len(cls._composed_schemas['oneOf']) == 0: - return None - - oneof_instances = [] - # Iterate over each oneOf schema and determine if the input data - # matches the oneOf schemas. - for oneof_class in cls._composed_schemas['oneOf']: - # The composed oneOf schema allows the 'null' type and the input data - # is the null value. This is a OAS >= 3.1 feature. - if oneof_class is none_type: - # skip none_types because we are deserializing dict data. - # none_type deserialization is handled in the __new__ method - continue - - single_value_input = allows_single_value_input(oneof_class) - - try: - if not single_value_input: - if constant_kwargs.get('_spec_property_naming'): - oneof_instance = oneof_class._from_openapi_data(**model_kwargs, **constant_kwargs) - else: - oneof_instance = oneof_class(**model_kwargs, **constant_kwargs) - - # Workaround for missing OneOf schema support by the generator - # Checks if the defined schema is a subset of received model - # This way we can ensure forward-compatibility support of new fields in API - assert len(set(model_kwargs.keys()).difference(set(oneof_class.openapi_types.keys()))) == 0 or set(oneof_class.openapi_types.keys()) <= set(model_kwargs.keys()) - - else: - if issubclass(oneof_class, ModelSimple): - if constant_kwargs.get('_spec_property_naming'): - oneof_instance = oneof_class._from_openapi_data(model_arg, **constant_kwargs) - else: - oneof_instance = oneof_class(model_arg, **constant_kwargs) - elif oneof_class in PRIMITIVE_TYPES: - oneof_instance = validate_and_convert_types( - model_arg, - (oneof_class,), - constant_kwargs['_path_to_item'], - constant_kwargs['_spec_property_naming'], - constant_kwargs['_check_type'], - configuration=constant_kwargs['_configuration'] - ) - oneof_instances.append(oneof_instance) - except Exception: - pass - if len(oneof_instances) == 0: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. None " - "of the oneOf schemas matched the input data." % - cls.__name__ - ) - elif len(oneof_instances) > 1: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. Multiple " - "oneOf schemas matched the inputs, but a max of one is allowed." % - cls.__name__ - ) - return oneof_instances[0] - - -def get_anyof_instances(self, model_args, constant_args): - """ - Args: - self: the class we are handling - model_args (dict): var_name to var_value - The input data, e.g. the payload that must match at least one - anyOf child schema in the OpenAPI document. - constant_args (dict): var_name to var_value - args that every model requires, including configuration, server - and path to item. - - Returns - anyof_instances (list) - """ - anyof_instances = [] - if len(self._composed_schemas['anyOf']) == 0: - return anyof_instances - - for anyof_class in self._composed_schemas['anyOf']: - # The composed oneOf schema allows the 'null' type and the input data - # is the null value. This is a OAS >= 3.1 feature. - if anyof_class is none_type: - # skip none_types because we are deserializing dict data. - # none_type deserialization is handled in the __new__ method - continue - - try: - if constant_args.get('_spec_property_naming'): - anyof_instance = anyof_class._from_openapi_data(**model_args, **constant_args) - else: - anyof_instance = anyof_class(**model_args, **constant_args) - anyof_instances.append(anyof_instance) - except Exception: - pass - if len(anyof_instances) == 0: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. None of the " - "anyOf schemas matched the inputs." % - self.__class__.__name__ - ) - return anyof_instances - - -def get_discarded_args(self, composed_instances, model_args): - """ - Gathers the args that were discarded by configuration.discard_unknown_keys - """ - model_arg_keys = model_args.keys() - discarded_args = set() - # arguments passed to self were already converted to python names - # before __init__ was called - for instance in composed_instances: - if instance.__class__ in self._composed_schemas['allOf']: - try: - keys = instance.to_dict().keys() - discarded_keys = model_args - keys - discarded_args.update(discarded_keys) - except Exception: - # allOf integer schema will throw exception - pass - else: - try: - all_keys = set(model_to_dict(instance, serialize=False).keys()) - js_keys = model_to_dict(instance, serialize=True).keys() - all_keys.update(js_keys) - discarded_keys = model_arg_keys - all_keys - discarded_args.update(discarded_keys) - except Exception: - # allOf integer schema will throw exception - pass - return discarded_args - - -def validate_get_composed_info(constant_args, model_args, self): - """ - For composed schemas, generate schema instances for - all schemas in the oneOf/anyOf/allOf definition. If additional - properties are allowed, also assign those properties on - all matched schemas that contain additionalProperties. - Openapi schemas are python classes. - - Exceptions are raised if: - - 0 or > 1 oneOf schema matches the model_args input data - - no anyOf schema matches the model_args input data - - any of the allOf schemas do not match the model_args input data - - Args: - constant_args (dict): these are the args that every model requires - model_args (dict): these are the required and optional spec args that - were passed in to make this model - self (class): the class that we are instantiating - This class contains self._composed_schemas - - Returns: - composed_info (list): length three - composed_instances (list): the composed instances which are not - self - var_name_to_model_instances (dict): a dict going from var_name - to the model_instance which holds that var_name - the model_instance may be self or an instance of one of the - classes in self.composed_instances() - additional_properties_model_instances (list): a list of the - model instances which have the property - additional_properties_type. This list can include self - """ - # create composed_instances - composed_instances = [] - allof_instances = get_allof_instances(self, model_args, constant_args) - composed_instances.extend(allof_instances) - oneof_instance = get_oneof_instance(self.__class__, model_args, constant_args) - if oneof_instance is not None: - composed_instances.append(oneof_instance) - anyof_instances = get_anyof_instances(self, model_args, constant_args) - composed_instances.extend(anyof_instances) - """ - set additional_properties_model_instances - additional properties must be evaluated at the schema level - so self's additional properties are most important - If self is a composed schema with: - - no properties defined in self - - additionalProperties: False - Then for object payloads every property is an additional property - and they are not allowed, so only empty dict is allowed - - Properties must be set on all matching schemas - so when a property is assigned toa composed instance, it must be set on all - composed instances regardless of additionalProperties presence - keeping it to prevent breaking changes in v5.0.1 - TODO remove cls._additional_properties_model_instances in 6.0.0 - """ - additional_properties_model_instances = [] - if self.additional_properties_type is not None: - additional_properties_model_instances = [self] - - """ - no need to set properties on self in here, they will be set in __init__ - By here all composed schema oneOf/anyOf/allOf instances have their properties set using - model_args - """ - discarded_args = get_discarded_args(self, composed_instances, model_args) - - # map variable names to composed_instances - var_name_to_model_instances = {} - for prop_name in model_args: - if prop_name not in discarded_args: - var_name_to_model_instances[prop_name] = [self] + composed_instances - - return [ - composed_instances, - var_name_to_model_instances, - additional_properties_model_instances, - discarded_args - ] diff --git a/gooddata-api-client/gooddata_api_client/models/__init__.py b/gooddata-api-client/gooddata_api_client/models/__init__.py index 558225f7d..ccf23ede7 100644 --- a/gooddata-api-client/gooddata_api_client/models/__init__.py +++ b/gooddata-api-client/gooddata_api_client/models/__init__.py @@ -1,991 +1,958 @@ +# coding: utf-8 + # flake8: noqa +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 -# import all models into this package -# if you have many models here with many references from one model to another this may -# raise a RecursionError -# to avoid this, import only the models that you directly need like: -# from from gooddata_api_client.model.pet import Pet -# or import this package, but before doing it, use: -# import sys -# sys.setrecursionlimit(n) -from gooddata_api_client.model.afm import AFM -from gooddata_api_client.model.afm_filters_inner import AFMFiltersInner -from gooddata_api_client.model.absolute_date_filter import AbsoluteDateFilter -from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter -from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter -from gooddata_api_client.model.active_object_identification import ActiveObjectIdentification -from gooddata_api_client.model.ad_hoc_automation import AdHocAutomation -from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens -from gooddata_api_client.model.afm_execution import AfmExecution -from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse -from gooddata_api_client.model.afm_identifier import AfmIdentifier -from gooddata_api_client.model.afm_local_identifier import AfmLocalIdentifier -from gooddata_api_client.model.afm_object_identifier import AfmObjectIdentifier -from gooddata_api_client.model.afm_object_identifier_attribute import AfmObjectIdentifierAttribute -from gooddata_api_client.model.afm_object_identifier_attribute_identifier import AfmObjectIdentifierAttributeIdentifier -from gooddata_api_client.model.afm_object_identifier_core import AfmObjectIdentifierCore -from gooddata_api_client.model.afm_object_identifier_core_identifier import AfmObjectIdentifierCoreIdentifier -from gooddata_api_client.model.afm_object_identifier_dataset import AfmObjectIdentifierDataset -from gooddata_api_client.model.afm_object_identifier_dataset_identifier import AfmObjectIdentifierDatasetIdentifier -from gooddata_api_client.model.afm_object_identifier_identifier import AfmObjectIdentifierIdentifier -from gooddata_api_client.model.afm_object_identifier_label import AfmObjectIdentifierLabel -from gooddata_api_client.model.afm_object_identifier_label_identifier import AfmObjectIdentifierLabelIdentifier -from gooddata_api_client.model.afm_valid_descendants_query import AfmValidDescendantsQuery -from gooddata_api_client.model.afm_valid_descendants_response import AfmValidDescendantsResponse -from gooddata_api_client.model.afm_valid_objects_query import AfmValidObjectsQuery -from gooddata_api_client.model.afm_valid_objects_response import AfmValidObjectsResponse -from gooddata_api_client.model.alert_afm import AlertAfm -from gooddata_api_client.model.alert_condition import AlertCondition -from gooddata_api_client.model.alert_condition_operand import AlertConditionOperand -from gooddata_api_client.model.alert_description import AlertDescription -from gooddata_api_client.model.alert_evaluation_row import AlertEvaluationRow -from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags -from gooddata_api_client.model.anomaly_detection_request import AnomalyDetectionRequest -from gooddata_api_client.model.anomaly_detection_result import AnomalyDetectionResult -from gooddata_api_client.model.api_entitlement import ApiEntitlement -from gooddata_api_client.model.arithmetic_measure import ArithmeticMeasure -from gooddata_api_client.model.arithmetic_measure_definition import ArithmeticMeasureDefinition -from gooddata_api_client.model.arithmetic_measure_definition_arithmetic_measure import ArithmeticMeasureDefinitionArithmeticMeasure -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier -from gooddata_api_client.model.assignee_rule import AssigneeRule -from gooddata_api_client.model.attribute_elements import AttributeElements -from gooddata_api_client.model.attribute_elements_by_ref import AttributeElementsByRef -from gooddata_api_client.model.attribute_elements_by_value import AttributeElementsByValue -from gooddata_api_client.model.attribute_execution_result_header import AttributeExecutionResultHeader -from gooddata_api_client.model.attribute_filter import AttributeFilter -from gooddata_api_client.model.attribute_filter_by_date import AttributeFilterByDate -from gooddata_api_client.model.attribute_filter_elements import AttributeFilterElements -from gooddata_api_client.model.attribute_filter_parent import AttributeFilterParent -from gooddata_api_client.model.attribute_format import AttributeFormat -from gooddata_api_client.model.attribute_header import AttributeHeader -from gooddata_api_client.model.attribute_header_attribute_header import AttributeHeaderAttributeHeader -from gooddata_api_client.model.attribute_item import AttributeItem -from gooddata_api_client.model.attribute_negative_filter import AttributeNegativeFilter -from gooddata_api_client.model.attribute_negative_filter_all_of import AttributeNegativeFilterAllOf -from gooddata_api_client.model.attribute_positive_filter import AttributePositiveFilter -from gooddata_api_client.model.attribute_positive_filter_all_of import AttributePositiveFilterAllOf -from gooddata_api_client.model.attribute_result_header import AttributeResultHeader -from gooddata_api_client.model.automation_alert import AutomationAlert -from gooddata_api_client.model.automation_alert_condition import AutomationAlertCondition -from gooddata_api_client.model.automation_dashboard_tabular_export import AutomationDashboardTabularExport -from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient -from gooddata_api_client.model.automation_image_export import AutomationImageExport -from gooddata_api_client.model.automation_metadata import AutomationMetadata -from gooddata_api_client.model.automation_notification import AutomationNotification -from gooddata_api_client.model.automation_notification_all_of import AutomationNotificationAllOf -from gooddata_api_client.model.automation_raw_export import AutomationRawExport -from gooddata_api_client.model.automation_schedule import AutomationSchedule -from gooddata_api_client.model.automation_slides_export import AutomationSlidesExport -from gooddata_api_client.model.automation_tabular_export import AutomationTabularExport -from gooddata_api_client.model.automation_visual_export import AutomationVisualExport -from gooddata_api_client.model.available_assignees import AvailableAssignees -from gooddata_api_client.model.bounded_filter import BoundedFilter -from gooddata_api_client.model.chat_history_interaction import ChatHistoryInteraction -from gooddata_api_client.model.chat_history_request import ChatHistoryRequest -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_request import ChatRequest -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.chat_usage_response import ChatUsageResponse -from gooddata_api_client.model.clustering_request import ClusteringRequest -from gooddata_api_client.model.clustering_result import ClusteringResult -from gooddata_api_client.model.column_location import ColumnLocation -from gooddata_api_client.model.column_override import ColumnOverride -from gooddata_api_client.model.column_statistic import ColumnStatistic -from gooddata_api_client.model.column_statistic_warning import ColumnStatisticWarning -from gooddata_api_client.model.column_statistics_request import ColumnStatisticsRequest -from gooddata_api_client.model.column_statistics_request_from import ColumnStatisticsRequestFrom -from gooddata_api_client.model.column_statistics_response import ColumnStatisticsResponse -from gooddata_api_client.model.column_warning import ColumnWarning -from gooddata_api_client.model.comparison import Comparison -from gooddata_api_client.model.comparison_measure_value_filter import ComparisonMeasureValueFilter -from gooddata_api_client.model.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter -from gooddata_api_client.model.comparison_wrapper import ComparisonWrapper -from gooddata_api_client.model.content_slide_template import ContentSlideTemplate -from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate -from gooddata_api_client.model.created_visualization import CreatedVisualization -from gooddata_api_client.model.created_visualization_filters_inner import CreatedVisualizationFiltersInner -from gooddata_api_client.model.created_visualizations import CreatedVisualizations -from gooddata_api_client.model.custom_label import CustomLabel -from gooddata_api_client.model.custom_metric import CustomMetric -from gooddata_api_client.model.custom_override import CustomOverride -from gooddata_api_client.model.dashboard_attribute_filter import DashboardAttributeFilter -from gooddata_api_client.model.dashboard_attribute_filter_attribute_filter import DashboardAttributeFilterAttributeFilter -from gooddata_api_client.model.dashboard_date_filter import DashboardDateFilter -from gooddata_api_client.model.dashboard_date_filter_date_filter import DashboardDateFilterDateFilter -from gooddata_api_client.model.dashboard_date_filter_date_filter_from import DashboardDateFilterDateFilterFrom -from gooddata_api_client.model.dashboard_export_settings import DashboardExportSettings -from gooddata_api_client.model.dashboard_filter import DashboardFilter -from gooddata_api_client.model.dashboard_permissions import DashboardPermissions -from gooddata_api_client.model.dashboard_permissions_assignment import DashboardPermissionsAssignment -from gooddata_api_client.model.dashboard_slides_template import DashboardSlidesTemplate -from gooddata_api_client.model.dashboard_tabular_export_request import DashboardTabularExportRequest -from gooddata_api_client.model.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 -from gooddata_api_client.model.data_column_locator import DataColumnLocator -from gooddata_api_client.model.data_column_locators import DataColumnLocators -from gooddata_api_client.model.data_source_parameter import DataSourceParameter -from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment -from gooddata_api_client.model.data_source_schemata import DataSourceSchemata -from gooddata_api_client.model.data_source_table_identifier import DataSourceTableIdentifier -from gooddata_api_client.model.dataset_grain import DatasetGrain -from gooddata_api_client.model.dataset_reference_identifier import DatasetReferenceIdentifier -from gooddata_api_client.model.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier -from gooddata_api_client.model.date_absolute_filter import DateAbsoluteFilter -from gooddata_api_client.model.date_absolute_filter_all_of import DateAbsoluteFilterAllOf -from gooddata_api_client.model.date_filter import DateFilter -from gooddata_api_client.model.date_relative_filter import DateRelativeFilter -from gooddata_api_client.model.date_relative_filter_all_of import DateRelativeFilterAllOf -from gooddata_api_client.model.date_value import DateValue -from gooddata_api_client.model.declarative_aggregated_fact import DeclarativeAggregatedFact -from gooddata_api_client.model.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard -from gooddata_api_client.model.declarative_analytical_dashboard_extension import DeclarativeAnalyticalDashboardExtension -from gooddata_api_client.model.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier -from gooddata_api_client.model.declarative_analytical_dashboard_permission_assignment import DeclarativeAnalyticalDashboardPermissionAssignment -from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee import DeclarativeAnalyticalDashboardPermissionForAssignee -from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee_all_of import DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf -from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee_rule import DeclarativeAnalyticalDashboardPermissionForAssigneeRule -from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee_rule_all_of import DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf -from gooddata_api_client.model.declarative_analytical_dashboard_permissions_inner import DeclarativeAnalyticalDashboardPermissionsInner -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics -from gooddata_api_client.model.declarative_analytics_layer import DeclarativeAnalyticsLayer -from gooddata_api_client.model.declarative_attribute import DeclarativeAttribute -from gooddata_api_client.model.declarative_attribute_hierarchy import DeclarativeAttributeHierarchy -from gooddata_api_client.model.declarative_automation import DeclarativeAutomation -from gooddata_api_client.model.declarative_color_palette import DeclarativeColorPalette -from gooddata_api_client.model.declarative_column import DeclarativeColumn -from gooddata_api_client.model.declarative_csp_directive import DeclarativeCspDirective -from gooddata_api_client.model.declarative_custom_application_setting import DeclarativeCustomApplicationSetting -from gooddata_api_client.model.declarative_dashboard_plugin import DeclarativeDashboardPlugin -from gooddata_api_client.model.declarative_data_source import DeclarativeDataSource -from gooddata_api_client.model.declarative_data_source_permission import DeclarativeDataSourcePermission -from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources -from gooddata_api_client.model.declarative_dataset import DeclarativeDataset -from gooddata_api_client.model.declarative_dataset_extension import DeclarativeDatasetExtension -from gooddata_api_client.model.declarative_dataset_sql import DeclarativeDatasetSql -from gooddata_api_client.model.declarative_date_dataset import DeclarativeDateDataset -from gooddata_api_client.model.declarative_export_definition import DeclarativeExportDefinition -from gooddata_api_client.model.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier -from gooddata_api_client.model.declarative_export_definition_request_payload import DeclarativeExportDefinitionRequestPayload -from gooddata_api_client.model.declarative_export_template import DeclarativeExportTemplate -from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates -from gooddata_api_client.model.declarative_fact import DeclarativeFact -from gooddata_api_client.model.declarative_filter_context import DeclarativeFilterContext -from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView -from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider -from gooddata_api_client.model.declarative_identity_provider_identifier import DeclarativeIdentityProviderIdentifier -from gooddata_api_client.model.declarative_jwk import DeclarativeJwk -from gooddata_api_client.model.declarative_jwk_specification import DeclarativeJwkSpecification -from gooddata_api_client.model.declarative_label import DeclarativeLabel -from gooddata_api_client.model.declarative_ldm import DeclarativeLdm -from gooddata_api_client.model.declarative_metric import DeclarativeMetric -from gooddata_api_client.model.declarative_model import DeclarativeModel -from gooddata_api_client.model.declarative_notification_channel import DeclarativeNotificationChannel -from gooddata_api_client.model.declarative_notification_channel_destination import DeclarativeNotificationChannelDestination -from gooddata_api_client.model.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier -from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization -from gooddata_api_client.model.declarative_organization_info import DeclarativeOrganizationInfo -from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission -from gooddata_api_client.model.declarative_reference import DeclarativeReference -from gooddata_api_client.model.declarative_reference_source import DeclarativeReferenceSource -from gooddata_api_client.model.declarative_rsa_specification import DeclarativeRsaSpecification -from gooddata_api_client.model.declarative_setting import DeclarativeSetting -from gooddata_api_client.model.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission -from gooddata_api_client.model.declarative_source_fact_reference import DeclarativeSourceFactReference -from gooddata_api_client.model.declarative_table import DeclarativeTable -from gooddata_api_client.model.declarative_tables import DeclarativeTables -from gooddata_api_client.model.declarative_theme import DeclarativeTheme -from gooddata_api_client.model.declarative_user import DeclarativeUser -from gooddata_api_client.model.declarative_user_data_filter import DeclarativeUserDataFilter -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters -from gooddata_api_client.model.declarative_user_group import DeclarativeUserGroup -from gooddata_api_client.model.declarative_user_group_identifier import DeclarativeUserGroupIdentifier -from gooddata_api_client.model.declarative_user_group_permission import DeclarativeUserGroupPermission -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups -from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier -from gooddata_api_client.model.declarative_user_permission import DeclarativeUserPermission -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions -from gooddata_api_client.model.declarative_users import DeclarativeUsers -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups -from gooddata_api_client.model.declarative_visualization_object import DeclarativeVisualizationObject -from gooddata_api_client.model.declarative_workspace import DeclarativeWorkspace -from gooddata_api_client.model.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter -from gooddata_api_client.model.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn -from gooddata_api_client.model.declarative_workspace_data_filter_references import DeclarativeWorkspaceDataFilterReferences -from gooddata_api_client.model.declarative_workspace_data_filter_setting import DeclarativeWorkspaceDataFilterSetting -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters -from gooddata_api_client.model.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces -from gooddata_api_client.model.default_smtp import DefaultSmtp -from gooddata_api_client.model.default_smtp_all_of import DefaultSmtpAllOf -from gooddata_api_client.model.dependent_entities_graph import DependentEntitiesGraph -from gooddata_api_client.model.dependent_entities_node import DependentEntitiesNode -from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse -from gooddata_api_client.model.depends_on import DependsOn -from gooddata_api_client.model.depends_on_all_of import DependsOnAllOf -from gooddata_api_client.model.depends_on_date_filter import DependsOnDateFilter -from gooddata_api_client.model.depends_on_date_filter_all_of import DependsOnDateFilterAllOf -from gooddata_api_client.model.depends_on_item import DependsOnItem -from gooddata_api_client.model.dim_attribute import DimAttribute -from gooddata_api_client.model.dimension import Dimension -from gooddata_api_client.model.dimension_header import DimensionHeader -from gooddata_api_client.model.element import Element -from gooddata_api_client.model.elements_request import ElementsRequest -from gooddata_api_client.model.elements_request_depends_on_inner import ElementsRequestDependsOnInner -from gooddata_api_client.model.elements_response import ElementsResponse -from gooddata_api_client.model.entitlements_request import EntitlementsRequest -from gooddata_api_client.model.entity_identifier import EntityIdentifier -from gooddata_api_client.model.execution_links import ExecutionLinks -from gooddata_api_client.model.execution_response import ExecutionResponse -from gooddata_api_client.model.execution_result import ExecutionResult -from gooddata_api_client.model.execution_result_data_source_message import ExecutionResultDataSourceMessage -from gooddata_api_client.model.execution_result_grand_total import ExecutionResultGrandTotal -from gooddata_api_client.model.execution_result_header import ExecutionResultHeader -from gooddata_api_client.model.execution_result_metadata import ExecutionResultMetadata -from gooddata_api_client.model.execution_result_paging import ExecutionResultPaging -from gooddata_api_client.model.execution_settings import ExecutionSettings -from gooddata_api_client.model.export_request import ExportRequest -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.export_result import ExportResult -from gooddata_api_client.model.fact_identifier import FactIdentifier -from gooddata_api_client.model.file import File -from gooddata_api_client.model.filter import Filter -from gooddata_api_client.model.filter_by import FilterBy -from gooddata_api_client.model.filter_definition import FilterDefinition -from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure -from gooddata_api_client.model.forecast_request import ForecastRequest -from gooddata_api_client.model.forecast_result import ForecastResult -from gooddata_api_client.model.found_objects import FoundObjects -from gooddata_api_client.model.frequency import Frequency -from gooddata_api_client.model.frequency_bucket import FrequencyBucket -from gooddata_api_client.model.frequency_properties import FrequencyProperties -from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner -from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse -from gooddata_api_client.model.grain_identifier import GrainIdentifier -from gooddata_api_client.model.granted_permission import GrantedPermission -from gooddata_api_client.model.granularities_formatting import GranularitiesFormatting -from gooddata_api_client.model.header_group import HeaderGroup -from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification -from gooddata_api_client.model.histogram import Histogram -from gooddata_api_client.model.histogram_bucket import HistogramBucket -from gooddata_api_client.model.histogram_properties import HistogramProperties -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications -from gooddata_api_client.model.identifier_ref import IdentifierRef -from gooddata_api_client.model.identifier_ref_identifier import IdentifierRefIdentifier -from gooddata_api_client.model.image_export_request import ImageExportRequest -from gooddata_api_client.model.in_platform import InPlatform -from gooddata_api_client.model.in_platform_all_of import InPlatformAllOf -from gooddata_api_client.model.inline_filter_definition import InlineFilterDefinition -from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline -from gooddata_api_client.model.inline_measure_definition import InlineMeasureDefinition -from gooddata_api_client.model.inline_measure_definition_inline import InlineMeasureDefinitionInline -from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate -from gooddata_api_client.model.json_api_aggregated_fact_linkage import JsonApiAggregatedFactLinkage -from gooddata_api_client.model.json_api_aggregated_fact_out import JsonApiAggregatedFactOut -from gooddata_api_client.model.json_api_aggregated_fact_out_attributes import JsonApiAggregatedFactOutAttributes -from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument -from gooddata_api_client.model.json_api_aggregated_fact_out_includes import JsonApiAggregatedFactOutIncludes -from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList -from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta -from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta -from gooddata_api_client.model.json_api_aggregated_fact_out_meta_origin import JsonApiAggregatedFactOutMetaOrigin -from gooddata_api_client.model.json_api_aggregated_fact_out_relationships import JsonApiAggregatedFactOutRelationships -from gooddata_api_client.model.json_api_aggregated_fact_out_relationships_dataset import JsonApiAggregatedFactOutRelationshipsDataset -from gooddata_api_client.model.json_api_aggregated_fact_out_relationships_source_fact import JsonApiAggregatedFactOutRelationshipsSourceFact -from gooddata_api_client.model.json_api_aggregated_fact_out_with_links import JsonApiAggregatedFactOutWithLinks -from gooddata_api_client.model.json_api_aggregated_fact_to_many_linkage import JsonApiAggregatedFactToManyLinkage -from gooddata_api_client.model.json_api_analytical_dashboard_in import JsonApiAnalyticalDashboardIn -from gooddata_api_client.model.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_linkage import JsonApiAnalyticalDashboardLinkage -from gooddata_api_client.model.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut -from gooddata_api_client.model.json_api_analytical_dashboard_out_attributes import JsonApiAnalyticalDashboardOutAttributes -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList -from gooddata_api_client.model.json_api_analytical_dashboard_out_meta import JsonApiAnalyticalDashboardOutMeta -from gooddata_api_client.model.json_api_analytical_dashboard_out_meta_access_info import JsonApiAnalyticalDashboardOutMetaAccessInfo -from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships import JsonApiAnalyticalDashboardOutRelationships -from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_analytical_dashboards import JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards -from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy -from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_dashboard_plugins import JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins -from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets -from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_filter_contexts import JsonApiAnalyticalDashboardOutRelationshipsFilterContexts -from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels -from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics -from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_visualization_objects import JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects -from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks -from gooddata_api_client.model.json_api_analytical_dashboard_patch import JsonApiAnalyticalDashboardPatch -from gooddata_api_client.model.json_api_analytical_dashboard_patch_attributes import JsonApiAnalyticalDashboardPatchAttributes -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id import JsonApiAnalyticalDashboardPostOptionalId -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_analytical_dashboard_to_many_linkage import JsonApiAnalyticalDashboardToManyLinkage -from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage -from gooddata_api_client.model.json_api_api_token_in import JsonApiApiTokenIn -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument -from gooddata_api_client.model.json_api_api_token_out import JsonApiApiTokenOut -from gooddata_api_client.model.json_api_api_token_out_attributes import JsonApiApiTokenOutAttributes -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList -from gooddata_api_client.model.json_api_api_token_out_with_links import JsonApiApiTokenOutWithLinks -from gooddata_api_client.model.json_api_attribute_hierarchy_in import JsonApiAttributeHierarchyIn -from gooddata_api_client.model.json_api_attribute_hierarchy_in_attributes import JsonApiAttributeHierarchyInAttributes -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_linkage import JsonApiAttributeHierarchyLinkage -from gooddata_api_client.model.json_api_attribute_hierarchy_out import JsonApiAttributeHierarchyOut -from gooddata_api_client.model.json_api_attribute_hierarchy_out_attributes import JsonApiAttributeHierarchyOutAttributes -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_includes import JsonApiAttributeHierarchyOutIncludes -from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList -from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships import JsonApiAttributeHierarchyOutRelationships -from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes -from gooddata_api_client.model.json_api_attribute_hierarchy_out_with_links import JsonApiAttributeHierarchyOutWithLinks -from gooddata_api_client.model.json_api_attribute_hierarchy_patch import JsonApiAttributeHierarchyPatch -from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_to_many_linkage import JsonApiAttributeHierarchyToManyLinkage -from gooddata_api_client.model.json_api_attribute_linkage import JsonApiAttributeLinkage -from gooddata_api_client.model.json_api_attribute_out import JsonApiAttributeOut -from gooddata_api_client.model.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument -from gooddata_api_client.model.json_api_attribute_out_includes import JsonApiAttributeOutIncludes -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList -from gooddata_api_client.model.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships -from gooddata_api_client.model.json_api_attribute_out_relationships_attribute_hierarchies import JsonApiAttributeOutRelationshipsAttributeHierarchies -from gooddata_api_client.model.json_api_attribute_out_relationships_default_view import JsonApiAttributeOutRelationshipsDefaultView -from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks -from gooddata_api_client.model.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage -from gooddata_api_client.model.json_api_attribute_to_one_linkage import JsonApiAttributeToOneLinkage -from gooddata_api_client.model.json_api_automation_in import JsonApiAutomationIn -from gooddata_api_client.model.json_api_automation_in_attributes import JsonApiAutomationInAttributes -from gooddata_api_client.model.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert -from gooddata_api_client.model.json_api_automation_in_attributes_dashboard_tabular_exports_inner import JsonApiAutomationInAttributesDashboardTabularExportsInner -from gooddata_api_client.model.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner -from gooddata_api_client.model.json_api_automation_in_attributes_image_exports_inner import JsonApiAutomationInAttributesImageExportsInner -from gooddata_api_client.model.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata -from gooddata_api_client.model.json_api_automation_in_attributes_raw_exports_inner import JsonApiAutomationInAttributesRawExportsInner -from gooddata_api_client.model.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule -from gooddata_api_client.model.json_api_automation_in_attributes_slides_exports_inner import JsonApiAutomationInAttributesSlidesExportsInner -from gooddata_api_client.model.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner -from gooddata_api_client.model.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_in_relationships import JsonApiAutomationInRelationships -from gooddata_api_client.model.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard -from gooddata_api_client.model.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions -from gooddata_api_client.model.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel -from gooddata_api_client.model.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients -from gooddata_api_client.model.json_api_automation_linkage import JsonApiAutomationLinkage -from gooddata_api_client.model.json_api_automation_out import JsonApiAutomationOut -from gooddata_api_client.model.json_api_automation_out_attributes import JsonApiAutomationOutAttributes -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -from gooddata_api_client.model.json_api_automation_out_includes import JsonApiAutomationOutIncludes -from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList -from gooddata_api_client.model.json_api_automation_out_relationships import JsonApiAutomationOutRelationships -from gooddata_api_client.model.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults -from gooddata_api_client.model.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks -from gooddata_api_client.model.json_api_automation_patch import JsonApiAutomationPatch -from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument -from gooddata_api_client.model.json_api_automation_result_linkage import JsonApiAutomationResultLinkage -from gooddata_api_client.model.json_api_automation_result_out import JsonApiAutomationResultOut -from gooddata_api_client.model.json_api_automation_result_out_attributes import JsonApiAutomationResultOutAttributes -from gooddata_api_client.model.json_api_automation_result_out_relationships import JsonApiAutomationResultOutRelationships -from gooddata_api_client.model.json_api_automation_result_out_relationships_automation import JsonApiAutomationResultOutRelationshipsAutomation -from gooddata_api_client.model.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks -from gooddata_api_client.model.json_api_automation_result_to_many_linkage import JsonApiAutomationResultToManyLinkage -from gooddata_api_client.model.json_api_automation_to_one_linkage import JsonApiAutomationToOneLinkage -from gooddata_api_client.model.json_api_color_palette_in import JsonApiColorPaletteIn -from gooddata_api_client.model.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out import JsonApiColorPaletteOut -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList -from gooddata_api_client.model.json_api_color_palette_out_with_links import JsonApiColorPaletteOutWithLinks -from gooddata_api_client.model.json_api_color_palette_patch import JsonApiColorPalettePatch -from gooddata_api_client.model.json_api_color_palette_patch_attributes import JsonApiColorPalettePatchAttributes -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_in import JsonApiCookieSecurityConfigurationIn -from gooddata_api_client.model.json_api_cookie_security_configuration_in_attributes import JsonApiCookieSecurityConfigurationInAttributes -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out import JsonApiCookieSecurityConfigurationOut -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch import JsonApiCookieSecurityConfigurationPatch -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument -from gooddata_api_client.model.json_api_csp_directive_in import JsonApiCspDirectiveIn -from gooddata_api_client.model.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument -from gooddata_api_client.model.json_api_csp_directive_out import JsonApiCspDirectiveOut -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList -from gooddata_api_client.model.json_api_csp_directive_out_with_links import JsonApiCspDirectiveOutWithLinks -from gooddata_api_client.model.json_api_csp_directive_patch import JsonApiCspDirectivePatch -from gooddata_api_client.model.json_api_csp_directive_patch_attributes import JsonApiCspDirectivePatchAttributes -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_in import JsonApiCustomApplicationSettingIn -from gooddata_api_client.model.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out import JsonApiCustomApplicationSettingOut -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList -from gooddata_api_client.model.json_api_custom_application_setting_out_with_links import JsonApiCustomApplicationSettingOutWithLinks -from gooddata_api_client.model.json_api_custom_application_setting_patch import JsonApiCustomApplicationSettingPatch -from gooddata_api_client.model.json_api_custom_application_setting_patch_attributes import JsonApiCustomApplicationSettingPatchAttributes -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id import JsonApiCustomApplicationSettingPostOptionalId -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in import JsonApiDashboardPluginIn -from gooddata_api_client.model.json_api_dashboard_plugin_in_attributes import JsonApiDashboardPluginInAttributes -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument -from gooddata_api_client.model.json_api_dashboard_plugin_linkage import JsonApiDashboardPluginLinkage -from gooddata_api_client.model.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut -from gooddata_api_client.model.json_api_dashboard_plugin_out_attributes import JsonApiDashboardPluginOutAttributes -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList -from gooddata_api_client.model.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships -from gooddata_api_client.model.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks -from gooddata_api_client.model.json_api_dashboard_plugin_patch import JsonApiDashboardPluginPatch -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id import JsonApiDashboardPluginPostOptionalId -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_to_many_linkage import JsonApiDashboardPluginToManyLinkage -from gooddata_api_client.model.json_api_data_source_identifier_out import JsonApiDataSourceIdentifierOut -from gooddata_api_client.model.json_api_data_source_identifier_out_attributes import JsonApiDataSourceIdentifierOutAttributes -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList -from gooddata_api_client.model.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta -from gooddata_api_client.model.json_api_data_source_identifier_out_with_links import JsonApiDataSourceIdentifierOutWithLinks -from gooddata_api_client.model.json_api_data_source_in import JsonApiDataSourceIn -from gooddata_api_client.model.json_api_data_source_in_attributes import JsonApiDataSourceInAttributes -from gooddata_api_client.model.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out import JsonApiDataSourceOut -from gooddata_api_client.model.json_api_data_source_out_attributes import JsonApiDataSourceOutAttributes -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList -from gooddata_api_client.model.json_api_data_source_out_with_links import JsonApiDataSourceOutWithLinks -from gooddata_api_client.model.json_api_data_source_patch import JsonApiDataSourcePatch -from gooddata_api_client.model.json_api_data_source_patch_attributes import JsonApiDataSourcePatchAttributes -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_dataset_linkage import JsonApiDatasetLinkage -from gooddata_api_client.model.json_api_dataset_out import JsonApiDatasetOut -from gooddata_api_client.model.json_api_dataset_out_attributes import JsonApiDatasetOutAttributes -from gooddata_api_client.model.json_api_dataset_out_attributes_grain_inner import JsonApiDatasetOutAttributesGrainInner -from gooddata_api_client.model.json_api_dataset_out_attributes_reference_properties_inner import JsonApiDatasetOutAttributesReferencePropertiesInner -from gooddata_api_client.model.json_api_dataset_out_attributes_sql import JsonApiDatasetOutAttributesSql -from gooddata_api_client.model.json_api_dataset_out_attributes_workspace_data_filter_columns_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner -from gooddata_api_client.model.json_api_dataset_out_attributes_workspace_data_filter_references_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument -from gooddata_api_client.model.json_api_dataset_out_includes import JsonApiDatasetOutIncludes -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList -from gooddata_api_client.model.json_api_dataset_out_relationships import JsonApiDatasetOutRelationships -from gooddata_api_client.model.json_api_dataset_out_relationships_aggregated_facts import JsonApiDatasetOutRelationshipsAggregatedFacts -from gooddata_api_client.model.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts -from gooddata_api_client.model.json_api_dataset_out_relationships_workspace_data_filters import JsonApiDatasetOutRelationshipsWorkspaceDataFilters -from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks -from gooddata_api_client.model.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage -from gooddata_api_client.model.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage -from gooddata_api_client.model.json_api_entitlement_out import JsonApiEntitlementOut -from gooddata_api_client.model.json_api_entitlement_out_attributes import JsonApiEntitlementOutAttributes -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList -from gooddata_api_client.model.json_api_entitlement_out_with_links import JsonApiEntitlementOutWithLinks -from gooddata_api_client.model.json_api_export_definition_in import JsonApiExportDefinitionIn -from gooddata_api_client.model.json_api_export_definition_in_attributes import JsonApiExportDefinitionInAttributes -from gooddata_api_client.model.json_api_export_definition_in_attributes_request_payload import JsonApiExportDefinitionInAttributesRequestPayload -from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument -from gooddata_api_client.model.json_api_export_definition_in_relationships import JsonApiExportDefinitionInRelationships -from gooddata_api_client.model.json_api_export_definition_in_relationships_visualization_object import JsonApiExportDefinitionInRelationshipsVisualizationObject -from gooddata_api_client.model.json_api_export_definition_linkage import JsonApiExportDefinitionLinkage -from gooddata_api_client.model.json_api_export_definition_out import JsonApiExportDefinitionOut -from gooddata_api_client.model.json_api_export_definition_out_attributes import JsonApiExportDefinitionOutAttributes -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_out_includes import JsonApiExportDefinitionOutIncludes -from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList -from gooddata_api_client.model.json_api_export_definition_out_relationships import JsonApiExportDefinitionOutRelationships -from gooddata_api_client.model.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks -from gooddata_api_client.model.json_api_export_definition_patch import JsonApiExportDefinitionPatch -from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument -from gooddata_api_client.model.json_api_export_definition_post_optional_id import JsonApiExportDefinitionPostOptionalId -from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument -from gooddata_api_client.model.json_api_export_definition_to_many_linkage import JsonApiExportDefinitionToManyLinkage -from gooddata_api_client.model.json_api_export_template_in import JsonApiExportTemplateIn -from gooddata_api_client.model.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes -from gooddata_api_client.model.json_api_export_template_in_attributes_dashboard_slides_template import JsonApiExportTemplateInAttributesDashboardSlidesTemplate -from gooddata_api_client.model.json_api_export_template_in_attributes_widget_slides_template import JsonApiExportTemplateInAttributesWidgetSlidesTemplate -from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument -from gooddata_api_client.model.json_api_export_template_out import JsonApiExportTemplateOut -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument -from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList -from gooddata_api_client.model.json_api_export_template_out_with_links import JsonApiExportTemplateOutWithLinks -from gooddata_api_client.model.json_api_export_template_patch import JsonApiExportTemplatePatch -from gooddata_api_client.model.json_api_export_template_patch_attributes import JsonApiExportTemplatePatchAttributes -from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument -from gooddata_api_client.model.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId -from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument -from gooddata_api_client.model.json_api_fact_linkage import JsonApiFactLinkage -from gooddata_api_client.model.json_api_fact_out import JsonApiFactOut -from gooddata_api_client.model.json_api_fact_out_attributes import JsonApiFactOutAttributes -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList -from gooddata_api_client.model.json_api_fact_out_relationships import JsonApiFactOutRelationships -from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks -from gooddata_api_client.model.json_api_fact_to_many_linkage import JsonApiFactToManyLinkage -from gooddata_api_client.model.json_api_fact_to_one_linkage import JsonApiFactToOneLinkage -from gooddata_api_client.model.json_api_filter_context_in import JsonApiFilterContextIn -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_linkage import JsonApiFilterContextLinkage -from gooddata_api_client.model.json_api_filter_context_out import JsonApiFilterContextOut -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument -from gooddata_api_client.model.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList -from gooddata_api_client.model.json_api_filter_context_out_relationships import JsonApiFilterContextOutRelationships -from gooddata_api_client.model.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks -from gooddata_api_client.model.json_api_filter_context_patch import JsonApiFilterContextPatch -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_post_optional_id import JsonApiFilterContextPostOptionalId -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_context_to_many_linkage import JsonApiFilterContextToManyLinkage -from gooddata_api_client.model.json_api_filter_view_in import JsonApiFilterViewIn -from gooddata_api_client.model.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships -from gooddata_api_client.model.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser -from gooddata_api_client.model.json_api_filter_view_out import JsonApiFilterViewOut -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument -from gooddata_api_client.model.json_api_filter_view_out_includes import JsonApiFilterViewOutIncludes -from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList -from gooddata_api_client.model.json_api_filter_view_out_with_links import JsonApiFilterViewOutWithLinks -from gooddata_api_client.model.json_api_filter_view_patch import JsonApiFilterViewPatch -from gooddata_api_client.model.json_api_filter_view_patch_attributes import JsonApiFilterViewPatchAttributes -from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument -from gooddata_api_client.model.json_api_identity_provider_in import JsonApiIdentityProviderIn -from gooddata_api_client.model.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument -from gooddata_api_client.model.json_api_identity_provider_linkage import JsonApiIdentityProviderLinkage -from gooddata_api_client.model.json_api_identity_provider_out import JsonApiIdentityProviderOut -from gooddata_api_client.model.json_api_identity_provider_out_attributes import JsonApiIdentityProviderOutAttributes -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList -from gooddata_api_client.model.json_api_identity_provider_out_with_links import JsonApiIdentityProviderOutWithLinks -from gooddata_api_client.model.json_api_identity_provider_patch import JsonApiIdentityProviderPatch -from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument -from gooddata_api_client.model.json_api_identity_provider_to_one_linkage import JsonApiIdentityProviderToOneLinkage -from gooddata_api_client.model.json_api_jwk_in import JsonApiJwkIn -from gooddata_api_client.model.json_api_jwk_in_attributes import JsonApiJwkInAttributes -from gooddata_api_client.model.json_api_jwk_in_attributes_content import JsonApiJwkInAttributesContent -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out import JsonApiJwkOut -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument -from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList -from gooddata_api_client.model.json_api_jwk_out_with_links import JsonApiJwkOutWithLinks -from gooddata_api_client.model.json_api_jwk_patch import JsonApiJwkPatch -from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument -from gooddata_api_client.model.json_api_label_linkage import JsonApiLabelLinkage -from gooddata_api_client.model.json_api_label_out import JsonApiLabelOut -from gooddata_api_client.model.json_api_label_out_attributes import JsonApiLabelOutAttributes -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList -from gooddata_api_client.model.json_api_label_out_relationships import JsonApiLabelOutRelationships -from gooddata_api_client.model.json_api_label_out_relationships_attribute import JsonApiLabelOutRelationshipsAttribute -from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks -from gooddata_api_client.model.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage -from gooddata_api_client.model.json_api_label_to_one_linkage import JsonApiLabelToOneLinkage -from gooddata_api_client.model.json_api_llm_endpoint_in import JsonApiLlmEndpointIn -from gooddata_api_client.model.json_api_llm_endpoint_in_attributes import JsonApiLlmEndpointInAttributes -from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument -from gooddata_api_client.model.json_api_llm_endpoint_out import JsonApiLlmEndpointOut -from gooddata_api_client.model.json_api_llm_endpoint_out_attributes import JsonApiLlmEndpointOutAttributes -from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument -from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList -from gooddata_api_client.model.json_api_llm_endpoint_out_with_links import JsonApiLlmEndpointOutWithLinks -from gooddata_api_client.model.json_api_llm_endpoint_patch import JsonApiLlmEndpointPatch -from gooddata_api_client.model.json_api_llm_endpoint_patch_attributes import JsonApiLlmEndpointPatchAttributes -from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument -from gooddata_api_client.model.json_api_metric_in import JsonApiMetricIn -from gooddata_api_client.model.json_api_metric_in_attributes import JsonApiMetricInAttributes -from gooddata_api_client.model.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_linkage import JsonApiMetricLinkage -from gooddata_api_client.model.json_api_metric_out import JsonApiMetricOut -from gooddata_api_client.model.json_api_metric_out_attributes import JsonApiMetricOutAttributes -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument -from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList -from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships -from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks -from gooddata_api_client.model.json_api_metric_patch import JsonApiMetricPatch -from gooddata_api_client.model.json_api_metric_patch_attributes import JsonApiMetricPatchAttributes -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_post_optional_id import JsonApiMetricPostOptionalId -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_metric_to_many_linkage import JsonApiMetricToManyLinkage -from gooddata_api_client.model.json_api_notification_channel_identifier_out import JsonApiNotificationChannelIdentifierOut -from gooddata_api_client.model.json_api_notification_channel_identifier_out_attributes import JsonApiNotificationChannelIdentifierOutAttributes -from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument -from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList -from gooddata_api_client.model.json_api_notification_channel_identifier_out_with_links import JsonApiNotificationChannelIdentifierOutWithLinks -from gooddata_api_client.model.json_api_notification_channel_in import JsonApiNotificationChannelIn -from gooddata_api_client.model.json_api_notification_channel_in_attributes import JsonApiNotificationChannelInAttributes -from gooddata_api_client.model.json_api_notification_channel_in_attributes_destination import JsonApiNotificationChannelInAttributesDestination -from gooddata_api_client.model.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument -from gooddata_api_client.model.json_api_notification_channel_linkage import JsonApiNotificationChannelLinkage -from gooddata_api_client.model.json_api_notification_channel_out import JsonApiNotificationChannelOut -from gooddata_api_client.model.json_api_notification_channel_out_attributes import JsonApiNotificationChannelOutAttributes -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument -from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList -from gooddata_api_client.model.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks -from gooddata_api_client.model.json_api_notification_channel_patch import JsonApiNotificationChannelPatch -from gooddata_api_client.model.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument -from gooddata_api_client.model.json_api_notification_channel_post_optional_id import JsonApiNotificationChannelPostOptionalId -from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument -from gooddata_api_client.model.json_api_notification_channel_to_one_linkage import JsonApiNotificationChannelToOneLinkage -from gooddata_api_client.model.json_api_organization_in import JsonApiOrganizationIn -from gooddata_api_client.model.json_api_organization_in_attributes import JsonApiOrganizationInAttributes -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument -from gooddata_api_client.model.json_api_organization_in_relationships import JsonApiOrganizationInRelationships -from gooddata_api_client.model.json_api_organization_in_relationships_identity_provider import JsonApiOrganizationInRelationshipsIdentityProvider -from gooddata_api_client.model.json_api_organization_out import JsonApiOrganizationOut -from gooddata_api_client.model.json_api_organization_out_attributes import JsonApiOrganizationOutAttributes -from gooddata_api_client.model.json_api_organization_out_attributes_cache_settings import JsonApiOrganizationOutAttributesCacheSettings -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_out_includes import JsonApiOrganizationOutIncludes -from gooddata_api_client.model.json_api_organization_out_meta import JsonApiOrganizationOutMeta -from gooddata_api_client.model.json_api_organization_out_relationships import JsonApiOrganizationOutRelationships -from gooddata_api_client.model.json_api_organization_out_relationships_bootstrap_user_group import JsonApiOrganizationOutRelationshipsBootstrapUserGroup -from gooddata_api_client.model.json_api_organization_patch import JsonApiOrganizationPatch -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument -from gooddata_api_client.model.json_api_organization_setting_in import JsonApiOrganizationSettingIn -from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out import JsonApiOrganizationSettingOut -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList -from gooddata_api_client.model.json_api_organization_setting_out_with_links import JsonApiOrganizationSettingOutWithLinks -from gooddata_api_client.model.json_api_organization_setting_patch import JsonApiOrganizationSettingPatch -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument -from gooddata_api_client.model.json_api_theme_in import JsonApiThemeIn -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out import JsonApiThemeOut -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList -from gooddata_api_client.model.json_api_theme_out_with_links import JsonApiThemeOutWithLinks -from gooddata_api_client.model.json_api_theme_patch import JsonApiThemePatch -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument -from gooddata_api_client.model.json_api_user_data_filter_in import JsonApiUserDataFilterIn -from gooddata_api_client.model.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument -from gooddata_api_client.model.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships -from gooddata_api_client.model.json_api_user_data_filter_out import JsonApiUserDataFilterOut -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList -from gooddata_api_client.model.json_api_user_data_filter_out_relationships import JsonApiUserDataFilterOutRelationships -from gooddata_api_client.model.json_api_user_data_filter_out_with_links import JsonApiUserDataFilterOutWithLinks -from gooddata_api_client.model.json_api_user_data_filter_patch import JsonApiUserDataFilterPatch -from gooddata_api_client.model.json_api_user_data_filter_patch_attributes import JsonApiUserDataFilterPatchAttributes -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id import JsonApiUserDataFilterPostOptionalId -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument -from gooddata_api_client.model.json_api_user_group_in import JsonApiUserGroupIn -from gooddata_api_client.model.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships -from gooddata_api_client.model.json_api_user_group_in_relationships_parents import JsonApiUserGroupInRelationshipsParents -from gooddata_api_client.model.json_api_user_group_linkage import JsonApiUserGroupLinkage -from gooddata_api_client.model.json_api_user_group_out import JsonApiUserGroupOut -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList -from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks -from gooddata_api_client.model.json_api_user_group_patch import JsonApiUserGroupPatch -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument -from gooddata_api_client.model.json_api_user_group_to_many_linkage import JsonApiUserGroupToManyLinkage -from gooddata_api_client.model.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage -from gooddata_api_client.model.json_api_user_identifier_linkage import JsonApiUserIdentifierLinkage -from gooddata_api_client.model.json_api_user_identifier_out import JsonApiUserIdentifierOut -from gooddata_api_client.model.json_api_user_identifier_out_attributes import JsonApiUserIdentifierOutAttributes -from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument -from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList -from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks -from gooddata_api_client.model.json_api_user_identifier_to_one_linkage import JsonApiUserIdentifierToOneLinkage -from gooddata_api_client.model.json_api_user_in import JsonApiUserIn -from gooddata_api_client.model.json_api_user_in_attributes import JsonApiUserInAttributes -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_in_relationships import JsonApiUserInRelationships -from gooddata_api_client.model.json_api_user_linkage import JsonApiUserLinkage -from gooddata_api_client.model.json_api_user_out import JsonApiUserOut -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList -from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks -from gooddata_api_client.model.json_api_user_patch import JsonApiUserPatch -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument -from gooddata_api_client.model.json_api_user_setting_in import JsonApiUserSettingIn -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument -from gooddata_api_client.model.json_api_user_setting_out import JsonApiUserSettingOut -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList -from gooddata_api_client.model.json_api_user_setting_out_with_links import JsonApiUserSettingOutWithLinks -from gooddata_api_client.model.json_api_user_to_many_linkage import JsonApiUserToManyLinkage -from gooddata_api_client.model.json_api_user_to_one_linkage import JsonApiUserToOneLinkage -from gooddata_api_client.model.json_api_visualization_object_in import JsonApiVisualizationObjectIn -from gooddata_api_client.model.json_api_visualization_object_in_attributes import JsonApiVisualizationObjectInAttributes -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument -from gooddata_api_client.model.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage -from gooddata_api_client.model.json_api_visualization_object_out import JsonApiVisualizationObjectOut -from gooddata_api_client.model.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList -from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks -from gooddata_api_client.model.json_api_visualization_object_patch import JsonApiVisualizationObjectPatch -from gooddata_api_client.model.json_api_visualization_object_patch_attributes import JsonApiVisualizationObjectPatchAttributes -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id import JsonApiVisualizationObjectPostOptionalId -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument -from gooddata_api_client.model.json_api_visualization_object_to_many_linkage import JsonApiVisualizationObjectToManyLinkage -from gooddata_api_client.model.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage -from gooddata_api_client.model.json_api_workspace_automation_out import JsonApiWorkspaceAutomationOut -from gooddata_api_client.model.json_api_workspace_automation_out_includes import JsonApiWorkspaceAutomationOutIncludes -from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList -from gooddata_api_client.model.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships -from gooddata_api_client.model.json_api_workspace_automation_out_relationships_workspace import JsonApiWorkspaceAutomationOutRelationshipsWorkspace -from gooddata_api_client.model.json_api_workspace_automation_out_with_links import JsonApiWorkspaceAutomationOutWithLinks -from gooddata_api_client.model.json_api_workspace_data_filter_in import JsonApiWorkspaceDataFilterIn -from gooddata_api_client.model.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships -from gooddata_api_client.model.json_api_workspace_data_filter_in_relationships_filter_settings import JsonApiWorkspaceDataFilterInRelationshipsFilterSettings -from gooddata_api_client.model.json_api_workspace_data_filter_linkage import JsonApiWorkspaceDataFilterLinkage -from gooddata_api_client.model.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList -from gooddata_api_client.model.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks -from gooddata_api_client.model.json_api_workspace_data_filter_patch import JsonApiWorkspaceDataFilterPatch -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in import JsonApiWorkspaceDataFilterSettingIn -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter import JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter -from gooddata_api_client.model.json_api_workspace_data_filter_setting_linkage import JsonApiWorkspaceDataFilterSettingLinkage -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks -from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch import JsonApiWorkspaceDataFilterSettingPatch -from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_to_many_linkage import JsonApiWorkspaceDataFilterSettingToManyLinkage -from gooddata_api_client.model.json_api_workspace_data_filter_to_many_linkage import JsonApiWorkspaceDataFilterToManyLinkage -from gooddata_api_client.model.json_api_workspace_data_filter_to_one_linkage import JsonApiWorkspaceDataFilterToOneLinkage -from gooddata_api_client.model.json_api_workspace_in import JsonApiWorkspaceIn -from gooddata_api_client.model.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes -from gooddata_api_client.model.json_api_workspace_in_attributes_data_source import JsonApiWorkspaceInAttributesDataSource -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument -from gooddata_api_client.model.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships -from gooddata_api_client.model.json_api_workspace_linkage import JsonApiWorkspaceLinkage -from gooddata_api_client.model.json_api_workspace_out import JsonApiWorkspaceOut -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList -from gooddata_api_client.model.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta -from gooddata_api_client.model.json_api_workspace_out_meta_config import JsonApiWorkspaceOutMetaConfig -from gooddata_api_client.model.json_api_workspace_out_meta_data_model import JsonApiWorkspaceOutMetaDataModel -from gooddata_api_client.model.json_api_workspace_out_meta_hierarchy import JsonApiWorkspaceOutMetaHierarchy -from gooddata_api_client.model.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks -from gooddata_api_client.model.json_api_workspace_patch import JsonApiWorkspacePatch -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument -from gooddata_api_client.model.json_api_workspace_setting_in import JsonApiWorkspaceSettingIn -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList -from gooddata_api_client.model.json_api_workspace_setting_out_with_links import JsonApiWorkspaceSettingOutWithLinks -from gooddata_api_client.model.json_api_workspace_setting_patch import JsonApiWorkspaceSettingPatch -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id import JsonApiWorkspaceSettingPostOptionalId -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage -from gooddata_api_client.model.json_node import JsonNode -from gooddata_api_client.model.key_drivers_dimension import KeyDriversDimension -from gooddata_api_client.model.key_drivers_request import KeyDriversRequest -from gooddata_api_client.model.key_drivers_response import KeyDriversResponse -from gooddata_api_client.model.key_drivers_result import KeyDriversResult -from gooddata_api_client.model.label_identifier import LabelIdentifier -from gooddata_api_client.model.list_links import ListLinks -from gooddata_api_client.model.list_links_all_of import ListLinksAllOf -from gooddata_api_client.model.local_identifier import LocalIdentifier -from gooddata_api_client.model.locale_request import LocaleRequest -from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner -from gooddata_api_client.model.measure_definition import MeasureDefinition -from gooddata_api_client.model.measure_execution_result_header import MeasureExecutionResultHeader -from gooddata_api_client.model.measure_group_headers import MeasureGroupHeaders -from gooddata_api_client.model.measure_header import MeasureHeader -from gooddata_api_client.model.measure_item import MeasureItem -from gooddata_api_client.model.measure_item_definition import MeasureItemDefinition -from gooddata_api_client.model.measure_result_header import MeasureResultHeader -from gooddata_api_client.model.measure_value_filter import MeasureValueFilter -from gooddata_api_client.model.memory_item import MemoryItem -from gooddata_api_client.model.memory_item_use_cases import MemoryItemUseCases -from gooddata_api_client.model.metric import Metric -from gooddata_api_client.model.metric_record import MetricRecord -from gooddata_api_client.model.negative_attribute_filter import NegativeAttributeFilter -from gooddata_api_client.model.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter -from gooddata_api_client.model.note import Note -from gooddata_api_client.model.notes import Notes -from gooddata_api_client.model.notification import Notification -from gooddata_api_client.model.notification_channel_destination import NotificationChannelDestination -from gooddata_api_client.model.notification_content import NotificationContent -from gooddata_api_client.model.notification_data import NotificationData -from gooddata_api_client.model.notification_filter import NotificationFilter -from gooddata_api_client.model.notifications import Notifications -from gooddata_api_client.model.notifications_meta import NotificationsMeta -from gooddata_api_client.model.notifications_meta_total import NotificationsMetaTotal -from gooddata_api_client.model.object_links import ObjectLinks -from gooddata_api_client.model.object_links_container import ObjectLinksContainer -from gooddata_api_client.model.organization_automation_identifier import OrganizationAutomationIdentifier -from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest -from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment -from gooddata_api_client.model.over import Over -from gooddata_api_client.model.page_metadata import PageMetadata -from gooddata_api_client.model.paging import Paging -from gooddata_api_client.model.parameter import Parameter -from gooddata_api_client.model.pdf_table_style import PdfTableStyle -from gooddata_api_client.model.pdf_table_style_property import PdfTableStyleProperty -from gooddata_api_client.model.pdm_ldm_request import PdmLdmRequest -from gooddata_api_client.model.pdm_sql import PdmSql -from gooddata_api_client.model.permissions_assignment import PermissionsAssignment -from gooddata_api_client.model.permissions_for_assignee import PermissionsForAssignee -from gooddata_api_client.model.permissions_for_assignee_all_of import PermissionsForAssigneeAllOf -from gooddata_api_client.model.permissions_for_assignee_rule import PermissionsForAssigneeRule -from gooddata_api_client.model.platform_usage import PlatformUsage -from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest -from gooddata_api_client.model.pop_dataset import PopDataset -from gooddata_api_client.model.pop_dataset_measure_definition import PopDatasetMeasureDefinition -from gooddata_api_client.model.pop_dataset_measure_definition_previous_period_measure import PopDatasetMeasureDefinitionPreviousPeriodMeasure -from gooddata_api_client.model.pop_date import PopDate -from gooddata_api_client.model.pop_date_measure_definition import PopDateMeasureDefinition -from gooddata_api_client.model.pop_date_measure_definition_over_period_measure import PopDateMeasureDefinitionOverPeriodMeasure -from gooddata_api_client.model.pop_measure_definition import PopMeasureDefinition -from gooddata_api_client.model.positive_attribute_filter import PositiveAttributeFilter -from gooddata_api_client.model.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter -from gooddata_api_client.model.quality_issue import QualityIssue -from gooddata_api_client.model.quality_issue_object import QualityIssueObject -from gooddata_api_client.model.range import Range -from gooddata_api_client.model.range_measure_value_filter import RangeMeasureValueFilter -from gooddata_api_client.model.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter -from gooddata_api_client.model.range_wrapper import RangeWrapper -from gooddata_api_client.model.ranking_filter import RankingFilter -from gooddata_api_client.model.ranking_filter_ranking_filter import RankingFilterRankingFilter -from gooddata_api_client.model.raw_custom_label import RawCustomLabel -from gooddata_api_client.model.raw_custom_metric import RawCustomMetric -from gooddata_api_client.model.raw_custom_override import RawCustomOverride -from gooddata_api_client.model.raw_export_automation_request import RawExportAutomationRequest -from gooddata_api_client.model.raw_export_request import RawExportRequest -from gooddata_api_client.model.reference_identifier import ReferenceIdentifier -from gooddata_api_client.model.reference_source_column import ReferenceSourceColumn -from gooddata_api_client.model.relative import Relative -from gooddata_api_client.model.relative_bounded_date_filter import RelativeBoundedDateFilter -from gooddata_api_client.model.relative_date_filter import RelativeDateFilter -from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter -from gooddata_api_client.model.relative_wrapper import RelativeWrapper -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest -from gooddata_api_client.model.resolved_llm_endpoint import ResolvedLlmEndpoint -from gooddata_api_client.model.resolved_llm_endpoints import ResolvedLlmEndpoints -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.rest_api_identifier import RestApiIdentifier -from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata -from gooddata_api_client.model.result_dimension import ResultDimension -from gooddata_api_client.model.result_dimension_header import ResultDimensionHeader -from gooddata_api_client.model.result_spec import ResultSpec -from gooddata_api_client.model.route_result import RouteResult -from gooddata_api_client.model.rsa_specification import RsaSpecification -from gooddata_api_client.model.rule_permission import RulePermission -from gooddata_api_client.model.running_section import RunningSection -from gooddata_api_client.model.saved_visualization import SavedVisualization -from gooddata_api_client.model.scan_request import ScanRequest -from gooddata_api_client.model.scan_result_pdm import ScanResultPdm -from gooddata_api_client.model.scan_sql_request import ScanSqlRequest -from gooddata_api_client.model.scan_sql_response import ScanSqlResponse -from gooddata_api_client.model.search_relationship_object import SearchRelationshipObject -from gooddata_api_client.model.search_request import SearchRequest -from gooddata_api_client.model.search_result import SearchResult -from gooddata_api_client.model.search_result_object import SearchResultObject -from gooddata_api_client.model.section_slide_template import SectionSlideTemplate -from gooddata_api_client.model.settings import Settings -from gooddata_api_client.model.simple_measure_definition import SimpleMeasureDefinition -from gooddata_api_client.model.simple_measure_definition_measure import SimpleMeasureDefinitionMeasure -from gooddata_api_client.model.skeleton import Skeleton -from gooddata_api_client.model.slides_export_request import SlidesExportRequest -from gooddata_api_client.model.smart_function_response import SmartFunctionResponse -from gooddata_api_client.model.smtp import Smtp -from gooddata_api_client.model.smtp_all_of import SmtpAllOf -from gooddata_api_client.model.sort_key import SortKey -from gooddata_api_client.model.sort_key_attribute import SortKeyAttribute -from gooddata_api_client.model.sort_key_attribute_attribute import SortKeyAttributeAttribute -from gooddata_api_client.model.sort_key_total import SortKeyTotal -from gooddata_api_client.model.sort_key_total_total import SortKeyTotalTotal -from gooddata_api_client.model.sort_key_value import SortKeyValue -from gooddata_api_client.model.sort_key_value_value import SortKeyValueValue -from gooddata_api_client.model.sql_column import SqlColumn -from gooddata_api_client.model.sql_query import SqlQuery -from gooddata_api_client.model.sql_query_all_of import SqlQueryAllOf -from gooddata_api_client.model.suggestion import Suggestion -from gooddata_api_client.model.switch_identity_provider_request import SwitchIdentityProviderRequest -from gooddata_api_client.model.table import Table -from gooddata_api_client.model.table_all_of import TableAllOf -from gooddata_api_client.model.table_override import TableOverride -from gooddata_api_client.model.table_warning import TableWarning -from gooddata_api_client.model.tabular_export_request import TabularExportRequest -from gooddata_api_client.model.test_definition_request import TestDefinitionRequest -from gooddata_api_client.model.test_destination_request import TestDestinationRequest -from gooddata_api_client.model.test_notification import TestNotification -from gooddata_api_client.model.test_notification_all_of import TestNotificationAllOf -from gooddata_api_client.model.test_query_duration import TestQueryDuration -from gooddata_api_client.model.test_request import TestRequest -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.total import Total -from gooddata_api_client.model.total_dimension import TotalDimension -from gooddata_api_client.model.total_execution_result_header import TotalExecutionResultHeader -from gooddata_api_client.model.total_result_header import TotalResultHeader -from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest -from gooddata_api_client.model.user_assignee import UserAssignee -from gooddata_api_client.model.user_context import UserContext -from gooddata_api_client.model.user_group_assignee import UserGroupAssignee -from gooddata_api_client.model.user_group_identifier import UserGroupIdentifier -from gooddata_api_client.model.user_group_permission import UserGroupPermission -from gooddata_api_client.model.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment -from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments -from gooddata_api_client.model.user_management_user_group_member import UserManagementUserGroupMember -from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers -from gooddata_api_client.model.user_management_user_groups import UserManagementUserGroups -from gooddata_api_client.model.user_management_user_groups_item import UserManagementUserGroupsItem -from gooddata_api_client.model.user_management_users import UserManagementUsers -from gooddata_api_client.model.user_management_users_item import UserManagementUsersItem -from gooddata_api_client.model.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment -from gooddata_api_client.model.user_permission import UserPermission -from gooddata_api_client.model.validate_by_item import ValidateByItem -from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest -from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest -from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse -from gooddata_api_client.model.value import Value -from gooddata_api_client.model.visible_filter import VisibleFilter -from gooddata_api_client.model.visual_export_request import VisualExportRequest -from gooddata_api_client.model.webhook import Webhook -from gooddata_api_client.model.webhook_all_of import WebhookAllOf -from gooddata_api_client.model.webhook_automation_info import WebhookAutomationInfo -from gooddata_api_client.model.webhook_message import WebhookMessage -from gooddata_api_client.model.webhook_message_data import WebhookMessageData -from gooddata_api_client.model.webhook_recipient import WebhookRecipient -from gooddata_api_client.model.widget_slides_template import WidgetSlidesTemplate -from gooddata_api_client.model.workspace_automation_identifier import WorkspaceAutomationIdentifier -from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest -from gooddata_api_client.model.workspace_data_source import WorkspaceDataSource -from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier -from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment -from gooddata_api_client.model.workspace_user import WorkspaceUser -from gooddata_api_client.model.workspace_user_group import WorkspaceUserGroup -from gooddata_api_client.model.workspace_user_groups import WorkspaceUserGroups -from gooddata_api_client.model.workspace_users import WorkspaceUsers -from gooddata_api_client.model.xliff import Xliff +# import models into model package +from gooddata_api_client.models.afm import AFM +from gooddata_api_client.models.afm_filters_inner import AFMFiltersInner +from gooddata_api_client.models.absolute_date_filter import AbsoluteDateFilter +from gooddata_api_client.models.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter +from gooddata_api_client.models.abstract_measure_value_filter import AbstractMeasureValueFilter +from gooddata_api_client.models.active_object_identification import ActiveObjectIdentification +from gooddata_api_client.models.ad_hoc_automation import AdHocAutomation +from gooddata_api_client.models.afm_cancel_tokens import AfmCancelTokens +from gooddata_api_client.models.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution_response import AfmExecutionResponse +from gooddata_api_client.models.afm_identifier import AfmIdentifier +from gooddata_api_client.models.afm_local_identifier import AfmLocalIdentifier +from gooddata_api_client.models.afm_object_identifier import AfmObjectIdentifier +from gooddata_api_client.models.afm_object_identifier_attribute import AfmObjectIdentifierAttribute +from gooddata_api_client.models.afm_object_identifier_attribute_identifier import AfmObjectIdentifierAttributeIdentifier +from gooddata_api_client.models.afm_object_identifier_core import AfmObjectIdentifierCore +from gooddata_api_client.models.afm_object_identifier_core_identifier import AfmObjectIdentifierCoreIdentifier +from gooddata_api_client.models.afm_object_identifier_dataset import AfmObjectIdentifierDataset +from gooddata_api_client.models.afm_object_identifier_dataset_identifier import AfmObjectIdentifierDatasetIdentifier +from gooddata_api_client.models.afm_object_identifier_identifier import AfmObjectIdentifierIdentifier +from gooddata_api_client.models.afm_object_identifier_label import AfmObjectIdentifierLabel +from gooddata_api_client.models.afm_object_identifier_label_identifier import AfmObjectIdentifierLabelIdentifier +from gooddata_api_client.models.afm_valid_descendants_query import AfmValidDescendantsQuery +from gooddata_api_client.models.afm_valid_descendants_response import AfmValidDescendantsResponse +from gooddata_api_client.models.afm_valid_objects_query import AfmValidObjectsQuery +from gooddata_api_client.models.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.models.alert_afm import AlertAfm +from gooddata_api_client.models.alert_condition import AlertCondition +from gooddata_api_client.models.alert_condition_operand import AlertConditionOperand +from gooddata_api_client.models.alert_description import AlertDescription +from gooddata_api_client.models.alert_evaluation_row import AlertEvaluationRow +from gooddata_api_client.models.analytics_catalog_tags import AnalyticsCatalogTags +from gooddata_api_client.models.anomaly_detection_request import AnomalyDetectionRequest +from gooddata_api_client.models.anomaly_detection_result import AnomalyDetectionResult +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.models.arithmetic_measure import ArithmeticMeasure +from gooddata_api_client.models.arithmetic_measure_definition import ArithmeticMeasureDefinition +from gooddata_api_client.models.arithmetic_measure_definition_arithmetic_measure import ArithmeticMeasureDefinitionArithmeticMeasure +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.assignee_rule import AssigneeRule +from gooddata_api_client.models.attribute_elements import AttributeElements +from gooddata_api_client.models.attribute_elements_by_ref import AttributeElementsByRef +from gooddata_api_client.models.attribute_elements_by_value import AttributeElementsByValue +from gooddata_api_client.models.attribute_execution_result_header import AttributeExecutionResultHeader +from gooddata_api_client.models.attribute_filter import AttributeFilter +from gooddata_api_client.models.attribute_filter_by_date import AttributeFilterByDate +from gooddata_api_client.models.attribute_filter_elements import AttributeFilterElements +from gooddata_api_client.models.attribute_filter_parent import AttributeFilterParent +from gooddata_api_client.models.attribute_format import AttributeFormat +from gooddata_api_client.models.attribute_header import AttributeHeader +from gooddata_api_client.models.attribute_header_attribute_header import AttributeHeaderAttributeHeader +from gooddata_api_client.models.attribute_item import AttributeItem +from gooddata_api_client.models.attribute_negative_filter import AttributeNegativeFilter +from gooddata_api_client.models.attribute_positive_filter import AttributePositiveFilter +from gooddata_api_client.models.attribute_result_header import AttributeResultHeader +from gooddata_api_client.models.automation_alert import AutomationAlert +from gooddata_api_client.models.automation_alert_condition import AutomationAlertCondition +from gooddata_api_client.models.automation_dashboard_tabular_export import AutomationDashboardTabularExport +from gooddata_api_client.models.automation_external_recipient import AutomationExternalRecipient +from gooddata_api_client.models.automation_image_export import AutomationImageExport +from gooddata_api_client.models.automation_metadata import AutomationMetadata +from gooddata_api_client.models.automation_notification import AutomationNotification +from gooddata_api_client.models.automation_raw_export import AutomationRawExport +from gooddata_api_client.models.automation_schedule import AutomationSchedule +from gooddata_api_client.models.automation_slides_export import AutomationSlidesExport +from gooddata_api_client.models.automation_tabular_export import AutomationTabularExport +from gooddata_api_client.models.automation_visual_export import AutomationVisualExport +from gooddata_api_client.models.available_assignees import AvailableAssignees +from gooddata_api_client.models.bounded_filter import BoundedFilter +from gooddata_api_client.models.chat_history_interaction import ChatHistoryInteraction +from gooddata_api_client.models.chat_history_request import ChatHistoryRequest +from gooddata_api_client.models.chat_history_result import ChatHistoryResult +from gooddata_api_client.models.chat_request import ChatRequest +from gooddata_api_client.models.chat_result import ChatResult +from gooddata_api_client.models.chat_usage_response import ChatUsageResponse +from gooddata_api_client.models.clustering_request import ClusteringRequest +from gooddata_api_client.models.clustering_result import ClusteringResult +from gooddata_api_client.models.column_override import ColumnOverride +from gooddata_api_client.models.column_statistic import ColumnStatistic +from gooddata_api_client.models.column_statistic_warning import ColumnStatisticWarning +from gooddata_api_client.models.column_statistics_request import ColumnStatisticsRequest +from gooddata_api_client.models.column_statistics_request_from import ColumnStatisticsRequestFrom +from gooddata_api_client.models.column_statistics_response import ColumnStatisticsResponse +from gooddata_api_client.models.column_warning import ColumnWarning +from gooddata_api_client.models.comparison import Comparison +from gooddata_api_client.models.comparison_measure_value_filter import ComparisonMeasureValueFilter +from gooddata_api_client.models.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter +from gooddata_api_client.models.comparison_wrapper import ComparisonWrapper +from gooddata_api_client.models.content_slide_template import ContentSlideTemplate +from gooddata_api_client.models.cover_slide_template import CoverSlideTemplate +from gooddata_api_client.models.created_visualization import CreatedVisualization +from gooddata_api_client.models.created_visualization_filters_inner import CreatedVisualizationFiltersInner +from gooddata_api_client.models.created_visualizations import CreatedVisualizations +from gooddata_api_client.models.custom_label import CustomLabel +from gooddata_api_client.models.custom_metric import CustomMetric +from gooddata_api_client.models.custom_override import CustomOverride +from gooddata_api_client.models.dashboard_attribute_filter import DashboardAttributeFilter +from gooddata_api_client.models.dashboard_attribute_filter_attribute_filter import DashboardAttributeFilterAttributeFilter +from gooddata_api_client.models.dashboard_date_filter import DashboardDateFilter +from gooddata_api_client.models.dashboard_date_filter_date_filter import DashboardDateFilterDateFilter +from gooddata_api_client.models.dashboard_date_filter_date_filter_from import DashboardDateFilterDateFilterFrom +from gooddata_api_client.models.dashboard_export_settings import DashboardExportSettings +from gooddata_api_client.models.dashboard_filter import DashboardFilter +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions +from gooddata_api_client.models.dashboard_permissions_assignment import DashboardPermissionsAssignment +from gooddata_api_client.models.dashboard_slides_template import DashboardSlidesTemplate +from gooddata_api_client.models.dashboard_tabular_export_request import DashboardTabularExportRequest +from gooddata_api_client.models.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 +from gooddata_api_client.models.data_column_locator import DataColumnLocator +from gooddata_api_client.models.data_column_locators import DataColumnLocators +from gooddata_api_client.models.data_source_parameter import DataSourceParameter +from gooddata_api_client.models.data_source_permission_assignment import DataSourcePermissionAssignment +from gooddata_api_client.models.data_source_schemata import DataSourceSchemata +from gooddata_api_client.models.data_source_table_identifier import DataSourceTableIdentifier +from gooddata_api_client.models.dataset_grain import DatasetGrain +from gooddata_api_client.models.dataset_reference_identifier import DatasetReferenceIdentifier +from gooddata_api_client.models.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier +from gooddata_api_client.models.date_absolute_filter import DateAbsoluteFilter +from gooddata_api_client.models.date_filter import DateFilter +from gooddata_api_client.models.date_relative_filter import DateRelativeFilter +from gooddata_api_client.models.date_value import DateValue +from gooddata_api_client.models.declarative_aggregated_fact import DeclarativeAggregatedFact +from gooddata_api_client.models.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard +from gooddata_api_client.models.declarative_analytical_dashboard_extension import DeclarativeAnalyticalDashboardExtension +from gooddata_api_client.models.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier +from gooddata_api_client.models.declarative_analytical_dashboard_permission_assignment import DeclarativeAnalyticalDashboardPermissionAssignment +from gooddata_api_client.models.declarative_analytical_dashboard_permission_for_assignee import DeclarativeAnalyticalDashboardPermissionForAssignee +from gooddata_api_client.models.declarative_analytical_dashboard_permission_for_assignee_rule import DeclarativeAnalyticalDashboardPermissionForAssigneeRule +from gooddata_api_client.models.declarative_analytical_dashboard_permissions_inner import DeclarativeAnalyticalDashboardPermissionsInner +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics_layer import DeclarativeAnalyticsLayer +from gooddata_api_client.models.declarative_attribute import DeclarativeAttribute +from gooddata_api_client.models.declarative_attribute_hierarchy import DeclarativeAttributeHierarchy +from gooddata_api_client.models.declarative_automation import DeclarativeAutomation +from gooddata_api_client.models.declarative_color_palette import DeclarativeColorPalette +from gooddata_api_client.models.declarative_column import DeclarativeColumn +from gooddata_api_client.models.declarative_csp_directive import DeclarativeCspDirective +from gooddata_api_client.models.declarative_custom_application_setting import DeclarativeCustomApplicationSetting +from gooddata_api_client.models.declarative_dashboard_plugin import DeclarativeDashboardPlugin +from gooddata_api_client.models.declarative_data_source import DeclarativeDataSource +from gooddata_api_client.models.declarative_data_source_permission import DeclarativeDataSourcePermission +from gooddata_api_client.models.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_dataset import DeclarativeDataset +from gooddata_api_client.models.declarative_dataset_extension import DeclarativeDatasetExtension +from gooddata_api_client.models.declarative_dataset_sql import DeclarativeDatasetSql +from gooddata_api_client.models.declarative_date_dataset import DeclarativeDateDataset +from gooddata_api_client.models.declarative_export_definition import DeclarativeExportDefinition +from gooddata_api_client.models.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier +from gooddata_api_client.models.declarative_export_definition_request_payload import DeclarativeExportDefinitionRequestPayload +from gooddata_api_client.models.declarative_export_template import DeclarativeExportTemplate +from gooddata_api_client.models.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.models.declarative_fact import DeclarativeFact +from gooddata_api_client.models.declarative_filter_context import DeclarativeFilterContext +from gooddata_api_client.models.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.models.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.models.declarative_identity_provider_identifier import DeclarativeIdentityProviderIdentifier +from gooddata_api_client.models.declarative_jwk import DeclarativeJwk +from gooddata_api_client.models.declarative_jwk_specification import DeclarativeJwkSpecification +from gooddata_api_client.models.declarative_label import DeclarativeLabel +from gooddata_api_client.models.declarative_ldm import DeclarativeLdm +from gooddata_api_client.models.declarative_metric import DeclarativeMetric +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_notification_channel import DeclarativeNotificationChannel +from gooddata_api_client.models.declarative_notification_channel_destination import DeclarativeNotificationChannelDestination +from gooddata_api_client.models.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier +from gooddata_api_client.models.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization_info import DeclarativeOrganizationInfo +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.models.declarative_reference import DeclarativeReference +from gooddata_api_client.models.declarative_reference_source import DeclarativeReferenceSource +from gooddata_api_client.models.declarative_rsa_specification import DeclarativeRsaSpecification +from gooddata_api_client.models.declarative_setting import DeclarativeSetting +from gooddata_api_client.models.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission +from gooddata_api_client.models.declarative_source_fact_reference import DeclarativeSourceFactReference +from gooddata_api_client.models.declarative_table import DeclarativeTable +from gooddata_api_client.models.declarative_tables import DeclarativeTables +from gooddata_api_client.models.declarative_theme import DeclarativeTheme +from gooddata_api_client.models.declarative_user import DeclarativeUser +from gooddata_api_client.models.declarative_user_data_filter import DeclarativeUserDataFilter +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_group import DeclarativeUserGroup +from gooddata_api_client.models.declarative_user_group_identifier import DeclarativeUserGroupIdentifier +from gooddata_api_client.models.declarative_user_group_permission import DeclarativeUserGroupPermission +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from gooddata_api_client.models.declarative_user_permission import DeclarativeUserPermission +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_visualization_object import DeclarativeVisualizationObject +from gooddata_api_client.models.declarative_workspace import DeclarativeWorkspace +from gooddata_api_client.models.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter +from gooddata_api_client.models.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn +from gooddata_api_client.models.declarative_workspace_data_filter_references import DeclarativeWorkspaceDataFilterReferences +from gooddata_api_client.models.declarative_workspace_data_filter_setting import DeclarativeWorkspaceDataFilterSetting +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.default_smtp import DefaultSmtp +from gooddata_api_client.models.dependent_entities_graph import DependentEntitiesGraph +from gooddata_api_client.models.dependent_entities_node import DependentEntitiesNode +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.depends_on import DependsOn +from gooddata_api_client.models.depends_on_date_filter import DependsOnDateFilter +from gooddata_api_client.models.dim_attribute import DimAttribute +from gooddata_api_client.models.dimension import Dimension +from gooddata_api_client.models.dimension_header import DimensionHeader +from gooddata_api_client.models.element import Element +from gooddata_api_client.models.elements_request import ElementsRequest +from gooddata_api_client.models.elements_request_depends_on_inner import ElementsRequestDependsOnInner +from gooddata_api_client.models.elements_response import ElementsResponse +from gooddata_api_client.models.entitlements_request import EntitlementsRequest +from gooddata_api_client.models.entity_identifier import EntityIdentifier +from gooddata_api_client.models.execution_links import ExecutionLinks +from gooddata_api_client.models.execution_response import ExecutionResponse +from gooddata_api_client.models.execution_result import ExecutionResult +from gooddata_api_client.models.execution_result_data_source_message import ExecutionResultDataSourceMessage +from gooddata_api_client.models.execution_result_grand_total import ExecutionResultGrandTotal +from gooddata_api_client.models.execution_result_header import ExecutionResultHeader +from gooddata_api_client.models.execution_result_metadata import ExecutionResultMetadata +from gooddata_api_client.models.execution_result_paging import ExecutionResultPaging +from gooddata_api_client.models.execution_settings import ExecutionSettings +from gooddata_api_client.models.export_request import ExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.export_result import ExportResult +from gooddata_api_client.models.fact_identifier import FactIdentifier +from gooddata_api_client.models.file import File +from gooddata_api_client.models.filter_by import FilterBy +from gooddata_api_client.models.filter_definition import FilterDefinition +from gooddata_api_client.models.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure +from gooddata_api_client.models.forecast_request import ForecastRequest +from gooddata_api_client.models.forecast_result import ForecastResult +from gooddata_api_client.models.found_objects import FoundObjects +from gooddata_api_client.models.frequency import Frequency +from gooddata_api_client.models.frequency_bucket import FrequencyBucket +from gooddata_api_client.models.frequency_properties import FrequencyProperties +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.models.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.models.get_quality_issues_response import GetQualityIssuesResponse +from gooddata_api_client.models.grain_identifier import GrainIdentifier +from gooddata_api_client.models.granted_permission import GrantedPermission +from gooddata_api_client.models.granularities_formatting import GranularitiesFormatting +from gooddata_api_client.models.header_group import HeaderGroup +from gooddata_api_client.models.hierarchy_object_identification import HierarchyObjectIdentification +from gooddata_api_client.models.histogram import Histogram +from gooddata_api_client.models.histogram_bucket import HistogramBucket +from gooddata_api_client.models.histogram_properties import HistogramProperties +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_ref import IdentifierRef +from gooddata_api_client.models.identifier_ref_identifier import IdentifierRefIdentifier +from gooddata_api_client.models.image_export_request import ImageExportRequest +from gooddata_api_client.models.in_platform import InPlatform +from gooddata_api_client.models.inline_filter_definition import InlineFilterDefinition +from gooddata_api_client.models.inline_filter_definition_inline import InlineFilterDefinitionInline +from gooddata_api_client.models.inline_measure_definition import InlineMeasureDefinition +from gooddata_api_client.models.inline_measure_definition_inline import InlineMeasureDefinitionInline +from gooddata_api_client.models.intro_slide_template import IntroSlideTemplate +from gooddata_api_client.models.json_api_aggregated_fact_linkage import JsonApiAggregatedFactLinkage +from gooddata_api_client.models.json_api_aggregated_fact_out import JsonApiAggregatedFactOut +from gooddata_api_client.models.json_api_aggregated_fact_out_attributes import JsonApiAggregatedFactOutAttributes +from gooddata_api_client.models.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument +from gooddata_api_client.models.json_api_aggregated_fact_out_includes import JsonApiAggregatedFactOutIncludes +from gooddata_api_client.models.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_aggregated_fact_out_meta_origin import JsonApiAggregatedFactOutMetaOrigin +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships import JsonApiAggregatedFactOutRelationships +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships_dataset import JsonApiAggregatedFactOutRelationshipsDataset +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships_source_fact import JsonApiAggregatedFactOutRelationshipsSourceFact +from gooddata_api_client.models.json_api_aggregated_fact_out_with_links import JsonApiAggregatedFactOutWithLinks +from gooddata_api_client.models.json_api_analytical_dashboard_in import JsonApiAnalyticalDashboardIn +from gooddata_api_client.models.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_linkage import JsonApiAnalyticalDashboardLinkage +from gooddata_api_client.models.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut +from gooddata_api_client.models.json_api_analytical_dashboard_out_attributes import JsonApiAnalyticalDashboardOutAttributes +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_out_meta import JsonApiAnalyticalDashboardOutMeta +from gooddata_api_client.models.json_api_analytical_dashboard_out_meta_access_info import JsonApiAnalyticalDashboardOutMetaAccessInfo +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships import JsonApiAnalyticalDashboardOutRelationships +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_analytical_dashboards import JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_dashboard_plugins import JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_filter_contexts import JsonApiAnalyticalDashboardOutRelationshipsFilterContexts +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_visualization_objects import JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects +from gooddata_api_client.models.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.models.json_api_analytical_dashboard_patch import JsonApiAnalyticalDashboardPatch +from gooddata_api_client.models.json_api_analytical_dashboard_patch_attributes import JsonApiAnalyticalDashboardPatchAttributes +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id import JsonApiAnalyticalDashboardPostOptionalId +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.models.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.models.json_api_api_token_in import JsonApiApiTokenIn +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out import JsonApiApiTokenOut +from gooddata_api_client.models.json_api_api_token_out_attributes import JsonApiApiTokenOutAttributes +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_api_token_out_with_links import JsonApiApiTokenOutWithLinks +from gooddata_api_client.models.json_api_attribute_hierarchy_in import JsonApiAttributeHierarchyIn +from gooddata_api_client.models.json_api_attribute_hierarchy_in_attributes import JsonApiAttributeHierarchyInAttributes +from gooddata_api_client.models.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_linkage import JsonApiAttributeHierarchyLinkage +from gooddata_api_client.models.json_api_attribute_hierarchy_out import JsonApiAttributeHierarchyOut +from gooddata_api_client.models.json_api_attribute_hierarchy_out_attributes import JsonApiAttributeHierarchyOutAttributes +from gooddata_api_client.models.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.models.json_api_attribute_hierarchy_out_includes import JsonApiAttributeHierarchyOutIncludes +from gooddata_api_client.models.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships import JsonApiAttributeHierarchyOutRelationships +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes +from gooddata_api_client.models.json_api_attribute_hierarchy_out_with_links import JsonApiAttributeHierarchyOutWithLinks +from gooddata_api_client.models.json_api_attribute_hierarchy_patch import JsonApiAttributeHierarchyPatch +from gooddata_api_client.models.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument +from gooddata_api_client.models.json_api_attribute_linkage import JsonApiAttributeLinkage +from gooddata_api_client.models.json_api_attribute_out import JsonApiAttributeOut +from gooddata_api_client.models.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_includes import JsonApiAttributeOutIncludes +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships +from gooddata_api_client.models.json_api_attribute_out_relationships_attribute_hierarchies import JsonApiAttributeOutRelationshipsAttributeHierarchies +from gooddata_api_client.models.json_api_attribute_out_relationships_default_view import JsonApiAttributeOutRelationshipsDefaultView +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_attribute_to_one_linkage import JsonApiAttributeToOneLinkage +from gooddata_api_client.models.json_api_automation_in import JsonApiAutomationIn +from gooddata_api_client.models.json_api_automation_in_attributes import JsonApiAutomationInAttributes +from gooddata_api_client.models.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert +from gooddata_api_client.models.json_api_automation_in_attributes_dashboard_tabular_exports_inner import JsonApiAutomationInAttributesDashboardTabularExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner +from gooddata_api_client.models.json_api_automation_in_attributes_image_exports_inner import JsonApiAutomationInAttributesImageExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata +from gooddata_api_client.models.json_api_automation_in_attributes_raw_exports_inner import JsonApiAutomationInAttributesRawExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule +from gooddata_api_client.models.json_api_automation_in_attributes_slides_exports_inner import JsonApiAutomationInAttributesSlidesExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner +from gooddata_api_client.models.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.models.json_api_automation_in_relationships import JsonApiAutomationInRelationships +from gooddata_api_client.models.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard +from gooddata_api_client.models.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions +from gooddata_api_client.models.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel +from gooddata_api_client.models.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients +from gooddata_api_client.models.json_api_automation_linkage import JsonApiAutomationLinkage +from gooddata_api_client.models.json_api_automation_out import JsonApiAutomationOut +from gooddata_api_client.models.json_api_automation_out_attributes import JsonApiAutomationOutAttributes +from gooddata_api_client.models.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.models.json_api_automation_out_includes import JsonApiAutomationOutIncludes +from gooddata_api_client.models.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.models.json_api_automation_out_relationships import JsonApiAutomationOutRelationships +from gooddata_api_client.models.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults +from gooddata_api_client.models.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks +from gooddata_api_client.models.json_api_automation_patch import JsonApiAutomationPatch +from gooddata_api_client.models.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.models.json_api_automation_result_linkage import JsonApiAutomationResultLinkage +from gooddata_api_client.models.json_api_automation_result_out import JsonApiAutomationResultOut +from gooddata_api_client.models.json_api_automation_result_out_attributes import JsonApiAutomationResultOutAttributes +from gooddata_api_client.models.json_api_automation_result_out_relationships import JsonApiAutomationResultOutRelationships +from gooddata_api_client.models.json_api_automation_result_out_relationships_automation import JsonApiAutomationResultOutRelationshipsAutomation +from gooddata_api_client.models.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks +from gooddata_api_client.models.json_api_automation_to_one_linkage import JsonApiAutomationToOneLinkage +from gooddata_api_client.models.json_api_color_palette_in import JsonApiColorPaletteIn +from gooddata_api_client.models.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out import JsonApiColorPaletteOut +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_out_with_links import JsonApiColorPaletteOutWithLinks +from gooddata_api_client.models.json_api_color_palette_patch import JsonApiColorPalettePatch +from gooddata_api_client.models.json_api_color_palette_patch_attributes import JsonApiColorPalettePatchAttributes +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_in import JsonApiCookieSecurityConfigurationIn +from gooddata_api_client.models.json_api_cookie_security_configuration_in_attributes import JsonApiCookieSecurityConfigurationInAttributes +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out import JsonApiCookieSecurityConfigurationOut +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch import JsonApiCookieSecurityConfigurationPatch +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_csp_directive_in import JsonApiCspDirectiveIn +from gooddata_api_client.models.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out import JsonApiCspDirectiveOut +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_out_with_links import JsonApiCspDirectiveOutWithLinks +from gooddata_api_client.models.json_api_csp_directive_patch import JsonApiCspDirectivePatch +from gooddata_api_client.models.json_api_csp_directive_patch_attributes import JsonApiCspDirectivePatchAttributes +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_in import JsonApiCustomApplicationSettingIn +from gooddata_api_client.models.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out import JsonApiCustomApplicationSettingOut +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_out_with_links import JsonApiCustomApplicationSettingOutWithLinks +from gooddata_api_client.models.json_api_custom_application_setting_patch import JsonApiCustomApplicationSettingPatch +from gooddata_api_client.models.json_api_custom_application_setting_patch_attributes import JsonApiCustomApplicationSettingPatchAttributes +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id import JsonApiCustomApplicationSettingPostOptionalId +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in import JsonApiDashboardPluginIn +from gooddata_api_client.models.json_api_dashboard_plugin_in_attributes import JsonApiDashboardPluginInAttributes +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_linkage import JsonApiDashboardPluginLinkage +from gooddata_api_client.models.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut +from gooddata_api_client.models.json_api_dashboard_plugin_out_attributes import JsonApiDashboardPluginOutAttributes +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships +from gooddata_api_client.models.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks +from gooddata_api_client.models.json_api_dashboard_plugin_patch import JsonApiDashboardPluginPatch +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id import JsonApiDashboardPluginPostOptionalId +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.models.json_api_data_source_identifier_out import JsonApiDataSourceIdentifierOut +from gooddata_api_client.models.json_api_data_source_identifier_out_attributes import JsonApiDataSourceIdentifierOutAttributes +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta +from gooddata_api_client.models.json_api_data_source_identifier_out_with_links import JsonApiDataSourceIdentifierOutWithLinks +from gooddata_api_client.models.json_api_data_source_in import JsonApiDataSourceIn +from gooddata_api_client.models.json_api_data_source_in_attributes import JsonApiDataSourceInAttributes +from gooddata_api_client.models.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out import JsonApiDataSourceOut +from gooddata_api_client.models.json_api_data_source_out_attributes import JsonApiDataSourceOutAttributes +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_out_with_links import JsonApiDataSourceOutWithLinks +from gooddata_api_client.models.json_api_data_source_patch import JsonApiDataSourcePatch +from gooddata_api_client.models.json_api_data_source_patch_attributes import JsonApiDataSourcePatchAttributes +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.models.json_api_dataset_linkage import JsonApiDatasetLinkage +from gooddata_api_client.models.json_api_dataset_out import JsonApiDatasetOut +from gooddata_api_client.models.json_api_dataset_out_attributes import JsonApiDatasetOutAttributes +from gooddata_api_client.models.json_api_dataset_out_attributes_grain_inner import JsonApiDatasetOutAttributesGrainInner +from gooddata_api_client.models.json_api_dataset_out_attributes_reference_properties_inner import JsonApiDatasetOutAttributesReferencePropertiesInner +from gooddata_api_client.models.json_api_dataset_out_attributes_sql import JsonApiDatasetOutAttributesSql +from gooddata_api_client.models.json_api_dataset_out_attributes_workspace_data_filter_columns_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner +from gooddata_api_client.models.json_api_dataset_out_attributes_workspace_data_filter_references_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_includes import JsonApiDatasetOutIncludes +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_dataset_out_relationships import JsonApiDatasetOutRelationships +from gooddata_api_client.models.json_api_dataset_out_relationships_aggregated_facts import JsonApiDatasetOutRelationshipsAggregatedFacts +from gooddata_api_client.models.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts +from gooddata_api_client.models.json_api_dataset_out_relationships_workspace_data_filters import JsonApiDatasetOutRelationshipsWorkspaceDataFilters +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage +from gooddata_api_client.models.json_api_entitlement_out import JsonApiEntitlementOut +from gooddata_api_client.models.json_api_entitlement_out_attributes import JsonApiEntitlementOutAttributes +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_entitlement_out_with_links import JsonApiEntitlementOutWithLinks +from gooddata_api_client.models.json_api_export_definition_in import JsonApiExportDefinitionIn +from gooddata_api_client.models.json_api_export_definition_in_attributes import JsonApiExportDefinitionInAttributes +from gooddata_api_client.models.json_api_export_definition_in_attributes_request_payload import JsonApiExportDefinitionInAttributesRequestPayload +from gooddata_api_client.models.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.models.json_api_export_definition_in_relationships import JsonApiExportDefinitionInRelationships +from gooddata_api_client.models.json_api_export_definition_in_relationships_visualization_object import JsonApiExportDefinitionInRelationshipsVisualizationObject +from gooddata_api_client.models.json_api_export_definition_linkage import JsonApiExportDefinitionLinkage +from gooddata_api_client.models.json_api_export_definition_out import JsonApiExportDefinitionOut +from gooddata_api_client.models.json_api_export_definition_out_attributes import JsonApiExportDefinitionOutAttributes +from gooddata_api_client.models.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.models.json_api_export_definition_out_includes import JsonApiExportDefinitionOutIncludes +from gooddata_api_client.models.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.models.json_api_export_definition_out_relationships import JsonApiExportDefinitionOutRelationships +from gooddata_api_client.models.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks +from gooddata_api_client.models.json_api_export_definition_patch import JsonApiExportDefinitionPatch +from gooddata_api_client.models.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.models.json_api_export_definition_post_optional_id import JsonApiExportDefinitionPostOptionalId +from gooddata_api_client.models.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.models.json_api_export_template_in import JsonApiExportTemplateIn +from gooddata_api_client.models.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes +from gooddata_api_client.models.json_api_export_template_in_attributes_dashboard_slides_template import JsonApiExportTemplateInAttributesDashboardSlidesTemplate +from gooddata_api_client.models.json_api_export_template_in_attributes_widget_slides_template import JsonApiExportTemplateInAttributesWidgetSlidesTemplate +from gooddata_api_client.models.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.models.json_api_export_template_out import JsonApiExportTemplateOut +from gooddata_api_client.models.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.models.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.models.json_api_export_template_out_with_links import JsonApiExportTemplateOutWithLinks +from gooddata_api_client.models.json_api_export_template_patch import JsonApiExportTemplatePatch +from gooddata_api_client.models.json_api_export_template_patch_attributes import JsonApiExportTemplatePatchAttributes +from gooddata_api_client.models.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.models.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId +from gooddata_api_client.models.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.models.json_api_fact_linkage import JsonApiFactLinkage +from gooddata_api_client.models.json_api_fact_out import JsonApiFactOut +from gooddata_api_client.models.json_api_fact_out_attributes import JsonApiFactOutAttributes +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_fact_out_relationships import JsonApiFactOutRelationships +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks +from gooddata_api_client.models.json_api_fact_to_one_linkage import JsonApiFactToOneLinkage +from gooddata_api_client.models.json_api_filter_context_in import JsonApiFilterContextIn +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_linkage import JsonApiFilterContextLinkage +from gooddata_api_client.models.json_api_filter_context_out import JsonApiFilterContextOut +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_out_relationships import JsonApiFilterContextOutRelationships +from gooddata_api_client.models.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks +from gooddata_api_client.models.json_api_filter_context_patch import JsonApiFilterContextPatch +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id import JsonApiFilterContextPostOptionalId +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.models.json_api_filter_view_in import JsonApiFilterViewIn +from gooddata_api_client.models.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships +from gooddata_api_client.models.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser +from gooddata_api_client.models.json_api_filter_view_out import JsonApiFilterViewOut +from gooddata_api_client.models.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.models.json_api_filter_view_out_includes import JsonApiFilterViewOutIncludes +from gooddata_api_client.models.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.models.json_api_filter_view_out_with_links import JsonApiFilterViewOutWithLinks +from gooddata_api_client.models.json_api_filter_view_patch import JsonApiFilterViewPatch +from gooddata_api_client.models.json_api_filter_view_patch_attributes import JsonApiFilterViewPatchAttributes +from gooddata_api_client.models.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.models.json_api_identity_provider_in import JsonApiIdentityProviderIn +from gooddata_api_client.models.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_linkage import JsonApiIdentityProviderLinkage +from gooddata_api_client.models.json_api_identity_provider_out import JsonApiIdentityProviderOut +from gooddata_api_client.models.json_api_identity_provider_out_attributes import JsonApiIdentityProviderOutAttributes +from gooddata_api_client.models.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.models.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.models.json_api_identity_provider_out_with_links import JsonApiIdentityProviderOutWithLinks +from gooddata_api_client.models.json_api_identity_provider_patch import JsonApiIdentityProviderPatch +from gooddata_api_client.models.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument +from gooddata_api_client.models.json_api_identity_provider_to_one_linkage import JsonApiIdentityProviderToOneLinkage +from gooddata_api_client.models.json_api_jwk_in import JsonApiJwkIn +from gooddata_api_client.models.json_api_jwk_in_attributes import JsonApiJwkInAttributes +from gooddata_api_client.models.json_api_jwk_in_attributes_content import JsonApiJwkInAttributesContent +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_out import JsonApiJwkOut +from gooddata_api_client.models.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.models.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.models.json_api_jwk_out_with_links import JsonApiJwkOutWithLinks +from gooddata_api_client.models.json_api_jwk_patch import JsonApiJwkPatch +from gooddata_api_client.models.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from gooddata_api_client.models.json_api_label_linkage import JsonApiLabelLinkage +from gooddata_api_client.models.json_api_label_out import JsonApiLabelOut +from gooddata_api_client.models.json_api_label_out_attributes import JsonApiLabelOutAttributes +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_label_out_relationships import JsonApiLabelOutRelationships +from gooddata_api_client.models.json_api_label_out_relationships_attribute import JsonApiLabelOutRelationshipsAttribute +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.json_api_label_to_one_linkage import JsonApiLabelToOneLinkage +from gooddata_api_client.models.json_api_llm_endpoint_in import JsonApiLlmEndpointIn +from gooddata_api_client.models.json_api_llm_endpoint_in_attributes import JsonApiLlmEndpointInAttributes +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_out import JsonApiLlmEndpointOut +from gooddata_api_client.models.json_api_llm_endpoint_out_attributes import JsonApiLlmEndpointOutAttributes +from gooddata_api_client.models.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.models.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from gooddata_api_client.models.json_api_llm_endpoint_out_with_links import JsonApiLlmEndpointOutWithLinks +from gooddata_api_client.models.json_api_llm_endpoint_patch import JsonApiLlmEndpointPatch +from gooddata_api_client.models.json_api_llm_endpoint_patch_attributes import JsonApiLlmEndpointPatchAttributes +from gooddata_api_client.models.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.models.json_api_metric_in import JsonApiMetricIn +from gooddata_api_client.models.json_api_metric_in_attributes import JsonApiMetricInAttributes +from gooddata_api_client.models.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_linkage import JsonApiMetricLinkage +from gooddata_api_client.models.json_api_metric_out import JsonApiMetricOut +from gooddata_api_client.models.json_api_metric_out_attributes import JsonApiMetricOutAttributes +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_includes import JsonApiMetricOutIncludes +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_out_relationships import JsonApiMetricOutRelationships +from gooddata_api_client.models.json_api_metric_out_with_links import JsonApiMetricOutWithLinks +from gooddata_api_client.models.json_api_metric_patch import JsonApiMetricPatch +from gooddata_api_client.models.json_api_metric_patch_attributes import JsonApiMetricPatchAttributes +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.models.json_api_metric_post_optional_id import JsonApiMetricPostOptionalId +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out import JsonApiNotificationChannelIdentifierOut +from gooddata_api_client.models.json_api_notification_channel_identifier_out_attributes import JsonApiNotificationChannelIdentifierOutAttributes +from gooddata_api_client.models.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.models.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.models.json_api_notification_channel_identifier_out_with_links import JsonApiNotificationChannelIdentifierOutWithLinks +from gooddata_api_client.models.json_api_notification_channel_in import JsonApiNotificationChannelIn +from gooddata_api_client.models.json_api_notification_channel_in_attributes import JsonApiNotificationChannelInAttributes +from gooddata_api_client.models.json_api_notification_channel_in_attributes_destination import JsonApiNotificationChannelInAttributesDestination +from gooddata_api_client.models.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument +from gooddata_api_client.models.json_api_notification_channel_linkage import JsonApiNotificationChannelLinkage +from gooddata_api_client.models.json_api_notification_channel_out import JsonApiNotificationChannelOut +from gooddata_api_client.models.json_api_notification_channel_out_attributes import JsonApiNotificationChannelOutAttributes +from gooddata_api_client.models.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.models.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.models.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks +from gooddata_api_client.models.json_api_notification_channel_patch import JsonApiNotificationChannelPatch +from gooddata_api_client.models.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +from gooddata_api_client.models.json_api_notification_channel_post_optional_id import JsonApiNotificationChannelPostOptionalId +from gooddata_api_client.models.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.models.json_api_notification_channel_to_one_linkage import JsonApiNotificationChannelToOneLinkage +from gooddata_api_client.models.json_api_organization_in import JsonApiOrganizationIn +from gooddata_api_client.models.json_api_organization_in_attributes import JsonApiOrganizationInAttributes +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_in_relationships import JsonApiOrganizationInRelationships +from gooddata_api_client.models.json_api_organization_in_relationships_identity_provider import JsonApiOrganizationInRelationshipsIdentityProvider +from gooddata_api_client.models.json_api_organization_out import JsonApiOrganizationOut +from gooddata_api_client.models.json_api_organization_out_attributes import JsonApiOrganizationOutAttributes +from gooddata_api_client.models.json_api_organization_out_attributes_cache_settings import JsonApiOrganizationOutAttributesCacheSettings +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_out_includes import JsonApiOrganizationOutIncludes +from gooddata_api_client.models.json_api_organization_out_meta import JsonApiOrganizationOutMeta +from gooddata_api_client.models.json_api_organization_out_relationships import JsonApiOrganizationOutRelationships +from gooddata_api_client.models.json_api_organization_out_relationships_bootstrap_user_group import JsonApiOrganizationOutRelationshipsBootstrapUserGroup +from gooddata_api_client.models.json_api_organization_patch import JsonApiOrganizationPatch +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_setting_in import JsonApiOrganizationSettingIn +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out import JsonApiOrganizationSettingOut +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_out_with_links import JsonApiOrganizationSettingOutWithLinks +from gooddata_api_client.models.json_api_organization_setting_patch import JsonApiOrganizationSettingPatch +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_theme_in import JsonApiThemeIn +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out import JsonApiThemeOut +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_out_with_links import JsonApiThemeOutWithLinks +from gooddata_api_client.models.json_api_theme_patch import JsonApiThemePatch +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.models.json_api_user_data_filter_in import JsonApiUserDataFilterIn +from gooddata_api_client.models.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships +from gooddata_api_client.models.json_api_user_data_filter_out import JsonApiUserDataFilterOut +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_out_relationships import JsonApiUserDataFilterOutRelationships +from gooddata_api_client.models.json_api_user_data_filter_out_with_links import JsonApiUserDataFilterOutWithLinks +from gooddata_api_client.models.json_api_user_data_filter_patch import JsonApiUserDataFilterPatch +from gooddata_api_client.models.json_api_user_data_filter_patch_attributes import JsonApiUserDataFilterPatchAttributes +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id import JsonApiUserDataFilterPostOptionalId +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_group_in import JsonApiUserGroupIn +from gooddata_api_client.models.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships +from gooddata_api_client.models.json_api_user_group_in_relationships_parents import JsonApiUserGroupInRelationshipsParents +from gooddata_api_client.models.json_api_user_group_linkage import JsonApiUserGroupLinkage +from gooddata_api_client.models.json_api_user_group_out import JsonApiUserGroupOut +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.json_api_user_group_patch import JsonApiUserGroupPatch +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage +from gooddata_api_client.models.json_api_user_identifier_linkage import JsonApiUserIdentifierLinkage +from gooddata_api_client.models.json_api_user_identifier_out import JsonApiUserIdentifierOut +from gooddata_api_client.models.json_api_user_identifier_out_attributes import JsonApiUserIdentifierOutAttributes +from gooddata_api_client.models.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.models.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.models.json_api_user_identifier_to_one_linkage import JsonApiUserIdentifierToOneLinkage +from gooddata_api_client.models.json_api_user_in import JsonApiUserIn +from gooddata_api_client.models.json_api_user_in_attributes import JsonApiUserInAttributes +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_in_relationships import JsonApiUserInRelationships +from gooddata_api_client.models.json_api_user_linkage import JsonApiUserLinkage +from gooddata_api_client.models.json_api_user_out import JsonApiUserOut +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks +from gooddata_api_client.models.json_api_user_patch import JsonApiUserPatch +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_user_setting_in import JsonApiUserSettingIn +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out import JsonApiUserSettingOut +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.models.json_api_user_setting_out_with_links import JsonApiUserSettingOutWithLinks +from gooddata_api_client.models.json_api_user_to_one_linkage import JsonApiUserToOneLinkage +from gooddata_api_client.models.json_api_visualization_object_in import JsonApiVisualizationObjectIn +from gooddata_api_client.models.json_api_visualization_object_in_attributes import JsonApiVisualizationObjectInAttributes +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage +from gooddata_api_client.models.json_api_visualization_object_out import JsonApiVisualizationObjectOut +from gooddata_api_client.models.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks +from gooddata_api_client.models.json_api_visualization_object_patch import JsonApiVisualizationObjectPatch +from gooddata_api_client.models.json_api_visualization_object_patch_attributes import JsonApiVisualizationObjectPatchAttributes +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id import JsonApiVisualizationObjectPostOptionalId +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage +from gooddata_api_client.models.json_api_workspace_automation_out import JsonApiWorkspaceAutomationOut +from gooddata_api_client.models.json_api_workspace_automation_out_includes import JsonApiWorkspaceAutomationOutIncludes +from gooddata_api_client.models.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.models.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships +from gooddata_api_client.models.json_api_workspace_automation_out_relationships_workspace import JsonApiWorkspaceAutomationOutRelationshipsWorkspace +from gooddata_api_client.models.json_api_workspace_automation_out_with_links import JsonApiWorkspaceAutomationOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_in import JsonApiWorkspaceDataFilterIn +from gooddata_api_client.models.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships +from gooddata_api_client.models.json_api_workspace_data_filter_in_relationships_filter_settings import JsonApiWorkspaceDataFilterInRelationshipsFilterSettings +from gooddata_api_client.models.json_api_workspace_data_filter_linkage import JsonApiWorkspaceDataFilterLinkage +from gooddata_api_client.models.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_patch import JsonApiWorkspaceDataFilterPatch +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in import JsonApiWorkspaceDataFilterSettingIn +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter import JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter +from gooddata_api_client.models.json_api_workspace_data_filter_setting_linkage import JsonApiWorkspaceDataFilterSettingLinkage +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch import JsonApiWorkspaceDataFilterSettingPatch +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_to_one_linkage import JsonApiWorkspaceDataFilterToOneLinkage +from gooddata_api_client.models.json_api_workspace_in import JsonApiWorkspaceIn +from gooddata_api_client.models.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes +from gooddata_api_client.models.json_api_workspace_in_attributes_data_source import JsonApiWorkspaceInAttributesDataSource +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships +from gooddata_api_client.models.json_api_workspace_linkage import JsonApiWorkspaceLinkage +from gooddata_api_client.models.json_api_workspace_out import JsonApiWorkspaceOut +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta +from gooddata_api_client.models.json_api_workspace_out_meta_config import JsonApiWorkspaceOutMetaConfig +from gooddata_api_client.models.json_api_workspace_out_meta_data_model import JsonApiWorkspaceOutMetaDataModel +from gooddata_api_client.models.json_api_workspace_out_meta_hierarchy import JsonApiWorkspaceOutMetaHierarchy +from gooddata_api_client.models.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks +from gooddata_api_client.models.json_api_workspace_patch import JsonApiWorkspacePatch +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.models.json_api_workspace_setting_in import JsonApiWorkspaceSettingIn +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_out_with_links import JsonApiWorkspaceSettingOutWithLinks +from gooddata_api_client.models.json_api_workspace_setting_patch import JsonApiWorkspaceSettingPatch +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id import JsonApiWorkspaceSettingPostOptionalId +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage +from gooddata_api_client.models.key_drivers_dimension import KeyDriversDimension +from gooddata_api_client.models.key_drivers_request import KeyDriversRequest +from gooddata_api_client.models.key_drivers_response import KeyDriversResponse +from gooddata_api_client.models.key_drivers_result import KeyDriversResult +from gooddata_api_client.models.label_identifier import LabelIdentifier +from gooddata_api_client.models.list_links import ListLinks +from gooddata_api_client.models.local_identifier import LocalIdentifier +from gooddata_api_client.models.locale_request import LocaleRequest +from gooddata_api_client.models.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.models.measure_definition import MeasureDefinition +from gooddata_api_client.models.measure_execution_result_header import MeasureExecutionResultHeader +from gooddata_api_client.models.measure_group_headers import MeasureGroupHeaders +from gooddata_api_client.models.measure_header import MeasureHeader +from gooddata_api_client.models.measure_item import MeasureItem +from gooddata_api_client.models.measure_item_definition import MeasureItemDefinition +from gooddata_api_client.models.measure_result_header import MeasureResultHeader +from gooddata_api_client.models.measure_value_filter import MeasureValueFilter +from gooddata_api_client.models.memory_item import MemoryItem +from gooddata_api_client.models.memory_item_use_cases import MemoryItemUseCases +from gooddata_api_client.models.metric import Metric +from gooddata_api_client.models.metric_record import MetricRecord +from gooddata_api_client.models.negative_attribute_filter import NegativeAttributeFilter +from gooddata_api_client.models.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter +from gooddata_api_client.models.note import Note +from gooddata_api_client.models.notes import Notes +from gooddata_api_client.models.notification import Notification +from gooddata_api_client.models.notification_channel_destination import NotificationChannelDestination +from gooddata_api_client.models.notification_content import NotificationContent +from gooddata_api_client.models.notification_data import NotificationData +from gooddata_api_client.models.notification_filter import NotificationFilter +from gooddata_api_client.models.notifications import Notifications +from gooddata_api_client.models.notifications_meta import NotificationsMeta +from gooddata_api_client.models.notifications_meta_total import NotificationsMetaTotal +from gooddata_api_client.models.object_links import ObjectLinks +from gooddata_api_client.models.object_links_container import ObjectLinksContainer +from gooddata_api_client.models.organization_automation_identifier import OrganizationAutomationIdentifier +from gooddata_api_client.models.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from gooddata_api_client.models.organization_permission_assignment import OrganizationPermissionAssignment +from gooddata_api_client.models.over import Over +from gooddata_api_client.models.page_metadata import PageMetadata +from gooddata_api_client.models.paging import Paging +from gooddata_api_client.models.parameter import Parameter +from gooddata_api_client.models.pdf_table_style import PdfTableStyle +from gooddata_api_client.models.pdf_table_style_property import PdfTableStyleProperty +from gooddata_api_client.models.pdm_ldm_request import PdmLdmRequest +from gooddata_api_client.models.pdm_sql import PdmSql +from gooddata_api_client.models.permissions_assignment import PermissionsAssignment +from gooddata_api_client.models.permissions_for_assignee import PermissionsForAssignee +from gooddata_api_client.models.permissions_for_assignee_rule import PermissionsForAssigneeRule +from gooddata_api_client.models.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage_request import PlatformUsageRequest +from gooddata_api_client.models.pop_dataset import PopDataset +from gooddata_api_client.models.pop_dataset_measure_definition import PopDatasetMeasureDefinition +from gooddata_api_client.models.pop_dataset_measure_definition_previous_period_measure import PopDatasetMeasureDefinitionPreviousPeriodMeasure +from gooddata_api_client.models.pop_date import PopDate +from gooddata_api_client.models.pop_date_measure_definition import PopDateMeasureDefinition +from gooddata_api_client.models.pop_date_measure_definition_over_period_measure import PopDateMeasureDefinitionOverPeriodMeasure +from gooddata_api_client.models.pop_measure_definition import PopMeasureDefinition +from gooddata_api_client.models.positive_attribute_filter import PositiveAttributeFilter +from gooddata_api_client.models.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter +from gooddata_api_client.models.quality_issue import QualityIssue +from gooddata_api_client.models.quality_issue_object import QualityIssueObject +from gooddata_api_client.models.range import Range +from gooddata_api_client.models.range_measure_value_filter import RangeMeasureValueFilter +from gooddata_api_client.models.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter +from gooddata_api_client.models.range_wrapper import RangeWrapper +from gooddata_api_client.models.ranking_filter import RankingFilter +from gooddata_api_client.models.ranking_filter_ranking_filter import RankingFilterRankingFilter +from gooddata_api_client.models.raw_custom_label import RawCustomLabel +from gooddata_api_client.models.raw_custom_metric import RawCustomMetric +from gooddata_api_client.models.raw_custom_override import RawCustomOverride +from gooddata_api_client.models.raw_export_automation_request import RawExportAutomationRequest +from gooddata_api_client.models.raw_export_request import RawExportRequest +from gooddata_api_client.models.reference_identifier import ReferenceIdentifier +from gooddata_api_client.models.reference_source_column import ReferenceSourceColumn +from gooddata_api_client.models.relative import Relative +from gooddata_api_client.models.relative_bounded_date_filter import RelativeBoundedDateFilter +from gooddata_api_client.models.relative_date_filter import RelativeDateFilter +from gooddata_api_client.models.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter +from gooddata_api_client.models.relative_wrapper import RelativeWrapper +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_llm_endpoint import ResolvedLlmEndpoint +from gooddata_api_client.models.resolved_llm_endpoints import ResolvedLlmEndpoints +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.models.rest_api_identifier import RestApiIdentifier +from gooddata_api_client.models.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.models.result_dimension import ResultDimension +from gooddata_api_client.models.result_dimension_header import ResultDimensionHeader +from gooddata_api_client.models.result_spec import ResultSpec +from gooddata_api_client.models.route_result import RouteResult +from gooddata_api_client.models.rsa_specification import RsaSpecification +from gooddata_api_client.models.rule_permission import RulePermission +from gooddata_api_client.models.running_section import RunningSection +from gooddata_api_client.models.saved_visualization import SavedVisualization +from gooddata_api_client.models.scan_request import ScanRequest +from gooddata_api_client.models.scan_result_pdm import ScanResultPdm +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse +from gooddata_api_client.models.search_relationship_object import SearchRelationshipObject +from gooddata_api_client.models.search_request import SearchRequest +from gooddata_api_client.models.search_result import SearchResult +from gooddata_api_client.models.search_result_object import SearchResultObject +from gooddata_api_client.models.section_slide_template import SectionSlideTemplate +from gooddata_api_client.models.settings import Settings +from gooddata_api_client.models.simple_measure_definition import SimpleMeasureDefinition +from gooddata_api_client.models.simple_measure_definition_measure import SimpleMeasureDefinitionMeasure +from gooddata_api_client.models.skeleton import Skeleton +from gooddata_api_client.models.slides_export_request import SlidesExportRequest +from gooddata_api_client.models.smart_function_response import SmartFunctionResponse +from gooddata_api_client.models.smtp import Smtp +from gooddata_api_client.models.sort_key import SortKey +from gooddata_api_client.models.sort_key_attribute import SortKeyAttribute +from gooddata_api_client.models.sort_key_attribute_attribute import SortKeyAttributeAttribute +from gooddata_api_client.models.sort_key_total import SortKeyTotal +from gooddata_api_client.models.sort_key_total_total import SortKeyTotalTotal +from gooddata_api_client.models.sort_key_value import SortKeyValue +from gooddata_api_client.models.sort_key_value_value import SortKeyValueValue +from gooddata_api_client.models.sql_column import SqlColumn +from gooddata_api_client.models.sql_query import SqlQuery +from gooddata_api_client.models.suggestion import Suggestion +from gooddata_api_client.models.switch_identity_provider_request import SwitchIdentityProviderRequest +from gooddata_api_client.models.table import Table +from gooddata_api_client.models.table_override import TableOverride +from gooddata_api_client.models.table_warning import TableWarning +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_destination_request import TestDestinationRequest +from gooddata_api_client.models.test_notification import TestNotification +from gooddata_api_client.models.test_query_duration import TestQueryDuration +from gooddata_api_client.models.test_request import TestRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.models.total import Total +from gooddata_api_client.models.total_dimension import TotalDimension +from gooddata_api_client.models.total_execution_result_header import TotalExecutionResultHeader +from gooddata_api_client.models.total_result_header import TotalResultHeader +from gooddata_api_client.models.trigger_automation_request import TriggerAutomationRequest +from gooddata_api_client.models.user_assignee import UserAssignee +from gooddata_api_client.models.user_context import UserContext +from gooddata_api_client.models.user_group_assignee import UserGroupAssignee +from gooddata_api_client.models.user_group_identifier import UserGroupIdentifier +from gooddata_api_client.models.user_group_permission import UserGroupPermission +from gooddata_api_client.models.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment +from gooddata_api_client.models.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.models.user_management_user_group_member import UserManagementUserGroupMember +from gooddata_api_client.models.user_management_user_group_members import UserManagementUserGroupMembers +from gooddata_api_client.models.user_management_user_groups import UserManagementUserGroups +from gooddata_api_client.models.user_management_user_groups_item import UserManagementUserGroupsItem +from gooddata_api_client.models.user_management_users import UserManagementUsers +from gooddata_api_client.models.user_management_users_item import UserManagementUsersItem +from gooddata_api_client.models.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment +from gooddata_api_client.models.user_permission import UserPermission +from gooddata_api_client.models.validate_by_item import ValidateByItem +from gooddata_api_client.models.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest +from gooddata_api_client.models.validate_llm_endpoint_request import ValidateLLMEndpointRequest +from gooddata_api_client.models.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.models.value import Value +from gooddata_api_client.models.visible_filter import VisibleFilter +from gooddata_api_client.models.visual_export_request import VisualExportRequest +from gooddata_api_client.models.webhook import Webhook +from gooddata_api_client.models.webhook_automation_info import WebhookAutomationInfo +from gooddata_api_client.models.webhook_message import WebhookMessage +from gooddata_api_client.models.webhook_message_data import WebhookMessageData +from gooddata_api_client.models.webhook_recipient import WebhookRecipient +from gooddata_api_client.models.widget_slides_template import WidgetSlidesTemplate +from gooddata_api_client.models.workspace_automation_identifier import WorkspaceAutomationIdentifier +from gooddata_api_client.models.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.models.workspace_data_source import WorkspaceDataSource +from gooddata_api_client.models.workspace_identifier import WorkspaceIdentifier +from gooddata_api_client.models.workspace_permission_assignment import WorkspacePermissionAssignment +from gooddata_api_client.models.workspace_user import WorkspaceUser +from gooddata_api_client.models.workspace_user_group import WorkspaceUserGroup +from gooddata_api_client.models.workspace_user_groups import WorkspaceUserGroups +from gooddata_api_client.models.workspace_users import WorkspaceUsers +from gooddata_api_client.models.xliff import Xliff diff --git a/gooddata-api-client/gooddata_api_client/models/absolute_date_filter.py b/gooddata-api-client/gooddata_api_client/models/absolute_date_filter.py new file mode 100644 index 000000000..ef2a39934 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/absolute_date_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter +from typing import Optional, Set +from typing_extensions import Self + +class AbsoluteDateFilter(BaseModel): + """ + A datetime filter specifying exact from and to values. + """ # noqa: E501 + absolute_date_filter: AbsoluteDateFilterAbsoluteDateFilter = Field(alias="absoluteDateFilter") + __properties: ClassVar[List[str]] = ["absoluteDateFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AbsoluteDateFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of absolute_date_filter + if self.absolute_date_filter: + _dict['absoluteDateFilter'] = self.absolute_date_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AbsoluteDateFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "absoluteDateFilter": AbsoluteDateFilterAbsoluteDateFilter.from_dict(obj["absoluteDateFilter"]) if obj.get("absoluteDateFilter") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/absolute_date_filter_absolute_date_filter.py b/gooddata-api-client/gooddata_api_client/models/absolute_date_filter_absolute_date_filter.py new file mode 100644 index 000000000..099e22d5a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/absolute_date_filter_absolute_date_filter.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.afm_object_identifier_dataset import AfmObjectIdentifierDataset +from typing import Optional, Set +from typing_extensions import Self + +class AbsoluteDateFilterAbsoluteDateFilter(BaseModel): + """ + AbsoluteDateFilterAbsoluteDateFilter + """ # noqa: E501 + apply_on_result: Optional[StrictBool] = Field(default=None, alias="applyOnResult") + dataset: AfmObjectIdentifierDataset + var_from: Annotated[str, Field(strict=True)] = Field(alias="from") + local_identifier: Optional[StrictStr] = Field(default=None, alias="localIdentifier") + to: Annotated[str, Field(strict=True)] + __properties: ClassVar[List[str]] = ["applyOnResult", "dataset", "from", "localIdentifier", "to"] + + @field_validator('var_from') + def var_from_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^\d{4}-\d{1,2}-\d{1,2}( \d{1,2}:\d{1,2})?$", value): + raise ValueError(r"must validate the regular expression /^\d{4}-\d{1,2}-\d{1,2}( \d{1,2}:\d{1,2})?$/") + return value + + @field_validator('to') + def to_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^\d{4}-\d{1,2}-\d{1,2}( \d{1,2}:\d{1,2})?$", value): + raise ValueError(r"must validate the regular expression /^\d{4}-\d{1,2}-\d{1,2}( \d{1,2}:\d{1,2})?$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AbsoluteDateFilterAbsoluteDateFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dataset + if self.dataset: + _dict['dataset'] = self.dataset.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AbsoluteDateFilterAbsoluteDateFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applyOnResult": obj.get("applyOnResult"), + "dataset": AfmObjectIdentifierDataset.from_dict(obj["dataset"]) if obj.get("dataset") is not None else None, + "from": obj.get("from"), + "localIdentifier": obj.get("localIdentifier"), + "to": obj.get("to") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/abstract_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/models/abstract_measure_value_filter.py new file mode 100644 index 000000000..123f12e1f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/abstract_measure_value_filter.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.comparison_measure_value_filter import ComparisonMeasureValueFilter +from gooddata_api_client.models.range_measure_value_filter import RangeMeasureValueFilter +from gooddata_api_client.models.ranking_filter import RankingFilter +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +ABSTRACTMEASUREVALUEFILTER_ONE_OF_SCHEMAS = ["ComparisonMeasureValueFilter", "RangeMeasureValueFilter", "RankingFilter"] + +class AbstractMeasureValueFilter(BaseModel): + """ + AbstractMeasureValueFilter + """ + # data type: ComparisonMeasureValueFilter + oneof_schema_1_validator: Optional[ComparisonMeasureValueFilter] = None + # data type: RangeMeasureValueFilter + oneof_schema_2_validator: Optional[RangeMeasureValueFilter] = None + # data type: RankingFilter + oneof_schema_3_validator: Optional[RankingFilter] = None + actual_instance: Optional[Union[ComparisonMeasureValueFilter, RangeMeasureValueFilter, RankingFilter]] = None + one_of_schemas: Set[str] = { "ComparisonMeasureValueFilter", "RangeMeasureValueFilter", "RankingFilter" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = AbstractMeasureValueFilter.model_construct() + error_messages = [] + match = 0 + # validate data type: ComparisonMeasureValueFilter + if not isinstance(v, ComparisonMeasureValueFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `ComparisonMeasureValueFilter`") + else: + match += 1 + # validate data type: RangeMeasureValueFilter + if not isinstance(v, RangeMeasureValueFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `RangeMeasureValueFilter`") + else: + match += 1 + # validate data type: RankingFilter + if not isinstance(v, RankingFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `RankingFilter`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in AbstractMeasureValueFilter with oneOf schemas: ComparisonMeasureValueFilter, RangeMeasureValueFilter, RankingFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in AbstractMeasureValueFilter with oneOf schemas: ComparisonMeasureValueFilter, RangeMeasureValueFilter, RankingFilter. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into ComparisonMeasureValueFilter + try: + instance.actual_instance = ComparisonMeasureValueFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RangeMeasureValueFilter + try: + instance.actual_instance = RangeMeasureValueFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RankingFilter + try: + instance.actual_instance = RankingFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into AbstractMeasureValueFilter with oneOf schemas: ComparisonMeasureValueFilter, RangeMeasureValueFilter, RankingFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into AbstractMeasureValueFilter with oneOf schemas: ComparisonMeasureValueFilter, RangeMeasureValueFilter, RankingFilter. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], ComparisonMeasureValueFilter, RangeMeasureValueFilter, RankingFilter]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/active_object_identification.py b/gooddata-api-client/gooddata_api_client/models/active_object_identification.py new file mode 100644 index 000000000..caeea2be9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/active_object_identification.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ActiveObjectIdentification(BaseModel): + """ + Object, with which the user is actively working. + """ # noqa: E501 + id: StrictStr = Field(description="Object ID.") + type: StrictStr = Field(description="Object type, e.g. dashboard.") + workspace_id: StrictStr = Field(description="Workspace ID.", alias="workspaceId") + __properties: ClassVar[List[str]] = ["id", "type", "workspaceId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ActiveObjectIdentification from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ActiveObjectIdentification from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type"), + "workspaceId": obj.get("workspaceId") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/ad_hoc_automation.py b/gooddata-api-client/gooddata_api_client/models/ad_hoc_automation.py new file mode 100644 index 000000000..1ca0ee297 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/ad_hoc_automation.py @@ -0,0 +1,204 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.automation_alert import AutomationAlert +from gooddata_api_client.models.automation_dashboard_tabular_export import AutomationDashboardTabularExport +from gooddata_api_client.models.automation_external_recipient import AutomationExternalRecipient +from gooddata_api_client.models.automation_image_export import AutomationImageExport +from gooddata_api_client.models.automation_metadata import AutomationMetadata +from gooddata_api_client.models.automation_raw_export import AutomationRawExport +from gooddata_api_client.models.automation_slides_export import AutomationSlidesExport +from gooddata_api_client.models.automation_tabular_export import AutomationTabularExport +from gooddata_api_client.models.automation_visual_export import AutomationVisualExport +from gooddata_api_client.models.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier +from gooddata_api_client.models.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class AdHocAutomation(BaseModel): + """ + AdHocAutomation + """ # noqa: E501 + alert: Optional[AutomationAlert] = None + analytical_dashboard: Optional[DeclarativeAnalyticalDashboardIdentifier] = Field(default=None, alias="analyticalDashboard") + dashboard_tabular_exports: Optional[List[AutomationDashboardTabularExport]] = Field(default=None, alias="dashboardTabularExports") + description: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + details: Optional[Dict[str, Annotated[str, Field(strict=True, max_length=10000)]]] = Field(default=None, description="Additional details to be included in the automated message.") + external_recipients: Optional[List[AutomationExternalRecipient]] = Field(default=None, description="External recipients of the automation action results.", alias="externalRecipients") + image_exports: Optional[List[AutomationImageExport]] = Field(default=None, alias="imageExports") + metadata: Optional[AutomationMetadata] = None + notification_channel: Optional[DeclarativeNotificationChannelIdentifier] = Field(default=None, alias="notificationChannel") + raw_exports: Optional[List[AutomationRawExport]] = Field(default=None, alias="rawExports") + recipients: Optional[List[DeclarativeUserIdentifier]] = None + slides_exports: Optional[List[AutomationSlidesExport]] = Field(default=None, alias="slidesExports") + tabular_exports: Optional[List[AutomationTabularExport]] = Field(default=None, alias="tabularExports") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + visual_exports: Optional[List[AutomationVisualExport]] = Field(default=None, alias="visualExports") + __properties: ClassVar[List[str]] = ["alert", "analyticalDashboard", "dashboardTabularExports", "description", "details", "externalRecipients", "imageExports", "metadata", "notificationChannel", "rawExports", "recipients", "slidesExports", "tabularExports", "tags", "title", "visualExports"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdHocAutomation from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of alert + if self.alert: + _dict['alert'] = self.alert.to_dict() + # override the default output from pydantic by calling `to_dict()` of analytical_dashboard + if self.analytical_dashboard: + _dict['analyticalDashboard'] = self.analytical_dashboard.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in dashboard_tabular_exports (list) + _items = [] + if self.dashboard_tabular_exports: + for _item_dashboard_tabular_exports in self.dashboard_tabular_exports: + if _item_dashboard_tabular_exports: + _items.append(_item_dashboard_tabular_exports.to_dict()) + _dict['dashboardTabularExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in external_recipients (list) + _items = [] + if self.external_recipients: + for _item_external_recipients in self.external_recipients: + if _item_external_recipients: + _items.append(_item_external_recipients.to_dict()) + _dict['externalRecipients'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in image_exports (list) + _items = [] + if self.image_exports: + for _item_image_exports in self.image_exports: + if _item_image_exports: + _items.append(_item_image_exports.to_dict()) + _dict['imageExports'] = _items + # override the default output from pydantic by calling `to_dict()` of metadata + if self.metadata: + _dict['metadata'] = self.metadata.to_dict() + # override the default output from pydantic by calling `to_dict()` of notification_channel + if self.notification_channel: + _dict['notificationChannel'] = self.notification_channel.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in raw_exports (list) + _items = [] + if self.raw_exports: + for _item_raw_exports in self.raw_exports: + if _item_raw_exports: + _items.append(_item_raw_exports.to_dict()) + _dict['rawExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in recipients (list) + _items = [] + if self.recipients: + for _item_recipients in self.recipients: + if _item_recipients: + _items.append(_item_recipients.to_dict()) + _dict['recipients'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in slides_exports (list) + _items = [] + if self.slides_exports: + for _item_slides_exports in self.slides_exports: + if _item_slides_exports: + _items.append(_item_slides_exports.to_dict()) + _dict['slidesExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in tabular_exports (list) + _items = [] + if self.tabular_exports: + for _item_tabular_exports in self.tabular_exports: + if _item_tabular_exports: + _items.append(_item_tabular_exports.to_dict()) + _dict['tabularExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in visual_exports (list) + _items = [] + if self.visual_exports: + for _item_visual_exports in self.visual_exports: + if _item_visual_exports: + _items.append(_item_visual_exports.to_dict()) + _dict['visualExports'] = _items + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdHocAutomation from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "alert": AutomationAlert.from_dict(obj["alert"]) if obj.get("alert") is not None else None, + "analyticalDashboard": DeclarativeAnalyticalDashboardIdentifier.from_dict(obj["analyticalDashboard"]) if obj.get("analyticalDashboard") is not None else None, + "dashboardTabularExports": [AutomationDashboardTabularExport.from_dict(_item) for _item in obj["dashboardTabularExports"]] if obj.get("dashboardTabularExports") is not None else None, + "description": obj.get("description"), + "details": obj.get("details"), + "externalRecipients": [AutomationExternalRecipient.from_dict(_item) for _item in obj["externalRecipients"]] if obj.get("externalRecipients") is not None else None, + "imageExports": [AutomationImageExport.from_dict(_item) for _item in obj["imageExports"]] if obj.get("imageExports") is not None else None, + "metadata": AutomationMetadata.from_dict(obj["metadata"]) if obj.get("metadata") is not None else None, + "notificationChannel": DeclarativeNotificationChannelIdentifier.from_dict(obj["notificationChannel"]) if obj.get("notificationChannel") is not None else None, + "rawExports": [AutomationRawExport.from_dict(_item) for _item in obj["rawExports"]] if obj.get("rawExports") is not None else None, + "recipients": [DeclarativeUserIdentifier.from_dict(_item) for _item in obj["recipients"]] if obj.get("recipients") is not None else None, + "slidesExports": [AutomationSlidesExport.from_dict(_item) for _item in obj["slidesExports"]] if obj.get("slidesExports") is not None else None, + "tabularExports": [AutomationTabularExport.from_dict(_item) for _item in obj["tabularExports"]] if obj.get("tabularExports") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title"), + "visualExports": [AutomationVisualExport.from_dict(_item) for _item in obj["visualExports"]] if obj.get("visualExports") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm.py b/gooddata-api-client/gooddata_api_client/models/afm.py new file mode 100644 index 000000000..02bca6dbe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.afm_filters_inner import AFMFiltersInner +from gooddata_api_client.models.attribute_item import AttributeItem +from gooddata_api_client.models.measure_item import MeasureItem +from typing import Optional, Set +from typing_extensions import Self + +class AFM(BaseModel): + """ + Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics. + """ # noqa: E501 + attributes: List[AttributeItem] = Field(description="Attributes to be used in the computation.") + aux_measures: Optional[List[MeasureItem]] = Field(default=None, description="Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", alias="auxMeasures") + filters: List[AFMFiltersInner] = Field(description="Various filter types to filter the execution result.") + measures: List[MeasureItem] = Field(description="Metrics to be computed.") + __properties: ClassVar[List[str]] = ["attributes", "auxMeasures", "filters", "measures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AFM from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in attributes (list) + _items = [] + if self.attributes: + for _item_attributes in self.attributes: + if _item_attributes: + _items.append(_item_attributes.to_dict()) + _dict['attributes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in aux_measures (list) + _items = [] + if self.aux_measures: + for _item_aux_measures in self.aux_measures: + if _item_aux_measures: + _items.append(_item_aux_measures.to_dict()) + _dict['auxMeasures'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in filters (list) + _items = [] + if self.filters: + for _item_filters in self.filters: + if _item_filters: + _items.append(_item_filters.to_dict()) + _dict['filters'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in measures (list) + _items = [] + if self.measures: + for _item_measures in self.measures: + if _item_measures: + _items.append(_item_measures.to_dict()) + _dict['measures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AFM from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": [AttributeItem.from_dict(_item) for _item in obj["attributes"]] if obj.get("attributes") is not None else None, + "auxMeasures": [MeasureItem.from_dict(_item) for _item in obj["auxMeasures"]] if obj.get("auxMeasures") is not None else None, + "filters": [AFMFiltersInner.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None, + "measures": [MeasureItem.from_dict(_item) for _item in obj["measures"]] if obj.get("measures") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_cancel_tokens.py b/gooddata-api-client/gooddata_api_client/models/afm_cancel_tokens.py new file mode 100644 index 000000000..172cece16 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_cancel_tokens.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AfmCancelTokens(BaseModel): + """ + Any information related to cancellation. + """ # noqa: E501 + result_id_to_cancel_token_pairs: Dict[str, StrictStr] = Field(description="resultId to cancel token pairs", alias="resultIdToCancelTokenPairs") + __properties: ClassVar[List[str]] = ["resultIdToCancelTokenPairs"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmCancelTokens from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmCancelTokens from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "resultIdToCancelTokenPairs": obj.get("resultIdToCancelTokenPairs") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_execution.py b/gooddata-api-client/gooddata_api_client/models/afm_execution.py new file mode 100644 index 000000000..3ea1595b9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_execution.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.afm import AFM +from gooddata_api_client.models.execution_settings import ExecutionSettings +from gooddata_api_client.models.result_spec import ResultSpec +from typing import Optional, Set +from typing_extensions import Self + +class AfmExecution(BaseModel): + """ + AfmExecution + """ # noqa: E501 + execution: AFM + result_spec: ResultSpec = Field(alias="resultSpec") + settings: Optional[ExecutionSettings] = None + __properties: ClassVar[List[str]] = ["execution", "resultSpec", "settings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmExecution from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of execution + if self.execution: + _dict['execution'] = self.execution.to_dict() + # override the default output from pydantic by calling `to_dict()` of result_spec + if self.result_spec: + _dict['resultSpec'] = self.result_spec.to_dict() + # override the default output from pydantic by calling `to_dict()` of settings + if self.settings: + _dict['settings'] = self.settings.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmExecution from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "execution": AFM.from_dict(obj["execution"]) if obj.get("execution") is not None else None, + "resultSpec": ResultSpec.from_dict(obj["resultSpec"]) if obj.get("resultSpec") is not None else None, + "settings": ExecutionSettings.from_dict(obj["settings"]) if obj.get("settings") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_execution_response.py b/gooddata-api-client/gooddata_api_client/models/afm_execution_response.py new file mode 100644 index 000000000..6339b2cdd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_execution_response.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.execution_response import ExecutionResponse +from typing import Optional, Set +from typing_extensions import Self + +class AfmExecutionResponse(BaseModel): + """ + Response to AFM execution request + """ # noqa: E501 + execution_response: ExecutionResponse = Field(alias="executionResponse") + __properties: ClassVar[List[str]] = ["executionResponse"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmExecutionResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of execution_response + if self.execution_response: + _dict['executionResponse'] = self.execution_response.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmExecutionResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "executionResponse": ExecutionResponse.from_dict(obj["executionResponse"]) if obj.get("executionResponse") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_filters_inner.py b/gooddata-api-client/gooddata_api_client/models/afm_filters_inner.py new file mode 100644 index 000000000..d0e072261 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_filters_inner.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.abstract_measure_value_filter import AbstractMeasureValueFilter +from gooddata_api_client.models.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure +from gooddata_api_client.models.inline_filter_definition import InlineFilterDefinition +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +AFMFILTERSINNER_ONE_OF_SCHEMAS = ["AbstractMeasureValueFilter", "FilterDefinitionForSimpleMeasure", "InlineFilterDefinition"] + +class AFMFiltersInner(BaseModel): + """ + AFMFiltersInner + """ + # data type: AbstractMeasureValueFilter + oneof_schema_1_validator: Optional[AbstractMeasureValueFilter] = None + # data type: FilterDefinitionForSimpleMeasure + oneof_schema_2_validator: Optional[FilterDefinitionForSimpleMeasure] = None + # data type: InlineFilterDefinition + oneof_schema_3_validator: Optional[InlineFilterDefinition] = None + actual_instance: Optional[Union[AbstractMeasureValueFilter, FilterDefinitionForSimpleMeasure, InlineFilterDefinition]] = None + one_of_schemas: Set[str] = { "AbstractMeasureValueFilter", "FilterDefinitionForSimpleMeasure", "InlineFilterDefinition" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = AFMFiltersInner.model_construct() + error_messages = [] + match = 0 + # validate data type: AbstractMeasureValueFilter + if not isinstance(v, AbstractMeasureValueFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `AbstractMeasureValueFilter`") + else: + match += 1 + # validate data type: FilterDefinitionForSimpleMeasure + if not isinstance(v, FilterDefinitionForSimpleMeasure): + error_messages.append(f"Error! Input type `{type(v)}` is not `FilterDefinitionForSimpleMeasure`") + else: + match += 1 + # validate data type: InlineFilterDefinition + if not isinstance(v, InlineFilterDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `InlineFilterDefinition`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in AFMFiltersInner with oneOf schemas: AbstractMeasureValueFilter, FilterDefinitionForSimpleMeasure, InlineFilterDefinition. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in AFMFiltersInner with oneOf schemas: AbstractMeasureValueFilter, FilterDefinitionForSimpleMeasure, InlineFilterDefinition. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into AbstractMeasureValueFilter + try: + instance.actual_instance = AbstractMeasureValueFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into FilterDefinitionForSimpleMeasure + try: + instance.actual_instance = FilterDefinitionForSimpleMeasure.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into InlineFilterDefinition + try: + instance.actual_instance = InlineFilterDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into AFMFiltersInner with oneOf schemas: AbstractMeasureValueFilter, FilterDefinitionForSimpleMeasure, InlineFilterDefinition. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into AFMFiltersInner with oneOf schemas: AbstractMeasureValueFilter, FilterDefinitionForSimpleMeasure, InlineFilterDefinition. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], AbstractMeasureValueFilter, FilterDefinitionForSimpleMeasure, InlineFilterDefinition]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_identifier.py b/gooddata-api-client/gooddata_api_client/models/afm_identifier.py new file mode 100644 index 000000000..c16e3fede --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_identifier.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.afm_local_identifier import AfmLocalIdentifier +from gooddata_api_client.models.afm_object_identifier import AfmObjectIdentifier +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +AFMIDENTIFIER_ONE_OF_SCHEMAS = ["AfmLocalIdentifier", "AfmObjectIdentifier"] + +class AfmIdentifier(BaseModel): + """ + Reference to the attribute label to which the filter should be applied. + """ + # data type: AfmObjectIdentifier + oneof_schema_1_validator: Optional[AfmObjectIdentifier] = None + # data type: AfmLocalIdentifier + oneof_schema_2_validator: Optional[AfmLocalIdentifier] = None + actual_instance: Optional[Union[AfmLocalIdentifier, AfmObjectIdentifier]] = None + one_of_schemas: Set[str] = { "AfmLocalIdentifier", "AfmObjectIdentifier" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = AfmIdentifier.model_construct() + error_messages = [] + match = 0 + # validate data type: AfmObjectIdentifier + if not isinstance(v, AfmObjectIdentifier): + error_messages.append(f"Error! Input type `{type(v)}` is not `AfmObjectIdentifier`") + else: + match += 1 + # validate data type: AfmLocalIdentifier + if not isinstance(v, AfmLocalIdentifier): + error_messages.append(f"Error! Input type `{type(v)}` is not `AfmLocalIdentifier`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in AfmIdentifier with oneOf schemas: AfmLocalIdentifier, AfmObjectIdentifier. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in AfmIdentifier with oneOf schemas: AfmLocalIdentifier, AfmObjectIdentifier. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into AfmObjectIdentifier + try: + instance.actual_instance = AfmObjectIdentifier.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into AfmLocalIdentifier + try: + instance.actual_instance = AfmLocalIdentifier.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into AfmIdentifier with oneOf schemas: AfmLocalIdentifier, AfmObjectIdentifier. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into AfmIdentifier with oneOf schemas: AfmLocalIdentifier, AfmObjectIdentifier. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], AfmLocalIdentifier, AfmObjectIdentifier]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_local_identifier.py b/gooddata-api-client/gooddata_api_client/models/afm_local_identifier.py new file mode 100644 index 000000000..0a558d0d4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_local_identifier.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AfmLocalIdentifier(BaseModel): + """ + AfmLocalIdentifier + """ # noqa: E501 + local_identifier: Annotated[str, Field(strict=True)] = Field(alias="localIdentifier") + __properties: ClassVar[List[str]] = ["localIdentifier"] + + @field_validator('local_identifier') + def local_identifier_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[.a-zA-Z0-9_-]+$", value): + raise ValueError(r"must validate the regular expression /^[.a-zA-Z0-9_-]+$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmLocalIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmLocalIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "localIdentifier": obj.get("localIdentifier") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_object_identifier.py b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier.py new file mode 100644 index 000000000..ca9a3106d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_object_identifier_identifier import AfmObjectIdentifierIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class AfmObjectIdentifier(BaseModel): + """ + ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers. + """ # noqa: E501 + identifier: AfmObjectIdentifierIdentifier + __properties: ClassVar[List[str]] = ["identifier"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmObjectIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of identifier + if self.identifier: + _dict['identifier'] = self.identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmObjectIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "identifier": AfmObjectIdentifierIdentifier.from_dict(obj["identifier"]) if obj.get("identifier") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_attribute.py b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_attribute.py new file mode 100644 index 000000000..1875d835d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_attribute.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_object_identifier_attribute_identifier import AfmObjectIdentifierAttributeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class AfmObjectIdentifierAttribute(BaseModel): + """ + Reference to the date attribute to use. + """ # noqa: E501 + identifier: AfmObjectIdentifierAttributeIdentifier + __properties: ClassVar[List[str]] = ["identifier"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierAttribute from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of identifier + if self.identifier: + _dict['identifier'] = self.identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierAttribute from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "identifier": AfmObjectIdentifierAttributeIdentifier.from_dict(obj["identifier"]) if obj.get("identifier") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_attribute_identifier.py b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_attribute_identifier.py new file mode 100644 index 000000000..381c6892d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_attribute_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AfmObjectIdentifierAttributeIdentifier(BaseModel): + """ + AfmObjectIdentifierAttributeIdentifier + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attribute']): + raise ValueError("must be one of enum values ('attribute')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierAttributeIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierAttributeIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_core.py b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_core.py new file mode 100644 index 000000000..3a4397fe3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_core.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_object_identifier_core_identifier import AfmObjectIdentifierCoreIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class AfmObjectIdentifierCore(BaseModel): + """ + Reference to the metric, fact or attribute object to use for the metric. + """ # noqa: E501 + identifier: AfmObjectIdentifierCoreIdentifier + __properties: ClassVar[List[str]] = ["identifier"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierCore from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of identifier + if self.identifier: + _dict['identifier'] = self.identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierCore from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "identifier": AfmObjectIdentifierCoreIdentifier.from_dict(obj["identifier"]) if obj.get("identifier") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_core_identifier.py b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_core_identifier.py new file mode 100644 index 000000000..769e87a04 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_core_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AfmObjectIdentifierCoreIdentifier(BaseModel): + """ + AfmObjectIdentifierCoreIdentifier + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attribute', 'label', 'fact', 'metric']): + raise ValueError("must be one of enum values ('attribute', 'label', 'fact', 'metric')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierCoreIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierCoreIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_dataset.py b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_dataset.py new file mode 100644 index 000000000..0cda35c5d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_dataset.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_object_identifier_dataset_identifier import AfmObjectIdentifierDatasetIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class AfmObjectIdentifierDataset(BaseModel): + """ + Reference to the date dataset to which the filter should be applied. + """ # noqa: E501 + identifier: AfmObjectIdentifierDatasetIdentifier + __properties: ClassVar[List[str]] = ["identifier"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierDataset from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of identifier + if self.identifier: + _dict['identifier'] = self.identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierDataset from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "identifier": AfmObjectIdentifierDatasetIdentifier.from_dict(obj["identifier"]) if obj.get("identifier") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_dataset_identifier.py b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_dataset_identifier.py new file mode 100644 index 000000000..6d1d34186 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_dataset_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AfmObjectIdentifierDatasetIdentifier(BaseModel): + """ + AfmObjectIdentifierDatasetIdentifier + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataset']): + raise ValueError("must be one of enum values ('dataset')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierDatasetIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierDatasetIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_identifier.py b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_identifier.py new file mode 100644 index 000000000..a635d853f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AfmObjectIdentifierIdentifier(BaseModel): + """ + AfmObjectIdentifierIdentifier + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard', 'attribute', 'dashboardPlugin', 'dataset', 'fact', 'label', 'metric', 'prompt', 'visualizationObject', 'filterContext']): + raise ValueError("must be one of enum values ('analyticalDashboard', 'attribute', 'dashboardPlugin', 'dataset', 'fact', 'label', 'metric', 'prompt', 'visualizationObject', 'filterContext')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_label.py b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_label.py new file mode 100644 index 000000000..6df69a95f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_label.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_object_identifier_label_identifier import AfmObjectIdentifierLabelIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class AfmObjectIdentifierLabel(BaseModel): + """ + AfmObjectIdentifierLabel + """ # noqa: E501 + identifier: AfmObjectIdentifierLabelIdentifier + __properties: ClassVar[List[str]] = ["identifier"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierLabel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of identifier + if self.identifier: + _dict['identifier'] = self.identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierLabel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "identifier": AfmObjectIdentifierLabelIdentifier.from_dict(obj["identifier"]) if obj.get("identifier") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_label_identifier.py b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_label_identifier.py new file mode 100644 index 000000000..f1408c2eb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_object_identifier_label_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AfmObjectIdentifierLabelIdentifier(BaseModel): + """ + AfmObjectIdentifierLabelIdentifier + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['label']): + raise ValueError("must be one of enum values ('label')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierLabelIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmObjectIdentifierLabelIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_valid_descendants_query.py b/gooddata-api-client/gooddata_api_client/models/afm_valid_descendants_query.py new file mode 100644 index 000000000..6ca770624 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_valid_descendants_query.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_object_identifier_attribute import AfmObjectIdentifierAttribute +from typing import Optional, Set +from typing_extensions import Self + +class AfmValidDescendantsQuery(BaseModel): + """ + Entity describing the valid descendants request. + """ # noqa: E501 + attributes: List[AfmObjectIdentifierAttribute] = Field(description="List of identifiers of the attributes to get the valid descendants for.") + __properties: ClassVar[List[str]] = ["attributes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmValidDescendantsQuery from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in attributes (list) + _items = [] + if self.attributes: + for _item_attributes in self.attributes: + if _item_attributes: + _items.append(_item_attributes.to_dict()) + _dict['attributes'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmValidDescendantsQuery from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": [AfmObjectIdentifierAttribute.from_dict(_item) for _item in obj["attributes"]] if obj.get("attributes") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_valid_descendants_response.py b/gooddata-api-client/gooddata_api_client/models/afm_valid_descendants_response.py new file mode 100644 index 000000000..3b9aefc83 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_valid_descendants_response.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_object_identifier_attribute import AfmObjectIdentifierAttribute +from typing import Optional, Set +from typing_extensions import Self + +class AfmValidDescendantsResponse(BaseModel): + """ + Entity describing the valid descendants response. + """ # noqa: E501 + valid_descendants: Dict[str, List[AfmObjectIdentifierAttribute]] = Field(description="Map of attribute identifiers to list of valid descendants identifiers.", alias="validDescendants") + __properties: ClassVar[List[str]] = ["validDescendants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmValidDescendantsResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each value in valid_descendants (dict of array) + _field_dict_of_array = {} + if self.valid_descendants: + for _key_valid_descendants in self.valid_descendants: + if self.valid_descendants[_key_valid_descendants] is not None: + _field_dict_of_array[_key_valid_descendants] = [ + _item.to_dict() for _item in self.valid_descendants[_key_valid_descendants] + ] + _dict['validDescendants'] = _field_dict_of_array + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmValidDescendantsResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "validDescendants": dict( + (_k, + [AfmObjectIdentifierAttribute.from_dict(_item) for _item in _v] + if _v is not None + else None + ) + for _k, _v in obj.get("validDescendants", {}).items() + ) + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_valid_objects_query.py b/gooddata-api-client/gooddata_api_client/models/afm_valid_objects_query.py new file mode 100644 index 000000000..d6cd50913 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_valid_objects_query.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm import AFM +from typing import Optional, Set +from typing_extensions import Self + +class AfmValidObjectsQuery(BaseModel): + """ + Entity holding AFM and list of object types whose validity should be computed. + """ # noqa: E501 + afm: AFM + types: List[StrictStr] + __properties: ClassVar[List[str]] = ["afm", "types"] + + @field_validator('types') + def types_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['facts', 'attributes', 'measures']): + raise ValueError("each list item must be one of ('facts', 'attributes', 'measures')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmValidObjectsQuery from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of afm + if self.afm: + _dict['afm'] = self.afm.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmValidObjectsQuery from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "afm": AFM.from_dict(obj["afm"]) if obj.get("afm") is not None else None, + "types": obj.get("types") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/afm_valid_objects_response.py b/gooddata-api-client/gooddata_api_client/models/afm_valid_objects_response.py new file mode 100644 index 000000000..382b556eb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/afm_valid_objects_response.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.rest_api_identifier import RestApiIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class AfmValidObjectsResponse(BaseModel): + """ + All objects of specified types valid with respect to given AFM. + """ # noqa: E501 + items: List[RestApiIdentifier] + __properties: ClassVar[List[str]] = ["items"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AfmValidObjectsResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) + _dict['items'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AfmValidObjectsResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [RestApiIdentifier.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/alert_afm.py b/gooddata-api-client/gooddata_api_client/models/alert_afm.py new file mode 100644 index 000000000..7ff97780e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/alert_afm.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.attribute_item import AttributeItem +from gooddata_api_client.models.filter_definition import FilterDefinition +from gooddata_api_client.models.measure_item import MeasureItem +from typing import Optional, Set +from typing_extensions import Self + +class AlertAfm(BaseModel): + """ + AlertAfm + """ # noqa: E501 + attributes: Optional[List[AttributeItem]] = Field(default=None, description="Attributes to be used in the computation.") + aux_measures: Optional[List[MeasureItem]] = Field(default=None, description="Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", alias="auxMeasures") + filters: List[FilterDefinition] = Field(description="Various filter types to filter execution result.") + measures: List[MeasureItem] = Field(description="Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other.") + __properties: ClassVar[List[str]] = ["attributes", "auxMeasures", "filters", "measures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AlertAfm from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in attributes (list) + _items = [] + if self.attributes: + for _item_attributes in self.attributes: + if _item_attributes: + _items.append(_item_attributes.to_dict()) + _dict['attributes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in aux_measures (list) + _items = [] + if self.aux_measures: + for _item_aux_measures in self.aux_measures: + if _item_aux_measures: + _items.append(_item_aux_measures.to_dict()) + _dict['auxMeasures'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in filters (list) + _items = [] + if self.filters: + for _item_filters in self.filters: + if _item_filters: + _items.append(_item_filters.to_dict()) + _dict['filters'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in measures (list) + _items = [] + if self.measures: + for _item_measures in self.measures: + if _item_measures: + _items.append(_item_measures.to_dict()) + _dict['measures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AlertAfm from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": [AttributeItem.from_dict(_item) for _item in obj["attributes"]] if obj.get("attributes") is not None else None, + "auxMeasures": [MeasureItem.from_dict(_item) for _item in obj["auxMeasures"]] if obj.get("auxMeasures") is not None else None, + "filters": [FilterDefinition.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None, + "measures": [MeasureItem.from_dict(_item) for _item in obj["measures"]] if obj.get("measures") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/alert_condition.py b/gooddata-api-client/gooddata_api_client/models/alert_condition.py new file mode 100644 index 000000000..bdca7bc20 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/alert_condition.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.comparison_wrapper import ComparisonWrapper +from gooddata_api_client.models.range_wrapper import RangeWrapper +from gooddata_api_client.models.relative_wrapper import RelativeWrapper +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +ALERTCONDITION_ONE_OF_SCHEMAS = ["ComparisonWrapper", "RangeWrapper", "RelativeWrapper"] + +class AlertCondition(BaseModel): + """ + Alert trigger condition. + """ + # data type: ComparisonWrapper + oneof_schema_1_validator: Optional[ComparisonWrapper] = None + # data type: RangeWrapper + oneof_schema_2_validator: Optional[RangeWrapper] = None + # data type: RelativeWrapper + oneof_schema_3_validator: Optional[RelativeWrapper] = None + actual_instance: Optional[Union[ComparisonWrapper, RangeWrapper, RelativeWrapper]] = None + one_of_schemas: Set[str] = { "ComparisonWrapper", "RangeWrapper", "RelativeWrapper" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = AlertCondition.model_construct() + error_messages = [] + match = 0 + # validate data type: ComparisonWrapper + if not isinstance(v, ComparisonWrapper): + error_messages.append(f"Error! Input type `{type(v)}` is not `ComparisonWrapper`") + else: + match += 1 + # validate data type: RangeWrapper + if not isinstance(v, RangeWrapper): + error_messages.append(f"Error! Input type `{type(v)}` is not `RangeWrapper`") + else: + match += 1 + # validate data type: RelativeWrapper + if not isinstance(v, RelativeWrapper): + error_messages.append(f"Error! Input type `{type(v)}` is not `RelativeWrapper`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in AlertCondition with oneOf schemas: ComparisonWrapper, RangeWrapper, RelativeWrapper. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in AlertCondition with oneOf schemas: ComparisonWrapper, RangeWrapper, RelativeWrapper. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into ComparisonWrapper + try: + instance.actual_instance = ComparisonWrapper.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RangeWrapper + try: + instance.actual_instance = RangeWrapper.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RelativeWrapper + try: + instance.actual_instance = RelativeWrapper.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into AlertCondition with oneOf schemas: ComparisonWrapper, RangeWrapper, RelativeWrapper. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into AlertCondition with oneOf schemas: ComparisonWrapper, RangeWrapper, RelativeWrapper. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], ComparisonWrapper, RangeWrapper, RelativeWrapper]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/alert_condition_operand.py b/gooddata-api-client/gooddata_api_client/models/alert_condition_operand.py new file mode 100644 index 000000000..693d6e8c2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/alert_condition_operand.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.local_identifier import LocalIdentifier +from gooddata_api_client.models.value import Value +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +ALERTCONDITIONOPERAND_ONE_OF_SCHEMAS = ["LocalIdentifier", "Value"] + +class AlertConditionOperand(BaseModel): + """ + Operand of the alert condition. + """ + # data type: LocalIdentifier + oneof_schema_1_validator: Optional[LocalIdentifier] = None + # data type: Value + oneof_schema_2_validator: Optional[Value] = None + actual_instance: Optional[Union[LocalIdentifier, Value]] = None + one_of_schemas: Set[str] = { "LocalIdentifier", "Value" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = AlertConditionOperand.model_construct() + error_messages = [] + match = 0 + # validate data type: LocalIdentifier + if not isinstance(v, LocalIdentifier): + error_messages.append(f"Error! Input type `{type(v)}` is not `LocalIdentifier`") + else: + match += 1 + # validate data type: Value + if not isinstance(v, Value): + error_messages.append(f"Error! Input type `{type(v)}` is not `Value`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in AlertConditionOperand with oneOf schemas: LocalIdentifier, Value. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in AlertConditionOperand with oneOf schemas: LocalIdentifier, Value. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into LocalIdentifier + try: + instance.actual_instance = LocalIdentifier.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into Value + try: + instance.actual_instance = Value.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into AlertConditionOperand with oneOf schemas: LocalIdentifier, Value. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into AlertConditionOperand with oneOf schemas: LocalIdentifier, Value. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], LocalIdentifier, Value]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/alert_description.py b/gooddata-api-client/gooddata_api_client/models/alert_description.py new file mode 100644 index 000000000..386b77f6c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/alert_description.py @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from gooddata_api_client.models.alert_evaluation_row import AlertEvaluationRow +from typing import Optional, Set +from typing_extensions import Self + +class AlertDescription(BaseModel): + """ + AlertDescription + """ # noqa: E501 + attribute: Optional[StrictStr] = None + condition: StrictStr + current_values: Optional[List[AlertEvaluationRow]] = Field(default=None, alias="currentValues") + error_message: Optional[StrictStr] = Field(default=None, alias="errorMessage") + formatted_threshold: Optional[StrictStr] = Field(default=None, alias="formattedThreshold") + lower_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="lowerThreshold") + metric: StrictStr + remaining_alert_evaluation_count: Optional[StrictInt] = Field(default=None, alias="remainingAlertEvaluationCount") + status: Optional[StrictStr] = None + threshold: Optional[Union[StrictFloat, StrictInt]] = None + total_value_count: Optional[StrictInt] = Field(default=None, alias="totalValueCount") + trace_id: Optional[StrictStr] = Field(default=None, alias="traceId") + triggered_at: Optional[datetime] = Field(default=None, alias="triggeredAt") + triggered_count: Optional[StrictInt] = Field(default=None, alias="triggeredCount") + upper_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="upperThreshold") + __properties: ClassVar[List[str]] = ["attribute", "condition", "currentValues", "errorMessage", "formattedThreshold", "lowerThreshold", "metric", "remainingAlertEvaluationCount", "status", "threshold", "totalValueCount", "traceId", "triggeredAt", "triggeredCount", "upperThreshold"] + + @field_validator('status') + def status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SUCCESS', 'ERROR', 'INTERNAL_ERROR', 'TIMEOUT']): + raise ValueError("must be one of enum values ('SUCCESS', 'ERROR', 'INTERNAL_ERROR', 'TIMEOUT')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AlertDescription from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in current_values (list) + _items = [] + if self.current_values: + for _item_current_values in self.current_values: + if _item_current_values: + _items.append(_item_current_values.to_dict()) + _dict['currentValues'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AlertDescription from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attribute": obj.get("attribute"), + "condition": obj.get("condition"), + "currentValues": [AlertEvaluationRow.from_dict(_item) for _item in obj["currentValues"]] if obj.get("currentValues") is not None else None, + "errorMessage": obj.get("errorMessage"), + "formattedThreshold": obj.get("formattedThreshold"), + "lowerThreshold": obj.get("lowerThreshold"), + "metric": obj.get("metric"), + "remainingAlertEvaluationCount": obj.get("remainingAlertEvaluationCount"), + "status": obj.get("status"), + "threshold": obj.get("threshold"), + "totalValueCount": obj.get("totalValueCount"), + "traceId": obj.get("traceId"), + "triggeredAt": obj.get("triggeredAt"), + "triggeredCount": obj.get("triggeredCount"), + "upperThreshold": obj.get("upperThreshold") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/alert_evaluation_row.py b/gooddata-api-client/gooddata_api_client/models/alert_evaluation_row.py new file mode 100644 index 000000000..25ec4900d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/alert_evaluation_row.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.metric_record import MetricRecord +from typing import Optional, Set +from typing_extensions import Self + +class AlertEvaluationRow(BaseModel): + """ + AlertEvaluationRow + """ # noqa: E501 + computed_metric: Optional[MetricRecord] = Field(default=None, alias="computedMetric") + label_value: Optional[StrictStr] = Field(default=None, alias="labelValue") + primary_metric: Optional[MetricRecord] = Field(default=None, alias="primaryMetric") + secondary_metric: Optional[MetricRecord] = Field(default=None, alias="secondaryMetric") + __properties: ClassVar[List[str]] = ["computedMetric", "labelValue", "primaryMetric", "secondaryMetric"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AlertEvaluationRow from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of computed_metric + if self.computed_metric: + _dict['computedMetric'] = self.computed_metric.to_dict() + # override the default output from pydantic by calling `to_dict()` of primary_metric + if self.primary_metric: + _dict['primaryMetric'] = self.primary_metric.to_dict() + # override the default output from pydantic by calling `to_dict()` of secondary_metric + if self.secondary_metric: + _dict['secondaryMetric'] = self.secondary_metric.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AlertEvaluationRow from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "computedMetric": MetricRecord.from_dict(obj["computedMetric"]) if obj.get("computedMetric") is not None else None, + "labelValue": obj.get("labelValue"), + "primaryMetric": MetricRecord.from_dict(obj["primaryMetric"]) if obj.get("primaryMetric") is not None else None, + "secondaryMetric": MetricRecord.from_dict(obj["secondaryMetric"]) if obj.get("secondaryMetric") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/analytics_catalog_tags.py b/gooddata-api-client/gooddata_api_client/models/analytics_catalog_tags.py new file mode 100644 index 000000000..829650dff --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/analytics_catalog_tags.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AnalyticsCatalogTags(BaseModel): + """ + AnalyticsCatalogTags + """ # noqa: E501 + tags: List[StrictStr] + __properties: ClassVar[List[str]] = ["tags"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalyticsCatalogTags from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalyticsCatalogTags from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tags": obj.get("tags") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/anomaly_detection_request.py b/gooddata-api-client/gooddata_api_client/models/anomaly_detection_request.py new file mode 100644 index 000000000..9e01b5b95 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/anomaly_detection_request.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt +from typing import Any, ClassVar, Dict, List, Union +from typing import Optional, Set +from typing_extensions import Self + +class AnomalyDetectionRequest(BaseModel): + """ + AnomalyDetectionRequest + """ # noqa: E501 + sensitivity: Union[StrictFloat, StrictInt] = Field(description="Anomaly detection sensitivity.") + __properties: ClassVar[List[str]] = ["sensitivity"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnomalyDetectionRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnomalyDetectionRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sensitivity": obj.get("sensitivity") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/anomaly_detection_result.py b/gooddata-api-client/gooddata_api_client/models/anomaly_detection_result.py new file mode 100644 index 000000000..89d96873a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/anomaly_detection_result.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class AnomalyDetectionResult(BaseModel): + """ + AnomalyDetectionResult + """ # noqa: E501 + anomaly_flag: List[Optional[StrictBool]] = Field(alias="anomalyFlag") + attribute: List[StrictStr] + values: List[Optional[Union[StrictFloat, StrictInt]]] + __properties: ClassVar[List[str]] = ["anomalyFlag", "attribute", "values"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnomalyDetectionResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnomalyDetectionResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "anomalyFlag": obj.get("anomalyFlag"), + "attribute": obj.get("attribute"), + "values": obj.get("values") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/api_entitlement.py b/gooddata-api-client/gooddata_api_client/models/api_entitlement.py new file mode 100644 index 000000000..b08f8c114 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/api_entitlement.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import date +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ApiEntitlement(BaseModel): + """ + ApiEntitlement + """ # noqa: E501 + expiry: Optional[date] = None + name: StrictStr + value: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["expiry", "name", "value"] + + @field_validator('name') + def name_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['CacheStrategy', 'Contract', 'CustomTheming', 'ExtraCache', 'Hipaa', 'PdfExports', 'ManagedOIDC', 'UiLocalization', 'Tier', 'UserCount', 'ManagedIdpUserCount', 'UnlimitedUsers', 'UnlimitedWorkspaces', 'WhiteLabeling', 'WorkspaceCount', 'UserTelemetryDisabled', 'AutomationCount', 'UnlimitedAutomations', 'AutomationRecipientCount', 'UnlimitedAutomationRecipients', 'DailyScheduledActionCount', 'UnlimitedDailyScheduledActions', 'DailyAlertActionCount', 'UnlimitedDailyAlertActions', 'ScheduledActionMinimumRecurrenceMinutes', 'FederatedIdentityManagement', 'AuditLogging', 'ControlledFeatureRollout']): + raise ValueError("must be one of enum values ('CacheStrategy', 'Contract', 'CustomTheming', 'ExtraCache', 'Hipaa', 'PdfExports', 'ManagedOIDC', 'UiLocalization', 'Tier', 'UserCount', 'ManagedIdpUserCount', 'UnlimitedUsers', 'UnlimitedWorkspaces', 'WhiteLabeling', 'WorkspaceCount', 'UserTelemetryDisabled', 'AutomationCount', 'UnlimitedAutomations', 'AutomationRecipientCount', 'UnlimitedAutomationRecipients', 'DailyScheduledActionCount', 'UnlimitedDailyScheduledActions', 'DailyAlertActionCount', 'UnlimitedDailyAlertActions', 'ScheduledActionMinimumRecurrenceMinutes', 'FederatedIdentityManagement', 'AuditLogging', 'ControlledFeatureRollout')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ApiEntitlement from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ApiEntitlement from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "expiry": obj.get("expiry"), + "name": obj.get("name"), + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/arithmetic_measure.py b/gooddata-api-client/gooddata_api_client/models/arithmetic_measure.py new file mode 100644 index 000000000..cf397c493 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/arithmetic_measure.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.local_identifier import LocalIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class ArithmeticMeasure(BaseModel): + """ + ArithmeticMeasure + """ # noqa: E501 + left: LocalIdentifier + operator: StrictStr = Field(description="Arithmetic operator. DIFFERENCE - m₁−m₂ - the difference between two metrics. CHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics. ") + right: LocalIdentifier + __properties: ClassVar[List[str]] = ["left", "operator", "right"] + + @field_validator('operator') + def operator_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['DIFFERENCE', 'CHANGE']): + raise ValueError("must be one of enum values ('DIFFERENCE', 'CHANGE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ArithmeticMeasure from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of left + if self.left: + _dict['left'] = self.left.to_dict() + # override the default output from pydantic by calling `to_dict()` of right + if self.right: + _dict['right'] = self.right.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ArithmeticMeasure from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "left": LocalIdentifier.from_dict(obj["left"]) if obj.get("left") is not None else None, + "operator": obj.get("operator"), + "right": LocalIdentifier.from_dict(obj["right"]) if obj.get("right") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/arithmetic_measure_definition.py b/gooddata-api-client/gooddata_api_client/models/arithmetic_measure_definition.py new file mode 100644 index 000000000..419cb2c14 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/arithmetic_measure_definition.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.arithmetic_measure_definition_arithmetic_measure import ArithmeticMeasureDefinitionArithmeticMeasure +from typing import Optional, Set +from typing_extensions import Self + +class ArithmeticMeasureDefinition(BaseModel): + """ + Metric representing arithmetics between other metrics. + """ # noqa: E501 + arithmetic_measure: ArithmeticMeasureDefinitionArithmeticMeasure = Field(alias="arithmeticMeasure") + __properties: ClassVar[List[str]] = ["arithmeticMeasure"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ArithmeticMeasureDefinition from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of arithmetic_measure + if self.arithmetic_measure: + _dict['arithmeticMeasure'] = self.arithmetic_measure.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ArithmeticMeasureDefinition from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "arithmeticMeasure": ArithmeticMeasureDefinitionArithmeticMeasure.from_dict(obj["arithmeticMeasure"]) if obj.get("arithmeticMeasure") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/arithmetic_measure_definition_arithmetic_measure.py b/gooddata-api-client/gooddata_api_client/models/arithmetic_measure_definition_arithmetic_measure.py new file mode 100644 index 000000000..31e492c95 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/arithmetic_measure_definition_arithmetic_measure.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_local_identifier import AfmLocalIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class ArithmeticMeasureDefinitionArithmeticMeasure(BaseModel): + """ + ArithmeticMeasureDefinitionArithmeticMeasure + """ # noqa: E501 + measure_identifiers: List[AfmLocalIdentifier] = Field(description="List of metrics to apply arithmetic operation by chosen operator.", alias="measureIdentifiers") + operator: StrictStr = Field(description="Arithmetic operator describing operation between metrics.") + __properties: ClassVar[List[str]] = ["measureIdentifiers", "operator"] + + @field_validator('operator') + def operator_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['SUM', 'DIFFERENCE', 'MULTIPLICATION', 'RATIO', 'CHANGE']): + raise ValueError("must be one of enum values ('SUM', 'DIFFERENCE', 'MULTIPLICATION', 'RATIO', 'CHANGE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ArithmeticMeasureDefinitionArithmeticMeasure from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in measure_identifiers (list) + _items = [] + if self.measure_identifiers: + for _item_measure_identifiers in self.measure_identifiers: + if _item_measure_identifiers: + _items.append(_item_measure_identifiers.to_dict()) + _dict['measureIdentifiers'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ArithmeticMeasureDefinitionArithmeticMeasure from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "measureIdentifiers": [AfmLocalIdentifier.from_dict(_item) for _item in obj["measureIdentifiers"]] if obj.get("measureIdentifiers") is not None else None, + "operator": obj.get("operator") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/assignee_identifier.py b/gooddata-api-client/gooddata_api_client/models/assignee_identifier.py new file mode 100644 index 000000000..2976b68cc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/assignee_identifier.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AssigneeIdentifier(BaseModel): + """ + Identifier of a user or user-group. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['user', 'userGroup']): + raise ValueError("must be one of enum values ('user', 'userGroup')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssigneeIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssigneeIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/assignee_rule.py b/gooddata-api-client/gooddata_api_client/models/assignee_rule.py new file mode 100644 index 000000000..912b16cf8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/assignee_rule.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AssigneeRule(BaseModel): + """ + Identifier of an assignee rule. + """ # noqa: E501 + type: StrictStr + __properties: ClassVar[List[str]] = ["type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['allWorkspaceUsers']): + raise ValueError("must be one of enum values ('allWorkspaceUsers')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssigneeRule from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssigneeRule from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_elements.py b/gooddata-api-client/gooddata_api_client/models/attribute_elements.py new file mode 100644 index 000000000..e2179385e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_elements.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.attribute_elements_by_ref import AttributeElementsByRef +from gooddata_api_client.models.attribute_elements_by_value import AttributeElementsByValue +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +ATTRIBUTEELEMENTS_ONE_OF_SCHEMAS = ["AttributeElementsByRef", "AttributeElementsByValue"] + +class AttributeElements(BaseModel): + """ + AttributeElements + """ + # data type: AttributeElementsByRef + oneof_schema_1_validator: Optional[AttributeElementsByRef] = None + # data type: AttributeElementsByValue + oneof_schema_2_validator: Optional[AttributeElementsByValue] = None + actual_instance: Optional[Union[AttributeElementsByRef, AttributeElementsByValue]] = None + one_of_schemas: Set[str] = { "AttributeElementsByRef", "AttributeElementsByValue" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = AttributeElements.model_construct() + error_messages = [] + match = 0 + # validate data type: AttributeElementsByRef + if not isinstance(v, AttributeElementsByRef): + error_messages.append(f"Error! Input type `{type(v)}` is not `AttributeElementsByRef`") + else: + match += 1 + # validate data type: AttributeElementsByValue + if not isinstance(v, AttributeElementsByValue): + error_messages.append(f"Error! Input type `{type(v)}` is not `AttributeElementsByValue`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in AttributeElements with oneOf schemas: AttributeElementsByRef, AttributeElementsByValue. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in AttributeElements with oneOf schemas: AttributeElementsByRef, AttributeElementsByValue. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into AttributeElementsByRef + try: + instance.actual_instance = AttributeElementsByRef.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into AttributeElementsByValue + try: + instance.actual_instance = AttributeElementsByValue.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into AttributeElements with oneOf schemas: AttributeElementsByRef, AttributeElementsByValue. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into AttributeElements with oneOf schemas: AttributeElementsByRef, AttributeElementsByValue. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], AttributeElementsByRef, AttributeElementsByValue]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_elements_by_ref.py b/gooddata-api-client/gooddata_api_client/models/attribute_elements_by_ref.py new file mode 100644 index 000000000..6f4f6b35f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_elements_by_ref.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AttributeElementsByRef(BaseModel): + """ + AttributeElementsByRef + """ # noqa: E501 + uris: List[Optional[StrictStr]] = Field(description="List of attribute elements by reference") + __properties: ClassVar[List[str]] = ["uris"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeElementsByRef from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeElementsByRef from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uris": obj.get("uris") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_elements_by_value.py b/gooddata-api-client/gooddata_api_client/models/attribute_elements_by_value.py new file mode 100644 index 000000000..253315428 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_elements_by_value.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AttributeElementsByValue(BaseModel): + """ + AttributeElementsByValue + """ # noqa: E501 + values: List[Optional[StrictStr]] = Field(description="List of attribute elements by value") + __properties: ClassVar[List[str]] = ["values"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeElementsByValue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeElementsByValue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "values": obj.get("values") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_execution_result_header.py b/gooddata-api-client/gooddata_api_client/models/attribute_execution_result_header.py new file mode 100644 index 000000000..e12412392 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_execution_result_header.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.attribute_result_header import AttributeResultHeader +from typing import Optional, Set +from typing_extensions import Self + +class AttributeExecutionResultHeader(BaseModel): + """ + AttributeExecutionResultHeader + """ # noqa: E501 + attribute_header: AttributeResultHeader = Field(alias="attributeHeader") + __properties: ClassVar[List[str]] = ["attributeHeader"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeExecutionResultHeader from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attribute_header + if self.attribute_header: + _dict['attributeHeader'] = self.attribute_header.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeExecutionResultHeader from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributeHeader": AttributeResultHeader.from_dict(obj["attributeHeader"]) if obj.get("attributeHeader") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_filter.py b/gooddata-api-client/gooddata_api_client/models/attribute_filter.py new file mode 100644 index 000000000..ad4cf7437 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_filter.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.negative_attribute_filter import NegativeAttributeFilter +from gooddata_api_client.models.positive_attribute_filter import PositiveAttributeFilter +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +ATTRIBUTEFILTER_ONE_OF_SCHEMAS = ["NegativeAttributeFilter", "PositiveAttributeFilter"] + +class AttributeFilter(BaseModel): + """ + Abstract filter definition type attributes + """ + # data type: NegativeAttributeFilter + oneof_schema_1_validator: Optional[NegativeAttributeFilter] = None + # data type: PositiveAttributeFilter + oneof_schema_2_validator: Optional[PositiveAttributeFilter] = None + actual_instance: Optional[Union[NegativeAttributeFilter, PositiveAttributeFilter]] = None + one_of_schemas: Set[str] = { "NegativeAttributeFilter", "PositiveAttributeFilter" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = AttributeFilter.model_construct() + error_messages = [] + match = 0 + # validate data type: NegativeAttributeFilter + if not isinstance(v, NegativeAttributeFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `NegativeAttributeFilter`") + else: + match += 1 + # validate data type: PositiveAttributeFilter + if not isinstance(v, PositiveAttributeFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `PositiveAttributeFilter`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in AttributeFilter with oneOf schemas: NegativeAttributeFilter, PositiveAttributeFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in AttributeFilter with oneOf schemas: NegativeAttributeFilter, PositiveAttributeFilter. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into NegativeAttributeFilter + try: + instance.actual_instance = NegativeAttributeFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into PositiveAttributeFilter + try: + instance.actual_instance = PositiveAttributeFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into AttributeFilter with oneOf schemas: NegativeAttributeFilter, PositiveAttributeFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into AttributeFilter with oneOf schemas: NegativeAttributeFilter, PositiveAttributeFilter. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], NegativeAttributeFilter, PositiveAttributeFilter]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_filter_by_date.py b/gooddata-api-client/gooddata_api_client/models/attribute_filter_by_date.py new file mode 100644 index 000000000..419cd5d07 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_filter_by_date.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AttributeFilterByDate(BaseModel): + """ + AttributeFilterByDate + """ # noqa: E501 + filter_local_identifier: StrictStr = Field(alias="filterLocalIdentifier") + is_common_date: StrictBool = Field(alias="isCommonDate") + __properties: ClassVar[List[str]] = ["filterLocalIdentifier", "isCommonDate"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeFilterByDate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeFilterByDate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "filterLocalIdentifier": obj.get("filterLocalIdentifier"), + "isCommonDate": obj.get("isCommonDate") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_filter_elements.py b/gooddata-api-client/gooddata_api_client/models/attribute_filter_elements.py new file mode 100644 index 000000000..581142358 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_filter_elements.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AttributeFilterElements(BaseModel): + """ + Filter on specific set of label values. + """ # noqa: E501 + values: List[Optional[StrictStr]] = Field(description="Set of label values.") + __properties: ClassVar[List[str]] = ["values"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeFilterElements from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeFilterElements from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "values": obj.get("values") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_filter_parent.py b/gooddata-api-client/gooddata_api_client/models/attribute_filter_parent.py new file mode 100644 index 000000000..5ffc3c63b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_filter_parent.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.over import Over +from typing import Optional, Set +from typing_extensions import Self + +class AttributeFilterParent(BaseModel): + """ + AttributeFilterParent + """ # noqa: E501 + filter_local_identifier: StrictStr = Field(alias="filterLocalIdentifier") + over: Over + __properties: ClassVar[List[str]] = ["filterLocalIdentifier", "over"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeFilterParent from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of over + if self.over: + _dict['over'] = self.over.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeFilterParent from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "filterLocalIdentifier": obj.get("filterLocalIdentifier"), + "over": Over.from_dict(obj["over"]) if obj.get("over") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_format.py b/gooddata-api-client/gooddata_api_client/models/attribute_format.py new file mode 100644 index 000000000..60a076528 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_format.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AttributeFormat(BaseModel): + """ + Attribute format describes formatting information to effectively format attribute values when needed. + """ # noqa: E501 + locale: StrictStr = Field(description="Format locale code like 'en-US', 'cs-CZ', etc.") + pattern: StrictStr = Field(description="ICU formatting pattern like 'y', 'dd.MM.y', etc.") + timezone: Optional[StrictStr] = Field(default=None, description="Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc.") + __properties: ClassVar[List[str]] = ["locale", "pattern", "timezone"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeFormat from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeFormat from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "locale": obj.get("locale"), + "pattern": obj.get("pattern"), + "timezone": obj.get("timezone") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_header.py b/gooddata-api-client/gooddata_api_client/models/attribute_header.py new file mode 100644 index 000000000..6597f50b1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_header.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.attribute_header_attribute_header import AttributeHeaderAttributeHeader +from typing import Optional, Set +from typing_extensions import Self + +class AttributeHeader(BaseModel): + """ + AttributeHeader + """ # noqa: E501 + attribute_header: AttributeHeaderAttributeHeader = Field(alias="attributeHeader") + __properties: ClassVar[List[str]] = ["attributeHeader"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeHeader from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attribute_header + if self.attribute_header: + _dict['attributeHeader'] = self.attribute_header.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeHeader from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributeHeader": AttributeHeaderAttributeHeader.from_dict(obj["attributeHeader"]) if obj.get("attributeHeader") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_header_attribute_header.py b/gooddata-api-client/gooddata_api_client/models/attribute_header_attribute_header.py new file mode 100644 index 000000000..b0cffa705 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_header_attribute_header.py @@ -0,0 +1,146 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.attribute_format import AttributeFormat +from gooddata_api_client.models.rest_api_identifier import RestApiIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class AttributeHeaderAttributeHeader(BaseModel): + """ + AttributeHeaderAttributeHeader + """ # noqa: E501 + attribute: RestApiIdentifier + attribute_name: StrictStr = Field(description="Attribute name.", alias="attributeName") + format: Optional[AttributeFormat] = None + granularity: Optional[StrictStr] = Field(default=None, description="Date granularity of the attribute, only filled for date attributes.") + label: RestApiIdentifier + label_name: StrictStr = Field(description="Label name.", alias="labelName") + local_identifier: Annotated[str, Field(strict=True)] = Field(description="Local identifier of the attribute this header relates to.", alias="localIdentifier") + primary_label: RestApiIdentifier = Field(alias="primaryLabel") + value_type: Optional[StrictStr] = Field(default=None, description="Attribute value type.", alias="valueType") + __properties: ClassVar[List[str]] = ["attribute", "attributeName", "format", "granularity", "label", "labelName", "localIdentifier", "primaryLabel", "valueType"] + + @field_validator('granularity') + def granularity_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR']): + raise ValueError("must be one of enum values ('MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR')") + return value + + @field_validator('local_identifier') + def local_identifier_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[.a-zA-Z0-9_-]+$", value): + raise ValueError(r"must validate the regular expression /^[.a-zA-Z0-9_-]+$/") + return value + + @field_validator('value_type') + def value_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TEXT', 'HYPERLINK', 'GEO', 'GEO_LONGITUDE', 'GEO_LATITUDE', 'IMAGE']): + raise ValueError("must be one of enum values ('TEXT', 'HYPERLINK', 'GEO', 'GEO_LONGITUDE', 'GEO_LATITUDE', 'IMAGE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeHeaderAttributeHeader from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attribute + if self.attribute: + _dict['attribute'] = self.attribute.to_dict() + # override the default output from pydantic by calling `to_dict()` of format + if self.format: + _dict['format'] = self.format.to_dict() + # override the default output from pydantic by calling `to_dict()` of label + if self.label: + _dict['label'] = self.label.to_dict() + # override the default output from pydantic by calling `to_dict()` of primary_label + if self.primary_label: + _dict['primaryLabel'] = self.primary_label.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeHeaderAttributeHeader from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attribute": RestApiIdentifier.from_dict(obj["attribute"]) if obj.get("attribute") is not None else None, + "attributeName": obj.get("attributeName"), + "format": AttributeFormat.from_dict(obj["format"]) if obj.get("format") is not None else None, + "granularity": obj.get("granularity"), + "label": RestApiIdentifier.from_dict(obj["label"]) if obj.get("label") is not None else None, + "labelName": obj.get("labelName"), + "localIdentifier": obj.get("localIdentifier"), + "primaryLabel": RestApiIdentifier.from_dict(obj["primaryLabel"]) if obj.get("primaryLabel") is not None else None, + "valueType": obj.get("valueType") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_item.py b/gooddata-api-client/gooddata_api_client/models/attribute_item.py new file mode 100644 index 000000000..5c19557be --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_item.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.afm_object_identifier_label import AfmObjectIdentifierLabel +from typing import Optional, Set +from typing_extensions import Self + +class AttributeItem(BaseModel): + """ + AttributeItem + """ # noqa: E501 + label: AfmObjectIdentifierLabel + local_identifier: Annotated[str, Field(strict=True)] = Field(description="Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.", alias="localIdentifier") + show_all_values: Optional[StrictBool] = Field(default=False, description="Indicates whether to show all values of given attribute even if the data bound to those values is not available.", alias="showAllValues") + __properties: ClassVar[List[str]] = ["label", "localIdentifier", "showAllValues"] + + @field_validator('local_identifier') + def local_identifier_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[.a-zA-Z0-9_-]+$", value): + raise ValueError(r"must validate the regular expression /^[.a-zA-Z0-9_-]+$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeItem from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of label + if self.label: + _dict['label'] = self.label.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeItem from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "label": AfmObjectIdentifierLabel.from_dict(obj["label"]) if obj.get("label") is not None else None, + "localIdentifier": obj.get("localIdentifier"), + "showAllValues": obj.get("showAllValues") if obj.get("showAllValues") is not None else False + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_negative_filter.py b/gooddata-api-client/gooddata_api_client/models/attribute_negative_filter.py new file mode 100644 index 000000000..38f8b4dcf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_negative_filter.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AttributeNegativeFilter(BaseModel): + """ + AttributeNegativeFilter + """ # noqa: E501 + exclude: List[StrictStr] + using: StrictStr + __properties: ClassVar[List[str]] = ["exclude", "using"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeNegativeFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeNegativeFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "exclude": obj.get("exclude"), + "using": obj.get("using") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_positive_filter.py b/gooddata-api-client/gooddata_api_client/models/attribute_positive_filter.py new file mode 100644 index 000000000..3712ac7fd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_positive_filter.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AttributePositiveFilter(BaseModel): + """ + AttributePositiveFilter + """ # noqa: E501 + include: List[StrictStr] + using: StrictStr + __properties: ClassVar[List[str]] = ["include", "using"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributePositiveFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributePositiveFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "include": obj.get("include"), + "using": obj.get("using") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/attribute_result_header.py b/gooddata-api-client/gooddata_api_client/models/attribute_result_header.py new file mode 100644 index 000000000..f7690a90d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/attribute_result_header.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AttributeResultHeader(BaseModel): + """ + Header containing the information related to attributes. + """ # noqa: E501 + label_value: StrictStr = Field(description="A value of the current attribute label.", alias="labelValue") + primary_label_value: StrictStr = Field(description="A value of the primary attribute label.", alias="primaryLabelValue") + __properties: ClassVar[List[str]] = ["labelValue", "primaryLabelValue"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AttributeResultHeader from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AttributeResultHeader from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "labelValue": obj.get("labelValue"), + "primaryLabelValue": obj.get("primaryLabelValue") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_alert.py b/gooddata-api-client/gooddata_api_client/models/automation_alert.py new file mode 100644 index 000000000..42c88e278 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_alert.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.alert_afm import AlertAfm +from gooddata_api_client.models.automation_alert_condition import AutomationAlertCondition +from typing import Optional, Set +from typing_extensions import Self + +class AutomationAlert(BaseModel): + """ + AutomationAlert + """ # noqa: E501 + condition: AutomationAlertCondition + execution: AlertAfm + trigger: Optional[StrictStr] = Field(default='ALWAYS', description="Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ") + __properties: ClassVar[List[str]] = ["condition", "execution", "trigger"] + + @field_validator('trigger') + def trigger_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ALWAYS', 'ONCE']): + raise ValueError("must be one of enum values ('ALWAYS', 'ONCE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AutomationAlert from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of condition + if self.condition: + _dict['condition'] = self.condition.to_dict() + # override the default output from pydantic by calling `to_dict()` of execution + if self.execution: + _dict['execution'] = self.execution.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AutomationAlert from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "condition": AutomationAlertCondition.from_dict(obj["condition"]) if obj.get("condition") is not None else None, + "execution": AlertAfm.from_dict(obj["execution"]) if obj.get("execution") is not None else None, + "trigger": obj.get("trigger") if obj.get("trigger") is not None else 'ALWAYS' + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_alert_condition.py b/gooddata-api-client/gooddata_api_client/models/automation_alert_condition.py new file mode 100644 index 000000000..bd02e1beb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_alert_condition.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.comparison_wrapper import ComparisonWrapper +from gooddata_api_client.models.range_wrapper import RangeWrapper +from gooddata_api_client.models.relative_wrapper import RelativeWrapper +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +AUTOMATIONALERTCONDITION_ONE_OF_SCHEMAS = ["ComparisonWrapper", "RangeWrapper", "RelativeWrapper"] + +class AutomationAlertCondition(BaseModel): + """ + AutomationAlertCondition + """ + # data type: ComparisonWrapper + oneof_schema_1_validator: Optional[ComparisonWrapper] = None + # data type: RangeWrapper + oneof_schema_2_validator: Optional[RangeWrapper] = None + # data type: RelativeWrapper + oneof_schema_3_validator: Optional[RelativeWrapper] = None + actual_instance: Optional[Union[ComparisonWrapper, RangeWrapper, RelativeWrapper]] = None + one_of_schemas: Set[str] = { "ComparisonWrapper", "RangeWrapper", "RelativeWrapper" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = AutomationAlertCondition.model_construct() + error_messages = [] + match = 0 + # validate data type: ComparisonWrapper + if not isinstance(v, ComparisonWrapper): + error_messages.append(f"Error! Input type `{type(v)}` is not `ComparisonWrapper`") + else: + match += 1 + # validate data type: RangeWrapper + if not isinstance(v, RangeWrapper): + error_messages.append(f"Error! Input type `{type(v)}` is not `RangeWrapper`") + else: + match += 1 + # validate data type: RelativeWrapper + if not isinstance(v, RelativeWrapper): + error_messages.append(f"Error! Input type `{type(v)}` is not `RelativeWrapper`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in AutomationAlertCondition with oneOf schemas: ComparisonWrapper, RangeWrapper, RelativeWrapper. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in AutomationAlertCondition with oneOf schemas: ComparisonWrapper, RangeWrapper, RelativeWrapper. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into ComparisonWrapper + try: + instance.actual_instance = ComparisonWrapper.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RangeWrapper + try: + instance.actual_instance = RangeWrapper.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RelativeWrapper + try: + instance.actual_instance = RelativeWrapper.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into AutomationAlertCondition with oneOf schemas: ComparisonWrapper, RangeWrapper, RelativeWrapper. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into AutomationAlertCondition with oneOf schemas: ComparisonWrapper, RangeWrapper, RelativeWrapper. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], ComparisonWrapper, RangeWrapper, RelativeWrapper]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_dashboard_tabular_export.py b/gooddata-api-client/gooddata_api_client/models/automation_dashboard_tabular_export.py new file mode 100644 index 000000000..3de74641c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_dashboard_tabular_export.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 +from typing import Optional, Set +from typing_extensions import Self + +class AutomationDashboardTabularExport(BaseModel): + """ + AutomationDashboardTabularExport + """ # noqa: E501 + request_payload: DashboardTabularExportRequestV2 = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AutomationDashboardTabularExport from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AutomationDashboardTabularExport from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": DashboardTabularExportRequestV2.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_external_recipient.py b/gooddata-api-client/gooddata_api_client/models/automation_external_recipient.py new file mode 100644 index 000000000..d7122ab1b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_external_recipient.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AutomationExternalRecipient(BaseModel): + """ + AutomationExternalRecipient + """ # noqa: E501 + email: StrictStr = Field(description="E-mail address to send notifications from.") + __properties: ClassVar[List[str]] = ["email"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AutomationExternalRecipient from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AutomationExternalRecipient from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "email": obj.get("email") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_image_export.py b/gooddata-api-client/gooddata_api_client/models/automation_image_export.py new file mode 100644 index 000000000..b908ef88f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_image_export.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.image_export_request import ImageExportRequest +from typing import Optional, Set +from typing_extensions import Self + +class AutomationImageExport(BaseModel): + """ + AutomationImageExport + """ # noqa: E501 + request_payload: ImageExportRequest = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AutomationImageExport from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AutomationImageExport from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": ImageExportRequest.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_metadata.py b/gooddata-api-client/gooddata_api_client/models/automation_metadata.py new file mode 100644 index 000000000..f242953bc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_metadata.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.visible_filter import VisibleFilter +from typing import Optional, Set +from typing_extensions import Self + +class AutomationMetadata(BaseModel): + """ + Additional information for the automation. + """ # noqa: E501 + visible_filters: Optional[List[VisibleFilter]] = Field(default=None, alias="visibleFilters") + widget: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["visibleFilters", "widget"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AutomationMetadata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in visible_filters (list) + _items = [] + if self.visible_filters: + for _item_visible_filters in self.visible_filters: + if _item_visible_filters: + _items.append(_item_visible_filters.to_dict()) + _dict['visibleFilters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AutomationMetadata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "visibleFilters": [VisibleFilter.from_dict(_item) for _item in obj["visibleFilters"]] if obj.get("visibleFilters") is not None else None, + "widget": obj.get("widget") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_notification.py b/gooddata-api-client/gooddata_api_client/models/automation_notification.py new file mode 100644 index 000000000..4e08d6f47 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_notification.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.notification_content import NotificationContent +from gooddata_api_client.models.webhook_message import WebhookMessage +from typing import Optional, Set +from typing_extensions import Self + +class AutomationNotification(NotificationContent): + """ + AutomationNotification + """ # noqa: E501 + content: WebhookMessage + __properties: ClassVar[List[str]] = ["type", "content"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AutomationNotification from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of content + if self.content: + _dict['content'] = self.content.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AutomationNotification from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "type": obj.get("type"), + "content": WebhookMessage.from_dict(obj["content"]) if obj.get("content") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_raw_export.py b/gooddata-api-client/gooddata_api_client/models/automation_raw_export.py new file mode 100644 index 000000000..b3aa533de --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_raw_export.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.raw_export_automation_request import RawExportAutomationRequest +from typing import Optional, Set +from typing_extensions import Self + +class AutomationRawExport(BaseModel): + """ + AutomationRawExport + """ # noqa: E501 + request_payload: RawExportAutomationRequest = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AutomationRawExport from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AutomationRawExport from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": RawExportAutomationRequest.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_schedule.py b/gooddata-api-client/gooddata_api_client/models/automation_schedule.py new file mode 100644 index 000000000..756f4a73a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_schedule.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AutomationSchedule(BaseModel): + """ + AutomationSchedule + """ # noqa: E501 + cron: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.") + cron_description: Optional[StrictStr] = Field(default=None, description="Human-readable description of the cron expression.", alias="cronDescription") + first_run: Optional[datetime] = Field(default=None, description="Timestamp of the first scheduled action. If not provided default to the next scheduled time.", alias="firstRun") + timezone: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Timezone in which the schedule is defined.") + __properties: ClassVar[List[str]] = ["cron", "cronDescription", "firstRun", "timezone"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AutomationSchedule from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "cron_description", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AutomationSchedule from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cron": obj.get("cron"), + "cronDescription": obj.get("cronDescription"), + "firstRun": obj.get("firstRun"), + "timezone": obj.get("timezone") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_slides_export.py b/gooddata-api-client/gooddata_api_client/models/automation_slides_export.py new file mode 100644 index 000000000..a53d65e04 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_slides_export.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.slides_export_request import SlidesExportRequest +from typing import Optional, Set +from typing_extensions import Self + +class AutomationSlidesExport(BaseModel): + """ + AutomationSlidesExport + """ # noqa: E501 + request_payload: SlidesExportRequest = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AutomationSlidesExport from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AutomationSlidesExport from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": SlidesExportRequest.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_tabular_export.py b/gooddata-api-client/gooddata_api_client/models/automation_tabular_export.py new file mode 100644 index 000000000..2bb6d699c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_tabular_export.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from typing import Optional, Set +from typing_extensions import Self + +class AutomationTabularExport(BaseModel): + """ + AutomationTabularExport + """ # noqa: E501 + request_payload: TabularExportRequest = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AutomationTabularExport from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AutomationTabularExport from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": TabularExportRequest.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/automation_visual_export.py b/gooddata-api-client/gooddata_api_client/models/automation_visual_export.py new file mode 100644 index 000000000..5cb93b0b5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/automation_visual_export.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.visual_export_request import VisualExportRequest +from typing import Optional, Set +from typing_extensions import Self + +class AutomationVisualExport(BaseModel): + """ + AutomationVisualExport + """ # noqa: E501 + request_payload: VisualExportRequest = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AutomationVisualExport from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AutomationVisualExport from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": VisualExportRequest.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/available_assignees.py b/gooddata-api-client/gooddata_api_client/models/available_assignees.py new file mode 100644 index 000000000..f9b072477 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/available_assignees.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.user_assignee import UserAssignee +from gooddata_api_client.models.user_group_assignee import UserGroupAssignee +from typing import Optional, Set +from typing_extensions import Self + +class AvailableAssignees(BaseModel): + """ + AvailableAssignees + """ # noqa: E501 + user_groups: List[UserGroupAssignee] = Field(description="List of user groups", alias="userGroups") + users: List[UserAssignee] = Field(description="List of users") + __properties: ClassVar[List[str]] = ["userGroups", "users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AvailableAssignees from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AvailableAssignees from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroups": [UserGroupAssignee.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None, + "users": [UserAssignee.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/bounded_filter.py b/gooddata-api-client/gooddata_api_client/models/bounded_filter.py new file mode 100644 index 000000000..18b9a976b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/bounded_filter.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class BoundedFilter(BaseModel): + """ + Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range. + """ # noqa: E501 + var_from: Optional[StrictInt] = Field(default=None, description="Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.", alias="from") + granularity: StrictStr = Field(description="Date granularity specifying particular date attribute in given dimension.") + to: Optional[StrictInt] = Field(default=None, description="End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.") + __properties: ClassVar[List[str]] = ["from", "granularity", "to"] + + @field_validator('granularity') + def granularity_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR']): + raise ValueError("must be one of enum values ('MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of BoundedFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if var_from (nullable) is None + # and model_fields_set contains the field + if self.var_from is None and "var_from" in self.model_fields_set: + _dict['from'] = None + + # set to None if to (nullable) is None + # and model_fields_set contains the field + if self.to is None and "to" in self.model_fields_set: + _dict['to'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of BoundedFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "from": obj.get("from"), + "granularity": obj.get("granularity"), + "to": obj.get("to") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/chat_history_interaction.py b/gooddata-api-client/gooddata_api_client/models/chat_history_interaction.py new file mode 100644 index 000000000..0992414b4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/chat_history_interaction.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.created_visualizations import CreatedVisualizations +from gooddata_api_client.models.found_objects import FoundObjects +from gooddata_api_client.models.route_result import RouteResult +from typing import Optional, Set +from typing_extensions import Self + +class ChatHistoryInteraction(BaseModel): + """ + List of chat history interactions. + """ # noqa: E501 + chat_history_interaction_id: StrictStr = Field(description="Chat History interaction ID. Unique ID for each interaction.", alias="chatHistoryInteractionId") + created_visualizations: Optional[CreatedVisualizations] = Field(default=None, alias="createdVisualizations") + error_response: Optional[StrictStr] = Field(default=None, description="Error response in anything fails.", alias="errorResponse") + found_objects: Optional[FoundObjects] = Field(default=None, alias="foundObjects") + interaction_finished: StrictBool = Field(description="Has the interaction already finished? Can be used for polling when interaction is in progress.", alias="interactionFinished") + question: Annotated[str, Field(strict=True, max_length=2000)] = Field(description="User question") + routing: RouteResult + text_response: Optional[StrictStr] = Field(default=None, description="Text response for general questions.", alias="textResponse") + thread_id_suffix: Optional[StrictStr] = Field(default=None, description="Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", alias="threadIdSuffix") + user_feedback: Optional[StrictStr] = Field(default=None, description="User feedback.", alias="userFeedback") + __properties: ClassVar[List[str]] = ["chatHistoryInteractionId", "createdVisualizations", "errorResponse", "foundObjects", "interactionFinished", "question", "routing", "textResponse", "threadIdSuffix", "userFeedback"] + + @field_validator('user_feedback') + def user_feedback_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['POSITIVE', 'NEGATIVE', 'NONE']): + raise ValueError("must be one of enum values ('POSITIVE', 'NEGATIVE', 'NONE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ChatHistoryInteraction from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of created_visualizations + if self.created_visualizations: + _dict['createdVisualizations'] = self.created_visualizations.to_dict() + # override the default output from pydantic by calling `to_dict()` of found_objects + if self.found_objects: + _dict['foundObjects'] = self.found_objects.to_dict() + # override the default output from pydantic by calling `to_dict()` of routing + if self.routing: + _dict['routing'] = self.routing.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ChatHistoryInteraction from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "chatHistoryInteractionId": obj.get("chatHistoryInteractionId"), + "createdVisualizations": CreatedVisualizations.from_dict(obj["createdVisualizations"]) if obj.get("createdVisualizations") is not None else None, + "errorResponse": obj.get("errorResponse"), + "foundObjects": FoundObjects.from_dict(obj["foundObjects"]) if obj.get("foundObjects") is not None else None, + "interactionFinished": obj.get("interactionFinished"), + "question": obj.get("question"), + "routing": RouteResult.from_dict(obj["routing"]) if obj.get("routing") is not None else None, + "textResponse": obj.get("textResponse"), + "threadIdSuffix": obj.get("threadIdSuffix"), + "userFeedback": obj.get("userFeedback") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/chat_history_request.py b/gooddata-api-client/gooddata_api_client/models/chat_history_request.py new file mode 100644 index 000000000..4e0813ac8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/chat_history_request.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.saved_visualization import SavedVisualization +from typing import Optional, Set +from typing_extensions import Self + +class ChatHistoryRequest(BaseModel): + """ + ChatHistoryRequest + """ # noqa: E501 + chat_history_interaction_id: Optional[StrictStr] = Field(default=None, description="Return chat history records only after this interaction ID. If empty, complete chat history is returned.", alias="chatHistoryInteractionId") + reset: Optional[StrictBool] = Field(default=None, description="User feedback.") + response_state: Optional[StrictStr] = Field(default=None, description="Response state indicating the outcome of the AI interaction.", alias="responseState") + saved_visualization: Optional[SavedVisualization] = Field(default=None, alias="savedVisualization") + thread_id_suffix: Optional[StrictStr] = Field(default=None, description="Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", alias="threadIdSuffix") + user_feedback: Optional[StrictStr] = Field(default=None, description="User feedback.", alias="userFeedback") + __properties: ClassVar[List[str]] = ["chatHistoryInteractionId", "reset", "responseState", "savedVisualization", "threadIdSuffix", "userFeedback"] + + @field_validator('response_state') + def response_state_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SUCCESSFUL', 'UNEXPECTED_ERROR', 'NOT_FOUND_ATTRIBUTES', 'TOO_MANY_DATA_POINTS', 'NO_DATA', 'NO_RESULTS', 'OUT_OF_TOPIC']): + raise ValueError("must be one of enum values ('SUCCESSFUL', 'UNEXPECTED_ERROR', 'NOT_FOUND_ATTRIBUTES', 'TOO_MANY_DATA_POINTS', 'NO_DATA', 'NO_RESULTS', 'OUT_OF_TOPIC')") + return value + + @field_validator('user_feedback') + def user_feedback_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['POSITIVE', 'NEGATIVE', 'NONE']): + raise ValueError("must be one of enum values ('POSITIVE', 'NEGATIVE', 'NONE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ChatHistoryRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of saved_visualization + if self.saved_visualization: + _dict['savedVisualization'] = self.saved_visualization.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ChatHistoryRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "chatHistoryInteractionId": obj.get("chatHistoryInteractionId"), + "reset": obj.get("reset"), + "responseState": obj.get("responseState"), + "savedVisualization": SavedVisualization.from_dict(obj["savedVisualization"]) if obj.get("savedVisualization") is not None else None, + "threadIdSuffix": obj.get("threadIdSuffix"), + "userFeedback": obj.get("userFeedback") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/chat_history_result.py b/gooddata-api-client/gooddata_api_client/models/chat_history_result.py new file mode 100644 index 000000000..94c62158d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/chat_history_result.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.chat_history_interaction import ChatHistoryInteraction +from typing import Optional, Set +from typing_extensions import Self + +class ChatHistoryResult(BaseModel): + """ + ChatHistoryResult + """ # noqa: E501 + interactions: List[ChatHistoryInteraction] = Field(description="List of chat history interactions.") + thread_id: StrictStr = Field(description="The conversation thread ID.", alias="threadId") + __properties: ClassVar[List[str]] = ["interactions", "threadId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ChatHistoryResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in interactions (list) + _items = [] + if self.interactions: + for _item_interactions in self.interactions: + if _item_interactions: + _items.append(_item_interactions.to_dict()) + _dict['interactions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ChatHistoryResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "interactions": [ChatHistoryInteraction.from_dict(_item) for _item in obj["interactions"]] if obj.get("interactions") is not None else None, + "threadId": obj.get("threadId") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/chat_request.py b/gooddata-api-client/gooddata_api_client/models/chat_request.py new file mode 100644 index 000000000..edf048b88 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/chat_request.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from gooddata_api_client.models.user_context import UserContext +from typing import Optional, Set +from typing_extensions import Self + +class ChatRequest(BaseModel): + """ + ChatRequest + """ # noqa: E501 + limit_create: Optional[StrictInt] = Field(default=3, description="Maximum number of created results.", alias="limitCreate") + limit_create_context: Optional[StrictInt] = Field(default=10, description="Maximum number of relevant objects included into context for LLM (for each object type).", alias="limitCreateContext") + limit_search: Optional[StrictInt] = Field(default=5, description="Maximum number of search results.", alias="limitSearch") + question: Annotated[str, Field(strict=True, max_length=2000)] = Field(description="User question") + relevant_score_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.45, description="Score, above which we return found objects. Below this score objects are not relevant.", alias="relevantScoreThreshold") + search_score_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.9, description="Score, above which we return found object(s) and don't call LLM to create new objects.", alias="searchScoreThreshold") + thread_id_suffix: Optional[StrictStr] = Field(default=None, description="Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", alias="threadIdSuffix") + title_to_descriptor_ratio: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.7, description="Temporary for experiments. Ratio of title score to descriptor score.", alias="titleToDescriptorRatio") + user_context: Optional[UserContext] = Field(default=None, alias="userContext") + __properties: ClassVar[List[str]] = ["limitCreate", "limitCreateContext", "limitSearch", "question", "relevantScoreThreshold", "searchScoreThreshold", "threadIdSuffix", "titleToDescriptorRatio", "userContext"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ChatRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user_context + if self.user_context: + _dict['userContext'] = self.user_context.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ChatRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "limitCreate": obj.get("limitCreate") if obj.get("limitCreate") is not None else 3, + "limitCreateContext": obj.get("limitCreateContext") if obj.get("limitCreateContext") is not None else 10, + "limitSearch": obj.get("limitSearch") if obj.get("limitSearch") is not None else 5, + "question": obj.get("question"), + "relevantScoreThreshold": obj.get("relevantScoreThreshold") if obj.get("relevantScoreThreshold") is not None else 0.45, + "searchScoreThreshold": obj.get("searchScoreThreshold") if obj.get("searchScoreThreshold") is not None else 0.9, + "threadIdSuffix": obj.get("threadIdSuffix"), + "titleToDescriptorRatio": obj.get("titleToDescriptorRatio") if obj.get("titleToDescriptorRatio") is not None else 0.7, + "userContext": UserContext.from_dict(obj["userContext"]) if obj.get("userContext") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/chat_result.py b/gooddata-api-client/gooddata_api_client/models/chat_result.py new file mode 100644 index 000000000..82d414212 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/chat_result.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.created_visualizations import CreatedVisualizations +from gooddata_api_client.models.found_objects import FoundObjects +from gooddata_api_client.models.route_result import RouteResult +from typing import Optional, Set +from typing_extensions import Self + +class ChatResult(BaseModel): + """ + ChatResult + """ # noqa: E501 + chat_history_interaction_id: Optional[StrictStr] = Field(default=None, description="Chat History interaction ID. Unique ID for each interaction.", alias="chatHistoryInteractionId") + created_visualizations: Optional[CreatedVisualizations] = Field(default=None, alias="createdVisualizations") + error_response: Optional[StrictStr] = Field(default=None, description="Error response in anything fails.", alias="errorResponse") + found_objects: Optional[FoundObjects] = Field(default=None, alias="foundObjects") + routing: Optional[RouteResult] = None + text_response: Optional[StrictStr] = Field(default=None, description="Text response for general questions.", alias="textResponse") + thread_id_suffix: Optional[StrictStr] = Field(default=None, description="Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", alias="threadIdSuffix") + __properties: ClassVar[List[str]] = ["chatHistoryInteractionId", "createdVisualizations", "errorResponse", "foundObjects", "routing", "textResponse", "threadIdSuffix"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ChatResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of created_visualizations + if self.created_visualizations: + _dict['createdVisualizations'] = self.created_visualizations.to_dict() + # override the default output from pydantic by calling `to_dict()` of found_objects + if self.found_objects: + _dict['foundObjects'] = self.found_objects.to_dict() + # override the default output from pydantic by calling `to_dict()` of routing + if self.routing: + _dict['routing'] = self.routing.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ChatResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "chatHistoryInteractionId": obj.get("chatHistoryInteractionId"), + "createdVisualizations": CreatedVisualizations.from_dict(obj["createdVisualizations"]) if obj.get("createdVisualizations") is not None else None, + "errorResponse": obj.get("errorResponse"), + "foundObjects": FoundObjects.from_dict(obj["foundObjects"]) if obj.get("foundObjects") is not None else None, + "routing": RouteResult.from_dict(obj["routing"]) if obj.get("routing") is not None else None, + "textResponse": obj.get("textResponse"), + "threadIdSuffix": obj.get("threadIdSuffix") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/chat_usage_response.py b/gooddata-api-client/gooddata_api_client/models/chat_usage_response.py new file mode 100644 index 000000000..c8e2e6e22 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/chat_usage_response.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ChatUsageResponse(BaseModel): + """ + ChatUsageResponse + """ # noqa: E501 + interaction_count: StrictInt = Field(description="Number of interactions in the time window", alias="interactionCount") + interaction_limit: StrictInt = Field(description="Maximum number of interactions in the time window any user can do in the workspace", alias="interactionLimit") + time_window_hours: StrictInt = Field(description="Time window in hours", alias="timeWindowHours") + __properties: ClassVar[List[str]] = ["interactionCount", "interactionLimit", "timeWindowHours"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ChatUsageResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ChatUsageResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "interactionCount": obj.get("interactionCount"), + "interactionLimit": obj.get("interactionLimit"), + "timeWindowHours": obj.get("timeWindowHours") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/clustering_request.py b/gooddata-api-client/gooddata_api_client/models/clustering_request.py new file mode 100644 index 000000000..82e21441f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/clustering_request.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class ClusteringRequest(BaseModel): + """ + ClusteringRequest + """ # noqa: E501 + number_of_clusters: Annotated[int, Field(strict=True, ge=1)] = Field(description="Number of clusters to create", alias="numberOfClusters") + threshold: Optional[Union[Annotated[float, Field(strict=True, gt=0)], Annotated[int, Field(strict=True, gt=0)]]] = Field(default=0.03, description="Threshold used for algorithm") + __properties: ClassVar[List[str]] = ["numberOfClusters", "threshold"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ClusteringRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ClusteringRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "numberOfClusters": obj.get("numberOfClusters"), + "threshold": obj.get("threshold") if obj.get("threshold") is not None else 0.03 + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/clustering_result.py b/gooddata-api-client/gooddata_api_client/models/clustering_result.py new file mode 100644 index 000000000..546f87aae --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/clustering_result.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class ClusteringResult(BaseModel): + """ + ClusteringResult + """ # noqa: E501 + attribute: List[Dict[str, Any]] + clusters: List[Optional[StrictInt]] + x_coord: Optional[List[Optional[Union[StrictFloat, StrictInt]]]] = Field(default=None, alias="xCoord") + xcoord: List[Union[StrictFloat, StrictInt]] + y_coord: Optional[List[Optional[Union[StrictFloat, StrictInt]]]] = Field(default=None, alias="yCoord") + ycoord: List[Union[StrictFloat, StrictInt]] + __properties: ClassVar[List[str]] = ["attribute", "clusters", "xCoord", "xcoord", "yCoord", "ycoord"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ClusteringResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ClusteringResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attribute": obj.get("attribute"), + "clusters": obj.get("clusters"), + "xCoord": obj.get("xCoord"), + "xcoord": obj.get("xcoord"), + "yCoord": obj.get("yCoord"), + "ycoord": obj.get("ycoord") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/column_override.py b/gooddata-api-client/gooddata_api_client/models/column_override.py new file mode 100644 index 000000000..8f9929a8f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/column_override.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ColumnOverride(BaseModel): + """ + Table column override. + """ # noqa: E501 + label_target_column: Optional[StrictStr] = Field(default=None, description="Specifies the attribute's column to which this label is associated.", alias="labelTargetColumn") + label_type: Optional[StrictStr] = Field(default=None, description="Label type for the target attribute.", alias="labelType") + ldm_type_override: Optional[StrictStr] = Field(default=None, description="Logical Data Model type for the column.", alias="ldmTypeOverride") + name: StrictStr = Field(description="Column name.") + __properties: ClassVar[List[str]] = ["labelTargetColumn", "labelType", "ldmTypeOverride", "name"] + + @field_validator('label_type') + def label_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TEXT', 'HYPERLINK', 'GEO', 'GEO_LONGITUDE', 'GEO_LATITUDE', 'IMAGE']): + raise ValueError("must be one of enum values ('TEXT', 'HYPERLINK', 'GEO', 'GEO_LONGITUDE', 'GEO_LATITUDE', 'IMAGE')") + return value + + @field_validator('ldm_type_override') + def ldm_type_override_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['FACT', 'LABEL']): + raise ValueError("must be one of enum values ('FACT', 'LABEL')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ColumnOverride from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ColumnOverride from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "labelTargetColumn": obj.get("labelTargetColumn"), + "labelType": obj.get("labelType"), + "ldmTypeOverride": obj.get("ldmTypeOverride"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/column_statistic.py b/gooddata-api-client/gooddata_api_client/models/column_statistic.py new file mode 100644 index 000000000..7010992f1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/column_statistic.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ColumnStatistic(BaseModel): + """ + ColumnStatistic + """ # noqa: E501 + type: StrictStr + value: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["type", "value"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['COUNT', 'COUNT_NULL', 'COUNT_UNIQUE', 'AVG', 'STDDEV', 'MIN', 'MAX', 'PERCENTILE_25', 'PERCENTILE_50', 'PERCENTILE_75']): + raise ValueError("must be one of enum values ('COUNT', 'COUNT_NULL', 'COUNT_UNIQUE', 'AVG', 'STDDEV', 'MIN', 'MAX', 'PERCENTILE_25', 'PERCENTILE_50', 'PERCENTILE_75')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ColumnStatistic from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ColumnStatistic from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "type": obj.get("type"), + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/column_statistic_warning.py b/gooddata-api-client/gooddata_api_client/models/column_statistic_warning.py new file mode 100644 index 000000000..03bed3459 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/column_statistic_warning.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ColumnStatisticWarning(BaseModel): + """ + ColumnStatisticWarning + """ # noqa: E501 + action: StrictStr + message: StrictStr + __properties: ClassVar[List[str]] = ["action", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ColumnStatisticWarning from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ColumnStatisticWarning from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "action": obj.get("action"), + "message": obj.get("message") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/column_statistics_request.py b/gooddata-api-client/gooddata_api_client/models/column_statistics_request.py new file mode 100644 index 000000000..f3e7f488c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/column_statistics_request.py @@ -0,0 +1,119 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.column_statistics_request_from import ColumnStatisticsRequestFrom +from gooddata_api_client.models.frequency_properties import FrequencyProperties +from gooddata_api_client.models.histogram_properties import HistogramProperties +from typing import Optional, Set +from typing_extensions import Self + +class ColumnStatisticsRequest(BaseModel): + """ + A request to retrieve statistics for a column. + """ # noqa: E501 + column_name: StrictStr = Field(alias="columnName") + frequency: Optional[FrequencyProperties] = None + var_from: ColumnStatisticsRequestFrom = Field(alias="from") + histogram: Optional[HistogramProperties] = None + statistics: Optional[List[StrictStr]] = None + __properties: ClassVar[List[str]] = ["columnName", "frequency", "from", "histogram", "statistics"] + + @field_validator('statistics') + def statistics_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['COUNT', 'COUNT_NULL', 'COUNT_UNIQUE', 'AVG', 'STDDEV', 'MIN', 'MAX', 'PERCENTILE_25', 'PERCENTILE_50', 'PERCENTILE_75']): + raise ValueError("each list item must be one of ('COUNT', 'COUNT_NULL', 'COUNT_UNIQUE', 'AVG', 'STDDEV', 'MIN', 'MAX', 'PERCENTILE_25', 'PERCENTILE_50', 'PERCENTILE_75')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ColumnStatisticsRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of frequency + if self.frequency: + _dict['frequency'] = self.frequency.to_dict() + # override the default output from pydantic by calling `to_dict()` of var_from + if self.var_from: + _dict['from'] = self.var_from.to_dict() + # override the default output from pydantic by calling `to_dict()` of histogram + if self.histogram: + _dict['histogram'] = self.histogram.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ColumnStatisticsRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columnName": obj.get("columnName"), + "frequency": FrequencyProperties.from_dict(obj["frequency"]) if obj.get("frequency") is not None else None, + "from": ColumnStatisticsRequestFrom.from_dict(obj["from"]) if obj.get("from") is not None else None, + "histogram": HistogramProperties.from_dict(obj["histogram"]) if obj.get("histogram") is not None else None, + "statistics": obj.get("statistics") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/column_statistics_request_from.py b/gooddata-api-client/gooddata_api_client/models/column_statistics_request_from.py new file mode 100644 index 000000000..1f314b157 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/column_statistics_request_from.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.sql_query import SqlQuery +from gooddata_api_client.models.table import Table +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +COLUMNSTATISTICSREQUESTFROM_ONE_OF_SCHEMAS = ["SqlQuery", "Table"] + +class ColumnStatisticsRequestFrom(BaseModel): + """ + ColumnStatisticsRequestFrom + """ + # data type: SqlQuery + oneof_schema_1_validator: Optional[SqlQuery] = None + # data type: Table + oneof_schema_2_validator: Optional[Table] = None + actual_instance: Optional[Union[SqlQuery, Table]] = None + one_of_schemas: Set[str] = { "SqlQuery", "Table" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = ColumnStatisticsRequestFrom.model_construct() + error_messages = [] + match = 0 + # validate data type: SqlQuery + if not isinstance(v, SqlQuery): + error_messages.append(f"Error! Input type `{type(v)}` is not `SqlQuery`") + else: + match += 1 + # validate data type: Table + if not isinstance(v, Table): + error_messages.append(f"Error! Input type `{type(v)}` is not `Table`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in ColumnStatisticsRequestFrom with oneOf schemas: SqlQuery, Table. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in ColumnStatisticsRequestFrom with oneOf schemas: SqlQuery, Table. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into SqlQuery + try: + instance.actual_instance = SqlQuery.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into Table + try: + instance.actual_instance = Table.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into ColumnStatisticsRequestFrom with oneOf schemas: SqlQuery, Table. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into ColumnStatisticsRequestFrom with oneOf schemas: SqlQuery, Table. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], SqlQuery, Table]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/column_statistics_response.py b/gooddata-api-client/gooddata_api_client/models/column_statistics_response.py new file mode 100644 index 000000000..e0c1b122c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/column_statistics_response.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.column_statistic import ColumnStatistic +from gooddata_api_client.models.column_statistic_warning import ColumnStatisticWarning +from gooddata_api_client.models.frequency import Frequency +from gooddata_api_client.models.histogram import Histogram +from typing import Optional, Set +from typing_extensions import Self + +class ColumnStatisticsResponse(BaseModel): + """ + ColumnStatisticsResponse + """ # noqa: E501 + frequency: Optional[Frequency] = None + histogram: Optional[Histogram] = None + statistics: Optional[List[ColumnStatistic]] = None + warnings: Optional[List[ColumnStatisticWarning]] = None + __properties: ClassVar[List[str]] = ["frequency", "histogram", "statistics", "warnings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ColumnStatisticsResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of frequency + if self.frequency: + _dict['frequency'] = self.frequency.to_dict() + # override the default output from pydantic by calling `to_dict()` of histogram + if self.histogram: + _dict['histogram'] = self.histogram.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in statistics (list) + _items = [] + if self.statistics: + for _item_statistics in self.statistics: + if _item_statistics: + _items.append(_item_statistics.to_dict()) + _dict['statistics'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in warnings (list) + _items = [] + if self.warnings: + for _item_warnings in self.warnings: + if _item_warnings: + _items.append(_item_warnings.to_dict()) + _dict['warnings'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ColumnStatisticsResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "frequency": Frequency.from_dict(obj["frequency"]) if obj.get("frequency") is not None else None, + "histogram": Histogram.from_dict(obj["histogram"]) if obj.get("histogram") is not None else None, + "statistics": [ColumnStatistic.from_dict(_item) for _item in obj["statistics"]] if obj.get("statistics") is not None else None, + "warnings": [ColumnStatisticWarning.from_dict(_item) for _item in obj["warnings"]] if obj.get("warnings") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/column_warning.py b/gooddata-api-client/gooddata_api_client/models/column_warning.py new file mode 100644 index 000000000..3e6c6bb6f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/column_warning.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ColumnWarning(BaseModel): + """ + Warning related to single column. + """ # noqa: E501 + message: StrictStr = Field(description="Warning message related to the column.") + name: StrictStr = Field(description="Column name.") + __properties: ClassVar[List[str]] = ["message", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ColumnWarning from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ColumnWarning from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/comparison.py b/gooddata-api-client/gooddata_api_client/models/comparison.py new file mode 100644 index 000000000..e079e2e9d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/comparison.py @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.alert_condition_operand import AlertConditionOperand +from gooddata_api_client.models.local_identifier import LocalIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class Comparison(BaseModel): + """ + Comparison + """ # noqa: E501 + left: LocalIdentifier + operator: StrictStr + right: AlertConditionOperand + __properties: ClassVar[List[str]] = ["left", "operator", "right"] + + @field_validator('operator') + def operator_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['GREATER_THAN', 'GREATER_THAN_OR_EQUAL_TO', 'LESS_THAN', 'LESS_THAN_OR_EQUAL_TO', 'EQUAL_TO', 'NOT_EQUAL_TO']): + raise ValueError("must be one of enum values ('GREATER_THAN', 'GREATER_THAN_OR_EQUAL_TO', 'LESS_THAN', 'LESS_THAN_OR_EQUAL_TO', 'EQUAL_TO', 'NOT_EQUAL_TO')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Comparison from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of left + if self.left: + _dict['left'] = self.left.to_dict() + # override the default output from pydantic by calling `to_dict()` of right + if self.right: + _dict['right'] = self.right.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Comparison from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "left": LocalIdentifier.from_dict(obj["left"]) if obj.get("left") is not None else None, + "operator": obj.get("operator"), + "right": AlertConditionOperand.from_dict(obj["right"]) if obj.get("right") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/comparison_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/models/comparison_measure_value_filter.py new file mode 100644 index 000000000..48a71fd73 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/comparison_measure_value_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter +from typing import Optional, Set +from typing_extensions import Self + +class ComparisonMeasureValueFilter(BaseModel): + """ + Filter the result by comparing specified metric to given constant value, using given comparison operator. + """ # noqa: E501 + comparison_measure_value_filter: ComparisonMeasureValueFilterComparisonMeasureValueFilter = Field(alias="comparisonMeasureValueFilter") + __properties: ClassVar[List[str]] = ["comparisonMeasureValueFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ComparisonMeasureValueFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of comparison_measure_value_filter + if self.comparison_measure_value_filter: + _dict['comparisonMeasureValueFilter'] = self.comparison_measure_value_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ComparisonMeasureValueFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "comparisonMeasureValueFilter": ComparisonMeasureValueFilterComparisonMeasureValueFilter.from_dict(obj["comparisonMeasureValueFilter"]) if obj.get("comparisonMeasureValueFilter") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/comparison_measure_value_filter_comparison_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/models/comparison_measure_value_filter_comparison_measure_value_filter.py new file mode 100644 index 000000000..e267a77ff --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/comparison_measure_value_filter_comparison_measure_value_filter.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from gooddata_api_client.models.afm_identifier import AfmIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class ComparisonMeasureValueFilterComparisonMeasureValueFilter(BaseModel): + """ + ComparisonMeasureValueFilterComparisonMeasureValueFilter + """ # noqa: E501 + apply_on_result: Optional[StrictBool] = Field(default=None, alias="applyOnResult") + dimensionality: Optional[List[AfmIdentifier]] = Field(default=None, description="References to the attributes to be used when filtering.") + local_identifier: Optional[StrictStr] = Field(default=None, alias="localIdentifier") + measure: AfmIdentifier + operator: StrictStr + treat_null_values_as: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="A value that will be substituted for null values in the metric for the comparisons.", alias="treatNullValuesAs") + value: Union[StrictFloat, StrictInt] + __properties: ClassVar[List[str]] = ["applyOnResult", "dimensionality", "localIdentifier", "measure", "operator", "treatNullValuesAs", "value"] + + @field_validator('operator') + def operator_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['GREATER_THAN', 'GREATER_THAN_OR_EQUAL_TO', 'LESS_THAN', 'LESS_THAN_OR_EQUAL_TO', 'EQUAL_TO', 'NOT_EQUAL_TO']): + raise ValueError("must be one of enum values ('GREATER_THAN', 'GREATER_THAN_OR_EQUAL_TO', 'LESS_THAN', 'LESS_THAN_OR_EQUAL_TO', 'EQUAL_TO', 'NOT_EQUAL_TO')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ComparisonMeasureValueFilterComparisonMeasureValueFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensionality (list) + _items = [] + if self.dimensionality: + for _item_dimensionality in self.dimensionality: + if _item_dimensionality: + _items.append(_item_dimensionality.to_dict()) + _dict['dimensionality'] = _items + # override the default output from pydantic by calling `to_dict()` of measure + if self.measure: + _dict['measure'] = self.measure.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ComparisonMeasureValueFilterComparisonMeasureValueFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applyOnResult": obj.get("applyOnResult"), + "dimensionality": [AfmIdentifier.from_dict(_item) for _item in obj["dimensionality"]] if obj.get("dimensionality") is not None else None, + "localIdentifier": obj.get("localIdentifier"), + "measure": AfmIdentifier.from_dict(obj["measure"]) if obj.get("measure") is not None else None, + "operator": obj.get("operator"), + "treatNullValuesAs": obj.get("treatNullValuesAs"), + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/comparison_wrapper.py b/gooddata-api-client/gooddata_api_client/models/comparison_wrapper.py new file mode 100644 index 000000000..d6aa08396 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/comparison_wrapper.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.comparison import Comparison +from typing import Optional, Set +from typing_extensions import Self + +class ComparisonWrapper(BaseModel): + """ + ComparisonWrapper + """ # noqa: E501 + comparison: Comparison + __properties: ClassVar[List[str]] = ["comparison"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ComparisonWrapper from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of comparison + if self.comparison: + _dict['comparison'] = self.comparison.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ComparisonWrapper from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "comparison": Comparison.from_dict(obj["comparison"]) if obj.get("comparison") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/content_slide_template.py b/gooddata-api-client/gooddata_api_client/models/content_slide_template.py new file mode 100644 index 000000000..ee6e45ae5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/content_slide_template.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.running_section import RunningSection +from typing import Optional, Set +from typing_extensions import Self + +class ContentSlideTemplate(BaseModel): + """ + Settings for content slide. + """ # noqa: E501 + description_field: Optional[StrictStr] = Field(default=None, alias="descriptionField") + footer: Optional[RunningSection] = None + header: Optional[RunningSection] = None + __properties: ClassVar[List[str]] = ["descriptionField", "footer", "header"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ContentSlideTemplate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of footer + if self.footer: + _dict['footer'] = self.footer.to_dict() + # override the default output from pydantic by calling `to_dict()` of header + if self.header: + _dict['header'] = self.header.to_dict() + # set to None if description_field (nullable) is None + # and model_fields_set contains the field + if self.description_field is None and "description_field" in self.model_fields_set: + _dict['descriptionField'] = None + + # set to None if footer (nullable) is None + # and model_fields_set contains the field + if self.footer is None and "footer" in self.model_fields_set: + _dict['footer'] = None + + # set to None if header (nullable) is None + # and model_fields_set contains the field + if self.header is None and "header" in self.model_fields_set: + _dict['header'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ContentSlideTemplate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "descriptionField": obj.get("descriptionField"), + "footer": RunningSection.from_dict(obj["footer"]) if obj.get("footer") is not None else None, + "header": RunningSection.from_dict(obj["header"]) if obj.get("header") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/cover_slide_template.py b/gooddata-api-client/gooddata_api_client/models/cover_slide_template.py new file mode 100644 index 000000000..2af866d56 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/cover_slide_template.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.running_section import RunningSection +from typing import Optional, Set +from typing_extensions import Self + +class CoverSlideTemplate(BaseModel): + """ + Settings for cover slide. + """ # noqa: E501 + background_image: Optional[StrictBool] = Field(default=True, description="Show background image on the slide.", alias="backgroundImage") + description_field: Optional[StrictStr] = Field(default=None, alias="descriptionField") + footer: Optional[RunningSection] = None + header: Optional[RunningSection] = None + __properties: ClassVar[List[str]] = ["backgroundImage", "descriptionField", "footer", "header"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CoverSlideTemplate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of footer + if self.footer: + _dict['footer'] = self.footer.to_dict() + # override the default output from pydantic by calling `to_dict()` of header + if self.header: + _dict['header'] = self.header.to_dict() + # set to None if description_field (nullable) is None + # and model_fields_set contains the field + if self.description_field is None and "description_field" in self.model_fields_set: + _dict['descriptionField'] = None + + # set to None if footer (nullable) is None + # and model_fields_set contains the field + if self.footer is None and "footer" in self.model_fields_set: + _dict['footer'] = None + + # set to None if header (nullable) is None + # and model_fields_set contains the field + if self.header is None and "header" in self.model_fields_set: + _dict['header'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CoverSlideTemplate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "backgroundImage": obj.get("backgroundImage") if obj.get("backgroundImage") is not None else True, + "descriptionField": obj.get("descriptionField"), + "footer": RunningSection.from_dict(obj["footer"]) if obj.get("footer") is not None else None, + "header": RunningSection.from_dict(obj["header"]) if obj.get("header") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/created_visualization.py b/gooddata-api-client/gooddata_api_client/models/created_visualization.py new file mode 100644 index 000000000..0d13fdc46 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/created_visualization.py @@ -0,0 +1,141 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.created_visualization_filters_inner import CreatedVisualizationFiltersInner +from gooddata_api_client.models.dim_attribute import DimAttribute +from gooddata_api_client.models.metric import Metric +from gooddata_api_client.models.suggestion import Suggestion +from typing import Optional, Set +from typing_extensions import Self + +class CreatedVisualization(BaseModel): + """ + List of created visualization objects + """ # noqa: E501 + dimensionality: List[DimAttribute] = Field(description="List of attributes representing the dimensionality of the new visualization") + filters: List[CreatedVisualizationFiltersInner] = Field(description="List of filters to be applied to the new visualization") + id: StrictStr = Field(description="Proposed ID of the new visualization") + metrics: List[Metric] = Field(description="List of metrics to be used in the new visualization") + saved_visualization_id: Optional[StrictStr] = Field(default=None, description="Saved visualization ID.", alias="savedVisualizationId") + suggestions: List[Suggestion] = Field(description="Suggestions for next steps") + title: StrictStr = Field(description="Proposed title of the new visualization") + visualization_type: StrictStr = Field(description="Visualization type requested in question", alias="visualizationType") + __properties: ClassVar[List[str]] = ["dimensionality", "filters", "id", "metrics", "savedVisualizationId", "suggestions", "title", "visualizationType"] + + @field_validator('visualization_type') + def visualization_type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['TABLE', 'HEADLINE', 'BAR', 'LINE', 'PIE', 'COLUMN']): + raise ValueError("must be one of enum values ('TABLE', 'HEADLINE', 'BAR', 'LINE', 'PIE', 'COLUMN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreatedVisualization from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensionality (list) + _items = [] + if self.dimensionality: + for _item_dimensionality in self.dimensionality: + if _item_dimensionality: + _items.append(_item_dimensionality.to_dict()) + _dict['dimensionality'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in filters (list) + _items = [] + if self.filters: + for _item_filters in self.filters: + if _item_filters: + _items.append(_item_filters.to_dict()) + _dict['filters'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in metrics (list) + _items = [] + if self.metrics: + for _item_metrics in self.metrics: + if _item_metrics: + _items.append(_item_metrics.to_dict()) + _dict['metrics'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in suggestions (list) + _items = [] + if self.suggestions: + for _item_suggestions in self.suggestions: + if _item_suggestions: + _items.append(_item_suggestions.to_dict()) + _dict['suggestions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreatedVisualization from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensionality": [DimAttribute.from_dict(_item) for _item in obj["dimensionality"]] if obj.get("dimensionality") is not None else None, + "filters": [CreatedVisualizationFiltersInner.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None, + "id": obj.get("id"), + "metrics": [Metric.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None, + "savedVisualizationId": obj.get("savedVisualizationId"), + "suggestions": [Suggestion.from_dict(_item) for _item in obj["suggestions"]] if obj.get("suggestions") is not None else None, + "title": obj.get("title"), + "visualizationType": obj.get("visualizationType") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/created_visualization_filters_inner.py b/gooddata-api-client/gooddata_api_client/models/created_visualization_filters_inner.py new file mode 100644 index 000000000..37367d6db --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/created_visualization_filters_inner.py @@ -0,0 +1,180 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.attribute_negative_filter import AttributeNegativeFilter +from gooddata_api_client.models.attribute_positive_filter import AttributePositiveFilter +from gooddata_api_client.models.date_absolute_filter import DateAbsoluteFilter +from gooddata_api_client.models.date_relative_filter import DateRelativeFilter +from gooddata_api_client.models.ranking_filter import RankingFilter +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +CREATEDVISUALIZATIONFILTERSINNER_ONE_OF_SCHEMAS = ["AttributeNegativeFilter", "AttributePositiveFilter", "DateAbsoluteFilter", "DateRelativeFilter", "RankingFilter"] + +class CreatedVisualizationFiltersInner(BaseModel): + """ + CreatedVisualizationFiltersInner + """ + # data type: AttributeNegativeFilter + oneof_schema_1_validator: Optional[AttributeNegativeFilter] = None + # data type: AttributePositiveFilter + oneof_schema_2_validator: Optional[AttributePositiveFilter] = None + # data type: DateAbsoluteFilter + oneof_schema_3_validator: Optional[DateAbsoluteFilter] = None + # data type: DateRelativeFilter + oneof_schema_4_validator: Optional[DateRelativeFilter] = None + # data type: RankingFilter + oneof_schema_5_validator: Optional[RankingFilter] = None + actual_instance: Optional[Union[AttributeNegativeFilter, AttributePositiveFilter, DateAbsoluteFilter, DateRelativeFilter, RankingFilter]] = None + one_of_schemas: Set[str] = { "AttributeNegativeFilter", "AttributePositiveFilter", "DateAbsoluteFilter", "DateRelativeFilter", "RankingFilter" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = CreatedVisualizationFiltersInner.model_construct() + error_messages = [] + match = 0 + # validate data type: AttributeNegativeFilter + if not isinstance(v, AttributeNegativeFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `AttributeNegativeFilter`") + else: + match += 1 + # validate data type: AttributePositiveFilter + if not isinstance(v, AttributePositiveFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `AttributePositiveFilter`") + else: + match += 1 + # validate data type: DateAbsoluteFilter + if not isinstance(v, DateAbsoluteFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `DateAbsoluteFilter`") + else: + match += 1 + # validate data type: DateRelativeFilter + if not isinstance(v, DateRelativeFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `DateRelativeFilter`") + else: + match += 1 + # validate data type: RankingFilter + if not isinstance(v, RankingFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `RankingFilter`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in CreatedVisualizationFiltersInner with oneOf schemas: AttributeNegativeFilter, AttributePositiveFilter, DateAbsoluteFilter, DateRelativeFilter, RankingFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in CreatedVisualizationFiltersInner with oneOf schemas: AttributeNegativeFilter, AttributePositiveFilter, DateAbsoluteFilter, DateRelativeFilter, RankingFilter. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into AttributeNegativeFilter + try: + instance.actual_instance = AttributeNegativeFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into AttributePositiveFilter + try: + instance.actual_instance = AttributePositiveFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into DateAbsoluteFilter + try: + instance.actual_instance = DateAbsoluteFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into DateRelativeFilter + try: + instance.actual_instance = DateRelativeFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RankingFilter + try: + instance.actual_instance = RankingFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into CreatedVisualizationFiltersInner with oneOf schemas: AttributeNegativeFilter, AttributePositiveFilter, DateAbsoluteFilter, DateRelativeFilter, RankingFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into CreatedVisualizationFiltersInner with oneOf schemas: AttributeNegativeFilter, AttributePositiveFilter, DateAbsoluteFilter, DateRelativeFilter, RankingFilter. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], AttributeNegativeFilter, AttributePositiveFilter, DateAbsoluteFilter, DateRelativeFilter, RankingFilter]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/created_visualizations.py b/gooddata-api-client/gooddata_api_client/models/created_visualizations.py new file mode 100644 index 000000000..b0be731cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/created_visualizations.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.created_visualization import CreatedVisualization +from gooddata_api_client.models.suggestion import Suggestion +from typing import Optional, Set +from typing_extensions import Self + +class CreatedVisualizations(BaseModel): + """ + Visualization definitions created by AI. + """ # noqa: E501 + objects: List[CreatedVisualization] = Field(description="List of created visualization objects") + reasoning: StrictStr = Field(description="Reasoning from LLM. Description of how and why the answer was generated.") + suggestions: List[Suggestion] = Field(description="List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.") + __properties: ClassVar[List[str]] = ["objects", "reasoning", "suggestions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreatedVisualizations from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in objects (list) + _items = [] + if self.objects: + for _item_objects in self.objects: + if _item_objects: + _items.append(_item_objects.to_dict()) + _dict['objects'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in suggestions (list) + _items = [] + if self.suggestions: + for _item_suggestions in self.suggestions: + if _item_suggestions: + _items.append(_item_suggestions.to_dict()) + _dict['suggestions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreatedVisualizations from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objects": [CreatedVisualization.from_dict(_item) for _item in obj["objects"]] if obj.get("objects") is not None else None, + "reasoning": obj.get("reasoning"), + "suggestions": [Suggestion.from_dict(_item) for _item in obj["suggestions"]] if obj.get("suggestions") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/custom_label.py b/gooddata-api-client/gooddata_api_client/models/custom_label.py new file mode 100644 index 000000000..2ed5d5faa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/custom_label.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class CustomLabel(BaseModel): + """ + Custom label object override. + """ # noqa: E501 + title: StrictStr = Field(description="Override value.") + __properties: ClassVar[List[str]] = ["title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CustomLabel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CustomLabel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/custom_metric.py b/gooddata-api-client/gooddata_api_client/models/custom_metric.py new file mode 100644 index 000000000..3bc3b6fb7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/custom_metric.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class CustomMetric(BaseModel): + """ + Custom metric object override. + """ # noqa: E501 + format: StrictStr = Field(description="Format override.") + title: StrictStr = Field(description="Metric title override.") + __properties: ClassVar[List[str]] = ["format", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CustomMetric from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CustomMetric from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "format": obj.get("format"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/custom_override.py b/gooddata-api-client/gooddata_api_client/models/custom_override.py new file mode 100644 index 000000000..d67277092 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/custom_override.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.custom_label import CustomLabel +from gooddata_api_client.models.custom_metric import CustomMetric +from typing import Optional, Set +from typing_extensions import Self + +class CustomOverride(BaseModel): + """ + Custom cell value overrides (IDs will be replaced with specified values). + """ # noqa: E501 + labels: Optional[Dict[str, CustomLabel]] = Field(default=None, description="Map of CustomLabels with keys used as placeholders in document.") + metrics: Optional[Dict[str, CustomMetric]] = Field(default=None, description="Map of CustomMetrics with keys used as placeholders in document.") + __properties: ClassVar[List[str]] = ["labels", "metrics"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CustomOverride from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each value in labels (dict) + _field_dict = {} + if self.labels: + for _key_labels in self.labels: + if self.labels[_key_labels]: + _field_dict[_key_labels] = self.labels[_key_labels].to_dict() + _dict['labels'] = _field_dict + # override the default output from pydantic by calling `to_dict()` of each value in metrics (dict) + _field_dict = {} + if self.metrics: + for _key_metrics in self.metrics: + if self.metrics[_key_metrics]: + _field_dict[_key_metrics] = self.metrics[_key_metrics].to_dict() + _dict['metrics'] = _field_dict + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CustomOverride from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "labels": dict( + (_k, CustomLabel.from_dict(_v)) + for _k, _v in obj["labels"].items() + ) + if obj.get("labels") is not None + else None, + "metrics": dict( + (_k, CustomMetric.from_dict(_v)) + for _k, _v in obj["metrics"].items() + ) + if obj.get("metrics") is not None + else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_attribute_filter.py b/gooddata-api-client/gooddata_api_client/models/dashboard_attribute_filter.py new file mode 100644 index 000000000..9ee129a79 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_attribute_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.dashboard_attribute_filter_attribute_filter import DashboardAttributeFilterAttributeFilter +from typing import Optional, Set +from typing_extensions import Self + +class DashboardAttributeFilter(BaseModel): + """ + DashboardAttributeFilter + """ # noqa: E501 + attribute_filter: DashboardAttributeFilterAttributeFilter = Field(alias="attributeFilter") + __properties: ClassVar[List[str]] = ["attributeFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DashboardAttributeFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attribute_filter + if self.attribute_filter: + _dict['attributeFilter'] = self.attribute_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DashboardAttributeFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributeFilter": DashboardAttributeFilterAttributeFilter.from_dict(obj["attributeFilter"]) if obj.get("attributeFilter") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_attribute_filter_attribute_filter.py b/gooddata-api-client/gooddata_api_client/models/dashboard_attribute_filter_attribute_filter.py new file mode 100644 index 000000000..e7d32e94d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_attribute_filter_attribute_filter.py @@ -0,0 +1,145 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.attribute_elements import AttributeElements +from gooddata_api_client.models.attribute_filter_by_date import AttributeFilterByDate +from gooddata_api_client.models.attribute_filter_parent import AttributeFilterParent +from gooddata_api_client.models.identifier_ref import IdentifierRef +from typing import Optional, Set +from typing_extensions import Self + +class DashboardAttributeFilterAttributeFilter(BaseModel): + """ + DashboardAttributeFilterAttributeFilter + """ # noqa: E501 + attribute_elements: AttributeElements = Field(alias="attributeElements") + display_form: IdentifierRef = Field(alias="displayForm") + filter_elements_by: Optional[List[AttributeFilterParent]] = Field(default=None, alias="filterElementsBy") + filter_elements_by_date: Optional[List[AttributeFilterByDate]] = Field(default=None, alias="filterElementsByDate") + local_identifier: Optional[StrictStr] = Field(default=None, alias="localIdentifier") + negative_selection: StrictBool = Field(alias="negativeSelection") + selection_mode: Optional[StrictStr] = Field(default=None, alias="selectionMode") + title: Optional[StrictStr] = None + validate_elements_by: Optional[List[IdentifierRef]] = Field(default=None, alias="validateElementsBy") + __properties: ClassVar[List[str]] = ["attributeElements", "displayForm", "filterElementsBy", "filterElementsByDate", "localIdentifier", "negativeSelection", "selectionMode", "title", "validateElementsBy"] + + @field_validator('selection_mode') + def selection_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['single', 'multi']): + raise ValueError("must be one of enum values ('single', 'multi')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DashboardAttributeFilterAttributeFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attribute_elements + if self.attribute_elements: + _dict['attributeElements'] = self.attribute_elements.to_dict() + # override the default output from pydantic by calling `to_dict()` of display_form + if self.display_form: + _dict['displayForm'] = self.display_form.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in filter_elements_by (list) + _items = [] + if self.filter_elements_by: + for _item_filter_elements_by in self.filter_elements_by: + if _item_filter_elements_by: + _items.append(_item_filter_elements_by.to_dict()) + _dict['filterElementsBy'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in filter_elements_by_date (list) + _items = [] + if self.filter_elements_by_date: + for _item_filter_elements_by_date in self.filter_elements_by_date: + if _item_filter_elements_by_date: + _items.append(_item_filter_elements_by_date.to_dict()) + _dict['filterElementsByDate'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in validate_elements_by (list) + _items = [] + if self.validate_elements_by: + for _item_validate_elements_by in self.validate_elements_by: + if _item_validate_elements_by: + _items.append(_item_validate_elements_by.to_dict()) + _dict['validateElementsBy'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DashboardAttributeFilterAttributeFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributeElements": AttributeElements.from_dict(obj["attributeElements"]) if obj.get("attributeElements") is not None else None, + "displayForm": IdentifierRef.from_dict(obj["displayForm"]) if obj.get("displayForm") is not None else None, + "filterElementsBy": [AttributeFilterParent.from_dict(_item) for _item in obj["filterElementsBy"]] if obj.get("filterElementsBy") is not None else None, + "filterElementsByDate": [AttributeFilterByDate.from_dict(_item) for _item in obj["filterElementsByDate"]] if obj.get("filterElementsByDate") is not None else None, + "localIdentifier": obj.get("localIdentifier"), + "negativeSelection": obj.get("negativeSelection"), + "selectionMode": obj.get("selectionMode"), + "title": obj.get("title"), + "validateElementsBy": [IdentifierRef.from_dict(_item) for _item in obj["validateElementsBy"]] if obj.get("validateElementsBy") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_date_filter.py b/gooddata-api-client/gooddata_api_client/models/dashboard_date_filter.py new file mode 100644 index 000000000..b9fe4d3ea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_date_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.dashboard_date_filter_date_filter import DashboardDateFilterDateFilter +from typing import Optional, Set +from typing_extensions import Self + +class DashboardDateFilter(BaseModel): + """ + DashboardDateFilter + """ # noqa: E501 + date_filter: DashboardDateFilterDateFilter = Field(alias="dateFilter") + __properties: ClassVar[List[str]] = ["dateFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DashboardDateFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of date_filter + if self.date_filter: + _dict['dateFilter'] = self.date_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DashboardDateFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dateFilter": DashboardDateFilterDateFilter.from_dict(obj["dateFilter"]) if obj.get("dateFilter") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_date_filter_date_filter.py b/gooddata-api-client/gooddata_api_client/models/dashboard_date_filter_date_filter.py new file mode 100644 index 000000000..920fb144b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_date_filter_date_filter.py @@ -0,0 +1,134 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.dashboard_date_filter_date_filter_from import DashboardDateFilterDateFilterFrom +from gooddata_api_client.models.identifier_ref import IdentifierRef +from gooddata_api_client.models.relative_bounded_date_filter import RelativeBoundedDateFilter +from typing import Optional, Set +from typing_extensions import Self + +class DashboardDateFilterDateFilter(BaseModel): + """ + DashboardDateFilterDateFilter + """ # noqa: E501 + attribute: Optional[IdentifierRef] = None + bounded_filter: Optional[RelativeBoundedDateFilter] = Field(default=None, alias="boundedFilter") + data_set: Optional[IdentifierRef] = Field(default=None, alias="dataSet") + var_from: Optional[DashboardDateFilterDateFilterFrom] = Field(default=None, alias="from") + granularity: StrictStr + local_identifier: Optional[StrictStr] = Field(default=None, alias="localIdentifier") + to: Optional[DashboardDateFilterDateFilterFrom] = None + type: StrictStr + __properties: ClassVar[List[str]] = ["attribute", "boundedFilter", "dataSet", "from", "granularity", "localIdentifier", "to", "type"] + + @field_validator('granularity') + def granularity_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['ALL_TIME_GRANULARITY', 'GDC.time.year', 'GDC.time.week_us', 'GDC.time.week_in_year', 'GDC.time.week_in_quarter', 'GDC.time.week', 'GDC.time.euweek_in_year', 'GDC.time.euweek_in_quarter', 'GDC.time.quarter', 'GDC.time.quarter_in_year', 'GDC.time.month', 'GDC.time.month_in_quarter', 'GDC.time.month_in_year', 'GDC.time.day_in_year', 'GDC.time.day_in_quarter', 'GDC.time.day_in_month', 'GDC.time.day_in_week', 'GDC.time.day_in_euweek', 'GDC.time.date', 'GDC.time.hour', 'GDC.time.hour_in_day', 'GDC.time.minute', 'GDC.time.minute_in_hour']): + raise ValueError("must be one of enum values ('ALL_TIME_GRANULARITY', 'GDC.time.year', 'GDC.time.week_us', 'GDC.time.week_in_year', 'GDC.time.week_in_quarter', 'GDC.time.week', 'GDC.time.euweek_in_year', 'GDC.time.euweek_in_quarter', 'GDC.time.quarter', 'GDC.time.quarter_in_year', 'GDC.time.month', 'GDC.time.month_in_quarter', 'GDC.time.month_in_year', 'GDC.time.day_in_year', 'GDC.time.day_in_quarter', 'GDC.time.day_in_month', 'GDC.time.day_in_week', 'GDC.time.day_in_euweek', 'GDC.time.date', 'GDC.time.hour', 'GDC.time.hour_in_day', 'GDC.time.minute', 'GDC.time.minute_in_hour')") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['relative', 'absolute']): + raise ValueError("must be one of enum values ('relative', 'absolute')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DashboardDateFilterDateFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attribute + if self.attribute: + _dict['attribute'] = self.attribute.to_dict() + # override the default output from pydantic by calling `to_dict()` of bounded_filter + if self.bounded_filter: + _dict['boundedFilter'] = self.bounded_filter.to_dict() + # override the default output from pydantic by calling `to_dict()` of data_set + if self.data_set: + _dict['dataSet'] = self.data_set.to_dict() + # override the default output from pydantic by calling `to_dict()` of var_from + if self.var_from: + _dict['from'] = self.var_from.to_dict() + # override the default output from pydantic by calling `to_dict()` of to + if self.to: + _dict['to'] = self.to.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DashboardDateFilterDateFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attribute": IdentifierRef.from_dict(obj["attribute"]) if obj.get("attribute") is not None else None, + "boundedFilter": RelativeBoundedDateFilter.from_dict(obj["boundedFilter"]) if obj.get("boundedFilter") is not None else None, + "dataSet": IdentifierRef.from_dict(obj["dataSet"]) if obj.get("dataSet") is not None else None, + "from": DashboardDateFilterDateFilterFrom.from_dict(obj["from"]) if obj.get("from") is not None else None, + "granularity": obj.get("granularity"), + "localIdentifier": obj.get("localIdentifier"), + "to": DashboardDateFilterDateFilterFrom.from_dict(obj["to"]) if obj.get("to") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_date_filter_date_filter_from.py b/gooddata-api-client/gooddata_api_client/models/dashboard_date_filter_date_filter_from.py new file mode 100644 index 000000000..75a5d0a20 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_date_filter_date_filter_from.py @@ -0,0 +1,144 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +DASHBOARDDATEFILTERDATEFILTERFROM_ONE_OF_SCHEMAS = ["int", "str"] + +class DashboardDateFilterDateFilterFrom(BaseModel): + """ + DashboardDateFilterDateFilterFrom + """ + # data type: str + oneof_schema_1_validator: Optional[StrictStr] = None + # data type: int + oneof_schema_2_validator: Optional[StrictInt] = None + actual_instance: Optional[Union[int, str]] = None + one_of_schemas: Set[str] = { "int", "str" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = DashboardDateFilterDateFilterFrom.model_construct() + error_messages = [] + match = 0 + # validate data type: str + try: + instance.oneof_schema_1_validator = v + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # validate data type: int + try: + instance.oneof_schema_2_validator = v + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in DashboardDateFilterDateFilterFrom with oneOf schemas: int, str. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in DashboardDateFilterDateFilterFrom with oneOf schemas: int, str. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into str + try: + # validation + instance.oneof_schema_1_validator = json.loads(json_str) + # assign value to actual_instance + instance.actual_instance = instance.oneof_schema_1_validator + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into int + try: + # validation + instance.oneof_schema_2_validator = json.loads(json_str) + # assign value to actual_instance + instance.actual_instance = instance.oneof_schema_2_validator + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into DashboardDateFilterDateFilterFrom with oneOf schemas: int, str. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into DashboardDateFilterDateFilterFrom with oneOf schemas: int, str. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], int, str]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_export_settings.py b/gooddata-api-client/gooddata_api_client/models/dashboard_export_settings.py new file mode 100644 index 000000000..c7c2e2b26 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_export_settings.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DashboardExportSettings(BaseModel): + """ + Additional settings. + """ # noqa: E501 + export_info: Optional[StrictBool] = Field(default=False, description="If true, the export will contain the information about the export – exported date, dashboard filters, etc.", alias="exportInfo") + merge_headers: Optional[StrictBool] = Field(default=False, description="Merge equal headers in neighbouring cells. Used for [XLSX] format only.", alias="mergeHeaders") + page_orientation: Optional[StrictStr] = Field(default='PORTRAIT', description="Set page orientation. (PDF)", alias="pageOrientation") + page_size: Optional[StrictStr] = Field(default='A4', description="Set page size. (PDF)", alias="pageSize") + __properties: ClassVar[List[str]] = ["exportInfo", "mergeHeaders", "pageOrientation", "pageSize"] + + @field_validator('page_orientation') + def page_orientation_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['PORTRAIT', 'LANDSCAPE']): + raise ValueError("must be one of enum values ('PORTRAIT', 'LANDSCAPE')") + return value + + @field_validator('page_size') + def page_size_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['A3', 'A4', 'LETTER']): + raise ValueError("must be one of enum values ('A3', 'A4', 'LETTER')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DashboardExportSettings from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DashboardExportSettings from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "exportInfo": obj.get("exportInfo") if obj.get("exportInfo") is not None else False, + "mergeHeaders": obj.get("mergeHeaders") if obj.get("mergeHeaders") is not None else False, + "pageOrientation": obj.get("pageOrientation") if obj.get("pageOrientation") is not None else 'PORTRAIT', + "pageSize": obj.get("pageSize") if obj.get("pageSize") is not None else 'A4' + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_filter.py b/gooddata-api-client/gooddata_api_client/models/dashboard_filter.py new file mode 100644 index 000000000..5ae80feb5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_filter.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.dashboard_attribute_filter import DashboardAttributeFilter +from gooddata_api_client.models.dashboard_date_filter import DashboardDateFilter +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +DASHBOARDFILTER_ONE_OF_SCHEMAS = ["DashboardAttributeFilter", "DashboardDateFilter"] + +class DashboardFilter(BaseModel): + """ + DashboardFilter + """ + # data type: DashboardAttributeFilter + oneof_schema_1_validator: Optional[DashboardAttributeFilter] = None + # data type: DashboardDateFilter + oneof_schema_2_validator: Optional[DashboardDateFilter] = None + actual_instance: Optional[Union[DashboardAttributeFilter, DashboardDateFilter]] = None + one_of_schemas: Set[str] = { "DashboardAttributeFilter", "DashboardDateFilter" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = DashboardFilter.model_construct() + error_messages = [] + match = 0 + # validate data type: DashboardAttributeFilter + if not isinstance(v, DashboardAttributeFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `DashboardAttributeFilter`") + else: + match += 1 + # validate data type: DashboardDateFilter + if not isinstance(v, DashboardDateFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `DashboardDateFilter`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in DashboardFilter with oneOf schemas: DashboardAttributeFilter, DashboardDateFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in DashboardFilter with oneOf schemas: DashboardAttributeFilter, DashboardDateFilter. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into DashboardAttributeFilter + try: + instance.actual_instance = DashboardAttributeFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into DashboardDateFilter + try: + instance.actual_instance = DashboardDateFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into DashboardFilter with oneOf schemas: DashboardAttributeFilter, DashboardDateFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into DashboardFilter with oneOf schemas: DashboardAttributeFilter, DashboardDateFilter. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], DashboardAttributeFilter, DashboardDateFilter]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_permissions.py b/gooddata-api-client/gooddata_api_client/models/dashboard_permissions.py new file mode 100644 index 000000000..16f83f498 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_permissions.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.rule_permission import RulePermission +from gooddata_api_client.models.user_group_permission import UserGroupPermission +from gooddata_api_client.models.user_permission import UserPermission +from typing import Optional, Set +from typing_extensions import Self + +class DashboardPermissions(BaseModel): + """ + DashboardPermissions + """ # noqa: E501 + rules: List[RulePermission] = Field(description="List of rules") + user_groups: List[UserGroupPermission] = Field(description="List of user groups", alias="userGroups") + users: List[UserPermission] = Field(description="List of users") + __properties: ClassVar[List[str]] = ["rules", "userGroups", "users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DashboardPermissions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in rules (list) + _items = [] + if self.rules: + for _item_rules in self.rules: + if _item_rules: + _items.append(_item_rules.to_dict()) + _dict['rules'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DashboardPermissions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "rules": [RulePermission.from_dict(_item) for _item in obj["rules"]] if obj.get("rules") is not None else None, + "userGroups": [UserGroupPermission.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None, + "users": [UserPermission.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_permissions_assignment.py b/gooddata-api-client/gooddata_api_client/models/dashboard_permissions_assignment.py new file mode 100644 index 000000000..6c68721b1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_permissions_assignment.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DashboardPermissionsAssignment(BaseModel): + """ + Desired levels of permissions for an assignee. + """ # noqa: E501 + permissions: List[StrictStr] + __properties: ClassVar[List[str]] = ["permissions"] + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['EDIT', 'SHARE', 'VIEW']): + raise ValueError("each list item must be one of ('EDIT', 'SHARE', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DashboardPermissionsAssignment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DashboardPermissionsAssignment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": obj.get("permissions") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_slides_template.py b/gooddata-api-client/gooddata_api_client/models/dashboard_slides_template.py new file mode 100644 index 000000000..c1715eb08 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_slides_template.py @@ -0,0 +1,141 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.content_slide_template import ContentSlideTemplate +from gooddata_api_client.models.cover_slide_template import CoverSlideTemplate +from gooddata_api_client.models.intro_slide_template import IntroSlideTemplate +from gooddata_api_client.models.section_slide_template import SectionSlideTemplate +from typing import Optional, Set +from typing_extensions import Self + +class DashboardSlidesTemplate(BaseModel): + """ + Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + """ # noqa: E501 + applied_on: Annotated[List[StrictStr], Field(min_length=1)] = Field(description="Export types this template applies to.", alias="appliedOn") + content_slide: Optional[ContentSlideTemplate] = Field(default=None, alias="contentSlide") + cover_slide: Optional[CoverSlideTemplate] = Field(default=None, alias="coverSlide") + intro_slide: Optional[IntroSlideTemplate] = Field(default=None, alias="introSlide") + section_slide: Optional[SectionSlideTemplate] = Field(default=None, alias="sectionSlide") + __properties: ClassVar[List[str]] = ["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide"] + + @field_validator('applied_on') + def applied_on_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['PDF', 'PPTX']): + raise ValueError("each list item must be one of ('PDF', 'PPTX')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DashboardSlidesTemplate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of content_slide + if self.content_slide: + _dict['contentSlide'] = self.content_slide.to_dict() + # override the default output from pydantic by calling `to_dict()` of cover_slide + if self.cover_slide: + _dict['coverSlide'] = self.cover_slide.to_dict() + # override the default output from pydantic by calling `to_dict()` of intro_slide + if self.intro_slide: + _dict['introSlide'] = self.intro_slide.to_dict() + # override the default output from pydantic by calling `to_dict()` of section_slide + if self.section_slide: + _dict['sectionSlide'] = self.section_slide.to_dict() + # set to None if content_slide (nullable) is None + # and model_fields_set contains the field + if self.content_slide is None and "content_slide" in self.model_fields_set: + _dict['contentSlide'] = None + + # set to None if cover_slide (nullable) is None + # and model_fields_set contains the field + if self.cover_slide is None and "cover_slide" in self.model_fields_set: + _dict['coverSlide'] = None + + # set to None if intro_slide (nullable) is None + # and model_fields_set contains the field + if self.intro_slide is None and "intro_slide" in self.model_fields_set: + _dict['introSlide'] = None + + # set to None if section_slide (nullable) is None + # and model_fields_set contains the field + if self.section_slide is None and "section_slide" in self.model_fields_set: + _dict['sectionSlide'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DashboardSlidesTemplate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "appliedOn": obj.get("appliedOn"), + "contentSlide": ContentSlideTemplate.from_dict(obj["contentSlide"]) if obj.get("contentSlide") is not None else None, + "coverSlide": CoverSlideTemplate.from_dict(obj["coverSlide"]) if obj.get("coverSlide") is not None else None, + "introSlide": IntroSlideTemplate.from_dict(obj["introSlide"]) if obj.get("introSlide") is not None else None, + "sectionSlide": SectionSlideTemplate.from_dict(obj["sectionSlide"]) if obj.get("sectionSlide") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_tabular_export_request.py b/gooddata-api-client/gooddata_api_client/models/dashboard_tabular_export_request.py new file mode 100644 index 000000000..b5fdb51a7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_tabular_export_request.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.dashboard_export_settings import DashboardExportSettings +from gooddata_api_client.models.dashboard_filter import DashboardFilter +from typing import Optional, Set +from typing_extensions import Self + +class DashboardTabularExportRequest(BaseModel): + """ + Export request object describing the export properties for dashboard tabular exports. + """ # noqa: E501 + dashboard_filters_override: Optional[List[DashboardFilter]] = Field(default=None, description="List of filters that will be used instead of the default dashboard filters.", alias="dashboardFiltersOverride") + file_name: StrictStr = Field(description="Filename of downloaded file without extension.", alias="fileName") + format: StrictStr = Field(description="Requested tabular export type.") + settings: Optional[DashboardExportSettings] = None + widget_ids: Optional[Annotated[List[StrictStr], Field(max_length=1)]] = Field(default=None, description="List of widget identifiers to be exported. Note that only one widget is currently supported.", alias="widgetIds") + __properties: ClassVar[List[str]] = ["dashboardFiltersOverride", "fileName", "format", "settings", "widgetIds"] + + @field_validator('format') + def format_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['XLSX', 'PDF']): + raise ValueError("must be one of enum values ('XLSX', 'PDF')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DashboardTabularExportRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dashboard_filters_override (list) + _items = [] + if self.dashboard_filters_override: + for _item_dashboard_filters_override in self.dashboard_filters_override: + if _item_dashboard_filters_override: + _items.append(_item_dashboard_filters_override.to_dict()) + _dict['dashboardFiltersOverride'] = _items + # override the default output from pydantic by calling `to_dict()` of settings + if self.settings: + _dict['settings'] = self.settings.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DashboardTabularExportRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dashboardFiltersOverride": [DashboardFilter.from_dict(_item) for _item in obj["dashboardFiltersOverride"]] if obj.get("dashboardFiltersOverride") is not None else None, + "fileName": obj.get("fileName"), + "format": obj.get("format"), + "settings": DashboardExportSettings.from_dict(obj["settings"]) if obj.get("settings") is not None else None, + "widgetIds": obj.get("widgetIds") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dashboard_tabular_export_request_v2.py b/gooddata-api-client/gooddata_api_client/models/dashboard_tabular_export_request_v2.py new file mode 100644 index 000000000..76052e6d6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dashboard_tabular_export_request_v2.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.dashboard_export_settings import DashboardExportSettings +from gooddata_api_client.models.dashboard_filter import DashboardFilter +from typing import Optional, Set +from typing_extensions import Self + +class DashboardTabularExportRequestV2(BaseModel): + """ + Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId). + """ # noqa: E501 + dashboard_filters_override: Optional[List[DashboardFilter]] = Field(default=None, description="List of filters that will be used instead of the default dashboard filters.", alias="dashboardFiltersOverride") + dashboard_id: StrictStr = Field(description="Dashboard identifier", alias="dashboardId") + file_name: StrictStr = Field(description="Filename of downloaded file without extension.", alias="fileName") + format: StrictStr = Field(description="Requested tabular export type.") + settings: Optional[DashboardExportSettings] = None + widget_ids: Optional[Annotated[List[StrictStr], Field(max_length=1)]] = Field(default=None, description="List of widget identifiers to be exported. Note that only one widget is currently supported.", alias="widgetIds") + __properties: ClassVar[List[str]] = ["dashboardFiltersOverride", "dashboardId", "fileName", "format", "settings", "widgetIds"] + + @field_validator('format') + def format_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['XLSX', 'PDF']): + raise ValueError("must be one of enum values ('XLSX', 'PDF')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DashboardTabularExportRequestV2 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dashboard_filters_override (list) + _items = [] + if self.dashboard_filters_override: + for _item_dashboard_filters_override in self.dashboard_filters_override: + if _item_dashboard_filters_override: + _items.append(_item_dashboard_filters_override.to_dict()) + _dict['dashboardFiltersOverride'] = _items + # override the default output from pydantic by calling `to_dict()` of settings + if self.settings: + _dict['settings'] = self.settings.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DashboardTabularExportRequestV2 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dashboardFiltersOverride": [DashboardFilter.from_dict(_item) for _item in obj["dashboardFiltersOverride"]] if obj.get("dashboardFiltersOverride") is not None else None, + "dashboardId": obj.get("dashboardId"), + "fileName": obj.get("fileName"), + "format": obj.get("format"), + "settings": DashboardExportSettings.from_dict(obj["settings"]) if obj.get("settings") is not None else None, + "widgetIds": obj.get("widgetIds") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/data_column_locator.py b/gooddata-api-client/gooddata_api_client/models/data_column_locator.py new file mode 100644 index 000000000..a8cc5ac32 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/data_column_locator.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DataColumnLocator(BaseModel): + """ + Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified. + """ # noqa: E501 + properties: Dict[str, StrictStr] = Field(description="Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.") + __properties: ClassVar[List[str]] = ["properties"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataColumnLocator from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataColumnLocator from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "properties": obj.get("properties") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/data_column_locators.py b/gooddata-api-client/gooddata_api_client/models/data_column_locators.py new file mode 100644 index 000000000..76d186737 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/data_column_locators.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.data_column_locator import DataColumnLocator +from typing import Optional, Set +from typing_extensions import Self + +class DataColumnLocators(BaseModel): + """ + Data column locators for the values. + """ # noqa: E501 + properties: Optional[Dict[str, DataColumnLocator]] = Field(default=None, description="Mapping from dimensions to data column locators.") + __properties: ClassVar[List[str]] = ["properties"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataColumnLocators from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each value in properties (dict) + _field_dict = {} + if self.properties: + for _key_properties in self.properties: + if self.properties[_key_properties]: + _field_dict[_key_properties] = self.properties[_key_properties].to_dict() + _dict['properties'] = _field_dict + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataColumnLocators from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "properties": dict( + (_k, DataColumnLocator.from_dict(_v)) + for _k, _v in obj["properties"].items() + ) + if obj.get("properties") is not None + else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/data_source_parameter.py b/gooddata-api-client/gooddata_api_client/models/data_source_parameter.py new file mode 100644 index 000000000..3d52af1ab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/data_source_parameter.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DataSourceParameter(BaseModel): + """ + A parameter for testing data source connection + """ # noqa: E501 + name: StrictStr = Field(description="Parameter name.") + value: StrictStr = Field(description="Parameter value.") + __properties: ClassVar[List[str]] = ["name", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataSourceParameter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataSourceParameter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/data_source_permission_assignment.py b/gooddata-api-client/gooddata_api_client/models/data_source_permission_assignment.py new file mode 100644 index 000000000..da10bab46 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/data_source_permission_assignment.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DataSourcePermissionAssignment(BaseModel): + """ + Data source permission assignments + """ # noqa: E501 + assignee_identifier: AssigneeIdentifier = Field(alias="assigneeIdentifier") + permissions: List[StrictStr] + __properties: ClassVar[List[str]] = ["assigneeIdentifier", "permissions"] + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['MANAGE', 'USE']): + raise ValueError("each list item must be one of ('MANAGE', 'USE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataSourcePermissionAssignment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee_identifier + if self.assignee_identifier: + _dict['assigneeIdentifier'] = self.assignee_identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataSourcePermissionAssignment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assigneeIdentifier": AssigneeIdentifier.from_dict(obj["assigneeIdentifier"]) if obj.get("assigneeIdentifier") is not None else None, + "permissions": obj.get("permissions") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/data_source_schemata.py b/gooddata-api-client/gooddata_api_client/models/data_source_schemata.py new file mode 100644 index 000000000..1f731d682 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/data_source_schemata.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DataSourceSchemata(BaseModel): + """ + Result of getSchemata. Contains list of available DB schema names. + """ # noqa: E501 + schema_names: List[StrictStr] = Field(alias="schemaNames") + __properties: ClassVar[List[str]] = ["schemaNames"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataSourceSchemata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataSourceSchemata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "schemaNames": obj.get("schemaNames") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/data_source_table_identifier.py b/gooddata-api-client/gooddata_api_client/models/data_source_table_identifier.py new file mode 100644 index 000000000..3e069ed15 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/data_source_table_identifier.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DataSourceTableIdentifier(BaseModel): + """ + An id of the table. Including ID of data source. + """ # noqa: E501 + data_source_id: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Data source ID.", alias="dataSourceId") + id: Annotated[str, Field(strict=True)] = Field(description="ID of table.") + path: Optional[List[StrictStr]] = Field(default=None, description="Path to table.") + type: StrictStr = Field(description="Data source entity type.") + __properties: ClassVar[List[str]] = ["dataSourceId", "id", "path", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataSource']): + raise ValueError("must be one of enum values ('dataSource')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataSourceTableIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if path (nullable) is None + # and model_fields_set contains the field + if self.path is None and "path" in self.model_fields_set: + _dict['path'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataSourceTableIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataSourceId": obj.get("dataSourceId"), + "id": obj.get("id"), + "path": obj.get("path"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dataset_grain.py b/gooddata-api-client/gooddata_api_client/models/dataset_grain.py new file mode 100644 index 000000000..a40f00774 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dataset_grain.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DatasetGrain(BaseModel): + """ + DatasetGrain + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attribute', 'date']): + raise ValueError("must be one of enum values ('attribute', 'date')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DatasetGrain from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DatasetGrain from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dataset_reference_identifier.py b/gooddata-api-client/gooddata_api_client/models/dataset_reference_identifier.py new file mode 100644 index 000000000..420c0091d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dataset_reference_identifier.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DatasetReferenceIdentifier(BaseModel): + """ + DatasetReferenceIdentifier + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataset']): + raise ValueError("must be one of enum values ('dataset')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DatasetReferenceIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DatasetReferenceIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dataset_workspace_data_filter_identifier.py b/gooddata-api-client/gooddata_api_client/models/dataset_workspace_data_filter_identifier.py new file mode 100644 index 000000000..b8c485a7e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dataset_workspace_data_filter_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DatasetWorkspaceDataFilterIdentifier(BaseModel): + """ + Identifier of a workspace data filter. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Workspace Data Filters ID.") + type: StrictStr = Field(description="Filter type.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceDataFilter']): + raise ValueError("must be one of enum values ('workspaceDataFilter')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DatasetWorkspaceDataFilterIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DatasetWorkspaceDataFilterIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/date_absolute_filter.py b/gooddata-api-client/gooddata_api_client/models/date_absolute_filter.py new file mode 100644 index 000000000..64a6a31c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/date_absolute_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DateAbsoluteFilter(BaseModel): + """ + DateAbsoluteFilter + """ # noqa: E501 + var_from: StrictStr = Field(alias="from") + to: StrictStr + using: StrictStr + __properties: ClassVar[List[str]] = ["from", "to", "using"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DateAbsoluteFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DateAbsoluteFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "from": obj.get("from"), + "to": obj.get("to"), + "using": obj.get("using") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/date_filter.py b/gooddata-api-client/gooddata_api_client/models/date_filter.py new file mode 100644 index 000000000..333b1e015 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/date_filter.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.absolute_date_filter import AbsoluteDateFilter +from gooddata_api_client.models.relative_date_filter import RelativeDateFilter +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +DATEFILTER_ONE_OF_SCHEMAS = ["AbsoluteDateFilter", "RelativeDateFilter"] + +class DateFilter(BaseModel): + """ + Abstract filter definition type for dates. + """ + # data type: AbsoluteDateFilter + oneof_schema_1_validator: Optional[AbsoluteDateFilter] = None + # data type: RelativeDateFilter + oneof_schema_2_validator: Optional[RelativeDateFilter] = None + actual_instance: Optional[Union[AbsoluteDateFilter, RelativeDateFilter]] = None + one_of_schemas: Set[str] = { "AbsoluteDateFilter", "RelativeDateFilter" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = DateFilter.model_construct() + error_messages = [] + match = 0 + # validate data type: AbsoluteDateFilter + if not isinstance(v, AbsoluteDateFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `AbsoluteDateFilter`") + else: + match += 1 + # validate data type: RelativeDateFilter + if not isinstance(v, RelativeDateFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `RelativeDateFilter`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in DateFilter with oneOf schemas: AbsoluteDateFilter, RelativeDateFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in DateFilter with oneOf schemas: AbsoluteDateFilter, RelativeDateFilter. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into AbsoluteDateFilter + try: + instance.actual_instance = AbsoluteDateFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RelativeDateFilter + try: + instance.actual_instance = RelativeDateFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into DateFilter with oneOf schemas: AbsoluteDateFilter, RelativeDateFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into DateFilter with oneOf schemas: AbsoluteDateFilter, RelativeDateFilter. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], AbsoluteDateFilter, RelativeDateFilter]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/date_relative_filter.py b/gooddata-api-client/gooddata_api_client/models/date_relative_filter.py new file mode 100644 index 000000000..b6ecfdc1d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/date_relative_filter.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DateRelativeFilter(BaseModel): + """ + DateRelativeFilter + """ # noqa: E501 + var_from: StrictInt = Field(alias="from") + granularity: StrictStr + to: StrictInt + using: StrictStr + __properties: ClassVar[List[str]] = ["from", "granularity", "to", "using"] + + @field_validator('granularity') + def granularity_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR']): + raise ValueError("must be one of enum values ('MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DateRelativeFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DateRelativeFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "from": obj.get("from"), + "granularity": obj.get("granularity"), + "to": obj.get("to"), + "using": obj.get("using") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/date_value.py b/gooddata-api-client/gooddata_api_client/models/date_value.py new file mode 100644 index 000000000..8656a04dc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/date_value.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DateValue(BaseModel): + """ + DateValue + """ # noqa: E501 + value: StrictStr + __properties: ClassVar[List[str]] = ["value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DateValue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DateValue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_aggregated_fact.py b/gooddata-api-client/gooddata_api_client/models/declarative_aggregated_fact.py new file mode 100644 index 000000000..c797d6353 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_aggregated_fact.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_source_fact_reference import DeclarativeSourceFactReference +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAggregatedFact(BaseModel): + """ + A dataset fact. + """ # noqa: E501 + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Fact description.") + id: Annotated[str, Field(strict=True)] = Field(description="Fact ID.") + source_column: Annotated[str, Field(strict=True, max_length=255)] = Field(description="A name of the source column in the table.", alias="sourceColumn") + source_column_data_type: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="A type of the source column", alias="sourceColumnDataType") + source_fact_reference: DeclarativeSourceFactReference = Field(alias="sourceFactReference") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + __properties: ClassVar[List[str]] = ["description", "id", "sourceColumn", "sourceColumnDataType", "sourceFactReference", "tags"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('source_column_data_type') + def source_column_data_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAggregatedFact from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of source_fact_reference + if self.source_fact_reference: + _dict['sourceFactReference'] = self.source_fact_reference.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAggregatedFact from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "id": obj.get("id"), + "sourceColumn": obj.get("sourceColumn"), + "sourceColumnDataType": obj.get("sourceColumnDataType"), + "sourceFactReference": DeclarativeSourceFactReference.from_dict(obj["sourceFactReference"]) if obj.get("sourceFactReference") is not None else None, + "tags": obj.get("tags") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard.py b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard.py new file mode 100644 index 000000000..2a169f8d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard.py @@ -0,0 +1,164 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_analytical_dashboard_permissions_inner import DeclarativeAnalyticalDashboardPermissionsInner +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAnalyticalDashboard(BaseModel): + """ + DeclarativeAnalyticalDashboard + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(description="Free-form JSON object") + created_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the entity creation.", alias="createdAt") + created_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="createdBy") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Analytical dashboard description.") + id: Annotated[str, Field(strict=True)] = Field(description="Analytical dashboard ID.") + modified_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the last entity modification.", alias="modifiedAt") + modified_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="modifiedBy") + permissions: Optional[List[DeclarativeAnalyticalDashboardPermissionsInner]] = Field(default=None, description="A list of permissions.") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Analytical dashboard title.") + __properties: ClassVar[List[str]] = ["content", "createdAt", "createdBy", "description", "id", "modifiedAt", "modifiedBy", "permissions", "tags", "title"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('modified_at') + def modified_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboard from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + # set to None if modified_at (nullable) is None + # and model_fields_set contains the field + if self.modified_at is None and "modified_at" in self.model_fields_set: + _dict['modifiedAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboard from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "createdAt": obj.get("createdAt"), + "createdBy": DeclarativeUserIdentifier.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "description": obj.get("description"), + "id": obj.get("id"), + "modifiedAt": obj.get("modifiedAt"), + "modifiedBy": DeclarativeUserIdentifier.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None, + "permissions": [DeclarativeAnalyticalDashboardPermissionsInner.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_extension.py b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_extension.py new file mode 100644 index 000000000..f72296f59 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_extension.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_analytical_dashboard_permissions_inner import DeclarativeAnalyticalDashboardPermissionsInner +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAnalyticalDashboardExtension(BaseModel): + """ + DeclarativeAnalyticalDashboardExtension + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Analytical dashboard ID.") + permissions: List[DeclarativeAnalyticalDashboardPermissionsInner] = Field(description="A list of permissions.") + __properties: ClassVar[List[str]] = ["id", "permissions"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboardExtension from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboardExtension from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "permissions": [DeclarativeAnalyticalDashboardPermissionsInner.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_identifier.py b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_identifier.py new file mode 100644 index 000000000..81e869d42 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAnalyticalDashboardIdentifier(BaseModel): + """ + An analytical dashboard identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Identifier of the analytical dashboard.") + type: StrictStr = Field(description="A type.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard']): + raise ValueError("must be one of enum values ('analyticalDashboard')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboardIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboardIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permission_assignment.py b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permission_assignment.py new file mode 100644 index 000000000..393f4e7c2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permission_assignment.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAnalyticalDashboardPermissionAssignment(BaseModel): + """ + Analytical dashboard permission. + """ # noqa: E501 + name: StrictStr = Field(description="Permission name.") + __properties: ClassVar[List[str]] = ["name"] + + @field_validator('name') + def name_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['EDIT', 'SHARE', 'VIEW']): + raise ValueError("must be one of enum values ('EDIT', 'SHARE', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboardPermissionAssignment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboardPermissionAssignment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permission_for_assignee.py b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permission_for_assignee.py new file mode 100644 index 000000000..7b22c4c1c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permission_for_assignee.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAnalyticalDashboardPermissionForAssignee(BaseModel): + """ + Analytical dashboard permission for an assignee. + """ # noqa: E501 + name: StrictStr = Field(description="Permission name.") + assignee: AssigneeIdentifier + __properties: ClassVar[List[str]] = ["name", "assignee"] + + @field_validator('name') + def name_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['EDIT', 'SHARE', 'VIEW']): + raise ValueError("must be one of enum values ('EDIT', 'SHARE', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboardPermissionForAssignee from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee + if self.assignee: + _dict['assignee'] = self.assignee.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboardPermissionForAssignee from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "assignee": AssigneeIdentifier.from_dict(obj["assignee"]) if obj.get("assignee") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permission_for_assignee_rule.py b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permission_for_assignee_rule.py new file mode 100644 index 000000000..4356aa380 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permission_for_assignee_rule.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_rule import AssigneeRule +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAnalyticalDashboardPermissionForAssigneeRule(BaseModel): + """ + Analytical dashboard permission for a collection of assignees identified by a rule. + """ # noqa: E501 + name: StrictStr = Field(description="Permission name.") + assignee_rule: AssigneeRule = Field(alias="assigneeRule") + __properties: ClassVar[List[str]] = ["name", "assigneeRule"] + + @field_validator('name') + def name_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['EDIT', 'SHARE', 'VIEW']): + raise ValueError("must be one of enum values ('EDIT', 'SHARE', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboardPermissionForAssigneeRule from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee_rule + if self.assignee_rule: + _dict['assigneeRule'] = self.assignee_rule.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticalDashboardPermissionForAssigneeRule from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "assigneeRule": AssigneeRule.from_dict(obj["assigneeRule"]) if obj.get("assigneeRule") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permissions_inner.py b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permissions_inner.py new file mode 100644 index 000000000..17ca35613 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_analytical_dashboard_permissions_inner.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.declarative_analytical_dashboard_permission_for_assignee import DeclarativeAnalyticalDashboardPermissionForAssignee +from gooddata_api_client.models.declarative_analytical_dashboard_permission_for_assignee_rule import DeclarativeAnalyticalDashboardPermissionForAssigneeRule +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +DECLARATIVEANALYTICALDASHBOARDPERMISSIONSINNER_ONE_OF_SCHEMAS = ["DeclarativeAnalyticalDashboardPermissionForAssignee", "DeclarativeAnalyticalDashboardPermissionForAssigneeRule"] + +class DeclarativeAnalyticalDashboardPermissionsInner(BaseModel): + """ + DeclarativeAnalyticalDashboardPermissionsInner + """ + # data type: DeclarativeAnalyticalDashboardPermissionForAssignee + oneof_schema_1_validator: Optional[DeclarativeAnalyticalDashboardPermissionForAssignee] = None + # data type: DeclarativeAnalyticalDashboardPermissionForAssigneeRule + oneof_schema_2_validator: Optional[DeclarativeAnalyticalDashboardPermissionForAssigneeRule] = None + actual_instance: Optional[Union[DeclarativeAnalyticalDashboardPermissionForAssignee, DeclarativeAnalyticalDashboardPermissionForAssigneeRule]] = None + one_of_schemas: Set[str] = { "DeclarativeAnalyticalDashboardPermissionForAssignee", "DeclarativeAnalyticalDashboardPermissionForAssigneeRule" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = DeclarativeAnalyticalDashboardPermissionsInner.model_construct() + error_messages = [] + match = 0 + # validate data type: DeclarativeAnalyticalDashboardPermissionForAssignee + if not isinstance(v, DeclarativeAnalyticalDashboardPermissionForAssignee): + error_messages.append(f"Error! Input type `{type(v)}` is not `DeclarativeAnalyticalDashboardPermissionForAssignee`") + else: + match += 1 + # validate data type: DeclarativeAnalyticalDashboardPermissionForAssigneeRule + if not isinstance(v, DeclarativeAnalyticalDashboardPermissionForAssigneeRule): + error_messages.append(f"Error! Input type `{type(v)}` is not `DeclarativeAnalyticalDashboardPermissionForAssigneeRule`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in DeclarativeAnalyticalDashboardPermissionsInner with oneOf schemas: DeclarativeAnalyticalDashboardPermissionForAssignee, DeclarativeAnalyticalDashboardPermissionForAssigneeRule. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in DeclarativeAnalyticalDashboardPermissionsInner with oneOf schemas: DeclarativeAnalyticalDashboardPermissionForAssignee, DeclarativeAnalyticalDashboardPermissionForAssigneeRule. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into DeclarativeAnalyticalDashboardPermissionForAssignee + try: + instance.actual_instance = DeclarativeAnalyticalDashboardPermissionForAssignee.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into DeclarativeAnalyticalDashboardPermissionForAssigneeRule + try: + instance.actual_instance = DeclarativeAnalyticalDashboardPermissionForAssigneeRule.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into DeclarativeAnalyticalDashboardPermissionsInner with oneOf schemas: DeclarativeAnalyticalDashboardPermissionForAssignee, DeclarativeAnalyticalDashboardPermissionForAssigneeRule. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into DeclarativeAnalyticalDashboardPermissionsInner with oneOf schemas: DeclarativeAnalyticalDashboardPermissionForAssignee, DeclarativeAnalyticalDashboardPermissionForAssigneeRule. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], DeclarativeAnalyticalDashboardPermissionForAssignee, DeclarativeAnalyticalDashboardPermissionForAssigneeRule]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_analytics.py b/gooddata-api-client/gooddata_api_client/models/declarative_analytics.py new file mode 100644 index 000000000..52cc9cae5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_analytics.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_analytics_layer import DeclarativeAnalyticsLayer +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAnalytics(BaseModel): + """ + Entities describing users' view on data. + """ # noqa: E501 + analytics: Optional[DeclarativeAnalyticsLayer] = None + __properties: ClassVar[List[str]] = ["analytics"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAnalytics from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of analytics + if self.analytics: + _dict['analytics'] = self.analytics.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAnalytics from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analytics": DeclarativeAnalyticsLayer.from_dict(obj["analytics"]) if obj.get("analytics") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_analytics_layer.py b/gooddata-api-client/gooddata_api_client/models/declarative_analytics_layer.py new file mode 100644 index 000000000..adb06595f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_analytics_layer.py @@ -0,0 +1,166 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard +from gooddata_api_client.models.declarative_analytical_dashboard_extension import DeclarativeAnalyticalDashboardExtension +from gooddata_api_client.models.declarative_attribute_hierarchy import DeclarativeAttributeHierarchy +from gooddata_api_client.models.declarative_dashboard_plugin import DeclarativeDashboardPlugin +from gooddata_api_client.models.declarative_export_definition import DeclarativeExportDefinition +from gooddata_api_client.models.declarative_filter_context import DeclarativeFilterContext +from gooddata_api_client.models.declarative_metric import DeclarativeMetric +from gooddata_api_client.models.declarative_visualization_object import DeclarativeVisualizationObject +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAnalyticsLayer(BaseModel): + """ + DeclarativeAnalyticsLayer + """ # noqa: E501 + analytical_dashboard_extensions: Optional[List[DeclarativeAnalyticalDashboardExtension]] = Field(default=None, description="A list of dashboard permissions assigned to a related dashboard.", alias="analyticalDashboardExtensions") + analytical_dashboards: Optional[List[DeclarativeAnalyticalDashboard]] = Field(default=None, description="A list of analytical dashboards available in the model.", alias="analyticalDashboards") + attribute_hierarchies: Optional[List[DeclarativeAttributeHierarchy]] = Field(default=None, description="A list of attribute hierarchies.", alias="attributeHierarchies") + dashboard_plugins: Optional[List[DeclarativeDashboardPlugin]] = Field(default=None, description="A list of dashboard plugins available in the model.", alias="dashboardPlugins") + export_definitions: Optional[List[DeclarativeExportDefinition]] = Field(default=None, description="A list of export definitions.", alias="exportDefinitions") + filter_contexts: Optional[List[DeclarativeFilterContext]] = Field(default=None, description="A list of filter contexts available in the model.", alias="filterContexts") + metrics: Optional[List[DeclarativeMetric]] = Field(default=None, description="A list of metrics available in the model.") + visualization_objects: Optional[List[DeclarativeVisualizationObject]] = Field(default=None, description="A list of visualization objects available in the model.", alias="visualizationObjects") + __properties: ClassVar[List[str]] = ["analyticalDashboardExtensions", "analyticalDashboards", "attributeHierarchies", "dashboardPlugins", "exportDefinitions", "filterContexts", "metrics", "visualizationObjects"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticsLayer from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in analytical_dashboard_extensions (list) + _items = [] + if self.analytical_dashboard_extensions: + for _item_analytical_dashboard_extensions in self.analytical_dashboard_extensions: + if _item_analytical_dashboard_extensions: + _items.append(_item_analytical_dashboard_extensions.to_dict()) + _dict['analyticalDashboardExtensions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in analytical_dashboards (list) + _items = [] + if self.analytical_dashboards: + for _item_analytical_dashboards in self.analytical_dashboards: + if _item_analytical_dashboards: + _items.append(_item_analytical_dashboards.to_dict()) + _dict['analyticalDashboards'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in attribute_hierarchies (list) + _items = [] + if self.attribute_hierarchies: + for _item_attribute_hierarchies in self.attribute_hierarchies: + if _item_attribute_hierarchies: + _items.append(_item_attribute_hierarchies.to_dict()) + _dict['attributeHierarchies'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in dashboard_plugins (list) + _items = [] + if self.dashboard_plugins: + for _item_dashboard_plugins in self.dashboard_plugins: + if _item_dashboard_plugins: + _items.append(_item_dashboard_plugins.to_dict()) + _dict['dashboardPlugins'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in export_definitions (list) + _items = [] + if self.export_definitions: + for _item_export_definitions in self.export_definitions: + if _item_export_definitions: + _items.append(_item_export_definitions.to_dict()) + _dict['exportDefinitions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in filter_contexts (list) + _items = [] + if self.filter_contexts: + for _item_filter_contexts in self.filter_contexts: + if _item_filter_contexts: + _items.append(_item_filter_contexts.to_dict()) + _dict['filterContexts'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in metrics (list) + _items = [] + if self.metrics: + for _item_metrics in self.metrics: + if _item_metrics: + _items.append(_item_metrics.to_dict()) + _dict['metrics'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in visualization_objects (list) + _items = [] + if self.visualization_objects: + for _item_visualization_objects in self.visualization_objects: + if _item_visualization_objects: + _items.append(_item_visualization_objects.to_dict()) + _dict['visualizationObjects'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAnalyticsLayer from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticalDashboardExtensions": [DeclarativeAnalyticalDashboardExtension.from_dict(_item) for _item in obj["analyticalDashboardExtensions"]] if obj.get("analyticalDashboardExtensions") is not None else None, + "analyticalDashboards": [DeclarativeAnalyticalDashboard.from_dict(_item) for _item in obj["analyticalDashboards"]] if obj.get("analyticalDashboards") is not None else None, + "attributeHierarchies": [DeclarativeAttributeHierarchy.from_dict(_item) for _item in obj["attributeHierarchies"]] if obj.get("attributeHierarchies") is not None else None, + "dashboardPlugins": [DeclarativeDashboardPlugin.from_dict(_item) for _item in obj["dashboardPlugins"]] if obj.get("dashboardPlugins") is not None else None, + "exportDefinitions": [DeclarativeExportDefinition.from_dict(_item) for _item in obj["exportDefinitions"]] if obj.get("exportDefinitions") is not None else None, + "filterContexts": [DeclarativeFilterContext.from_dict(_item) for _item in obj["filterContexts"]] if obj.get("filterContexts") is not None else None, + "metrics": [DeclarativeMetric.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None, + "visualizationObjects": [DeclarativeVisualizationObject.from_dict(_item) for _item in obj["visualizationObjects"]] if obj.get("visualizationObjects") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_attribute.py b/gooddata-api-client/gooddata_api_client/models/declarative_attribute.py new file mode 100644 index 000000000..9f4fb1707 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_attribute.py @@ -0,0 +1,148 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_label import DeclarativeLabel +from gooddata_api_client.models.label_identifier import LabelIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAttribute(BaseModel): + """ + A dataset attribute. + """ # noqa: E501 + default_view: Optional[LabelIdentifier] = Field(default=None, alias="defaultView") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Attribute description.") + id: Annotated[str, Field(strict=True)] = Field(description="Attribute ID.") + is_hidden: Optional[StrictBool] = Field(default=None, description="If true, this attribute is hidden from AI search results.", alias="isHidden") + labels: List[DeclarativeLabel] = Field(description="An array of attribute labels.") + sort_column: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Attribute sort column.", alias="sortColumn") + sort_direction: Optional[StrictStr] = Field(default=None, description="Attribute sort direction.", alias="sortDirection") + source_column: Annotated[str, Field(strict=True, max_length=255)] = Field(description="A name of the source column that is the primary label", alias="sourceColumn") + source_column_data_type: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="A type of the source column", alias="sourceColumnDataType") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Attribute title.") + __properties: ClassVar[List[str]] = ["defaultView", "description", "id", "isHidden", "labels", "sortColumn", "sortDirection", "sourceColumn", "sourceColumnDataType", "tags", "title"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('sort_direction') + def sort_direction_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ASC', 'DESC']): + raise ValueError("must be one of enum values ('ASC', 'DESC')") + return value + + @field_validator('source_column_data_type') + def source_column_data_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAttribute from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of default_view + if self.default_view: + _dict['defaultView'] = self.default_view.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in labels (list) + _items = [] + if self.labels: + for _item_labels in self.labels: + if _item_labels: + _items.append(_item_labels.to_dict()) + _dict['labels'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAttribute from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "defaultView": LabelIdentifier.from_dict(obj["defaultView"]) if obj.get("defaultView") is not None else None, + "description": obj.get("description"), + "id": obj.get("id"), + "isHidden": obj.get("isHidden"), + "labels": [DeclarativeLabel.from_dict(_item) for _item in obj["labels"]] if obj.get("labels") is not None else None, + "sortColumn": obj.get("sortColumn"), + "sortDirection": obj.get("sortDirection"), + "sourceColumn": obj.get("sourceColumn"), + "sourceColumnDataType": obj.get("sourceColumnDataType"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_attribute_hierarchy.py b/gooddata-api-client/gooddata_api_client/models/declarative_attribute_hierarchy.py new file mode 100644 index 000000000..5f26dd8fa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_attribute_hierarchy.py @@ -0,0 +1,154 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAttributeHierarchy(BaseModel): + """ + DeclarativeAttributeHierarchy + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(description="Free-form JSON object") + created_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the entity creation.", alias="createdAt") + created_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="createdBy") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Attribute hierarchy object description.") + id: Annotated[str, Field(strict=True)] = Field(description="Attribute hierarchy object ID.") + modified_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the last entity modification.", alias="modifiedAt") + modified_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="modifiedBy") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Attribute hierarchy object title.") + __properties: ClassVar[List[str]] = ["content", "createdAt", "createdBy", "description", "id", "modifiedAt", "modifiedBy", "tags", "title"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('modified_at') + def modified_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAttributeHierarchy from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + # set to None if modified_at (nullable) is None + # and model_fields_set contains the field + if self.modified_at is None and "modified_at" in self.model_fields_set: + _dict['modifiedAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAttributeHierarchy from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "createdAt": obj.get("createdAt"), + "createdBy": DeclarativeUserIdentifier.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "description": obj.get("description"), + "id": obj.get("id"), + "modifiedAt": obj.get("modifiedAt"), + "modifiedBy": DeclarativeUserIdentifier.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_automation.py b/gooddata-api-client/gooddata_api_client/models/declarative_automation.py new file mode 100644 index 000000000..a2a50bb65 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_automation.py @@ -0,0 +1,297 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.automation_alert import AutomationAlert +from gooddata_api_client.models.automation_dashboard_tabular_export import AutomationDashboardTabularExport +from gooddata_api_client.models.automation_external_recipient import AutomationExternalRecipient +from gooddata_api_client.models.automation_image_export import AutomationImageExport +from gooddata_api_client.models.automation_metadata import AutomationMetadata +from gooddata_api_client.models.automation_raw_export import AutomationRawExport +from gooddata_api_client.models.automation_schedule import AutomationSchedule +from gooddata_api_client.models.automation_slides_export import AutomationSlidesExport +from gooddata_api_client.models.automation_tabular_export import AutomationTabularExport +from gooddata_api_client.models.automation_visual_export import AutomationVisualExport +from gooddata_api_client.models.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier +from gooddata_api_client.models.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier +from gooddata_api_client.models.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeAutomation(BaseModel): + """ + DeclarativeAutomation + """ # noqa: E501 + alert: Optional[AutomationAlert] = None + analytical_dashboard: Optional[DeclarativeAnalyticalDashboardIdentifier] = Field(default=None, alias="analyticalDashboard") + created_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the entity creation.", alias="createdAt") + created_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="createdBy") + dashboard_tabular_exports: Optional[List[AutomationDashboardTabularExport]] = Field(default=None, alias="dashboardTabularExports") + description: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + details: Optional[Dict[str, Annotated[str, Field(strict=True, max_length=10000)]]] = Field(default=None, description="TODO") + evaluation_mode: Optional[StrictStr] = Field(default='PER_RECIPIENT', description="Specify automation evaluation mode.", alias="evaluationMode") + export_definitions: Optional[List[DeclarativeExportDefinitionIdentifier]] = Field(default=None, alias="exportDefinitions") + external_recipients: Optional[List[AutomationExternalRecipient]] = Field(default=None, description="External recipients of the automation action results.", alias="externalRecipients") + id: Annotated[str, Field(strict=True)] + image_exports: Optional[List[AutomationImageExport]] = Field(default=None, alias="imageExports") + metadata: Optional[AutomationMetadata] = None + modified_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the last entity modification.", alias="modifiedAt") + modified_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="modifiedBy") + notification_channel: Optional[DeclarativeNotificationChannelIdentifier] = Field(default=None, alias="notificationChannel") + raw_exports: Optional[List[AutomationRawExport]] = Field(default=None, alias="rawExports") + recipients: Optional[List[DeclarativeUserIdentifier]] = None + schedule: Optional[AutomationSchedule] = None + slides_exports: Optional[List[AutomationSlidesExport]] = Field(default=None, alias="slidesExports") + state: Optional[StrictStr] = Field(default='ACTIVE', description="Current state of the automation.") + tabular_exports: Optional[List[AutomationTabularExport]] = Field(default=None, alias="tabularExports") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + visual_exports: Optional[List[AutomationVisualExport]] = Field(default=None, alias="visualExports") + __properties: ClassVar[List[str]] = ["alert", "analyticalDashboard", "createdAt", "createdBy", "dashboardTabularExports", "description", "details", "evaluationMode", "exportDefinitions", "externalRecipients", "id", "imageExports", "metadata", "modifiedAt", "modifiedBy", "notificationChannel", "rawExports", "recipients", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + @field_validator('evaluation_mode') + def evaluation_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SHARED', 'PER_RECIPIENT']): + raise ValueError("must be one of enum values ('SHARED', 'PER_RECIPIENT')") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('modified_at') + def modified_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + @field_validator('state') + def state_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ACTIVE', 'PAUSED']): + raise ValueError("must be one of enum values ('ACTIVE', 'PAUSED')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeAutomation from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of alert + if self.alert: + _dict['alert'] = self.alert.to_dict() + # override the default output from pydantic by calling `to_dict()` of analytical_dashboard + if self.analytical_dashboard: + _dict['analyticalDashboard'] = self.analytical_dashboard.to_dict() + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in dashboard_tabular_exports (list) + _items = [] + if self.dashboard_tabular_exports: + for _item_dashboard_tabular_exports in self.dashboard_tabular_exports: + if _item_dashboard_tabular_exports: + _items.append(_item_dashboard_tabular_exports.to_dict()) + _dict['dashboardTabularExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in export_definitions (list) + _items = [] + if self.export_definitions: + for _item_export_definitions in self.export_definitions: + if _item_export_definitions: + _items.append(_item_export_definitions.to_dict()) + _dict['exportDefinitions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in external_recipients (list) + _items = [] + if self.external_recipients: + for _item_external_recipients in self.external_recipients: + if _item_external_recipients: + _items.append(_item_external_recipients.to_dict()) + _dict['externalRecipients'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in image_exports (list) + _items = [] + if self.image_exports: + for _item_image_exports in self.image_exports: + if _item_image_exports: + _items.append(_item_image_exports.to_dict()) + _dict['imageExports'] = _items + # override the default output from pydantic by calling `to_dict()` of metadata + if self.metadata: + _dict['metadata'] = self.metadata.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of notification_channel + if self.notification_channel: + _dict['notificationChannel'] = self.notification_channel.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in raw_exports (list) + _items = [] + if self.raw_exports: + for _item_raw_exports in self.raw_exports: + if _item_raw_exports: + _items.append(_item_raw_exports.to_dict()) + _dict['rawExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in recipients (list) + _items = [] + if self.recipients: + for _item_recipients in self.recipients: + if _item_recipients: + _items.append(_item_recipients.to_dict()) + _dict['recipients'] = _items + # override the default output from pydantic by calling `to_dict()` of schedule + if self.schedule: + _dict['schedule'] = self.schedule.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in slides_exports (list) + _items = [] + if self.slides_exports: + for _item_slides_exports in self.slides_exports: + if _item_slides_exports: + _items.append(_item_slides_exports.to_dict()) + _dict['slidesExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in tabular_exports (list) + _items = [] + if self.tabular_exports: + for _item_tabular_exports in self.tabular_exports: + if _item_tabular_exports: + _items.append(_item_tabular_exports.to_dict()) + _dict['tabularExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in visual_exports (list) + _items = [] + if self.visual_exports: + for _item_visual_exports in self.visual_exports: + if _item_visual_exports: + _items.append(_item_visual_exports.to_dict()) + _dict['visualExports'] = _items + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + # set to None if modified_at (nullable) is None + # and model_fields_set contains the field + if self.modified_at is None and "modified_at" in self.model_fields_set: + _dict['modifiedAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeAutomation from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "alert": AutomationAlert.from_dict(obj["alert"]) if obj.get("alert") is not None else None, + "analyticalDashboard": DeclarativeAnalyticalDashboardIdentifier.from_dict(obj["analyticalDashboard"]) if obj.get("analyticalDashboard") is not None else None, + "createdAt": obj.get("createdAt"), + "createdBy": DeclarativeUserIdentifier.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "dashboardTabularExports": [AutomationDashboardTabularExport.from_dict(_item) for _item in obj["dashboardTabularExports"]] if obj.get("dashboardTabularExports") is not None else None, + "description": obj.get("description"), + "details": obj.get("details"), + "evaluationMode": obj.get("evaluationMode") if obj.get("evaluationMode") is not None else 'PER_RECIPIENT', + "exportDefinitions": [DeclarativeExportDefinitionIdentifier.from_dict(_item) for _item in obj["exportDefinitions"]] if obj.get("exportDefinitions") is not None else None, + "externalRecipients": [AutomationExternalRecipient.from_dict(_item) for _item in obj["externalRecipients"]] if obj.get("externalRecipients") is not None else None, + "id": obj.get("id"), + "imageExports": [AutomationImageExport.from_dict(_item) for _item in obj["imageExports"]] if obj.get("imageExports") is not None else None, + "metadata": AutomationMetadata.from_dict(obj["metadata"]) if obj.get("metadata") is not None else None, + "modifiedAt": obj.get("modifiedAt"), + "modifiedBy": DeclarativeUserIdentifier.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None, + "notificationChannel": DeclarativeNotificationChannelIdentifier.from_dict(obj["notificationChannel"]) if obj.get("notificationChannel") is not None else None, + "rawExports": [AutomationRawExport.from_dict(_item) for _item in obj["rawExports"]] if obj.get("rawExports") is not None else None, + "recipients": [DeclarativeUserIdentifier.from_dict(_item) for _item in obj["recipients"]] if obj.get("recipients") is not None else None, + "schedule": AutomationSchedule.from_dict(obj["schedule"]) if obj.get("schedule") is not None else None, + "slidesExports": [AutomationSlidesExport.from_dict(_item) for _item in obj["slidesExports"]] if obj.get("slidesExports") is not None else None, + "state": obj.get("state") if obj.get("state") is not None else 'ACTIVE', + "tabularExports": [AutomationTabularExport.from_dict(_item) for _item in obj["tabularExports"]] if obj.get("tabularExports") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title"), + "visualExports": [AutomationVisualExport.from_dict(_item) for _item in obj["visualExports"]] if obj.get("visualExports") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_color_palette.py b/gooddata-api-client/gooddata_api_client/models/declarative_color_palette.py new file mode 100644 index 000000000..8f3ae0bb2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_color_palette.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeColorPalette(BaseModel): + """ + Color palette and its properties. + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(description="Free-form JSON object") + id: StrictStr + name: Annotated[str, Field(strict=True, max_length=255)] + __properties: ClassVar[List[str]] = ["content", "id", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeColorPalette from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeColorPalette from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "id": obj.get("id"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_column.py b/gooddata-api-client/gooddata_api_client/models/declarative_column.py new file mode 100644 index 000000000..b0f3e42e3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_column.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeColumn(BaseModel): + """ + A table column. + """ # noqa: E501 + data_type: StrictStr = Field(description="Column type", alias="dataType") + is_primary_key: Optional[StrictBool] = Field(default=None, description="Is column part of primary key?", alias="isPrimaryKey") + name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Column name") + referenced_table_column: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Referenced table (Foreign key)", alias="referencedTableColumn") + referenced_table_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Referenced table (Foreign key)", alias="referencedTableId") + __properties: ClassVar[List[str]] = ["dataType", "isPrimaryKey", "name", "referencedTableColumn", "referencedTableId"] + + @field_validator('data_type') + def data_type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeColumn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeColumn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataType": obj.get("dataType"), + "isPrimaryKey": obj.get("isPrimaryKey"), + "name": obj.get("name"), + "referencedTableColumn": obj.get("referencedTableColumn"), + "referencedTableId": obj.get("referencedTableId") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_csp_directive.py b/gooddata-api-client/gooddata_api_client/models/declarative_csp_directive.py new file mode 100644 index 000000000..a75f635a8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_csp_directive.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeCspDirective(BaseModel): + """ + DeclarativeCspDirective + """ # noqa: E501 + directive: Annotated[str, Field(strict=True, max_length=255)] + sources: List[StrictStr] + __properties: ClassVar[List[str]] = ["directive", "sources"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeCspDirective from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeCspDirective from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "directive": obj.get("directive"), + "sources": obj.get("sources") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_custom_application_setting.py b/gooddata-api-client/gooddata_api_client/models/declarative_custom_application_setting.py new file mode 100644 index 000000000..f20ff93fe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_custom_application_setting.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeCustomApplicationSetting(BaseModel): + """ + Custom application setting and its value. + """ # noqa: E501 + application_name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="The application id", alias="applicationName") + content: Optional[Dict[str, Any]] = Field(description="Free-form JSON object") + id: Annotated[str, Field(strict=True)] = Field(description="Custom Application Setting ID.") + __properties: ClassVar[List[str]] = ["applicationName", "content", "id"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeCustomApplicationSetting from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeCustomApplicationSetting from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applicationName": obj.get("applicationName"), + "content": obj.get("content"), + "id": obj.get("id") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_dashboard_plugin.py b/gooddata-api-client/gooddata_api_client/models/declarative_dashboard_plugin.py new file mode 100644 index 000000000..fd3dac3b1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_dashboard_plugin.py @@ -0,0 +1,154 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeDashboardPlugin(BaseModel): + """ + DeclarativeDashboardPlugin + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(description="Free-form JSON object") + created_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the entity creation.", alias="createdAt") + created_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="createdBy") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Dashboard plugin description.") + id: Annotated[str, Field(strict=True)] = Field(description="Dashboard plugin object ID.") + modified_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the last entity modification.", alias="modifiedAt") + modified_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="modifiedBy") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Dashboard plugin object title.") + __properties: ClassVar[List[str]] = ["content", "createdAt", "createdBy", "description", "id", "modifiedAt", "modifiedBy", "tags", "title"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('modified_at') + def modified_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeDashboardPlugin from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + # set to None if modified_at (nullable) is None + # and model_fields_set contains the field + if self.modified_at is None and "modified_at" in self.model_fields_set: + _dict['modifiedAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeDashboardPlugin from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "createdAt": obj.get("createdAt"), + "createdBy": DeclarativeUserIdentifier.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "description": obj.get("description"), + "id": obj.get("id"), + "modifiedAt": obj.get("modifiedAt"), + "modifiedBy": DeclarativeUserIdentifier.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_data_source.py b/gooddata-api-client/gooddata_api_client/models/declarative_data_source.py new file mode 100644 index 000000000..fb2ae3150 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_data_source.py @@ -0,0 +1,193 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_data_source_permission import DeclarativeDataSourcePermission +from gooddata_api_client.models.parameter import Parameter +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeDataSource(BaseModel): + """ + A data source and its properties. + """ # noqa: E501 + authentication_type: Optional[StrictStr] = Field(default=None, description="Type of authentication used to connect to the database.", alias="authenticationType") + cache_strategy: Optional[StrictStr] = Field(default=None, description="Determines how the results coming from a particular datasource should be cached. - ALWAYS: The results from the datasource should be cached normally (the default). - NEVER: The results from the datasource should never be cached.", alias="cacheStrategy") + client_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Id of client with permission to connect to the data source.", alias="clientId") + client_secret: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The client secret to use to connect to the database providing the data for the data source.", alias="clientSecret") + decoded_parameters: Optional[List[Parameter]] = Field(default=None, alias="decodedParameters") + id: Annotated[str, Field(strict=True)] = Field(description="Data source ID.") + name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Name of the data source.") + parameters: Optional[List[Parameter]] = None + password: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Password for the data-source user, property is never returned back.") + permissions: Optional[List[DeclarativeDataSourcePermission]] = None + private_key: Optional[Annotated[str, Field(strict=True, max_length=15000)]] = Field(default=None, description="The private key to use to connect to the database providing the data for the data source.", alias="privateKey") + private_key_passphrase: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The passphrase used to encrypt the private key.", alias="privateKeyPassphrase") + var_schema: Annotated[str, Field(strict=True, max_length=255)] = Field(description="A scheme/database with the data.", alias="schema") + token: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Token as an alternative to username and password.") + type: StrictStr = Field(description="Type of database.") + url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="An connection string relevant to type of database.") + username: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="User with permission connect the data source/database.") + __properties: ClassVar[List[str]] = ["authenticationType", "cacheStrategy", "clientId", "clientSecret", "decodedParameters", "id", "name", "parameters", "password", "permissions", "privateKey", "privateKeyPassphrase", "schema", "token", "type", "url", "username"] + + @field_validator('authentication_type') + def authentication_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['USERNAME_PASSWORD', 'TOKEN', 'KEY_PAIR', 'CLIENT_SECRET', 'ACCESS_TOKEN']): + raise ValueError("must be one of enum values ('USERNAME_PASSWORD', 'TOKEN', 'KEY_PAIR', 'CLIENT_SECRET', 'ACCESS_TOKEN')") + return value + + @field_validator('cache_strategy') + def cache_strategy_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ALWAYS', 'NEVER']): + raise ValueError("must be one of enum values ('ALWAYS', 'NEVER')") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB']): + raise ValueError("must be one of enum values ('POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeDataSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in decoded_parameters (list) + _items = [] + if self.decoded_parameters: + for _item_decoded_parameters in self.decoded_parameters: + if _item_decoded_parameters: + _items.append(_item_decoded_parameters.to_dict()) + _dict['decodedParameters'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in parameters (list) + _items = [] + if self.parameters: + for _item_parameters in self.parameters: + if _item_parameters: + _items.append(_item_parameters.to_dict()) + _dict['parameters'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + # set to None if authentication_type (nullable) is None + # and model_fields_set contains the field + if self.authentication_type is None and "authentication_type" in self.model_fields_set: + _dict['authenticationType'] = None + + # set to None if private_key (nullable) is None + # and model_fields_set contains the field + if self.private_key is None and "private_key" in self.model_fields_set: + _dict['privateKey'] = None + + # set to None if private_key_passphrase (nullable) is None + # and model_fields_set contains the field + if self.private_key_passphrase is None and "private_key_passphrase" in self.model_fields_set: + _dict['privateKeyPassphrase'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeDataSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "authenticationType": obj.get("authenticationType"), + "cacheStrategy": obj.get("cacheStrategy"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "decodedParameters": [Parameter.from_dict(_item) for _item in obj["decodedParameters"]] if obj.get("decodedParameters") is not None else None, + "id": obj.get("id"), + "name": obj.get("name"), + "parameters": [Parameter.from_dict(_item) for _item in obj["parameters"]] if obj.get("parameters") is not None else None, + "password": obj.get("password"), + "permissions": [DeclarativeDataSourcePermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None, + "privateKey": obj.get("privateKey"), + "privateKeyPassphrase": obj.get("privateKeyPassphrase"), + "schema": obj.get("schema"), + "token": obj.get("token"), + "type": obj.get("type"), + "url": obj.get("url"), + "username": obj.get("username") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_data_source_permission.py b/gooddata-api-client/gooddata_api_client/models/declarative_data_source_permission.py new file mode 100644 index 000000000..0b95c0b35 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_data_source_permission.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeDataSourcePermission(BaseModel): + """ + DeclarativeDataSourcePermission + """ # noqa: E501 + assignee: AssigneeIdentifier + name: StrictStr = Field(description="Permission name.") + __properties: ClassVar[List[str]] = ["assignee", "name"] + + @field_validator('name') + def name_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['MANAGE', 'USE']): + raise ValueError("must be one of enum values ('MANAGE', 'USE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeDataSourcePermission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee + if self.assignee: + _dict['assignee'] = self.assignee.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeDataSourcePermission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assignee": AssigneeIdentifier.from_dict(obj["assignee"]) if obj.get("assignee") is not None else None, + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_data_source_permissions.py b/gooddata-api-client/gooddata_api_client/models/declarative_data_source_permissions.py new file mode 100644 index 000000000..757fb626f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_data_source_permissions.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_data_source_permission import DeclarativeDataSourcePermission +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeDataSourcePermissions(BaseModel): + """ + Data source permissions. + """ # noqa: E501 + permissions: Optional[List[DeclarativeDataSourcePermission]] = None + __properties: ClassVar[List[str]] = ["permissions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeDataSourcePermissions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeDataSourcePermissions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": [DeclarativeDataSourcePermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_data_sources.py b/gooddata-api-client/gooddata_api_client/models/declarative_data_sources.py new file mode 100644 index 000000000..d3a147bba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_data_sources.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.declarative_data_source import DeclarativeDataSource +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeDataSources(BaseModel): + """ + A data source and its properties. + """ # noqa: E501 + data_sources: List[DeclarativeDataSource] = Field(alias="dataSources") + __properties: ClassVar[List[str]] = ["dataSources"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeDataSources from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_sources (list) + _items = [] + if self.data_sources: + for _item_data_sources in self.data_sources: + if _item_data_sources: + _items.append(_item_data_sources.to_dict()) + _dict['dataSources'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeDataSources from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataSources": [DeclarativeDataSource.from_dict(_item) for _item in obj["dataSources"]] if obj.get("dataSources") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_dataset.py b/gooddata-api-client/gooddata_api_client/models/declarative_dataset.py new file mode 100644 index 000000000..254d6bb3b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_dataset.py @@ -0,0 +1,186 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.data_source_table_identifier import DataSourceTableIdentifier +from gooddata_api_client.models.declarative_aggregated_fact import DeclarativeAggregatedFact +from gooddata_api_client.models.declarative_attribute import DeclarativeAttribute +from gooddata_api_client.models.declarative_dataset_sql import DeclarativeDatasetSql +from gooddata_api_client.models.declarative_fact import DeclarativeFact +from gooddata_api_client.models.declarative_reference import DeclarativeReference +from gooddata_api_client.models.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn +from gooddata_api_client.models.declarative_workspace_data_filter_references import DeclarativeWorkspaceDataFilterReferences +from gooddata_api_client.models.grain_identifier import GrainIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeDataset(BaseModel): + """ + A dataset defined by its properties. + """ # noqa: E501 + aggregated_facts: Optional[List[DeclarativeAggregatedFact]] = Field(default=None, description="An array of aggregated facts.", alias="aggregatedFacts") + attributes: Optional[List[DeclarativeAttribute]] = Field(default=None, description="An array of attributes.") + data_source_table_id: Optional[DataSourceTableIdentifier] = Field(default=None, alias="dataSourceTableId") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="A dataset description.") + facts: Optional[List[DeclarativeFact]] = Field(default=None, description="An array of facts.") + grain: List[GrainIdentifier] = Field(description="An array of grain identifiers.") + id: Annotated[str, Field(strict=True)] = Field(description="The Dataset ID. This ID is further used to refer to this instance of dataset.") + precedence: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Precedence used in aggregate awareness.") + references: List[DeclarativeReference] = Field(description="An array of references.") + sql: Optional[DeclarativeDatasetSql] = None + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="A dataset title.") + workspace_data_filter_columns: Optional[List[DeclarativeWorkspaceDataFilterColumn]] = Field(default=None, description="An array of columns which are available for match to implicit workspace data filters.", alias="workspaceDataFilterColumns") + workspace_data_filter_references: Optional[List[DeclarativeWorkspaceDataFilterReferences]] = Field(default=None, description="An array of explicit workspace data filters.", alias="workspaceDataFilterReferences") + __properties: ClassVar[List[str]] = ["aggregatedFacts", "attributes", "dataSourceTableId", "description", "facts", "grain", "id", "precedence", "references", "sql", "tags", "title", "workspaceDataFilterColumns", "workspaceDataFilterReferences"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeDataset from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in aggregated_facts (list) + _items = [] + if self.aggregated_facts: + for _item_aggregated_facts in self.aggregated_facts: + if _item_aggregated_facts: + _items.append(_item_aggregated_facts.to_dict()) + _dict['aggregatedFacts'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in attributes (list) + _items = [] + if self.attributes: + for _item_attributes in self.attributes: + if _item_attributes: + _items.append(_item_attributes.to_dict()) + _dict['attributes'] = _items + # override the default output from pydantic by calling `to_dict()` of data_source_table_id + if self.data_source_table_id: + _dict['dataSourceTableId'] = self.data_source_table_id.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in facts (list) + _items = [] + if self.facts: + for _item_facts in self.facts: + if _item_facts: + _items.append(_item_facts.to_dict()) + _dict['facts'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in grain (list) + _items = [] + if self.grain: + for _item_grain in self.grain: + if _item_grain: + _items.append(_item_grain.to_dict()) + _dict['grain'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in references (list) + _items = [] + if self.references: + for _item_references in self.references: + if _item_references: + _items.append(_item_references.to_dict()) + _dict['references'] = _items + # override the default output from pydantic by calling `to_dict()` of sql + if self.sql: + _dict['sql'] = self.sql.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in workspace_data_filter_columns (list) + _items = [] + if self.workspace_data_filter_columns: + for _item_workspace_data_filter_columns in self.workspace_data_filter_columns: + if _item_workspace_data_filter_columns: + _items.append(_item_workspace_data_filter_columns.to_dict()) + _dict['workspaceDataFilterColumns'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in workspace_data_filter_references (list) + _items = [] + if self.workspace_data_filter_references: + for _item_workspace_data_filter_references in self.workspace_data_filter_references: + if _item_workspace_data_filter_references: + _items.append(_item_workspace_data_filter_references.to_dict()) + _dict['workspaceDataFilterReferences'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeDataset from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "aggregatedFacts": [DeclarativeAggregatedFact.from_dict(_item) for _item in obj["aggregatedFacts"]] if obj.get("aggregatedFacts") is not None else None, + "attributes": [DeclarativeAttribute.from_dict(_item) for _item in obj["attributes"]] if obj.get("attributes") is not None else None, + "dataSourceTableId": DataSourceTableIdentifier.from_dict(obj["dataSourceTableId"]) if obj.get("dataSourceTableId") is not None else None, + "description": obj.get("description"), + "facts": [DeclarativeFact.from_dict(_item) for _item in obj["facts"]] if obj.get("facts") is not None else None, + "grain": [GrainIdentifier.from_dict(_item) for _item in obj["grain"]] if obj.get("grain") is not None else None, + "id": obj.get("id"), + "precedence": obj.get("precedence"), + "references": [DeclarativeReference.from_dict(_item) for _item in obj["references"]] if obj.get("references") is not None else None, + "sql": DeclarativeDatasetSql.from_dict(obj["sql"]) if obj.get("sql") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title"), + "workspaceDataFilterColumns": [DeclarativeWorkspaceDataFilterColumn.from_dict(_item) for _item in obj["workspaceDataFilterColumns"]] if obj.get("workspaceDataFilterColumns") is not None else None, + "workspaceDataFilterReferences": [DeclarativeWorkspaceDataFilterReferences.from_dict(_item) for _item in obj["workspaceDataFilterReferences"]] if obj.get("workspaceDataFilterReferences") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_dataset_extension.py b/gooddata-api-client/gooddata_api_client/models/declarative_dataset_extension.py new file mode 100644 index 000000000..62121aede --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_dataset_extension.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_workspace_data_filter_references import DeclarativeWorkspaceDataFilterReferences +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeDatasetExtension(BaseModel): + """ + A dataset extension properties. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="The Dataset ID. This ID is further used to refer to this instance of dataset.") + workspace_data_filter_references: Optional[List[DeclarativeWorkspaceDataFilterReferences]] = Field(default=None, description="An array of explicit workspace data filters.", alias="workspaceDataFilterReferences") + __properties: ClassVar[List[str]] = ["id", "workspaceDataFilterReferences"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeDatasetExtension from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in workspace_data_filter_references (list) + _items = [] + if self.workspace_data_filter_references: + for _item_workspace_data_filter_references in self.workspace_data_filter_references: + if _item_workspace_data_filter_references: + _items.append(_item_workspace_data_filter_references.to_dict()) + _dict['workspaceDataFilterReferences'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeDatasetExtension from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "workspaceDataFilterReferences": [DeclarativeWorkspaceDataFilterReferences.from_dict(_item) for _item in obj["workspaceDataFilterReferences"]] if obj.get("workspaceDataFilterReferences") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_dataset_sql.py b/gooddata-api-client/gooddata_api_client/models/declarative_dataset_sql.py new file mode 100644 index 000000000..baf9c0df9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_dataset_sql.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeDatasetSql(BaseModel): + """ + SQL defining this dataset. + """ # noqa: E501 + data_source_id: StrictStr = Field(description="Data source ID.", alias="dataSourceId") + statement: StrictStr = Field(description="SQL statement.") + __properties: ClassVar[List[str]] = ["dataSourceId", "statement"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeDatasetSql from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeDatasetSql from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataSourceId": obj.get("dataSourceId"), + "statement": obj.get("statement") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_date_dataset.py b/gooddata-api-client/gooddata_api_client/models/declarative_date_dataset.py new file mode 100644 index 000000000..c0934df7d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_date_dataset.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.granularities_formatting import GranularitiesFormatting +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeDateDataset(BaseModel): + """ + A date dataset. + """ # noqa: E501 + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Date dataset description.") + granularities: List[StrictStr] = Field(description="An array of date granularities. All listed granularities will be available for date dataset.") + granularities_formatting: GranularitiesFormatting = Field(alias="granularitiesFormatting") + id: Annotated[str, Field(strict=True)] = Field(description="Date dataset ID.") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Date dataset title.") + __properties: ClassVar[List[str]] = ["description", "granularities", "granularitiesFormatting", "id", "tags", "title"] + + @field_validator('granularities') + def granularities_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR']): + raise ValueError("each list item must be one of ('MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR')") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeDateDataset from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of granularities_formatting + if self.granularities_formatting: + _dict['granularitiesFormatting'] = self.granularities_formatting.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeDateDataset from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "granularities": obj.get("granularities"), + "granularitiesFormatting": GranularitiesFormatting.from_dict(obj["granularitiesFormatting"]) if obj.get("granularitiesFormatting") is not None else None, + "id": obj.get("id"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_export_definition.py b/gooddata-api-client/gooddata_api_client/models/declarative_export_definition.py new file mode 100644 index 000000000..81c4f432a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_export_definition.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_export_definition_request_payload import DeclarativeExportDefinitionRequestPayload +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeExportDefinition(BaseModel): + """ + DeclarativeExportDefinition + """ # noqa: E501 + created_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the entity creation.", alias="createdAt") + created_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="createdBy") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Export definition object description.") + id: Annotated[str, Field(strict=True)] = Field(description="Export definition id.") + modified_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the last entity modification.", alias="modifiedAt") + modified_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="modifiedBy") + request_payload: Optional[DeclarativeExportDefinitionRequestPayload] = Field(default=None, alias="requestPayload") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Export definition object title.") + __properties: ClassVar[List[str]] = ["createdAt", "createdBy", "description", "id", "modifiedAt", "modifiedBy", "requestPayload", "tags", "title"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('modified_at') + def modified_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeExportDefinition from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + # set to None if modified_at (nullable) is None + # and model_fields_set contains the field + if self.modified_at is None and "modified_at" in self.model_fields_set: + _dict['modifiedAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeExportDefinition from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "createdAt": obj.get("createdAt"), + "createdBy": DeclarativeUserIdentifier.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "description": obj.get("description"), + "id": obj.get("id"), + "modifiedAt": obj.get("modifiedAt"), + "modifiedBy": DeclarativeUserIdentifier.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None, + "requestPayload": DeclarativeExportDefinitionRequestPayload.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_export_definition_identifier.py b/gooddata-api-client/gooddata_api_client/models/declarative_export_definition_identifier.py new file mode 100644 index 000000000..63623b718 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_export_definition_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeExportDefinitionIdentifier(BaseModel): + """ + An export definition identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Export definition identifier.") + type: StrictStr = Field(description="A type.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportDefinition']): + raise ValueError("must be one of enum values ('exportDefinition')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeExportDefinitionIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeExportDefinitionIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_export_definition_request_payload.py b/gooddata-api-client/gooddata_api_client/models/declarative_export_definition_request_payload.py new file mode 100644 index 000000000..65e86b141 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_export_definition_request_payload.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.visual_export_request import VisualExportRequest +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +DECLARATIVEEXPORTDEFINITIONREQUESTPAYLOAD_ONE_OF_SCHEMAS = ["TabularExportRequest", "VisualExportRequest"] + +class DeclarativeExportDefinitionRequestPayload(BaseModel): + """ + DeclarativeExportDefinitionRequestPayload + """ + # data type: TabularExportRequest + oneof_schema_1_validator: Optional[TabularExportRequest] = None + # data type: VisualExportRequest + oneof_schema_2_validator: Optional[VisualExportRequest] = None + actual_instance: Optional[Union[TabularExportRequest, VisualExportRequest]] = None + one_of_schemas: Set[str] = { "TabularExportRequest", "VisualExportRequest" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = DeclarativeExportDefinitionRequestPayload.model_construct() + error_messages = [] + match = 0 + # validate data type: TabularExportRequest + if not isinstance(v, TabularExportRequest): + error_messages.append(f"Error! Input type `{type(v)}` is not `TabularExportRequest`") + else: + match += 1 + # validate data type: VisualExportRequest + if not isinstance(v, VisualExportRequest): + error_messages.append(f"Error! Input type `{type(v)}` is not `VisualExportRequest`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in DeclarativeExportDefinitionRequestPayload with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in DeclarativeExportDefinitionRequestPayload with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into TabularExportRequest + try: + instance.actual_instance = TabularExportRequest.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into VisualExportRequest + try: + instance.actual_instance = VisualExportRequest.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into DeclarativeExportDefinitionRequestPayload with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into DeclarativeExportDefinitionRequestPayload with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], TabularExportRequest, VisualExportRequest]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_export_template.py b/gooddata-api-client/gooddata_api_client/models/declarative_export_template.py new file mode 100644 index 000000000..4f429f30e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_export_template.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.dashboard_slides_template import DashboardSlidesTemplate +from gooddata_api_client.models.widget_slides_template import WidgetSlidesTemplate +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeExportTemplate(BaseModel): + """ + A declarative form of a particular export template. + """ # noqa: E501 + dashboard_slides_template: Optional[DashboardSlidesTemplate] = Field(default=None, alias="dashboardSlidesTemplate") + id: Annotated[str, Field(strict=True)] = Field(description="Identifier of an export template") + name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Name of an export template.") + widget_slides_template: Optional[WidgetSlidesTemplate] = Field(default=None, alias="widgetSlidesTemplate") + __properties: ClassVar[List[str]] = ["dashboardSlidesTemplate", "id", "name", "widgetSlidesTemplate"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeExportTemplate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dashboard_slides_template + if self.dashboard_slides_template: + _dict['dashboardSlidesTemplate'] = self.dashboard_slides_template.to_dict() + # override the default output from pydantic by calling `to_dict()` of widget_slides_template + if self.widget_slides_template: + _dict['widgetSlidesTemplate'] = self.widget_slides_template.to_dict() + # set to None if dashboard_slides_template (nullable) is None + # and model_fields_set contains the field + if self.dashboard_slides_template is None and "dashboard_slides_template" in self.model_fields_set: + _dict['dashboardSlidesTemplate'] = None + + # set to None if widget_slides_template (nullable) is None + # and model_fields_set contains the field + if self.widget_slides_template is None and "widget_slides_template" in self.model_fields_set: + _dict['widgetSlidesTemplate'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeExportTemplate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dashboardSlidesTemplate": DashboardSlidesTemplate.from_dict(obj["dashboardSlidesTemplate"]) if obj.get("dashboardSlidesTemplate") is not None else None, + "id": obj.get("id"), + "name": obj.get("name"), + "widgetSlidesTemplate": WidgetSlidesTemplate.from_dict(obj["widgetSlidesTemplate"]) if obj.get("widgetSlidesTemplate") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_export_templates.py b/gooddata-api-client/gooddata_api_client/models/declarative_export_templates.py new file mode 100644 index 000000000..45b8b4213 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_export_templates.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.declarative_export_template import DeclarativeExportTemplate +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeExportTemplates(BaseModel): + """ + Export templates. + """ # noqa: E501 + export_templates: List[DeclarativeExportTemplate] = Field(alias="exportTemplates") + __properties: ClassVar[List[str]] = ["exportTemplates"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeExportTemplates from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in export_templates (list) + _items = [] + if self.export_templates: + for _item_export_templates in self.export_templates: + if _item_export_templates: + _items.append(_item_export_templates.to_dict()) + _dict['exportTemplates'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeExportTemplates from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "exportTemplates": [DeclarativeExportTemplate.from_dict(_item) for _item in obj["exportTemplates"]] if obj.get("exportTemplates") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_fact.py b/gooddata-api-client/gooddata_api_client/models/declarative_fact.py new file mode 100644 index 000000000..e6a4cbf10 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_fact.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeFact(BaseModel): + """ + A dataset fact. + """ # noqa: E501 + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Fact description.") + id: Annotated[str, Field(strict=True)] = Field(description="Fact ID.") + is_hidden: Optional[StrictBool] = Field(default=None, description="If true, this fact is hidden from AI search results.", alias="isHidden") + source_column: Annotated[str, Field(strict=True, max_length=255)] = Field(description="A name of the source column in the table.", alias="sourceColumn") + source_column_data_type: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="A type of the source column", alias="sourceColumnDataType") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Fact title.") + __properties: ClassVar[List[str]] = ["description", "id", "isHidden", "sourceColumn", "sourceColumnDataType", "tags", "title"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('source_column_data_type') + def source_column_data_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeFact from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeFact from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "id": obj.get("id"), + "isHidden": obj.get("isHidden"), + "sourceColumn": obj.get("sourceColumn"), + "sourceColumnDataType": obj.get("sourceColumnDataType"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_filter_context.py b/gooddata-api-client/gooddata_api_client/models/declarative_filter_context.py new file mode 100644 index 000000000..bfffe1623 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_filter_context.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeFilterContext(BaseModel): + """ + DeclarativeFilterContext + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(description="Free-form JSON object") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Filter Context description.") + id: Annotated[str, Field(strict=True)] = Field(description="Filter Context ID.") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Filter Context title.") + __properties: ClassVar[List[str]] = ["content", "description", "id", "tags", "title"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeFilterContext from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeFilterContext from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "description": obj.get("description"), + "id": obj.get("id"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_filter_view.py b/gooddata-api-client/gooddata_api_client/models/declarative_filter_view.py new file mode 100644 index 000000000..3d8470927 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_filter_view.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeFilterView(BaseModel): + """ + DeclarativeFilterView + """ # noqa: E501 + analytical_dashboard: Optional[DeclarativeAnalyticalDashboardIdentifier] = Field(default=None, alias="analyticalDashboard") + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON object") + description: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + id: Annotated[str, Field(strict=True)] = Field(description="FilterView object ID.") + is_default: Optional[StrictBool] = Field(default=None, description="Indicator whether the filter view should by applied by default.", alias="isDefault") + tags: Optional[List[StrictStr]] = None + title: Annotated[str, Field(strict=True, max_length=255)] + user: Optional[DeclarativeUserIdentifier] = None + __properties: ClassVar[List[str]] = ["analyticalDashboard", "content", "description", "id", "isDefault", "tags", "title", "user"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeFilterView from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of analytical_dashboard + if self.analytical_dashboard: + _dict['analyticalDashboard'] = self.analytical_dashboard.to_dict() + # override the default output from pydantic by calling `to_dict()` of user + if self.user: + _dict['user'] = self.user.to_dict() + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeFilterView from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticalDashboard": DeclarativeAnalyticalDashboardIdentifier.from_dict(obj["analyticalDashboard"]) if obj.get("analyticalDashboard") is not None else None, + "content": obj.get("content"), + "description": obj.get("description"), + "id": obj.get("id"), + "isDefault": obj.get("isDefault"), + "tags": obj.get("tags"), + "title": obj.get("title"), + "user": DeclarativeUserIdentifier.from_dict(obj["user"]) if obj.get("user") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_identity_provider.py b/gooddata-api-client/gooddata_api_client/models/declarative_identity_provider.py new file mode 100644 index 000000000..2d8ed666e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_identity_provider.py @@ -0,0 +1,133 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeIdentityProvider(BaseModel): + """ + Notification channels. + """ # noqa: E501 + custom_claim_mapping: Optional[Dict[str, Annotated[str, Field(strict=True, max_length=10000)]]] = Field(default=None, description="Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", alias="customClaimMapping") + id: Annotated[str, Field(strict=True)] = Field(description="FilterView object ID.") + identifiers: Optional[List[StrictStr]] = Field(default=None, description="List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.") + idp_type: Optional[StrictStr] = Field(default=None, description="Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", alias="idpType") + oauth_client_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", alias="oauthClientId") + oauth_client_secret: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", alias="oauthClientSecret") + oauth_custom_auth_attributes: Optional[Dict[str, Annotated[str, Field(strict=True, max_length=10000)]]] = Field(default=None, description="Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", alias="oauthCustomAuthAttributes") + oauth_custom_scopes: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", alias="oauthCustomScopes") + oauth_issuer_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", alias="oauthIssuerId") + oauth_issuer_location: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The location of your OIDC provider. This field is mandatory for OIDC IdP.", alias="oauthIssuerLocation") + oauth_subject_id_claim: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", alias="oauthSubjectIdClaim") + saml_metadata: Optional[Annotated[str, Field(strict=True, max_length=15000)]] = Field(default=None, description="Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.", alias="samlMetadata") + __properties: ClassVar[List[str]] = ["customClaimMapping", "id", "identifiers", "idpType", "oauthClientId", "oauthClientSecret", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim", "samlMetadata"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('idp_type') + def idp_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MANAGED_IDP', 'FIM_IDP', 'DEX_IDP', 'CUSTOM_IDP']): + raise ValueError("must be one of enum values ('MANAGED_IDP', 'FIM_IDP', 'DEX_IDP', 'CUSTOM_IDP')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeIdentityProvider from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if oauth_custom_scopes (nullable) is None + # and model_fields_set contains the field + if self.oauth_custom_scopes is None and "oauth_custom_scopes" in self.model_fields_set: + _dict['oauthCustomScopes'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeIdentityProvider from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "customClaimMapping": obj.get("customClaimMapping"), + "id": obj.get("id"), + "identifiers": obj.get("identifiers"), + "idpType": obj.get("idpType"), + "oauthClientId": obj.get("oauthClientId"), + "oauthClientSecret": obj.get("oauthClientSecret"), + "oauthCustomAuthAttributes": obj.get("oauthCustomAuthAttributes"), + "oauthCustomScopes": obj.get("oauthCustomScopes"), + "oauthIssuerId": obj.get("oauthIssuerId"), + "oauthIssuerLocation": obj.get("oauthIssuerLocation"), + "oauthSubjectIdClaim": obj.get("oauthSubjectIdClaim"), + "samlMetadata": obj.get("samlMetadata") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_identity_provider_identifier.py b/gooddata-api-client/gooddata_api_client/models/declarative_identity_provider_identifier.py new file mode 100644 index 000000000..c68677abb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_identity_provider_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeIdentityProviderIdentifier(BaseModel): + """ + An Identity Provider identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Identifier of the identity provider.") + type: StrictStr = Field(description="A type.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['identityProvider']): + raise ValueError("must be one of enum values ('identityProvider')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeIdentityProviderIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeIdentityProviderIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_jwk.py b/gooddata-api-client/gooddata_api_client/models/declarative_jwk.py new file mode 100644 index 000000000..868f48df0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_jwk.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_jwk_specification import DeclarativeJwkSpecification +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeJwk(BaseModel): + """ + A declarative form of the JWK. + """ # noqa: E501 + content: DeclarativeJwkSpecification + id: Annotated[str, Field(strict=True)] = Field(description="JWK object ID.") + __properties: ClassVar[List[str]] = ["content", "id"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeJwk from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of content + if self.content: + _dict['content'] = self.content.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeJwk from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": DeclarativeJwkSpecification.from_dict(obj["content"]) if obj.get("content") is not None else None, + "id": obj.get("id") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_jwk_specification.py b/gooddata-api-client/gooddata_api_client/models/declarative_jwk_specification.py new file mode 100644 index 000000000..5cff5c4bf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_jwk_specification.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.declarative_rsa_specification import DeclarativeRsaSpecification +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +DECLARATIVEJWKSPECIFICATION_ONE_OF_SCHEMAS = ["DeclarativeRsaSpecification"] + +class DeclarativeJwkSpecification(BaseModel): + """ + Declarative specification of the cryptographic key. + """ + # data type: DeclarativeRsaSpecification + oneof_schema_1_validator: Optional[DeclarativeRsaSpecification] = None + actual_instance: Optional[Union[DeclarativeRsaSpecification]] = None + one_of_schemas: Set[str] = { "DeclarativeRsaSpecification" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = DeclarativeJwkSpecification.model_construct() + error_messages = [] + match = 0 + # validate data type: DeclarativeRsaSpecification + if not isinstance(v, DeclarativeRsaSpecification): + error_messages.append(f"Error! Input type `{type(v)}` is not `DeclarativeRsaSpecification`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in DeclarativeJwkSpecification with oneOf schemas: DeclarativeRsaSpecification. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in DeclarativeJwkSpecification with oneOf schemas: DeclarativeRsaSpecification. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into DeclarativeRsaSpecification + try: + instance.actual_instance = DeclarativeRsaSpecification.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into DeclarativeJwkSpecification with oneOf schemas: DeclarativeRsaSpecification. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into DeclarativeJwkSpecification with oneOf schemas: DeclarativeRsaSpecification. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], DeclarativeRsaSpecification]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_label.py b/gooddata-api-client/gooddata_api_client/models/declarative_label.py new file mode 100644 index 000000000..a0182ab72 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_label.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeLabel(BaseModel): + """ + A attribute label. + """ # noqa: E501 + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Label description.") + id: Annotated[str, Field(strict=True)] = Field(description="Label ID.") + is_hidden: Optional[StrictBool] = Field(default=None, description="Determines if the label is hidden from AI features.", alias="isHidden") + source_column: Annotated[str, Field(strict=True, max_length=255)] = Field(description="A name of the source column in the table.", alias="sourceColumn") + source_column_data_type: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="A type of the source column", alias="sourceColumnDataType") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Label title.") + value_type: Optional[StrictStr] = Field(default=None, description="Specific type of label", alias="valueType") + __properties: ClassVar[List[str]] = ["description", "id", "isHidden", "sourceColumn", "sourceColumnDataType", "tags", "title", "valueType"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('source_column_data_type') + def source_column_data_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + @field_validator('value_type') + def value_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TEXT', 'HYPERLINK', 'GEO', 'GEO_LONGITUDE', 'GEO_LATITUDE', 'IMAGE']): + raise ValueError("must be one of enum values ('TEXT', 'HYPERLINK', 'GEO', 'GEO_LONGITUDE', 'GEO_LATITUDE', 'IMAGE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeLabel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeLabel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "id": obj.get("id"), + "isHidden": obj.get("isHidden"), + "sourceColumn": obj.get("sourceColumn"), + "sourceColumnDataType": obj.get("sourceColumnDataType"), + "tags": obj.get("tags"), + "title": obj.get("title"), + "valueType": obj.get("valueType") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_ldm.py b/gooddata-api-client/gooddata_api_client/models/declarative_ldm.py new file mode 100644 index 000000000..309d8a323 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_ldm.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_dataset import DeclarativeDataset +from gooddata_api_client.models.declarative_dataset_extension import DeclarativeDatasetExtension +from gooddata_api_client.models.declarative_date_dataset import DeclarativeDateDataset +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeLdm(BaseModel): + """ + A logical data model (LDM) representation. + """ # noqa: E501 + dataset_extensions: Optional[List[DeclarativeDatasetExtension]] = Field(default=None, description="An array containing extensions for datasets defined in parent workspaces.", alias="datasetExtensions") + datasets: Optional[List[DeclarativeDataset]] = Field(default=None, description="An array containing datasets.") + date_instances: Optional[List[DeclarativeDateDataset]] = Field(default=None, description="An array containing date-related datasets.", alias="dateInstances") + __properties: ClassVar[List[str]] = ["datasetExtensions", "datasets", "dateInstances"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeLdm from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dataset_extensions (list) + _items = [] + if self.dataset_extensions: + for _item_dataset_extensions in self.dataset_extensions: + if _item_dataset_extensions: + _items.append(_item_dataset_extensions.to_dict()) + _dict['datasetExtensions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in datasets (list) + _items = [] + if self.datasets: + for _item_datasets in self.datasets: + if _item_datasets: + _items.append(_item_datasets.to_dict()) + _dict['datasets'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in date_instances (list) + _items = [] + if self.date_instances: + for _item_date_instances in self.date_instances: + if _item_date_instances: + _items.append(_item_date_instances.to_dict()) + _dict['dateInstances'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeLdm from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "datasetExtensions": [DeclarativeDatasetExtension.from_dict(_item) for _item in obj["datasetExtensions"]] if obj.get("datasetExtensions") is not None else None, + "datasets": [DeclarativeDataset.from_dict(_item) for _item in obj["datasets"]] if obj.get("datasets") is not None else None, + "dateInstances": [DeclarativeDateDataset.from_dict(_item) for _item in obj["dateInstances"]] if obj.get("dateInstances") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_metric.py b/gooddata-api-client/gooddata_api_client/models/declarative_metric.py new file mode 100644 index 000000000..6f1b80b17 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_metric.py @@ -0,0 +1,154 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeMetric(BaseModel): + """ + DeclarativeMetric + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(description="Free-form JSON object") + created_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the entity creation.", alias="createdAt") + created_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="createdBy") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Metric description.") + id: Annotated[str, Field(strict=True)] = Field(description="Metric ID.") + modified_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the last entity modification.", alias="modifiedAt") + modified_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="modifiedBy") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Metric title.") + __properties: ClassVar[List[str]] = ["content", "createdAt", "createdBy", "description", "id", "modifiedAt", "modifiedBy", "tags", "title"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('modified_at') + def modified_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeMetric from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + # set to None if modified_at (nullable) is None + # and model_fields_set contains the field + if self.modified_at is None and "modified_at" in self.model_fields_set: + _dict['modifiedAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeMetric from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "createdAt": obj.get("createdAt"), + "createdBy": DeclarativeUserIdentifier.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "description": obj.get("description"), + "id": obj.get("id"), + "modifiedAt": obj.get("modifiedAt"), + "modifiedBy": DeclarativeUserIdentifier.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_model.py b/gooddata-api-client/gooddata_api_client/models/declarative_model.py new file mode 100644 index 000000000..38cfe93e9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_model.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_ldm import DeclarativeLdm +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeModel(BaseModel): + """ + A data model structured as a set of its attributes. + """ # noqa: E501 + ldm: Optional[DeclarativeLdm] = None + __properties: ClassVar[List[str]] = ["ldm"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeModel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of ldm + if self.ldm: + _dict['ldm'] = self.ldm.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeModel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "ldm": DeclarativeLdm.from_dict(obj["ldm"]) if obj.get("ldm") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_notification_channel.py b/gooddata-api-client/gooddata_api_client/models/declarative_notification_channel.py new file mode 100644 index 000000000..1eace888d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_notification_channel.py @@ -0,0 +1,165 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_notification_channel_destination import DeclarativeNotificationChannelDestination +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeNotificationChannel(BaseModel): + """ + A declarative form of a particular notification channel. + """ # noqa: E501 + allowed_recipients: Optional[StrictStr] = Field(default='INTERNAL', description="Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization ", alias="allowedRecipients") + custom_dashboard_url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} ", alias="customDashboardUrl") + dashboard_link_visibility: Optional[StrictStr] = Field(default='INTERNAL_ONLY', description="Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link ", alias="dashboardLinkVisibility") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Description of a notification channel.") + destination: Optional[DeclarativeNotificationChannelDestination] = None + destination_type: Optional[StrictStr] = Field(default=None, alias="destinationType") + id: Annotated[str, Field(strict=True)] = Field(description="Identifier of a notification channel") + in_platform_notification: Optional[StrictStr] = Field(default='DISABLED', description="In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications ", alias="inPlatformNotification") + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Name of a notification channel.") + notification_source: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} ", alias="notificationSource") + __properties: ClassVar[List[str]] = ["allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "destinationType", "id", "inPlatformNotification", "name", "notificationSource"] + + @field_validator('allowed_recipients') + def allowed_recipients_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['CREATOR', 'INTERNAL', 'EXTERNAL']): + raise ValueError("must be one of enum values ('CREATOR', 'INTERNAL', 'EXTERNAL')") + return value + + @field_validator('dashboard_link_visibility') + def dashboard_link_visibility_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['HIDDEN', 'INTERNAL_ONLY', 'ALL']): + raise ValueError("must be one of enum values ('HIDDEN', 'INTERNAL_ONLY', 'ALL')") + return value + + @field_validator('destination_type') + def destination_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['WEBHOOK', 'SMTP', 'DEFAULT_SMTP', 'IN_PLATFORM']): + raise ValueError("must be one of enum values ('WEBHOOK', 'SMTP', 'DEFAULT_SMTP', 'IN_PLATFORM')") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('in_platform_notification') + def in_platform_notification_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['DISABLED', 'ENABLED']): + raise ValueError("must be one of enum values ('DISABLED', 'ENABLED')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeNotificationChannel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "destination_type", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of destination + if self.destination: + _dict['destination'] = self.destination.to_dict() + # set to None if destination_type (nullable) is None + # and model_fields_set contains the field + if self.destination_type is None and "destination_type" in self.model_fields_set: + _dict['destinationType'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeNotificationChannel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "allowedRecipients": obj.get("allowedRecipients") if obj.get("allowedRecipients") is not None else 'INTERNAL', + "customDashboardUrl": obj.get("customDashboardUrl"), + "dashboardLinkVisibility": obj.get("dashboardLinkVisibility") if obj.get("dashboardLinkVisibility") is not None else 'INTERNAL_ONLY', + "description": obj.get("description"), + "destination": DeclarativeNotificationChannelDestination.from_dict(obj["destination"]) if obj.get("destination") is not None else None, + "destinationType": obj.get("destinationType"), + "id": obj.get("id"), + "inPlatformNotification": obj.get("inPlatformNotification") if obj.get("inPlatformNotification") is not None else 'DISABLED', + "name": obj.get("name"), + "notificationSource": obj.get("notificationSource") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_notification_channel_destination.py b/gooddata-api-client/gooddata_api_client/models/declarative_notification_channel_destination.py new file mode 100644 index 000000000..14afc59c7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_notification_channel_destination.py @@ -0,0 +1,166 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.default_smtp import DefaultSmtp +from gooddata_api_client.models.in_platform import InPlatform +from gooddata_api_client.models.smtp import Smtp +from gooddata_api_client.models.webhook import Webhook +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +DECLARATIVENOTIFICATIONCHANNELDESTINATION_ONE_OF_SCHEMAS = ["DefaultSmtp", "InPlatform", "Smtp", "Webhook"] + +class DeclarativeNotificationChannelDestination(BaseModel): + """ + DeclarativeNotificationChannelDestination + """ + # data type: DefaultSmtp + oneof_schema_1_validator: Optional[DefaultSmtp] = None + # data type: InPlatform + oneof_schema_2_validator: Optional[InPlatform] = None + # data type: Smtp + oneof_schema_3_validator: Optional[Smtp] = None + # data type: Webhook + oneof_schema_4_validator: Optional[Webhook] = None + actual_instance: Optional[Union[DefaultSmtp, InPlatform, Smtp, Webhook]] = None + one_of_schemas: Set[str] = { "DefaultSmtp", "InPlatform", "Smtp", "Webhook" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = DeclarativeNotificationChannelDestination.model_construct() + error_messages = [] + match = 0 + # validate data type: DefaultSmtp + if not isinstance(v, DefaultSmtp): + error_messages.append(f"Error! Input type `{type(v)}` is not `DefaultSmtp`") + else: + match += 1 + # validate data type: InPlatform + if not isinstance(v, InPlatform): + error_messages.append(f"Error! Input type `{type(v)}` is not `InPlatform`") + else: + match += 1 + # validate data type: Smtp + if not isinstance(v, Smtp): + error_messages.append(f"Error! Input type `{type(v)}` is not `Smtp`") + else: + match += 1 + # validate data type: Webhook + if not isinstance(v, Webhook): + error_messages.append(f"Error! Input type `{type(v)}` is not `Webhook`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in DeclarativeNotificationChannelDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in DeclarativeNotificationChannelDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into DefaultSmtp + try: + instance.actual_instance = DefaultSmtp.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into InPlatform + try: + instance.actual_instance = InPlatform.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into Smtp + try: + instance.actual_instance = Smtp.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into Webhook + try: + instance.actual_instance = Webhook.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into DeclarativeNotificationChannelDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into DeclarativeNotificationChannelDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], DefaultSmtp, InPlatform, Smtp, Webhook]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_notification_channel_identifier.py b/gooddata-api-client/gooddata_api_client/models/declarative_notification_channel_identifier.py new file mode 100644 index 000000000..bad9a2fe2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_notification_channel_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeNotificationChannelIdentifier(BaseModel): + """ + A notification channel identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Notification channel identifier.") + type: StrictStr = Field(description="A type.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['notificationChannel']): + raise ValueError("must be one of enum values ('notificationChannel')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeNotificationChannelIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeNotificationChannelIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_notification_channels.py b/gooddata-api-client/gooddata_api_client/models/declarative_notification_channels.py new file mode 100644 index 000000000..1c152464f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_notification_channels.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.declarative_notification_channel import DeclarativeNotificationChannel +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeNotificationChannels(BaseModel): + """ + Notification channels. + """ # noqa: E501 + notification_channels: List[DeclarativeNotificationChannel] = Field(alias="notificationChannels") + __properties: ClassVar[List[str]] = ["notificationChannels"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeNotificationChannels from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in notification_channels (list) + _items = [] + if self.notification_channels: + for _item_notification_channels in self.notification_channels: + if _item_notification_channels: + _items.append(_item_notification_channels.to_dict()) + _dict['notificationChannels'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeNotificationChannels from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "notificationChannels": [DeclarativeNotificationChannel.from_dict(_item) for _item in obj["notificationChannels"]] if obj.get("notificationChannels") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_organization.py b/gooddata-api-client/gooddata_api_client/models/declarative_organization.py new file mode 100644 index 000000000..72ed44754 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_organization.py @@ -0,0 +1,182 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_data_source import DeclarativeDataSource +from gooddata_api_client.models.declarative_export_template import DeclarativeExportTemplate +from gooddata_api_client.models.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.models.declarative_jwk import DeclarativeJwk +from gooddata_api_client.models.declarative_notification_channel import DeclarativeNotificationChannel +from gooddata_api_client.models.declarative_organization_info import DeclarativeOrganizationInfo +from gooddata_api_client.models.declarative_user import DeclarativeUser +from gooddata_api_client.models.declarative_user_group import DeclarativeUserGroup +from gooddata_api_client.models.declarative_workspace import DeclarativeWorkspace +from gooddata_api_client.models.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeOrganization(BaseModel): + """ + Complete definition of an organization in a declarative form. + """ # noqa: E501 + data_sources: Optional[List[DeclarativeDataSource]] = Field(default=None, alias="dataSources") + export_templates: Optional[List[DeclarativeExportTemplate]] = Field(default=None, alias="exportTemplates") + identity_providers: Optional[List[DeclarativeIdentityProvider]] = Field(default=None, alias="identityProviders") + jwks: Optional[List[DeclarativeJwk]] = None + notification_channels: Optional[List[DeclarativeNotificationChannel]] = Field(default=None, alias="notificationChannels") + organization: DeclarativeOrganizationInfo + user_groups: Optional[List[DeclarativeUserGroup]] = Field(default=None, alias="userGroups") + users: Optional[List[DeclarativeUser]] = None + workspace_data_filters: Optional[List[DeclarativeWorkspaceDataFilter]] = Field(default=None, alias="workspaceDataFilters") + workspaces: Optional[List[DeclarativeWorkspace]] = None + __properties: ClassVar[List[str]] = ["dataSources", "exportTemplates", "identityProviders", "jwks", "notificationChannels", "organization", "userGroups", "users", "workspaceDataFilters", "workspaces"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeOrganization from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_sources (list) + _items = [] + if self.data_sources: + for _item_data_sources in self.data_sources: + if _item_data_sources: + _items.append(_item_data_sources.to_dict()) + _dict['dataSources'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in export_templates (list) + _items = [] + if self.export_templates: + for _item_export_templates in self.export_templates: + if _item_export_templates: + _items.append(_item_export_templates.to_dict()) + _dict['exportTemplates'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in identity_providers (list) + _items = [] + if self.identity_providers: + for _item_identity_providers in self.identity_providers: + if _item_identity_providers: + _items.append(_item_identity_providers.to_dict()) + _dict['identityProviders'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in jwks (list) + _items = [] + if self.jwks: + for _item_jwks in self.jwks: + if _item_jwks: + _items.append(_item_jwks.to_dict()) + _dict['jwks'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in notification_channels (list) + _items = [] + if self.notification_channels: + for _item_notification_channels in self.notification_channels: + if _item_notification_channels: + _items.append(_item_notification_channels.to_dict()) + _dict['notificationChannels'] = _items + # override the default output from pydantic by calling `to_dict()` of organization + if self.organization: + _dict['organization'] = self.organization.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in workspace_data_filters (list) + _items = [] + if self.workspace_data_filters: + for _item_workspace_data_filters in self.workspace_data_filters: + if _item_workspace_data_filters: + _items.append(_item_workspace_data_filters.to_dict()) + _dict['workspaceDataFilters'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in workspaces (list) + _items = [] + if self.workspaces: + for _item_workspaces in self.workspaces: + if _item_workspaces: + _items.append(_item_workspaces.to_dict()) + _dict['workspaces'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeOrganization from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataSources": [DeclarativeDataSource.from_dict(_item) for _item in obj["dataSources"]] if obj.get("dataSources") is not None else None, + "exportTemplates": [DeclarativeExportTemplate.from_dict(_item) for _item in obj["exportTemplates"]] if obj.get("exportTemplates") is not None else None, + "identityProviders": [DeclarativeIdentityProvider.from_dict(_item) for _item in obj["identityProviders"]] if obj.get("identityProviders") is not None else None, + "jwks": [DeclarativeJwk.from_dict(_item) for _item in obj["jwks"]] if obj.get("jwks") is not None else None, + "notificationChannels": [DeclarativeNotificationChannel.from_dict(_item) for _item in obj["notificationChannels"]] if obj.get("notificationChannels") is not None else None, + "organization": DeclarativeOrganizationInfo.from_dict(obj["organization"]) if obj.get("organization") is not None else None, + "userGroups": [DeclarativeUserGroup.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None, + "users": [DeclarativeUser.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None, + "workspaceDataFilters": [DeclarativeWorkspaceDataFilter.from_dict(_item) for _item in obj["workspaceDataFilters"]] if obj.get("workspaceDataFilters") is not None else None, + "workspaces": [DeclarativeWorkspace.from_dict(_item) for _item in obj["workspaces"]] if obj.get("workspaces") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_organization_info.py b/gooddata-api-client/gooddata_api_client/models/declarative_organization_info.py new file mode 100644 index 000000000..1092191b5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_organization_info.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_color_palette import DeclarativeColorPalette +from gooddata_api_client.models.declarative_csp_directive import DeclarativeCspDirective +from gooddata_api_client.models.declarative_identity_provider_identifier import DeclarativeIdentityProviderIdentifier +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.models.declarative_setting import DeclarativeSetting +from gooddata_api_client.models.declarative_theme import DeclarativeTheme +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeOrganizationInfo(BaseModel): + """ + Information available about an organization. + """ # noqa: E501 + allowed_origins: Optional[List[StrictStr]] = Field(default=None, alias="allowedOrigins") + color_palettes: Optional[List[DeclarativeColorPalette]] = Field(default=None, description="A list of color palettes.", alias="colorPalettes") + csp_directives: Optional[List[DeclarativeCspDirective]] = Field(default=None, description="A list of CSP directives.", alias="cspDirectives") + early_access: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Early access defined on level Organization", alias="earlyAccess") + early_access_values: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="Early access defined on level Organization", alias="earlyAccessValues") + hostname: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Formal hostname used in deployment.") + id: Annotated[str, Field(strict=True)] = Field(description="Identifier of the organization.") + identity_provider: Optional[DeclarativeIdentityProviderIdentifier] = Field(default=None, alias="identityProvider") + name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Formal name of the organization.") + oauth_client_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Identifier of the authentication provider", alias="oauthClientId") + oauth_client_secret: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Communication secret of the authentication provider (never returned back).", alias="oauthClientSecret") + oauth_custom_auth_attributes: Optional[Dict[str, Annotated[str, Field(strict=True, max_length=10000)]]] = Field(default=None, description="Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", alias="oauthCustomAuthAttributes") + oauth_custom_scopes: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", alias="oauthCustomScopes") + oauth_issuer_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", alias="oauthIssuerId") + oauth_issuer_location: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="URI of the authentication provider.", alias="oauthIssuerLocation") + oauth_subject_id_claim: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", alias="oauthSubjectIdClaim") + permissions: List[DeclarativeOrganizationPermission] + settings: Optional[List[DeclarativeSetting]] = Field(default=None, description="A list of organization settings.") + themes: Optional[List[DeclarativeTheme]] = Field(default=None, description="A list of themes.") + __properties: ClassVar[List[str]] = ["allowedOrigins", "colorPalettes", "cspDirectives", "earlyAccess", "earlyAccessValues", "hostname", "id", "identityProvider", "name", "oauthClientId", "oauthClientSecret", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim", "permissions", "settings", "themes"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeOrganizationInfo from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in color_palettes (list) + _items = [] + if self.color_palettes: + for _item_color_palettes in self.color_palettes: + if _item_color_palettes: + _items.append(_item_color_palettes.to_dict()) + _dict['colorPalettes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in csp_directives (list) + _items = [] + if self.csp_directives: + for _item_csp_directives in self.csp_directives: + if _item_csp_directives: + _items.append(_item_csp_directives.to_dict()) + _dict['cspDirectives'] = _items + # override the default output from pydantic by calling `to_dict()` of identity_provider + if self.identity_provider: + _dict['identityProvider'] = self.identity_provider.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in settings (list) + _items = [] + if self.settings: + for _item_settings in self.settings: + if _item_settings: + _items.append(_item_settings.to_dict()) + _dict['settings'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in themes (list) + _items = [] + if self.themes: + for _item_themes in self.themes: + if _item_themes: + _items.append(_item_themes.to_dict()) + _dict['themes'] = _items + # set to None if oauth_custom_scopes (nullable) is None + # and model_fields_set contains the field + if self.oauth_custom_scopes is None and "oauth_custom_scopes" in self.model_fields_set: + _dict['oauthCustomScopes'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeOrganizationInfo from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "allowedOrigins": obj.get("allowedOrigins"), + "colorPalettes": [DeclarativeColorPalette.from_dict(_item) for _item in obj["colorPalettes"]] if obj.get("colorPalettes") is not None else None, + "cspDirectives": [DeclarativeCspDirective.from_dict(_item) for _item in obj["cspDirectives"]] if obj.get("cspDirectives") is not None else None, + "earlyAccess": obj.get("earlyAccess"), + "earlyAccessValues": obj.get("earlyAccessValues"), + "hostname": obj.get("hostname"), + "id": obj.get("id"), + "identityProvider": DeclarativeIdentityProviderIdentifier.from_dict(obj["identityProvider"]) if obj.get("identityProvider") is not None else None, + "name": obj.get("name"), + "oauthClientId": obj.get("oauthClientId"), + "oauthClientSecret": obj.get("oauthClientSecret"), + "oauthCustomAuthAttributes": obj.get("oauthCustomAuthAttributes"), + "oauthCustomScopes": obj.get("oauthCustomScopes"), + "oauthIssuerId": obj.get("oauthIssuerId"), + "oauthIssuerLocation": obj.get("oauthIssuerLocation"), + "oauthSubjectIdClaim": obj.get("oauthSubjectIdClaim"), + "permissions": [DeclarativeOrganizationPermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None, + "settings": [DeclarativeSetting.from_dict(_item) for _item in obj["settings"]] if obj.get("settings") is not None else None, + "themes": [DeclarativeTheme.from_dict(_item) for _item in obj["themes"]] if obj.get("themes") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_organization_permission.py b/gooddata-api-client/gooddata_api_client/models/declarative_organization_permission.py new file mode 100644 index 000000000..91e7a2735 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_organization_permission.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeOrganizationPermission(BaseModel): + """ + Definition of an organization permission assigned to a user/user-group. + """ # noqa: E501 + assignee: AssigneeIdentifier + name: StrictStr = Field(description="Permission name.") + __properties: ClassVar[List[str]] = ["assignee", "name"] + + @field_validator('name') + def name_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['MANAGE', 'SELF_CREATE_TOKEN']): + raise ValueError("must be one of enum values ('MANAGE', 'SELF_CREATE_TOKEN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeOrganizationPermission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee + if self.assignee: + _dict['assignee'] = self.assignee.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeOrganizationPermission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assignee": AssigneeIdentifier.from_dict(obj["assignee"]) if obj.get("assignee") is not None else None, + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_reference.py b/gooddata-api-client/gooddata_api_client/models/declarative_reference.py new file mode 100644 index 000000000..66eb4bf2f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_reference.py @@ -0,0 +1,119 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_reference_source import DeclarativeReferenceSource +from gooddata_api_client.models.reference_identifier import ReferenceIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeReference(BaseModel): + """ + A dataset reference. + """ # noqa: E501 + identifier: ReferenceIdentifier + multivalue: StrictBool = Field(description="The multi-value flag enables many-to-many cardinality for references.") + source_column_data_types: Optional[List[StrictStr]] = Field(default=None, description="An array of source column data types for a given reference. Deprecated, use 'sources' instead.", alias="sourceColumnDataTypes") + source_columns: Optional[List[StrictStr]] = Field(default=None, description="An array of source column names for a given reference. Deprecated, use 'sources' instead.", alias="sourceColumns") + sources: Optional[List[DeclarativeReferenceSource]] = Field(default=None, description="An array of source columns for a given reference.") + __properties: ClassVar[List[str]] = ["identifier", "multivalue", "sourceColumnDataTypes", "sourceColumns", "sources"] + + @field_validator('source_column_data_types') + def source_column_data_types_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("each list item must be one of ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeReference from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of identifier + if self.identifier: + _dict['identifier'] = self.identifier.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in sources (list) + _items = [] + if self.sources: + for _item_sources in self.sources: + if _item_sources: + _items.append(_item_sources.to_dict()) + _dict['sources'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeReference from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "identifier": ReferenceIdentifier.from_dict(obj["identifier"]) if obj.get("identifier") is not None else None, + "multivalue": obj.get("multivalue"), + "sourceColumnDataTypes": obj.get("sourceColumnDataTypes"), + "sourceColumns": obj.get("sourceColumns"), + "sources": [DeclarativeReferenceSource.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_reference_source.py b/gooddata-api-client/gooddata_api_client/models/declarative_reference_source.py new file mode 100644 index 000000000..88d5e94dd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_reference_source.py @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.grain_identifier import GrainIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeReferenceSource(BaseModel): + """ + A dataset reference source column description. + """ # noqa: E501 + column: Annotated[str, Field(strict=True, max_length=255)] = Field(description="A name of the source column in the table.") + data_type: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="A type of the source column.", alias="dataType") + target: GrainIdentifier + __properties: ClassVar[List[str]] = ["column", "dataType", "target"] + + @field_validator('data_type') + def data_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeReferenceSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of target + if self.target: + _dict['target'] = self.target.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeReferenceSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "column": obj.get("column"), + "dataType": obj.get("dataType"), + "target": GrainIdentifier.from_dict(obj["target"]) if obj.get("target") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_rsa_specification.py b/gooddata-api-client/gooddata_api_client/models/declarative_rsa_specification.py new file mode 100644 index 000000000..cd50d53be --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_rsa_specification.py @@ -0,0 +1,131 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeRsaSpecification(BaseModel): + """ + Declarative specification of the cryptographic key. + """ # noqa: E501 + alg: StrictStr = Field(description="Algorithm intended for use with the key.") + e: StrictStr = Field(description="parameter contains the exponent value for the RSA public key.") + kid: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Parameter is used to match a specific key.") + kty: StrictStr = Field(description="Key type parameter") + n: StrictStr = Field(description="Parameter contains the modulus value for the RSA public key.") + use: StrictStr = Field(description="Parameter identifies the intended use of the public key.") + x5c: Optional[List[StrictStr]] = Field(default=None, description="Parameter contains a chain of one or more PKIX certificates.") + x5t: Optional[StrictStr] = Field(default=None, description="Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate.") + __properties: ClassVar[List[str]] = ["alg", "e", "kid", "kty", "n", "use", "x5c", "x5t"] + + @field_validator('alg') + def alg_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['RS256', 'RS384', 'RS512']): + raise ValueError("must be one of enum values ('RS256', 'RS384', 'RS512')") + return value + + @field_validator('kid') + def kid_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[^.]", value): + raise ValueError(r"must validate the regular expression /^[^.]/") + return value + + @field_validator('kty') + def kty_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['RSA']): + raise ValueError("must be one of enum values ('RSA')") + return value + + @field_validator('use') + def use_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['sig']): + raise ValueError("must be one of enum values ('sig')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeRsaSpecification from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeRsaSpecification from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "alg": obj.get("alg"), + "e": obj.get("e"), + "kid": obj.get("kid"), + "kty": obj.get("kty"), + "n": obj.get("n"), + "use": obj.get("use"), + "x5c": obj.get("x5c"), + "x5t": obj.get("x5t") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_setting.py b/gooddata-api-client/gooddata_api_client/models/declarative_setting.py new file mode 100644 index 000000000..9811a7371 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_setting.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeSetting(BaseModel): + """ + Setting and its value. + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON object") + id: Annotated[str, Field(strict=True)] = Field(description="Setting ID.") + type: Optional[StrictStr] = Field(default=None, description="Type of the setting.") + __properties: ClassVar[List[str]] = ["content", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TIMEZONE', 'ACTIVE_THEME', 'ACTIVE_COLOR_PALETTE', 'ACTIVE_LLM_ENDPOINT', 'WHITE_LABELING', 'LOCALE', 'METADATA_LOCALE', 'FORMAT_LOCALE', 'MAPBOX_TOKEN', 'AG_GRID_TOKEN', 'WEEK_START', 'SHOW_HIDDEN_CATALOG_ITEMS', 'OPERATOR_OVERRIDES', 'TIMEZONE_VALIDATION_ENABLED', 'OPENAI_CONFIG', 'ENABLE_FILE_ANALYTICS', 'ALERT', 'SEPARATORS', 'DATE_FILTER_CONFIG', 'JIT_PROVISIONING', 'JWT_JIT_PROVISIONING', 'DASHBOARD_FILTERS_APPLY_MODE', 'ENABLE_SLIDES_EXPORT', 'AI_RATE_LIMIT', 'ATTACHMENT_SIZE_LIMIT', 'ATTACHMENT_LINK_TTL', 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE', 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS', 'ENABLE_AUTOMATION_EVALUATION_MODE', 'REGISTERED_PLUGGABLE_APPLICATIONS']): + raise ValueError("must be one of enum values ('TIMEZONE', 'ACTIVE_THEME', 'ACTIVE_COLOR_PALETTE', 'ACTIVE_LLM_ENDPOINT', 'WHITE_LABELING', 'LOCALE', 'METADATA_LOCALE', 'FORMAT_LOCALE', 'MAPBOX_TOKEN', 'AG_GRID_TOKEN', 'WEEK_START', 'SHOW_HIDDEN_CATALOG_ITEMS', 'OPERATOR_OVERRIDES', 'TIMEZONE_VALIDATION_ENABLED', 'OPENAI_CONFIG', 'ENABLE_FILE_ANALYTICS', 'ALERT', 'SEPARATORS', 'DATE_FILTER_CONFIG', 'JIT_PROVISIONING', 'JWT_JIT_PROVISIONING', 'DASHBOARD_FILTERS_APPLY_MODE', 'ENABLE_SLIDES_EXPORT', 'AI_RATE_LIMIT', 'ATTACHMENT_SIZE_LIMIT', 'ATTACHMENT_LINK_TTL', 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE', 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS', 'ENABLE_AUTOMATION_EVALUATION_MODE', 'REGISTERED_PLUGGABLE_APPLICATIONS')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeSetting from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeSetting from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_single_workspace_permission.py b/gooddata-api-client/gooddata_api_client/models/declarative_single_workspace_permission.py new file mode 100644 index 000000000..7d0ebbc92 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_single_workspace_permission.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeSingleWorkspacePermission(BaseModel): + """ + DeclarativeSingleWorkspacePermission + """ # noqa: E501 + assignee: AssigneeIdentifier + name: StrictStr = Field(description="Permission name.") + __properties: ClassVar[List[str]] = ["assignee", "name"] + + @field_validator('name') + def name_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW']): + raise ValueError("must be one of enum values ('MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeSingleWorkspacePermission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee + if self.assignee: + _dict['assignee'] = self.assignee.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeSingleWorkspacePermission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assignee": AssigneeIdentifier.from_dict(obj["assignee"]) if obj.get("assignee") is not None else None, + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_source_fact_reference.py b/gooddata-api-client/gooddata_api_client/models/declarative_source_fact_reference.py new file mode 100644 index 000000000..ab8cf0a4b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_source_fact_reference.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.fact_identifier import FactIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeSourceFactReference(BaseModel): + """ + Aggregated awareness source fact reference. + """ # noqa: E501 + operation: StrictStr = Field(description="Aggregation operation.") + reference: FactIdentifier + __properties: ClassVar[List[str]] = ["operation", "reference"] + + @field_validator('operation') + def operation_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['SUM', 'MIN', 'MAX']): + raise ValueError("must be one of enum values ('SUM', 'MIN', 'MAX')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeSourceFactReference from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of reference + if self.reference: + _dict['reference'] = self.reference.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeSourceFactReference from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "operation": obj.get("operation"), + "reference": FactIdentifier.from_dict(obj["reference"]) if obj.get("reference") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_table.py b/gooddata-api-client/gooddata_api_client/models/declarative_table.py new file mode 100644 index 000000000..aa9f534ca --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_table.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_column import DeclarativeColumn +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeTable(BaseModel): + """ + A database table. + """ # noqa: E501 + columns: List[DeclarativeColumn] = Field(description="An array of physical columns") + id: Annotated[str, Field(strict=True)] = Field(description="Table id.") + name_prefix: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Table or view name prefix used in scan. Will be stripped when generating LDM.", alias="namePrefix") + path: List[StrictStr] = Field(description="Path to table.") + type: StrictStr = Field(description="Table type: TABLE or VIEW.") + __properties: ClassVar[List[str]] = ["columns", "id", "namePrefix", "path", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeTable from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in columns (list) + _items = [] + if self.columns: + for _item_columns in self.columns: + if _item_columns: + _items.append(_item_columns.to_dict()) + _dict['columns'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeTable from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columns": [DeclarativeColumn.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None, + "id": obj.get("id"), + "namePrefix": obj.get("namePrefix"), + "path": obj.get("path"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_tables.py b/gooddata-api-client/gooddata_api_client/models/declarative_tables.py new file mode 100644 index 000000000..793faa248 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_tables.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.declarative_table import DeclarativeTable +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeTables(BaseModel): + """ + A physical data model (PDM) tables. + """ # noqa: E501 + tables: List[DeclarativeTable] = Field(description="An array of physical database tables.") + __properties: ClassVar[List[str]] = ["tables"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeTables from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tables (list) + _items = [] + if self.tables: + for _item_tables in self.tables: + if _item_tables: + _items.append(_item_tables.to_dict()) + _dict['tables'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeTables from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tables": [DeclarativeTable.from_dict(_item) for _item in obj["tables"]] if obj.get("tables") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_theme.py b/gooddata-api-client/gooddata_api_client/models/declarative_theme.py new file mode 100644 index 000000000..a47b1c6c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_theme.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeTheme(BaseModel): + """ + Theme and its properties. + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(description="Free-form JSON object") + id: StrictStr + name: Annotated[str, Field(strict=True, max_length=255)] + __properties: ClassVar[List[str]] = ["content", "id", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeTheme from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeTheme from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "id": obj.get("id"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_user.py b/gooddata-api-client/gooddata_api_client/models/declarative_user.py new file mode 100644 index 000000000..8143525e1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_user.py @@ -0,0 +1,134 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_setting import DeclarativeSetting +from gooddata_api_client.models.declarative_user_group_identifier import DeclarativeUserGroupIdentifier +from gooddata_api_client.models.declarative_user_permission import DeclarativeUserPermission +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUser(BaseModel): + """ + A user and its properties + """ # noqa: E501 + auth_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="User identification in the authentication manager.", alias="authId") + email: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="User email address") + firstname: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="User first name") + id: Annotated[str, Field(strict=True)] = Field(description="User identifier.") + lastname: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="User last name") + permissions: Optional[List[DeclarativeUserPermission]] = None + settings: Optional[List[DeclarativeSetting]] = Field(default=None, description="A list of user settings.") + user_groups: Optional[List[DeclarativeUserGroupIdentifier]] = Field(default=None, alias="userGroups") + __properties: ClassVar[List[str]] = ["authId", "email", "firstname", "id", "lastname", "permissions", "settings", "userGroups"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUser from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in settings (list) + _items = [] + if self.settings: + for _item_settings in self.settings: + if _item_settings: + _items.append(_item_settings.to_dict()) + _dict['settings'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUser from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "authId": obj.get("authId"), + "email": obj.get("email"), + "firstname": obj.get("firstname"), + "id": obj.get("id"), + "lastname": obj.get("lastname"), + "permissions": [DeclarativeUserPermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None, + "settings": [DeclarativeSetting.from_dict(_item) for _item in obj["settings"]] if obj.get("settings") is not None else None, + "userGroups": [DeclarativeUserGroupIdentifier.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_user_data_filter.py b/gooddata-api-client/gooddata_api_client/models/declarative_user_data_filter.py new file mode 100644 index 000000000..2b55138a6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_user_data_filter.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_user_group_identifier import DeclarativeUserGroupIdentifier +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUserDataFilter(BaseModel): + """ + User Data Filters serving the filtering of what data users can see in workspaces. + """ # noqa: E501 + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="User Data Filters setting description.") + id: Annotated[str, Field(strict=True)] = Field(description="User Data Filters ID. This ID is further used to refer to this instance.") + maql: Annotated[str, Field(strict=True, max_length=10000)] = Field(description="Expression in MAQL specifying the User Data Filter") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="User Data Filters setting title.") + user: Optional[DeclarativeUserIdentifier] = None + user_group: Optional[DeclarativeUserGroupIdentifier] = Field(default=None, alias="userGroup") + __properties: ClassVar[List[str]] = ["description", "id", "maql", "tags", "title", "user", "userGroup"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUserDataFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user + if self.user: + _dict['user'] = self.user.to_dict() + # override the default output from pydantic by calling `to_dict()` of user_group + if self.user_group: + _dict['userGroup'] = self.user_group.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUserDataFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "id": obj.get("id"), + "maql": obj.get("maql"), + "tags": obj.get("tags"), + "title": obj.get("title"), + "user": DeclarativeUserIdentifier.from_dict(obj["user"]) if obj.get("user") is not None else None, + "userGroup": DeclarativeUserGroupIdentifier.from_dict(obj["userGroup"]) if obj.get("userGroup") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_user_data_filters.py b/gooddata-api-client/gooddata_api_client/models/declarative_user_data_filters.py new file mode 100644 index 000000000..f51158aee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_user_data_filters.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.declarative_user_data_filter import DeclarativeUserDataFilter +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUserDataFilters(BaseModel): + """ + Declarative form of user data filters. + """ # noqa: E501 + user_data_filters: List[DeclarativeUserDataFilter] = Field(alias="userDataFilters") + __properties: ClassVar[List[str]] = ["userDataFilters"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUserDataFilters from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_data_filters (list) + _items = [] + if self.user_data_filters: + for _item_user_data_filters in self.user_data_filters: + if _item_user_data_filters: + _items.append(_item_user_data_filters.to_dict()) + _dict['userDataFilters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUserDataFilters from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userDataFilters": [DeclarativeUserDataFilter.from_dict(_item) for _item in obj["userDataFilters"]] if obj.get("userDataFilters") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_user_group.py b/gooddata-api-client/gooddata_api_client/models/declarative_user_group.py new file mode 100644 index 000000000..c1332b02d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_user_group.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_user_group_identifier import DeclarativeUserGroupIdentifier +from gooddata_api_client.models.declarative_user_group_permission import DeclarativeUserGroupPermission +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUserGroup(BaseModel): + """ + A user-group and its properties + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="UserGroup identifier.") + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Name of UserGroup") + parents: Optional[List[DeclarativeUserGroupIdentifier]] = None + permissions: Optional[List[DeclarativeUserGroupPermission]] = None + __properties: ClassVar[List[str]] = ["id", "name", "parents", "permissions"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUserGroup from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in parents (list) + _items = [] + if self.parents: + for _item_parents in self.parents: + if _item_parents: + _items.append(_item_parents.to_dict()) + _dict['parents'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUserGroup from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "parents": [DeclarativeUserGroupIdentifier.from_dict(_item) for _item in obj["parents"]] if obj.get("parents") is not None else None, + "permissions": [DeclarativeUserGroupPermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_user_group_identifier.py b/gooddata-api-client/gooddata_api_client/models/declarative_user_group_identifier.py new file mode 100644 index 000000000..60e303bb4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_user_group_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUserGroupIdentifier(BaseModel): + """ + A user group identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Identifier of the user group.") + type: StrictStr = Field(description="A type.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userGroup']): + raise ValueError("must be one of enum values ('userGroup')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUserGroupIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUserGroupIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_user_group_permission.py b/gooddata-api-client/gooddata_api_client/models/declarative_user_group_permission.py new file mode 100644 index 000000000..c42aa808e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_user_group_permission.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUserGroupPermission(BaseModel): + """ + Definition of a user-group permission assigned to a user/user-group. + """ # noqa: E501 + assignee: AssigneeIdentifier + name: StrictStr = Field(description="Permission name.") + __properties: ClassVar[List[str]] = ["assignee", "name"] + + @field_validator('name') + def name_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['SEE']): + raise ValueError("must be one of enum values ('SEE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUserGroupPermission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee + if self.assignee: + _dict['assignee'] = self.assignee.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUserGroupPermission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assignee": AssigneeIdentifier.from_dict(obj["assignee"]) if obj.get("assignee") is not None else None, + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_user_group_permissions.py b/gooddata-api-client/gooddata_api_client/models/declarative_user_group_permissions.py new file mode 100644 index 000000000..3fbfa6a09 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_user_group_permissions.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_user_group_permission import DeclarativeUserGroupPermission +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUserGroupPermissions(BaseModel): + """ + Definition of permissions associated with a user-group. + """ # noqa: E501 + permissions: Optional[List[DeclarativeUserGroupPermission]] = None + __properties: ClassVar[List[str]] = ["permissions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUserGroupPermissions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUserGroupPermissions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": [DeclarativeUserGroupPermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_user_groups.py b/gooddata-api-client/gooddata_api_client/models/declarative_user_groups.py new file mode 100644 index 000000000..b9fa1ff6e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_user_groups.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.declarative_user_group import DeclarativeUserGroup +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUserGroups(BaseModel): + """ + Declarative form of userGroups and its properties. + """ # noqa: E501 + user_groups: List[DeclarativeUserGroup] = Field(alias="userGroups") + __properties: ClassVar[List[str]] = ["userGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUserGroups from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUserGroups from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroups": [DeclarativeUserGroup.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_user_identifier.py b/gooddata-api-client/gooddata_api_client/models/declarative_user_identifier.py new file mode 100644 index 000000000..28bc27e8d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_user_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUserIdentifier(BaseModel): + """ + A user identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="User identifier.") + type: StrictStr = Field(description="A type.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['user']): + raise ValueError("must be one of enum values ('user')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUserIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUserIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_user_permission.py b/gooddata-api-client/gooddata_api_client/models/declarative_user_permission.py new file mode 100644 index 000000000..dd53fc94b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_user_permission.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUserPermission(BaseModel): + """ + Definition of a user permission assigned to a user/user-group. + """ # noqa: E501 + assignee: AssigneeIdentifier + name: StrictStr = Field(description="Permission name.") + __properties: ClassVar[List[str]] = ["assignee", "name"] + + @field_validator('name') + def name_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['SEE']): + raise ValueError("must be one of enum values ('SEE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUserPermission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee + if self.assignee: + _dict['assignee'] = self.assignee.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUserPermission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assignee": AssigneeIdentifier.from_dict(obj["assignee"]) if obj.get("assignee") is not None else None, + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_user_permissions.py b/gooddata-api-client/gooddata_api_client/models/declarative_user_permissions.py new file mode 100644 index 000000000..fb53ca81c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_user_permissions.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_user_permission import DeclarativeUserPermission +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUserPermissions(BaseModel): + """ + Definition of permissions associated with a user. + """ # noqa: E501 + permissions: Optional[List[DeclarativeUserPermission]] = None + __properties: ClassVar[List[str]] = ["permissions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUserPermissions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUserPermissions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": [DeclarativeUserPermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_users.py b/gooddata-api-client/gooddata_api_client/models/declarative_users.py new file mode 100644 index 000000000..a708f7497 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_users.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.declarative_user import DeclarativeUser +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUsers(BaseModel): + """ + Declarative form of users and its properties. + """ # noqa: E501 + users: List[DeclarativeUser] + __properties: ClassVar[List[str]] = ["users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUsers from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUsers from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "users": [DeclarativeUser.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_users_user_groups.py b/gooddata-api-client/gooddata_api_client/models/declarative_users_user_groups.py new file mode 100644 index 000000000..87a11b684 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_users_user_groups.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.declarative_user import DeclarativeUser +from gooddata_api_client.models.declarative_user_group import DeclarativeUserGroup +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeUsersUserGroups(BaseModel): + """ + Declarative form of both users and user groups and theirs properties. + """ # noqa: E501 + user_groups: List[DeclarativeUserGroup] = Field(alias="userGroups") + users: List[DeclarativeUser] + __properties: ClassVar[List[str]] = ["userGroups", "users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeUsersUserGroups from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeUsersUserGroups from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroups": [DeclarativeUserGroup.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None, + "users": [DeclarativeUser.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_visualization_object.py b/gooddata-api-client/gooddata_api_client/models/declarative_visualization_object.py new file mode 100644 index 000000000..af8a2c998 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_visualization_object.py @@ -0,0 +1,156 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeVisualizationObject(BaseModel): + """ + DeclarativeVisualizationObject + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(description="Free-form JSON object") + created_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the entity creation.", alias="createdAt") + created_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="createdBy") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Visualization object description.") + id: Annotated[str, Field(strict=True)] = Field(description="Visualization object ID.") + is_hidden: Optional[StrictBool] = Field(default=None, description="If true, this visualization object is hidden from AI search results.", alias="isHidden") + modified_at: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Time of the last entity modification.", alias="modifiedAt") + modified_by: Optional[DeclarativeUserIdentifier] = Field(default=None, alias="modifiedBy") + tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Visualization object title.") + __properties: ClassVar[List[str]] = ["content", "createdAt", "createdBy", "description", "id", "isHidden", "modifiedAt", "modifiedBy", "tags", "title"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('modified_at') + def modified_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", value): + raise ValueError(r"must validate the regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeVisualizationObject from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + # set to None if modified_at (nullable) is None + # and model_fields_set contains the field + if self.modified_at is None and "modified_at" in self.model_fields_set: + _dict['modifiedAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeVisualizationObject from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "createdAt": obj.get("createdAt"), + "createdBy": DeclarativeUserIdentifier.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "description": obj.get("description"), + "id": obj.get("id"), + "isHidden": obj.get("isHidden"), + "modifiedAt": obj.get("modifiedAt"), + "modifiedBy": DeclarativeUserIdentifier.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_workspace.py b/gooddata-api-client/gooddata_api_client/models/declarative_workspace.py new file mode 100644 index 000000000..d28dd04b5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_workspace.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_automation import DeclarativeAutomation +from gooddata_api_client.models.declarative_custom_application_setting import DeclarativeCustomApplicationSetting +from gooddata_api_client.models.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.models.declarative_setting import DeclarativeSetting +from gooddata_api_client.models.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission +from gooddata_api_client.models.declarative_user_data_filter import DeclarativeUserDataFilter +from gooddata_api_client.models.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.workspace_data_source import WorkspaceDataSource +from gooddata_api_client.models.workspace_identifier import WorkspaceIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeWorkspace(BaseModel): + """ + A declarative form of a particular workspace. + """ # noqa: E501 + automations: Optional[List[DeclarativeAutomation]] = None + cache_extra_limit: Optional[StrictInt] = Field(default=None, description="Extra cache limit allocated to specific workspace. In case there is extra cache budget setup for organization, it can be split between multiple workspaces.", alias="cacheExtraLimit") + custom_application_settings: Optional[List[DeclarativeCustomApplicationSetting]] = Field(default=None, description="A list of workspace custom settings.", alias="customApplicationSettings") + data_source: Optional[WorkspaceDataSource] = Field(default=None, alias="dataSource") + description: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Description of the workspace") + early_access: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Early access defined on level Workspace", alias="earlyAccess") + early_access_values: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="Early access defined on level Workspace", alias="earlyAccessValues") + filter_views: Optional[List[DeclarativeFilterView]] = Field(default=None, alias="filterViews") + hierarchy_permissions: Optional[List[DeclarativeWorkspaceHierarchyPermission]] = Field(default=None, alias="hierarchyPermissions") + id: Annotated[str, Field(strict=True)] = Field(description="Identifier of a workspace") + model: Optional[DeclarativeWorkspaceModel] = None + name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Name of a workspace to view.") + parent: Optional[WorkspaceIdentifier] = None + permissions: Optional[List[DeclarativeSingleWorkspacePermission]] = None + prefix: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Custom prefix of entity identifiers in workspace") + settings: Optional[List[DeclarativeSetting]] = Field(default=None, description="A list of workspace settings.") + user_data_filters: Optional[List[DeclarativeUserDataFilter]] = Field(default=None, description="A list of workspace user data filters.", alias="userDataFilters") + __properties: ClassVar[List[str]] = ["automations", "cacheExtraLimit", "customApplicationSettings", "dataSource", "description", "earlyAccess", "earlyAccessValues", "filterViews", "hierarchyPermissions", "id", "model", "name", "parent", "permissions", "prefix", "settings", "userDataFilters"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('prefix') + def prefix_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeWorkspace from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in automations (list) + _items = [] + if self.automations: + for _item_automations in self.automations: + if _item_automations: + _items.append(_item_automations.to_dict()) + _dict['automations'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in custom_application_settings (list) + _items = [] + if self.custom_application_settings: + for _item_custom_application_settings in self.custom_application_settings: + if _item_custom_application_settings: + _items.append(_item_custom_application_settings.to_dict()) + _dict['customApplicationSettings'] = _items + # override the default output from pydantic by calling `to_dict()` of data_source + if self.data_source: + _dict['dataSource'] = self.data_source.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in filter_views (list) + _items = [] + if self.filter_views: + for _item_filter_views in self.filter_views: + if _item_filter_views: + _items.append(_item_filter_views.to_dict()) + _dict['filterViews'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in hierarchy_permissions (list) + _items = [] + if self.hierarchy_permissions: + for _item_hierarchy_permissions in self.hierarchy_permissions: + if _item_hierarchy_permissions: + _items.append(_item_hierarchy_permissions.to_dict()) + _dict['hierarchyPermissions'] = _items + # override the default output from pydantic by calling `to_dict()` of model + if self.model: + _dict['model'] = self.model.to_dict() + # override the default output from pydantic by calling `to_dict()` of parent + if self.parent: + _dict['parent'] = self.parent.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in settings (list) + _items = [] + if self.settings: + for _item_settings in self.settings: + if _item_settings: + _items.append(_item_settings.to_dict()) + _dict['settings'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in user_data_filters (list) + _items = [] + if self.user_data_filters: + for _item_user_data_filters in self.user_data_filters: + if _item_user_data_filters: + _items.append(_item_user_data_filters.to_dict()) + _dict['userDataFilters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeWorkspace from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "automations": [DeclarativeAutomation.from_dict(_item) for _item in obj["automations"]] if obj.get("automations") is not None else None, + "cacheExtraLimit": obj.get("cacheExtraLimit"), + "customApplicationSettings": [DeclarativeCustomApplicationSetting.from_dict(_item) for _item in obj["customApplicationSettings"]] if obj.get("customApplicationSettings") is not None else None, + "dataSource": WorkspaceDataSource.from_dict(obj["dataSource"]) if obj.get("dataSource") is not None else None, + "description": obj.get("description"), + "earlyAccess": obj.get("earlyAccess"), + "earlyAccessValues": obj.get("earlyAccessValues"), + "filterViews": [DeclarativeFilterView.from_dict(_item) for _item in obj["filterViews"]] if obj.get("filterViews") is not None else None, + "hierarchyPermissions": [DeclarativeWorkspaceHierarchyPermission.from_dict(_item) for _item in obj["hierarchyPermissions"]] if obj.get("hierarchyPermissions") is not None else None, + "id": obj.get("id"), + "model": DeclarativeWorkspaceModel.from_dict(obj["model"]) if obj.get("model") is not None else None, + "name": obj.get("name"), + "parent": WorkspaceIdentifier.from_dict(obj["parent"]) if obj.get("parent") is not None else None, + "permissions": [DeclarativeSingleWorkspacePermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None, + "prefix": obj.get("prefix"), + "settings": [DeclarativeSetting.from_dict(_item) for _item in obj["settings"]] if obj.get("settings") is not None else None, + "userDataFilters": [DeclarativeUserDataFilter.from_dict(_item) for _item in obj["userDataFilters"]] if obj.get("userDataFilters") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter.py b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter.py new file mode 100644 index 000000000..968055574 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.declarative_workspace_data_filter_setting import DeclarativeWorkspaceDataFilterSetting +from gooddata_api_client.models.workspace_identifier import WorkspaceIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeWorkspaceDataFilter(BaseModel): + """ + Workspace Data Filters serving the filtering of what data users can see in workspaces. + """ # noqa: E501 + column_name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Workspace Data Filters column name. Data are filtered using this physical column.", alias="columnName") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Workspace Data Filters description.") + id: Annotated[str, Field(strict=True)] = Field(description="Workspace Data Filters ID. This ID is further used to refer to this instance.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Workspace Data Filters title.") + workspace: WorkspaceIdentifier + workspace_data_filter_settings: List[DeclarativeWorkspaceDataFilterSetting] = Field(description="Filter settings specifying values of filters valid for the workspace.", alias="workspaceDataFilterSettings") + __properties: ClassVar[List[str]] = ["columnName", "description", "id", "title", "workspace", "workspaceDataFilterSettings"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceDataFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of workspace + if self.workspace: + _dict['workspace'] = self.workspace.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in workspace_data_filter_settings (list) + _items = [] + if self.workspace_data_filter_settings: + for _item_workspace_data_filter_settings in self.workspace_data_filter_settings: + if _item_workspace_data_filter_settings: + _items.append(_item_workspace_data_filter_settings.to_dict()) + _dict['workspaceDataFilterSettings'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceDataFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columnName": obj.get("columnName"), + "description": obj.get("description"), + "id": obj.get("id"), + "title": obj.get("title"), + "workspace": WorkspaceIdentifier.from_dict(obj["workspace"]) if obj.get("workspace") is not None else None, + "workspaceDataFilterSettings": [DeclarativeWorkspaceDataFilterSetting.from_dict(_item) for _item in obj["workspaceDataFilterSettings"]] if obj.get("workspaceDataFilterSettings") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter_column.py b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter_column.py new file mode 100644 index 000000000..6b3a3e953 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter_column.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeWorkspaceDataFilterColumn(BaseModel): + """ + DeclarativeWorkspaceDataFilterColumn + """ # noqa: E501 + data_type: StrictStr = Field(description="Data type of the column", alias="dataType") + name: StrictStr = Field(description="Name of the column") + __properties: ClassVar[List[str]] = ["dataType", "name"] + + @field_validator('data_type') + def data_type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceDataFilterColumn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceDataFilterColumn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataType": obj.get("dataType"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter_references.py b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter_references.py new file mode 100644 index 000000000..a9474f1a8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter_references.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeWorkspaceDataFilterReferences(BaseModel): + """ + DeclarativeWorkspaceDataFilterReferences + """ # noqa: E501 + filter_column: StrictStr = Field(description="Filter column name", alias="filterColumn") + filter_column_data_type: StrictStr = Field(description="Filter column data type", alias="filterColumnDataType") + filter_id: DatasetWorkspaceDataFilterIdentifier = Field(alias="filterId") + __properties: ClassVar[List[str]] = ["filterColumn", "filterColumnDataType", "filterId"] + + @field_validator('filter_column_data_type') + def filter_column_data_type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceDataFilterReferences from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of filter_id + if self.filter_id: + _dict['filterId'] = self.filter_id.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceDataFilterReferences from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "filterColumn": obj.get("filterColumn"), + "filterColumnDataType": obj.get("filterColumnDataType"), + "filterId": DatasetWorkspaceDataFilterIdentifier.from_dict(obj["filterId"]) if obj.get("filterId") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter_setting.py b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter_setting.py new file mode 100644 index 000000000..9d9f683bd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filter_setting.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.workspace_identifier import WorkspaceIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeWorkspaceDataFilterSetting(BaseModel): + """ + Workspace Data Filters serving the filtering of what data users can see in workspaces. + """ # noqa: E501 + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Workspace Data Filters setting description.") + filter_values: List[StrictStr] = Field(description="Only those rows are returned, where columnName from filter matches those values.", alias="filterValues") + id: Annotated[str, Field(strict=True)] = Field(description="Workspace Data Filters ID. This ID is further used to refer to this instance.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Workspace Data Filters setting title.") + workspace: WorkspaceIdentifier + __properties: ClassVar[List[str]] = ["description", "filterValues", "id", "title", "workspace"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceDataFilterSetting from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of workspace + if self.workspace: + _dict['workspace'] = self.workspace.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceDataFilterSetting from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "filterValues": obj.get("filterValues"), + "id": obj.get("id"), + "title": obj.get("title"), + "workspace": WorkspaceIdentifier.from_dict(obj["workspace"]) if obj.get("workspace") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filters.py b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filters.py new file mode 100644 index 000000000..cbbe9a3f7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_data_filters.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeWorkspaceDataFilters(BaseModel): + """ + Declarative form of data filters. + """ # noqa: E501 + workspace_data_filters: List[DeclarativeWorkspaceDataFilter] = Field(alias="workspaceDataFilters") + __properties: ClassVar[List[str]] = ["workspaceDataFilters"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceDataFilters from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in workspace_data_filters (list) + _items = [] + if self.workspace_data_filters: + for _item_workspace_data_filters in self.workspace_data_filters: + if _item_workspace_data_filters: + _items.append(_item_workspace_data_filters.to_dict()) + _dict['workspaceDataFilters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceDataFilters from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "workspaceDataFilters": [DeclarativeWorkspaceDataFilter.from_dict(_item) for _item in obj["workspaceDataFilters"]] if obj.get("workspaceDataFilters") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_workspace_hierarchy_permission.py b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_hierarchy_permission.py new file mode 100644 index 000000000..d678ab426 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_hierarchy_permission.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeWorkspaceHierarchyPermission(BaseModel): + """ + DeclarativeWorkspaceHierarchyPermission + """ # noqa: E501 + assignee: AssigneeIdentifier + name: StrictStr = Field(description="Permission name.") + __properties: ClassVar[List[str]] = ["assignee", "name"] + + @field_validator('name') + def name_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW']): + raise ValueError("must be one of enum values ('MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceHierarchyPermission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee + if self.assignee: + _dict['assignee'] = self.assignee.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceHierarchyPermission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assignee": AssigneeIdentifier.from_dict(obj["assignee"]) if obj.get("assignee") is not None else None, + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_workspace_model.py b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_model.py new file mode 100644 index 000000000..806c585b2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_model.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_analytics_layer import DeclarativeAnalyticsLayer +from gooddata_api_client.models.declarative_ldm import DeclarativeLdm +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeWorkspaceModel(BaseModel): + """ + A declarative form of a model and analytics for a workspace. + """ # noqa: E501 + analytics: Optional[DeclarativeAnalyticsLayer] = None + ldm: Optional[DeclarativeLdm] = None + __properties: ClassVar[List[str]] = ["analytics", "ldm"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceModel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of analytics + if self.analytics: + _dict['analytics'] = self.analytics.to_dict() + # override the default output from pydantic by calling `to_dict()` of ldm + if self.ldm: + _dict['ldm'] = self.ldm.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaceModel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analytics": DeclarativeAnalyticsLayer.from_dict(obj["analytics"]) if obj.get("analytics") is not None else None, + "ldm": DeclarativeLdm.from_dict(obj["ldm"]) if obj.get("ldm") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_workspace_permissions.py b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_permissions.py new file mode 100644 index 000000000..1ae36d203 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_workspace_permissions.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission +from gooddata_api_client.models.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeWorkspacePermissions(BaseModel): + """ + Definition of permissions associated with a workspace. + """ # noqa: E501 + hierarchy_permissions: Optional[List[DeclarativeWorkspaceHierarchyPermission]] = Field(default=None, alias="hierarchyPermissions") + permissions: Optional[List[DeclarativeSingleWorkspacePermission]] = None + __properties: ClassVar[List[str]] = ["hierarchyPermissions", "permissions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeWorkspacePermissions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in hierarchy_permissions (list) + _items = [] + if self.hierarchy_permissions: + for _item_hierarchy_permissions in self.hierarchy_permissions: + if _item_hierarchy_permissions: + _items.append(_item_hierarchy_permissions.to_dict()) + _dict['hierarchyPermissions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeWorkspacePermissions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "hierarchyPermissions": [DeclarativeWorkspaceHierarchyPermission.from_dict(_item) for _item in obj["hierarchyPermissions"]] if obj.get("hierarchyPermissions") is not None else None, + "permissions": [DeclarativeSingleWorkspacePermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/declarative_workspaces.py b/gooddata-api-client/gooddata_api_client/models/declarative_workspaces.py new file mode 100644 index 000000000..11857ecd2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/declarative_workspaces.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.declarative_workspace import DeclarativeWorkspace +from gooddata_api_client.models.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter +from typing import Optional, Set +from typing_extensions import Self + +class DeclarativeWorkspaces(BaseModel): + """ + A declarative form of a all workspace layout. + """ # noqa: E501 + workspace_data_filters: List[DeclarativeWorkspaceDataFilter] = Field(alias="workspaceDataFilters") + workspaces: List[DeclarativeWorkspace] + __properties: ClassVar[List[str]] = ["workspaceDataFilters", "workspaces"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaces from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in workspace_data_filters (list) + _items = [] + if self.workspace_data_filters: + for _item_workspace_data_filters in self.workspace_data_filters: + if _item_workspace_data_filters: + _items.append(_item_workspace_data_filters.to_dict()) + _dict['workspaceDataFilters'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in workspaces (list) + _items = [] + if self.workspaces: + for _item_workspaces in self.workspaces: + if _item_workspaces: + _items.append(_item_workspaces.to_dict()) + _dict['workspaces'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeclarativeWorkspaces from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "workspaceDataFilters": [DeclarativeWorkspaceDataFilter.from_dict(_item) for _item in obj["workspaceDataFilters"]] if obj.get("workspaceDataFilters") is not None else None, + "workspaces": [DeclarativeWorkspace.from_dict(_item) for _item in obj["workspaces"]] if obj.get("workspaces") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/default_smtp.py b/gooddata-api-client/gooddata_api_client/models/default_smtp.py new file mode 100644 index 000000000..880d9bd89 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/default_smtp.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DefaultSmtp(BaseModel): + """ + Default SMTP destination for notifications. + """ # noqa: E501 + from_email: Optional[StrictStr] = Field(default='no-reply@gooddata.com', description="E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.", alias="fromEmail") + from_email_name: Optional[StrictStr] = Field(default='GoodData', description="An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.", alias="fromEmailName") + type: StrictStr = Field(description="The destination type.") + __properties: ClassVar[List[str]] = ["fromEmail", "fromEmailName", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['DEFAULT_SMTP']): + raise ValueError("must be one of enum values ('DEFAULT_SMTP')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DefaultSmtp from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DefaultSmtp from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fromEmail": obj.get("fromEmail") if obj.get("fromEmail") is not None else 'no-reply@gooddata.com', + "fromEmailName": obj.get("fromEmailName") if obj.get("fromEmailName") is not None else 'GoodData', + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dependent_entities_graph.py b/gooddata-api-client/gooddata_api_client/models/dependent_entities_graph.py new file mode 100644 index 000000000..fbaf249c9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dependent_entities_graph.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.dependent_entities_node import DependentEntitiesNode +from gooddata_api_client.models.entity_identifier import EntityIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DependentEntitiesGraph(BaseModel): + """ + DependentEntitiesGraph + """ # noqa: E501 + edges: List[List[EntityIdentifier]] + nodes: List[DependentEntitiesNode] + __properties: ClassVar[List[str]] = ["edges", "nodes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DependentEntitiesGraph from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in edges (list of list) + _items = [] + if self.edges: + for _item_edges in self.edges: + if _item_edges: + _items.append( + [_inner_item.to_dict() for _inner_item in _item_edges if _inner_item is not None] + ) + _dict['edges'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in nodes (list) + _items = [] + if self.nodes: + for _item_nodes in self.nodes: + if _item_nodes: + _items.append(_item_nodes.to_dict()) + _dict['nodes'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DependentEntitiesGraph from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "edges": [ + [EntityIdentifier.from_dict(_inner_item) for _inner_item in _item] + for _item in obj["edges"] + ] if obj.get("edges") is not None else None, + "nodes": [DependentEntitiesNode.from_dict(_item) for _item in obj["nodes"]] if obj.get("nodes") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dependent_entities_node.py b/gooddata-api-client/gooddata_api_client/models/dependent_entities_node.py new file mode 100644 index 000000000..66e9a44d4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dependent_entities_node.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DependentEntitiesNode(BaseModel): + """ + DependentEntitiesNode + """ # noqa: E501 + id: StrictStr + title: Optional[StrictStr] = None + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "title", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard', 'attribute', 'attributeHierarchy', 'dashboardPlugin', 'dataset', 'fact', 'label', 'metric', 'userDataFilter', 'automation', 'visualizationObject', 'filterContext', 'filterView']): + raise ValueError("must be one of enum values ('analyticalDashboard', 'attribute', 'attributeHierarchy', 'dashboardPlugin', 'dataset', 'fact', 'label', 'metric', 'userDataFilter', 'automation', 'visualizationObject', 'filterContext', 'filterView')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DependentEntitiesNode from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DependentEntitiesNode from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "title": obj.get("title"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dependent_entities_request.py b/gooddata-api-client/gooddata_api_client/models/dependent_entities_request.py new file mode 100644 index 000000000..0f76f324e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dependent_entities_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.entity_identifier import EntityIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class DependentEntitiesRequest(BaseModel): + """ + DependentEntitiesRequest + """ # noqa: E501 + identifiers: List[EntityIdentifier] + __properties: ClassVar[List[str]] = ["identifiers"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DependentEntitiesRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in identifiers (list) + _items = [] + if self.identifiers: + for _item_identifiers in self.identifiers: + if _item_identifiers: + _items.append(_item_identifiers.to_dict()) + _dict['identifiers'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DependentEntitiesRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "identifiers": [EntityIdentifier.from_dict(_item) for _item in obj["identifiers"]] if obj.get("identifiers") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dependent_entities_response.py b/gooddata-api-client/gooddata_api_client/models/dependent_entities_response.py new file mode 100644 index 000000000..28c869f88 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dependent_entities_response.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.dependent_entities_graph import DependentEntitiesGraph +from typing import Optional, Set +from typing_extensions import Self + +class DependentEntitiesResponse(BaseModel): + """ + DependentEntitiesResponse + """ # noqa: E501 + graph: DependentEntitiesGraph + __properties: ClassVar[List[str]] = ["graph"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DependentEntitiesResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of graph + if self.graph: + _dict['graph'] = self.graph.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DependentEntitiesResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "graph": DependentEntitiesGraph.from_dict(obj["graph"]) if obj.get("graph") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/depends_on.py b/gooddata-api-client/gooddata_api_client/models/depends_on.py new file mode 100644 index 000000000..2381ff489 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/depends_on.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DependsOn(BaseModel): + """ + Filter definition type specified by label and values. + """ # noqa: E501 + complement_filter: Optional[StrictBool] = Field(default=False, description="Inverse filtering mode.", alias="complementFilter") + label: StrictStr = Field(description="Specifies on which label the filter depends on.") + values: List[Optional[StrictStr]] = Field(description="Specifies values of the label for element filtering.") + __properties: ClassVar[List[str]] = ["complementFilter", "label", "values"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DependsOn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DependsOn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "complementFilter": obj.get("complementFilter") if obj.get("complementFilter") is not None else False, + "label": obj.get("label"), + "values": obj.get("values") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/depends_on_date_filter.py b/gooddata-api-client/gooddata_api_client/models/depends_on_date_filter.py new file mode 100644 index 000000000..20c48ee60 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/depends_on_date_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.date_filter import DateFilter +from typing import Optional, Set +from typing_extensions import Self + +class DependsOnDateFilter(BaseModel): + """ + Filter definition type for dates. + """ # noqa: E501 + date_filter: DateFilter = Field(alias="dateFilter") + __properties: ClassVar[List[str]] = ["dateFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DependsOnDateFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of date_filter + if self.date_filter: + _dict['dateFilter'] = self.date_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DependsOnDateFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dateFilter": DateFilter.from_dict(obj["dateFilter"]) if obj.get("dateFilter") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dim_attribute.py b/gooddata-api-client/gooddata_api_client/models/dim_attribute.py new file mode 100644 index 000000000..255b6c596 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dim_attribute.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DimAttribute(BaseModel): + """ + List of attributes representing the dimensionality of the new visualization + """ # noqa: E501 + id: StrictStr = Field(description="ID of the object") + title: StrictStr = Field(description="Title of attribute.") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["id", "title", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attribute']): + raise ValueError("must be one of enum values ('attribute')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DimAttribute from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DimAttribute from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "title": obj.get("title"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dimension.py b/gooddata-api-client/gooddata_api_client/models/dimension.py new file mode 100644 index 000000000..891889c90 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dimension.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.sort_key import SortKey +from typing import Optional, Set +from typing_extensions import Self + +class Dimension(BaseModel): + """ + Single dimension description. + """ # noqa: E501 + item_identifiers: List[StrictStr] = Field(description="List of items in current dimension. Can reference 'localIdentifier' from 'AttributeItem', or special pseudo attribute \"measureGroup\" representing list of metrics.", alias="itemIdentifiers") + local_identifier: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Dimension identification within requests. Other entities can reference this dimension by this value.", alias="localIdentifier") + sorting: Optional[List[SortKey]] = Field(default=None, description="List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal).") + __properties: ClassVar[List[str]] = ["itemIdentifiers", "localIdentifier", "sorting"] + + @field_validator('local_identifier') + def local_identifier_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^[.a-zA-Z0-9_-]+$", value): + raise ValueError(r"must validate the regular expression /^[.a-zA-Z0-9_-]+$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Dimension from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in sorting (list) + _items = [] + if self.sorting: + for _item_sorting in self.sorting: + if _item_sorting: + _items.append(_item_sorting.to_dict()) + _dict['sorting'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Dimension from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "itemIdentifiers": obj.get("itemIdentifiers"), + "localIdentifier": obj.get("localIdentifier"), + "sorting": [SortKey.from_dict(_item) for _item in obj["sorting"]] if obj.get("sorting") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/dimension_header.py b/gooddata-api-client/gooddata_api_client/models/dimension_header.py new file mode 100644 index 000000000..616400c1e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/dimension_header.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.header_group import HeaderGroup +from typing import Optional, Set +from typing_extensions import Self + +class DimensionHeader(BaseModel): + """ + Contains the dimension-specific header information. + """ # noqa: E501 + header_groups: List[HeaderGroup] = Field(description="An array containing header groups.", alias="headerGroups") + __properties: ClassVar[List[str]] = ["headerGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DimensionHeader from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in header_groups (list) + _items = [] + if self.header_groups: + for _item_header_groups in self.header_groups: + if _item_header_groups: + _items.append(_item_header_groups.to_dict()) + _dict['headerGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DimensionHeader from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "headerGroups": [HeaderGroup.from_dict(_item) for _item in obj["headerGroups"]] if obj.get("headerGroups") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/element.py b/gooddata-api-client/gooddata_api_client/models/element.py new file mode 100644 index 000000000..68702129b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/element.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class Element(BaseModel): + """ + List of returned elements. + """ # noqa: E501 + primary_title: StrictStr = Field(description="Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded", alias="primaryTitle") + title: StrictStr = Field(description="Title of requested label.") + __properties: ClassVar[List[str]] = ["primaryTitle", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Element from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Element from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "primaryTitle": obj.get("primaryTitle"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/elements_request.py b/gooddata-api-client/gooddata_api_client/models/elements_request.py new file mode 100644 index 000000000..3b08be48d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/elements_request.py @@ -0,0 +1,146 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from gooddata_api_client.models.elements_request_depends_on_inner import ElementsRequestDependsOnInner +from gooddata_api_client.models.filter_by import FilterBy +from gooddata_api_client.models.validate_by_item import ValidateByItem +from typing import Optional, Set +from typing_extensions import Self + +class ElementsRequest(BaseModel): + """ + ElementsRequest + """ # noqa: E501 + cache_id: Optional[StrictStr] = Field(default=None, description="If specified, the element data will be taken from the result with the same cacheId if it is available.", alias="cacheId") + complement_filter: Optional[StrictBool] = Field(default=False, description="Inverse filters: * ```false``` - return items matching ```patternFilter``` and ```exactFilter``` * ```true``` - return items not matching ```patternFilter``` and ```exactFilter```", alias="complementFilter") + data_sampling_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=100.0, description="Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.", alias="dataSamplingPercentage") + depends_on: Optional[List[ElementsRequestDependsOnInner]] = Field(default=None, description="Return only items that are not filtered-out by the parent filters.", alias="dependsOn") + exact_filter: Optional[List[Optional[StrictStr]]] = Field(default=None, description="Return only items, whose ```label``` title exactly matches one of ```filter```.", alias="exactFilter") + exclude_primary_label: Optional[StrictBool] = Field(default=False, description="Excludes items from the result that differ only by primary label * ```false``` - return items with distinct primary label * ```true``` - return items with distinct requested label", alias="excludePrimaryLabel") + filter_by: Optional[FilterBy] = Field(default=None, alias="filterBy") + label: Annotated[str, Field(strict=True)] = Field(description="Requested label.") + pattern_filter: Optional[StrictStr] = Field(default=None, description="Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.", alias="patternFilter") + sort_order: Optional[StrictStr] = Field(default=None, description="Sort order of returned items. Items are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default", alias="sortOrder") + validate_by: Optional[List[Optional[ValidateByItem]]] = Field(default=None, description="Return only items that are computable on metric.", alias="validateBy") + __properties: ClassVar[List[str]] = ["cacheId", "complementFilter", "dataSamplingPercentage", "dependsOn", "exactFilter", "excludePrimaryLabel", "filterBy", "label", "patternFilter", "sortOrder", "validateBy"] + + @field_validator('label') + def label_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('sort_order') + def sort_order_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ASC', 'DESC']): + raise ValueError("must be one of enum values ('ASC', 'DESC')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ElementsRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in depends_on (list) + _items = [] + if self.depends_on: + for _item_depends_on in self.depends_on: + if _item_depends_on: + _items.append(_item_depends_on.to_dict()) + _dict['dependsOn'] = _items + # override the default output from pydantic by calling `to_dict()` of filter_by + if self.filter_by: + _dict['filterBy'] = self.filter_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in validate_by (list) + _items = [] + if self.validate_by: + for _item_validate_by in self.validate_by: + if _item_validate_by: + _items.append(_item_validate_by.to_dict()) + _dict['validateBy'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ElementsRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cacheId": obj.get("cacheId"), + "complementFilter": obj.get("complementFilter") if obj.get("complementFilter") is not None else False, + "dataSamplingPercentage": obj.get("dataSamplingPercentage") if obj.get("dataSamplingPercentage") is not None else 100.0, + "dependsOn": [ElementsRequestDependsOnInner.from_dict(_item) for _item in obj["dependsOn"]] if obj.get("dependsOn") is not None else None, + "exactFilter": obj.get("exactFilter"), + "excludePrimaryLabel": obj.get("excludePrimaryLabel") if obj.get("excludePrimaryLabel") is not None else False, + "filterBy": FilterBy.from_dict(obj["filterBy"]) if obj.get("filterBy") is not None else None, + "label": obj.get("label"), + "patternFilter": obj.get("patternFilter"), + "sortOrder": obj.get("sortOrder"), + "validateBy": [ValidateByItem.from_dict(_item) for _item in obj["validateBy"]] if obj.get("validateBy") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/elements_request_depends_on_inner.py b/gooddata-api-client/gooddata_api_client/models/elements_request_depends_on_inner.py new file mode 100644 index 000000000..269ea6d0f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/elements_request_depends_on_inner.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.depends_on import DependsOn +from gooddata_api_client.models.depends_on_date_filter import DependsOnDateFilter +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +ELEMENTSREQUESTDEPENDSONINNER_ONE_OF_SCHEMAS = ["DependsOn", "DependsOnDateFilter"] + +class ElementsRequestDependsOnInner(BaseModel): + """ + ElementsRequestDependsOnInner + """ + # data type: DependsOn + oneof_schema_1_validator: Optional[DependsOn] = None + # data type: DependsOnDateFilter + oneof_schema_2_validator: Optional[DependsOnDateFilter] = None + actual_instance: Optional[Union[DependsOn, DependsOnDateFilter]] = None + one_of_schemas: Set[str] = { "DependsOn", "DependsOnDateFilter" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = ElementsRequestDependsOnInner.model_construct() + error_messages = [] + match = 0 + # validate data type: DependsOn + if not isinstance(v, DependsOn): + error_messages.append(f"Error! Input type `{type(v)}` is not `DependsOn`") + else: + match += 1 + # validate data type: DependsOnDateFilter + if not isinstance(v, DependsOnDateFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `DependsOnDateFilter`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in ElementsRequestDependsOnInner with oneOf schemas: DependsOn, DependsOnDateFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in ElementsRequestDependsOnInner with oneOf schemas: DependsOn, DependsOnDateFilter. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into DependsOn + try: + instance.actual_instance = DependsOn.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into DependsOnDateFilter + try: + instance.actual_instance = DependsOnDateFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into ElementsRequestDependsOnInner with oneOf schemas: DependsOn, DependsOnDateFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into ElementsRequestDependsOnInner with oneOf schemas: DependsOn, DependsOnDateFilter. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], DependsOn, DependsOnDateFilter]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/elements_response.py b/gooddata-api-client/gooddata_api_client/models/elements_response.py new file mode 100644 index 000000000..5cd8861ef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/elements_response.py @@ -0,0 +1,128 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.attribute_format import AttributeFormat +from gooddata_api_client.models.element import Element +from gooddata_api_client.models.paging import Paging +from gooddata_api_client.models.rest_api_identifier import RestApiIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class ElementsResponse(BaseModel): + """ + Entity holding list of sorted & filtered label elements, related primary label of attribute owning requested label and paging. + """ # noqa: E501 + cache_id: Optional[StrictStr] = Field(default=None, description="The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.", alias="cacheId") + elements: List[Element] = Field(description="List of returned elements.") + format: Optional[AttributeFormat] = None + granularity: Optional[StrictStr] = Field(default=None, description="Granularity of requested label in case of date attribute") + paging: Paging + primary_label: RestApiIdentifier = Field(alias="primaryLabel") + __properties: ClassVar[List[str]] = ["cacheId", "elements", "format", "granularity", "paging", "primaryLabel"] + + @field_validator('granularity') + def granularity_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR']): + raise ValueError("must be one of enum values ('MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ElementsResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in elements (list) + _items = [] + if self.elements: + for _item_elements in self.elements: + if _item_elements: + _items.append(_item_elements.to_dict()) + _dict['elements'] = _items + # override the default output from pydantic by calling `to_dict()` of format + if self.format: + _dict['format'] = self.format.to_dict() + # override the default output from pydantic by calling `to_dict()` of paging + if self.paging: + _dict['paging'] = self.paging.to_dict() + # override the default output from pydantic by calling `to_dict()` of primary_label + if self.primary_label: + _dict['primaryLabel'] = self.primary_label.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ElementsResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cacheId": obj.get("cacheId"), + "elements": [Element.from_dict(_item) for _item in obj["elements"]] if obj.get("elements") is not None else None, + "format": AttributeFormat.from_dict(obj["format"]) if obj.get("format") is not None else None, + "granularity": obj.get("granularity"), + "paging": Paging.from_dict(obj["paging"]) if obj.get("paging") is not None else None, + "primaryLabel": RestApiIdentifier.from_dict(obj["primaryLabel"]) if obj.get("primaryLabel") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/entitlements_request.py b/gooddata-api-client/gooddata_api_client/models/entitlements_request.py new file mode 100644 index 000000000..550bc53cb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/entitlements_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class EntitlementsRequest(BaseModel): + """ + EntitlementsRequest + """ # noqa: E501 + entitlements_name: List[StrictStr] = Field(alias="entitlementsName") + __properties: ClassVar[List[str]] = ["entitlementsName"] + + @field_validator('entitlements_name') + def entitlements_name_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['CacheStrategy', 'Contract', 'CustomTheming', 'ExtraCache', 'Hipaa', 'PdfExports', 'ManagedOIDC', 'UiLocalization', 'Tier', 'UserCount', 'ManagedIdpUserCount', 'UnlimitedUsers', 'UnlimitedWorkspaces', 'WhiteLabeling', 'WorkspaceCount', 'UserTelemetryDisabled', 'AutomationCount', 'UnlimitedAutomations', 'AutomationRecipientCount', 'UnlimitedAutomationRecipients', 'DailyScheduledActionCount', 'UnlimitedDailyScheduledActions', 'DailyAlertActionCount', 'UnlimitedDailyAlertActions', 'ScheduledActionMinimumRecurrenceMinutes', 'FederatedIdentityManagement', 'AuditLogging', 'ControlledFeatureRollout']): + raise ValueError("each list item must be one of ('CacheStrategy', 'Contract', 'CustomTheming', 'ExtraCache', 'Hipaa', 'PdfExports', 'ManagedOIDC', 'UiLocalization', 'Tier', 'UserCount', 'ManagedIdpUserCount', 'UnlimitedUsers', 'UnlimitedWorkspaces', 'WhiteLabeling', 'WorkspaceCount', 'UserTelemetryDisabled', 'AutomationCount', 'UnlimitedAutomations', 'AutomationRecipientCount', 'UnlimitedAutomationRecipients', 'DailyScheduledActionCount', 'UnlimitedDailyScheduledActions', 'DailyAlertActionCount', 'UnlimitedDailyAlertActions', 'ScheduledActionMinimumRecurrenceMinutes', 'FederatedIdentityManagement', 'AuditLogging', 'ControlledFeatureRollout')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of EntitlementsRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of EntitlementsRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "entitlementsName": obj.get("entitlementsName") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/entity_identifier.py b/gooddata-api-client/gooddata_api_client/models/entity_identifier.py new file mode 100644 index 000000000..97eaca097 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/entity_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class EntityIdentifier(BaseModel): + """ + EntityIdentifier + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Object identifier.") + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard', 'attribute', 'attributeHierarchy', 'dashboardPlugin', 'dataset', 'fact', 'label', 'metric', 'userDataFilter', 'automation', 'visualizationObject', 'filterContext', 'filterView']): + raise ValueError("must be one of enum values ('analyticalDashboard', 'attribute', 'attributeHierarchy', 'dashboardPlugin', 'dataset', 'fact', 'label', 'metric', 'userDataFilter', 'automation', 'visualizationObject', 'filterContext', 'filterView')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of EntityIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of EntityIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/execution_links.py b/gooddata-api-client/gooddata_api_client/models/execution_links.py new file mode 100644 index 000000000..337666c5c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/execution_links.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ExecutionLinks(BaseModel): + """ + Links to the execution result. + """ # noqa: E501 + execution_result: StrictStr = Field(description="Link to the result data.", alias="executionResult") + __properties: ClassVar[List[str]] = ["executionResult"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExecutionLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExecutionLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "executionResult": obj.get("executionResult") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/execution_response.py b/gooddata-api-client/gooddata_api_client/models/execution_response.py new file mode 100644 index 000000000..6d795c29d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/execution_response.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.execution_links import ExecutionLinks +from gooddata_api_client.models.result_dimension import ResultDimension +from typing import Optional, Set +from typing_extensions import Self + +class ExecutionResponse(BaseModel): + """ + Response to AFM execution request body + """ # noqa: E501 + dimensions: List[ResultDimension] = Field(description="Dimensions of the result") + links: ExecutionLinks + __properties: ClassVar[List[str]] = ["dimensions", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExecutionResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensions (list) + _items = [] + if self.dimensions: + for _item_dimensions in self.dimensions: + if _item_dimensions: + _items.append(_item_dimensions.to_dict()) + _dict['dimensions'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExecutionResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensions": [ResultDimension.from_dict(_item) for _item in obj["dimensions"]] if obj.get("dimensions") is not None else None, + "links": ExecutionLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/execution_result.py b/gooddata-api-client/gooddata_api_client/models/execution_result.py new file mode 100644 index 000000000..1040dada1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/execution_result.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.dimension_header import DimensionHeader +from gooddata_api_client.models.execution_result_grand_total import ExecutionResultGrandTotal +from gooddata_api_client.models.execution_result_metadata import ExecutionResultMetadata +from gooddata_api_client.models.execution_result_paging import ExecutionResultPaging +from typing import Optional, Set +from typing_extensions import Self + +class ExecutionResult(BaseModel): + """ + Contains the result of an AFM execution. + """ # noqa: E501 + data: List[Dict[str, Any]] = Field(description="A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.") + dimension_headers: List[DimensionHeader] = Field(description="An array containing dimension headers. The size of the array corresponds to the number of dimensions. Their order corresponds to the dimension order in the execution result spec.", alias="dimensionHeaders") + grand_totals: List[ExecutionResultGrandTotal] = Field(alias="grandTotals") + metadata: ExecutionResultMetadata + paging: ExecutionResultPaging + __properties: ClassVar[List[str]] = ["data", "dimensionHeaders", "grandTotals", "metadata", "paging"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExecutionResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimension_headers (list) + _items = [] + if self.dimension_headers: + for _item_dimension_headers in self.dimension_headers: + if _item_dimension_headers: + _items.append(_item_dimension_headers.to_dict()) + _dict['dimensionHeaders'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in grand_totals (list) + _items = [] + if self.grand_totals: + for _item_grand_totals in self.grand_totals: + if _item_grand_totals: + _items.append(_item_grand_totals.to_dict()) + _dict['grandTotals'] = _items + # override the default output from pydantic by calling `to_dict()` of metadata + if self.metadata: + _dict['metadata'] = self.metadata.to_dict() + # override the default output from pydantic by calling `to_dict()` of paging + if self.paging: + _dict['paging'] = self.paging.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExecutionResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": obj.get("data"), + "dimensionHeaders": [DimensionHeader.from_dict(_item) for _item in obj["dimensionHeaders"]] if obj.get("dimensionHeaders") is not None else None, + "grandTotals": [ExecutionResultGrandTotal.from_dict(_item) for _item in obj["grandTotals"]] if obj.get("grandTotals") is not None else None, + "metadata": ExecutionResultMetadata.from_dict(obj["metadata"]) if obj.get("metadata") is not None else None, + "paging": ExecutionResultPaging.from_dict(obj["paging"]) if obj.get("paging") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/execution_result_data_source_message.py b/gooddata-api-client/gooddata_api_client/models/execution_result_data_source_message.py new file mode 100644 index 000000000..0611fc52f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/execution_result_data_source_message.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ExecutionResultDataSourceMessage(BaseModel): + """ + A piece of extra information related to the results (e.g. debug information, warnings, etc.). + """ # noqa: E501 + correlation_id: StrictStr = Field(description="Id correlating different pieces of supplementary info together.", alias="correlationId") + data: Optional[Dict[str, Any]] = Field(default=None, description="Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type.") + source: StrictStr = Field(description="Information about what part of the system created this piece of supplementary info.") + type: StrictStr = Field(description="Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future.") + __properties: ClassVar[List[str]] = ["correlationId", "data", "source", "type"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExecutionResultDataSourceMessage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExecutionResultDataSourceMessage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "correlationId": obj.get("correlationId"), + "data": obj.get("data"), + "source": obj.get("source"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/execution_result_grand_total.py b/gooddata-api-client/gooddata_api_client/models/execution_result_grand_total.py new file mode 100644 index 000000000..80d599045 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/execution_result_grand_total.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.dimension_header import DimensionHeader +from typing import Optional, Set +from typing_extensions import Self + +class ExecutionResultGrandTotal(BaseModel): + """ + Contains the data of grand totals with the same dimensions. + """ # noqa: E501 + data: List[Dict[str, Any]] = Field(description="A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.") + dimension_headers: List[DimensionHeader] = Field(description="Contains headers for a subset of `totalDimensions` in which the totals are grand totals.", alias="dimensionHeaders") + total_dimensions: List[StrictStr] = Field(description="Dimensions of the grand totals.", alias="totalDimensions") + __properties: ClassVar[List[str]] = ["data", "dimensionHeaders", "totalDimensions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExecutionResultGrandTotal from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimension_headers (list) + _items = [] + if self.dimension_headers: + for _item_dimension_headers in self.dimension_headers: + if _item_dimension_headers: + _items.append(_item_dimension_headers.to_dict()) + _dict['dimensionHeaders'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExecutionResultGrandTotal from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": obj.get("data"), + "dimensionHeaders": [DimensionHeader.from_dict(_item) for _item in obj["dimensionHeaders"]] if obj.get("dimensionHeaders") is not None else None, + "totalDimensions": obj.get("totalDimensions") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/execution_result_header.py b/gooddata-api-client/gooddata_api_client/models/execution_result_header.py new file mode 100644 index 000000000..4ba8b47c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/execution_result_header.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.attribute_execution_result_header import AttributeExecutionResultHeader +from gooddata_api_client.models.measure_execution_result_header import MeasureExecutionResultHeader +from gooddata_api_client.models.total_execution_result_header import TotalExecutionResultHeader +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +EXECUTIONRESULTHEADER_ONE_OF_SCHEMAS = ["AttributeExecutionResultHeader", "MeasureExecutionResultHeader", "TotalExecutionResultHeader"] + +class ExecutionResultHeader(BaseModel): + """ + Abstract execution result header + """ + # data type: AttributeExecutionResultHeader + oneof_schema_1_validator: Optional[AttributeExecutionResultHeader] = None + # data type: MeasureExecutionResultHeader + oneof_schema_2_validator: Optional[MeasureExecutionResultHeader] = None + # data type: TotalExecutionResultHeader + oneof_schema_3_validator: Optional[TotalExecutionResultHeader] = None + actual_instance: Optional[Union[AttributeExecutionResultHeader, MeasureExecutionResultHeader, TotalExecutionResultHeader]] = None + one_of_schemas: Set[str] = { "AttributeExecutionResultHeader", "MeasureExecutionResultHeader", "TotalExecutionResultHeader" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = ExecutionResultHeader.model_construct() + error_messages = [] + match = 0 + # validate data type: AttributeExecutionResultHeader + if not isinstance(v, AttributeExecutionResultHeader): + error_messages.append(f"Error! Input type `{type(v)}` is not `AttributeExecutionResultHeader`") + else: + match += 1 + # validate data type: MeasureExecutionResultHeader + if not isinstance(v, MeasureExecutionResultHeader): + error_messages.append(f"Error! Input type `{type(v)}` is not `MeasureExecutionResultHeader`") + else: + match += 1 + # validate data type: TotalExecutionResultHeader + if not isinstance(v, TotalExecutionResultHeader): + error_messages.append(f"Error! Input type `{type(v)}` is not `TotalExecutionResultHeader`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in ExecutionResultHeader with oneOf schemas: AttributeExecutionResultHeader, MeasureExecutionResultHeader, TotalExecutionResultHeader. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in ExecutionResultHeader with oneOf schemas: AttributeExecutionResultHeader, MeasureExecutionResultHeader, TotalExecutionResultHeader. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into AttributeExecutionResultHeader + try: + instance.actual_instance = AttributeExecutionResultHeader.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into MeasureExecutionResultHeader + try: + instance.actual_instance = MeasureExecutionResultHeader.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into TotalExecutionResultHeader + try: + instance.actual_instance = TotalExecutionResultHeader.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into ExecutionResultHeader with oneOf schemas: AttributeExecutionResultHeader, MeasureExecutionResultHeader, TotalExecutionResultHeader. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into ExecutionResultHeader with oneOf schemas: AttributeExecutionResultHeader, MeasureExecutionResultHeader, TotalExecutionResultHeader. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], AttributeExecutionResultHeader, MeasureExecutionResultHeader, TotalExecutionResultHeader]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/execution_result_metadata.py b/gooddata-api-client/gooddata_api_client/models/execution_result_metadata.py new file mode 100644 index 000000000..b5e6433a1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/execution_result_metadata.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.execution_result_data_source_message import ExecutionResultDataSourceMessage +from typing import Optional, Set +from typing_extensions import Self + +class ExecutionResultMetadata(BaseModel): + """ + Additional metadata for the particular execution result. + """ # noqa: E501 + data_source_messages: List[ExecutionResultDataSourceMessage] = Field(description="Additional information sent by the underlying data source.", alias="dataSourceMessages") + __properties: ClassVar[List[str]] = ["dataSourceMessages"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExecutionResultMetadata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_source_messages (list) + _items = [] + if self.data_source_messages: + for _item_data_source_messages in self.data_source_messages: + if _item_data_source_messages: + _items.append(_item_data_source_messages.to_dict()) + _dict['dataSourceMessages'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExecutionResultMetadata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataSourceMessages": [ExecutionResultDataSourceMessage.from_dict(_item) for _item in obj["dataSourceMessages"]] if obj.get("dataSourceMessages") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/execution_result_paging.py b/gooddata-api-client/gooddata_api_client/models/execution_result_paging.py new file mode 100644 index 000000000..b775717c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/execution_result_paging.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ExecutionResultPaging(BaseModel): + """ + A paging information related to the data presented in the execution result. These paging information are multi-dimensional. + """ # noqa: E501 + count: List[StrictInt] = Field(description="A count of the returned results in every dimension.") + offset: List[StrictInt] = Field(description="The offset of the results returned in every dimension.") + total: List[StrictInt] = Field(description="A total count of the results in every dimension.") + __properties: ClassVar[List[str]] = ["count", "offset", "total"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExecutionResultPaging from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExecutionResultPaging from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "count": obj.get("count"), + "offset": obj.get("offset"), + "total": obj.get("total") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/execution_settings.py b/gooddata-api-client/gooddata_api_client/models/execution_settings.py new file mode 100644 index 000000000..a7e1bce9d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/execution_settings.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class ExecutionSettings(BaseModel): + """ + Various settings affecting the process of AFM execution or its result + """ # noqa: E501 + data_sampling_percentage: Optional[Union[Annotated[float, Field(lt=100, strict=True, gt=0)], Annotated[int, Field(lt=100, strict=True, gt=0)]]] = Field(default=None, description="Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.", alias="dataSamplingPercentage") + timestamp: Optional[datetime] = Field(default=None, description="Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.") + __properties: ClassVar[List[str]] = ["dataSamplingPercentage", "timestamp"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExecutionSettings from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExecutionSettings from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataSamplingPercentage": obj.get("dataSamplingPercentage"), + "timestamp": obj.get("timestamp") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/export_request.py b/gooddata-api-client/gooddata_api_client/models/export_request.py new file mode 100644 index 000000000..1f8ea3570 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/export_request.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.visual_export_request import VisualExportRequest +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +EXPORTREQUEST_ONE_OF_SCHEMAS = ["TabularExportRequest", "VisualExportRequest"] + +class ExportRequest(BaseModel): + """ + JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. + """ + # data type: VisualExportRequest + oneof_schema_1_validator: Optional[VisualExportRequest] = None + # data type: TabularExportRequest + oneof_schema_2_validator: Optional[TabularExportRequest] = None + actual_instance: Optional[Union[TabularExportRequest, VisualExportRequest]] = None + one_of_schemas: Set[str] = { "TabularExportRequest", "VisualExportRequest" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = ExportRequest.model_construct() + error_messages = [] + match = 0 + # validate data type: VisualExportRequest + if not isinstance(v, VisualExportRequest): + error_messages.append(f"Error! Input type `{type(v)}` is not `VisualExportRequest`") + else: + match += 1 + # validate data type: TabularExportRequest + if not isinstance(v, TabularExportRequest): + error_messages.append(f"Error! Input type `{type(v)}` is not `TabularExportRequest`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in ExportRequest with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in ExportRequest with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into VisualExportRequest + try: + instance.actual_instance = VisualExportRequest.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into TabularExportRequest + try: + instance.actual_instance = TabularExportRequest.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into ExportRequest with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into ExportRequest with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], TabularExportRequest, VisualExportRequest]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/export_response.py b/gooddata-api-client/gooddata_api_client/models/export_response.py new file mode 100644 index 000000000..0111ede8c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/export_response.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ExportResponse(BaseModel): + """ + ExportResponse + """ # noqa: E501 + export_result: StrictStr = Field(alias="exportResult") + __properties: ClassVar[List[str]] = ["exportResult"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExportResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExportResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "exportResult": obj.get("exportResult") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/export_result.py b/gooddata-api-client/gooddata_api_client/models/export_result.py new file mode 100644 index 000000000..055d22782 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/export_result.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ExportResult(BaseModel): + """ + ExportResult + """ # noqa: E501 + error_message: Optional[StrictStr] = Field(default=None, alias="errorMessage") + expires_at: Optional[datetime] = Field(default=None, alias="expiresAt") + export_id: StrictStr = Field(alias="exportId") + file_name: StrictStr = Field(alias="fileName") + file_size: Optional[StrictInt] = Field(default=None, alias="fileSize") + file_uri: Optional[StrictStr] = Field(default=None, alias="fileUri") + status: StrictStr + trace_id: Optional[StrictStr] = Field(default=None, alias="traceId") + triggered_at: Optional[datetime] = Field(default=None, alias="triggeredAt") + __properties: ClassVar[List[str]] = ["errorMessage", "expiresAt", "exportId", "fileName", "fileSize", "fileUri", "status", "traceId", "triggeredAt"] + + @field_validator('status') + def status_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['SUCCESS', 'ERROR', 'INTERNAL_ERROR', 'TIMEOUT']): + raise ValueError("must be one of enum values ('SUCCESS', 'ERROR', 'INTERNAL_ERROR', 'TIMEOUT')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExportResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExportResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "errorMessage": obj.get("errorMessage"), + "expiresAt": obj.get("expiresAt"), + "exportId": obj.get("exportId"), + "fileName": obj.get("fileName"), + "fileSize": obj.get("fileSize"), + "fileUri": obj.get("fileUri"), + "status": obj.get("status"), + "traceId": obj.get("traceId"), + "triggeredAt": obj.get("triggeredAt") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/fact_identifier.py b/gooddata-api-client/gooddata_api_client/models/fact_identifier.py new file mode 100644 index 000000000..60c7a8948 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/fact_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class FactIdentifier(BaseModel): + """ + A fact identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Fact ID.") + type: StrictStr = Field(description="A type of the fact.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['fact']): + raise ValueError("must be one of enum values ('fact')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FactIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FactIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/file.py b/gooddata-api-client/gooddata_api_client/models/file.py new file mode 100644 index 000000000..da1c41ec5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/file.py @@ -0,0 +1,158 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.notes import Notes +from gooddata_api_client.models.skeleton import Skeleton +from typing import Optional, Set +from typing_extensions import Self + +class File(BaseModel): + """ + File + """ # noqa: E501 + any: Optional[List[Dict[str, Any]]] = None + can_resegment: Optional[StrictStr] = Field(default=None, alias="canResegment") + id: Optional[StrictStr] = None + notes: Optional[Notes] = None + original: Optional[StrictStr] = None + other_attributes: Optional[Dict[str, StrictStr]] = Field(default=None, alias="otherAttributes") + skeleton: Optional[Skeleton] = None + space: Optional[StrictStr] = None + src_dir: Optional[StrictStr] = Field(default=None, alias="srcDir") + translate: Optional[StrictStr] = None + trg_dir: Optional[StrictStr] = Field(default=None, alias="trgDir") + unit_or_group: Optional[List[Dict[str, Any]]] = Field(default=None, alias="unitOrGroup") + __properties: ClassVar[List[str]] = ["any", "canResegment", "id", "notes", "original", "otherAttributes", "skeleton", "space", "srcDir", "translate", "trgDir", "unitOrGroup"] + + @field_validator('can_resegment') + def can_resegment_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['YES', 'NO']): + raise ValueError("must be one of enum values ('YES', 'NO')") + return value + + @field_validator('src_dir') + def src_dir_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['LTR', 'RTL', 'AUTO']): + raise ValueError("must be one of enum values ('LTR', 'RTL', 'AUTO')") + return value + + @field_validator('translate') + def translate_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['YES', 'NO']): + raise ValueError("must be one of enum values ('YES', 'NO')") + return value + + @field_validator('trg_dir') + def trg_dir_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['LTR', 'RTL', 'AUTO']): + raise ValueError("must be one of enum values ('LTR', 'RTL', 'AUTO')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of File from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of notes + if self.notes: + _dict['notes'] = self.notes.to_dict() + # override the default output from pydantic by calling `to_dict()` of skeleton + if self.skeleton: + _dict['skeleton'] = self.skeleton.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of File from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "any": obj.get("any"), + "canResegment": obj.get("canResegment"), + "id": obj.get("id"), + "notes": Notes.from_dict(obj["notes"]) if obj.get("notes") is not None else None, + "original": obj.get("original"), + "otherAttributes": obj.get("otherAttributes"), + "skeleton": Skeleton.from_dict(obj["skeleton"]) if obj.get("skeleton") is not None else None, + "space": obj.get("space"), + "srcDir": obj.get("srcDir"), + "translate": obj.get("translate"), + "trgDir": obj.get("trgDir"), + "unitOrGroup": obj.get("unitOrGroup") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/filter_by.py b/gooddata-api-client/gooddata_api_client/models/filter_by.py new file mode 100644 index 000000000..4bfc63687 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/filter_by.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class FilterBy(BaseModel): + """ + Specifies what is used for filtering. + """ # noqa: E501 + label_type: Optional[StrictStr] = Field(default='REQUESTED', description="Specifies which label is used for filtering - primary or requested.", alias="labelType") + __properties: ClassVar[List[str]] = ["labelType"] + + @field_validator('label_type') + def label_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['PRIMARY', 'REQUESTED']): + raise ValueError("must be one of enum values ('PRIMARY', 'REQUESTED')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FilterBy from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FilterBy from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "labelType": obj.get("labelType") if obj.get("labelType") is not None else 'REQUESTED' + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/filter_definition.py b/gooddata-api-client/gooddata_api_client/models/filter_definition.py new file mode 100644 index 000000000..831905772 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/filter_definition.py @@ -0,0 +1,222 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.absolute_date_filter import AbsoluteDateFilter +from gooddata_api_client.models.comparison_measure_value_filter import ComparisonMeasureValueFilter +from gooddata_api_client.models.inline_filter_definition import InlineFilterDefinition +from gooddata_api_client.models.negative_attribute_filter import NegativeAttributeFilter +from gooddata_api_client.models.positive_attribute_filter import PositiveAttributeFilter +from gooddata_api_client.models.range_measure_value_filter import RangeMeasureValueFilter +from gooddata_api_client.models.ranking_filter import RankingFilter +from gooddata_api_client.models.relative_date_filter import RelativeDateFilter +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +FILTERDEFINITION_ONE_OF_SCHEMAS = ["AbsoluteDateFilter", "ComparisonMeasureValueFilter", "InlineFilterDefinition", "NegativeAttributeFilter", "PositiveAttributeFilter", "RangeMeasureValueFilter", "RankingFilter", "RelativeDateFilter"] + +class FilterDefinition(BaseModel): + """ + Abstract filter definition type + """ + # data type: InlineFilterDefinition + oneof_schema_1_validator: Optional[InlineFilterDefinition] = None + # data type: RankingFilter + oneof_schema_2_validator: Optional[RankingFilter] = None + # data type: ComparisonMeasureValueFilter + oneof_schema_3_validator: Optional[ComparisonMeasureValueFilter] = None + # data type: RangeMeasureValueFilter + oneof_schema_4_validator: Optional[RangeMeasureValueFilter] = None + # data type: AbsoluteDateFilter + oneof_schema_5_validator: Optional[AbsoluteDateFilter] = None + # data type: RelativeDateFilter + oneof_schema_6_validator: Optional[RelativeDateFilter] = None + # data type: NegativeAttributeFilter + oneof_schema_7_validator: Optional[NegativeAttributeFilter] = None + # data type: PositiveAttributeFilter + oneof_schema_8_validator: Optional[PositiveAttributeFilter] = None + actual_instance: Optional[Union[AbsoluteDateFilter, ComparisonMeasureValueFilter, InlineFilterDefinition, NegativeAttributeFilter, PositiveAttributeFilter, RangeMeasureValueFilter, RankingFilter, RelativeDateFilter]] = None + one_of_schemas: Set[str] = { "AbsoluteDateFilter", "ComparisonMeasureValueFilter", "InlineFilterDefinition", "NegativeAttributeFilter", "PositiveAttributeFilter", "RangeMeasureValueFilter", "RankingFilter", "RelativeDateFilter" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = FilterDefinition.model_construct() + error_messages = [] + match = 0 + # validate data type: InlineFilterDefinition + if not isinstance(v, InlineFilterDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `InlineFilterDefinition`") + else: + match += 1 + # validate data type: RankingFilter + if not isinstance(v, RankingFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `RankingFilter`") + else: + match += 1 + # validate data type: ComparisonMeasureValueFilter + if not isinstance(v, ComparisonMeasureValueFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `ComparisonMeasureValueFilter`") + else: + match += 1 + # validate data type: RangeMeasureValueFilter + if not isinstance(v, RangeMeasureValueFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `RangeMeasureValueFilter`") + else: + match += 1 + # validate data type: AbsoluteDateFilter + if not isinstance(v, AbsoluteDateFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `AbsoluteDateFilter`") + else: + match += 1 + # validate data type: RelativeDateFilter + if not isinstance(v, RelativeDateFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `RelativeDateFilter`") + else: + match += 1 + # validate data type: NegativeAttributeFilter + if not isinstance(v, NegativeAttributeFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `NegativeAttributeFilter`") + else: + match += 1 + # validate data type: PositiveAttributeFilter + if not isinstance(v, PositiveAttributeFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `PositiveAttributeFilter`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in FilterDefinition with oneOf schemas: AbsoluteDateFilter, ComparisonMeasureValueFilter, InlineFilterDefinition, NegativeAttributeFilter, PositiveAttributeFilter, RangeMeasureValueFilter, RankingFilter, RelativeDateFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in FilterDefinition with oneOf schemas: AbsoluteDateFilter, ComparisonMeasureValueFilter, InlineFilterDefinition, NegativeAttributeFilter, PositiveAttributeFilter, RangeMeasureValueFilter, RankingFilter, RelativeDateFilter. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into InlineFilterDefinition + try: + instance.actual_instance = InlineFilterDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RankingFilter + try: + instance.actual_instance = RankingFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into ComparisonMeasureValueFilter + try: + instance.actual_instance = ComparisonMeasureValueFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RangeMeasureValueFilter + try: + instance.actual_instance = RangeMeasureValueFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into AbsoluteDateFilter + try: + instance.actual_instance = AbsoluteDateFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RelativeDateFilter + try: + instance.actual_instance = RelativeDateFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into NegativeAttributeFilter + try: + instance.actual_instance = NegativeAttributeFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into PositiveAttributeFilter + try: + instance.actual_instance = PositiveAttributeFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into FilterDefinition with oneOf schemas: AbsoluteDateFilter, ComparisonMeasureValueFilter, InlineFilterDefinition, NegativeAttributeFilter, PositiveAttributeFilter, RangeMeasureValueFilter, RankingFilter, RelativeDateFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into FilterDefinition with oneOf schemas: AbsoluteDateFilter, ComparisonMeasureValueFilter, InlineFilterDefinition, NegativeAttributeFilter, PositiveAttributeFilter, RangeMeasureValueFilter, RankingFilter, RelativeDateFilter. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], AbsoluteDateFilter, ComparisonMeasureValueFilter, InlineFilterDefinition, NegativeAttributeFilter, PositiveAttributeFilter, RangeMeasureValueFilter, RankingFilter, RelativeDateFilter]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/filter_definition_for_simple_measure.py b/gooddata-api-client/gooddata_api_client/models/filter_definition_for_simple_measure.py new file mode 100644 index 000000000..8dfd2cb50 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/filter_definition_for_simple_measure.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.attribute_filter import AttributeFilter +from gooddata_api_client.models.date_filter import DateFilter +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +FILTERDEFINITIONFORSIMPLEMEASURE_ONE_OF_SCHEMAS = ["AttributeFilter", "DateFilter"] + +class FilterDefinitionForSimpleMeasure(BaseModel): + """ + Abstract filter definition type for simple metric. + """ + # data type: DateFilter + oneof_schema_1_validator: Optional[DateFilter] = None + # data type: AttributeFilter + oneof_schema_2_validator: Optional[AttributeFilter] = None + actual_instance: Optional[Union[AttributeFilter, DateFilter]] = None + one_of_schemas: Set[str] = { "AttributeFilter", "DateFilter" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = FilterDefinitionForSimpleMeasure.model_construct() + error_messages = [] + match = 0 + # validate data type: DateFilter + if not isinstance(v, DateFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `DateFilter`") + else: + match += 1 + # validate data type: AttributeFilter + if not isinstance(v, AttributeFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `AttributeFilter`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in FilterDefinitionForSimpleMeasure with oneOf schemas: AttributeFilter, DateFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in FilterDefinitionForSimpleMeasure with oneOf schemas: AttributeFilter, DateFilter. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into DateFilter + try: + instance.actual_instance = DateFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into AttributeFilter + try: + instance.actual_instance = AttributeFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into FilterDefinitionForSimpleMeasure with oneOf schemas: AttributeFilter, DateFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into FilterDefinitionForSimpleMeasure with oneOf schemas: AttributeFilter, DateFilter. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], AttributeFilter, DateFilter]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/forecast_request.py b/gooddata-api-client/gooddata_api_client/models/forecast_request.py new file mode 100644 index 000000000..2eccd2067 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/forecast_request.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class ForecastRequest(BaseModel): + """ + ForecastRequest + """ # noqa: E501 + confidence_level: Optional[Union[Annotated[float, Field(lt=1.0, strict=True, gt=0.0)], Annotated[int, Field(lt=1, strict=True, gt=0)]]] = Field(default=0.95, description="Confidence interval boundary value.", alias="confidenceLevel") + forecast_period: StrictInt = Field(description="Number of future periods that should be forecasted", alias="forecastPeriod") + seasonal: Optional[StrictBool] = Field(default=False, description="Whether the input data is seasonal") + __properties: ClassVar[List[str]] = ["confidenceLevel", "forecastPeriod", "seasonal"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ForecastRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ForecastRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "confidenceLevel": obj.get("confidenceLevel") if obj.get("confidenceLevel") is not None else 0.95, + "forecastPeriod": obj.get("forecastPeriod"), + "seasonal": obj.get("seasonal") if obj.get("seasonal") is not None else False + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/forecast_result.py b/gooddata-api-client/gooddata_api_client/models/forecast_result.py new file mode 100644 index 000000000..6756ffbd1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/forecast_result.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class ForecastResult(BaseModel): + """ + ForecastResult + """ # noqa: E501 + attribute: List[StrictStr] + lower_bound: List[Optional[Union[StrictFloat, StrictInt]]] = Field(alias="lowerBound") + origin: List[Optional[Union[StrictFloat, StrictInt]]] + prediction: List[Optional[Union[StrictFloat, StrictInt]]] + upper_bound: List[Optional[Union[StrictFloat, StrictInt]]] = Field(alias="upperBound") + __properties: ClassVar[List[str]] = ["attribute", "lowerBound", "origin", "prediction", "upperBound"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ForecastResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ForecastResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attribute": obj.get("attribute"), + "lowerBound": obj.get("lowerBound"), + "origin": obj.get("origin"), + "prediction": obj.get("prediction"), + "upperBound": obj.get("upperBound") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/found_objects.py b/gooddata-api-client/gooddata_api_client/models/found_objects.py new file mode 100644 index 000000000..b3c710ec5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/found_objects.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.search_result_object import SearchResultObject +from typing import Optional, Set +from typing_extensions import Self + +class FoundObjects(BaseModel): + """ + List of objects found by similarity search and post-processed by LLM. + """ # noqa: E501 + objects: List[SearchResultObject] = Field(description="List of objects found with a similarity search.") + reasoning: StrictStr = Field(description="Reasoning from LLM. Description of how and why the answer was generated.") + __properties: ClassVar[List[str]] = ["objects", "reasoning"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FoundObjects from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in objects (list) + _items = [] + if self.objects: + for _item_objects in self.objects: + if _item_objects: + _items.append(_item_objects.to_dict()) + _dict['objects'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FoundObjects from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objects": [SearchResultObject.from_dict(_item) for _item in obj["objects"]] if obj.get("objects") is not None else None, + "reasoning": obj.get("reasoning") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/frequency.py b/gooddata-api-client/gooddata_api_client/models/frequency.py new file mode 100644 index 000000000..04c3deaa6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/frequency.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.frequency_bucket import FrequencyBucket +from typing import Optional, Set +from typing_extensions import Self + +class Frequency(BaseModel): + """ + Frequency + """ # noqa: E501 + buckets: List[FrequencyBucket] + __properties: ClassVar[List[str]] = ["buckets"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Frequency from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in buckets (list) + _items = [] + if self.buckets: + for _item_buckets in self.buckets: + if _item_buckets: + _items.append(_item_buckets.to_dict()) + _dict['buckets'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Frequency from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "buckets": [FrequencyBucket.from_dict(_item) for _item in obj["buckets"]] if obj.get("buckets") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/frequency_bucket.py b/gooddata-api-client/gooddata_api_client/models/frequency_bucket.py new file mode 100644 index 000000000..47026650b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/frequency_bucket.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class FrequencyBucket(BaseModel): + """ + FrequencyBucket + """ # noqa: E501 + count: StrictInt + value: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["count", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FrequencyBucket from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FrequencyBucket from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "count": obj.get("count"), + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/frequency_properties.py b/gooddata-api-client/gooddata_api_client/models/frequency_properties.py new file mode 100644 index 000000000..838374542 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/frequency_properties.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class FrequencyProperties(BaseModel): + """ + FrequencyProperties + """ # noqa: E501 + value_limit: Optional[StrictInt] = Field(default=10, description="The maximum number of distinct values to return.", alias="valueLimit") + __properties: ClassVar[List[str]] = ["valueLimit"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FrequencyProperties from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FrequencyProperties from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "valueLimit": obj.get("valueLimit") if obj.get("valueLimit") is not None else 10 + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/generate_ldm_request.py b/gooddata-api-client/gooddata_api_client/models/generate_ldm_request.py new file mode 100644 index 000000000..59a6bd715 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/generate_ldm_request.py @@ -0,0 +1,126 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.pdm_ldm_request import PdmLdmRequest +from typing import Optional, Set +from typing_extensions import Self + +class GenerateLdmRequest(BaseModel): + """ + A request containing all information needed for generation of logical model. + """ # noqa: E501 + aggregated_fact_prefix: Optional[StrictStr] = Field(default=None, description="Columns starting with this prefix will be considered as aggregated facts. The prefix is then followed by the value of `separator` parameter. Given the aggregated fact prefix is `aggr` and separator is `__`, the columns with name like `aggr__sum__product__sold` will be considered as aggregated sold fact in the product table with SUM aggregate function.", alias="aggregatedFactPrefix") + date_granularities: Optional[StrictStr] = Field(default=None, description="Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is `all` which enables all available date granularities, including time granularities (like hours, minutes).", alias="dateGranularities") + denorm_prefix: Optional[StrictStr] = Field(default=None, description="Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of `separator` parameter. Given the denormalization reference prefix is `dr` and separator is `__`, the columns with name like `dr__customer_name` will be considered as denormalization references.", alias="denormPrefix") + fact_prefix: Optional[StrictStr] = Field(default=None, description="Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of `separator` parameter. Given the fact prefix is `f` and separator is `__`, the columns with name like `f__sold` will be considered as facts.", alias="factPrefix") + generate_long_ids: Optional[StrictBool] = Field(default=False, description="A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `
.` is used. If the flag is set to true, then all ids will be generated in the long form.", alias="generateLongIds") + grain_multivalue_reference_prefix: Optional[StrictStr] = Field(default=None, description="Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `grmr` and separator is `__`, the columns with name like `grmr__customer__customer_id` will be considered as grain multivalue references to customer_id in customer table.", alias="grainMultivalueReferencePrefix") + grain_prefix: Optional[StrictStr] = Field(default=None, description="Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of `separator` parameter. Given the grain prefix is `gr` and separator is `__`, the columns with name like `gr__name` will be considered as grains.", alias="grainPrefix") + grain_reference_prefix: Optional[StrictStr] = Field(default=None, description="Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `grr` and separator is `__`, the columns with name like `grr__customer__customer_id` will be considered as grain references to customer_id in customer table.", alias="grainReferencePrefix") + multivalue_reference_prefix: Optional[StrictStr] = Field(default=None, description="Columns starting with this prefix will be considered as multivalue references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `mr` and separator is `__`, the columns with name like `mr__customer__customer_id` will be considered as multivalue references to customer_id in customer table.", alias="multivalueReferencePrefix") + pdm: Optional[PdmLdmRequest] = None + primary_label_prefix: Optional[StrictStr] = Field(default=None, description="Columns starting with this prefix will be considered as primary labels. The prefix is then followed by the value of `separator` parameter. Given the primary label prefix is `pl` and separator is `__`, the columns with name like `pl__country_id` will be considered as primary labels.", alias="primaryLabelPrefix") + reference_prefix: Optional[StrictStr] = Field(default=None, description="Columns starting with this prefix will be considered as references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `r` and separator is `__`, the columns with name like `r__customer__customer_id` will be considered as references to customer_id in customer table.", alias="referencePrefix") + secondary_label_prefix: Optional[StrictStr] = Field(default=None, description="Columns starting with this prefix will be considered as secondary labels. The prefix is then followed by the value of `separator` parameter. Given the secondary label prefix is `ls` and separator is `__`, the columns with name like `ls__country_id__country_name` will be considered as secondary labels.", alias="secondaryLabelPrefix") + separator: Optional[StrictStr] = Field(default='__', description="A separator between prefixes and the names. Default is \"__\".") + table_prefix: Optional[StrictStr] = Field(default=None, description="Tables starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.", alias="tablePrefix") + view_prefix: Optional[StrictStr] = Field(default=None, description="Views starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.", alias="viewPrefix") + wdf_prefix: Optional[StrictStr] = Field(default='wdf', description="Column serving as workspace data filter. No labels are auto generated for such columns.", alias="wdfPrefix") + workspace_id: Optional[StrictStr] = Field(default=None, description="Optional workspace id.", alias="workspaceId") + __properties: ClassVar[List[str]] = ["aggregatedFactPrefix", "dateGranularities", "denormPrefix", "factPrefix", "generateLongIds", "grainMultivalueReferencePrefix", "grainPrefix", "grainReferencePrefix", "multivalueReferencePrefix", "pdm", "primaryLabelPrefix", "referencePrefix", "secondaryLabelPrefix", "separator", "tablePrefix", "viewPrefix", "wdfPrefix", "workspaceId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GenerateLdmRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of pdm + if self.pdm: + _dict['pdm'] = self.pdm.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GenerateLdmRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "aggregatedFactPrefix": obj.get("aggregatedFactPrefix"), + "dateGranularities": obj.get("dateGranularities"), + "denormPrefix": obj.get("denormPrefix"), + "factPrefix": obj.get("factPrefix"), + "generateLongIds": obj.get("generateLongIds") if obj.get("generateLongIds") is not None else False, + "grainMultivalueReferencePrefix": obj.get("grainMultivalueReferencePrefix"), + "grainPrefix": obj.get("grainPrefix"), + "grainReferencePrefix": obj.get("grainReferencePrefix"), + "multivalueReferencePrefix": obj.get("multivalueReferencePrefix"), + "pdm": PdmLdmRequest.from_dict(obj["pdm"]) if obj.get("pdm") is not None else None, + "primaryLabelPrefix": obj.get("primaryLabelPrefix"), + "referencePrefix": obj.get("referencePrefix"), + "secondaryLabelPrefix": obj.get("secondaryLabelPrefix"), + "separator": obj.get("separator") if obj.get("separator") is not None else '__', + "tablePrefix": obj.get("tablePrefix"), + "viewPrefix": obj.get("viewPrefix"), + "wdfPrefix": obj.get("wdfPrefix") if obj.get("wdfPrefix") is not None else 'wdf', + "workspaceId": obj.get("workspaceId") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/get_image_export202_response_inner.py b/gooddata-api-client/gooddata_api_client/models/get_image_export202_response_inner.py new file mode 100644 index 000000000..e6ae7c919 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/get_image_export202_response_inner.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class GetImageExport202ResponseInner(BaseModel): + """ + GetImageExport202ResponseInner + """ # noqa: E501 + char: Optional[StrictStr] = None + direct: Optional[StrictBool] = None + double: Optional[Union[StrictFloat, StrictInt]] = None + var_float: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="float") + int: Optional[StrictInt] = None + long: Optional[StrictInt] = None + read_only: Optional[StrictBool] = Field(default=None, alias="readOnly") + short: Optional[StrictInt] = None + __properties: ClassVar[List[str]] = ["char", "direct", "double", "float", "int", "long", "readOnly", "short"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetImageExport202ResponseInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetImageExport202ResponseInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "char": obj.get("char"), + "direct": obj.get("direct"), + "double": obj.get("double"), + "float": obj.get("float"), + "int": obj.get("int"), + "long": obj.get("long"), + "readOnly": obj.get("readOnly"), + "short": obj.get("short") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/get_quality_issues_response.py b/gooddata-api-client/gooddata_api_client/models/get_quality_issues_response.py new file mode 100644 index 000000000..39cf661d7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/get_quality_issues_response.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.quality_issue import QualityIssue +from typing import Optional, Set +from typing_extensions import Self + +class GetQualityIssuesResponse(BaseModel): + """ + GetQualityIssuesResponse + """ # noqa: E501 + issues: List[QualityIssue] + __properties: ClassVar[List[str]] = ["issues"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetQualityIssuesResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in issues (list) + _items = [] + if self.issues: + for _item_issues in self.issues: + if _item_issues: + _items.append(_item_issues.to_dict()) + _dict['issues'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetQualityIssuesResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "issues": [QualityIssue.from_dict(_item) for _item in obj["issues"]] if obj.get("issues") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/grain_identifier.py b/gooddata-api-client/gooddata_api_client/models/grain_identifier.py new file mode 100644 index 000000000..fd1963bda --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/grain_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class GrainIdentifier(BaseModel): + """ + A grain identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Grain ID.") + type: StrictStr = Field(description="A type of the grain.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attribute', 'date']): + raise ValueError("must be one of enum values ('attribute', 'date')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GrainIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GrainIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/granted_permission.py b/gooddata-api-client/gooddata_api_client/models/granted_permission.py new file mode 100644 index 000000000..5f4e3f10a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/granted_permission.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class GrantedPermission(BaseModel): + """ + Permissions granted to the user group + """ # noqa: E501 + level: StrictStr = Field(description="Level of permission") + source: StrictStr = Field(description="Source of permission") + __properties: ClassVar[List[str]] = ["level", "source"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GrantedPermission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GrantedPermission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "level": obj.get("level"), + "source": obj.get("source") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/granularities_formatting.py b/gooddata-api-client/gooddata_api_client/models/granularities_formatting.py new file mode 100644 index 000000000..267a0aab8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/granularities_formatting.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class GranularitiesFormatting(BaseModel): + """ + A date dataset granularities title formatting rules. + """ # noqa: E501 + title_base: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Title base is used as a token in title pattern. If left empty, it is replaced by date dataset title.", alias="titleBase") + title_pattern: Annotated[str, Field(strict=True, max_length=255)] = Field(description="This pattern is used to generate the title of attributes and labels that result from the granularities. There are two tokens available: * `%titleBase` - represents shared part by all titles, or title of Date Dataset if left empty * `%granularityTitle` - represents `DateGranularity` built-in title", alias="titlePattern") + __properties: ClassVar[List[str]] = ["titleBase", "titlePattern"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GranularitiesFormatting from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GranularitiesFormatting from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "titleBase": obj.get("titleBase"), + "titlePattern": obj.get("titlePattern") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/header_group.py b/gooddata-api-client/gooddata_api_client/models/header_group.py new file mode 100644 index 000000000..513f55301 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/header_group.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.execution_result_header import ExecutionResultHeader +from typing import Optional, Set +from typing_extensions import Self + +class HeaderGroup(BaseModel): + """ + Contains the information specific for a group of headers. These groups correlate to attributes and metric groups. + """ # noqa: E501 + headers: List[ExecutionResultHeader] = Field(description="An array containing headers.") + __properties: ClassVar[List[str]] = ["headers"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of HeaderGroup from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in headers (list) + _items = [] + if self.headers: + for _item_headers in self.headers: + if _item_headers: + _items.append(_item_headers.to_dict()) + _dict['headers'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of HeaderGroup from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "headers": [ExecutionResultHeader.from_dict(_item) for _item in obj["headers"]] if obj.get("headers") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/hierarchy_object_identification.py b/gooddata-api-client/gooddata_api_client/models/hierarchy_object_identification.py new file mode 100644 index 000000000..45a78f0ad --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/hierarchy_object_identification.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class HierarchyObjectIdentification(BaseModel): + """ + Represents objects with given ID and type in workspace hierarchy (more than one can exists in different workspaces). + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard', 'attribute', 'dashboardPlugin', 'dataset', 'fact', 'label', 'metric', 'prompt', 'visualizationObject', 'filterContext', 'workspaceDataFilter', 'workspaceDataFilterSettings']): + raise ValueError("must be one of enum values ('analyticalDashboard', 'attribute', 'dashboardPlugin', 'dataset', 'fact', 'label', 'metric', 'prompt', 'visualizationObject', 'filterContext', 'workspaceDataFilter', 'workspaceDataFilterSettings')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of HierarchyObjectIdentification from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of HierarchyObjectIdentification from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/histogram.py b/gooddata-api-client/gooddata_api_client/models/histogram.py new file mode 100644 index 000000000..77e5fb423 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/histogram.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.histogram_bucket import HistogramBucket +from typing import Optional, Set +from typing_extensions import Self + +class Histogram(BaseModel): + """ + Histogram + """ # noqa: E501 + buckets: List[HistogramBucket] + __properties: ClassVar[List[str]] = ["buckets"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Histogram from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in buckets (list) + _items = [] + if self.buckets: + for _item_buckets in self.buckets: + if _item_buckets: + _items.append(_item_buckets.to_dict()) + _dict['buckets'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Histogram from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "buckets": [HistogramBucket.from_dict(_item) for _item in obj["buckets"]] if obj.get("buckets") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/histogram_bucket.py b/gooddata-api-client/gooddata_api_client/models/histogram_bucket.py new file mode 100644 index 000000000..93c33c779 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/histogram_bucket.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt +from typing import Any, ClassVar, Dict, List, Union +from typing import Optional, Set +from typing_extensions import Self + +class HistogramBucket(BaseModel): + """ + HistogramBucket + """ # noqa: E501 + count: StrictInt + lower_bound: Union[StrictFloat, StrictInt] = Field(alias="lowerBound") + upper_bound: Union[StrictFloat, StrictInt] = Field(alias="upperBound") + __properties: ClassVar[List[str]] = ["count", "lowerBound", "upperBound"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of HistogramBucket from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of HistogramBucket from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "count": obj.get("count"), + "lowerBound": obj.get("lowerBound"), + "upperBound": obj.get("upperBound") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/histogram_properties.py b/gooddata-api-client/gooddata_api_client/models/histogram_properties.py new file mode 100644 index 000000000..a2edfe661 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/histogram_properties.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class HistogramProperties(BaseModel): + """ + HistogramProperties + """ # noqa: E501 + bucket_count: StrictInt = Field(alias="bucketCount") + __properties: ClassVar[List[str]] = ["bucketCount"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of HistogramProperties from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of HistogramProperties from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "bucketCount": obj.get("bucketCount") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/identifier_duplications.py b/gooddata-api-client/gooddata_api_client/models/identifier_duplications.py new file mode 100644 index 000000000..9cb7db00e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/identifier_duplications.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class IdentifierDuplications(BaseModel): + """ + Contains information about conflicting IDs in workspace hierarchy + """ # noqa: E501 + id: StrictStr + origins: List[StrictStr] + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "origins", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard', 'attribute', 'dashboardPlugin', 'dataset', 'fact', 'label', 'metric', 'prompt', 'visualizationObject', 'filterContext', 'workspaceDataFilter', 'workspaceDataFilterSettings']): + raise ValueError("must be one of enum values ('analyticalDashboard', 'attribute', 'dashboardPlugin', 'dataset', 'fact', 'label', 'metric', 'prompt', 'visualizationObject', 'filterContext', 'workspaceDataFilter', 'workspaceDataFilterSettings')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IdentifierDuplications from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IdentifierDuplications from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "origins": obj.get("origins"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/identifier_ref.py b/gooddata-api-client/gooddata_api_client/models/identifier_ref.py new file mode 100644 index 000000000..afbf958b8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/identifier_ref.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.identifier_ref_identifier import IdentifierRefIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class IdentifierRef(BaseModel): + """ + IdentifierRef + """ # noqa: E501 + identifier: Optional[IdentifierRefIdentifier] = None + __properties: ClassVar[List[str]] = ["identifier"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IdentifierRef from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of identifier + if self.identifier: + _dict['identifier'] = self.identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IdentifierRef from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "identifier": IdentifierRefIdentifier.from_dict(obj["identifier"]) if obj.get("identifier") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/identifier_ref_identifier.py b/gooddata-api-client/gooddata_api_client/models/identifier_ref_identifier.py new file mode 100644 index 000000000..ca1d667fe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/identifier_ref_identifier.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class IdentifierRefIdentifier(BaseModel): + """ + IdentifierRefIdentifier + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard', 'attribute', 'attributeHierarchy', 'dashboardPlugin', 'dataset', 'fact', 'aggregatedFact', 'label', 'metric', 'userDataFilter', 'exportDefinition', 'automation', 'automationResult', 'prompt', 'visualizationObject', 'filterContext', 'workspaceSettings', 'customApplicationSetting', 'workspaceDataFilter', 'workspaceDataFilterSetting', 'filterView']): + raise ValueError("must be one of enum values ('analyticalDashboard', 'attribute', 'attributeHierarchy', 'dashboardPlugin', 'dataset', 'fact', 'aggregatedFact', 'label', 'metric', 'userDataFilter', 'exportDefinition', 'automation', 'automationResult', 'prompt', 'visualizationObject', 'filterContext', 'workspaceSettings', 'customApplicationSetting', 'workspaceDataFilter', 'workspaceDataFilterSetting', 'filterView')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IdentifierRefIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IdentifierRefIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/image_export_request.py b/gooddata-api-client/gooddata_api_client/models/image_export_request.py new file mode 100644 index 000000000..19685589a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/image_export_request.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class ImageExportRequest(BaseModel): + """ + Export request object describing the export properties and metadata for image exports. + """ # noqa: E501 + dashboard_id: StrictStr = Field(description="Dashboard identifier", alias="dashboardId") + file_name: StrictStr = Field(description="File name to be used for retrieving the image document.", alias="fileName") + format: StrictStr = Field(description="Requested resulting file type.") + metadata: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON object") + widget_ids: Annotated[List[Annotated[str, Field(min_length=1, strict=True, max_length=255)]], Field(min_length=1, max_length=1)] = Field(description="List of widget identifiers to be exported. Note that only one widget is currently supported.", alias="widgetIds") + __properties: ClassVar[List[str]] = ["dashboardId", "fileName", "format", "metadata", "widgetIds"] + + @field_validator('format') + def format_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['PNG']): + raise ValueError("must be one of enum values ('PNG')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ImageExportRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ImageExportRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dashboardId": obj.get("dashboardId"), + "fileName": obj.get("fileName"), + "format": obj.get("format"), + "metadata": obj.get("metadata"), + "widgetIds": obj.get("widgetIds") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/in_platform.py b/gooddata-api-client/gooddata_api_client/models/in_platform.py new file mode 100644 index 000000000..a60abba96 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/in_platform.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class InPlatform(BaseModel): + """ + In-platform destination for notifications. + """ # noqa: E501 + type: StrictStr = Field(description="The destination type.") + __properties: ClassVar[List[str]] = ["type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['IN_PLATFORM']): + raise ValueError("must be one of enum values ('IN_PLATFORM')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of InPlatform from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of InPlatform from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/inline_filter_definition.py b/gooddata-api-client/gooddata_api_client/models/inline_filter_definition.py new file mode 100644 index 000000000..4dbc5d839 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/inline_filter_definition.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.inline_filter_definition_inline import InlineFilterDefinitionInline +from typing import Optional, Set +from typing_extensions import Self + +class InlineFilterDefinition(BaseModel): + """ + Filter in form of direct MAQL query. + """ # noqa: E501 + inline: InlineFilterDefinitionInline + __properties: ClassVar[List[str]] = ["inline"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of InlineFilterDefinition from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of inline + if self.inline: + _dict['inline'] = self.inline.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of InlineFilterDefinition from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "inline": InlineFilterDefinitionInline.from_dict(obj["inline"]) if obj.get("inline") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/inline_filter_definition_inline.py b/gooddata-api-client/gooddata_api_client/models/inline_filter_definition_inline.py new file mode 100644 index 000000000..2cee65591 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/inline_filter_definition_inline.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class InlineFilterDefinitionInline(BaseModel): + """ + InlineFilterDefinitionInline + """ # noqa: E501 + apply_on_result: Optional[StrictBool] = Field(default=None, alias="applyOnResult") + filter: StrictStr = Field(description="MAQL query representing the filter.") + local_identifier: Optional[StrictStr] = Field(default=None, alias="localIdentifier") + __properties: ClassVar[List[str]] = ["applyOnResult", "filter", "localIdentifier"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of InlineFilterDefinitionInline from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of InlineFilterDefinitionInline from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applyOnResult": obj.get("applyOnResult"), + "filter": obj.get("filter"), + "localIdentifier": obj.get("localIdentifier") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/inline_measure_definition.py b/gooddata-api-client/gooddata_api_client/models/inline_measure_definition.py new file mode 100644 index 000000000..529c72577 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/inline_measure_definition.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.inline_measure_definition_inline import InlineMeasureDefinitionInline +from typing import Optional, Set +from typing_extensions import Self + +class InlineMeasureDefinition(BaseModel): + """ + Metric defined by the raw MAQL query. + """ # noqa: E501 + inline: InlineMeasureDefinitionInline + __properties: ClassVar[List[str]] = ["inline"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of InlineMeasureDefinition from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of inline + if self.inline: + _dict['inline'] = self.inline.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of InlineMeasureDefinition from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "inline": InlineMeasureDefinitionInline.from_dict(obj["inline"]) if obj.get("inline") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/inline_measure_definition_inline.py b/gooddata-api-client/gooddata_api_client/models/inline_measure_definition_inline.py new file mode 100644 index 000000000..a18070193 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/inline_measure_definition_inline.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class InlineMeasureDefinitionInline(BaseModel): + """ + InlineMeasureDefinitionInline + """ # noqa: E501 + maql: StrictStr = Field(description="MAQL query defining the metric.") + __properties: ClassVar[List[str]] = ["maql"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of InlineMeasureDefinitionInline from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of InlineMeasureDefinitionInline from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "maql": obj.get("maql") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/intro_slide_template.py b/gooddata-api-client/gooddata_api_client/models/intro_slide_template.py new file mode 100644 index 000000000..f21305238 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/intro_slide_template.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.running_section import RunningSection +from typing import Optional, Set +from typing_extensions import Self + +class IntroSlideTemplate(BaseModel): + """ + Settings for intro slide. + """ # noqa: E501 + background_image: Optional[StrictBool] = Field(default=True, description="Show background image on the slide.", alias="backgroundImage") + description_field: Optional[StrictStr] = Field(default=None, alias="descriptionField") + footer: Optional[RunningSection] = None + header: Optional[RunningSection] = None + title_field: Optional[StrictStr] = Field(default=None, alias="titleField") + __properties: ClassVar[List[str]] = ["backgroundImage", "descriptionField", "footer", "header", "titleField"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IntroSlideTemplate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of footer + if self.footer: + _dict['footer'] = self.footer.to_dict() + # override the default output from pydantic by calling `to_dict()` of header + if self.header: + _dict['header'] = self.header.to_dict() + # set to None if description_field (nullable) is None + # and model_fields_set contains the field + if self.description_field is None and "description_field" in self.model_fields_set: + _dict['descriptionField'] = None + + # set to None if footer (nullable) is None + # and model_fields_set contains the field + if self.footer is None and "footer" in self.model_fields_set: + _dict['footer'] = None + + # set to None if header (nullable) is None + # and model_fields_set contains the field + if self.header is None and "header" in self.model_fields_set: + _dict['header'] = None + + # set to None if title_field (nullable) is None + # and model_fields_set contains the field + if self.title_field is None and "title_field" in self.model_fields_set: + _dict['titleField'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IntroSlideTemplate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "backgroundImage": obj.get("backgroundImage") if obj.get("backgroundImage") is not None else True, + "descriptionField": obj.get("descriptionField"), + "footer": RunningSection.from_dict(obj["footer"]) if obj.get("footer") is not None else None, + "header": RunningSection.from_dict(obj["header"]) if obj.get("header") is not None else None, + "titleField": obj.get("titleField") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_linkage.py new file mode 100644 index 000000000..c59a1e0a9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['aggregatedFact']): + raise ValueError("must be one of enum values ('aggregatedFact')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out.py new file mode 100644 index 000000000..cccebed19 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_attributes import JsonApiAggregatedFactOutAttributes +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships import JsonApiAggregatedFactOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactOut(BaseModel): + """ + JSON:API representation of aggregatedFact entity. + """ # noqa: E501 + attributes: JsonApiAggregatedFactOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiAggregatedFactOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['aggregatedFact']): + raise ValueError("must be one of enum values ('aggregatedFact')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAggregatedFactOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiAggregatedFactOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_attributes.py new file mode 100644 index 000000000..88555036d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_attributes.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactOutAttributes(BaseModel): + """ + JsonApiAggregatedFactOutAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + operation: StrictStr + source_column: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="sourceColumn") + source_column_data_type: Optional[StrictStr] = Field(default=None, alias="sourceColumnDataType") + tags: Optional[List[StrictStr]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "description", "operation", "sourceColumn", "sourceColumnDataType", "tags"] + + @field_validator('operation') + def operation_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['SUM', 'MIN', 'MAX']): + raise ValueError("must be one of enum values ('SUM', 'MIN', 'MAX')") + return value + + @field_validator('source_column_data_type') + def source_column_data_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "description": obj.get("description"), + "operation": obj.get("operation"), + "sourceColumn": obj.get("sourceColumn"), + "sourceColumnDataType": obj.get("sourceColumnDataType"), + "tags": obj.get("tags") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_document.py new file mode 100644 index 000000000..cd39ae5a7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out import JsonApiAggregatedFactOut +from gooddata_api_client.models.json_api_aggregated_fact_out_includes import JsonApiAggregatedFactOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactOutDocument(BaseModel): + """ + JsonApiAggregatedFactOutDocument + """ # noqa: E501 + data: JsonApiAggregatedFactOut + included: Optional[List[JsonApiAggregatedFactOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAggregatedFactOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiAggregatedFactOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_includes.py new file mode 100644 index 000000000..d0e20452e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_includes.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIAGGREGATEDFACTOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiDatasetOutWithLinks", "JsonApiFactOutWithLinks"] + +class JsonApiAggregatedFactOutIncludes(BaseModel): + """ + JsonApiAggregatedFactOutIncludes + """ + # data type: JsonApiDatasetOutWithLinks + oneof_schema_1_validator: Optional[JsonApiDatasetOutWithLinks] = None + # data type: JsonApiFactOutWithLinks + oneof_schema_2_validator: Optional[JsonApiFactOutWithLinks] = None + actual_instance: Optional[Union[JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiDatasetOutWithLinks", "JsonApiFactOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiAggregatedFactOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiDatasetOutWithLinks + if not isinstance(v, JsonApiDatasetOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiDatasetOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiFactOutWithLinks + if not isinstance(v, JsonApiFactOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiFactOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiAggregatedFactOutIncludes with oneOf schemas: JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiAggregatedFactOutIncludes with oneOf schemas: JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiDatasetOutWithLinks + try: + instance.actual_instance = JsonApiDatasetOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiFactOutWithLinks + try: + instance.actual_instance = JsonApiFactOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiAggregatedFactOutIncludes with oneOf schemas: JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiAggregatedFactOutIncludes with oneOf schemas: JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_list.py new file mode 100644 index 000000000..7cce60031 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_includes import JsonApiAggregatedFactOutIncludes +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_aggregated_fact_out_with_links import JsonApiAggregatedFactOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiAggregatedFactOutWithLinks] + included: Optional[List[JsonApiAggregatedFactOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiAggregatedFactOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiAggregatedFactOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_list_meta.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_list_meta.py new file mode 100644 index 000000000..0d249165e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_list_meta.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.page_metadata import PageMetadata +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactOutListMeta(BaseModel): + """ + JsonApiAggregatedFactOutListMeta + """ # noqa: E501 + page: Optional[PageMetadata] = None + __properties: ClassVar[List[str]] = ["page"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutListMeta from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of page + if self.page: + _dict['page'] = self.page.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutListMeta from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "page": PageMetadata.from_dict(obj["page"]) if obj.get("page") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_meta.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_meta.py new file mode 100644 index 000000000..6d1f77e22 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_meta.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_meta_origin import JsonApiAggregatedFactOutMetaOrigin +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactOutMeta(BaseModel): + """ + JsonApiAggregatedFactOutMeta + """ # noqa: E501 + origin: Optional[JsonApiAggregatedFactOutMetaOrigin] = None + __properties: ClassVar[List[str]] = ["origin"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutMeta from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of origin + if self.origin: + _dict['origin'] = self.origin.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutMeta from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "origin": JsonApiAggregatedFactOutMetaOrigin.from_dict(obj["origin"]) if obj.get("origin") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_meta_origin.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_meta_origin.py new file mode 100644 index 000000000..22afe98cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_meta_origin.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactOutMetaOrigin(BaseModel): + """ + JsonApiAggregatedFactOutMetaOrigin + """ # noqa: E501 + origin_id: StrictStr = Field(description="defines id of the workspace where the entity comes from", alias="originId") + origin_type: StrictStr = Field(description="defines type of the origin of the entity", alias="originType") + __properties: ClassVar[List[str]] = ["originId", "originType"] + + @field_validator('origin_type') + def origin_type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['NATIVE', 'PARENT']): + raise ValueError("must be one of enum values ('NATIVE', 'PARENT')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutMetaOrigin from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutMetaOrigin from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "originId": obj.get("originId"), + "originType": obj.get("originType") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_relationships.py new file mode 100644 index 000000000..6ca454984 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_relationships.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships_dataset import JsonApiAggregatedFactOutRelationshipsDataset +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships_source_fact import JsonApiAggregatedFactOutRelationshipsSourceFact +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactOutRelationships(BaseModel): + """ + JsonApiAggregatedFactOutRelationships + """ # noqa: E501 + dataset: Optional[JsonApiAggregatedFactOutRelationshipsDataset] = None + source_fact: Optional[JsonApiAggregatedFactOutRelationshipsSourceFact] = Field(default=None, alias="sourceFact") + __properties: ClassVar[List[str]] = ["dataset", "sourceFact"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dataset + if self.dataset: + _dict['dataset'] = self.dataset.to_dict() + # override the default output from pydantic by calling `to_dict()` of source_fact + if self.source_fact: + _dict['sourceFact'] = self.source_fact.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataset": JsonApiAggregatedFactOutRelationshipsDataset.from_dict(obj["dataset"]) if obj.get("dataset") is not None else None, + "sourceFact": JsonApiAggregatedFactOutRelationshipsSourceFact.from_dict(obj["sourceFact"]) if obj.get("sourceFact") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_relationships_dataset.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_relationships_dataset.py new file mode 100644 index 000000000..0376260d1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_relationships_dataset.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactOutRelationshipsDataset(BaseModel): + """ + JsonApiAggregatedFactOutRelationshipsDataset + """ # noqa: E501 + data: Optional[JsonApiDatasetToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutRelationshipsDataset from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutRelationshipsDataset from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiDatasetToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_relationships_source_fact.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_relationships_source_fact.py new file mode 100644 index 000000000..6c0685a13 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_relationships_source_fact.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_fact_to_one_linkage import JsonApiFactToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactOutRelationshipsSourceFact(BaseModel): + """ + JsonApiAggregatedFactOutRelationshipsSourceFact + """ # noqa: E501 + data: Optional[JsonApiFactToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutRelationshipsSourceFact from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutRelationshipsSourceFact from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiFactToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_with_links.py new file mode 100644 index 000000000..ea6fb1555 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_aggregated_fact_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_attributes import JsonApiAggregatedFactOutAttributes +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships import JsonApiAggregatedFactOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAggregatedFactOutWithLinks(BaseModel): + """ + JsonApiAggregatedFactOutWithLinks + """ # noqa: E501 + attributes: JsonApiAggregatedFactOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiAggregatedFactOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['aggregatedFact']): + raise ValueError("must be one of enum values ('aggregatedFact')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAggregatedFactOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAggregatedFactOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiAggregatedFactOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_in.py new file mode 100644 index 000000000..c3d99e6a5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardIn(BaseModel): + """ + JSON:API representation of analyticalDashboard entity. + """ # noqa: E501 + attributes: JsonApiAnalyticalDashboardInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard']): + raise ValueError("must be one of enum values ('analyticalDashboard')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAnalyticalDashboardInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_in_attributes.py new file mode 100644 index 000000000..c8f2d1b80 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_in_attributes.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardInAttributes(BaseModel): + """ + JsonApiAnalyticalDashboardInAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Dict[str, Any] = Field(description="Free-form JSON content. Maximum supported length is 250000 characters.") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "description", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "description": obj.get("description"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_in_document.py new file mode 100644 index 000000000..cb51da029 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_analytical_dashboard_in import JsonApiAnalyticalDashboardIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardInDocument(BaseModel): + """ + JsonApiAnalyticalDashboardInDocument + """ # noqa: E501 + data: JsonApiAnalyticalDashboardIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAnalyticalDashboardIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_linkage.py new file mode 100644 index 000000000..bed78f8d6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard']): + raise ValueError("must be one of enum values ('analyticalDashboard')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out.py new file mode 100644 index 000000000..2fa3dac10 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_analytical_dashboard_out_attributes import JsonApiAnalyticalDashboardOutAttributes +from gooddata_api_client.models.json_api_analytical_dashboard_out_meta import JsonApiAnalyticalDashboardOutMeta +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships import JsonApiAnalyticalDashboardOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOut(BaseModel): + """ + JSON:API representation of analyticalDashboard entity. + """ # noqa: E501 + attributes: JsonApiAnalyticalDashboardOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAnalyticalDashboardOutMeta] = None + relationships: Optional[JsonApiAnalyticalDashboardOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard']): + raise ValueError("must be one of enum values ('analyticalDashboard')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAnalyticalDashboardOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAnalyticalDashboardOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiAnalyticalDashboardOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_attributes.py new file mode 100644 index 000000000..f042e5a5b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_attributes.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutAttributes(BaseModel): + """ + JsonApiAnalyticalDashboardOutAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Dict[str, Any] = Field(description="Free-form JSON content. Maximum supported length is 250000 characters.") + created_at: Optional[datetime] = Field(default=None, alias="createdAt") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + modified_at: Optional[datetime] = Field(default=None, alias="modifiedAt") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "createdAt", "description", "modifiedAt", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "createdAt": obj.get("createdAt"), + "description": obj.get("description"), + "modifiedAt": obj.get("modifiedAt"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_document.py new file mode 100644 index 000000000..2284038e3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut +from gooddata_api_client.models.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutDocument(BaseModel): + """ + JsonApiAnalyticalDashboardOutDocument + """ # noqa: E501 + data: JsonApiAnalyticalDashboardOut + included: Optional[List[JsonApiAnalyticalDashboardOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAnalyticalDashboardOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiAnalyticalDashboardOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_includes.py new file mode 100644 index 000000000..90b3842ef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_includes.py @@ -0,0 +1,222 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.models.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.json_api_metric_out_with_links import JsonApiMetricOutWithLinks +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.models.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIANALYTICALDASHBOARDOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiAnalyticalDashboardOutWithLinks", "JsonApiDashboardPluginOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiFilterContextOutWithLinks", "JsonApiLabelOutWithLinks", "JsonApiMetricOutWithLinks", "JsonApiUserIdentifierOutWithLinks", "JsonApiVisualizationObjectOutWithLinks"] + +class JsonApiAnalyticalDashboardOutIncludes(BaseModel): + """ + JsonApiAnalyticalDashboardOutIncludes + """ + # data type: JsonApiUserIdentifierOutWithLinks + oneof_schema_1_validator: Optional[JsonApiUserIdentifierOutWithLinks] = None + # data type: JsonApiVisualizationObjectOutWithLinks + oneof_schema_2_validator: Optional[JsonApiVisualizationObjectOutWithLinks] = None + # data type: JsonApiAnalyticalDashboardOutWithLinks + oneof_schema_3_validator: Optional[JsonApiAnalyticalDashboardOutWithLinks] = None + # data type: JsonApiLabelOutWithLinks + oneof_schema_4_validator: Optional[JsonApiLabelOutWithLinks] = None + # data type: JsonApiMetricOutWithLinks + oneof_schema_5_validator: Optional[JsonApiMetricOutWithLinks] = None + # data type: JsonApiDatasetOutWithLinks + oneof_schema_6_validator: Optional[JsonApiDatasetOutWithLinks] = None + # data type: JsonApiFilterContextOutWithLinks + oneof_schema_7_validator: Optional[JsonApiFilterContextOutWithLinks] = None + # data type: JsonApiDashboardPluginOutWithLinks + oneof_schema_8_validator: Optional[JsonApiDashboardPluginOutWithLinks] = None + actual_instance: Optional[Union[JsonApiAnalyticalDashboardOutWithLinks, JsonApiDashboardPluginOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFilterContextOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiAnalyticalDashboardOutWithLinks", "JsonApiDashboardPluginOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiFilterContextOutWithLinks", "JsonApiLabelOutWithLinks", "JsonApiMetricOutWithLinks", "JsonApiUserIdentifierOutWithLinks", "JsonApiVisualizationObjectOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiAnalyticalDashboardOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiUserIdentifierOutWithLinks + if not isinstance(v, JsonApiUserIdentifierOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserIdentifierOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiVisualizationObjectOutWithLinks + if not isinstance(v, JsonApiVisualizationObjectOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiVisualizationObjectOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAnalyticalDashboardOutWithLinks + if not isinstance(v, JsonApiAnalyticalDashboardOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAnalyticalDashboardOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiLabelOutWithLinks + if not isinstance(v, JsonApiLabelOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiLabelOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiMetricOutWithLinks + if not isinstance(v, JsonApiMetricOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiMetricOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiDatasetOutWithLinks + if not isinstance(v, JsonApiDatasetOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiDatasetOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiFilterContextOutWithLinks + if not isinstance(v, JsonApiFilterContextOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiFilterContextOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiDashboardPluginOutWithLinks + if not isinstance(v, JsonApiDashboardPluginOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiDashboardPluginOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiAnalyticalDashboardOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiDashboardPluginOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFilterContextOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiAnalyticalDashboardOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiDashboardPluginOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFilterContextOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiUserIdentifierOutWithLinks + try: + instance.actual_instance = JsonApiUserIdentifierOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiVisualizationObjectOutWithLinks + try: + instance.actual_instance = JsonApiVisualizationObjectOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAnalyticalDashboardOutWithLinks + try: + instance.actual_instance = JsonApiAnalyticalDashboardOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiLabelOutWithLinks + try: + instance.actual_instance = JsonApiLabelOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiMetricOutWithLinks + try: + instance.actual_instance = JsonApiMetricOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiDatasetOutWithLinks + try: + instance.actual_instance = JsonApiDatasetOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiFilterContextOutWithLinks + try: + instance.actual_instance = JsonApiFilterContextOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiDashboardPluginOutWithLinks + try: + instance.actual_instance = JsonApiDashboardPluginOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiAnalyticalDashboardOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiDashboardPluginOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFilterContextOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiAnalyticalDashboardOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiDashboardPluginOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFilterContextOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAnalyticalDashboardOutWithLinks, JsonApiDashboardPluginOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFilterContextOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_list.py new file mode 100644 index 000000000..7d716abba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes +from gooddata_api_client.models.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiAnalyticalDashboardOutWithLinks] + included: Optional[List[JsonApiAnalyticalDashboardOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiAnalyticalDashboardOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiAnalyticalDashboardOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_meta.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_meta.py new file mode 100644 index 000000000..c13d36740 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_meta.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_meta_origin import JsonApiAggregatedFactOutMetaOrigin +from gooddata_api_client.models.json_api_analytical_dashboard_out_meta_access_info import JsonApiAnalyticalDashboardOutMetaAccessInfo +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutMeta(BaseModel): + """ + JsonApiAnalyticalDashboardOutMeta + """ # noqa: E501 + access_info: Optional[JsonApiAnalyticalDashboardOutMetaAccessInfo] = Field(default=None, alias="accessInfo") + origin: Optional[JsonApiAggregatedFactOutMetaOrigin] = None + permissions: Optional[List[StrictStr]] = Field(default=None, description="List of valid permissions for a logged-in user.") + __properties: ClassVar[List[str]] = ["accessInfo", "origin", "permissions"] + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['EDIT', 'SHARE', 'VIEW']): + raise ValueError("each list item must be one of ('EDIT', 'SHARE', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutMeta from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of access_info + if self.access_info: + _dict['accessInfo'] = self.access_info.to_dict() + # override the default output from pydantic by calling `to_dict()` of origin + if self.origin: + _dict['origin'] = self.origin.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutMeta from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "accessInfo": JsonApiAnalyticalDashboardOutMetaAccessInfo.from_dict(obj["accessInfo"]) if obj.get("accessInfo") is not None else None, + "origin": JsonApiAggregatedFactOutMetaOrigin.from_dict(obj["origin"]) if obj.get("origin") is not None else None, + "permissions": obj.get("permissions") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_meta_access_info.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_meta_access_info.py new file mode 100644 index 000000000..273cfc0a2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_meta_access_info.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutMetaAccessInfo(BaseModel): + """ + JsonApiAnalyticalDashboardOutMetaAccessInfo + """ # noqa: E501 + private: StrictBool = Field(description="is the entity private to the currently logged-in user") + __properties: ClassVar[List[str]] = ["private"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutMetaAccessInfo from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutMetaAccessInfo from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "private": obj.get("private") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships.py new file mode 100644 index 000000000..a499ed347 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships.py @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_analytical_dashboards import JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_dashboard_plugins import JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_filter_contexts import JsonApiAnalyticalDashboardOutRelationshipsFilterContexts +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_visualization_objects import JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutRelationships(BaseModel): + """ + JsonApiAnalyticalDashboardOutRelationships + """ # noqa: E501 + analytical_dashboards: Optional[JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards] = Field(default=None, alias="analyticalDashboards") + created_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="createdBy") + dashboard_plugins: Optional[JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins] = Field(default=None, alias="dashboardPlugins") + datasets: Optional[JsonApiAnalyticalDashboardOutRelationshipsDatasets] = None + filter_contexts: Optional[JsonApiAnalyticalDashboardOutRelationshipsFilterContexts] = Field(default=None, alias="filterContexts") + labels: Optional[JsonApiAnalyticalDashboardOutRelationshipsLabels] = None + metrics: Optional[JsonApiAnalyticalDashboardOutRelationshipsMetrics] = None + modified_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="modifiedBy") + visualization_objects: Optional[JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects] = Field(default=None, alias="visualizationObjects") + __properties: ClassVar[List[str]] = ["analyticalDashboards", "createdBy", "dashboardPlugins", "datasets", "filterContexts", "labels", "metrics", "modifiedBy", "visualizationObjects"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of analytical_dashboards + if self.analytical_dashboards: + _dict['analyticalDashboards'] = self.analytical_dashboards.to_dict() + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of dashboard_plugins + if self.dashboard_plugins: + _dict['dashboardPlugins'] = self.dashboard_plugins.to_dict() + # override the default output from pydantic by calling `to_dict()` of datasets + if self.datasets: + _dict['datasets'] = self.datasets.to_dict() + # override the default output from pydantic by calling `to_dict()` of filter_contexts + if self.filter_contexts: + _dict['filterContexts'] = self.filter_contexts.to_dict() + # override the default output from pydantic by calling `to_dict()` of labels + if self.labels: + _dict['labels'] = self.labels.to_dict() + # override the default output from pydantic by calling `to_dict()` of metrics + if self.metrics: + _dict['metrics'] = self.metrics.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of visualization_objects + if self.visualization_objects: + _dict['visualizationObjects'] = self.visualization_objects.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticalDashboards": JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.from_dict(obj["analyticalDashboards"]) if obj.get("analyticalDashboards") is not None else None, + "createdBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "dashboardPlugins": JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.from_dict(obj["dashboardPlugins"]) if obj.get("dashboardPlugins") is not None else None, + "datasets": JsonApiAnalyticalDashboardOutRelationshipsDatasets.from_dict(obj["datasets"]) if obj.get("datasets") is not None else None, + "filterContexts": JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.from_dict(obj["filterContexts"]) if obj.get("filterContexts") is not None else None, + "labels": JsonApiAnalyticalDashboardOutRelationshipsLabels.from_dict(obj["labels"]) if obj.get("labels") is not None else None, + "metrics": JsonApiAnalyticalDashboardOutRelationshipsMetrics.from_dict(obj["metrics"]) if obj.get("metrics") is not None else None, + "modifiedBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None, + "visualizationObjects": JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.from_dict(obj["visualizationObjects"]) if obj.get("visualizationObjects") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_analytical_dashboards.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_analytical_dashboards.py new file mode 100644 index 000000000..b5cb26db0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_analytical_dashboards.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_analytical_dashboard_linkage import JsonApiAnalyticalDashboardLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards(BaseModel): + """ + JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards + """ # noqa: E501 + data: List[JsonApiAnalyticalDashboardLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiAnalyticalDashboardLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_created_by.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_created_by.py new file mode 100644 index 000000000..9dddb436c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_created_by.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_user_identifier_to_one_linkage import JsonApiUserIdentifierToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutRelationshipsCreatedBy(BaseModel): + """ + JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + """ # noqa: E501 + data: Optional[JsonApiUserIdentifierToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsCreatedBy from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsCreatedBy from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserIdentifierToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_dashboard_plugins.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_dashboard_plugins.py new file mode 100644 index 000000000..8ab940b7a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_dashboard_plugins.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_dashboard_plugin_linkage import JsonApiDashboardPluginLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins(BaseModel): + """ + JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins + """ # noqa: E501 + data: List[JsonApiDashboardPluginLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiDashboardPluginLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_datasets.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_datasets.py new file mode 100644 index 000000000..03df24105 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_datasets.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_dataset_linkage import JsonApiDatasetLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutRelationshipsDatasets(BaseModel): + """ + JsonApiAnalyticalDashboardOutRelationshipsDatasets + """ # noqa: E501 + data: List[JsonApiDatasetLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsDatasets from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsDatasets from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiDatasetLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_filter_contexts.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_filter_contexts.py new file mode 100644 index 000000000..b42ec503b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_filter_contexts.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_filter_context_linkage import JsonApiFilterContextLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutRelationshipsFilterContexts(BaseModel): + """ + JsonApiAnalyticalDashboardOutRelationshipsFilterContexts + """ # noqa: E501 + data: List[JsonApiFilterContextLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsFilterContexts from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsFilterContexts from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiFilterContextLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_labels.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_labels.py new file mode 100644 index 000000000..24fff6634 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_labels.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_label_linkage import JsonApiLabelLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutRelationshipsLabels(BaseModel): + """ + JsonApiAnalyticalDashboardOutRelationshipsLabels + """ # noqa: E501 + data: List[JsonApiLabelLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsLabels from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsLabels from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiLabelLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_metrics.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_metrics.py new file mode 100644 index 000000000..7e916f58d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_metrics.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_metric_linkage import JsonApiMetricLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutRelationshipsMetrics(BaseModel): + """ + JsonApiAnalyticalDashboardOutRelationshipsMetrics + """ # noqa: E501 + data: List[JsonApiMetricLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsMetrics from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsMetrics from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiMetricLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_visualization_objects.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_visualization_objects.py new file mode 100644 index 000000000..a2ae6df1f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_relationships_visualization_objects.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects(BaseModel): + """ + JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects + """ # noqa: E501 + data: List[JsonApiVisualizationObjectLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiVisualizationObjectLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_with_links.py new file mode 100644 index 000000000..d0505d263 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_analytical_dashboard_out_attributes import JsonApiAnalyticalDashboardOutAttributes +from gooddata_api_client.models.json_api_analytical_dashboard_out_meta import JsonApiAnalyticalDashboardOutMeta +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships import JsonApiAnalyticalDashboardOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardOutWithLinks(BaseModel): + """ + JsonApiAnalyticalDashboardOutWithLinks + """ # noqa: E501 + attributes: JsonApiAnalyticalDashboardOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAnalyticalDashboardOutMeta] = None + relationships: Optional[JsonApiAnalyticalDashboardOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard']): + raise ValueError("must be one of enum values ('analyticalDashboard')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAnalyticalDashboardOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAnalyticalDashboardOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiAnalyticalDashboardOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_patch.py new file mode 100644 index 000000000..7ffaf300c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_analytical_dashboard_patch_attributes import JsonApiAnalyticalDashboardPatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardPatch(BaseModel): + """ + JSON:API representation of patching analyticalDashboard entity. + """ # noqa: E501 + attributes: JsonApiAnalyticalDashboardPatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard']): + raise ValueError("must be one of enum values ('analyticalDashboard')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAnalyticalDashboardPatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_patch_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_patch_attributes.py new file mode 100644 index 000000000..7dbf8786a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_patch_attributes.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardPatchAttributes(BaseModel): + """ + JsonApiAnalyticalDashboardPatchAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON content. Maximum supported length is 250000 characters.") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "description", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardPatchAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardPatchAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "description": obj.get("description"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_patch_document.py new file mode 100644 index 000000000..da99bd147 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_analytical_dashboard_patch import JsonApiAnalyticalDashboardPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardPatchDocument(BaseModel): + """ + JsonApiAnalyticalDashboardPatchDocument + """ # noqa: E501 + data: JsonApiAnalyticalDashboardPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAnalyticalDashboardPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_post_optional_id.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_post_optional_id.py new file mode 100644 index 000000000..0c670a5c7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_post_optional_id.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardPostOptionalId(BaseModel): + """ + JSON:API representation of analyticalDashboard entity. + """ # noqa: E501 + attributes: JsonApiAnalyticalDashboardInAttributes + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['analyticalDashboard']): + raise ValueError("must be one of enum values ('analyticalDashboard')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardPostOptionalId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardPostOptionalId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAnalyticalDashboardInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_post_optional_id_document.py new file mode 100644 index 000000000..180b1fb98 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_post_optional_id_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id import JsonApiAnalyticalDashboardPostOptionalId +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAnalyticalDashboardPostOptionalIdDocument(BaseModel): + """ + JsonApiAnalyticalDashboardPostOptionalIdDocument + """ # noqa: E501 + data: JsonApiAnalyticalDashboardPostOptionalId + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardPostOptionalIdDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAnalyticalDashboardPostOptionalIdDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAnalyticalDashboardPostOptionalId.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_to_one_linkage.py new file mode 100644 index 000000000..43f9ad7ef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_analytical_dashboard_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_linkage import JsonApiAnalyticalDashboardLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIANALYTICALDASHBOARDTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiAnalyticalDashboardLinkage"] + +class JsonApiAnalyticalDashboardToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiAnalyticalDashboardLinkage + oneof_schema_1_validator: Optional[JsonApiAnalyticalDashboardLinkage] = None + actual_instance: Optional[Union[JsonApiAnalyticalDashboardLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiAnalyticalDashboardLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiAnalyticalDashboardToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiAnalyticalDashboardLinkage + if not isinstance(v, JsonApiAnalyticalDashboardLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAnalyticalDashboardLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiAnalyticalDashboardToOneLinkage with oneOf schemas: JsonApiAnalyticalDashboardLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiAnalyticalDashboardToOneLinkage with oneOf schemas: JsonApiAnalyticalDashboardLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiAnalyticalDashboardLinkage + try: + instance.actual_instance = JsonApiAnalyticalDashboardLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiAnalyticalDashboardToOneLinkage with oneOf schemas: JsonApiAnalyticalDashboardLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiAnalyticalDashboardToOneLinkage with oneOf schemas: JsonApiAnalyticalDashboardLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAnalyticalDashboardLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_api_token_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_in.py new file mode 100644 index 000000000..7c89d3af6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_in.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiApiTokenIn(BaseModel): + """ + JSON:API representation of apiToken entity. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['apiToken']): + raise ValueError("must be one of enum values ('apiToken')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiApiTokenIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiApiTokenIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_api_token_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_in_document.py new file mode 100644 index 000000000..a47d6a766 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_api_token_in import JsonApiApiTokenIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiApiTokenInDocument(BaseModel): + """ + JsonApiApiTokenInDocument + """ # noqa: E501 + data: JsonApiApiTokenIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiApiTokenInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiApiTokenInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiApiTokenIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out.py new file mode 100644 index 000000000..ac8cb9382 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_api_token_out_attributes import JsonApiApiTokenOutAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiApiTokenOut(BaseModel): + """ + JSON:API representation of apiToken entity. + """ # noqa: E501 + attributes: Optional[JsonApiApiTokenOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['apiToken']): + raise ValueError("must be one of enum values ('apiToken')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiApiTokenOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiApiTokenOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiApiTokenOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_attributes.py new file mode 100644 index 000000000..9cc62d6a8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_attributes.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiApiTokenOutAttributes(BaseModel): + """ + JsonApiApiTokenOutAttributes + """ # noqa: E501 + bearer_token: Optional[StrictStr] = Field(default=None, description="The value of the Bearer token. It is only returned when the API token is created.", alias="bearerToken") + __properties: ClassVar[List[str]] = ["bearerToken"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiApiTokenOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiApiTokenOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "bearerToken": obj.get("bearerToken") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_document.py new file mode 100644 index 000000000..912f4e9fe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_api_token_out import JsonApiApiTokenOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiApiTokenOutDocument(BaseModel): + """ + JsonApiApiTokenOutDocument + """ # noqa: E501 + data: JsonApiApiTokenOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiApiTokenOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiApiTokenOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiApiTokenOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_list.py new file mode 100644 index 000000000..e5c8d3ab8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_api_token_out_with_links import JsonApiApiTokenOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiApiTokenOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiApiTokenOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiApiTokenOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiApiTokenOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiApiTokenOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_with_links.py new file mode 100644 index 000000000..ff6ff86ee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_api_token_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_api_token_out_attributes import JsonApiApiTokenOutAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiApiTokenOutWithLinks(BaseModel): + """ + JsonApiApiTokenOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiApiTokenOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['apiToken']): + raise ValueError("must be one of enum values ('apiToken')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiApiTokenOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiApiTokenOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiApiTokenOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_in.py new file mode 100644 index 000000000..930a1d4d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_attribute_hierarchy_in_attributes import JsonApiAttributeHierarchyInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyIn(BaseModel): + """ + JSON:API representation of attributeHierarchy entity. + """ # noqa: E501 + attributes: Optional[JsonApiAttributeHierarchyInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attributeHierarchy']): + raise ValueError("must be one of enum values ('attributeHierarchy')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAttributeHierarchyInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_in_attributes.py new file mode 100644 index 000000000..045f4386f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_in_attributes.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyInAttributes(BaseModel): + """ + JsonApiAttributeHierarchyInAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON content. Maximum supported length is 15000 characters.") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "description", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "description": obj.get("description"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_in_document.py new file mode 100644 index 000000000..e3605a14d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_attribute_hierarchy_in import JsonApiAttributeHierarchyIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyInDocument(BaseModel): + """ + JsonApiAttributeHierarchyInDocument + """ # noqa: E501 + data: JsonApiAttributeHierarchyIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAttributeHierarchyIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_linkage.py new file mode 100644 index 000000000..df0ca2510 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attributeHierarchy']): + raise ValueError("must be one of enum values ('attributeHierarchy')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out.py new file mode 100644 index 000000000..63b012ae4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_attribute_hierarchy_out_attributes import JsonApiAttributeHierarchyOutAttributes +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships import JsonApiAttributeHierarchyOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyOut(BaseModel): + """ + JSON:API representation of attributeHierarchy entity. + """ # noqa: E501 + attributes: Optional[JsonApiAttributeHierarchyOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiAttributeHierarchyOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attributeHierarchy']): + raise ValueError("must be one of enum values ('attributeHierarchy')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAttributeHierarchyOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiAttributeHierarchyOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_attributes.py new file mode 100644 index 000000000..4860ad2b2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_attributes.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyOutAttributes(BaseModel): + """ + JsonApiAttributeHierarchyOutAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON content. Maximum supported length is 15000 characters.") + created_at: Optional[datetime] = Field(default=None, alias="createdAt") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + modified_at: Optional[datetime] = Field(default=None, alias="modifiedAt") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "createdAt", "description", "modifiedAt", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "createdAt": obj.get("createdAt"), + "description": obj.get("description"), + "modifiedAt": obj.get("modifiedAt"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_document.py new file mode 100644 index 000000000..ba4f53b5e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_attribute_hierarchy_out import JsonApiAttributeHierarchyOut +from gooddata_api_client.models.json_api_attribute_hierarchy_out_includes import JsonApiAttributeHierarchyOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyOutDocument(BaseModel): + """ + JsonApiAttributeHierarchyOutDocument + """ # noqa: E501 + data: JsonApiAttributeHierarchyOut + included: Optional[List[JsonApiAttributeHierarchyOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAttributeHierarchyOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiAttributeHierarchyOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_includes.py new file mode 100644 index 000000000..7a133bac7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_includes.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIATTRIBUTEHIERARCHYOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiAttributeOutWithLinks", "JsonApiUserIdentifierOutWithLinks"] + +class JsonApiAttributeHierarchyOutIncludes(BaseModel): + """ + JsonApiAttributeHierarchyOutIncludes + """ + # data type: JsonApiUserIdentifierOutWithLinks + oneof_schema_1_validator: Optional[JsonApiUserIdentifierOutWithLinks] = None + # data type: JsonApiAttributeOutWithLinks + oneof_schema_2_validator: Optional[JsonApiAttributeOutWithLinks] = None + actual_instance: Optional[Union[JsonApiAttributeOutWithLinks, JsonApiUserIdentifierOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiAttributeOutWithLinks", "JsonApiUserIdentifierOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiAttributeHierarchyOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiUserIdentifierOutWithLinks + if not isinstance(v, JsonApiUserIdentifierOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserIdentifierOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAttributeOutWithLinks + if not isinstance(v, JsonApiAttributeOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAttributeOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiAttributeHierarchyOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiUserIdentifierOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiAttributeHierarchyOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiUserIdentifierOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiUserIdentifierOutWithLinks + try: + instance.actual_instance = JsonApiUserIdentifierOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAttributeOutWithLinks + try: + instance.actual_instance = JsonApiAttributeOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiAttributeHierarchyOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiUserIdentifierOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiAttributeHierarchyOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiUserIdentifierOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAttributeOutWithLinks, JsonApiUserIdentifierOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_list.py new file mode 100644 index 000000000..be5d8a0d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_attribute_hierarchy_out_includes import JsonApiAttributeHierarchyOutIncludes +from gooddata_api_client.models.json_api_attribute_hierarchy_out_with_links import JsonApiAttributeHierarchyOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiAttributeHierarchyOutWithLinks] + included: Optional[List[JsonApiAttributeHierarchyOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiAttributeHierarchyOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiAttributeHierarchyOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_relationships.py new file mode 100644 index 000000000..830d252bf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_relationships.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyOutRelationships(BaseModel): + """ + JsonApiAttributeHierarchyOutRelationships + """ # noqa: E501 + attributes: Optional[JsonApiAttributeHierarchyOutRelationshipsAttributes] = None + created_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="createdBy") + modified_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="modifiedBy") + __properties: ClassVar[List[str]] = ["attributes", "createdBy", "modifiedBy"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAttributeHierarchyOutRelationshipsAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "createdBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "modifiedBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_relationships_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_relationships_attributes.py new file mode 100644 index 000000000..16be58701 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_relationships_attributes.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_attribute_linkage import JsonApiAttributeLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyOutRelationshipsAttributes(BaseModel): + """ + JsonApiAttributeHierarchyOutRelationshipsAttributes + """ # noqa: E501 + data: List[JsonApiAttributeLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutRelationshipsAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutRelationshipsAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiAttributeLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_with_links.py new file mode 100644 index 000000000..8fc247617 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_attribute_hierarchy_out_attributes import JsonApiAttributeHierarchyOutAttributes +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships import JsonApiAttributeHierarchyOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyOutWithLinks(BaseModel): + """ + JsonApiAttributeHierarchyOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiAttributeHierarchyOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiAttributeHierarchyOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attributeHierarchy']): + raise ValueError("must be one of enum values ('attributeHierarchy')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAttributeHierarchyOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiAttributeHierarchyOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_patch.py new file mode 100644 index 000000000..05963b681 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_attribute_hierarchy_in_attributes import JsonApiAttributeHierarchyInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyPatch(BaseModel): + """ + JSON:API representation of patching attributeHierarchy entity. + """ # noqa: E501 + attributes: Optional[JsonApiAttributeHierarchyInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attributeHierarchy']): + raise ValueError("must be one of enum values ('attributeHierarchy')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAttributeHierarchyInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_patch_document.py new file mode 100644 index 000000000..9dece1580 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_hierarchy_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_attribute_hierarchy_patch import JsonApiAttributeHierarchyPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeHierarchyPatchDocument(BaseModel): + """ + JsonApiAttributeHierarchyPatchDocument + """ # noqa: E501 + data: JsonApiAttributeHierarchyPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeHierarchyPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAttributeHierarchyPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_linkage.py new file mode 100644 index 000000000..95b1ef7e7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attribute']): + raise ValueError("must be one of enum values ('attribute')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out.py new file mode 100644 index 000000000..424fa81b8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes +from gooddata_api_client.models.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeOut(BaseModel): + """ + JSON:API representation of attribute entity. + """ # noqa: E501 + attributes: Optional[JsonApiAttributeOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiAttributeOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attribute']): + raise ValueError("must be one of enum values ('attribute')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAttributeOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiAttributeOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_attributes.py new file mode 100644 index 000000000..fdcbab060 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_attributes.py @@ -0,0 +1,137 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeOutAttributes(BaseModel): + """ + JsonApiAttributeOutAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + granularity: Optional[StrictStr] = None + is_hidden: Optional[StrictBool] = Field(default=None, alias="isHidden") + sort_column: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="sortColumn") + sort_direction: Optional[StrictStr] = Field(default=None, alias="sortDirection") + source_column: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="sourceColumn") + source_column_data_type: Optional[StrictStr] = Field(default=None, alias="sourceColumnDataType") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "description", "granularity", "isHidden", "sortColumn", "sortDirection", "sourceColumn", "sourceColumnDataType", "tags", "title"] + + @field_validator('granularity') + def granularity_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR']): + raise ValueError("must be one of enum values ('MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR')") + return value + + @field_validator('sort_direction') + def sort_direction_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ASC', 'DESC']): + raise ValueError("must be one of enum values ('ASC', 'DESC')") + return value + + @field_validator('source_column_data_type') + def source_column_data_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "description": obj.get("description"), + "granularity": obj.get("granularity"), + "isHidden": obj.get("isHidden"), + "sortColumn": obj.get("sortColumn"), + "sortDirection": obj.get("sortDirection"), + "sourceColumn": obj.get("sourceColumn"), + "sourceColumnDataType": obj.get("sourceColumnDataType"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_document.py new file mode 100644 index 000000000..e1fc379eb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_attribute_out import JsonApiAttributeOut +from gooddata_api_client.models.json_api_attribute_out_includes import JsonApiAttributeOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeOutDocument(BaseModel): + """ + JsonApiAttributeOutDocument + """ # noqa: E501 + data: JsonApiAttributeOut + included: Optional[List[JsonApiAttributeOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAttributeOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiAttributeOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_includes.py new file mode 100644 index 000000000..b4601365f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_includes.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_attribute_hierarchy_out_with_links import JsonApiAttributeHierarchyOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIATTRIBUTEOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiAttributeHierarchyOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiLabelOutWithLinks"] + +class JsonApiAttributeOutIncludes(BaseModel): + """ + JsonApiAttributeOutIncludes + """ + # data type: JsonApiDatasetOutWithLinks + oneof_schema_1_validator: Optional[JsonApiDatasetOutWithLinks] = None + # data type: JsonApiLabelOutWithLinks + oneof_schema_2_validator: Optional[JsonApiLabelOutWithLinks] = None + # data type: JsonApiAttributeHierarchyOutWithLinks + oneof_schema_3_validator: Optional[JsonApiAttributeHierarchyOutWithLinks] = None + actual_instance: Optional[Union[JsonApiAttributeHierarchyOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiAttributeHierarchyOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiLabelOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiAttributeOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiDatasetOutWithLinks + if not isinstance(v, JsonApiDatasetOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiDatasetOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiLabelOutWithLinks + if not isinstance(v, JsonApiLabelOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiLabelOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAttributeHierarchyOutWithLinks + if not isinstance(v, JsonApiAttributeHierarchyOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAttributeHierarchyOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiAttributeOutIncludes with oneOf schemas: JsonApiAttributeHierarchyOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiAttributeOutIncludes with oneOf schemas: JsonApiAttributeHierarchyOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiDatasetOutWithLinks + try: + instance.actual_instance = JsonApiDatasetOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiLabelOutWithLinks + try: + instance.actual_instance = JsonApiLabelOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAttributeHierarchyOutWithLinks + try: + instance.actual_instance = JsonApiAttributeHierarchyOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiAttributeOutIncludes with oneOf schemas: JsonApiAttributeHierarchyOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiAttributeOutIncludes with oneOf schemas: JsonApiAttributeHierarchyOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAttributeHierarchyOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_list.py new file mode 100644 index 000000000..d7cd39461 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_attribute_out_includes import JsonApiAttributeOutIncludes +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiAttributeOutWithLinks] + included: Optional[List[JsonApiAttributeOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiAttributeOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiAttributeOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_relationships.py new file mode 100644 index 000000000..7de4a28ab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_relationships.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships_dataset import JsonApiAggregatedFactOutRelationshipsDataset +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels +from gooddata_api_client.models.json_api_attribute_out_relationships_attribute_hierarchies import JsonApiAttributeOutRelationshipsAttributeHierarchies +from gooddata_api_client.models.json_api_attribute_out_relationships_default_view import JsonApiAttributeOutRelationshipsDefaultView +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeOutRelationships(BaseModel): + """ + JsonApiAttributeOutRelationships + """ # noqa: E501 + attribute_hierarchies: Optional[JsonApiAttributeOutRelationshipsAttributeHierarchies] = Field(default=None, alias="attributeHierarchies") + dataset: Optional[JsonApiAggregatedFactOutRelationshipsDataset] = None + default_view: Optional[JsonApiAttributeOutRelationshipsDefaultView] = Field(default=None, alias="defaultView") + labels: Optional[JsonApiAnalyticalDashboardOutRelationshipsLabels] = None + __properties: ClassVar[List[str]] = ["attributeHierarchies", "dataset", "defaultView", "labels"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attribute_hierarchies + if self.attribute_hierarchies: + _dict['attributeHierarchies'] = self.attribute_hierarchies.to_dict() + # override the default output from pydantic by calling `to_dict()` of dataset + if self.dataset: + _dict['dataset'] = self.dataset.to_dict() + # override the default output from pydantic by calling `to_dict()` of default_view + if self.default_view: + _dict['defaultView'] = self.default_view.to_dict() + # override the default output from pydantic by calling `to_dict()` of labels + if self.labels: + _dict['labels'] = self.labels.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributeHierarchies": JsonApiAttributeOutRelationshipsAttributeHierarchies.from_dict(obj["attributeHierarchies"]) if obj.get("attributeHierarchies") is not None else None, + "dataset": JsonApiAggregatedFactOutRelationshipsDataset.from_dict(obj["dataset"]) if obj.get("dataset") is not None else None, + "defaultView": JsonApiAttributeOutRelationshipsDefaultView.from_dict(obj["defaultView"]) if obj.get("defaultView") is not None else None, + "labels": JsonApiAnalyticalDashboardOutRelationshipsLabels.from_dict(obj["labels"]) if obj.get("labels") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_relationships_attribute_hierarchies.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_relationships_attribute_hierarchies.py new file mode 100644 index 000000000..46efbca3f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_relationships_attribute_hierarchies.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_attribute_hierarchy_linkage import JsonApiAttributeHierarchyLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeOutRelationshipsAttributeHierarchies(BaseModel): + """ + JsonApiAttributeOutRelationshipsAttributeHierarchies + """ # noqa: E501 + data: List[JsonApiAttributeHierarchyLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutRelationshipsAttributeHierarchies from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutRelationshipsAttributeHierarchies from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiAttributeHierarchyLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_relationships_default_view.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_relationships_default_view.py new file mode 100644 index 000000000..816513d92 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_relationships_default_view.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_label_to_one_linkage import JsonApiLabelToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeOutRelationshipsDefaultView(BaseModel): + """ + JsonApiAttributeOutRelationshipsDefaultView + """ # noqa: E501 + data: Optional[JsonApiLabelToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutRelationshipsDefaultView from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutRelationshipsDefaultView from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiLabelToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_with_links.py new file mode 100644 index 000000000..f212fa6db --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes +from gooddata_api_client.models.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAttributeOutWithLinks(BaseModel): + """ + JsonApiAttributeOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiAttributeOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiAttributeOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attribute']): + raise ValueError("must be one of enum values ('attribute')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAttributeOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAttributeOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiAttributeOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_attribute_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_to_one_linkage.py new file mode 100644 index 000000000..860ef2737 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_attribute_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_attribute_linkage import JsonApiAttributeLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIATTRIBUTETOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiAttributeLinkage"] + +class JsonApiAttributeToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiAttributeLinkage + oneof_schema_1_validator: Optional[JsonApiAttributeLinkage] = None + actual_instance: Optional[Union[JsonApiAttributeLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiAttributeLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiAttributeToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiAttributeLinkage + if not isinstance(v, JsonApiAttributeLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAttributeLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiAttributeToOneLinkage with oneOf schemas: JsonApiAttributeLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiAttributeToOneLinkage with oneOf schemas: JsonApiAttributeLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiAttributeLinkage + try: + instance.actual_instance = JsonApiAttributeLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiAttributeToOneLinkage with oneOf schemas: JsonApiAttributeLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiAttributeToOneLinkage with oneOf schemas: JsonApiAttributeLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAttributeLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in.py new file mode 100644 index 000000000..cf3db59b3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_automation_in_attributes import JsonApiAutomationInAttributes +from gooddata_api_client.models.json_api_automation_in_relationships import JsonApiAutomationInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationIn(BaseModel): + """ + JSON:API representation of automation entity. + """ # noqa: E501 + attributes: Optional[JsonApiAutomationInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiAutomationInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['automation']): + raise ValueError("must be one of enum values ('automation')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAutomationInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiAutomationInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes.py new file mode 100644 index 000000000..a3ad37043 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert +from gooddata_api_client.models.json_api_automation_in_attributes_dashboard_tabular_exports_inner import JsonApiAutomationInAttributesDashboardTabularExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner +from gooddata_api_client.models.json_api_automation_in_attributes_image_exports_inner import JsonApiAutomationInAttributesImageExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata +from gooddata_api_client.models.json_api_automation_in_attributes_raw_exports_inner import JsonApiAutomationInAttributesRawExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule +from gooddata_api_client.models.json_api_automation_in_attributes_slides_exports_inner import JsonApiAutomationInAttributesSlidesExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInAttributes(BaseModel): + """ + JsonApiAutomationInAttributes + """ # noqa: E501 + alert: Optional[JsonApiAutomationInAttributesAlert] = None + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + dashboard_tabular_exports: Optional[List[JsonApiAutomationInAttributesDashboardTabularExportsInner]] = Field(default=None, alias="dashboardTabularExports") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + details: Optional[Dict[str, Any]] = Field(default=None, description="Additional details to be included in the automated message.") + evaluation_mode: Optional[StrictStr] = Field(default=None, description="Specify automation evaluation mode.", alias="evaluationMode") + external_recipients: Optional[List[JsonApiAutomationInAttributesExternalRecipientsInner]] = Field(default=None, description="External recipients of the automation action results.", alias="externalRecipients") + image_exports: Optional[List[JsonApiAutomationInAttributesImageExportsInner]] = Field(default=None, alias="imageExports") + metadata: Optional[JsonApiAutomationInAttributesMetadata] = None + raw_exports: Optional[List[JsonApiAutomationInAttributesRawExportsInner]] = Field(default=None, alias="rawExports") + schedule: Optional[JsonApiAutomationInAttributesSchedule] = None + slides_exports: Optional[List[JsonApiAutomationInAttributesSlidesExportsInner]] = Field(default=None, alias="slidesExports") + state: Optional[StrictStr] = Field(default=None, description="Current state of the automation.") + tabular_exports: Optional[List[JsonApiAutomationInAttributesTabularExportsInner]] = Field(default=None, alias="tabularExports") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + visual_exports: Optional[List[JsonApiAutomationInAttributesVisualExportsInner]] = Field(default=None, alias="visualExports") + __properties: ClassVar[List[str]] = ["alert", "areRelationsValid", "dashboardTabularExports", "description", "details", "evaluationMode", "externalRecipients", "imageExports", "metadata", "rawExports", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports"] + + @field_validator('evaluation_mode') + def evaluation_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SHARED', 'PER_RECIPIENT']): + raise ValueError("must be one of enum values ('SHARED', 'PER_RECIPIENT')") + return value + + @field_validator('state') + def state_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ACTIVE', 'PAUSED']): + raise ValueError("must be one of enum values ('ACTIVE', 'PAUSED')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of alert + if self.alert: + _dict['alert'] = self.alert.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in dashboard_tabular_exports (list) + _items = [] + if self.dashboard_tabular_exports: + for _item_dashboard_tabular_exports in self.dashboard_tabular_exports: + if _item_dashboard_tabular_exports: + _items.append(_item_dashboard_tabular_exports.to_dict()) + _dict['dashboardTabularExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in external_recipients (list) + _items = [] + if self.external_recipients: + for _item_external_recipients in self.external_recipients: + if _item_external_recipients: + _items.append(_item_external_recipients.to_dict()) + _dict['externalRecipients'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in image_exports (list) + _items = [] + if self.image_exports: + for _item_image_exports in self.image_exports: + if _item_image_exports: + _items.append(_item_image_exports.to_dict()) + _dict['imageExports'] = _items + # override the default output from pydantic by calling `to_dict()` of metadata + if self.metadata: + _dict['metadata'] = self.metadata.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in raw_exports (list) + _items = [] + if self.raw_exports: + for _item_raw_exports in self.raw_exports: + if _item_raw_exports: + _items.append(_item_raw_exports.to_dict()) + _dict['rawExports'] = _items + # override the default output from pydantic by calling `to_dict()` of schedule + if self.schedule: + _dict['schedule'] = self.schedule.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in slides_exports (list) + _items = [] + if self.slides_exports: + for _item_slides_exports in self.slides_exports: + if _item_slides_exports: + _items.append(_item_slides_exports.to_dict()) + _dict['slidesExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in tabular_exports (list) + _items = [] + if self.tabular_exports: + for _item_tabular_exports in self.tabular_exports: + if _item_tabular_exports: + _items.append(_item_tabular_exports.to_dict()) + _dict['tabularExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in visual_exports (list) + _items = [] + if self.visual_exports: + for _item_visual_exports in self.visual_exports: + if _item_visual_exports: + _items.append(_item_visual_exports.to_dict()) + _dict['visualExports'] = _items + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "alert": JsonApiAutomationInAttributesAlert.from_dict(obj["alert"]) if obj.get("alert") is not None else None, + "areRelationsValid": obj.get("areRelationsValid"), + "dashboardTabularExports": [JsonApiAutomationInAttributesDashboardTabularExportsInner.from_dict(_item) for _item in obj["dashboardTabularExports"]] if obj.get("dashboardTabularExports") is not None else None, + "description": obj.get("description"), + "details": obj.get("details"), + "evaluationMode": obj.get("evaluationMode"), + "externalRecipients": [JsonApiAutomationInAttributesExternalRecipientsInner.from_dict(_item) for _item in obj["externalRecipients"]] if obj.get("externalRecipients") is not None else None, + "imageExports": [JsonApiAutomationInAttributesImageExportsInner.from_dict(_item) for _item in obj["imageExports"]] if obj.get("imageExports") is not None else None, + "metadata": JsonApiAutomationInAttributesMetadata.from_dict(obj["metadata"]) if obj.get("metadata") is not None else None, + "rawExports": [JsonApiAutomationInAttributesRawExportsInner.from_dict(_item) for _item in obj["rawExports"]] if obj.get("rawExports") is not None else None, + "schedule": JsonApiAutomationInAttributesSchedule.from_dict(obj["schedule"]) if obj.get("schedule") is not None else None, + "slidesExports": [JsonApiAutomationInAttributesSlidesExportsInner.from_dict(_item) for _item in obj["slidesExports"]] if obj.get("slidesExports") is not None else None, + "state": obj.get("state"), + "tabularExports": [JsonApiAutomationInAttributesTabularExportsInner.from_dict(_item) for _item in obj["tabularExports"]] if obj.get("tabularExports") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title"), + "visualExports": [JsonApiAutomationInAttributesVisualExportsInner.from_dict(_item) for _item in obj["visualExports"]] if obj.get("visualExports") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_alert.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_alert.py new file mode 100644 index 000000000..e5c5e0369 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_alert.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.alert_afm import AlertAfm +from gooddata_api_client.models.alert_condition import AlertCondition +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInAttributesAlert(BaseModel): + """ + JsonApiAutomationInAttributesAlert + """ # noqa: E501 + condition: AlertCondition + execution: AlertAfm + trigger: Optional[StrictStr] = Field(default='ALWAYS', description="Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ") + __properties: ClassVar[List[str]] = ["condition", "execution", "trigger"] + + @field_validator('trigger') + def trigger_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ALWAYS', 'ONCE']): + raise ValueError("must be one of enum values ('ALWAYS', 'ONCE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesAlert from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of condition + if self.condition: + _dict['condition'] = self.condition.to_dict() + # override the default output from pydantic by calling `to_dict()` of execution + if self.execution: + _dict['execution'] = self.execution.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesAlert from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "condition": AlertCondition.from_dict(obj["condition"]) if obj.get("condition") is not None else None, + "execution": AlertAfm.from_dict(obj["execution"]) if obj.get("execution") is not None else None, + "trigger": obj.get("trigger") if obj.get("trigger") is not None else 'ALWAYS' + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_dashboard_tabular_exports_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_dashboard_tabular_exports_inner.py new file mode 100644 index 000000000..e14742fbc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_dashboard_tabular_exports_inner.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInAttributesDashboardTabularExportsInner(BaseModel): + """ + JsonApiAutomationInAttributesDashboardTabularExportsInner + """ # noqa: E501 + request_payload: DashboardTabularExportRequestV2 = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesDashboardTabularExportsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesDashboardTabularExportsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": DashboardTabularExportRequestV2.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_external_recipients_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_external_recipients_inner.py new file mode 100644 index 000000000..af5a91146 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_external_recipients_inner.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInAttributesExternalRecipientsInner(BaseModel): + """ + JsonApiAutomationInAttributesExternalRecipientsInner + """ # noqa: E501 + email: StrictStr = Field(description="E-mail address to send notifications from.") + __properties: ClassVar[List[str]] = ["email"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesExternalRecipientsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesExternalRecipientsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "email": obj.get("email") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_image_exports_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_image_exports_inner.py new file mode 100644 index 000000000..d4206337f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_image_exports_inner.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.image_export_request import ImageExportRequest +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInAttributesImageExportsInner(BaseModel): + """ + JsonApiAutomationInAttributesImageExportsInner + """ # noqa: E501 + request_payload: ImageExportRequest = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesImageExportsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesImageExportsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": ImageExportRequest.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_metadata.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_metadata.py new file mode 100644 index 000000000..284cd0175 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_metadata.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.visible_filter import VisibleFilter +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInAttributesMetadata(BaseModel): + """ + Additional information for the automation. + """ # noqa: E501 + visible_filters: Optional[List[VisibleFilter]] = Field(default=None, alias="visibleFilters") + widget: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["visibleFilters", "widget"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesMetadata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in visible_filters (list) + _items = [] + if self.visible_filters: + for _item_visible_filters in self.visible_filters: + if _item_visible_filters: + _items.append(_item_visible_filters.to_dict()) + _dict['visibleFilters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesMetadata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "visibleFilters": [VisibleFilter.from_dict(_item) for _item in obj["visibleFilters"]] if obj.get("visibleFilters") is not None else None, + "widget": obj.get("widget") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_raw_exports_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_raw_exports_inner.py new file mode 100644 index 000000000..66982168c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_raw_exports_inner.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.raw_export_automation_request import RawExportAutomationRequest +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInAttributesRawExportsInner(BaseModel): + """ + JsonApiAutomationInAttributesRawExportsInner + """ # noqa: E501 + request_payload: RawExportAutomationRequest = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesRawExportsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesRawExportsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": RawExportAutomationRequest.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_schedule.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_schedule.py new file mode 100644 index 000000000..fc87dcd68 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_schedule.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInAttributesSchedule(BaseModel): + """ + JsonApiAutomationInAttributesSchedule + """ # noqa: E501 + cron: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.") + cron_description: Optional[StrictStr] = Field(default=None, description="Human-readable description of the cron expression.", alias="cronDescription") + first_run: Optional[datetime] = Field(default=None, description="Timestamp of the first scheduled action. If not provided default to the next scheduled time.", alias="firstRun") + timezone: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Timezone in which the schedule is defined.") + __properties: ClassVar[List[str]] = ["cron", "cronDescription", "firstRun", "timezone"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesSchedule from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "cron_description", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesSchedule from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cron": obj.get("cron"), + "cronDescription": obj.get("cronDescription"), + "firstRun": obj.get("firstRun"), + "timezone": obj.get("timezone") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_slides_exports_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_slides_exports_inner.py new file mode 100644 index 000000000..d66f90693 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_slides_exports_inner.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.slides_export_request import SlidesExportRequest +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInAttributesSlidesExportsInner(BaseModel): + """ + JsonApiAutomationInAttributesSlidesExportsInner + """ # noqa: E501 + request_payload: SlidesExportRequest = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesSlidesExportsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesSlidesExportsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": SlidesExportRequest.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_tabular_exports_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_tabular_exports_inner.py new file mode 100644 index 000000000..29571ba3e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_tabular_exports_inner.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInAttributesTabularExportsInner(BaseModel): + """ + JsonApiAutomationInAttributesTabularExportsInner + """ # noqa: E501 + request_payload: TabularExportRequest = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesTabularExportsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesTabularExportsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": TabularExportRequest.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_visual_exports_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_visual_exports_inner.py new file mode 100644 index 000000000..b5654836b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_attributes_visual_exports_inner.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.visual_export_request import VisualExportRequest +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInAttributesVisualExportsInner(BaseModel): + """ + JsonApiAutomationInAttributesVisualExportsInner + """ # noqa: E501 + request_payload: VisualExportRequest = Field(alias="requestPayload") + __properties: ClassVar[List[str]] = ["requestPayload"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesVisualExportsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInAttributesVisualExportsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "requestPayload": VisualExportRequest.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_document.py new file mode 100644 index 000000000..21dd37a60 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_automation_in import JsonApiAutomationIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInDocument(BaseModel): + """ + JsonApiAutomationInDocument + """ # noqa: E501 + data: JsonApiAutomationIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAutomationIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships.py new file mode 100644 index 000000000..eec38d842 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard +from gooddata_api_client.models.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions +from gooddata_api_client.models.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel +from gooddata_api_client.models.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInRelationships(BaseModel): + """ + JsonApiAutomationInRelationships + """ # noqa: E501 + analytical_dashboard: Optional[JsonApiAutomationInRelationshipsAnalyticalDashboard] = Field(default=None, alias="analyticalDashboard") + export_definitions: Optional[JsonApiAutomationInRelationshipsExportDefinitions] = Field(default=None, alias="exportDefinitions") + notification_channel: Optional[JsonApiAutomationInRelationshipsNotificationChannel] = Field(default=None, alias="notificationChannel") + recipients: Optional[JsonApiAutomationInRelationshipsRecipients] = None + __properties: ClassVar[List[str]] = ["analyticalDashboard", "exportDefinitions", "notificationChannel", "recipients"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of analytical_dashboard + if self.analytical_dashboard: + _dict['analyticalDashboard'] = self.analytical_dashboard.to_dict() + # override the default output from pydantic by calling `to_dict()` of export_definitions + if self.export_definitions: + _dict['exportDefinitions'] = self.export_definitions.to_dict() + # override the default output from pydantic by calling `to_dict()` of notification_channel + if self.notification_channel: + _dict['notificationChannel'] = self.notification_channel.to_dict() + # override the default output from pydantic by calling `to_dict()` of recipients + if self.recipients: + _dict['recipients'] = self.recipients.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticalDashboard": JsonApiAutomationInRelationshipsAnalyticalDashboard.from_dict(obj["analyticalDashboard"]) if obj.get("analyticalDashboard") is not None else None, + "exportDefinitions": JsonApiAutomationInRelationshipsExportDefinitions.from_dict(obj["exportDefinitions"]) if obj.get("exportDefinitions") is not None else None, + "notificationChannel": JsonApiAutomationInRelationshipsNotificationChannel.from_dict(obj["notificationChannel"]) if obj.get("notificationChannel") is not None else None, + "recipients": JsonApiAutomationInRelationshipsRecipients.from_dict(obj["recipients"]) if obj.get("recipients") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_analytical_dashboard.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_analytical_dashboard.py new file mode 100644 index 000000000..790fe683a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_analytical_dashboard.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInRelationshipsAnalyticalDashboard(BaseModel): + """ + JsonApiAutomationInRelationshipsAnalyticalDashboard + """ # noqa: E501 + data: Optional[JsonApiAnalyticalDashboardToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInRelationshipsAnalyticalDashboard from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInRelationshipsAnalyticalDashboard from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAnalyticalDashboardToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_export_definitions.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_export_definitions.py new file mode 100644 index 000000000..b78cc47ff --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_export_definitions.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_export_definition_linkage import JsonApiExportDefinitionLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInRelationshipsExportDefinitions(BaseModel): + """ + JsonApiAutomationInRelationshipsExportDefinitions + """ # noqa: E501 + data: List[JsonApiExportDefinitionLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInRelationshipsExportDefinitions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInRelationshipsExportDefinitions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiExportDefinitionLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_notification_channel.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_notification_channel.py new file mode 100644 index 000000000..9b7a0931e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_notification_channel.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_notification_channel_to_one_linkage import JsonApiNotificationChannelToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInRelationshipsNotificationChannel(BaseModel): + """ + JsonApiAutomationInRelationshipsNotificationChannel + """ # noqa: E501 + data: Optional[JsonApiNotificationChannelToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInRelationshipsNotificationChannel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInRelationshipsNotificationChannel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiNotificationChannelToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_recipients.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_recipients.py new file mode 100644 index 000000000..811013ddf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_in_relationships_recipients.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_user_linkage import JsonApiUserLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationInRelationshipsRecipients(BaseModel): + """ + JsonApiAutomationInRelationshipsRecipients + """ # noqa: E501 + data: List[JsonApiUserLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationInRelationshipsRecipients from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationInRelationshipsRecipients from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiUserLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_linkage.py new file mode 100644 index 000000000..849819bcf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['automation']): + raise ValueError("must be one of enum values ('automation')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out.py new file mode 100644 index 000000000..a5bdbd978 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_automation_out_attributes import JsonApiAutomationOutAttributes +from gooddata_api_client.models.json_api_automation_out_relationships import JsonApiAutomationOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationOut(BaseModel): + """ + JSON:API representation of automation entity. + """ # noqa: E501 + attributes: Optional[JsonApiAutomationOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiAutomationOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['automation']): + raise ValueError("must be one of enum values ('automation')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAutomationOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiAutomationOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_attributes.py new file mode 100644 index 000000000..ffd045588 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_attributes.py @@ -0,0 +1,219 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert +from gooddata_api_client.models.json_api_automation_in_attributes_dashboard_tabular_exports_inner import JsonApiAutomationInAttributesDashboardTabularExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner +from gooddata_api_client.models.json_api_automation_in_attributes_image_exports_inner import JsonApiAutomationInAttributesImageExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata +from gooddata_api_client.models.json_api_automation_in_attributes_raw_exports_inner import JsonApiAutomationInAttributesRawExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule +from gooddata_api_client.models.json_api_automation_in_attributes_slides_exports_inner import JsonApiAutomationInAttributesSlidesExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner +from gooddata_api_client.models.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationOutAttributes(BaseModel): + """ + JsonApiAutomationOutAttributes + """ # noqa: E501 + alert: Optional[JsonApiAutomationInAttributesAlert] = None + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + created_at: Optional[datetime] = Field(default=None, alias="createdAt") + dashboard_tabular_exports: Optional[List[JsonApiAutomationInAttributesDashboardTabularExportsInner]] = Field(default=None, alias="dashboardTabularExports") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + details: Optional[Dict[str, Any]] = Field(default=None, description="Additional details to be included in the automated message.") + evaluation_mode: Optional[StrictStr] = Field(default=None, description="Specify automation evaluation mode.", alias="evaluationMode") + external_recipients: Optional[List[JsonApiAutomationInAttributesExternalRecipientsInner]] = Field(default=None, description="External recipients of the automation action results.", alias="externalRecipients") + image_exports: Optional[List[JsonApiAutomationInAttributesImageExportsInner]] = Field(default=None, alias="imageExports") + metadata: Optional[JsonApiAutomationInAttributesMetadata] = None + modified_at: Optional[datetime] = Field(default=None, alias="modifiedAt") + raw_exports: Optional[List[JsonApiAutomationInAttributesRawExportsInner]] = Field(default=None, alias="rawExports") + schedule: Optional[JsonApiAutomationInAttributesSchedule] = None + slides_exports: Optional[List[JsonApiAutomationInAttributesSlidesExportsInner]] = Field(default=None, alias="slidesExports") + state: Optional[StrictStr] = Field(default=None, description="Current state of the automation.") + tabular_exports: Optional[List[JsonApiAutomationInAttributesTabularExportsInner]] = Field(default=None, alias="tabularExports") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + visual_exports: Optional[List[JsonApiAutomationInAttributesVisualExportsInner]] = Field(default=None, alias="visualExports") + __properties: ClassVar[List[str]] = ["alert", "areRelationsValid", "createdAt", "dashboardTabularExports", "description", "details", "evaluationMode", "externalRecipients", "imageExports", "metadata", "modifiedAt", "rawExports", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports"] + + @field_validator('evaluation_mode') + def evaluation_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SHARED', 'PER_RECIPIENT']): + raise ValueError("must be one of enum values ('SHARED', 'PER_RECIPIENT')") + return value + + @field_validator('state') + def state_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ACTIVE', 'PAUSED']): + raise ValueError("must be one of enum values ('ACTIVE', 'PAUSED')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of alert + if self.alert: + _dict['alert'] = self.alert.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in dashboard_tabular_exports (list) + _items = [] + if self.dashboard_tabular_exports: + for _item_dashboard_tabular_exports in self.dashboard_tabular_exports: + if _item_dashboard_tabular_exports: + _items.append(_item_dashboard_tabular_exports.to_dict()) + _dict['dashboardTabularExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in external_recipients (list) + _items = [] + if self.external_recipients: + for _item_external_recipients in self.external_recipients: + if _item_external_recipients: + _items.append(_item_external_recipients.to_dict()) + _dict['externalRecipients'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in image_exports (list) + _items = [] + if self.image_exports: + for _item_image_exports in self.image_exports: + if _item_image_exports: + _items.append(_item_image_exports.to_dict()) + _dict['imageExports'] = _items + # override the default output from pydantic by calling `to_dict()` of metadata + if self.metadata: + _dict['metadata'] = self.metadata.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in raw_exports (list) + _items = [] + if self.raw_exports: + for _item_raw_exports in self.raw_exports: + if _item_raw_exports: + _items.append(_item_raw_exports.to_dict()) + _dict['rawExports'] = _items + # override the default output from pydantic by calling `to_dict()` of schedule + if self.schedule: + _dict['schedule'] = self.schedule.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in slides_exports (list) + _items = [] + if self.slides_exports: + for _item_slides_exports in self.slides_exports: + if _item_slides_exports: + _items.append(_item_slides_exports.to_dict()) + _dict['slidesExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in tabular_exports (list) + _items = [] + if self.tabular_exports: + for _item_tabular_exports in self.tabular_exports: + if _item_tabular_exports: + _items.append(_item_tabular_exports.to_dict()) + _dict['tabularExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in visual_exports (list) + _items = [] + if self.visual_exports: + for _item_visual_exports in self.visual_exports: + if _item_visual_exports: + _items.append(_item_visual_exports.to_dict()) + _dict['visualExports'] = _items + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "alert": JsonApiAutomationInAttributesAlert.from_dict(obj["alert"]) if obj.get("alert") is not None else None, + "areRelationsValid": obj.get("areRelationsValid"), + "createdAt": obj.get("createdAt"), + "dashboardTabularExports": [JsonApiAutomationInAttributesDashboardTabularExportsInner.from_dict(_item) for _item in obj["dashboardTabularExports"]] if obj.get("dashboardTabularExports") is not None else None, + "description": obj.get("description"), + "details": obj.get("details"), + "evaluationMode": obj.get("evaluationMode"), + "externalRecipients": [JsonApiAutomationInAttributesExternalRecipientsInner.from_dict(_item) for _item in obj["externalRecipients"]] if obj.get("externalRecipients") is not None else None, + "imageExports": [JsonApiAutomationInAttributesImageExportsInner.from_dict(_item) for _item in obj["imageExports"]] if obj.get("imageExports") is not None else None, + "metadata": JsonApiAutomationInAttributesMetadata.from_dict(obj["metadata"]) if obj.get("metadata") is not None else None, + "modifiedAt": obj.get("modifiedAt"), + "rawExports": [JsonApiAutomationInAttributesRawExportsInner.from_dict(_item) for _item in obj["rawExports"]] if obj.get("rawExports") is not None else None, + "schedule": JsonApiAutomationInAttributesSchedule.from_dict(obj["schedule"]) if obj.get("schedule") is not None else None, + "slidesExports": [JsonApiAutomationInAttributesSlidesExportsInner.from_dict(_item) for _item in obj["slidesExports"]] if obj.get("slidesExports") is not None else None, + "state": obj.get("state"), + "tabularExports": [JsonApiAutomationInAttributesTabularExportsInner.from_dict(_item) for _item in obj["tabularExports"]] if obj.get("tabularExports") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title"), + "visualExports": [JsonApiAutomationInAttributesVisualExportsInner.from_dict(_item) for _item in obj["visualExports"]] if obj.get("visualExports") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_document.py new file mode 100644 index 000000000..4857b944c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_automation_out import JsonApiAutomationOut +from gooddata_api_client.models.json_api_automation_out_includes import JsonApiAutomationOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationOutDocument(BaseModel): + """ + JsonApiAutomationOutDocument + """ # noqa: E501 + data: JsonApiAutomationOut + included: Optional[List[JsonApiAutomationOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAutomationOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiAutomationOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_includes.py new file mode 100644 index 000000000..818b33370 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_includes.py @@ -0,0 +1,194 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.models.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks +from gooddata_api_client.models.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks +from gooddata_api_client.models.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIAUTOMATIONOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiAnalyticalDashboardOutWithLinks", "JsonApiAutomationResultOutWithLinks", "JsonApiExportDefinitionOutWithLinks", "JsonApiNotificationChannelOutWithLinks", "JsonApiUserIdentifierOutWithLinks", "JsonApiUserOutWithLinks"] + +class JsonApiAutomationOutIncludes(BaseModel): + """ + JsonApiAutomationOutIncludes + """ + # data type: JsonApiNotificationChannelOutWithLinks + oneof_schema_1_validator: Optional[JsonApiNotificationChannelOutWithLinks] = None + # data type: JsonApiAnalyticalDashboardOutWithLinks + oneof_schema_2_validator: Optional[JsonApiAnalyticalDashboardOutWithLinks] = None + # data type: JsonApiUserIdentifierOutWithLinks + oneof_schema_3_validator: Optional[JsonApiUserIdentifierOutWithLinks] = None + # data type: JsonApiExportDefinitionOutWithLinks + oneof_schema_4_validator: Optional[JsonApiExportDefinitionOutWithLinks] = None + # data type: JsonApiUserOutWithLinks + oneof_schema_5_validator: Optional[JsonApiUserOutWithLinks] = None + # data type: JsonApiAutomationResultOutWithLinks + oneof_schema_6_validator: Optional[JsonApiAutomationResultOutWithLinks] = None + actual_instance: Optional[Union[JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiAnalyticalDashboardOutWithLinks", "JsonApiAutomationResultOutWithLinks", "JsonApiExportDefinitionOutWithLinks", "JsonApiNotificationChannelOutWithLinks", "JsonApiUserIdentifierOutWithLinks", "JsonApiUserOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiAutomationOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiNotificationChannelOutWithLinks + if not isinstance(v, JsonApiNotificationChannelOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiNotificationChannelOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAnalyticalDashboardOutWithLinks + if not isinstance(v, JsonApiAnalyticalDashboardOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAnalyticalDashboardOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiUserIdentifierOutWithLinks + if not isinstance(v, JsonApiUserIdentifierOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserIdentifierOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiExportDefinitionOutWithLinks + if not isinstance(v, JsonApiExportDefinitionOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiExportDefinitionOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiUserOutWithLinks + if not isinstance(v, JsonApiUserOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAutomationResultOutWithLinks + if not isinstance(v, JsonApiAutomationResultOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAutomationResultOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiAutomationOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiAutomationOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiNotificationChannelOutWithLinks + try: + instance.actual_instance = JsonApiNotificationChannelOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAnalyticalDashboardOutWithLinks + try: + instance.actual_instance = JsonApiAnalyticalDashboardOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiUserIdentifierOutWithLinks + try: + instance.actual_instance = JsonApiUserIdentifierOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiExportDefinitionOutWithLinks + try: + instance.actual_instance = JsonApiExportDefinitionOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiUserOutWithLinks + try: + instance.actual_instance = JsonApiUserOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAutomationResultOutWithLinks + try: + instance.actual_instance = JsonApiAutomationResultOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiAutomationOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiAutomationOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_list.py new file mode 100644 index 000000000..588c27c63 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_automation_out_includes import JsonApiAutomationOutIncludes +from gooddata_api_client.models.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiAutomationOutWithLinks] + included: Optional[List[JsonApiAutomationOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiAutomationOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiAutomationOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_relationships.py new file mode 100644 index 000000000..3169bb7f1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_relationships.py @@ -0,0 +1,127 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy +from gooddata_api_client.models.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard +from gooddata_api_client.models.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions +from gooddata_api_client.models.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel +from gooddata_api_client.models.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients +from gooddata_api_client.models.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationOutRelationships(BaseModel): + """ + JsonApiAutomationOutRelationships + """ # noqa: E501 + analytical_dashboard: Optional[JsonApiAutomationInRelationshipsAnalyticalDashboard] = Field(default=None, alias="analyticalDashboard") + automation_results: Optional[JsonApiAutomationOutRelationshipsAutomationResults] = Field(default=None, alias="automationResults") + created_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="createdBy") + export_definitions: Optional[JsonApiAutomationInRelationshipsExportDefinitions] = Field(default=None, alias="exportDefinitions") + modified_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="modifiedBy") + notification_channel: Optional[JsonApiAutomationInRelationshipsNotificationChannel] = Field(default=None, alias="notificationChannel") + recipients: Optional[JsonApiAutomationInRelationshipsRecipients] = None + __properties: ClassVar[List[str]] = ["analyticalDashboard", "automationResults", "createdBy", "exportDefinitions", "modifiedBy", "notificationChannel", "recipients"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of analytical_dashboard + if self.analytical_dashboard: + _dict['analyticalDashboard'] = self.analytical_dashboard.to_dict() + # override the default output from pydantic by calling `to_dict()` of automation_results + if self.automation_results: + _dict['automationResults'] = self.automation_results.to_dict() + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of export_definitions + if self.export_definitions: + _dict['exportDefinitions'] = self.export_definitions.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of notification_channel + if self.notification_channel: + _dict['notificationChannel'] = self.notification_channel.to_dict() + # override the default output from pydantic by calling `to_dict()` of recipients + if self.recipients: + _dict['recipients'] = self.recipients.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticalDashboard": JsonApiAutomationInRelationshipsAnalyticalDashboard.from_dict(obj["analyticalDashboard"]) if obj.get("analyticalDashboard") is not None else None, + "automationResults": JsonApiAutomationOutRelationshipsAutomationResults.from_dict(obj["automationResults"]) if obj.get("automationResults") is not None else None, + "createdBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "exportDefinitions": JsonApiAutomationInRelationshipsExportDefinitions.from_dict(obj["exportDefinitions"]) if obj.get("exportDefinitions") is not None else None, + "modifiedBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None, + "notificationChannel": JsonApiAutomationInRelationshipsNotificationChannel.from_dict(obj["notificationChannel"]) if obj.get("notificationChannel") is not None else None, + "recipients": JsonApiAutomationInRelationshipsRecipients.from_dict(obj["recipients"]) if obj.get("recipients") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_relationships_automation_results.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_relationships_automation_results.py new file mode 100644 index 000000000..8383487fe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_relationships_automation_results.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_automation_result_linkage import JsonApiAutomationResultLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationOutRelationshipsAutomationResults(BaseModel): + """ + JsonApiAutomationOutRelationshipsAutomationResults + """ # noqa: E501 + data: List[JsonApiAutomationResultLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutRelationshipsAutomationResults from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutRelationshipsAutomationResults from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiAutomationResultLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_with_links.py new file mode 100644 index 000000000..23b2ec6f9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_automation_out_attributes import JsonApiAutomationOutAttributes +from gooddata_api_client.models.json_api_automation_out_relationships import JsonApiAutomationOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationOutWithLinks(BaseModel): + """ + JsonApiAutomationOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiAutomationOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiAutomationOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['automation']): + raise ValueError("must be one of enum values ('automation')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAutomationOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiAutomationOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_patch.py new file mode 100644 index 000000000..2dc450cba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_patch.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_automation_in_attributes import JsonApiAutomationInAttributes +from gooddata_api_client.models.json_api_automation_in_relationships import JsonApiAutomationInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationPatch(BaseModel): + """ + JSON:API representation of patching automation entity. + """ # noqa: E501 + attributes: Optional[JsonApiAutomationInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiAutomationInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['automation']): + raise ValueError("must be one of enum values ('automation')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAutomationInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiAutomationInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_patch_document.py new file mode 100644 index 000000000..9ba09e4e1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_automation_patch import JsonApiAutomationPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationPatchDocument(BaseModel): + """ + JsonApiAutomationPatchDocument + """ # noqa: E501 + data: JsonApiAutomationPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAutomationPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_linkage.py new file mode 100644 index 000000000..5654b3d2a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationResultLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['automationResult']): + raise ValueError("must be one of enum values ('automationResult')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out.py new file mode 100644 index 000000000..3310d2d89 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_automation_result_out_attributes import JsonApiAutomationResultOutAttributes +from gooddata_api_client.models.json_api_automation_result_out_relationships import JsonApiAutomationResultOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationResultOut(BaseModel): + """ + JSON:API representation of automationResult entity. + """ # noqa: E501 + attributes: JsonApiAutomationResultOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiAutomationResultOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['automationResult']): + raise ValueError("must be one of enum values ('automationResult')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAutomationResultOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiAutomationResultOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_attributes.py new file mode 100644 index 000000000..c602d91ec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_attributes.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationResultOutAttributes(BaseModel): + """ + JsonApiAutomationResultOutAttributes + """ # noqa: E501 + error_message: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, alias="errorMessage") + executed_at: datetime = Field(description="Timestamp of the last automation run.", alias="executedAt") + status: StrictStr = Field(description="Status of the last automation run.") + trace_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="traceId") + __properties: ClassVar[List[str]] = ["errorMessage", "executedAt", "status", "traceId"] + + @field_validator('status') + def status_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['SUCCESS', 'FAILED']): + raise ValueError("must be one of enum values ('SUCCESS', 'FAILED')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "errorMessage": obj.get("errorMessage"), + "executedAt": obj.get("executedAt"), + "status": obj.get("status"), + "traceId": obj.get("traceId") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_relationships.py new file mode 100644 index 000000000..1535ee80e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_relationships.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_automation_result_out_relationships_automation import JsonApiAutomationResultOutRelationshipsAutomation +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationResultOutRelationships(BaseModel): + """ + JsonApiAutomationResultOutRelationships + """ # noqa: E501 + automation: Optional[JsonApiAutomationResultOutRelationshipsAutomation] = None + __properties: ClassVar[List[str]] = ["automation"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of automation + if self.automation: + _dict['automation'] = self.automation.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "automation": JsonApiAutomationResultOutRelationshipsAutomation.from_dict(obj["automation"]) if obj.get("automation") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_relationships_automation.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_relationships_automation.py new file mode 100644 index 000000000..e3ed8d761 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_relationships_automation.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_automation_to_one_linkage import JsonApiAutomationToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationResultOutRelationshipsAutomation(BaseModel): + """ + JsonApiAutomationResultOutRelationshipsAutomation + """ # noqa: E501 + data: Optional[JsonApiAutomationToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultOutRelationshipsAutomation from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultOutRelationshipsAutomation from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAutomationToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_with_links.py new file mode 100644 index 000000000..bbef24af6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_result_out_with_links.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_automation_result_out_attributes import JsonApiAutomationResultOutAttributes +from gooddata_api_client.models.json_api_automation_result_out_relationships import JsonApiAutomationResultOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiAutomationResultOutWithLinks(BaseModel): + """ + JsonApiAutomationResultOutWithLinks + """ # noqa: E501 + attributes: JsonApiAutomationResultOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiAutomationResultOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['automationResult']): + raise ValueError("must be one of enum values ('automationResult')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiAutomationResultOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAutomationResultOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiAutomationResultOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_automation_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_automation_to_one_linkage.py new file mode 100644 index 000000000..2697df0ea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_automation_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_automation_linkage import JsonApiAutomationLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIAUTOMATIONTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiAutomationLinkage"] + +class JsonApiAutomationToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiAutomationLinkage + oneof_schema_1_validator: Optional[JsonApiAutomationLinkage] = None + actual_instance: Optional[Union[JsonApiAutomationLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiAutomationLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiAutomationToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiAutomationLinkage + if not isinstance(v, JsonApiAutomationLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAutomationLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiAutomationToOneLinkage with oneOf schemas: JsonApiAutomationLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiAutomationToOneLinkage with oneOf schemas: JsonApiAutomationLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiAutomationLinkage + try: + instance.actual_instance = JsonApiAutomationLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiAutomationToOneLinkage with oneOf schemas: JsonApiAutomationLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiAutomationToOneLinkage with oneOf schemas: JsonApiAutomationLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAutomationLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_in.py new file mode 100644 index 000000000..b5c74780f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiColorPaletteIn(BaseModel): + """ + JSON:API representation of colorPalette entity. + """ # noqa: E501 + attributes: JsonApiColorPaletteInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['colorPalette']): + raise ValueError("must be one of enum values ('colorPalette')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiColorPaletteInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_in_attributes.py new file mode 100644 index 000000000..fa7b66f96 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_in_attributes.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiColorPaletteInAttributes(BaseModel): + """ + JsonApiColorPaletteInAttributes + """ # noqa: E501 + content: Dict[str, Any] = Field(description="Free-form JSON content. Maximum supported length is 15000 characters.") + name: Annotated[str, Field(strict=True, max_length=255)] + __properties: ClassVar[List[str]] = ["content", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_in_document.py new file mode 100644 index 000000000..eeeaf4d13 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_color_palette_in import JsonApiColorPaletteIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiColorPaletteInDocument(BaseModel): + """ + JsonApiColorPaletteInDocument + """ # noqa: E501 + data: JsonApiColorPaletteIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiColorPaletteIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out.py new file mode 100644 index 000000000..a4e39478d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiColorPaletteOut(BaseModel): + """ + JSON:API representation of colorPalette entity. + """ # noqa: E501 + attributes: JsonApiColorPaletteInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['colorPalette']): + raise ValueError("must be one of enum values ('colorPalette')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiColorPaletteInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out_document.py new file mode 100644 index 000000000..3ad6f9502 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_color_palette_out import JsonApiColorPaletteOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiColorPaletteOutDocument(BaseModel): + """ + JsonApiColorPaletteOutDocument + """ # noqa: E501 + data: JsonApiColorPaletteOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiColorPaletteOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out_list.py new file mode 100644 index 000000000..ad82cdb98 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_color_palette_out_with_links import JsonApiColorPaletteOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiColorPaletteOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiColorPaletteOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiColorPaletteOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out_with_links.py new file mode 100644 index 000000000..dcc569aed --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiColorPaletteOutWithLinks(BaseModel): + """ + JsonApiColorPaletteOutWithLinks + """ # noqa: E501 + attributes: JsonApiColorPaletteInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['colorPalette']): + raise ValueError("must be one of enum values ('colorPalette')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiColorPaletteOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiColorPaletteInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_patch.py new file mode 100644 index 000000000..69e2debeb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_color_palette_patch_attributes import JsonApiColorPalettePatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiColorPalettePatch(BaseModel): + """ + JSON:API representation of patching colorPalette entity. + """ # noqa: E501 + attributes: JsonApiColorPalettePatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['colorPalette']): + raise ValueError("must be one of enum values ('colorPalette')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiColorPalettePatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiColorPalettePatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiColorPalettePatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_patch_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_patch_attributes.py new file mode 100644 index 000000000..072d294d5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_patch_attributes.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiColorPalettePatchAttributes(BaseModel): + """ + JsonApiColorPalettePatchAttributes + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON content. Maximum supported length is 15000 characters.") + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["content", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiColorPalettePatchAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiColorPalettePatchAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_patch_document.py new file mode 100644 index 000000000..09448a903 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_color_palette_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_color_palette_patch import JsonApiColorPalettePatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiColorPalettePatchDocument(BaseModel): + """ + JsonApiColorPalettePatchDocument + """ # noqa: E501 + data: JsonApiColorPalettePatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiColorPalettePatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiColorPalettePatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiColorPalettePatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_in.py new file mode 100644 index 000000000..cb0a9f1e1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_cookie_security_configuration_in_attributes import JsonApiCookieSecurityConfigurationInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCookieSecurityConfigurationIn(BaseModel): + """ + JSON:API representation of cookieSecurityConfiguration entity. + """ # noqa: E501 + attributes: Optional[JsonApiCookieSecurityConfigurationInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['cookieSecurityConfiguration']): + raise ValueError("must be one of enum values ('cookieSecurityConfiguration')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCookieSecurityConfigurationInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_in_attributes.py new file mode 100644 index 000000000..3b410659d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_in_attributes.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCookieSecurityConfigurationInAttributes(BaseModel): + """ + JsonApiCookieSecurityConfigurationInAttributes + """ # noqa: E501 + last_rotation: Optional[datetime] = Field(default=None, alias="lastRotation") + rotation_interval: Optional[StrictStr] = Field(default=None, description="Length of interval between automatic rotations expressed in format of ISO 8601 duration", alias="rotationInterval") + __properties: ClassVar[List[str]] = ["lastRotation", "rotationInterval"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "lastRotation": obj.get("lastRotation"), + "rotationInterval": obj.get("rotationInterval") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_in_document.py new file mode 100644 index 000000000..dd60793ab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_cookie_security_configuration_in import JsonApiCookieSecurityConfigurationIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCookieSecurityConfigurationInDocument(BaseModel): + """ + JsonApiCookieSecurityConfigurationInDocument + """ # noqa: E501 + data: JsonApiCookieSecurityConfigurationIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiCookieSecurityConfigurationIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_out.py new file mode 100644 index 000000000..de2140143 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_cookie_security_configuration_in_attributes import JsonApiCookieSecurityConfigurationInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCookieSecurityConfigurationOut(BaseModel): + """ + JSON:API representation of cookieSecurityConfiguration entity. + """ # noqa: E501 + attributes: Optional[JsonApiCookieSecurityConfigurationInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['cookieSecurityConfiguration']): + raise ValueError("must be one of enum values ('cookieSecurityConfiguration')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCookieSecurityConfigurationInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_out_document.py new file mode 100644 index 000000000..ff43c696c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_cookie_security_configuration_out import JsonApiCookieSecurityConfigurationOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCookieSecurityConfigurationOutDocument(BaseModel): + """ + JsonApiCookieSecurityConfigurationOutDocument + """ # noqa: E501 + data: JsonApiCookieSecurityConfigurationOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiCookieSecurityConfigurationOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_patch.py new file mode 100644 index 000000000..6c864bbb6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_cookie_security_configuration_in_attributes import JsonApiCookieSecurityConfigurationInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCookieSecurityConfigurationPatch(BaseModel): + """ + JSON:API representation of patching cookieSecurityConfiguration entity. + """ # noqa: E501 + attributes: Optional[JsonApiCookieSecurityConfigurationInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['cookieSecurityConfiguration']): + raise ValueError("must be one of enum values ('cookieSecurityConfiguration')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCookieSecurityConfigurationInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_patch_document.py new file mode 100644 index 000000000..65505eaf6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_cookie_security_configuration_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_cookie_security_configuration_patch import JsonApiCookieSecurityConfigurationPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCookieSecurityConfigurationPatchDocument(BaseModel): + """ + JsonApiCookieSecurityConfigurationPatchDocument + """ # noqa: E501 + data: JsonApiCookieSecurityConfigurationPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCookieSecurityConfigurationPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiCookieSecurityConfigurationPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_in.py new file mode 100644 index 000000000..54c2dda0c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCspDirectiveIn(BaseModel): + """ + JSON:API representation of cspDirective entity. + """ # noqa: E501 + attributes: JsonApiCspDirectiveInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['cspDirective']): + raise ValueError("must be one of enum values ('cspDirective')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCspDirectiveInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_in_attributes.py new file mode 100644 index 000000000..452b324fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_in_attributes.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCspDirectiveInAttributes(BaseModel): + """ + JsonApiCspDirectiveInAttributes + """ # noqa: E501 + sources: List[StrictStr] + __properties: ClassVar[List[str]] = ["sources"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sources": obj.get("sources") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_in_document.py new file mode 100644 index 000000000..4cbaf9e2f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_csp_directive_in import JsonApiCspDirectiveIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCspDirectiveInDocument(BaseModel): + """ + JsonApiCspDirectiveInDocument + """ # noqa: E501 + data: JsonApiCspDirectiveIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiCspDirectiveIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out.py new file mode 100644 index 000000000..e46477c7e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCspDirectiveOut(BaseModel): + """ + JSON:API representation of cspDirective entity. + """ # noqa: E501 + attributes: JsonApiCspDirectiveInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['cspDirective']): + raise ValueError("must be one of enum values ('cspDirective')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCspDirectiveInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out_document.py new file mode 100644 index 000000000..bb4539062 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_csp_directive_out import JsonApiCspDirectiveOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCspDirectiveOutDocument(BaseModel): + """ + JsonApiCspDirectiveOutDocument + """ # noqa: E501 + data: JsonApiCspDirectiveOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiCspDirectiveOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out_list.py new file mode 100644 index 000000000..0f7735af7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_csp_directive_out_with_links import JsonApiCspDirectiveOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCspDirectiveOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiCspDirectiveOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiCspDirectiveOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out_with_links.py new file mode 100644 index 000000000..cd9d908c0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCspDirectiveOutWithLinks(BaseModel): + """ + JsonApiCspDirectiveOutWithLinks + """ # noqa: E501 + attributes: JsonApiCspDirectiveInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['cspDirective']): + raise ValueError("must be one of enum values ('cspDirective')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCspDirectiveOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCspDirectiveInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_patch.py new file mode 100644 index 000000000..247df92b6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_csp_directive_patch_attributes import JsonApiCspDirectivePatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCspDirectivePatch(BaseModel): + """ + JSON:API representation of patching cspDirective entity. + """ # noqa: E501 + attributes: JsonApiCspDirectivePatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['cspDirective']): + raise ValueError("must be one of enum values ('cspDirective')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCspDirectivePatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCspDirectivePatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCspDirectivePatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_patch_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_patch_attributes.py new file mode 100644 index 000000000..41a2ffd61 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_patch_attributes.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCspDirectivePatchAttributes(BaseModel): + """ + JsonApiCspDirectivePatchAttributes + """ # noqa: E501 + sources: Optional[List[StrictStr]] = None + __properties: ClassVar[List[str]] = ["sources"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCspDirectivePatchAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCspDirectivePatchAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sources": obj.get("sources") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_patch_document.py new file mode 100644 index 000000000..1628d1e6c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_csp_directive_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_csp_directive_patch import JsonApiCspDirectivePatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCspDirectivePatchDocument(BaseModel): + """ + JsonApiCspDirectivePatchDocument + """ # noqa: E501 + data: JsonApiCspDirectivePatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCspDirectivePatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCspDirectivePatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiCspDirectivePatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_in.py new file mode 100644 index 000000000..3b59d4723 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingIn(BaseModel): + """ + JSON:API representation of customApplicationSetting entity. + """ # noqa: E501 + attributes: JsonApiCustomApplicationSettingInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['customApplicationSetting']): + raise ValueError("must be one of enum values ('customApplicationSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCustomApplicationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_in_attributes.py new file mode 100644 index 000000000..0dcbd902d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_in_attributes.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingInAttributes(BaseModel): + """ + JsonApiCustomApplicationSettingInAttributes + """ # noqa: E501 + application_name: Annotated[str, Field(strict=True, max_length=255)] = Field(alias="applicationName") + content: Dict[str, Any] = Field(description="Free-form JSON content. Maximum supported length is 15000 characters.") + __properties: ClassVar[List[str]] = ["applicationName", "content"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applicationName": obj.get("applicationName"), + "content": obj.get("content") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_in_document.py new file mode 100644 index 000000000..eaa452c32 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_custom_application_setting_in import JsonApiCustomApplicationSettingIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingInDocument(BaseModel): + """ + JsonApiCustomApplicationSettingInDocument + """ # noqa: E501 + data: JsonApiCustomApplicationSettingIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiCustomApplicationSettingIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out.py new file mode 100644 index 000000000..e77e9575e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingOut(BaseModel): + """ + JSON:API representation of customApplicationSetting entity. + """ # noqa: E501 + attributes: JsonApiCustomApplicationSettingInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['customApplicationSetting']): + raise ValueError("must be one of enum values ('customApplicationSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCustomApplicationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out_document.py new file mode 100644 index 000000000..bd0f21358 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_custom_application_setting_out import JsonApiCustomApplicationSettingOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingOutDocument(BaseModel): + """ + JsonApiCustomApplicationSettingOutDocument + """ # noqa: E501 + data: JsonApiCustomApplicationSettingOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiCustomApplicationSettingOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out_list.py new file mode 100644 index 000000000..a68ba29bc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_custom_application_setting_out_with_links import JsonApiCustomApplicationSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiCustomApplicationSettingOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiCustomApplicationSettingOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out_with_links.py new file mode 100644 index 000000000..2887b858f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_out_with_links.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingOutWithLinks(BaseModel): + """ + JsonApiCustomApplicationSettingOutWithLinks + """ # noqa: E501 + attributes: JsonApiCustomApplicationSettingInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['customApplicationSetting']): + raise ValueError("must be one of enum values ('customApplicationSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCustomApplicationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_patch.py new file mode 100644 index 000000000..6bca9c93a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_custom_application_setting_patch_attributes import JsonApiCustomApplicationSettingPatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingPatch(BaseModel): + """ + JSON:API representation of patching customApplicationSetting entity. + """ # noqa: E501 + attributes: JsonApiCustomApplicationSettingPatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['customApplicationSetting']): + raise ValueError("must be one of enum values ('customApplicationSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCustomApplicationSettingPatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_patch_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_patch_attributes.py new file mode 100644 index 000000000..e6fdf24d7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_patch_attributes.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingPatchAttributes(BaseModel): + """ + JsonApiCustomApplicationSettingPatchAttributes + """ # noqa: E501 + application_name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="applicationName") + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON content. Maximum supported length is 15000 characters.") + __properties: ClassVar[List[str]] = ["applicationName", "content"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingPatchAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingPatchAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applicationName": obj.get("applicationName"), + "content": obj.get("content") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_patch_document.py new file mode 100644 index 000000000..4700c853f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_custom_application_setting_patch import JsonApiCustomApplicationSettingPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingPatchDocument(BaseModel): + """ + JsonApiCustomApplicationSettingPatchDocument + """ # noqa: E501 + data: JsonApiCustomApplicationSettingPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiCustomApplicationSettingPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_post_optional_id.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_post_optional_id.py new file mode 100644 index 000000000..c8b6a577e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_post_optional_id.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_custom_application_setting_in_attributes import JsonApiCustomApplicationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingPostOptionalId(BaseModel): + """ + JSON:API representation of customApplicationSetting entity. + """ # noqa: E501 + attributes: JsonApiCustomApplicationSettingInAttributes + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['customApplicationSetting']): + raise ValueError("must be one of enum values ('customApplicationSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingPostOptionalId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingPostOptionalId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiCustomApplicationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_post_optional_id_document.py new file mode 100644 index 000000000..a2f5688ca --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_custom_application_setting_post_optional_id_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id import JsonApiCustomApplicationSettingPostOptionalId +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiCustomApplicationSettingPostOptionalIdDocument(BaseModel): + """ + JsonApiCustomApplicationSettingPostOptionalIdDocument + """ # noqa: E501 + data: JsonApiCustomApplicationSettingPostOptionalId + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingPostOptionalIdDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiCustomApplicationSettingPostOptionalIdDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiCustomApplicationSettingPostOptionalId.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_in.py new file mode 100644 index 000000000..f7939ffd7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_dashboard_plugin_in_attributes import JsonApiDashboardPluginInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginIn(BaseModel): + """ + JSON:API representation of dashboardPlugin entity. + """ # noqa: E501 + attributes: Optional[JsonApiDashboardPluginInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dashboardPlugin']): + raise ValueError("must be one of enum values ('dashboardPlugin')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDashboardPluginInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_in_attributes.py new file mode 100644 index 000000000..be01a93dc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_in_attributes.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginInAttributes(BaseModel): + """ + JsonApiDashboardPluginInAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON content. Maximum supported length is 250000 characters.") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "description", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "description": obj.get("description"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_in_document.py new file mode 100644 index 000000000..b2cae9d98 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_dashboard_plugin_in import JsonApiDashboardPluginIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginInDocument(BaseModel): + """ + JsonApiDashboardPluginInDocument + """ # noqa: E501 + data: JsonApiDashboardPluginIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiDashboardPluginIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_linkage.py new file mode 100644 index 000000000..d1f106139 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dashboardPlugin']): + raise ValueError("must be one of enum values ('dashboardPlugin')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out.py new file mode 100644 index 000000000..0f06da69b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_dashboard_plugin_out_attributes import JsonApiDashboardPluginOutAttributes +from gooddata_api_client.models.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginOut(BaseModel): + """ + JSON:API representation of dashboardPlugin entity. + """ # noqa: E501 + attributes: Optional[JsonApiDashboardPluginOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiDashboardPluginOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dashboardPlugin']): + raise ValueError("must be one of enum values ('dashboardPlugin')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDashboardPluginOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiDashboardPluginOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_attributes.py new file mode 100644 index 000000000..2c88f7b76 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_attributes.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginOutAttributes(BaseModel): + """ + JsonApiDashboardPluginOutAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON content. Maximum supported length is 250000 characters.") + created_at: Optional[datetime] = Field(default=None, alias="createdAt") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + modified_at: Optional[datetime] = Field(default=None, alias="modifiedAt") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "createdAt", "description", "modifiedAt", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "createdAt": obj.get("createdAt"), + "description": obj.get("description"), + "modifiedAt": obj.get("modifiedAt"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_document.py new file mode 100644 index 000000000..a774cffdd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginOutDocument(BaseModel): + """ + JsonApiDashboardPluginOutDocument + """ # noqa: E501 + data: JsonApiDashboardPluginOut + included: Optional[List[JsonApiUserIdentifierOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiDashboardPluginOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiUserIdentifierOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_list.py new file mode 100644 index 000000000..d106eecf4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiDashboardPluginOutWithLinks] + included: Optional[List[JsonApiUserIdentifierOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiDashboardPluginOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiUserIdentifierOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_relationships.py new file mode 100644 index 000000000..fb2135d30 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_relationships.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginOutRelationships(BaseModel): + """ + JsonApiDashboardPluginOutRelationships + """ # noqa: E501 + created_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="createdBy") + modified_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="modifiedBy") + __properties: ClassVar[List[str]] = ["createdBy", "modifiedBy"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "createdBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "modifiedBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_with_links.py new file mode 100644 index 000000000..c2a59b29c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_dashboard_plugin_out_attributes import JsonApiDashboardPluginOutAttributes +from gooddata_api_client.models.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginOutWithLinks(BaseModel): + """ + JsonApiDashboardPluginOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiDashboardPluginOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiDashboardPluginOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dashboardPlugin']): + raise ValueError("must be one of enum values ('dashboardPlugin')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDashboardPluginOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiDashboardPluginOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_patch.py new file mode 100644 index 000000000..ce4e993cb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_dashboard_plugin_in_attributes import JsonApiDashboardPluginInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginPatch(BaseModel): + """ + JSON:API representation of patching dashboardPlugin entity. + """ # noqa: E501 + attributes: Optional[JsonApiDashboardPluginInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dashboardPlugin']): + raise ValueError("must be one of enum values ('dashboardPlugin')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDashboardPluginInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_patch_document.py new file mode 100644 index 000000000..896a184b7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_dashboard_plugin_patch import JsonApiDashboardPluginPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginPatchDocument(BaseModel): + """ + JsonApiDashboardPluginPatchDocument + """ # noqa: E501 + data: JsonApiDashboardPluginPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiDashboardPluginPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_post_optional_id.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_post_optional_id.py new file mode 100644 index 000000000..c4f6d3075 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_post_optional_id.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_dashboard_plugin_in_attributes import JsonApiDashboardPluginInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginPostOptionalId(BaseModel): + """ + JSON:API representation of dashboardPlugin entity. + """ # noqa: E501 + attributes: Optional[JsonApiDashboardPluginInAttributes] = None + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dashboardPlugin']): + raise ValueError("must be one of enum values ('dashboardPlugin')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginPostOptionalId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginPostOptionalId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDashboardPluginInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_post_optional_id_document.py new file mode 100644 index 000000000..ad18721cf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dashboard_plugin_post_optional_id_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id import JsonApiDashboardPluginPostOptionalId +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDashboardPluginPostOptionalIdDocument(BaseModel): + """ + JsonApiDashboardPluginPostOptionalIdDocument + """ # noqa: E501 + data: JsonApiDashboardPluginPostOptionalId + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginPostOptionalIdDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDashboardPluginPostOptionalIdDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiDashboardPluginPostOptionalId.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out.py new file mode 100644 index 000000000..b01a51ddf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_data_source_identifier_out_attributes import JsonApiDataSourceIdentifierOutAttributes +from gooddata_api_client.models.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceIdentifierOut(BaseModel): + """ + JSON:API representation of dataSourceIdentifier entity. + """ # noqa: E501 + attributes: JsonApiDataSourceIdentifierOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiDataSourceIdentifierOutMeta] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataSourceIdentifier']): + raise ValueError("must be one of enum values ('dataSourceIdentifier')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDataSourceIdentifierOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiDataSourceIdentifierOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_attributes.py new file mode 100644 index 000000000..f81610a07 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_attributes.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceIdentifierOutAttributes(BaseModel): + """ + JsonApiDataSourceIdentifierOutAttributes + """ # noqa: E501 + name: Annotated[str, Field(strict=True, max_length=255)] + var_schema: Annotated[str, Field(strict=True, max_length=255)] = Field(alias="schema") + type: StrictStr + __properties: ClassVar[List[str]] = ["name", "schema", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB']): + raise ValueError("must be one of enum values ('POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "schema": obj.get("schema"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_document.py new file mode 100644 index 000000000..29991b064 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_data_source_identifier_out import JsonApiDataSourceIdentifierOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceIdentifierOutDocument(BaseModel): + """ + JsonApiDataSourceIdentifierOutDocument + """ # noqa: E501 + data: JsonApiDataSourceIdentifierOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiDataSourceIdentifierOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_list.py new file mode 100644 index 000000000..a83719a4f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_data_source_identifier_out_with_links import JsonApiDataSourceIdentifierOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceIdentifierOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiDataSourceIdentifierOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiDataSourceIdentifierOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_meta.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_meta.py new file mode 100644 index 000000000..afd74565e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_meta.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceIdentifierOutMeta(BaseModel): + """ + JsonApiDataSourceIdentifierOutMeta + """ # noqa: E501 + permissions: Optional[List[StrictStr]] = Field(default=None, description="List of valid permissions for a logged-in user.") + __properties: ClassVar[List[str]] = ["permissions"] + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['MANAGE', 'USE']): + raise ValueError("each list item must be one of ('MANAGE', 'USE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOutMeta from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOutMeta from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": obj.get("permissions") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_with_links.py new file mode 100644 index 000000000..9137b659f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_identifier_out_with_links.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_data_source_identifier_out_attributes import JsonApiDataSourceIdentifierOutAttributes +from gooddata_api_client.models.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceIdentifierOutWithLinks(BaseModel): + """ + JsonApiDataSourceIdentifierOutWithLinks + """ # noqa: E501 + attributes: JsonApiDataSourceIdentifierOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiDataSourceIdentifierOutMeta] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataSourceIdentifier']): + raise ValueError("must be one of enum values ('dataSourceIdentifier')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIdentifierOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDataSourceIdentifierOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiDataSourceIdentifierOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in.py new file mode 100644 index 000000000..4a0e2dce2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_data_source_in_attributes import JsonApiDataSourceInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceIn(BaseModel): + """ + JSON:API representation of dataSource entity. + """ # noqa: E501 + attributes: JsonApiDataSourceInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataSource']): + raise ValueError("must be one of enum values ('dataSource')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDataSourceInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in_attributes.py new file mode 100644 index 000000000..4e64c92c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in_attributes.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceInAttributes(BaseModel): + """ + JsonApiDataSourceInAttributes + """ # noqa: E501 + cache_strategy: Optional[StrictStr] = Field(default=None, description="Determines how the results coming from a particular datasource should be cached.", alias="cacheStrategy") + client_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", alias="clientId") + client_secret: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", alias="clientSecret") + name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="User-facing name of the data source.") + parameters: Optional[List[JsonApiDataSourceInAttributesParametersInner]] = Field(default=None, description="Additional parameters to be used when connecting to the database providing the data for the data source.") + password: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The password to use to connect to the database providing the data for the data source.") + private_key: Optional[Annotated[str, Field(strict=True, max_length=15000)]] = Field(default=None, description="The private key to use to connect to the database providing the data for the data source.", alias="privateKey") + private_key_passphrase: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The passphrase used to encrypt the private key.", alias="privateKeyPassphrase") + var_schema: Annotated[str, Field(strict=True, max_length=255)] = Field(description="The schema to use as the root of the data for the data source.", alias="schema") + token: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).") + type: StrictStr = Field(description="Type of the database providing the data for the data source.") + url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The URL of the database providing the data for the data source.") + username: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The username to use to connect to the database providing the data for the data source.") + __properties: ClassVar[List[str]] = ["cacheStrategy", "clientId", "clientSecret", "name", "parameters", "password", "privateKey", "privateKeyPassphrase", "schema", "token", "type", "url", "username"] + + @field_validator('cache_strategy') + def cache_strategy_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ALWAYS', 'NEVER']): + raise ValueError("must be one of enum values ('ALWAYS', 'NEVER')") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB']): + raise ValueError("must be one of enum values ('POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in parameters (list) + _items = [] + if self.parameters: + for _item_parameters in self.parameters: + if _item_parameters: + _items.append(_item_parameters.to_dict()) + _dict['parameters'] = _items + # set to None if cache_strategy (nullable) is None + # and model_fields_set contains the field + if self.cache_strategy is None and "cache_strategy" in self.model_fields_set: + _dict['cacheStrategy'] = None + + # set to None if client_id (nullable) is None + # and model_fields_set contains the field + if self.client_id is None and "client_id" in self.model_fields_set: + _dict['clientId'] = None + + # set to None if client_secret (nullable) is None + # and model_fields_set contains the field + if self.client_secret is None and "client_secret" in self.model_fields_set: + _dict['clientSecret'] = None + + # set to None if parameters (nullable) is None + # and model_fields_set contains the field + if self.parameters is None and "parameters" in self.model_fields_set: + _dict['parameters'] = None + + # set to None if password (nullable) is None + # and model_fields_set contains the field + if self.password is None and "password" in self.model_fields_set: + _dict['password'] = None + + # set to None if private_key (nullable) is None + # and model_fields_set contains the field + if self.private_key is None and "private_key" in self.model_fields_set: + _dict['privateKey'] = None + + # set to None if private_key_passphrase (nullable) is None + # and model_fields_set contains the field + if self.private_key_passphrase is None and "private_key_passphrase" in self.model_fields_set: + _dict['privateKeyPassphrase'] = None + + # set to None if token (nullable) is None + # and model_fields_set contains the field + if self.token is None and "token" in self.model_fields_set: + _dict['token'] = None + + # set to None if url (nullable) is None + # and model_fields_set contains the field + if self.url is None and "url" in self.model_fields_set: + _dict['url'] = None + + # set to None if username (nullable) is None + # and model_fields_set contains the field + if self.username is None and "username" in self.model_fields_set: + _dict['username'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cacheStrategy": obj.get("cacheStrategy"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "name": obj.get("name"), + "parameters": [JsonApiDataSourceInAttributesParametersInner.from_dict(_item) for _item in obj["parameters"]] if obj.get("parameters") is not None else None, + "password": obj.get("password"), + "privateKey": obj.get("privateKey"), + "privateKeyPassphrase": obj.get("privateKeyPassphrase"), + "schema": obj.get("schema"), + "token": obj.get("token"), + "type": obj.get("type"), + "url": obj.get("url"), + "username": obj.get("username") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in_attributes_parameters_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in_attributes_parameters_inner.py new file mode 100644 index 000000000..d0bd7f856 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in_attributes_parameters_inner.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceInAttributesParametersInner(BaseModel): + """ + JsonApiDataSourceInAttributesParametersInner + """ # noqa: E501 + name: StrictStr + value: StrictStr + __properties: ClassVar[List[str]] = ["name", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceInAttributesParametersInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceInAttributesParametersInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in_document.py new file mode 100644 index 000000000..54341a0da --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_data_source_in import JsonApiDataSourceIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceInDocument(BaseModel): + """ + JsonApiDataSourceInDocument + """ # noqa: E501 + data: JsonApiDataSourceIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiDataSourceIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out.py new file mode 100644 index 000000000..81e65ce3e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta +from gooddata_api_client.models.json_api_data_source_out_attributes import JsonApiDataSourceOutAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceOut(BaseModel): + """ + JSON:API representation of dataSource entity. + """ # noqa: E501 + attributes: JsonApiDataSourceOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiDataSourceIdentifierOutMeta] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataSource']): + raise ValueError("must be one of enum values ('dataSource')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDataSourceOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiDataSourceIdentifierOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_attributes.py new file mode 100644 index 000000000..877386b0a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_attributes.py @@ -0,0 +1,184 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceOutAttributes(BaseModel): + """ + JsonApiDataSourceOutAttributes + """ # noqa: E501 + authentication_type: Optional[StrictStr] = Field(default=None, description="Type of authentication used to connect to the database.", alias="authenticationType") + cache_strategy: Optional[StrictStr] = Field(default=None, description="Determines how the results coming from a particular datasource should be cached.", alias="cacheStrategy") + client_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", alias="clientId") + decoded_parameters: Optional[List[JsonApiDataSourceInAttributesParametersInner]] = Field(default=None, description="Decoded parameters to be used when connecting to the database providing the data for the data source.", alias="decodedParameters") + name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="User-facing name of the data source.") + parameters: Optional[List[JsonApiDataSourceInAttributesParametersInner]] = Field(default=None, description="Additional parameters to be used when connecting to the database providing the data for the data source.") + var_schema: Annotated[str, Field(strict=True, max_length=255)] = Field(description="The schema to use as the root of the data for the data source.", alias="schema") + type: StrictStr = Field(description="Type of the database providing the data for the data source.") + url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The URL of the database providing the data for the data source.") + username: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The username to use to connect to the database providing the data for the data source.") + __properties: ClassVar[List[str]] = ["authenticationType", "cacheStrategy", "clientId", "decodedParameters", "name", "parameters", "schema", "type", "url", "username"] + + @field_validator('authentication_type') + def authentication_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['USERNAME_PASSWORD', 'TOKEN', 'KEY_PAIR', 'CLIENT_SECRET', 'ACCESS_TOKEN']): + raise ValueError("must be one of enum values ('USERNAME_PASSWORD', 'TOKEN', 'KEY_PAIR', 'CLIENT_SECRET', 'ACCESS_TOKEN')") + return value + + @field_validator('cache_strategy') + def cache_strategy_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ALWAYS', 'NEVER']): + raise ValueError("must be one of enum values ('ALWAYS', 'NEVER')") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB']): + raise ValueError("must be one of enum values ('POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in decoded_parameters (list) + _items = [] + if self.decoded_parameters: + for _item_decoded_parameters in self.decoded_parameters: + if _item_decoded_parameters: + _items.append(_item_decoded_parameters.to_dict()) + _dict['decodedParameters'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in parameters (list) + _items = [] + if self.parameters: + for _item_parameters in self.parameters: + if _item_parameters: + _items.append(_item_parameters.to_dict()) + _dict['parameters'] = _items + # set to None if authentication_type (nullable) is None + # and model_fields_set contains the field + if self.authentication_type is None and "authentication_type" in self.model_fields_set: + _dict['authenticationType'] = None + + # set to None if cache_strategy (nullable) is None + # and model_fields_set contains the field + if self.cache_strategy is None and "cache_strategy" in self.model_fields_set: + _dict['cacheStrategy'] = None + + # set to None if client_id (nullable) is None + # and model_fields_set contains the field + if self.client_id is None and "client_id" in self.model_fields_set: + _dict['clientId'] = None + + # set to None if decoded_parameters (nullable) is None + # and model_fields_set contains the field + if self.decoded_parameters is None and "decoded_parameters" in self.model_fields_set: + _dict['decodedParameters'] = None + + # set to None if parameters (nullable) is None + # and model_fields_set contains the field + if self.parameters is None and "parameters" in self.model_fields_set: + _dict['parameters'] = None + + # set to None if url (nullable) is None + # and model_fields_set contains the field + if self.url is None and "url" in self.model_fields_set: + _dict['url'] = None + + # set to None if username (nullable) is None + # and model_fields_set contains the field + if self.username is None and "username" in self.model_fields_set: + _dict['username'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "authenticationType": obj.get("authenticationType"), + "cacheStrategy": obj.get("cacheStrategy"), + "clientId": obj.get("clientId"), + "decodedParameters": [JsonApiDataSourceInAttributesParametersInner.from_dict(_item) for _item in obj["decodedParameters"]] if obj.get("decodedParameters") is not None else None, + "name": obj.get("name"), + "parameters": [JsonApiDataSourceInAttributesParametersInner.from_dict(_item) for _item in obj["parameters"]] if obj.get("parameters") is not None else None, + "schema": obj.get("schema"), + "type": obj.get("type"), + "url": obj.get("url"), + "username": obj.get("username") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_document.py new file mode 100644 index 000000000..8f3888f55 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_data_source_out import JsonApiDataSourceOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceOutDocument(BaseModel): + """ + JsonApiDataSourceOutDocument + """ # noqa: E501 + data: JsonApiDataSourceOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiDataSourceOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_list.py new file mode 100644 index 000000000..facf8b513 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_data_source_out_with_links import JsonApiDataSourceOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiDataSourceOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiDataSourceOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_with_links.py new file mode 100644 index 000000000..6b34a3447 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_out_with_links.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_data_source_identifier_out_meta import JsonApiDataSourceIdentifierOutMeta +from gooddata_api_client.models.json_api_data_source_out_attributes import JsonApiDataSourceOutAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourceOutWithLinks(BaseModel): + """ + JsonApiDataSourceOutWithLinks + """ # noqa: E501 + attributes: JsonApiDataSourceOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiDataSourceIdentifierOutMeta] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataSource']): + raise ValueError("must be one of enum values ('dataSource')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourceOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourceOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDataSourceOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiDataSourceIdentifierOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_patch.py new file mode 100644 index 000000000..3d657787f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_data_source_patch_attributes import JsonApiDataSourcePatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourcePatch(BaseModel): + """ + JSON:API representation of patching dataSource entity. + """ # noqa: E501 + attributes: JsonApiDataSourcePatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataSource']): + raise ValueError("must be one of enum values ('dataSource')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourcePatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourcePatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDataSourcePatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_patch_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_patch_attributes.py new file mode 100644 index 000000000..42ec90ade --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_patch_attributes.py @@ -0,0 +1,191 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourcePatchAttributes(BaseModel): + """ + JsonApiDataSourcePatchAttributes + """ # noqa: E501 + cache_strategy: Optional[StrictStr] = Field(default=None, description="Determines how the results coming from a particular datasource should be cached.", alias="cacheStrategy") + client_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", alias="clientId") + client_secret: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", alias="clientSecret") + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="User-facing name of the data source.") + parameters: Optional[List[JsonApiDataSourceInAttributesParametersInner]] = Field(default=None, description="Additional parameters to be used when connecting to the database providing the data for the data source.") + password: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The password to use to connect to the database providing the data for the data source.") + private_key: Optional[Annotated[str, Field(strict=True, max_length=15000)]] = Field(default=None, description="The private key to use to connect to the database providing the data for the data source.", alias="privateKey") + private_key_passphrase: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The passphrase used to encrypt the private key.", alias="privateKeyPassphrase") + var_schema: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The schema to use as the root of the data for the data source.", alias="schema") + token: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).") + type: Optional[StrictStr] = Field(default=None, description="Type of the database providing the data for the data source.") + url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The URL of the database providing the data for the data source.") + username: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The username to use to connect to the database providing the data for the data source.") + __properties: ClassVar[List[str]] = ["cacheStrategy", "clientId", "clientSecret", "name", "parameters", "password", "privateKey", "privateKeyPassphrase", "schema", "token", "type", "url", "username"] + + @field_validator('cache_strategy') + def cache_strategy_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ALWAYS', 'NEVER']): + raise ValueError("must be one of enum values ('ALWAYS', 'NEVER')") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB']): + raise ValueError("must be one of enum values ('POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourcePatchAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in parameters (list) + _items = [] + if self.parameters: + for _item_parameters in self.parameters: + if _item_parameters: + _items.append(_item_parameters.to_dict()) + _dict['parameters'] = _items + # set to None if cache_strategy (nullable) is None + # and model_fields_set contains the field + if self.cache_strategy is None and "cache_strategy" in self.model_fields_set: + _dict['cacheStrategy'] = None + + # set to None if client_id (nullable) is None + # and model_fields_set contains the field + if self.client_id is None and "client_id" in self.model_fields_set: + _dict['clientId'] = None + + # set to None if client_secret (nullable) is None + # and model_fields_set contains the field + if self.client_secret is None and "client_secret" in self.model_fields_set: + _dict['clientSecret'] = None + + # set to None if parameters (nullable) is None + # and model_fields_set contains the field + if self.parameters is None and "parameters" in self.model_fields_set: + _dict['parameters'] = None + + # set to None if password (nullable) is None + # and model_fields_set contains the field + if self.password is None and "password" in self.model_fields_set: + _dict['password'] = None + + # set to None if private_key (nullable) is None + # and model_fields_set contains the field + if self.private_key is None and "private_key" in self.model_fields_set: + _dict['privateKey'] = None + + # set to None if private_key_passphrase (nullable) is None + # and model_fields_set contains the field + if self.private_key_passphrase is None and "private_key_passphrase" in self.model_fields_set: + _dict['privateKeyPassphrase'] = None + + # set to None if token (nullable) is None + # and model_fields_set contains the field + if self.token is None and "token" in self.model_fields_set: + _dict['token'] = None + + # set to None if url (nullable) is None + # and model_fields_set contains the field + if self.url is None and "url" in self.model_fields_set: + _dict['url'] = None + + # set to None if username (nullable) is None + # and model_fields_set contains the field + if self.username is None and "username" in self.model_fields_set: + _dict['username'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourcePatchAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cacheStrategy": obj.get("cacheStrategy"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "name": obj.get("name"), + "parameters": [JsonApiDataSourceInAttributesParametersInner.from_dict(_item) for _item in obj["parameters"]] if obj.get("parameters") is not None else None, + "password": obj.get("password"), + "privateKey": obj.get("privateKey"), + "privateKeyPassphrase": obj.get("privateKeyPassphrase"), + "schema": obj.get("schema"), + "token": obj.get("token"), + "type": obj.get("type"), + "url": obj.get("url"), + "username": obj.get("username") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_data_source_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_patch_document.py new file mode 100644 index 000000000..9e234fed3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_data_source_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_data_source_patch import JsonApiDataSourcePatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDataSourcePatchDocument(BaseModel): + """ + JsonApiDataSourcePatchDocument + """ # noqa: E501 + data: JsonApiDataSourcePatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDataSourcePatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDataSourcePatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiDataSourcePatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_linkage.py new file mode 100644 index 000000000..769b49ea6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataset']): + raise ValueError("must be one of enum values ('dataset')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out.py new file mode 100644 index 000000000..92001806e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_dataset_out_attributes import JsonApiDatasetOutAttributes +from gooddata_api_client.models.json_api_dataset_out_relationships import JsonApiDatasetOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOut(BaseModel): + """ + JSON:API representation of dataset entity. + """ # noqa: E501 + attributes: JsonApiDatasetOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiDatasetOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataset']): + raise ValueError("must be one of enum values ('dataset')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDatasetOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiDatasetOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes.py new file mode 100644 index 000000000..f968a299e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes.py @@ -0,0 +1,156 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_dataset_out_attributes_grain_inner import JsonApiDatasetOutAttributesGrainInner +from gooddata_api_client.models.json_api_dataset_out_attributes_reference_properties_inner import JsonApiDatasetOutAttributesReferencePropertiesInner +from gooddata_api_client.models.json_api_dataset_out_attributes_sql import JsonApiDatasetOutAttributesSql +from gooddata_api_client.models.json_api_dataset_out_attributes_workspace_data_filter_columns_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner +from gooddata_api_client.models.json_api_dataset_out_attributes_workspace_data_filter_references_inner import JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutAttributes(BaseModel): + """ + JsonApiDatasetOutAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + data_source_table_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="dataSourceTableId") + data_source_table_path: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="Path to database table.", alias="dataSourceTablePath") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + grain: Optional[List[JsonApiDatasetOutAttributesGrainInner]] = None + precedence: Optional[StrictInt] = None + reference_properties: Optional[List[JsonApiDatasetOutAttributesReferencePropertiesInner]] = Field(default=None, alias="referenceProperties") + sql: Optional[JsonApiDatasetOutAttributesSql] = None + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + type: StrictStr + workspace_data_filter_columns: Optional[List[JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner]] = Field(default=None, alias="workspaceDataFilterColumns") + workspace_data_filter_references: Optional[List[JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner]] = Field(default=None, alias="workspaceDataFilterReferences") + __properties: ClassVar[List[str]] = ["areRelationsValid", "dataSourceTableId", "dataSourceTablePath", "description", "grain", "precedence", "referenceProperties", "sql", "tags", "title", "type", "workspaceDataFilterColumns", "workspaceDataFilterReferences"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['NORMAL', 'DATE']): + raise ValueError("must be one of enum values ('NORMAL', 'DATE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in grain (list) + _items = [] + if self.grain: + for _item_grain in self.grain: + if _item_grain: + _items.append(_item_grain.to_dict()) + _dict['grain'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in reference_properties (list) + _items = [] + if self.reference_properties: + for _item_reference_properties in self.reference_properties: + if _item_reference_properties: + _items.append(_item_reference_properties.to_dict()) + _dict['referenceProperties'] = _items + # override the default output from pydantic by calling `to_dict()` of sql + if self.sql: + _dict['sql'] = self.sql.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in workspace_data_filter_columns (list) + _items = [] + if self.workspace_data_filter_columns: + for _item_workspace_data_filter_columns in self.workspace_data_filter_columns: + if _item_workspace_data_filter_columns: + _items.append(_item_workspace_data_filter_columns.to_dict()) + _dict['workspaceDataFilterColumns'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in workspace_data_filter_references (list) + _items = [] + if self.workspace_data_filter_references: + for _item_workspace_data_filter_references in self.workspace_data_filter_references: + if _item_workspace_data_filter_references: + _items.append(_item_workspace_data_filter_references.to_dict()) + _dict['workspaceDataFilterReferences'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "dataSourceTableId": obj.get("dataSourceTableId"), + "dataSourceTablePath": obj.get("dataSourceTablePath"), + "description": obj.get("description"), + "grain": [JsonApiDatasetOutAttributesGrainInner.from_dict(_item) for _item in obj["grain"]] if obj.get("grain") is not None else None, + "precedence": obj.get("precedence"), + "referenceProperties": [JsonApiDatasetOutAttributesReferencePropertiesInner.from_dict(_item) for _item in obj["referenceProperties"]] if obj.get("referenceProperties") is not None else None, + "sql": JsonApiDatasetOutAttributesSql.from_dict(obj["sql"]) if obj.get("sql") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title"), + "type": obj.get("type"), + "workspaceDataFilterColumns": [JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner.from_dict(_item) for _item in obj["workspaceDataFilterColumns"]] if obj.get("workspaceDataFilterColumns") is not None else None, + "workspaceDataFilterReferences": [JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner.from_dict(_item) for _item in obj["workspaceDataFilterReferences"]] if obj.get("workspaceDataFilterReferences") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_grain_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_grain_inner.py new file mode 100644 index 000000000..a210c6ee1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_grain_inner.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutAttributesGrainInner(BaseModel): + """ + JsonApiDatasetOutAttributesGrainInner + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['attribute', 'date']): + raise ValueError("must be one of enum values ('attribute', 'date')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributesGrainInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributesGrainInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_reference_properties_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_reference_properties_inner.py new file mode 100644 index 000000000..1578fccec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_reference_properties_inner.py @@ -0,0 +1,119 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.dataset_reference_identifier import DatasetReferenceIdentifier +from gooddata_api_client.models.reference_source_column import ReferenceSourceColumn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutAttributesReferencePropertiesInner(BaseModel): + """ + JsonApiDatasetOutAttributesReferencePropertiesInner + """ # noqa: E501 + identifier: DatasetReferenceIdentifier + multivalue: StrictBool + source_column_data_types: Optional[List[StrictStr]] = Field(default=None, alias="sourceColumnDataTypes") + source_columns: Optional[List[StrictStr]] = Field(default=None, alias="sourceColumns") + sources: Optional[List[ReferenceSourceColumn]] = None + __properties: ClassVar[List[str]] = ["identifier", "multivalue", "sourceColumnDataTypes", "sourceColumns", "sources"] + + @field_validator('source_column_data_types') + def source_column_data_types_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("each list item must be one of ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributesReferencePropertiesInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of identifier + if self.identifier: + _dict['identifier'] = self.identifier.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in sources (list) + _items = [] + if self.sources: + for _item_sources in self.sources: + if _item_sources: + _items.append(_item_sources.to_dict()) + _dict['sources'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributesReferencePropertiesInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "identifier": DatasetReferenceIdentifier.from_dict(obj["identifier"]) if obj.get("identifier") is not None else None, + "multivalue": obj.get("multivalue"), + "sourceColumnDataTypes": obj.get("sourceColumnDataTypes"), + "sourceColumns": obj.get("sourceColumns"), + "sources": [ReferenceSourceColumn.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_sql.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_sql.py new file mode 100644 index 000000000..768245f7d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_sql.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutAttributesSql(BaseModel): + """ + JsonApiDatasetOutAttributesSql + """ # noqa: E501 + data_source_id: StrictStr = Field(alias="dataSourceId") + statement: StrictStr + __properties: ClassVar[List[str]] = ["dataSourceId", "statement"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributesSql from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributesSql from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataSourceId": obj.get("dataSourceId"), + "statement": obj.get("statement") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_workspace_data_filter_columns_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_workspace_data_filter_columns_inner.py new file mode 100644 index 000000000..6370e8eef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_workspace_data_filter_columns_inner.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner(BaseModel): + """ + JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner + """ # noqa: E501 + data_type: StrictStr = Field(alias="dataType") + name: StrictStr + __properties: ClassVar[List[str]] = ["dataType", "name"] + + @field_validator('data_type') + def data_type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataType": obj.get("dataType"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_workspace_data_filter_references_inner.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_workspace_data_filter_references_inner.py new file mode 100644 index 000000000..9c2d7aa2e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_attributes_workspace_data_filter_references_inner.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner(BaseModel): + """ + Workspace data filter reference. + """ # noqa: E501 + filter_column: StrictStr = Field(alias="filterColumn") + filter_column_data_type: StrictStr = Field(alias="filterColumnDataType") + filter_id: DatasetWorkspaceDataFilterIdentifier = Field(alias="filterId") + __properties: ClassVar[List[str]] = ["filterColumn", "filterColumnDataType", "filterId"] + + @field_validator('filter_column_data_type') + def filter_column_data_type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of filter_id + if self.filter_id: + _dict['filterId'] = self.filter_id.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "filterColumn": obj.get("filterColumn"), + "filterColumnDataType": obj.get("filterColumnDataType"), + "filterId": DatasetWorkspaceDataFilterIdentifier.from_dict(obj["filterId"]) if obj.get("filterId") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_document.py new file mode 100644 index 000000000..f175859aa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_dataset_out import JsonApiDatasetOut +from gooddata_api_client.models.json_api_dataset_out_includes import JsonApiDatasetOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutDocument(BaseModel): + """ + JsonApiDatasetOutDocument + """ # noqa: E501 + data: JsonApiDatasetOut + included: Optional[List[JsonApiDatasetOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiDatasetOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiDatasetOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_includes.py new file mode 100644 index 000000000..5cfec74c0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_includes.py @@ -0,0 +1,180 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_with_links import JsonApiAggregatedFactOutWithLinks +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIDATASETOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiAggregatedFactOutWithLinks", "JsonApiAttributeOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiFactOutWithLinks", "JsonApiWorkspaceDataFilterOutWithLinks"] + +class JsonApiDatasetOutIncludes(BaseModel): + """ + JsonApiDatasetOutIncludes + """ + # data type: JsonApiAttributeOutWithLinks + oneof_schema_1_validator: Optional[JsonApiAttributeOutWithLinks] = None + # data type: JsonApiFactOutWithLinks + oneof_schema_2_validator: Optional[JsonApiFactOutWithLinks] = None + # data type: JsonApiAggregatedFactOutWithLinks + oneof_schema_3_validator: Optional[JsonApiAggregatedFactOutWithLinks] = None + # data type: JsonApiDatasetOutWithLinks + oneof_schema_4_validator: Optional[JsonApiDatasetOutWithLinks] = None + # data type: JsonApiWorkspaceDataFilterOutWithLinks + oneof_schema_5_validator: Optional[JsonApiWorkspaceDataFilterOutWithLinks] = None + actual_instance: Optional[Union[JsonApiAggregatedFactOutWithLinks, JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiWorkspaceDataFilterOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiAggregatedFactOutWithLinks", "JsonApiAttributeOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiFactOutWithLinks", "JsonApiWorkspaceDataFilterOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiDatasetOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiAttributeOutWithLinks + if not isinstance(v, JsonApiAttributeOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAttributeOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiFactOutWithLinks + if not isinstance(v, JsonApiFactOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiFactOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAggregatedFactOutWithLinks + if not isinstance(v, JsonApiAggregatedFactOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAggregatedFactOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiDatasetOutWithLinks + if not isinstance(v, JsonApiDatasetOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiDatasetOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiWorkspaceDataFilterOutWithLinks + if not isinstance(v, JsonApiWorkspaceDataFilterOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiWorkspaceDataFilterOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiDatasetOutIncludes with oneOf schemas: JsonApiAggregatedFactOutWithLinks, JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiWorkspaceDataFilterOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiDatasetOutIncludes with oneOf schemas: JsonApiAggregatedFactOutWithLinks, JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiWorkspaceDataFilterOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiAttributeOutWithLinks + try: + instance.actual_instance = JsonApiAttributeOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiFactOutWithLinks + try: + instance.actual_instance = JsonApiFactOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAggregatedFactOutWithLinks + try: + instance.actual_instance = JsonApiAggregatedFactOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiDatasetOutWithLinks + try: + instance.actual_instance = JsonApiDatasetOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiWorkspaceDataFilterOutWithLinks + try: + instance.actual_instance = JsonApiWorkspaceDataFilterOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiDatasetOutIncludes with oneOf schemas: JsonApiAggregatedFactOutWithLinks, JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiWorkspaceDataFilterOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiDatasetOutIncludes with oneOf schemas: JsonApiAggregatedFactOutWithLinks, JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiWorkspaceDataFilterOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAggregatedFactOutWithLinks, JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiWorkspaceDataFilterOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_list.py new file mode 100644 index 000000000..3b857324a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_dataset_out_includes import JsonApiDatasetOutIncludes +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiDatasetOutWithLinks] + included: Optional[List[JsonApiDatasetOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiDatasetOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiDatasetOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships.py new file mode 100644 index 000000000..45cfa1303 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes +from gooddata_api_client.models.json_api_dataset_out_relationships_aggregated_facts import JsonApiDatasetOutRelationshipsAggregatedFacts +from gooddata_api_client.models.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts +from gooddata_api_client.models.json_api_dataset_out_relationships_workspace_data_filters import JsonApiDatasetOutRelationshipsWorkspaceDataFilters +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutRelationships(BaseModel): + """ + JsonApiDatasetOutRelationships + """ # noqa: E501 + aggregated_facts: Optional[JsonApiDatasetOutRelationshipsAggregatedFacts] = Field(default=None, alias="aggregatedFacts") + attributes: Optional[JsonApiAttributeHierarchyOutRelationshipsAttributes] = None + facts: Optional[JsonApiDatasetOutRelationshipsFacts] = None + references: Optional[JsonApiAnalyticalDashboardOutRelationshipsDatasets] = None + workspace_data_filters: Optional[JsonApiDatasetOutRelationshipsWorkspaceDataFilters] = Field(default=None, alias="workspaceDataFilters") + __properties: ClassVar[List[str]] = ["aggregatedFacts", "attributes", "facts", "references", "workspaceDataFilters"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of aggregated_facts + if self.aggregated_facts: + _dict['aggregatedFacts'] = self.aggregated_facts.to_dict() + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of facts + if self.facts: + _dict['facts'] = self.facts.to_dict() + # override the default output from pydantic by calling `to_dict()` of references + if self.references: + _dict['references'] = self.references.to_dict() + # override the default output from pydantic by calling `to_dict()` of workspace_data_filters + if self.workspace_data_filters: + _dict['workspaceDataFilters'] = self.workspace_data_filters.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "aggregatedFacts": JsonApiDatasetOutRelationshipsAggregatedFacts.from_dict(obj["aggregatedFacts"]) if obj.get("aggregatedFacts") is not None else None, + "attributes": JsonApiAttributeHierarchyOutRelationshipsAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "facts": JsonApiDatasetOutRelationshipsFacts.from_dict(obj["facts"]) if obj.get("facts") is not None else None, + "references": JsonApiAnalyticalDashboardOutRelationshipsDatasets.from_dict(obj["references"]) if obj.get("references") is not None else None, + "workspaceDataFilters": JsonApiDatasetOutRelationshipsWorkspaceDataFilters.from_dict(obj["workspaceDataFilters"]) if obj.get("workspaceDataFilters") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships_aggregated_facts.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships_aggregated_facts.py new file mode 100644 index 000000000..03df8778b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships_aggregated_facts.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_aggregated_fact_linkage import JsonApiAggregatedFactLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutRelationshipsAggregatedFacts(BaseModel): + """ + JsonApiDatasetOutRelationshipsAggregatedFacts + """ # noqa: E501 + data: List[JsonApiAggregatedFactLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutRelationshipsAggregatedFacts from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutRelationshipsAggregatedFacts from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiAggregatedFactLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships_facts.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships_facts.py new file mode 100644 index 000000000..d4286188f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships_facts.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_fact_linkage import JsonApiFactLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutRelationshipsFacts(BaseModel): + """ + JsonApiDatasetOutRelationshipsFacts + """ # noqa: E501 + data: List[JsonApiFactLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutRelationshipsFacts from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutRelationshipsFacts from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiFactLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships_workspace_data_filters.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships_workspace_data_filters.py new file mode 100644 index 000000000..c5358f611 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_relationships_workspace_data_filters.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_workspace_data_filter_linkage import JsonApiWorkspaceDataFilterLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutRelationshipsWorkspaceDataFilters(BaseModel): + """ + JsonApiDatasetOutRelationshipsWorkspaceDataFilters + """ # noqa: E501 + data: List[JsonApiWorkspaceDataFilterLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutRelationshipsWorkspaceDataFilters from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutRelationshipsWorkspaceDataFilters from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiWorkspaceDataFilterLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_with_links.py new file mode 100644 index 000000000..0fb177e93 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_dataset_out_attributes import JsonApiDatasetOutAttributes +from gooddata_api_client.models.json_api_dataset_out_relationships import JsonApiDatasetOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiDatasetOutWithLinks(BaseModel): + """ + JsonApiDatasetOutWithLinks + """ # noqa: E501 + attributes: JsonApiDatasetOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiDatasetOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataset']): + raise ValueError("must be one of enum values ('dataset')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiDatasetOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiDatasetOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiDatasetOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_dataset_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_to_one_linkage.py new file mode 100644 index 000000000..b0a9432be --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_dataset_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_dataset_linkage import JsonApiDatasetLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIDATASETTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiDatasetLinkage"] + +class JsonApiDatasetToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiDatasetLinkage + oneof_schema_1_validator: Optional[JsonApiDatasetLinkage] = None + actual_instance: Optional[Union[JsonApiDatasetLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiDatasetLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiDatasetToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiDatasetLinkage + if not isinstance(v, JsonApiDatasetLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiDatasetLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiDatasetToOneLinkage with oneOf schemas: JsonApiDatasetLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiDatasetToOneLinkage with oneOf schemas: JsonApiDatasetLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiDatasetLinkage + try: + instance.actual_instance = JsonApiDatasetLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiDatasetToOneLinkage with oneOf schemas: JsonApiDatasetLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiDatasetToOneLinkage with oneOf schemas: JsonApiDatasetLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiDatasetLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out.py new file mode 100644 index 000000000..b804619c9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_entitlement_out_attributes import JsonApiEntitlementOutAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiEntitlementOut(BaseModel): + """ + JSON:API representation of entitlement entity. + """ # noqa: E501 + attributes: Optional[JsonApiEntitlementOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['entitlement']): + raise ValueError("must be one of enum values ('entitlement')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiEntitlementOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiEntitlementOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiEntitlementOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_attributes.py new file mode 100644 index 000000000..bd1b7a8eb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_attributes.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import date +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiEntitlementOutAttributes(BaseModel): + """ + JsonApiEntitlementOutAttributes + """ # noqa: E501 + expiry: Optional[date] = None + value: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["expiry", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiEntitlementOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiEntitlementOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "expiry": obj.get("expiry"), + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_document.py new file mode 100644 index 000000000..04e3b9921 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_entitlement_out import JsonApiEntitlementOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiEntitlementOutDocument(BaseModel): + """ + JsonApiEntitlementOutDocument + """ # noqa: E501 + data: JsonApiEntitlementOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiEntitlementOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiEntitlementOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiEntitlementOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_list.py new file mode 100644 index 000000000..a385f0869 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_entitlement_out_with_links import JsonApiEntitlementOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiEntitlementOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiEntitlementOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiEntitlementOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiEntitlementOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiEntitlementOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_with_links.py new file mode 100644 index 000000000..fc05f2534 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_entitlement_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_entitlement_out_attributes import JsonApiEntitlementOutAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiEntitlementOutWithLinks(BaseModel): + """ + JsonApiEntitlementOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiEntitlementOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['entitlement']): + raise ValueError("must be one of enum values ('entitlement')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiEntitlementOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiEntitlementOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiEntitlementOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in.py new file mode 100644 index 000000000..40b5af74d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_definition_in_attributes import JsonApiExportDefinitionInAttributes +from gooddata_api_client.models.json_api_export_definition_in_relationships import JsonApiExportDefinitionInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionIn(BaseModel): + """ + JSON:API representation of exportDefinition entity. + """ # noqa: E501 + attributes: Optional[JsonApiExportDefinitionInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiExportDefinitionInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportDefinition']): + raise ValueError("must be one of enum values ('exportDefinition')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiExportDefinitionInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiExportDefinitionInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_attributes.py new file mode 100644 index 000000000..5870308d9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_attributes.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_definition_in_attributes_request_payload import JsonApiExportDefinitionInAttributesRequestPayload +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionInAttributes(BaseModel): + """ + JsonApiExportDefinitionInAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + request_payload: Optional[JsonApiExportDefinitionInAttributesRequestPayload] = Field(default=None, alias="requestPayload") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "description", "requestPayload", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "description": obj.get("description"), + "requestPayload": JsonApiExportDefinitionInAttributesRequestPayload.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_attributes_request_payload.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_attributes_request_payload.py new file mode 100644 index 000000000..b0017e40e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_attributes_request_payload.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.visual_export_request import VisualExportRequest +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIEXPORTDEFINITIONINATTRIBUTESREQUESTPAYLOAD_ONE_OF_SCHEMAS = ["TabularExportRequest", "VisualExportRequest"] + +class JsonApiExportDefinitionInAttributesRequestPayload(BaseModel): + """ + JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. + """ + # data type: VisualExportRequest + oneof_schema_1_validator: Optional[VisualExportRequest] = None + # data type: TabularExportRequest + oneof_schema_2_validator: Optional[TabularExportRequest] = None + actual_instance: Optional[Union[TabularExportRequest, VisualExportRequest]] = None + one_of_schemas: Set[str] = { "TabularExportRequest", "VisualExportRequest" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiExportDefinitionInAttributesRequestPayload.model_construct() + error_messages = [] + match = 0 + # validate data type: VisualExportRequest + if not isinstance(v, VisualExportRequest): + error_messages.append(f"Error! Input type `{type(v)}` is not `VisualExportRequest`") + else: + match += 1 + # validate data type: TabularExportRequest + if not isinstance(v, TabularExportRequest): + error_messages.append(f"Error! Input type `{type(v)}` is not `TabularExportRequest`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiExportDefinitionInAttributesRequestPayload with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiExportDefinitionInAttributesRequestPayload with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into VisualExportRequest + try: + instance.actual_instance = VisualExportRequest.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into TabularExportRequest + try: + instance.actual_instance = TabularExportRequest.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiExportDefinitionInAttributesRequestPayload with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiExportDefinitionInAttributesRequestPayload with oneOf schemas: TabularExportRequest, VisualExportRequest. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], TabularExportRequest, VisualExportRequest]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_document.py new file mode 100644 index 000000000..2956c19d3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_export_definition_in import JsonApiExportDefinitionIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionInDocument(BaseModel): + """ + JsonApiExportDefinitionInDocument + """ # noqa: E501 + data: JsonApiExportDefinitionIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiExportDefinitionIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_relationships.py new file mode 100644 index 000000000..f23efc1f4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_relationships.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard +from gooddata_api_client.models.json_api_export_definition_in_relationships_visualization_object import JsonApiExportDefinitionInRelationshipsVisualizationObject +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionInRelationships(BaseModel): + """ + JsonApiExportDefinitionInRelationships + """ # noqa: E501 + analytical_dashboard: Optional[JsonApiAutomationInRelationshipsAnalyticalDashboard] = Field(default=None, alias="analyticalDashboard") + visualization_object: Optional[JsonApiExportDefinitionInRelationshipsVisualizationObject] = Field(default=None, alias="visualizationObject") + __properties: ClassVar[List[str]] = ["analyticalDashboard", "visualizationObject"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionInRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of analytical_dashboard + if self.analytical_dashboard: + _dict['analyticalDashboard'] = self.analytical_dashboard.to_dict() + # override the default output from pydantic by calling `to_dict()` of visualization_object + if self.visualization_object: + _dict['visualizationObject'] = self.visualization_object.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionInRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticalDashboard": JsonApiAutomationInRelationshipsAnalyticalDashboard.from_dict(obj["analyticalDashboard"]) if obj.get("analyticalDashboard") is not None else None, + "visualizationObject": JsonApiExportDefinitionInRelationshipsVisualizationObject.from_dict(obj["visualizationObject"]) if obj.get("visualizationObject") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_relationships_visualization_object.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_relationships_visualization_object.py new file mode 100644 index 000000000..9eeb2458b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_in_relationships_visualization_object.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionInRelationshipsVisualizationObject(BaseModel): + """ + JsonApiExportDefinitionInRelationshipsVisualizationObject + """ # noqa: E501 + data: Optional[JsonApiVisualizationObjectToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionInRelationshipsVisualizationObject from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionInRelationshipsVisualizationObject from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiVisualizationObjectToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_linkage.py new file mode 100644 index 000000000..de215461b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportDefinition']): + raise ValueError("must be one of enum values ('exportDefinition')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out.py new file mode 100644 index 000000000..98ea0b9e5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_export_definition_out_attributes import JsonApiExportDefinitionOutAttributes +from gooddata_api_client.models.json_api_export_definition_out_relationships import JsonApiExportDefinitionOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionOut(BaseModel): + """ + JSON:API representation of exportDefinition entity. + """ # noqa: E501 + attributes: Optional[JsonApiExportDefinitionOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiExportDefinitionOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportDefinition']): + raise ValueError("must be one of enum values ('exportDefinition')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiExportDefinitionOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiExportDefinitionOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_attributes.py new file mode 100644 index 000000000..5c222b84d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_attributes.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_definition_in_attributes_request_payload import JsonApiExportDefinitionInAttributesRequestPayload +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionOutAttributes(BaseModel): + """ + JsonApiExportDefinitionOutAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + created_at: Optional[datetime] = Field(default=None, alias="createdAt") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + modified_at: Optional[datetime] = Field(default=None, alias="modifiedAt") + request_payload: Optional[JsonApiExportDefinitionInAttributesRequestPayload] = Field(default=None, alias="requestPayload") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "createdAt", "description", "modifiedAt", "requestPayload", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of request_payload + if self.request_payload: + _dict['requestPayload'] = self.request_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "createdAt": obj.get("createdAt"), + "description": obj.get("description"), + "modifiedAt": obj.get("modifiedAt"), + "requestPayload": JsonApiExportDefinitionInAttributesRequestPayload.from_dict(obj["requestPayload"]) if obj.get("requestPayload") is not None else None, + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_document.py new file mode 100644 index 000000000..bce845d7e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_export_definition_out import JsonApiExportDefinitionOut +from gooddata_api_client.models.json_api_export_definition_out_includes import JsonApiExportDefinitionOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionOutDocument(BaseModel): + """ + JsonApiExportDefinitionOutDocument + """ # noqa: E501 + data: JsonApiExportDefinitionOut + included: Optional[List[JsonApiExportDefinitionOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiExportDefinitionOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiExportDefinitionOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_includes.py new file mode 100644 index 000000000..1ab8a0295 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_includes.py @@ -0,0 +1,166 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.models.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.models.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIEXPORTDEFINITIONOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiAnalyticalDashboardOutWithLinks", "JsonApiAutomationOutWithLinks", "JsonApiUserIdentifierOutWithLinks", "JsonApiVisualizationObjectOutWithLinks"] + +class JsonApiExportDefinitionOutIncludes(BaseModel): + """ + JsonApiExportDefinitionOutIncludes + """ + # data type: JsonApiVisualizationObjectOutWithLinks + oneof_schema_1_validator: Optional[JsonApiVisualizationObjectOutWithLinks] = None + # data type: JsonApiAnalyticalDashboardOutWithLinks + oneof_schema_2_validator: Optional[JsonApiAnalyticalDashboardOutWithLinks] = None + # data type: JsonApiAutomationOutWithLinks + oneof_schema_3_validator: Optional[JsonApiAutomationOutWithLinks] = None + # data type: JsonApiUserIdentifierOutWithLinks + oneof_schema_4_validator: Optional[JsonApiUserIdentifierOutWithLinks] = None + actual_instance: Optional[Union[JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiAnalyticalDashboardOutWithLinks", "JsonApiAutomationOutWithLinks", "JsonApiUserIdentifierOutWithLinks", "JsonApiVisualizationObjectOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiExportDefinitionOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiVisualizationObjectOutWithLinks + if not isinstance(v, JsonApiVisualizationObjectOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiVisualizationObjectOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAnalyticalDashboardOutWithLinks + if not isinstance(v, JsonApiAnalyticalDashboardOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAnalyticalDashboardOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAutomationOutWithLinks + if not isinstance(v, JsonApiAutomationOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAutomationOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiUserIdentifierOutWithLinks + if not isinstance(v, JsonApiUserIdentifierOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserIdentifierOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiExportDefinitionOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiExportDefinitionOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiVisualizationObjectOutWithLinks + try: + instance.actual_instance = JsonApiVisualizationObjectOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAnalyticalDashboardOutWithLinks + try: + instance.actual_instance = JsonApiAnalyticalDashboardOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAutomationOutWithLinks + try: + instance.actual_instance = JsonApiAutomationOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiUserIdentifierOutWithLinks + try: + instance.actual_instance = JsonApiUserIdentifierOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiExportDefinitionOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiExportDefinitionOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiVisualizationObjectOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_list.py new file mode 100644 index 000000000..877f4478b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_export_definition_out_includes import JsonApiExportDefinitionOutIncludes +from gooddata_api_client.models.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiExportDefinitionOutWithLinks] + included: Optional[List[JsonApiExportDefinitionOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiExportDefinitionOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiExportDefinitionOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_relationships.py new file mode 100644 index 000000000..118fbdf60 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_relationships.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy +from gooddata_api_client.models.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard +from gooddata_api_client.models.json_api_automation_result_out_relationships_automation import JsonApiAutomationResultOutRelationshipsAutomation +from gooddata_api_client.models.json_api_export_definition_in_relationships_visualization_object import JsonApiExportDefinitionInRelationshipsVisualizationObject +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionOutRelationships(BaseModel): + """ + JsonApiExportDefinitionOutRelationships + """ # noqa: E501 + analytical_dashboard: Optional[JsonApiAutomationInRelationshipsAnalyticalDashboard] = Field(default=None, alias="analyticalDashboard") + automation: Optional[JsonApiAutomationResultOutRelationshipsAutomation] = None + created_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="createdBy") + modified_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="modifiedBy") + visualization_object: Optional[JsonApiExportDefinitionInRelationshipsVisualizationObject] = Field(default=None, alias="visualizationObject") + __properties: ClassVar[List[str]] = ["analyticalDashboard", "automation", "createdBy", "modifiedBy", "visualizationObject"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of analytical_dashboard + if self.analytical_dashboard: + _dict['analyticalDashboard'] = self.analytical_dashboard.to_dict() + # override the default output from pydantic by calling `to_dict()` of automation + if self.automation: + _dict['automation'] = self.automation.to_dict() + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of visualization_object + if self.visualization_object: + _dict['visualizationObject'] = self.visualization_object.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticalDashboard": JsonApiAutomationInRelationshipsAnalyticalDashboard.from_dict(obj["analyticalDashboard"]) if obj.get("analyticalDashboard") is not None else None, + "automation": JsonApiAutomationResultOutRelationshipsAutomation.from_dict(obj["automation"]) if obj.get("automation") is not None else None, + "createdBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "modifiedBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None, + "visualizationObject": JsonApiExportDefinitionInRelationshipsVisualizationObject.from_dict(obj["visualizationObject"]) if obj.get("visualizationObject") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_with_links.py new file mode 100644 index 000000000..ad249267f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_export_definition_out_attributes import JsonApiExportDefinitionOutAttributes +from gooddata_api_client.models.json_api_export_definition_out_relationships import JsonApiExportDefinitionOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionOutWithLinks(BaseModel): + """ + JsonApiExportDefinitionOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiExportDefinitionOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiExportDefinitionOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportDefinition']): + raise ValueError("must be one of enum values ('exportDefinition')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiExportDefinitionOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiExportDefinitionOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_patch.py new file mode 100644 index 000000000..2b38d1e09 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_patch.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_definition_in_attributes import JsonApiExportDefinitionInAttributes +from gooddata_api_client.models.json_api_export_definition_in_relationships import JsonApiExportDefinitionInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionPatch(BaseModel): + """ + JSON:API representation of patching exportDefinition entity. + """ # noqa: E501 + attributes: Optional[JsonApiExportDefinitionInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiExportDefinitionInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportDefinition']): + raise ValueError("must be one of enum values ('exportDefinition')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiExportDefinitionInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiExportDefinitionInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_patch_document.py new file mode 100644 index 000000000..8ecb6a454 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_export_definition_patch import JsonApiExportDefinitionPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionPatchDocument(BaseModel): + """ + JsonApiExportDefinitionPatchDocument + """ # noqa: E501 + data: JsonApiExportDefinitionPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiExportDefinitionPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_post_optional_id.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_post_optional_id.py new file mode 100644 index 000000000..7770b485b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_post_optional_id.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_definition_in_attributes import JsonApiExportDefinitionInAttributes +from gooddata_api_client.models.json_api_export_definition_in_relationships import JsonApiExportDefinitionInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionPostOptionalId(BaseModel): + """ + JSON:API representation of exportDefinition entity. + """ # noqa: E501 + attributes: Optional[JsonApiExportDefinitionInAttributes] = None + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="API identifier of an object") + relationships: Optional[JsonApiExportDefinitionInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportDefinition']): + raise ValueError("must be one of enum values ('exportDefinition')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionPostOptionalId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionPostOptionalId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiExportDefinitionInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiExportDefinitionInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_post_optional_id_document.py new file mode 100644 index 000000000..63b0156ee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_definition_post_optional_id_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_export_definition_post_optional_id import JsonApiExportDefinitionPostOptionalId +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportDefinitionPostOptionalIdDocument(BaseModel): + """ + JsonApiExportDefinitionPostOptionalIdDocument + """ # noqa: E501 + data: JsonApiExportDefinitionPostOptionalId + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionPostOptionalIdDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportDefinitionPostOptionalIdDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiExportDefinitionPostOptionalId.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in.py new file mode 100644 index 000000000..47cc6a7bb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplateIn(BaseModel): + """ + JSON:API representation of exportTemplate entity. + """ # noqa: E501 + attributes: JsonApiExportTemplateInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportTemplate']): + raise ValueError("must be one of enum values ('exportTemplate')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiExportTemplateInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_attributes.py new file mode 100644 index 000000000..e338e9ece --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_attributes.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_template_in_attributes_dashboard_slides_template import JsonApiExportTemplateInAttributesDashboardSlidesTemplate +from gooddata_api_client.models.json_api_export_template_in_attributes_widget_slides_template import JsonApiExportTemplateInAttributesWidgetSlidesTemplate +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplateInAttributes(BaseModel): + """ + JsonApiExportTemplateInAttributes + """ # noqa: E501 + dashboard_slides_template: Optional[JsonApiExportTemplateInAttributesDashboardSlidesTemplate] = Field(default=None, alias="dashboardSlidesTemplate") + name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="User-facing name of the Slides template.") + widget_slides_template: Optional[JsonApiExportTemplateInAttributesWidgetSlidesTemplate] = Field(default=None, alias="widgetSlidesTemplate") + __properties: ClassVar[List[str]] = ["dashboardSlidesTemplate", "name", "widgetSlidesTemplate"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dashboard_slides_template + if self.dashboard_slides_template: + _dict['dashboardSlidesTemplate'] = self.dashboard_slides_template.to_dict() + # override the default output from pydantic by calling `to_dict()` of widget_slides_template + if self.widget_slides_template: + _dict['widgetSlidesTemplate'] = self.widget_slides_template.to_dict() + # set to None if dashboard_slides_template (nullable) is None + # and model_fields_set contains the field + if self.dashboard_slides_template is None and "dashboard_slides_template" in self.model_fields_set: + _dict['dashboardSlidesTemplate'] = None + + # set to None if widget_slides_template (nullable) is None + # and model_fields_set contains the field + if self.widget_slides_template is None and "widget_slides_template" in self.model_fields_set: + _dict['widgetSlidesTemplate'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dashboardSlidesTemplate": JsonApiExportTemplateInAttributesDashboardSlidesTemplate.from_dict(obj["dashboardSlidesTemplate"]) if obj.get("dashboardSlidesTemplate") is not None else None, + "name": obj.get("name"), + "widgetSlidesTemplate": JsonApiExportTemplateInAttributesWidgetSlidesTemplate.from_dict(obj["widgetSlidesTemplate"]) if obj.get("widgetSlidesTemplate") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_attributes_dashboard_slides_template.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_attributes_dashboard_slides_template.py new file mode 100644 index 000000000..1f3a60c2c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_attributes_dashboard_slides_template.py @@ -0,0 +1,141 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.content_slide_template import ContentSlideTemplate +from gooddata_api_client.models.cover_slide_template import CoverSlideTemplate +from gooddata_api_client.models.intro_slide_template import IntroSlideTemplate +from gooddata_api_client.models.section_slide_template import SectionSlideTemplate +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplateInAttributesDashboardSlidesTemplate(BaseModel): + """ + Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + """ # noqa: E501 + applied_on: Annotated[List[StrictStr], Field(min_length=1)] = Field(description="Export types this template applies to.", alias="appliedOn") + content_slide: Optional[ContentSlideTemplate] = Field(default=None, alias="contentSlide") + cover_slide: Optional[CoverSlideTemplate] = Field(default=None, alias="coverSlide") + intro_slide: Optional[IntroSlideTemplate] = Field(default=None, alias="introSlide") + section_slide: Optional[SectionSlideTemplate] = Field(default=None, alias="sectionSlide") + __properties: ClassVar[List[str]] = ["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide"] + + @field_validator('applied_on') + def applied_on_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['PDF', 'PPTX']): + raise ValueError("each list item must be one of ('PDF', 'PPTX')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateInAttributesDashboardSlidesTemplate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of content_slide + if self.content_slide: + _dict['contentSlide'] = self.content_slide.to_dict() + # override the default output from pydantic by calling `to_dict()` of cover_slide + if self.cover_slide: + _dict['coverSlide'] = self.cover_slide.to_dict() + # override the default output from pydantic by calling `to_dict()` of intro_slide + if self.intro_slide: + _dict['introSlide'] = self.intro_slide.to_dict() + # override the default output from pydantic by calling `to_dict()` of section_slide + if self.section_slide: + _dict['sectionSlide'] = self.section_slide.to_dict() + # set to None if content_slide (nullable) is None + # and model_fields_set contains the field + if self.content_slide is None and "content_slide" in self.model_fields_set: + _dict['contentSlide'] = None + + # set to None if cover_slide (nullable) is None + # and model_fields_set contains the field + if self.cover_slide is None and "cover_slide" in self.model_fields_set: + _dict['coverSlide'] = None + + # set to None if intro_slide (nullable) is None + # and model_fields_set contains the field + if self.intro_slide is None and "intro_slide" in self.model_fields_set: + _dict['introSlide'] = None + + # set to None if section_slide (nullable) is None + # and model_fields_set contains the field + if self.section_slide is None and "section_slide" in self.model_fields_set: + _dict['sectionSlide'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateInAttributesDashboardSlidesTemplate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "appliedOn": obj.get("appliedOn"), + "contentSlide": ContentSlideTemplate.from_dict(obj["contentSlide"]) if obj.get("contentSlide") is not None else None, + "coverSlide": CoverSlideTemplate.from_dict(obj["coverSlide"]) if obj.get("coverSlide") is not None else None, + "introSlide": IntroSlideTemplate.from_dict(obj["introSlide"]) if obj.get("introSlide") is not None else None, + "sectionSlide": SectionSlideTemplate.from_dict(obj["sectionSlide"]) if obj.get("sectionSlide") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_attributes_widget_slides_template.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_attributes_widget_slides_template.py new file mode 100644 index 000000000..5641c8cb2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_attributes_widget_slides_template.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.content_slide_template import ContentSlideTemplate +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplateInAttributesWidgetSlidesTemplate(BaseModel): + """ + Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + """ # noqa: E501 + applied_on: Annotated[List[StrictStr], Field(min_length=1)] = Field(description="Export types this template applies to.", alias="appliedOn") + content_slide: Optional[ContentSlideTemplate] = Field(default=None, alias="contentSlide") + __properties: ClassVar[List[str]] = ["appliedOn", "contentSlide"] + + @field_validator('applied_on') + def applied_on_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['PDF', 'PPTX']): + raise ValueError("each list item must be one of ('PDF', 'PPTX')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateInAttributesWidgetSlidesTemplate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of content_slide + if self.content_slide: + _dict['contentSlide'] = self.content_slide.to_dict() + # set to None if content_slide (nullable) is None + # and model_fields_set contains the field + if self.content_slide is None and "content_slide" in self.model_fields_set: + _dict['contentSlide'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateInAttributesWidgetSlidesTemplate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "appliedOn": obj.get("appliedOn"), + "contentSlide": ContentSlideTemplate.from_dict(obj["contentSlide"]) if obj.get("contentSlide") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_document.py new file mode 100644 index 000000000..1ea2e2cb3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_export_template_in import JsonApiExportTemplateIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplateInDocument(BaseModel): + """ + JsonApiExportTemplateInDocument + """ # noqa: E501 + data: JsonApiExportTemplateIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiExportTemplateIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out.py new file mode 100644 index 000000000..4c5c04c10 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplateOut(BaseModel): + """ + JSON:API representation of exportTemplate entity. + """ # noqa: E501 + attributes: JsonApiExportTemplateInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportTemplate']): + raise ValueError("must be one of enum values ('exportTemplate')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiExportTemplateInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out_document.py new file mode 100644 index 000000000..5e1382916 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_export_template_out import JsonApiExportTemplateOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplateOutDocument(BaseModel): + """ + JsonApiExportTemplateOutDocument + """ # noqa: E501 + data: JsonApiExportTemplateOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiExportTemplateOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out_list.py new file mode 100644 index 000000000..662c034d8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_export_template_out_with_links import JsonApiExportTemplateOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplateOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiExportTemplateOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiExportTemplateOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out_with_links.py new file mode 100644 index 000000000..5768cf5e7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplateOutWithLinks(BaseModel): + """ + JsonApiExportTemplateOutWithLinks + """ # noqa: E501 + attributes: JsonApiExportTemplateInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportTemplate']): + raise ValueError("must be one of enum values ('exportTemplate')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplateOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiExportTemplateInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_patch.py new file mode 100644 index 000000000..b3439ee2c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_template_patch_attributes import JsonApiExportTemplatePatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplatePatch(BaseModel): + """ + JSON:API representation of patching exportTemplate entity. + """ # noqa: E501 + attributes: JsonApiExportTemplatePatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportTemplate']): + raise ValueError("must be one of enum values ('exportTemplate')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplatePatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplatePatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiExportTemplatePatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_patch_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_patch_attributes.py new file mode 100644 index 000000000..54d8bf52a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_patch_attributes.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_template_in_attributes_dashboard_slides_template import JsonApiExportTemplateInAttributesDashboardSlidesTemplate +from gooddata_api_client.models.json_api_export_template_in_attributes_widget_slides_template import JsonApiExportTemplateInAttributesWidgetSlidesTemplate +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplatePatchAttributes(BaseModel): + """ + JsonApiExportTemplatePatchAttributes + """ # noqa: E501 + dashboard_slides_template: Optional[JsonApiExportTemplateInAttributesDashboardSlidesTemplate] = Field(default=None, alias="dashboardSlidesTemplate") + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="User-facing name of the Slides template.") + widget_slides_template: Optional[JsonApiExportTemplateInAttributesWidgetSlidesTemplate] = Field(default=None, alias="widgetSlidesTemplate") + __properties: ClassVar[List[str]] = ["dashboardSlidesTemplate", "name", "widgetSlidesTemplate"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplatePatchAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dashboard_slides_template + if self.dashboard_slides_template: + _dict['dashboardSlidesTemplate'] = self.dashboard_slides_template.to_dict() + # override the default output from pydantic by calling `to_dict()` of widget_slides_template + if self.widget_slides_template: + _dict['widgetSlidesTemplate'] = self.widget_slides_template.to_dict() + # set to None if dashboard_slides_template (nullable) is None + # and model_fields_set contains the field + if self.dashboard_slides_template is None and "dashboard_slides_template" in self.model_fields_set: + _dict['dashboardSlidesTemplate'] = None + + # set to None if widget_slides_template (nullable) is None + # and model_fields_set contains the field + if self.widget_slides_template is None and "widget_slides_template" in self.model_fields_set: + _dict['widgetSlidesTemplate'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplatePatchAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dashboardSlidesTemplate": JsonApiExportTemplateInAttributesDashboardSlidesTemplate.from_dict(obj["dashboardSlidesTemplate"]) if obj.get("dashboardSlidesTemplate") is not None else None, + "name": obj.get("name"), + "widgetSlidesTemplate": JsonApiExportTemplateInAttributesWidgetSlidesTemplate.from_dict(obj["widgetSlidesTemplate"]) if obj.get("widgetSlidesTemplate") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_patch_document.py new file mode 100644 index 000000000..d375f59f5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_export_template_patch import JsonApiExportTemplatePatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplatePatchDocument(BaseModel): + """ + JsonApiExportTemplatePatchDocument + """ # noqa: E501 + data: JsonApiExportTemplatePatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplatePatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplatePatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiExportTemplatePatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_post_optional_id.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_post_optional_id.py new file mode 100644 index 000000000..5bda2ccbf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_post_optional_id.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplatePostOptionalId(BaseModel): + """ + JSON:API representation of exportTemplate entity. + """ # noqa: E501 + attributes: JsonApiExportTemplateInAttributes + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['exportTemplate']): + raise ValueError("must be one of enum values ('exportTemplate')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplatePostOptionalId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplatePostOptionalId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiExportTemplateInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_export_template_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_post_optional_id_document.py new file mode 100644 index 000000000..81cadeccb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_export_template_post_optional_id_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiExportTemplatePostOptionalIdDocument(BaseModel): + """ + JsonApiExportTemplatePostOptionalIdDocument + """ # noqa: E501 + data: JsonApiExportTemplatePostOptionalId + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiExportTemplatePostOptionalIdDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiExportTemplatePostOptionalIdDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiExportTemplatePostOptionalId.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_fact_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_fact_linkage.py new file mode 100644 index 000000000..739bfcf59 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_fact_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFactLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['fact']): + raise ValueError("must be one of enum values ('fact')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFactLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFactLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_fact_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out.py new file mode 100644 index 000000000..0fd8ce469 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_fact_out_attributes import JsonApiFactOutAttributes +from gooddata_api_client.models.json_api_fact_out_relationships import JsonApiFactOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFactOut(BaseModel): + """ + JSON:API representation of fact entity. + """ # noqa: E501 + attributes: Optional[JsonApiFactOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiFactOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['fact']): + raise ValueError("must be one of enum values ('fact')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFactOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFactOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiFactOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiFactOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_attributes.py new file mode 100644 index 000000000..08accf09f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_attributes.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFactOutAttributes(BaseModel): + """ + JsonApiFactOutAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + is_hidden: Optional[StrictBool] = Field(default=None, alias="isHidden") + source_column: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="sourceColumn") + source_column_data_type: Optional[StrictStr] = Field(default=None, alias="sourceColumnDataType") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "description", "isHidden", "sourceColumn", "sourceColumnDataType", "tags", "title"] + + @field_validator('source_column_data_type') + def source_column_data_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFactOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFactOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "description": obj.get("description"), + "isHidden": obj.get("isHidden"), + "sourceColumn": obj.get("sourceColumn"), + "sourceColumnDataType": obj.get("sourceColumnDataType"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_document.py new file mode 100644 index 000000000..142a4dc85 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_fact_out import JsonApiFactOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFactOutDocument(BaseModel): + """ + JsonApiFactOutDocument + """ # noqa: E501 + data: JsonApiFactOut + included: Optional[List[JsonApiDatasetOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFactOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFactOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiFactOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiDatasetOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_list.py new file mode 100644 index 000000000..5a6bafd73 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFactOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiFactOutWithLinks] + included: Optional[List[JsonApiDatasetOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFactOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFactOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiFactOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiDatasetOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_relationships.py new file mode 100644 index 000000000..4793075e5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_relationships.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_relationships_dataset import JsonApiAggregatedFactOutRelationshipsDataset +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFactOutRelationships(BaseModel): + """ + JsonApiFactOutRelationships + """ # noqa: E501 + dataset: Optional[JsonApiAggregatedFactOutRelationshipsDataset] = None + __properties: ClassVar[List[str]] = ["dataset"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFactOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dataset + if self.dataset: + _dict['dataset'] = self.dataset.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFactOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataset": JsonApiAggregatedFactOutRelationshipsDataset.from_dict(obj["dataset"]) if obj.get("dataset") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_with_links.py new file mode 100644 index 000000000..de042f9ee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_fact_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_fact_out_attributes import JsonApiFactOutAttributes +from gooddata_api_client.models.json_api_fact_out_relationships import JsonApiFactOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFactOutWithLinks(BaseModel): + """ + JsonApiFactOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiFactOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiFactOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['fact']): + raise ValueError("must be one of enum values ('fact')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFactOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFactOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiFactOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiFactOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_fact_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_fact_to_one_linkage.py new file mode 100644 index 000000000..771272858 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_fact_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_fact_linkage import JsonApiFactLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIFACTTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiFactLinkage"] + +class JsonApiFactToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiFactLinkage + oneof_schema_1_validator: Optional[JsonApiFactLinkage] = None + actual_instance: Optional[Union[JsonApiFactLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiFactLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiFactToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiFactLinkage + if not isinstance(v, JsonApiFactLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiFactLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiFactToOneLinkage with oneOf schemas: JsonApiFactLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiFactToOneLinkage with oneOf schemas: JsonApiFactLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiFactLinkage + try: + instance.actual_instance = JsonApiFactLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiFactToOneLinkage with oneOf schemas: JsonApiFactLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiFactToOneLinkage with oneOf schemas: JsonApiFactLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiFactLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_in.py new file mode 100644 index 000000000..e70c2b4da --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextIn(BaseModel): + """ + JSON:API representation of filterContext entity. + """ # noqa: E501 + attributes: JsonApiAnalyticalDashboardInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['filterContext']): + raise ValueError("must be one of enum values ('filterContext')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAnalyticalDashboardInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_in_document.py new file mode 100644 index 000000000..f4b3e3e23 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_filter_context_in import JsonApiFilterContextIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextInDocument(BaseModel): + """ + JsonApiFilterContextInDocument + """ # noqa: E501 + data: JsonApiFilterContextIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiFilterContextIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_linkage.py new file mode 100644 index 000000000..63048104b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['filterContext']): + raise ValueError("must be one of enum values ('filterContext')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out.py new file mode 100644 index 000000000..dc00000dc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes +from gooddata_api_client.models.json_api_filter_context_out_relationships import JsonApiFilterContextOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextOut(BaseModel): + """ + JSON:API representation of filterContext entity. + """ # noqa: E501 + attributes: JsonApiAnalyticalDashboardInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiFilterContextOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['filterContext']): + raise ValueError("must be one of enum values ('filterContext')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAnalyticalDashboardInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiFilterContextOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_document.py new file mode 100644 index 000000000..2f7fc803d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_filter_context_out import JsonApiFilterContextOut +from gooddata_api_client.models.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextOutDocument(BaseModel): + """ + JsonApiFilterContextOutDocument + """ # noqa: E501 + data: JsonApiFilterContextOut + included: Optional[List[JsonApiFilterContextOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiFilterContextOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiFilterContextOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_includes.py new file mode 100644 index 000000000..694ded56d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_includes.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIFILTERCONTEXTOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiAttributeOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiLabelOutWithLinks"] + +class JsonApiFilterContextOutIncludes(BaseModel): + """ + JsonApiFilterContextOutIncludes + """ + # data type: JsonApiAttributeOutWithLinks + oneof_schema_1_validator: Optional[JsonApiAttributeOutWithLinks] = None + # data type: JsonApiDatasetOutWithLinks + oneof_schema_2_validator: Optional[JsonApiDatasetOutWithLinks] = None + # data type: JsonApiLabelOutWithLinks + oneof_schema_3_validator: Optional[JsonApiLabelOutWithLinks] = None + actual_instance: Optional[Union[JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiAttributeOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiLabelOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiFilterContextOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiAttributeOutWithLinks + if not isinstance(v, JsonApiAttributeOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAttributeOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiDatasetOutWithLinks + if not isinstance(v, JsonApiDatasetOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiDatasetOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiLabelOutWithLinks + if not isinstance(v, JsonApiLabelOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiLabelOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiFilterContextOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiFilterContextOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiAttributeOutWithLinks + try: + instance.actual_instance = JsonApiAttributeOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiDatasetOutWithLinks + try: + instance.actual_instance = JsonApiDatasetOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiLabelOutWithLinks + try: + instance.actual_instance = JsonApiLabelOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiFilterContextOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiFilterContextOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiLabelOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_list.py new file mode 100644 index 000000000..29a0c959a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes +from gooddata_api_client.models.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiFilterContextOutWithLinks] + included: Optional[List[JsonApiFilterContextOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiFilterContextOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiFilterContextOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_relationships.py new file mode 100644 index 000000000..479c3f1b2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_relationships.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextOutRelationships(BaseModel): + """ + JsonApiFilterContextOutRelationships + """ # noqa: E501 + attributes: Optional[JsonApiAttributeHierarchyOutRelationshipsAttributes] = None + datasets: Optional[JsonApiAnalyticalDashboardOutRelationshipsDatasets] = None + labels: Optional[JsonApiAnalyticalDashboardOutRelationshipsLabels] = None + __properties: ClassVar[List[str]] = ["attributes", "datasets", "labels"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of datasets + if self.datasets: + _dict['datasets'] = self.datasets.to_dict() + # override the default output from pydantic by calling `to_dict()` of labels + if self.labels: + _dict['labels'] = self.labels.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAttributeHierarchyOutRelationshipsAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "datasets": JsonApiAnalyticalDashboardOutRelationshipsDatasets.from_dict(obj["datasets"]) if obj.get("datasets") is not None else None, + "labels": JsonApiAnalyticalDashboardOutRelationshipsLabels.from_dict(obj["labels"]) if obj.get("labels") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_with_links.py new file mode 100644 index 000000000..1ddbc5e11 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes +from gooddata_api_client.models.json_api_filter_context_out_relationships import JsonApiFilterContextOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextOutWithLinks(BaseModel): + """ + JsonApiFilterContextOutWithLinks + """ # noqa: E501 + attributes: JsonApiAnalyticalDashboardInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiFilterContextOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['filterContext']): + raise ValueError("must be one of enum values ('filterContext')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAnalyticalDashboardInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiFilterContextOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_patch.py new file mode 100644 index 000000000..945197df3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_analytical_dashboard_patch_attributes import JsonApiAnalyticalDashboardPatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextPatch(BaseModel): + """ + JSON:API representation of patching filterContext entity. + """ # noqa: E501 + attributes: JsonApiAnalyticalDashboardPatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['filterContext']): + raise ValueError("must be one of enum values ('filterContext')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAnalyticalDashboardPatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_patch_document.py new file mode 100644 index 000000000..54ec96493 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_filter_context_patch import JsonApiFilterContextPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextPatchDocument(BaseModel): + """ + JsonApiFilterContextPatchDocument + """ # noqa: E501 + data: JsonApiFilterContextPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiFilterContextPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_post_optional_id.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_post_optional_id.py new file mode 100644 index 000000000..b3199ac97 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_post_optional_id.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextPostOptionalId(BaseModel): + """ + JSON:API representation of filterContext entity. + """ # noqa: E501 + attributes: JsonApiAnalyticalDashboardInAttributes + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['filterContext']): + raise ValueError("must be one of enum values ('filterContext')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextPostOptionalId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextPostOptionalId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAnalyticalDashboardInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_post_optional_id_document.py new file mode 100644 index 000000000..80770d264 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_context_post_optional_id_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_filter_context_post_optional_id import JsonApiFilterContextPostOptionalId +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterContextPostOptionalIdDocument(BaseModel): + """ + JsonApiFilterContextPostOptionalIdDocument + """ # noqa: E501 + data: JsonApiFilterContextPostOptionalId + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterContextPostOptionalIdDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterContextPostOptionalIdDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiFilterContextPostOptionalId.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in.py new file mode 100644 index 000000000..533291448 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes +from gooddata_api_client.models.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewIn(BaseModel): + """ + JSON:API representation of filterView entity. + """ # noqa: E501 + attributes: JsonApiFilterViewInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiFilterViewInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['filterView']): + raise ValueError("must be one of enum values ('filterView')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiFilterViewInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiFilterViewInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_attributes.py new file mode 100644 index 000000000..9650bd9f2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_attributes.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewInAttributes(BaseModel): + """ + JsonApiFilterViewInAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Dict[str, Any] = Field(description="The respective filter context.") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + is_default: Optional[StrictBool] = Field(default=None, description="Indicator whether the filter view should by applied by default.", alias="isDefault") + tags: Optional[List[StrictStr]] = None + title: Annotated[str, Field(strict=True, max_length=255)] + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "description", "isDefault", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "description": obj.get("description"), + "isDefault": obj.get("isDefault"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_document.py new file mode 100644 index 000000000..42bf249fd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_filter_view_in import JsonApiFilterViewIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewInDocument(BaseModel): + """ + JsonApiFilterViewInDocument + """ # noqa: E501 + data: JsonApiFilterViewIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiFilterViewIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_relationships.py new file mode 100644 index 000000000..4fde5d0c2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_relationships.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard +from gooddata_api_client.models.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewInRelationships(BaseModel): + """ + JsonApiFilterViewInRelationships + """ # noqa: E501 + analytical_dashboard: Optional[JsonApiAutomationInRelationshipsAnalyticalDashboard] = Field(default=None, alias="analyticalDashboard") + user: Optional[JsonApiFilterViewInRelationshipsUser] = None + __properties: ClassVar[List[str]] = ["analyticalDashboard", "user"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewInRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of analytical_dashboard + if self.analytical_dashboard: + _dict['analyticalDashboard'] = self.analytical_dashboard.to_dict() + # override the default output from pydantic by calling `to_dict()` of user + if self.user: + _dict['user'] = self.user.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewInRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticalDashboard": JsonApiAutomationInRelationshipsAnalyticalDashboard.from_dict(obj["analyticalDashboard"]) if obj.get("analyticalDashboard") is not None else None, + "user": JsonApiFilterViewInRelationshipsUser.from_dict(obj["user"]) if obj.get("user") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_relationships_user.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_relationships_user.py new file mode 100644 index 000000000..dad6fca85 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_in_relationships_user.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_user_to_one_linkage import JsonApiUserToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewInRelationshipsUser(BaseModel): + """ + JsonApiFilterViewInRelationshipsUser + """ # noqa: E501 + data: Optional[JsonApiUserToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewInRelationshipsUser from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewInRelationshipsUser from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out.py new file mode 100644 index 000000000..8731f0e01 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes +from gooddata_api_client.models.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewOut(BaseModel): + """ + JSON:API representation of filterView entity. + """ # noqa: E501 + attributes: JsonApiFilterViewInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiFilterViewInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['filterView']): + raise ValueError("must be one of enum values ('filterView')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiFilterViewInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiFilterViewInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_document.py new file mode 100644 index 000000000..efaa4630a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_filter_view_out import JsonApiFilterViewOut +from gooddata_api_client.models.json_api_filter_view_out_includes import JsonApiFilterViewOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewOutDocument(BaseModel): + """ + JsonApiFilterViewOutDocument + """ # noqa: E501 + data: JsonApiFilterViewOut + included: Optional[List[JsonApiFilterViewOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiFilterViewOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiFilterViewOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_includes.py new file mode 100644 index 000000000..ab9c4a055 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_includes.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIFILTERVIEWOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiAnalyticalDashboardOutWithLinks", "JsonApiUserOutWithLinks"] + +class JsonApiFilterViewOutIncludes(BaseModel): + """ + JsonApiFilterViewOutIncludes + """ + # data type: JsonApiAnalyticalDashboardOutWithLinks + oneof_schema_1_validator: Optional[JsonApiAnalyticalDashboardOutWithLinks] = None + # data type: JsonApiUserOutWithLinks + oneof_schema_2_validator: Optional[JsonApiUserOutWithLinks] = None + actual_instance: Optional[Union[JsonApiAnalyticalDashboardOutWithLinks, JsonApiUserOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiAnalyticalDashboardOutWithLinks", "JsonApiUserOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiFilterViewOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiAnalyticalDashboardOutWithLinks + if not isinstance(v, JsonApiAnalyticalDashboardOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAnalyticalDashboardOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiUserOutWithLinks + if not isinstance(v, JsonApiUserOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiFilterViewOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiFilterViewOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiAnalyticalDashboardOutWithLinks + try: + instance.actual_instance = JsonApiAnalyticalDashboardOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiUserOutWithLinks + try: + instance.actual_instance = JsonApiUserOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiFilterViewOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiFilterViewOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAnalyticalDashboardOutWithLinks, JsonApiUserOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_list.py new file mode 100644 index 000000000..0a6eb280c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_filter_view_out_includes import JsonApiFilterViewOutIncludes +from gooddata_api_client.models.json_api_filter_view_out_with_links import JsonApiFilterViewOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiFilterViewOutWithLinks] + included: Optional[List[JsonApiFilterViewOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiFilterViewOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiFilterViewOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_with_links.py new file mode 100644 index 000000000..94abe2523 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_out_with_links.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes +from gooddata_api_client.models.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewOutWithLinks(BaseModel): + """ + JsonApiFilterViewOutWithLinks + """ # noqa: E501 + attributes: JsonApiFilterViewInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiFilterViewInRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['filterView']): + raise ValueError("must be one of enum values ('filterView')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiFilterViewInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiFilterViewInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_patch.py new file mode 100644 index 000000000..4e1455cec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_patch.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships +from gooddata_api_client.models.json_api_filter_view_patch_attributes import JsonApiFilterViewPatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewPatch(BaseModel): + """ + JSON:API representation of patching filterView entity. + """ # noqa: E501 + attributes: JsonApiFilterViewPatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiFilterViewInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['filterView']): + raise ValueError("must be one of enum values ('filterView')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiFilterViewPatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiFilterViewInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_patch_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_patch_attributes.py new file mode 100644 index 000000000..f26e0598c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_patch_attributes.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewPatchAttributes(BaseModel): + """ + JsonApiFilterViewPatchAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Optional[Dict[str, Any]] = Field(default=None, description="The respective filter context.") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + is_default: Optional[StrictBool] = Field(default=None, description="Indicator whether the filter view should by applied by default.", alias="isDefault") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "description", "isDefault", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewPatchAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewPatchAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "description": obj.get("description"), + "isDefault": obj.get("isDefault"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_patch_document.py new file mode 100644 index 000000000..2785def14 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_filter_view_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_filter_view_patch import JsonApiFilterViewPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiFilterViewPatchDocument(BaseModel): + """ + JsonApiFilterViewPatchDocument + """ # noqa: E501 + data: JsonApiFilterViewPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiFilterViewPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiFilterViewPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiFilterViewPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_in.py new file mode 100644 index 000000000..18744624c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiIdentityProviderIn(BaseModel): + """ + JSON:API representation of identityProvider entity. + """ # noqa: E501 + attributes: Optional[JsonApiIdentityProviderInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['identityProvider']): + raise ValueError("must be one of enum values ('identityProvider')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiIdentityProviderInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_in_attributes.py new file mode 100644 index 000000000..7ed9759ea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_in_attributes.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiIdentityProviderInAttributes(BaseModel): + """ + JsonApiIdentityProviderInAttributes + """ # noqa: E501 + custom_claim_mapping: Optional[Dict[str, StrictStr]] = Field(default=None, description="Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", alias="customClaimMapping") + identifiers: Optional[List[StrictStr]] = Field(default=None, description="List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.") + idp_type: Optional[StrictStr] = Field(default=None, description="Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", alias="idpType") + oauth_client_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", alias="oauthClientId") + oauth_client_secret: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", alias="oauthClientSecret") + oauth_custom_auth_attributes: Optional[Dict[str, StrictStr]] = Field(default=None, description="Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", alias="oauthCustomAuthAttributes") + oauth_custom_scopes: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", alias="oauthCustomScopes") + oauth_issuer_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", alias="oauthIssuerId") + oauth_issuer_location: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The location of your OIDC provider. This field is mandatory for OIDC IdP.", alias="oauthIssuerLocation") + oauth_subject_id_claim: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", alias="oauthSubjectIdClaim") + saml_metadata: Optional[Annotated[str, Field(strict=True, max_length=15000)]] = Field(default=None, description="Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.", alias="samlMetadata") + __properties: ClassVar[List[str]] = ["customClaimMapping", "identifiers", "idpType", "oauthClientId", "oauthClientSecret", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim", "samlMetadata"] + + @field_validator('idp_type') + def idp_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MANAGED_IDP', 'FIM_IDP', 'DEX_IDP', 'CUSTOM_IDP']): + raise ValueError("must be one of enum values ('MANAGED_IDP', 'FIM_IDP', 'DEX_IDP', 'CUSTOM_IDP')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if oauth_custom_scopes (nullable) is None + # and model_fields_set contains the field + if self.oauth_custom_scopes is None and "oauth_custom_scopes" in self.model_fields_set: + _dict['oauthCustomScopes'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "customClaimMapping": obj.get("customClaimMapping"), + "identifiers": obj.get("identifiers"), + "idpType": obj.get("idpType"), + "oauthClientId": obj.get("oauthClientId"), + "oauthClientSecret": obj.get("oauthClientSecret"), + "oauthCustomAuthAttributes": obj.get("oauthCustomAuthAttributes"), + "oauthCustomScopes": obj.get("oauthCustomScopes"), + "oauthIssuerId": obj.get("oauthIssuerId"), + "oauthIssuerLocation": obj.get("oauthIssuerLocation"), + "oauthSubjectIdClaim": obj.get("oauthSubjectIdClaim"), + "samlMetadata": obj.get("samlMetadata") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_in_document.py new file mode 100644 index 000000000..594a7205a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_identity_provider_in import JsonApiIdentityProviderIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiIdentityProviderInDocument(BaseModel): + """ + JsonApiIdentityProviderInDocument + """ # noqa: E501 + data: JsonApiIdentityProviderIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiIdentityProviderIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_linkage.py new file mode 100644 index 000000000..da61a687d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiIdentityProviderLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['identityProvider']): + raise ValueError("must be one of enum values ('identityProvider')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out.py new file mode 100644 index 000000000..bc8c866fc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_identity_provider_out_attributes import JsonApiIdentityProviderOutAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiIdentityProviderOut(BaseModel): + """ + JSON:API representation of identityProvider entity. + """ # noqa: E501 + attributes: Optional[JsonApiIdentityProviderOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['identityProvider']): + raise ValueError("must be one of enum values ('identityProvider')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiIdentityProviderOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_attributes.py new file mode 100644 index 000000000..1a3b836c9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_attributes.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiIdentityProviderOutAttributes(BaseModel): + """ + JsonApiIdentityProviderOutAttributes + """ # noqa: E501 + custom_claim_mapping: Optional[Dict[str, StrictStr]] = Field(default=None, description="Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", alias="customClaimMapping") + identifiers: Optional[List[StrictStr]] = Field(default=None, description="List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.") + idp_type: Optional[StrictStr] = Field(default=None, description="Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", alias="idpType") + oauth_client_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", alias="oauthClientId") + oauth_custom_auth_attributes: Optional[Dict[str, StrictStr]] = Field(default=None, description="Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", alias="oauthCustomAuthAttributes") + oauth_custom_scopes: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", alias="oauthCustomScopes") + oauth_issuer_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", alias="oauthIssuerId") + oauth_issuer_location: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The location of your OIDC provider. This field is mandatory for OIDC IdP.", alias="oauthIssuerLocation") + oauth_subject_id_claim: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", alias="oauthSubjectIdClaim") + __properties: ClassVar[List[str]] = ["customClaimMapping", "identifiers", "idpType", "oauthClientId", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim"] + + @field_validator('idp_type') + def idp_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MANAGED_IDP', 'FIM_IDP', 'DEX_IDP', 'CUSTOM_IDP']): + raise ValueError("must be one of enum values ('MANAGED_IDP', 'FIM_IDP', 'DEX_IDP', 'CUSTOM_IDP')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if oauth_custom_scopes (nullable) is None + # and model_fields_set contains the field + if self.oauth_custom_scopes is None and "oauth_custom_scopes" in self.model_fields_set: + _dict['oauthCustomScopes'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "customClaimMapping": obj.get("customClaimMapping"), + "identifiers": obj.get("identifiers"), + "idpType": obj.get("idpType"), + "oauthClientId": obj.get("oauthClientId"), + "oauthCustomAuthAttributes": obj.get("oauthCustomAuthAttributes"), + "oauthCustomScopes": obj.get("oauthCustomScopes"), + "oauthIssuerId": obj.get("oauthIssuerId"), + "oauthIssuerLocation": obj.get("oauthIssuerLocation"), + "oauthSubjectIdClaim": obj.get("oauthSubjectIdClaim") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_document.py new file mode 100644 index 000000000..81ac56560 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_identity_provider_out import JsonApiIdentityProviderOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiIdentityProviderOutDocument(BaseModel): + """ + JsonApiIdentityProviderOutDocument + """ # noqa: E501 + data: JsonApiIdentityProviderOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiIdentityProviderOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_list.py new file mode 100644 index 000000000..5f63dabcc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_identity_provider_out_with_links import JsonApiIdentityProviderOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiIdentityProviderOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiIdentityProviderOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiIdentityProviderOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_with_links.py new file mode 100644 index 000000000..dafcb0a00 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_identity_provider_out_attributes import JsonApiIdentityProviderOutAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiIdentityProviderOutWithLinks(BaseModel): + """ + JsonApiIdentityProviderOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiIdentityProviderOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['identityProvider']): + raise ValueError("must be one of enum values ('identityProvider')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiIdentityProviderOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_patch.py new file mode 100644 index 000000000..b5ee25d64 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiIdentityProviderPatch(BaseModel): + """ + JSON:API representation of patching identityProvider entity. + """ # noqa: E501 + attributes: Optional[JsonApiIdentityProviderInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['identityProvider']): + raise ValueError("must be one of enum values ('identityProvider')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiIdentityProviderInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_patch_document.py new file mode 100644 index 000000000..dac025aa2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_identity_provider_patch import JsonApiIdentityProviderPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiIdentityProviderPatchDocument(BaseModel): + """ + JsonApiIdentityProviderPatchDocument + """ # noqa: E501 + data: JsonApiIdentityProviderPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiIdentityProviderPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiIdentityProviderPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_to_one_linkage.py new file mode 100644 index 000000000..f9fe5fc74 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_identity_provider_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_identity_provider_linkage import JsonApiIdentityProviderLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIIDENTITYPROVIDERTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiIdentityProviderLinkage"] + +class JsonApiIdentityProviderToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiIdentityProviderLinkage + oneof_schema_1_validator: Optional[JsonApiIdentityProviderLinkage] = None + actual_instance: Optional[Union[JsonApiIdentityProviderLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiIdentityProviderLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiIdentityProviderToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiIdentityProviderLinkage + if not isinstance(v, JsonApiIdentityProviderLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiIdentityProviderLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiIdentityProviderToOneLinkage with oneOf schemas: JsonApiIdentityProviderLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiIdentityProviderToOneLinkage with oneOf schemas: JsonApiIdentityProviderLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiIdentityProviderLinkage + try: + instance.actual_instance = JsonApiIdentityProviderLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiIdentityProviderToOneLinkage with oneOf schemas: JsonApiIdentityProviderLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiIdentityProviderToOneLinkage with oneOf schemas: JsonApiIdentityProviderLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiIdentityProviderLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in.py new file mode 100644 index 000000000..291d80f7b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_jwk_in_attributes import JsonApiJwkInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiJwkIn(BaseModel): + """ + JSON:API representation of jwk entity. + """ # noqa: E501 + attributes: Optional[JsonApiJwkInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['jwk']): + raise ValueError("must be one of enum values ('jwk')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiJwkIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiJwkIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiJwkInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in_attributes.py new file mode 100644 index 000000000..c3a3db7f0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in_attributes.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_jwk_in_attributes_content import JsonApiJwkInAttributesContent +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiJwkInAttributes(BaseModel): + """ + JsonApiJwkInAttributes + """ # noqa: E501 + content: Optional[JsonApiJwkInAttributesContent] = None + __properties: ClassVar[List[str]] = ["content"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiJwkInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of content + if self.content: + _dict['content'] = self.content.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiJwkInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": JsonApiJwkInAttributesContent.from_dict(obj["content"]) if obj.get("content") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in_attributes_content.py b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in_attributes_content.py new file mode 100644 index 000000000..d3e221383 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in_attributes_content.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.rsa_specification import RsaSpecification +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIJWKINATTRIBUTESCONTENT_ONE_OF_SCHEMAS = ["RsaSpecification"] + +class JsonApiJwkInAttributesContent(BaseModel): + """ + Specification of the cryptographic key + """ + # data type: RsaSpecification + oneof_schema_1_validator: Optional[RsaSpecification] = None + actual_instance: Optional[Union[RsaSpecification]] = None + one_of_schemas: Set[str] = { "RsaSpecification" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiJwkInAttributesContent.model_construct() + error_messages = [] + match = 0 + # validate data type: RsaSpecification + if not isinstance(v, RsaSpecification): + error_messages.append(f"Error! Input type `{type(v)}` is not `RsaSpecification`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiJwkInAttributesContent with oneOf schemas: RsaSpecification. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiJwkInAttributesContent with oneOf schemas: RsaSpecification. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into RsaSpecification + try: + instance.actual_instance = RsaSpecification.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiJwkInAttributesContent with oneOf schemas: RsaSpecification. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiJwkInAttributesContent with oneOf schemas: RsaSpecification. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], RsaSpecification]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in_document.py new file mode 100644 index 000000000..9f38ed32b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_jwk_in import JsonApiJwkIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiJwkInDocument(BaseModel): + """ + JsonApiJwkInDocument + """ # noqa: E501 + data: JsonApiJwkIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiJwkInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiJwkInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiJwkIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out.py new file mode 100644 index 000000000..f48121ea8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_jwk_in_attributes import JsonApiJwkInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiJwkOut(BaseModel): + """ + JSON:API representation of jwk entity. + """ # noqa: E501 + attributes: Optional[JsonApiJwkInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['jwk']): + raise ValueError("must be one of enum values ('jwk')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiJwkOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiJwkOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiJwkInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out_document.py new file mode 100644 index 000000000..e7a5ce469 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_jwk_out import JsonApiJwkOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiJwkOutDocument(BaseModel): + """ + JsonApiJwkOutDocument + """ # noqa: E501 + data: JsonApiJwkOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiJwkOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiJwkOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiJwkOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out_list.py new file mode 100644 index 000000000..83c4c0d8b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_jwk_out_with_links import JsonApiJwkOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiJwkOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiJwkOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiJwkOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiJwkOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiJwkOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out_with_links.py new file mode 100644 index 000000000..7726f06ac --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_jwk_in_attributes import JsonApiJwkInAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiJwkOutWithLinks(BaseModel): + """ + JsonApiJwkOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiJwkInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['jwk']): + raise ValueError("must be one of enum values ('jwk')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiJwkOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiJwkOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiJwkInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_jwk_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_patch.py new file mode 100644 index 000000000..c40293861 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_jwk_in_attributes import JsonApiJwkInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiJwkPatch(BaseModel): + """ + JSON:API representation of patching jwk entity. + """ # noqa: E501 + attributes: Optional[JsonApiJwkInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['jwk']): + raise ValueError("must be one of enum values ('jwk')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiJwkPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiJwkPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiJwkInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_jwk_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_patch_document.py new file mode 100644 index 000000000..4216d7685 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_jwk_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_jwk_patch import JsonApiJwkPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiJwkPatchDocument(BaseModel): + """ + JsonApiJwkPatchDocument + """ # noqa: E501 + data: JsonApiJwkPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiJwkPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiJwkPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiJwkPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_label_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_label_linkage.py new file mode 100644 index 000000000..ce1b2e7cc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_label_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLabelLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['label']): + raise ValueError("must be one of enum values ('label')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLabelLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLabelLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_label_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_label_out.py new file mode 100644 index 000000000..6bd9c4c37 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_label_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_label_out_attributes import JsonApiLabelOutAttributes +from gooddata_api_client.models.json_api_label_out_relationships import JsonApiLabelOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLabelOut(BaseModel): + """ + JSON:API representation of label entity. + """ # noqa: E501 + attributes: Optional[JsonApiLabelOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiLabelOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['label']): + raise ValueError("must be one of enum values ('label')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLabelOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLabelOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiLabelOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiLabelOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_label_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_attributes.py new file mode 100644 index 000000000..e3bd90a54 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_attributes.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLabelOutAttributes(BaseModel): + """ + JsonApiLabelOutAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + is_hidden: Optional[StrictBool] = Field(default=None, alias="isHidden") + primary: Optional[StrictBool] = None + source_column: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="sourceColumn") + source_column_data_type: Optional[StrictStr] = Field(default=None, alias="sourceColumnDataType") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + value_type: Optional[StrictStr] = Field(default=None, alias="valueType") + __properties: ClassVar[List[str]] = ["areRelationsValid", "description", "isHidden", "primary", "sourceColumn", "sourceColumnDataType", "tags", "title", "valueType"] + + @field_validator('source_column_data_type') + def source_column_data_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + @field_validator('value_type') + def value_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TEXT', 'HYPERLINK', 'GEO', 'GEO_LONGITUDE', 'GEO_LATITUDE', 'IMAGE']): + raise ValueError("must be one of enum values ('TEXT', 'HYPERLINK', 'GEO', 'GEO_LONGITUDE', 'GEO_LATITUDE', 'IMAGE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLabelOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLabelOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "description": obj.get("description"), + "isHidden": obj.get("isHidden"), + "primary": obj.get("primary"), + "sourceColumn": obj.get("sourceColumn"), + "sourceColumnDataType": obj.get("sourceColumnDataType"), + "tags": obj.get("tags"), + "title": obj.get("title"), + "valueType": obj.get("valueType") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_label_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_document.py new file mode 100644 index 000000000..c51d96919 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_label_out import JsonApiLabelOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLabelOutDocument(BaseModel): + """ + JsonApiLabelOutDocument + """ # noqa: E501 + data: JsonApiLabelOut + included: Optional[List[JsonApiAttributeOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLabelOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLabelOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiLabelOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiAttributeOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_label_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_list.py new file mode 100644 index 000000000..4fb0cd674 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLabelOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiLabelOutWithLinks] + included: Optional[List[JsonApiAttributeOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLabelOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLabelOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiLabelOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiAttributeOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_label_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_relationships.py new file mode 100644 index 000000000..710b50b64 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_relationships.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_label_out_relationships_attribute import JsonApiLabelOutRelationshipsAttribute +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLabelOutRelationships(BaseModel): + """ + JsonApiLabelOutRelationships + """ # noqa: E501 + attribute: Optional[JsonApiLabelOutRelationshipsAttribute] = None + __properties: ClassVar[List[str]] = ["attribute"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLabelOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attribute + if self.attribute: + _dict['attribute'] = self.attribute.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLabelOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attribute": JsonApiLabelOutRelationshipsAttribute.from_dict(obj["attribute"]) if obj.get("attribute") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_label_out_relationships_attribute.py b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_relationships_attribute.py new file mode 100644 index 000000000..401494569 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_relationships_attribute.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_attribute_to_one_linkage import JsonApiAttributeToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLabelOutRelationshipsAttribute(BaseModel): + """ + JsonApiLabelOutRelationshipsAttribute + """ # noqa: E501 + data: Optional[JsonApiAttributeToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLabelOutRelationshipsAttribute from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLabelOutRelationshipsAttribute from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiAttributeToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_label_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_with_links.py new file mode 100644 index 000000000..22883836a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_label_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_label_out_attributes import JsonApiLabelOutAttributes +from gooddata_api_client.models.json_api_label_out_relationships import JsonApiLabelOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLabelOutWithLinks(BaseModel): + """ + JsonApiLabelOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiLabelOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiLabelOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['label']): + raise ValueError("must be one of enum values ('label')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLabelOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLabelOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiLabelOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiLabelOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_label_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_label_to_one_linkage.py new file mode 100644 index 000000000..543ca69bb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_label_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_label_linkage import JsonApiLabelLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPILABELTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiLabelLinkage"] + +class JsonApiLabelToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiLabelLinkage + oneof_schema_1_validator: Optional[JsonApiLabelLinkage] = None + actual_instance: Optional[Union[JsonApiLabelLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiLabelLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiLabelToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiLabelLinkage + if not isinstance(v, JsonApiLabelLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiLabelLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiLabelToOneLinkage with oneOf schemas: JsonApiLabelLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiLabelToOneLinkage with oneOf schemas: JsonApiLabelLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiLabelLinkage + try: + instance.actual_instance = JsonApiLabelLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiLabelToOneLinkage with oneOf schemas: JsonApiLabelLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiLabelToOneLinkage with oneOf schemas: JsonApiLabelLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiLabelLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_in.py new file mode 100644 index 000000000..b5b9e5db9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_llm_endpoint_in_attributes import JsonApiLlmEndpointInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLlmEndpointIn(BaseModel): + """ + JSON:API representation of llmEndpoint entity. + """ # noqa: E501 + attributes: JsonApiLlmEndpointInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['llmEndpoint']): + raise ValueError("must be one of enum values ('llmEndpoint')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiLlmEndpointInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_in_attributes.py new file mode 100644 index 000000000..40a0ce764 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_in_attributes.py @@ -0,0 +1,119 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLlmEndpointInAttributes(BaseModel): + """ + JsonApiLlmEndpointInAttributes + """ # noqa: E501 + base_url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Custom LLM endpoint.", alias="baseUrl") + llm_model: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="LLM Model. We provide a default model for each provider, but you can override it here.", alias="llmModel") + llm_organization: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Organization in LLM provider.", alias="llmOrganization") + provider: Optional[StrictStr] = Field(default=None, description="LLM Provider.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="User-facing title of the LLM Provider.") + token: Annotated[str, Field(strict=True, max_length=10000)] = Field(description="The token to use to connect to the LLM provider.") + __properties: ClassVar[List[str]] = ["baseUrl", "llmModel", "llmOrganization", "provider", "title", "token"] + + @field_validator('provider') + def provider_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['OPENAI', 'AZURE_OPENAI']): + raise ValueError("must be one of enum values ('OPENAI', 'AZURE_OPENAI')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if base_url (nullable) is None + # and model_fields_set contains the field + if self.base_url is None and "base_url" in self.model_fields_set: + _dict['baseUrl'] = None + + # set to None if llm_organization (nullable) is None + # and model_fields_set contains the field + if self.llm_organization is None and "llm_organization" in self.model_fields_set: + _dict['llmOrganization'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "baseUrl": obj.get("baseUrl"), + "llmModel": obj.get("llmModel"), + "llmOrganization": obj.get("llmOrganization"), + "provider": obj.get("provider"), + "title": obj.get("title"), + "token": obj.get("token") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_in_document.py new file mode 100644 index 000000000..c6546a0ea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_llm_endpoint_in import JsonApiLlmEndpointIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLlmEndpointInDocument(BaseModel): + """ + JsonApiLlmEndpointInDocument + """ # noqa: E501 + data: JsonApiLlmEndpointIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiLlmEndpointIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out.py new file mode 100644 index 000000000..53224b52f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_llm_endpoint_out_attributes import JsonApiLlmEndpointOutAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLlmEndpointOut(BaseModel): + """ + JSON:API representation of llmEndpoint entity. + """ # noqa: E501 + attributes: JsonApiLlmEndpointOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['llmEndpoint']): + raise ValueError("must be one of enum values ('llmEndpoint')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiLlmEndpointOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_attributes.py new file mode 100644 index 000000000..01c690af0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_attributes.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLlmEndpointOutAttributes(BaseModel): + """ + JsonApiLlmEndpointOutAttributes + """ # noqa: E501 + base_url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Custom LLM endpoint.", alias="baseUrl") + llm_model: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="LLM Model. We provide a default model for each provider, but you can override it here.", alias="llmModel") + llm_organization: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Organization in LLM provider.", alias="llmOrganization") + provider: Optional[StrictStr] = Field(default=None, description="LLM Provider.") + title: Annotated[str, Field(strict=True, max_length=255)] = Field(description="User-facing title of the LLM Provider.") + __properties: ClassVar[List[str]] = ["baseUrl", "llmModel", "llmOrganization", "provider", "title"] + + @field_validator('provider') + def provider_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['OPENAI', 'AZURE_OPENAI']): + raise ValueError("must be one of enum values ('OPENAI', 'AZURE_OPENAI')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if base_url (nullable) is None + # and model_fields_set contains the field + if self.base_url is None and "base_url" in self.model_fields_set: + _dict['baseUrl'] = None + + # set to None if llm_organization (nullable) is None + # and model_fields_set contains the field + if self.llm_organization is None and "llm_organization" in self.model_fields_set: + _dict['llmOrganization'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "baseUrl": obj.get("baseUrl"), + "llmModel": obj.get("llmModel"), + "llmOrganization": obj.get("llmOrganization"), + "provider": obj.get("provider"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_document.py new file mode 100644 index 000000000..2e5373cea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_llm_endpoint_out import JsonApiLlmEndpointOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLlmEndpointOutDocument(BaseModel): + """ + JsonApiLlmEndpointOutDocument + """ # noqa: E501 + data: JsonApiLlmEndpointOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiLlmEndpointOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_list.py new file mode 100644 index 000000000..69c39274c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_llm_endpoint_out_with_links import JsonApiLlmEndpointOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLlmEndpointOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiLlmEndpointOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiLlmEndpointOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_with_links.py new file mode 100644 index 000000000..969057309 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_llm_endpoint_out_attributes import JsonApiLlmEndpointOutAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLlmEndpointOutWithLinks(BaseModel): + """ + JsonApiLlmEndpointOutWithLinks + """ # noqa: E501 + attributes: JsonApiLlmEndpointOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['llmEndpoint']): + raise ValueError("must be one of enum values ('llmEndpoint')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiLlmEndpointOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_patch.py new file mode 100644 index 000000000..c1fd52a46 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_llm_endpoint_patch_attributes import JsonApiLlmEndpointPatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLlmEndpointPatch(BaseModel): + """ + JSON:API representation of patching llmEndpoint entity. + """ # noqa: E501 + attributes: JsonApiLlmEndpointPatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['llmEndpoint']): + raise ValueError("must be one of enum values ('llmEndpoint')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiLlmEndpointPatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_patch_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_patch_attributes.py new file mode 100644 index 000000000..e6e62a84b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_patch_attributes.py @@ -0,0 +1,119 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLlmEndpointPatchAttributes(BaseModel): + """ + JsonApiLlmEndpointPatchAttributes + """ # noqa: E501 + base_url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Custom LLM endpoint.", alias="baseUrl") + llm_model: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="LLM Model. We provide a default model for each provider, but you can override it here.", alias="llmModel") + llm_organization: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Organization in LLM provider.", alias="llmOrganization") + provider: Optional[StrictStr] = Field(default=None, description="LLM Provider.") + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="User-facing title of the LLM Provider.") + token: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="The token to use to connect to the LLM provider.") + __properties: ClassVar[List[str]] = ["baseUrl", "llmModel", "llmOrganization", "provider", "title", "token"] + + @field_validator('provider') + def provider_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['OPENAI', 'AZURE_OPENAI']): + raise ValueError("must be one of enum values ('OPENAI', 'AZURE_OPENAI')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointPatchAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if base_url (nullable) is None + # and model_fields_set contains the field + if self.base_url is None and "base_url" in self.model_fields_set: + _dict['baseUrl'] = None + + # set to None if llm_organization (nullable) is None + # and model_fields_set contains the field + if self.llm_organization is None and "llm_organization" in self.model_fields_set: + _dict['llmOrganization'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointPatchAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "baseUrl": obj.get("baseUrl"), + "llmModel": obj.get("llmModel"), + "llmOrganization": obj.get("llmOrganization"), + "provider": obj.get("provider"), + "title": obj.get("title"), + "token": obj.get("token") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_patch_document.py new file mode 100644 index 000000000..58c20ec9f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_llm_endpoint_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_llm_endpoint_patch import JsonApiLlmEndpointPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiLlmEndpointPatchDocument(BaseModel): + """ + JsonApiLlmEndpointPatchDocument + """ # noqa: E501 + data: JsonApiLlmEndpointPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiLlmEndpointPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiLlmEndpointPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_in.py new file mode 100644 index 000000000..236659131 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_metric_in_attributes import JsonApiMetricInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricIn(BaseModel): + """ + JSON:API representation of metric entity. + """ # noqa: E501 + attributes: JsonApiMetricInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['metric']): + raise ValueError("must be one of enum values ('metric')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiMetricInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_in_attributes.py new file mode 100644 index 000000000..1a004dd57 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_in_attributes.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricInAttributes(BaseModel): + """ + JsonApiMetricInAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: JsonApiMetricInAttributesContent + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + is_hidden: Optional[StrictBool] = Field(default=None, alias="isHidden") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "description", "isHidden", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of content + if self.content: + _dict['content'] = self.content.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": JsonApiMetricInAttributesContent.from_dict(obj["content"]) if obj.get("content") is not None else None, + "description": obj.get("description"), + "isHidden": obj.get("isHidden"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_in_attributes_content.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_in_attributes_content.py new file mode 100644 index 000000000..67d19ccea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_in_attributes_content.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricInAttributesContent(BaseModel): + """ + JsonApiMetricInAttributesContent + """ # noqa: E501 + format: Optional[Annotated[str, Field(strict=True, max_length=2048)]] = None + maql: Annotated[str, Field(strict=True, max_length=10000)] + __properties: ClassVar[List[str]] = ["format", "maql"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricInAttributesContent from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricInAttributesContent from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "format": obj.get("format"), + "maql": obj.get("maql") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_in_document.py new file mode 100644 index 000000000..68ecae083 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_metric_in import JsonApiMetricIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricInDocument(BaseModel): + """ + JsonApiMetricInDocument + """ # noqa: E501 + data: JsonApiMetricIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiMetricIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_linkage.py new file mode 100644 index 000000000..cb235778b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['metric']): + raise ValueError("must be one of enum values ('metric')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out.py new file mode 100644 index 000000000..5192c4f19 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_metric_out_attributes import JsonApiMetricOutAttributes +from gooddata_api_client.models.json_api_metric_out_relationships import JsonApiMetricOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricOut(BaseModel): + """ + JSON:API representation of metric entity. + """ # noqa: E501 + attributes: JsonApiMetricOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiMetricOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['metric']): + raise ValueError("must be one of enum values ('metric')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiMetricOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiMetricOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_attributes.py new file mode 100644 index 000000000..f98216d7d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_attributes.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricOutAttributes(BaseModel): + """ + JsonApiMetricOutAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: JsonApiMetricInAttributesContent + created_at: Optional[datetime] = Field(default=None, alias="createdAt") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + is_hidden: Optional[StrictBool] = Field(default=None, alias="isHidden") + modified_at: Optional[datetime] = Field(default=None, alias="modifiedAt") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "createdAt", "description", "isHidden", "modifiedAt", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of content + if self.content: + _dict['content'] = self.content.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": JsonApiMetricInAttributesContent.from_dict(obj["content"]) if obj.get("content") is not None else None, + "createdAt": obj.get("createdAt"), + "description": obj.get("description"), + "isHidden": obj.get("isHidden"), + "modifiedAt": obj.get("modifiedAt"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_document.py new file mode 100644 index 000000000..f88a2d8da --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_metric_out import JsonApiMetricOut +from gooddata_api_client.models.json_api_metric_out_includes import JsonApiMetricOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricOutDocument(BaseModel): + """ + JsonApiMetricOutDocument + """ # noqa: E501 + data: JsonApiMetricOut + included: Optional[List[JsonApiMetricOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiMetricOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiMetricOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_includes.py new file mode 100644 index 000000000..e46e24b1e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_includes.py @@ -0,0 +1,194 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.json_api_metric_out_with_links import JsonApiMetricOutWithLinks +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIMETRICOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiAttributeOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiFactOutWithLinks", "JsonApiLabelOutWithLinks", "JsonApiMetricOutWithLinks", "JsonApiUserIdentifierOutWithLinks"] + +class JsonApiMetricOutIncludes(BaseModel): + """ + JsonApiMetricOutIncludes + """ + # data type: JsonApiUserIdentifierOutWithLinks + oneof_schema_1_validator: Optional[JsonApiUserIdentifierOutWithLinks] = None + # data type: JsonApiFactOutWithLinks + oneof_schema_2_validator: Optional[JsonApiFactOutWithLinks] = None + # data type: JsonApiAttributeOutWithLinks + oneof_schema_3_validator: Optional[JsonApiAttributeOutWithLinks] = None + # data type: JsonApiLabelOutWithLinks + oneof_schema_4_validator: Optional[JsonApiLabelOutWithLinks] = None + # data type: JsonApiMetricOutWithLinks + oneof_schema_5_validator: Optional[JsonApiMetricOutWithLinks] = None + # data type: JsonApiDatasetOutWithLinks + oneof_schema_6_validator: Optional[JsonApiDatasetOutWithLinks] = None + actual_instance: Optional[Union[JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiAttributeOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiFactOutWithLinks", "JsonApiLabelOutWithLinks", "JsonApiMetricOutWithLinks", "JsonApiUserIdentifierOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiMetricOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiUserIdentifierOutWithLinks + if not isinstance(v, JsonApiUserIdentifierOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserIdentifierOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiFactOutWithLinks + if not isinstance(v, JsonApiFactOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiFactOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAttributeOutWithLinks + if not isinstance(v, JsonApiAttributeOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAttributeOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiLabelOutWithLinks + if not isinstance(v, JsonApiLabelOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiLabelOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiMetricOutWithLinks + if not isinstance(v, JsonApiMetricOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiMetricOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiDatasetOutWithLinks + if not isinstance(v, JsonApiDatasetOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiDatasetOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiMetricOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiMetricOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiUserIdentifierOutWithLinks + try: + instance.actual_instance = JsonApiUserIdentifierOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiFactOutWithLinks + try: + instance.actual_instance = JsonApiFactOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAttributeOutWithLinks + try: + instance.actual_instance = JsonApiAttributeOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiLabelOutWithLinks + try: + instance.actual_instance = JsonApiLabelOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiMetricOutWithLinks + try: + instance.actual_instance = JsonApiMetricOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiDatasetOutWithLinks + try: + instance.actual_instance = JsonApiDatasetOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiMetricOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiMetricOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserIdentifierOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_list.py new file mode 100644 index 000000000..a70b6a8db --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_metric_out_includes import JsonApiMetricOutIncludes +from gooddata_api_client.models.json_api_metric_out_with_links import JsonApiMetricOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiMetricOutWithLinks] + included: Optional[List[JsonApiMetricOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiMetricOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiMetricOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_relationships.py new file mode 100644 index 000000000..ce2dfdb90 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_relationships.py @@ -0,0 +1,127 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes +from gooddata_api_client.models.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricOutRelationships(BaseModel): + """ + JsonApiMetricOutRelationships + """ # noqa: E501 + attributes: Optional[JsonApiAttributeHierarchyOutRelationshipsAttributes] = None + created_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="createdBy") + datasets: Optional[JsonApiAnalyticalDashboardOutRelationshipsDatasets] = None + facts: Optional[JsonApiDatasetOutRelationshipsFacts] = None + labels: Optional[JsonApiAnalyticalDashboardOutRelationshipsLabels] = None + metrics: Optional[JsonApiAnalyticalDashboardOutRelationshipsMetrics] = None + modified_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="modifiedBy") + __properties: ClassVar[List[str]] = ["attributes", "createdBy", "datasets", "facts", "labels", "metrics", "modifiedBy"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of datasets + if self.datasets: + _dict['datasets'] = self.datasets.to_dict() + # override the default output from pydantic by calling `to_dict()` of facts + if self.facts: + _dict['facts'] = self.facts.to_dict() + # override the default output from pydantic by calling `to_dict()` of labels + if self.labels: + _dict['labels'] = self.labels.to_dict() + # override the default output from pydantic by calling `to_dict()` of metrics + if self.metrics: + _dict['metrics'] = self.metrics.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAttributeHierarchyOutRelationshipsAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "createdBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "datasets": JsonApiAnalyticalDashboardOutRelationshipsDatasets.from_dict(obj["datasets"]) if obj.get("datasets") is not None else None, + "facts": JsonApiDatasetOutRelationshipsFacts.from_dict(obj["facts"]) if obj.get("facts") is not None else None, + "labels": JsonApiAnalyticalDashboardOutRelationshipsLabels.from_dict(obj["labels"]) if obj.get("labels") is not None else None, + "metrics": JsonApiAnalyticalDashboardOutRelationshipsMetrics.from_dict(obj["metrics"]) if obj.get("metrics") is not None else None, + "modifiedBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_with_links.py new file mode 100644 index 000000000..380d4d65d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_metric_out_attributes import JsonApiMetricOutAttributes +from gooddata_api_client.models.json_api_metric_out_relationships import JsonApiMetricOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricOutWithLinks(BaseModel): + """ + JsonApiMetricOutWithLinks + """ # noqa: E501 + attributes: JsonApiMetricOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiMetricOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['metric']): + raise ValueError("must be one of enum values ('metric')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiMetricOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiMetricOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_patch.py new file mode 100644 index 000000000..2ec14e964 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_metric_patch_attributes import JsonApiMetricPatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricPatch(BaseModel): + """ + JSON:API representation of patching metric entity. + """ # noqa: E501 + attributes: JsonApiMetricPatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['metric']): + raise ValueError("must be one of enum values ('metric')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiMetricPatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_patch_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_patch_attributes.py new file mode 100644 index 000000000..392bf7612 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_patch_attributes.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricPatchAttributes(BaseModel): + """ + JsonApiMetricPatchAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Optional[JsonApiMetricInAttributesContent] = None + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + is_hidden: Optional[StrictBool] = Field(default=None, alias="isHidden") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "description", "isHidden", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricPatchAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of content + if self.content: + _dict['content'] = self.content.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricPatchAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": JsonApiMetricInAttributesContent.from_dict(obj["content"]) if obj.get("content") is not None else None, + "description": obj.get("description"), + "isHidden": obj.get("isHidden"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_patch_document.py new file mode 100644 index 000000000..86674c24a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_metric_patch import JsonApiMetricPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricPatchDocument(BaseModel): + """ + JsonApiMetricPatchDocument + """ # noqa: E501 + data: JsonApiMetricPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiMetricPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_post_optional_id.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_post_optional_id.py new file mode 100644 index 000000000..6e8958524 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_post_optional_id.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_metric_in_attributes import JsonApiMetricInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricPostOptionalId(BaseModel): + """ + JSON:API representation of metric entity. + """ # noqa: E501 + attributes: JsonApiMetricInAttributes + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['metric']): + raise ValueError("must be one of enum values ('metric')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricPostOptionalId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricPostOptionalId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiMetricInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_metric_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_metric_post_optional_id_document.py new file mode 100644 index 000000000..d1f8ddd9d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_metric_post_optional_id_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_metric_post_optional_id import JsonApiMetricPostOptionalId +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiMetricPostOptionalIdDocument(BaseModel): + """ + JsonApiMetricPostOptionalIdDocument + """ # noqa: E501 + data: JsonApiMetricPostOptionalId + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiMetricPostOptionalIdDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiMetricPostOptionalIdDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiMetricPostOptionalId.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out.py new file mode 100644 index 000000000..93136d018 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_notification_channel_identifier_out_attributes import JsonApiNotificationChannelIdentifierOutAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelIdentifierOut(BaseModel): + """ + JSON:API representation of notificationChannelIdentifier entity. + """ # noqa: E501 + attributes: Optional[JsonApiNotificationChannelIdentifierOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['notificationChannelIdentifier']): + raise ValueError("must be one of enum values ('notificationChannelIdentifier')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIdentifierOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIdentifierOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiNotificationChannelIdentifierOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_attributes.py new file mode 100644 index 000000000..7ca84aaba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_attributes.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelIdentifierOutAttributes(BaseModel): + """ + JsonApiNotificationChannelIdentifierOutAttributes + """ # noqa: E501 + allowed_recipients: Optional[StrictStr] = Field(default=None, description="Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization ", alias="allowedRecipients") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + destination_type: Optional[StrictStr] = Field(default=None, alias="destinationType") + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["allowedRecipients", "description", "destinationType", "name"] + + @field_validator('allowed_recipients') + def allowed_recipients_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['CREATOR', 'INTERNAL', 'EXTERNAL']): + raise ValueError("must be one of enum values ('CREATOR', 'INTERNAL', 'EXTERNAL')") + return value + + @field_validator('destination_type') + def destination_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['WEBHOOK', 'SMTP', 'DEFAULT_SMTP', 'IN_PLATFORM']): + raise ValueError("must be one of enum values ('WEBHOOK', 'SMTP', 'DEFAULT_SMTP', 'IN_PLATFORM')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIdentifierOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIdentifierOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "allowedRecipients": obj.get("allowedRecipients"), + "description": obj.get("description"), + "destinationType": obj.get("destinationType"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_document.py new file mode 100644 index 000000000..be42e7cc8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_notification_channel_identifier_out import JsonApiNotificationChannelIdentifierOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelIdentifierOutDocument(BaseModel): + """ + JsonApiNotificationChannelIdentifierOutDocument + """ # noqa: E501 + data: JsonApiNotificationChannelIdentifierOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIdentifierOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIdentifierOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiNotificationChannelIdentifierOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_list.py new file mode 100644 index 000000000..b9a47fc90 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_notification_channel_identifier_out_with_links import JsonApiNotificationChannelIdentifierOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelIdentifierOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiNotificationChannelIdentifierOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIdentifierOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIdentifierOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiNotificationChannelIdentifierOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_with_links.py new file mode 100644 index 000000000..01e9578f6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_identifier_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_notification_channel_identifier_out_attributes import JsonApiNotificationChannelIdentifierOutAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelIdentifierOutWithLinks(BaseModel): + """ + JsonApiNotificationChannelIdentifierOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiNotificationChannelIdentifierOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['notificationChannelIdentifier']): + raise ValueError("must be one of enum values ('notificationChannelIdentifier')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIdentifierOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIdentifierOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiNotificationChannelIdentifierOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in.py new file mode 100644 index 000000000..6b97ec828 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_notification_channel_in_attributes import JsonApiNotificationChannelInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelIn(BaseModel): + """ + JSON:API representation of notificationChannel entity. + """ # noqa: E501 + attributes: Optional[JsonApiNotificationChannelInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['notificationChannel']): + raise ValueError("must be one of enum values ('notificationChannel')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiNotificationChannelInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in_attributes.py new file mode 100644 index 000000000..f282e00c1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in_attributes.py @@ -0,0 +1,147 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_notification_channel_in_attributes_destination import JsonApiNotificationChannelInAttributesDestination +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelInAttributes(BaseModel): + """ + JsonApiNotificationChannelInAttributes + """ # noqa: E501 + allowed_recipients: Optional[StrictStr] = Field(default=None, description="Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization ", alias="allowedRecipients") + custom_dashboard_url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} ", alias="customDashboardUrl") + dashboard_link_visibility: Optional[StrictStr] = Field(default=None, description="Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link ", alias="dashboardLinkVisibility") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + destination: Optional[JsonApiNotificationChannelInAttributesDestination] = None + in_platform_notification: Optional[StrictStr] = Field(default=None, description="In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications ", alias="inPlatformNotification") + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + notification_source: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} ", alias="notificationSource") + __properties: ClassVar[List[str]] = ["allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "inPlatformNotification", "name", "notificationSource"] + + @field_validator('allowed_recipients') + def allowed_recipients_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['CREATOR', 'INTERNAL', 'EXTERNAL']): + raise ValueError("must be one of enum values ('CREATOR', 'INTERNAL', 'EXTERNAL')") + return value + + @field_validator('dashboard_link_visibility') + def dashboard_link_visibility_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['HIDDEN', 'INTERNAL_ONLY', 'ALL']): + raise ValueError("must be one of enum values ('HIDDEN', 'INTERNAL_ONLY', 'ALL')") + return value + + @field_validator('in_platform_notification') + def in_platform_notification_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['DISABLED', 'ENABLED']): + raise ValueError("must be one of enum values ('DISABLED', 'ENABLED')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of destination + if self.destination: + _dict['destination'] = self.destination.to_dict() + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "allowedRecipients": obj.get("allowedRecipients"), + "customDashboardUrl": obj.get("customDashboardUrl"), + "dashboardLinkVisibility": obj.get("dashboardLinkVisibility"), + "description": obj.get("description"), + "destination": JsonApiNotificationChannelInAttributesDestination.from_dict(obj["destination"]) if obj.get("destination") is not None else None, + "inPlatformNotification": obj.get("inPlatformNotification"), + "name": obj.get("name"), + "notificationSource": obj.get("notificationSource") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in_attributes_destination.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in_attributes_destination.py new file mode 100644 index 000000000..13c90ee5d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in_attributes_destination.py @@ -0,0 +1,166 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.default_smtp import DefaultSmtp +from gooddata_api_client.models.in_platform import InPlatform +from gooddata_api_client.models.smtp import Smtp +from gooddata_api_client.models.webhook import Webhook +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPINOTIFICATIONCHANNELINATTRIBUTESDESTINATION_ONE_OF_SCHEMAS = ["DefaultSmtp", "InPlatform", "Smtp", "Webhook"] + +class JsonApiNotificationChannelInAttributesDestination(BaseModel): + """ + The destination where the notifications are to be sent. + """ + # data type: DefaultSmtp + oneof_schema_1_validator: Optional[DefaultSmtp] = None + # data type: InPlatform + oneof_schema_2_validator: Optional[InPlatform] = None + # data type: Smtp + oneof_schema_3_validator: Optional[Smtp] = None + # data type: Webhook + oneof_schema_4_validator: Optional[Webhook] = None + actual_instance: Optional[Union[DefaultSmtp, InPlatform, Smtp, Webhook]] = None + one_of_schemas: Set[str] = { "DefaultSmtp", "InPlatform", "Smtp", "Webhook" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiNotificationChannelInAttributesDestination.model_construct() + error_messages = [] + match = 0 + # validate data type: DefaultSmtp + if not isinstance(v, DefaultSmtp): + error_messages.append(f"Error! Input type `{type(v)}` is not `DefaultSmtp`") + else: + match += 1 + # validate data type: InPlatform + if not isinstance(v, InPlatform): + error_messages.append(f"Error! Input type `{type(v)}` is not `InPlatform`") + else: + match += 1 + # validate data type: Smtp + if not isinstance(v, Smtp): + error_messages.append(f"Error! Input type `{type(v)}` is not `Smtp`") + else: + match += 1 + # validate data type: Webhook + if not isinstance(v, Webhook): + error_messages.append(f"Error! Input type `{type(v)}` is not `Webhook`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiNotificationChannelInAttributesDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiNotificationChannelInAttributesDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into DefaultSmtp + try: + instance.actual_instance = DefaultSmtp.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into InPlatform + try: + instance.actual_instance = InPlatform.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into Smtp + try: + instance.actual_instance = Smtp.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into Webhook + try: + instance.actual_instance = Webhook.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiNotificationChannelInAttributesDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiNotificationChannelInAttributesDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], DefaultSmtp, InPlatform, Smtp, Webhook]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in_document.py new file mode 100644 index 000000000..631bdeed4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_notification_channel_in import JsonApiNotificationChannelIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelInDocument(BaseModel): + """ + JsonApiNotificationChannelInDocument + """ # noqa: E501 + data: JsonApiNotificationChannelIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiNotificationChannelIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_linkage.py new file mode 100644 index 000000000..c3eb7dd35 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['notificationChannel']): + raise ValueError("must be one of enum values ('notificationChannel')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out.py new file mode 100644 index 000000000..ba46c5709 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_notification_channel_out_attributes import JsonApiNotificationChannelOutAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelOut(BaseModel): + """ + JSON:API representation of notificationChannel entity. + """ # noqa: E501 + attributes: Optional[JsonApiNotificationChannelOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['notificationChannel']): + raise ValueError("must be one of enum values ('notificationChannel')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiNotificationChannelOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_attributes.py new file mode 100644 index 000000000..9f8346c83 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_attributes.py @@ -0,0 +1,164 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_notification_channel_in_attributes_destination import JsonApiNotificationChannelInAttributesDestination +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelOutAttributes(BaseModel): + """ + JsonApiNotificationChannelOutAttributes + """ # noqa: E501 + allowed_recipients: Optional[StrictStr] = Field(default=None, description="Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization ", alias="allowedRecipients") + custom_dashboard_url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} ", alias="customDashboardUrl") + dashboard_link_visibility: Optional[StrictStr] = Field(default=None, description="Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link ", alias="dashboardLinkVisibility") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + destination: Optional[JsonApiNotificationChannelInAttributesDestination] = None + destination_type: Optional[StrictStr] = Field(default=None, alias="destinationType") + in_platform_notification: Optional[StrictStr] = Field(default=None, description="In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications ", alias="inPlatformNotification") + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + notification_source: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} ", alias="notificationSource") + __properties: ClassVar[List[str]] = ["allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "destinationType", "inPlatformNotification", "name", "notificationSource"] + + @field_validator('allowed_recipients') + def allowed_recipients_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['CREATOR', 'INTERNAL', 'EXTERNAL']): + raise ValueError("must be one of enum values ('CREATOR', 'INTERNAL', 'EXTERNAL')") + return value + + @field_validator('dashboard_link_visibility') + def dashboard_link_visibility_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['HIDDEN', 'INTERNAL_ONLY', 'ALL']): + raise ValueError("must be one of enum values ('HIDDEN', 'INTERNAL_ONLY', 'ALL')") + return value + + @field_validator('destination_type') + def destination_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['WEBHOOK', 'SMTP', 'DEFAULT_SMTP', 'IN_PLATFORM']): + raise ValueError("must be one of enum values ('WEBHOOK', 'SMTP', 'DEFAULT_SMTP', 'IN_PLATFORM')") + return value + + @field_validator('in_platform_notification') + def in_platform_notification_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['DISABLED', 'ENABLED']): + raise ValueError("must be one of enum values ('DISABLED', 'ENABLED')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of destination + if self.destination: + _dict['destination'] = self.destination.to_dict() + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if destination_type (nullable) is None + # and model_fields_set contains the field + if self.destination_type is None and "destination_type" in self.model_fields_set: + _dict['destinationType'] = None + + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "allowedRecipients": obj.get("allowedRecipients"), + "customDashboardUrl": obj.get("customDashboardUrl"), + "dashboardLinkVisibility": obj.get("dashboardLinkVisibility"), + "description": obj.get("description"), + "destination": JsonApiNotificationChannelInAttributesDestination.from_dict(obj["destination"]) if obj.get("destination") is not None else None, + "destinationType": obj.get("destinationType"), + "inPlatformNotification": obj.get("inPlatformNotification"), + "name": obj.get("name"), + "notificationSource": obj.get("notificationSource") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_document.py new file mode 100644 index 000000000..21f061676 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_notification_channel_out import JsonApiNotificationChannelOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelOutDocument(BaseModel): + """ + JsonApiNotificationChannelOutDocument + """ # noqa: E501 + data: JsonApiNotificationChannelOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiNotificationChannelOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_list.py new file mode 100644 index 000000000..611096df1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiNotificationChannelOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiNotificationChannelOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_with_links.py new file mode 100644 index 000000000..0a6ea663b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_notification_channel_out_attributes import JsonApiNotificationChannelOutAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelOutWithLinks(BaseModel): + """ + JsonApiNotificationChannelOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiNotificationChannelOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['notificationChannel']): + raise ValueError("must be one of enum values ('notificationChannel')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiNotificationChannelOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_patch.py new file mode 100644 index 000000000..db25dfc72 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_notification_channel_in_attributes import JsonApiNotificationChannelInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelPatch(BaseModel): + """ + JSON:API representation of patching notificationChannel entity. + """ # noqa: E501 + attributes: Optional[JsonApiNotificationChannelInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['notificationChannel']): + raise ValueError("must be one of enum values ('notificationChannel')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiNotificationChannelInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_patch_document.py new file mode 100644 index 000000000..1ff9ada59 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_notification_channel_patch import JsonApiNotificationChannelPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelPatchDocument(BaseModel): + """ + JsonApiNotificationChannelPatchDocument + """ # noqa: E501 + data: JsonApiNotificationChannelPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiNotificationChannelPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_post_optional_id.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_post_optional_id.py new file mode 100644 index 000000000..67b311450 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_post_optional_id.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_notification_channel_in_attributes import JsonApiNotificationChannelInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelPostOptionalId(BaseModel): + """ + JSON:API representation of notificationChannel entity. + """ # noqa: E501 + attributes: Optional[JsonApiNotificationChannelInAttributes] = None + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['notificationChannel']): + raise ValueError("must be one of enum values ('notificationChannel')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelPostOptionalId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelPostOptionalId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiNotificationChannelInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_post_optional_id_document.py new file mode 100644 index 000000000..c2345591b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_post_optional_id_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_notification_channel_post_optional_id import JsonApiNotificationChannelPostOptionalId +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiNotificationChannelPostOptionalIdDocument(BaseModel): + """ + JsonApiNotificationChannelPostOptionalIdDocument + """ # noqa: E501 + data: JsonApiNotificationChannelPostOptionalId + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelPostOptionalIdDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiNotificationChannelPostOptionalIdDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiNotificationChannelPostOptionalId.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_to_one_linkage.py new file mode 100644 index 000000000..9662f8d4f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_notification_channel_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_notification_channel_linkage import JsonApiNotificationChannelLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPINOTIFICATIONCHANNELTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiNotificationChannelLinkage"] + +class JsonApiNotificationChannelToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiNotificationChannelLinkage + oneof_schema_1_validator: Optional[JsonApiNotificationChannelLinkage] = None + actual_instance: Optional[Union[JsonApiNotificationChannelLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiNotificationChannelLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiNotificationChannelToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiNotificationChannelLinkage + if not isinstance(v, JsonApiNotificationChannelLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiNotificationChannelLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiNotificationChannelToOneLinkage with oneOf schemas: JsonApiNotificationChannelLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiNotificationChannelToOneLinkage with oneOf schemas: JsonApiNotificationChannelLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiNotificationChannelLinkage + try: + instance.actual_instance = JsonApiNotificationChannelLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiNotificationChannelToOneLinkage with oneOf schemas: JsonApiNotificationChannelLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiNotificationChannelToOneLinkage with oneOf schemas: JsonApiNotificationChannelLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiNotificationChannelLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_in.py new file mode 100644 index 000000000..74729b03a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_in.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_in_attributes import JsonApiOrganizationInAttributes +from gooddata_api_client.models.json_api_organization_in_relationships import JsonApiOrganizationInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationIn(BaseModel): + """ + JSON:API representation of organization entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiOrganizationInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['organization']): + raise ValueError("must be one of enum values ('organization')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiOrganizationInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_attributes.py new file mode 100644 index 000000000..994777f21 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_attributes.py @@ -0,0 +1,131 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationInAttributes(BaseModel): + """ + JsonApiOrganizationInAttributes + """ # noqa: E501 + allowed_origins: Optional[List[StrictStr]] = Field(default=None, alias="allowedOrigins") + early_access: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", alias="earlyAccess") + early_access_values: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="The early access feature identifiers. They are used to enable experimental features.", alias="earlyAccessValues") + hostname: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + oauth_client_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="oauthClientId") + oauth_client_secret: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="oauthClientSecret") + oauth_custom_auth_attributes: Optional[Dict[str, StrictStr]] = Field(default=None, description="Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", alias="oauthCustomAuthAttributes") + oauth_custom_scopes: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", alias="oauthCustomScopes") + oauth_issuer_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", alias="oauthIssuerId") + oauth_issuer_location: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="oauthIssuerLocation") + oauth_subject_id_claim: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", alias="oauthSubjectIdClaim") + __properties: ClassVar[List[str]] = ["allowedOrigins", "earlyAccess", "earlyAccessValues", "hostname", "name", "oauthClientId", "oauthClientSecret", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if early_access (nullable) is None + # and model_fields_set contains the field + if self.early_access is None and "early_access" in self.model_fields_set: + _dict['earlyAccess'] = None + + # set to None if early_access_values (nullable) is None + # and model_fields_set contains the field + if self.early_access_values is None and "early_access_values" in self.model_fields_set: + _dict['earlyAccessValues'] = None + + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + # set to None if oauth_custom_scopes (nullable) is None + # and model_fields_set contains the field + if self.oauth_custom_scopes is None and "oauth_custom_scopes" in self.model_fields_set: + _dict['oauthCustomScopes'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "allowedOrigins": obj.get("allowedOrigins"), + "earlyAccess": obj.get("earlyAccess"), + "earlyAccessValues": obj.get("earlyAccessValues"), + "hostname": obj.get("hostname"), + "name": obj.get("name"), + "oauthClientId": obj.get("oauthClientId"), + "oauthClientSecret": obj.get("oauthClientSecret"), + "oauthCustomAuthAttributes": obj.get("oauthCustomAuthAttributes"), + "oauthCustomScopes": obj.get("oauthCustomScopes"), + "oauthIssuerId": obj.get("oauthIssuerId"), + "oauthIssuerLocation": obj.get("oauthIssuerLocation"), + "oauthSubjectIdClaim": obj.get("oauthSubjectIdClaim") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_document.py new file mode 100644 index 000000000..cc8c26f4c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_organization_in import JsonApiOrganizationIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationInDocument(BaseModel): + """ + JsonApiOrganizationInDocument + """ # noqa: E501 + data: JsonApiOrganizationIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiOrganizationIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_relationships.py new file mode 100644 index 000000000..5c34b5e41 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_relationships.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_organization_in_relationships_identity_provider import JsonApiOrganizationInRelationshipsIdentityProvider +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationInRelationships(BaseModel): + """ + JsonApiOrganizationInRelationships + """ # noqa: E501 + identity_provider: Optional[JsonApiOrganizationInRelationshipsIdentityProvider] = Field(default=None, alias="identityProvider") + __properties: ClassVar[List[str]] = ["identityProvider"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationInRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of identity_provider + if self.identity_provider: + _dict['identityProvider'] = self.identity_provider.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationInRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "identityProvider": JsonApiOrganizationInRelationshipsIdentityProvider.from_dict(obj["identityProvider"]) if obj.get("identityProvider") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_relationships_identity_provider.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_relationships_identity_provider.py new file mode 100644 index 000000000..9e0a4ead5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_in_relationships_identity_provider.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_identity_provider_to_one_linkage import JsonApiIdentityProviderToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationInRelationshipsIdentityProvider(BaseModel): + """ + JsonApiOrganizationInRelationshipsIdentityProvider + """ # noqa: E501 + data: Optional[JsonApiIdentityProviderToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationInRelationshipsIdentityProvider from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationInRelationshipsIdentityProvider from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiIdentityProviderToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out.py new file mode 100644 index 000000000..b490893b8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_out_attributes import JsonApiOrganizationOutAttributes +from gooddata_api_client.models.json_api_organization_out_meta import JsonApiOrganizationOutMeta +from gooddata_api_client.models.json_api_organization_out_relationships import JsonApiOrganizationOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationOut(BaseModel): + """ + JSON:API representation of organization entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiOrganizationOutMeta] = None + relationships: Optional[JsonApiOrganizationOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['organization']): + raise ValueError("must be one of enum values ('organization')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiOrganizationOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiOrganizationOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_attributes.py new file mode 100644 index 000000000..3d8b26ebe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_attributes.py @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_out_attributes_cache_settings import JsonApiOrganizationOutAttributesCacheSettings +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationOutAttributes(BaseModel): + """ + JsonApiOrganizationOutAttributes + """ # noqa: E501 + allowed_origins: Optional[List[StrictStr]] = Field(default=None, alias="allowedOrigins") + cache_settings: Optional[JsonApiOrganizationOutAttributesCacheSettings] = Field(default=None, alias="cacheSettings") + early_access: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", alias="earlyAccess") + early_access_values: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="The early access feature identifiers. They are used to enable experimental features.", alias="earlyAccessValues") + hostname: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + oauth_client_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="oauthClientId") + oauth_custom_auth_attributes: Optional[Dict[str, StrictStr]] = Field(default=None, description="Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", alias="oauthCustomAuthAttributes") + oauth_custom_scopes: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", alias="oauthCustomScopes") + oauth_issuer_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", alias="oauthIssuerId") + oauth_issuer_location: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="oauthIssuerLocation") + oauth_subject_id_claim: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", alias="oauthSubjectIdClaim") + __properties: ClassVar[List[str]] = ["allowedOrigins", "cacheSettings", "earlyAccess", "earlyAccessValues", "hostname", "name", "oauthClientId", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of cache_settings + if self.cache_settings: + _dict['cacheSettings'] = self.cache_settings.to_dict() + # set to None if early_access (nullable) is None + # and model_fields_set contains the field + if self.early_access is None and "early_access" in self.model_fields_set: + _dict['earlyAccess'] = None + + # set to None if early_access_values (nullable) is None + # and model_fields_set contains the field + if self.early_access_values is None and "early_access_values" in self.model_fields_set: + _dict['earlyAccessValues'] = None + + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + # set to None if oauth_custom_scopes (nullable) is None + # and model_fields_set contains the field + if self.oauth_custom_scopes is None and "oauth_custom_scopes" in self.model_fields_set: + _dict['oauthCustomScopes'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "allowedOrigins": obj.get("allowedOrigins"), + "cacheSettings": JsonApiOrganizationOutAttributesCacheSettings.from_dict(obj["cacheSettings"]) if obj.get("cacheSettings") is not None else None, + "earlyAccess": obj.get("earlyAccess"), + "earlyAccessValues": obj.get("earlyAccessValues"), + "hostname": obj.get("hostname"), + "name": obj.get("name"), + "oauthClientId": obj.get("oauthClientId"), + "oauthCustomAuthAttributes": obj.get("oauthCustomAuthAttributes"), + "oauthCustomScopes": obj.get("oauthCustomScopes"), + "oauthIssuerId": obj.get("oauthIssuerId"), + "oauthIssuerLocation": obj.get("oauthIssuerLocation"), + "oauthSubjectIdClaim": obj.get("oauthSubjectIdClaim") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_attributes_cache_settings.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_attributes_cache_settings.py new file mode 100644 index 000000000..a553dd2b4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_attributes_cache_settings.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationOutAttributesCacheSettings(BaseModel): + """ + JsonApiOrganizationOutAttributesCacheSettings + """ # noqa: E501 + cache_strategy: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="cacheStrategy") + extra_cache_budget: Optional[StrictInt] = Field(default=None, alias="extraCacheBudget") + __properties: ClassVar[List[str]] = ["cacheStrategy", "extraCacheBudget"] + + @field_validator('cache_strategy') + def cache_strategy_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['DURABLE', 'EPHEMERAL']): + raise ValueError("must be one of enum values ('DURABLE', 'EPHEMERAL')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutAttributesCacheSettings from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutAttributesCacheSettings from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cacheStrategy": obj.get("cacheStrategy"), + "extraCacheBudget": obj.get("extraCacheBudget") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_document.py new file mode 100644 index 000000000..44657bacd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_organization_out import JsonApiOrganizationOut +from gooddata_api_client.models.json_api_organization_out_includes import JsonApiOrganizationOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationOutDocument(BaseModel): + """ + JsonApiOrganizationOutDocument + """ # noqa: E501 + data: JsonApiOrganizationOut + included: Optional[List[JsonApiOrganizationOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiOrganizationOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiOrganizationOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_includes.py new file mode 100644 index 000000000..3bdd2ba3b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_includes.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_identity_provider_out_with_links import JsonApiIdentityProviderOutWithLinks +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIORGANIZATIONOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiIdentityProviderOutWithLinks", "JsonApiUserGroupOutWithLinks", "JsonApiUserOutWithLinks"] + +class JsonApiOrganizationOutIncludes(BaseModel): + """ + JsonApiOrganizationOutIncludes + """ + # data type: JsonApiUserOutWithLinks + oneof_schema_1_validator: Optional[JsonApiUserOutWithLinks] = None + # data type: JsonApiUserGroupOutWithLinks + oneof_schema_2_validator: Optional[JsonApiUserGroupOutWithLinks] = None + # data type: JsonApiIdentityProviderOutWithLinks + oneof_schema_3_validator: Optional[JsonApiIdentityProviderOutWithLinks] = None + actual_instance: Optional[Union[JsonApiIdentityProviderOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiIdentityProviderOutWithLinks", "JsonApiUserGroupOutWithLinks", "JsonApiUserOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiOrganizationOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiUserOutWithLinks + if not isinstance(v, JsonApiUserOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiUserGroupOutWithLinks + if not isinstance(v, JsonApiUserGroupOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserGroupOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiIdentityProviderOutWithLinks + if not isinstance(v, JsonApiIdentityProviderOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiIdentityProviderOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiOrganizationOutIncludes with oneOf schemas: JsonApiIdentityProviderOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiOrganizationOutIncludes with oneOf schemas: JsonApiIdentityProviderOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiUserOutWithLinks + try: + instance.actual_instance = JsonApiUserOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiUserGroupOutWithLinks + try: + instance.actual_instance = JsonApiUserGroupOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiIdentityProviderOutWithLinks + try: + instance.actual_instance = JsonApiIdentityProviderOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiOrganizationOutIncludes with oneOf schemas: JsonApiIdentityProviderOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiOrganizationOutIncludes with oneOf schemas: JsonApiIdentityProviderOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiIdentityProviderOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_meta.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_meta.py new file mode 100644 index 000000000..7c617ba17 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_meta.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationOutMeta(BaseModel): + """ + JsonApiOrganizationOutMeta + """ # noqa: E501 + permissions: Optional[List[StrictStr]] = Field(default=None, description="List of valid permissions for a logged-in user.") + __properties: ClassVar[List[str]] = ["permissions"] + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['MANAGE', 'SELF_CREATE_TOKEN']): + raise ValueError("each list item must be one of ('MANAGE', 'SELF_CREATE_TOKEN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutMeta from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutMeta from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": obj.get("permissions") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_relationships.py new file mode 100644 index 000000000..a3f46e7fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_relationships.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser +from gooddata_api_client.models.json_api_organization_in_relationships_identity_provider import JsonApiOrganizationInRelationshipsIdentityProvider +from gooddata_api_client.models.json_api_organization_out_relationships_bootstrap_user_group import JsonApiOrganizationOutRelationshipsBootstrapUserGroup +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationOutRelationships(BaseModel): + """ + JsonApiOrganizationOutRelationships + """ # noqa: E501 + bootstrap_user: Optional[JsonApiFilterViewInRelationshipsUser] = Field(default=None, alias="bootstrapUser") + bootstrap_user_group: Optional[JsonApiOrganizationOutRelationshipsBootstrapUserGroup] = Field(default=None, alias="bootstrapUserGroup") + identity_provider: Optional[JsonApiOrganizationInRelationshipsIdentityProvider] = Field(default=None, alias="identityProvider") + __properties: ClassVar[List[str]] = ["bootstrapUser", "bootstrapUserGroup", "identityProvider"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of bootstrap_user + if self.bootstrap_user: + _dict['bootstrapUser'] = self.bootstrap_user.to_dict() + # override the default output from pydantic by calling `to_dict()` of bootstrap_user_group + if self.bootstrap_user_group: + _dict['bootstrapUserGroup'] = self.bootstrap_user_group.to_dict() + # override the default output from pydantic by calling `to_dict()` of identity_provider + if self.identity_provider: + _dict['identityProvider'] = self.identity_provider.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "bootstrapUser": JsonApiFilterViewInRelationshipsUser.from_dict(obj["bootstrapUser"]) if obj.get("bootstrapUser") is not None else None, + "bootstrapUserGroup": JsonApiOrganizationOutRelationshipsBootstrapUserGroup.from_dict(obj["bootstrapUserGroup"]) if obj.get("bootstrapUserGroup") is not None else None, + "identityProvider": JsonApiOrganizationInRelationshipsIdentityProvider.from_dict(obj["identityProvider"]) if obj.get("identityProvider") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_relationships_bootstrap_user_group.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_relationships_bootstrap_user_group.py new file mode 100644 index 000000000..a5b44beff --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_out_relationships_bootstrap_user_group.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_user_group_to_one_linkage import JsonApiUserGroupToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationOutRelationshipsBootstrapUserGroup(BaseModel): + """ + JsonApiOrganizationOutRelationshipsBootstrapUserGroup + """ # noqa: E501 + data: Optional[JsonApiUserGroupToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutRelationshipsBootstrapUserGroup from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationOutRelationshipsBootstrapUserGroup from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserGroupToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_patch.py new file mode 100644 index 000000000..30cb2db24 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_patch.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_in_attributes import JsonApiOrganizationInAttributes +from gooddata_api_client.models.json_api_organization_in_relationships import JsonApiOrganizationInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationPatch(BaseModel): + """ + JSON:API representation of patching organization entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiOrganizationInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['organization']): + raise ValueError("must be one of enum values ('organization')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiOrganizationInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_patch_document.py new file mode 100644 index 000000000..a188721c6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_organization_patch import JsonApiOrganizationPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationPatchDocument(BaseModel): + """ + JsonApiOrganizationPatchDocument + """ # noqa: E501 + data: JsonApiOrganizationPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiOrganizationPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_in.py new file mode 100644 index 000000000..8428eff38 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationSettingIn(BaseModel): + """ + JSON:API representation of organizationSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['organizationSetting']): + raise ValueError("must be one of enum values ('organizationSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_in_attributes.py new file mode 100644 index 000000000..208067606 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_in_attributes.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationSettingInAttributes(BaseModel): + """ + JsonApiOrganizationSettingInAttributes + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON content. Maximum supported length is 15000 characters.") + type: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["content", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TIMEZONE', 'ACTIVE_THEME', 'ACTIVE_COLOR_PALETTE', 'ACTIVE_LLM_ENDPOINT', 'WHITE_LABELING', 'LOCALE', 'METADATA_LOCALE', 'FORMAT_LOCALE', 'MAPBOX_TOKEN', 'AG_GRID_TOKEN', 'WEEK_START', 'SHOW_HIDDEN_CATALOG_ITEMS', 'OPERATOR_OVERRIDES', 'TIMEZONE_VALIDATION_ENABLED', 'OPENAI_CONFIG', 'ENABLE_FILE_ANALYTICS', 'ALERT', 'SEPARATORS', 'DATE_FILTER_CONFIG', 'JIT_PROVISIONING', 'JWT_JIT_PROVISIONING', 'DASHBOARD_FILTERS_APPLY_MODE', 'ENABLE_SLIDES_EXPORT', 'AI_RATE_LIMIT', 'ATTACHMENT_SIZE_LIMIT', 'ATTACHMENT_LINK_TTL', 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE', 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS', 'ENABLE_AUTOMATION_EVALUATION_MODE', 'REGISTERED_PLUGGABLE_APPLICATIONS']): + raise ValueError("must be one of enum values ('TIMEZONE', 'ACTIVE_THEME', 'ACTIVE_COLOR_PALETTE', 'ACTIVE_LLM_ENDPOINT', 'WHITE_LABELING', 'LOCALE', 'METADATA_LOCALE', 'FORMAT_LOCALE', 'MAPBOX_TOKEN', 'AG_GRID_TOKEN', 'WEEK_START', 'SHOW_HIDDEN_CATALOG_ITEMS', 'OPERATOR_OVERRIDES', 'TIMEZONE_VALIDATION_ENABLED', 'OPENAI_CONFIG', 'ENABLE_FILE_ANALYTICS', 'ALERT', 'SEPARATORS', 'DATE_FILTER_CONFIG', 'JIT_PROVISIONING', 'JWT_JIT_PROVISIONING', 'DASHBOARD_FILTERS_APPLY_MODE', 'ENABLE_SLIDES_EXPORT', 'AI_RATE_LIMIT', 'ATTACHMENT_SIZE_LIMIT', 'ATTACHMENT_LINK_TTL', 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE', 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS', 'ENABLE_AUTOMATION_EVALUATION_MODE', 'REGISTERED_PLUGGABLE_APPLICATIONS')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_in_document.py new file mode 100644 index 000000000..f541df8fa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_organization_setting_in import JsonApiOrganizationSettingIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationSettingInDocument(BaseModel): + """ + JsonApiOrganizationSettingInDocument + """ # noqa: E501 + data: JsonApiOrganizationSettingIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiOrganizationSettingIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out.py new file mode 100644 index 000000000..08466aa46 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationSettingOut(BaseModel): + """ + JSON:API representation of organizationSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['organizationSetting']): + raise ValueError("must be one of enum values ('organizationSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out_document.py new file mode 100644 index 000000000..3186f2e16 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_organization_setting_out import JsonApiOrganizationSettingOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationSettingOutDocument(BaseModel): + """ + JsonApiOrganizationSettingOutDocument + """ # noqa: E501 + data: JsonApiOrganizationSettingOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiOrganizationSettingOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out_list.py new file mode 100644 index 000000000..bd725f286 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_organization_setting_out_with_links import JsonApiOrganizationSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationSettingOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiOrganizationSettingOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiOrganizationSettingOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out_with_links.py new file mode 100644 index 000000000..55bf1f43f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationSettingOutWithLinks(BaseModel): + """ + JsonApiOrganizationSettingOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['organizationSetting']): + raise ValueError("must be one of enum values ('organizationSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_patch.py new file mode 100644 index 000000000..27c839663 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationSettingPatch(BaseModel): + """ + JSON:API representation of patching organizationSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['organizationSetting']): + raise ValueError("must be one of enum values ('organizationSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_patch_document.py new file mode 100644 index 000000000..ef6a68e0e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_organization_setting_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_organization_setting_patch import JsonApiOrganizationSettingPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiOrganizationSettingPatchDocument(BaseModel): + """ + JsonApiOrganizationSettingPatchDocument + """ # noqa: E501 + data: JsonApiOrganizationSettingPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiOrganizationSettingPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiOrganizationSettingPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_theme_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_theme_in.py new file mode 100644 index 000000000..95a63d421 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_theme_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiThemeIn(BaseModel): + """ + JSON:API representation of theme entity. + """ # noqa: E501 + attributes: JsonApiColorPaletteInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['theme']): + raise ValueError("must be one of enum values ('theme')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiThemeIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiThemeIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiColorPaletteInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_theme_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_theme_in_document.py new file mode 100644 index 000000000..8d8abb220 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_theme_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_theme_in import JsonApiThemeIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiThemeInDocument(BaseModel): + """ + JsonApiThemeInDocument + """ # noqa: E501 + data: JsonApiThemeIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiThemeInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiThemeInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiThemeIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_theme_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_theme_out.py new file mode 100644 index 000000000..c6faa62be --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_theme_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiThemeOut(BaseModel): + """ + JSON:API representation of theme entity. + """ # noqa: E501 + attributes: JsonApiColorPaletteInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['theme']): + raise ValueError("must be one of enum values ('theme')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiThemeOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiThemeOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiColorPaletteInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_theme_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_theme_out_document.py new file mode 100644 index 000000000..79a1082f8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_theme_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_theme_out import JsonApiThemeOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiThemeOutDocument(BaseModel): + """ + JsonApiThemeOutDocument + """ # noqa: E501 + data: JsonApiThemeOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiThemeOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiThemeOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiThemeOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_theme_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_theme_out_list.py new file mode 100644 index 000000000..9f3ea369d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_theme_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_theme_out_with_links import JsonApiThemeOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiThemeOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiThemeOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiThemeOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiThemeOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiThemeOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_theme_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_theme_out_with_links.py new file mode 100644 index 000000000..b04477785 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_theme_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiThemeOutWithLinks(BaseModel): + """ + JsonApiThemeOutWithLinks + """ # noqa: E501 + attributes: JsonApiColorPaletteInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['theme']): + raise ValueError("must be one of enum values ('theme')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiThemeOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiThemeOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiColorPaletteInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_theme_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_theme_patch.py new file mode 100644 index 000000000..ead99f2ba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_theme_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_color_palette_patch_attributes import JsonApiColorPalettePatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiThemePatch(BaseModel): + """ + JSON:API representation of patching theme entity. + """ # noqa: E501 + attributes: JsonApiColorPalettePatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['theme']): + raise ValueError("must be one of enum values ('theme')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiThemePatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiThemePatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiColorPalettePatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_theme_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_theme_patch_document.py new file mode 100644 index 000000000..16dfd8440 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_theme_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_theme_patch import JsonApiThemePatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiThemePatchDocument(BaseModel): + """ + JsonApiThemePatchDocument + """ # noqa: E501 + data: JsonApiThemePatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiThemePatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiThemePatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiThemePatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in.py new file mode 100644 index 000000000..b0ee209e4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes +from gooddata_api_client.models.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterIn(BaseModel): + """ + JSON:API representation of userDataFilter entity. + """ # noqa: E501 + attributes: JsonApiUserDataFilterInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiUserDataFilterInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userDataFilter']): + raise ValueError("must be one of enum values ('userDataFilter')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserDataFilterInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiUserDataFilterInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in_attributes.py new file mode 100644 index 000000000..a8eea3b41 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in_attributes.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterInAttributes(BaseModel): + """ + JsonApiUserDataFilterInAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + maql: Annotated[str, Field(strict=True, max_length=10000)] + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "description", "maql", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "description": obj.get("description"), + "maql": obj.get("maql"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in_document.py new file mode 100644 index 000000000..16be9188b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_user_data_filter_in import JsonApiUserDataFilterIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterInDocument(BaseModel): + """ + JsonApiUserDataFilterInDocument + """ # noqa: E501 + data: JsonApiUserDataFilterIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserDataFilterIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in_relationships.py new file mode 100644 index 000000000..159e3730b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_in_relationships.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser +from gooddata_api_client.models.json_api_organization_out_relationships_bootstrap_user_group import JsonApiOrganizationOutRelationshipsBootstrapUserGroup +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterInRelationships(BaseModel): + """ + JsonApiUserDataFilterInRelationships + """ # noqa: E501 + user: Optional[JsonApiFilterViewInRelationshipsUser] = None + user_group: Optional[JsonApiOrganizationOutRelationshipsBootstrapUserGroup] = Field(default=None, alias="userGroup") + __properties: ClassVar[List[str]] = ["user", "userGroup"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterInRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user + if self.user: + _dict['user'] = self.user.to_dict() + # override the default output from pydantic by calling `to_dict()` of user_group + if self.user_group: + _dict['userGroup'] = self.user_group.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterInRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "user": JsonApiFilterViewInRelationshipsUser.from_dict(obj["user"]) if obj.get("user") is not None else None, + "userGroup": JsonApiOrganizationOutRelationshipsBootstrapUserGroup.from_dict(obj["userGroup"]) if obj.get("userGroup") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out.py new file mode 100644 index 000000000..e4e944665 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes +from gooddata_api_client.models.json_api_user_data_filter_out_relationships import JsonApiUserDataFilterOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterOut(BaseModel): + """ + JSON:API representation of userDataFilter entity. + """ # noqa: E501 + attributes: JsonApiUserDataFilterInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiUserDataFilterOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userDataFilter']): + raise ValueError("must be one of enum values ('userDataFilter')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserDataFilterInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiUserDataFilterOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_document.py new file mode 100644 index 000000000..f5275091b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_user_data_filter_out import JsonApiUserDataFilterOut +from gooddata_api_client.models.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterOutDocument(BaseModel): + """ + JsonApiUserDataFilterOutDocument + """ # noqa: E501 + data: JsonApiUserDataFilterOut + included: Optional[List[JsonApiUserDataFilterOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserDataFilterOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiUserDataFilterOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_includes.py new file mode 100644 index 000000000..197a52e55 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_includes.py @@ -0,0 +1,208 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.models.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks +from gooddata_api_client.models.json_api_fact_out_with_links import JsonApiFactOutWithLinks +from gooddata_api_client.models.json_api_label_out_with_links import JsonApiLabelOutWithLinks +from gooddata_api_client.models.json_api_metric_out_with_links import JsonApiMetricOutWithLinks +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIUSERDATAFILTEROUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiAttributeOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiFactOutWithLinks", "JsonApiLabelOutWithLinks", "JsonApiMetricOutWithLinks", "JsonApiUserGroupOutWithLinks", "JsonApiUserOutWithLinks"] + +class JsonApiUserDataFilterOutIncludes(BaseModel): + """ + JsonApiUserDataFilterOutIncludes + """ + # data type: JsonApiUserOutWithLinks + oneof_schema_1_validator: Optional[JsonApiUserOutWithLinks] = None + # data type: JsonApiUserGroupOutWithLinks + oneof_schema_2_validator: Optional[JsonApiUserGroupOutWithLinks] = None + # data type: JsonApiFactOutWithLinks + oneof_schema_3_validator: Optional[JsonApiFactOutWithLinks] = None + # data type: JsonApiAttributeOutWithLinks + oneof_schema_4_validator: Optional[JsonApiAttributeOutWithLinks] = None + # data type: JsonApiLabelOutWithLinks + oneof_schema_5_validator: Optional[JsonApiLabelOutWithLinks] = None + # data type: JsonApiMetricOutWithLinks + oneof_schema_6_validator: Optional[JsonApiMetricOutWithLinks] = None + # data type: JsonApiDatasetOutWithLinks + oneof_schema_7_validator: Optional[JsonApiDatasetOutWithLinks] = None + actual_instance: Optional[Union[JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiAttributeOutWithLinks", "JsonApiDatasetOutWithLinks", "JsonApiFactOutWithLinks", "JsonApiLabelOutWithLinks", "JsonApiMetricOutWithLinks", "JsonApiUserGroupOutWithLinks", "JsonApiUserOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiUserDataFilterOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiUserOutWithLinks + if not isinstance(v, JsonApiUserOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiUserGroupOutWithLinks + if not isinstance(v, JsonApiUserGroupOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserGroupOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiFactOutWithLinks + if not isinstance(v, JsonApiFactOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiFactOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAttributeOutWithLinks + if not isinstance(v, JsonApiAttributeOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAttributeOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiLabelOutWithLinks + if not isinstance(v, JsonApiLabelOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiLabelOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiMetricOutWithLinks + if not isinstance(v, JsonApiMetricOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiMetricOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiDatasetOutWithLinks + if not isinstance(v, JsonApiDatasetOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiDatasetOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiUserDataFilterOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiUserDataFilterOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiUserOutWithLinks + try: + instance.actual_instance = JsonApiUserOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiUserGroupOutWithLinks + try: + instance.actual_instance = JsonApiUserGroupOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiFactOutWithLinks + try: + instance.actual_instance = JsonApiFactOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAttributeOutWithLinks + try: + instance.actual_instance = JsonApiAttributeOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiLabelOutWithLinks + try: + instance.actual_instance = JsonApiLabelOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiMetricOutWithLinks + try: + instance.actual_instance = JsonApiMetricOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiDatasetOutWithLinks + try: + instance.actual_instance = JsonApiDatasetOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiUserDataFilterOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiUserDataFilterOutIncludes with oneOf schemas: JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, JsonApiMetricOutWithLinks, JsonApiUserGroupOutWithLinks, JsonApiUserOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_list.py new file mode 100644 index 000000000..25d691561 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes +from gooddata_api_client.models.json_api_user_data_filter_out_with_links import JsonApiUserDataFilterOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiUserDataFilterOutWithLinks] + included: Optional[List[JsonApiUserDataFilterOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiUserDataFilterOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiUserDataFilterOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_relationships.py new file mode 100644 index 000000000..e3917ed7b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_relationships.py @@ -0,0 +1,128 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics +from gooddata_api_client.models.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes +from gooddata_api_client.models.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts +from gooddata_api_client.models.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser +from gooddata_api_client.models.json_api_organization_out_relationships_bootstrap_user_group import JsonApiOrganizationOutRelationshipsBootstrapUserGroup +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterOutRelationships(BaseModel): + """ + JsonApiUserDataFilterOutRelationships + """ # noqa: E501 + attributes: Optional[JsonApiAttributeHierarchyOutRelationshipsAttributes] = None + datasets: Optional[JsonApiAnalyticalDashboardOutRelationshipsDatasets] = None + facts: Optional[JsonApiDatasetOutRelationshipsFacts] = None + labels: Optional[JsonApiAnalyticalDashboardOutRelationshipsLabels] = None + metrics: Optional[JsonApiAnalyticalDashboardOutRelationshipsMetrics] = None + user: Optional[JsonApiFilterViewInRelationshipsUser] = None + user_group: Optional[JsonApiOrganizationOutRelationshipsBootstrapUserGroup] = Field(default=None, alias="userGroup") + __properties: ClassVar[List[str]] = ["attributes", "datasets", "facts", "labels", "metrics", "user", "userGroup"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of datasets + if self.datasets: + _dict['datasets'] = self.datasets.to_dict() + # override the default output from pydantic by calling `to_dict()` of facts + if self.facts: + _dict['facts'] = self.facts.to_dict() + # override the default output from pydantic by calling `to_dict()` of labels + if self.labels: + _dict['labels'] = self.labels.to_dict() + # override the default output from pydantic by calling `to_dict()` of metrics + if self.metrics: + _dict['metrics'] = self.metrics.to_dict() + # override the default output from pydantic by calling `to_dict()` of user + if self.user: + _dict['user'] = self.user.to_dict() + # override the default output from pydantic by calling `to_dict()` of user_group + if self.user_group: + _dict['userGroup'] = self.user_group.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAttributeHierarchyOutRelationshipsAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "datasets": JsonApiAnalyticalDashboardOutRelationshipsDatasets.from_dict(obj["datasets"]) if obj.get("datasets") is not None else None, + "facts": JsonApiDatasetOutRelationshipsFacts.from_dict(obj["facts"]) if obj.get("facts") is not None else None, + "labels": JsonApiAnalyticalDashboardOutRelationshipsLabels.from_dict(obj["labels"]) if obj.get("labels") is not None else None, + "metrics": JsonApiAnalyticalDashboardOutRelationshipsMetrics.from_dict(obj["metrics"]) if obj.get("metrics") is not None else None, + "user": JsonApiFilterViewInRelationshipsUser.from_dict(obj["user"]) if obj.get("user") is not None else None, + "userGroup": JsonApiOrganizationOutRelationshipsBootstrapUserGroup.from_dict(obj["userGroup"]) if obj.get("userGroup") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_with_links.py new file mode 100644 index 000000000..718b60340 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes +from gooddata_api_client.models.json_api_user_data_filter_out_relationships import JsonApiUserDataFilterOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterOutWithLinks(BaseModel): + """ + JsonApiUserDataFilterOutWithLinks + """ # noqa: E501 + attributes: JsonApiUserDataFilterInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiUserDataFilterOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userDataFilter']): + raise ValueError("must be one of enum values ('userDataFilter')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserDataFilterInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiUserDataFilterOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_patch.py new file mode 100644 index 000000000..8c82609a6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_patch.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships +from gooddata_api_client.models.json_api_user_data_filter_patch_attributes import JsonApiUserDataFilterPatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterPatch(BaseModel): + """ + JSON:API representation of patching userDataFilter entity. + """ # noqa: E501 + attributes: JsonApiUserDataFilterPatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiUserDataFilterInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userDataFilter']): + raise ValueError("must be one of enum values ('userDataFilter')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserDataFilterPatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiUserDataFilterInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_patch_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_patch_attributes.py new file mode 100644 index 000000000..1db7aa028 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_patch_attributes.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterPatchAttributes(BaseModel): + """ + JsonApiUserDataFilterPatchAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + maql: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "description", "maql", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterPatchAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterPatchAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "description": obj.get("description"), + "maql": obj.get("maql"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_patch_document.py new file mode 100644 index 000000000..3ec9d9b03 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_user_data_filter_patch import JsonApiUserDataFilterPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterPatchDocument(BaseModel): + """ + JsonApiUserDataFilterPatchDocument + """ # noqa: E501 + data: JsonApiUserDataFilterPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserDataFilterPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_post_optional_id.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_post_optional_id.py new file mode 100644 index 000000000..51219fe6e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_post_optional_id.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes +from gooddata_api_client.models.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterPostOptionalId(BaseModel): + """ + JSON:API representation of userDataFilter entity. + """ # noqa: E501 + attributes: JsonApiUserDataFilterInAttributes + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="API identifier of an object") + relationships: Optional[JsonApiUserDataFilterInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userDataFilter']): + raise ValueError("must be one of enum values ('userDataFilter')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterPostOptionalId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterPostOptionalId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserDataFilterInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiUserDataFilterInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_post_optional_id_document.py new file mode 100644 index 000000000..787a1b40f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_data_filter_post_optional_id_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id import JsonApiUserDataFilterPostOptionalId +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserDataFilterPostOptionalIdDocument(BaseModel): + """ + JsonApiUserDataFilterPostOptionalIdDocument + """ # noqa: E501 + data: JsonApiUserDataFilterPostOptionalId + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterPostOptionalIdDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserDataFilterPostOptionalIdDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserDataFilterPostOptionalId.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in.py new file mode 100644 index 000000000..e6e479313 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes +from gooddata_api_client.models.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupIn(BaseModel): + """ + JSON:API representation of userGroup entity. + """ # noqa: E501 + attributes: Optional[JsonApiUserGroupInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiUserGroupInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userGroup']): + raise ValueError("must be one of enum values ('userGroup')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserGroupInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiUserGroupInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_attributes.py new file mode 100644 index 000000000..6618e3c9b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_attributes.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupInAttributes(BaseModel): + """ + JsonApiUserGroupInAttributes + """ # noqa: E501 + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_document.py new file mode 100644 index 000000000..00b918b8b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_user_group_in import JsonApiUserGroupIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupInDocument(BaseModel): + """ + JsonApiUserGroupInDocument + """ # noqa: E501 + data: JsonApiUserGroupIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserGroupIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_relationships.py new file mode 100644 index 000000000..08a103bda --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_relationships.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_user_group_in_relationships_parents import JsonApiUserGroupInRelationshipsParents +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupInRelationships(BaseModel): + """ + JsonApiUserGroupInRelationships + """ # noqa: E501 + parents: Optional[JsonApiUserGroupInRelationshipsParents] = None + __properties: ClassVar[List[str]] = ["parents"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupInRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of parents + if self.parents: + _dict['parents'] = self.parents.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupInRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "parents": JsonApiUserGroupInRelationshipsParents.from_dict(obj["parents"]) if obj.get("parents") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_relationships_parents.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_relationships_parents.py new file mode 100644 index 000000000..3f5cb6d46 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_in_relationships_parents.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_user_group_linkage import JsonApiUserGroupLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupInRelationshipsParents(BaseModel): + """ + JsonApiUserGroupInRelationshipsParents + """ # noqa: E501 + data: List[JsonApiUserGroupLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupInRelationshipsParents from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupInRelationshipsParents from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiUserGroupLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_linkage.py new file mode 100644 index 000000000..27396358f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userGroup']): + raise ValueError("must be one of enum values ('userGroup')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out.py new file mode 100644 index 000000000..49f658184 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes +from gooddata_api_client.models.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupOut(BaseModel): + """ + JSON:API representation of userGroup entity. + """ # noqa: E501 + attributes: Optional[JsonApiUserGroupInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiUserGroupInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userGroup']): + raise ValueError("must be one of enum values ('userGroup')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserGroupInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiUserGroupInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out_document.py new file mode 100644 index 000000000..f7a4c8624 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_user_group_out import JsonApiUserGroupOut +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupOutDocument(BaseModel): + """ + JsonApiUserGroupOutDocument + """ # noqa: E501 + data: JsonApiUserGroupOut + included: Optional[List[JsonApiUserGroupOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserGroupOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiUserGroupOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out_list.py new file mode 100644 index 000000000..69d49f461 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out_list.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiUserGroupOutWithLinks] + included: Optional[List[JsonApiUserGroupOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiUserGroupOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiUserGroupOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out_with_links.py new file mode 100644 index 000000000..5e46bae1d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_out_with_links.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes +from gooddata_api_client.models.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupOutWithLinks(BaseModel): + """ + JsonApiUserGroupOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiUserGroupInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiUserGroupInRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userGroup']): + raise ValueError("must be one of enum values ('userGroup')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserGroupInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiUserGroupInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_patch.py new file mode 100644 index 000000000..6cfc1546d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_patch.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_group_in_attributes import JsonApiUserGroupInAttributes +from gooddata_api_client.models.json_api_user_group_in_relationships import JsonApiUserGroupInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupPatch(BaseModel): + """ + JSON:API representation of patching userGroup entity. + """ # noqa: E501 + attributes: Optional[JsonApiUserGroupInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiUserGroupInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userGroup']): + raise ValueError("must be one of enum values ('userGroup')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserGroupInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiUserGroupInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_patch_document.py new file mode 100644 index 000000000..2a58f7d45 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_user_group_patch import JsonApiUserGroupPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserGroupPatchDocument(BaseModel): + """ + JsonApiUserGroupPatchDocument + """ # noqa: E501 + data: JsonApiUserGroupPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserGroupPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserGroupPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserGroupPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_group_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_to_one_linkage.py new file mode 100644 index 000000000..bbf55ff29 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_group_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_user_group_linkage import JsonApiUserGroupLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIUSERGROUPTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiUserGroupLinkage"] + +class JsonApiUserGroupToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiUserGroupLinkage + oneof_schema_1_validator: Optional[JsonApiUserGroupLinkage] = None + actual_instance: Optional[Union[JsonApiUserGroupLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiUserGroupLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiUserGroupToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiUserGroupLinkage + if not isinstance(v, JsonApiUserGroupLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserGroupLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiUserGroupToOneLinkage with oneOf schemas: JsonApiUserGroupLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiUserGroupToOneLinkage with oneOf schemas: JsonApiUserGroupLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiUserGroupLinkage + try: + instance.actual_instance = JsonApiUserGroupLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiUserGroupToOneLinkage with oneOf schemas: JsonApiUserGroupLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiUserGroupToOneLinkage with oneOf schemas: JsonApiUserGroupLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiUserGroupLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_linkage.py new file mode 100644 index 000000000..71cb66ec7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserIdentifierLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userIdentifier']): + raise ValueError("must be one of enum values ('userIdentifier')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out.py new file mode 100644 index 000000000..74935c978 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_identifier_out_attributes import JsonApiUserIdentifierOutAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserIdentifierOut(BaseModel): + """ + JSON:API representation of userIdentifier entity. + """ # noqa: E501 + attributes: Optional[JsonApiUserIdentifierOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userIdentifier']): + raise ValueError("must be one of enum values ('userIdentifier')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserIdentifierOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_attributes.py new file mode 100644 index 000000000..9c3c019f2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_attributes.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserIdentifierOutAttributes(BaseModel): + """ + JsonApiUserIdentifierOutAttributes + """ # noqa: E501 + email: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + firstname: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + lastname: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["email", "firstname", "lastname"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "email": obj.get("email"), + "firstname": obj.get("firstname"), + "lastname": obj.get("lastname") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_document.py new file mode 100644 index 000000000..a3dfe05c2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_user_identifier_out import JsonApiUserIdentifierOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserIdentifierOutDocument(BaseModel): + """ + JsonApiUserIdentifierOutDocument + """ # noqa: E501 + data: JsonApiUserIdentifierOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserIdentifierOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_list.py new file mode 100644 index 000000000..b41b9bb39 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserIdentifierOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiUserIdentifierOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiUserIdentifierOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_with_links.py new file mode 100644 index 000000000..8b7d81523 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_identifier_out_attributes import JsonApiUserIdentifierOutAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserIdentifierOutWithLinks(BaseModel): + """ + JsonApiUserIdentifierOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiUserIdentifierOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userIdentifier']): + raise ValueError("must be one of enum values ('userIdentifier')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserIdentifierOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserIdentifierOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_to_one_linkage.py new file mode 100644 index 000000000..edb27aea8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_identifier_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_user_identifier_linkage import JsonApiUserIdentifierLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIUSERIDENTIFIERTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiUserIdentifierLinkage"] + +class JsonApiUserIdentifierToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiUserIdentifierLinkage + oneof_schema_1_validator: Optional[JsonApiUserIdentifierLinkage] = None + actual_instance: Optional[Union[JsonApiUserIdentifierLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiUserIdentifierLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiUserIdentifierToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiUserIdentifierLinkage + if not isinstance(v, JsonApiUserIdentifierLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserIdentifierLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiUserIdentifierToOneLinkage with oneOf schemas: JsonApiUserIdentifierLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiUserIdentifierToOneLinkage with oneOf schemas: JsonApiUserIdentifierLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiUserIdentifierLinkage + try: + instance.actual_instance = JsonApiUserIdentifierLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiUserIdentifierToOneLinkage with oneOf schemas: JsonApiUserIdentifierLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiUserIdentifierToOneLinkage with oneOf schemas: JsonApiUserIdentifierLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiUserIdentifierLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_in.py new file mode 100644 index 000000000..c44d969d5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_in.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_in_attributes import JsonApiUserInAttributes +from gooddata_api_client.models.json_api_user_in_relationships import JsonApiUserInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserIn(BaseModel): + """ + JSON:API representation of user entity. + """ # noqa: E501 + attributes: Optional[JsonApiUserInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiUserInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['user']): + raise ValueError("must be one of enum values ('user')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiUserInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_in_attributes.py new file mode 100644 index 000000000..32e9a2822 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_in_attributes.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserInAttributes(BaseModel): + """ + JsonApiUserInAttributes + """ # noqa: E501 + authentication_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="authenticationId") + email: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + firstname: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + lastname: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["authenticationId", "email", "firstname", "lastname"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "authenticationId": obj.get("authenticationId"), + "email": obj.get("email"), + "firstname": obj.get("firstname"), + "lastname": obj.get("lastname") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_in_document.py new file mode 100644 index 000000000..f1349ece2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_user_in import JsonApiUserIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserInDocument(BaseModel): + """ + JsonApiUserInDocument + """ # noqa: E501 + data: JsonApiUserIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_in_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_in_relationships.py new file mode 100644 index 000000000..ef95a4387 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_in_relationships.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_user_group_in_relationships_parents import JsonApiUserGroupInRelationshipsParents +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserInRelationships(BaseModel): + """ + JsonApiUserInRelationships + """ # noqa: E501 + user_groups: Optional[JsonApiUserGroupInRelationshipsParents] = Field(default=None, alias="userGroups") + __properties: ClassVar[List[str]] = ["userGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserInRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user_groups + if self.user_groups: + _dict['userGroups'] = self.user_groups.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserInRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroups": JsonApiUserGroupInRelationshipsParents.from_dict(obj["userGroups"]) if obj.get("userGroups") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_linkage.py new file mode 100644 index 000000000..9a00a9ce1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['user']): + raise ValueError("must be one of enum values ('user')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_out.py new file mode 100644 index 000000000..c945b98e2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_out.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_in_attributes import JsonApiUserInAttributes +from gooddata_api_client.models.json_api_user_in_relationships import JsonApiUserInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserOut(BaseModel): + """ + JSON:API representation of user entity. + """ # noqa: E501 + attributes: Optional[JsonApiUserInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiUserInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['user']): + raise ValueError("must be one of enum values ('user')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiUserInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_out_document.py new file mode 100644 index 000000000..01cc0c3c7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.json_api_user_out import JsonApiUserOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserOutDocument(BaseModel): + """ + JsonApiUserOutDocument + """ # noqa: E501 + data: JsonApiUserOut + included: Optional[List[JsonApiUserGroupOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiUserGroupOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_out_list.py new file mode 100644 index 000000000..9ade572f6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiUserOutWithLinks] + included: Optional[List[JsonApiUserGroupOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiUserOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiUserGroupOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_out_with_links.py new file mode 100644 index 000000000..bb7ae041b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_out_with_links.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_in_attributes import JsonApiUserInAttributes +from gooddata_api_client.models.json_api_user_in_relationships import JsonApiUserInRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserOutWithLinks(BaseModel): + """ + JsonApiUserOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiUserInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiUserInRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['user']): + raise ValueError("must be one of enum values ('user')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiUserInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_patch.py new file mode 100644 index 000000000..87f071941 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_patch.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_user_in_attributes import JsonApiUserInAttributes +from gooddata_api_client.models.json_api_user_in_relationships import JsonApiUserInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserPatch(BaseModel): + """ + JSON:API representation of patching user entity. + """ # noqa: E501 + attributes: Optional[JsonApiUserInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiUserInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['user']): + raise ValueError("must be one of enum values ('user')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiUserInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiUserInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_patch_document.py new file mode 100644 index 000000000..7b5aac030 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_user_patch import JsonApiUserPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserPatchDocument(BaseModel): + """ + JsonApiUserPatchDocument + """ # noqa: E501 + data: JsonApiUserPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_in.py new file mode 100644 index 000000000..4d2db8e87 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserSettingIn(BaseModel): + """ + JSON:API representation of userSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userSetting']): + raise ValueError("must be one of enum values ('userSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserSettingIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserSettingIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_in_document.py new file mode 100644 index 000000000..18e18b2e5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_user_setting_in import JsonApiUserSettingIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserSettingInDocument(BaseModel): + """ + JsonApiUserSettingInDocument + """ # noqa: E501 + data: JsonApiUserSettingIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserSettingInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserSettingInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserSettingIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out.py new file mode 100644 index 000000000..8aec76d49 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserSettingOut(BaseModel): + """ + JSON:API representation of userSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userSetting']): + raise ValueError("must be one of enum values ('userSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserSettingOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserSettingOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out_document.py new file mode 100644 index 000000000..24da48ce3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_user_setting_out import JsonApiUserSettingOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserSettingOutDocument(BaseModel): + """ + JsonApiUserSettingOutDocument + """ # noqa: E501 + data: JsonApiUserSettingOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserSettingOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserSettingOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiUserSettingOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out_list.py new file mode 100644 index 000000000..175329b16 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_user_setting_out_with_links import JsonApiUserSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserSettingOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiUserSettingOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserSettingOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserSettingOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiUserSettingOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out_with_links.py new file mode 100644 index 000000000..a4a8890b0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_setting_out_with_links.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiUserSettingOutWithLinks(BaseModel): + """ + JsonApiUserSettingOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['userSetting']): + raise ValueError("must be one of enum values ('userSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiUserSettingOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiUserSettingOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_user_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_user_to_one_linkage.py new file mode 100644 index 000000000..c25dbea14 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_user_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_user_linkage import JsonApiUserLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIUSERTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiUserLinkage"] + +class JsonApiUserToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiUserLinkage + oneof_schema_1_validator: Optional[JsonApiUserLinkage] = None + actual_instance: Optional[Union[JsonApiUserLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiUserLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiUserToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiUserLinkage + if not isinstance(v, JsonApiUserLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiUserToOneLinkage with oneOf schemas: JsonApiUserLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiUserToOneLinkage with oneOf schemas: JsonApiUserLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiUserLinkage + try: + instance.actual_instance = JsonApiUserLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiUserToOneLinkage with oneOf schemas: JsonApiUserLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiUserToOneLinkage with oneOf schemas: JsonApiUserLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiUserLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_in.py new file mode 100644 index 000000000..d3ceb7d45 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_visualization_object_in_attributes import JsonApiVisualizationObjectInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectIn(BaseModel): + """ + JSON:API representation of visualizationObject entity. + """ # noqa: E501 + attributes: JsonApiVisualizationObjectInAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['visualizationObject']): + raise ValueError("must be one of enum values ('visualizationObject')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiVisualizationObjectInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_in_attributes.py new file mode 100644 index 000000000..d44671787 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_in_attributes.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectInAttributes(BaseModel): + """ + JsonApiVisualizationObjectInAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Dict[str, Any] = Field(description="Free-form JSON content. Maximum supported length is 250000 characters.") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + is_hidden: Optional[StrictBool] = Field(default=None, alias="isHidden") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "description", "isHidden", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "description": obj.get("description"), + "isHidden": obj.get("isHidden"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_in_document.py new file mode 100644 index 000000000..7e548e585 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_visualization_object_in import JsonApiVisualizationObjectIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectInDocument(BaseModel): + """ + JsonApiVisualizationObjectInDocument + """ # noqa: E501 + data: JsonApiVisualizationObjectIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiVisualizationObjectIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_linkage.py new file mode 100644 index 000000000..2bc1cc17c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['visualizationObject']): + raise ValueError("must be one of enum values ('visualizationObject')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out.py new file mode 100644 index 000000000..1a69a4843 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_metric_out_relationships import JsonApiMetricOutRelationships +from gooddata_api_client.models.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectOut(BaseModel): + """ + JSON:API representation of visualizationObject entity. + """ # noqa: E501 + attributes: JsonApiVisualizationObjectOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiMetricOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['visualizationObject']): + raise ValueError("must be one of enum values ('visualizationObject')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiVisualizationObjectOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiMetricOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_attributes.py new file mode 100644 index 000000000..3ab330f36 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_attributes.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectOutAttributes(BaseModel): + """ + JsonApiVisualizationObjectOutAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Dict[str, Any] = Field(description="Free-form JSON content. Maximum supported length is 250000 characters.") + created_at: Optional[datetime] = Field(default=None, alias="createdAt") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + is_hidden: Optional[StrictBool] = Field(default=None, alias="isHidden") + modified_at: Optional[datetime] = Field(default=None, alias="modifiedAt") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "createdAt", "description", "isHidden", "modifiedAt", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectOutAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectOutAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "createdAt": obj.get("createdAt"), + "description": obj.get("description"), + "isHidden": obj.get("isHidden"), + "modifiedAt": obj.get("modifiedAt"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_document.py new file mode 100644 index 000000000..60360045a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_metric_out_includes import JsonApiMetricOutIncludes +from gooddata_api_client.models.json_api_visualization_object_out import JsonApiVisualizationObjectOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectOutDocument(BaseModel): + """ + JsonApiVisualizationObjectOutDocument + """ # noqa: E501 + data: JsonApiVisualizationObjectOut + included: Optional[List[JsonApiMetricOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiVisualizationObjectOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiMetricOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_list.py new file mode 100644 index 000000000..e8401b97c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_metric_out_includes import JsonApiMetricOutIncludes +from gooddata_api_client.models.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiVisualizationObjectOutWithLinks] + included: Optional[List[JsonApiMetricOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiVisualizationObjectOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiMetricOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_with_links.py new file mode 100644 index 000000000..0a00eb991 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_metric_out_relationships import JsonApiMetricOutRelationships +from gooddata_api_client.models.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectOutWithLinks(BaseModel): + """ + JsonApiVisualizationObjectOutWithLinks + """ # noqa: E501 + attributes: JsonApiVisualizationObjectOutAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiMetricOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['visualizationObject']): + raise ValueError("must be one of enum values ('visualizationObject')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiVisualizationObjectOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiMetricOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_patch.py new file mode 100644 index 000000000..e606e7d05 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_visualization_object_patch_attributes import JsonApiVisualizationObjectPatchAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectPatch(BaseModel): + """ + JSON:API representation of patching visualizationObject entity. + """ # noqa: E501 + attributes: JsonApiVisualizationObjectPatchAttributes + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['visualizationObject']): + raise ValueError("must be one of enum values ('visualizationObject')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiVisualizationObjectPatchAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_patch_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_patch_attributes.py new file mode 100644 index 000000000..5e3396754 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_patch_attributes.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectPatchAttributes(BaseModel): + """ + JsonApiVisualizationObjectPatchAttributes + """ # noqa: E501 + are_relations_valid: Optional[StrictBool] = Field(default=None, alias="areRelationsValid") + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON content. Maximum supported length is 250000 characters.") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + is_hidden: Optional[StrictBool] = Field(default=None, alias="isHidden") + tags: Optional[List[StrictStr]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["areRelationsValid", "content", "description", "isHidden", "tags", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectPatchAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectPatchAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "areRelationsValid": obj.get("areRelationsValid"), + "content": obj.get("content"), + "description": obj.get("description"), + "isHidden": obj.get("isHidden"), + "tags": obj.get("tags"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_patch_document.py new file mode 100644 index 000000000..5ccb7b6eb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_visualization_object_patch import JsonApiVisualizationObjectPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectPatchDocument(BaseModel): + """ + JsonApiVisualizationObjectPatchDocument + """ # noqa: E501 + data: JsonApiVisualizationObjectPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiVisualizationObjectPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_post_optional_id.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_post_optional_id.py new file mode 100644 index 000000000..67f74b2a9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_post_optional_id.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_visualization_object_in_attributes import JsonApiVisualizationObjectInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectPostOptionalId(BaseModel): + """ + JSON:API representation of visualizationObject entity. + """ # noqa: E501 + attributes: JsonApiVisualizationObjectInAttributes + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['visualizationObject']): + raise ValueError("must be one of enum values ('visualizationObject')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectPostOptionalId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectPostOptionalId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiVisualizationObjectInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_post_optional_id_document.py new file mode 100644 index 000000000..600e46958 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_post_optional_id_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_visualization_object_post_optional_id import JsonApiVisualizationObjectPostOptionalId +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiVisualizationObjectPostOptionalIdDocument(BaseModel): + """ + JsonApiVisualizationObjectPostOptionalIdDocument + """ # noqa: E501 + data: JsonApiVisualizationObjectPostOptionalId + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectPostOptionalIdDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiVisualizationObjectPostOptionalIdDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiVisualizationObjectPostOptionalId.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_to_one_linkage.py new file mode 100644 index 000000000..c8fcd3d80 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_visualization_object_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIVISUALIZATIONOBJECTTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiVisualizationObjectLinkage"] + +class JsonApiVisualizationObjectToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiVisualizationObjectLinkage + oneof_schema_1_validator: Optional[JsonApiVisualizationObjectLinkage] = None + actual_instance: Optional[Union[JsonApiVisualizationObjectLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiVisualizationObjectLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiVisualizationObjectToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiVisualizationObjectLinkage + if not isinstance(v, JsonApiVisualizationObjectLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiVisualizationObjectLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiVisualizationObjectToOneLinkage with oneOf schemas: JsonApiVisualizationObjectLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiVisualizationObjectToOneLinkage with oneOf schemas: JsonApiVisualizationObjectLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiVisualizationObjectLinkage + try: + instance.actual_instance = JsonApiVisualizationObjectLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiVisualizationObjectToOneLinkage with oneOf schemas: JsonApiVisualizationObjectLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiVisualizationObjectToOneLinkage with oneOf schemas: JsonApiVisualizationObjectLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiVisualizationObjectLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out.py new file mode 100644 index 000000000..6fea81be7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_automation_out_attributes import JsonApiAutomationOutAttributes +from gooddata_api_client.models.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceAutomationOut(BaseModel): + """ + JSON:API representation of workspaceAutomation entity. + """ # noqa: E501 + attributes: Optional[JsonApiAutomationOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiWorkspaceAutomationOutRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceAutomation']): + raise ValueError("must be one of enum values ('workspaceAutomation')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceAutomationOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceAutomationOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAutomationOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiWorkspaceAutomationOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_includes.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_includes.py new file mode 100644 index 000000000..76afa91ef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_includes.py @@ -0,0 +1,208 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.models.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks +from gooddata_api_client.models.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks +from gooddata_api_client.models.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks +from gooddata_api_client.models.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.models.json_api_user_out_with_links import JsonApiUserOutWithLinks +from gooddata_api_client.models.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIWORKSPACEAUTOMATIONOUTINCLUDES_ONE_OF_SCHEMAS = ["JsonApiAnalyticalDashboardOutWithLinks", "JsonApiAutomationResultOutWithLinks", "JsonApiExportDefinitionOutWithLinks", "JsonApiNotificationChannelOutWithLinks", "JsonApiUserIdentifierOutWithLinks", "JsonApiUserOutWithLinks", "JsonApiWorkspaceOutWithLinks"] + +class JsonApiWorkspaceAutomationOutIncludes(BaseModel): + """ + JsonApiWorkspaceAutomationOutIncludes + """ + # data type: JsonApiWorkspaceOutWithLinks + oneof_schema_1_validator: Optional[JsonApiWorkspaceOutWithLinks] = None + # data type: JsonApiNotificationChannelOutWithLinks + oneof_schema_2_validator: Optional[JsonApiNotificationChannelOutWithLinks] = None + # data type: JsonApiAnalyticalDashboardOutWithLinks + oneof_schema_3_validator: Optional[JsonApiAnalyticalDashboardOutWithLinks] = None + # data type: JsonApiUserIdentifierOutWithLinks + oneof_schema_4_validator: Optional[JsonApiUserIdentifierOutWithLinks] = None + # data type: JsonApiExportDefinitionOutWithLinks + oneof_schema_5_validator: Optional[JsonApiExportDefinitionOutWithLinks] = None + # data type: JsonApiUserOutWithLinks + oneof_schema_6_validator: Optional[JsonApiUserOutWithLinks] = None + # data type: JsonApiAutomationResultOutWithLinks + oneof_schema_7_validator: Optional[JsonApiAutomationResultOutWithLinks] = None + actual_instance: Optional[Union[JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks, JsonApiWorkspaceOutWithLinks]] = None + one_of_schemas: Set[str] = { "JsonApiAnalyticalDashboardOutWithLinks", "JsonApiAutomationResultOutWithLinks", "JsonApiExportDefinitionOutWithLinks", "JsonApiNotificationChannelOutWithLinks", "JsonApiUserIdentifierOutWithLinks", "JsonApiUserOutWithLinks", "JsonApiWorkspaceOutWithLinks" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = JsonApiWorkspaceAutomationOutIncludes.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiWorkspaceOutWithLinks + if not isinstance(v, JsonApiWorkspaceOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiWorkspaceOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiNotificationChannelOutWithLinks + if not isinstance(v, JsonApiNotificationChannelOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiNotificationChannelOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAnalyticalDashboardOutWithLinks + if not isinstance(v, JsonApiAnalyticalDashboardOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAnalyticalDashboardOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiUserIdentifierOutWithLinks + if not isinstance(v, JsonApiUserIdentifierOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserIdentifierOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiExportDefinitionOutWithLinks + if not isinstance(v, JsonApiExportDefinitionOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiExportDefinitionOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiUserOutWithLinks + if not isinstance(v, JsonApiUserOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiUserOutWithLinks`") + else: + match += 1 + # validate data type: JsonApiAutomationResultOutWithLinks + if not isinstance(v, JsonApiAutomationResultOutWithLinks): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiAutomationResultOutWithLinks`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiWorkspaceAutomationOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks, JsonApiWorkspaceOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiWorkspaceAutomationOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks, JsonApiWorkspaceOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into JsonApiWorkspaceOutWithLinks + try: + instance.actual_instance = JsonApiWorkspaceOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiNotificationChannelOutWithLinks + try: + instance.actual_instance = JsonApiNotificationChannelOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAnalyticalDashboardOutWithLinks + try: + instance.actual_instance = JsonApiAnalyticalDashboardOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiUserIdentifierOutWithLinks + try: + instance.actual_instance = JsonApiUserIdentifierOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiExportDefinitionOutWithLinks + try: + instance.actual_instance = JsonApiExportDefinitionOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiUserOutWithLinks + try: + instance.actual_instance = JsonApiUserOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into JsonApiAutomationResultOutWithLinks + try: + instance.actual_instance = JsonApiAutomationResultOutWithLinks.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiWorkspaceAutomationOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks, JsonApiWorkspaceOutWithLinks. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiWorkspaceAutomationOutIncludes with oneOf schemas: JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks, JsonApiWorkspaceOutWithLinks. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiAnalyticalDashboardOutWithLinks, JsonApiAutomationResultOutWithLinks, JsonApiExportDefinitionOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks, JsonApiWorkspaceOutWithLinks]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_list.py new file mode 100644 index 000000000..b981f5a92 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_workspace_automation_out_includes import JsonApiWorkspaceAutomationOutIncludes +from gooddata_api_client.models.json_api_workspace_automation_out_with_links import JsonApiWorkspaceAutomationOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceAutomationOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiWorkspaceAutomationOutWithLinks] + included: Optional[List[JsonApiWorkspaceAutomationOutIncludes]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceAutomationOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceAutomationOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiWorkspaceAutomationOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiWorkspaceAutomationOutIncludes.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_relationships.py new file mode 100644 index 000000000..01d0ae97b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_relationships.py @@ -0,0 +1,133 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy +from gooddata_api_client.models.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard +from gooddata_api_client.models.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions +from gooddata_api_client.models.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel +from gooddata_api_client.models.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients +from gooddata_api_client.models.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults +from gooddata_api_client.models.json_api_workspace_automation_out_relationships_workspace import JsonApiWorkspaceAutomationOutRelationshipsWorkspace +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceAutomationOutRelationships(BaseModel): + """ + JsonApiWorkspaceAutomationOutRelationships + """ # noqa: E501 + analytical_dashboard: Optional[JsonApiAutomationInRelationshipsAnalyticalDashboard] = Field(default=None, alias="analyticalDashboard") + automation_results: Optional[JsonApiAutomationOutRelationshipsAutomationResults] = Field(default=None, alias="automationResults") + created_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="createdBy") + export_definitions: Optional[JsonApiAutomationInRelationshipsExportDefinitions] = Field(default=None, alias="exportDefinitions") + modified_by: Optional[JsonApiAnalyticalDashboardOutRelationshipsCreatedBy] = Field(default=None, alias="modifiedBy") + notification_channel: Optional[JsonApiAutomationInRelationshipsNotificationChannel] = Field(default=None, alias="notificationChannel") + recipients: Optional[JsonApiAutomationInRelationshipsRecipients] = None + workspace: Optional[JsonApiWorkspaceAutomationOutRelationshipsWorkspace] = None + __properties: ClassVar[List[str]] = ["analyticalDashboard", "automationResults", "createdBy", "exportDefinitions", "modifiedBy", "notificationChannel", "recipients", "workspace"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceAutomationOutRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of analytical_dashboard + if self.analytical_dashboard: + _dict['analyticalDashboard'] = self.analytical_dashboard.to_dict() + # override the default output from pydantic by calling `to_dict()` of automation_results + if self.automation_results: + _dict['automationResults'] = self.automation_results.to_dict() + # override the default output from pydantic by calling `to_dict()` of created_by + if self.created_by: + _dict['createdBy'] = self.created_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of export_definitions + if self.export_definitions: + _dict['exportDefinitions'] = self.export_definitions.to_dict() + # override the default output from pydantic by calling `to_dict()` of modified_by + if self.modified_by: + _dict['modifiedBy'] = self.modified_by.to_dict() + # override the default output from pydantic by calling `to_dict()` of notification_channel + if self.notification_channel: + _dict['notificationChannel'] = self.notification_channel.to_dict() + # override the default output from pydantic by calling `to_dict()` of recipients + if self.recipients: + _dict['recipients'] = self.recipients.to_dict() + # override the default output from pydantic by calling `to_dict()` of workspace + if self.workspace: + _dict['workspace'] = self.workspace.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceAutomationOutRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticalDashboard": JsonApiAutomationInRelationshipsAnalyticalDashboard.from_dict(obj["analyticalDashboard"]) if obj.get("analyticalDashboard") is not None else None, + "automationResults": JsonApiAutomationOutRelationshipsAutomationResults.from_dict(obj["automationResults"]) if obj.get("automationResults") is not None else None, + "createdBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, + "exportDefinitions": JsonApiAutomationInRelationshipsExportDefinitions.from_dict(obj["exportDefinitions"]) if obj.get("exportDefinitions") is not None else None, + "modifiedBy": JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None, + "notificationChannel": JsonApiAutomationInRelationshipsNotificationChannel.from_dict(obj["notificationChannel"]) if obj.get("notificationChannel") is not None else None, + "recipients": JsonApiAutomationInRelationshipsRecipients.from_dict(obj["recipients"]) if obj.get("recipients") is not None else None, + "workspace": JsonApiWorkspaceAutomationOutRelationshipsWorkspace.from_dict(obj["workspace"]) if obj.get("workspace") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_relationships_workspace.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_relationships_workspace.py new file mode 100644 index 000000000..71fe092ba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_relationships_workspace.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceAutomationOutRelationshipsWorkspace(BaseModel): + """ + JsonApiWorkspaceAutomationOutRelationshipsWorkspace + """ # noqa: E501 + data: Optional[JsonApiWorkspaceToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceAutomationOutRelationshipsWorkspace from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceAutomationOutRelationshipsWorkspace from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_with_links.py new file mode 100644 index 000000000..8e6bf5c5f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_automation_out_with_links.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_automation_out_attributes import JsonApiAutomationOutAttributes +from gooddata_api_client.models.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceAutomationOutWithLinks(BaseModel): + """ + JsonApiWorkspaceAutomationOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiAutomationOutAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiWorkspaceAutomationOutRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceAutomation']): + raise ValueError("must be one of enum values ('workspaceAutomation')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceAutomationOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceAutomationOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiAutomationOutAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiWorkspaceAutomationOutRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in.py new file mode 100644 index 000000000..e027a6878 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterIn(BaseModel): + """ + JSON:API representation of workspaceDataFilter entity. + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceDataFilterInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiWorkspaceDataFilterInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceDataFilter']): + raise ValueError("must be one of enum values ('workspaceDataFilter')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceDataFilterInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiWorkspaceDataFilterInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_attributes.py new file mode 100644 index 000000000..7d8e64436 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_attributes.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterInAttributes(BaseModel): + """ + JsonApiWorkspaceDataFilterInAttributes + """ # noqa: E501 + column_name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, alias="columnName") + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["columnName", "description", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columnName": obj.get("columnName"), + "description": obj.get("description"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_document.py new file mode 100644 index 000000000..f2d94c5fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_workspace_data_filter_in import JsonApiWorkspaceDataFilterIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterInDocument(BaseModel): + """ + JsonApiWorkspaceDataFilterInDocument + """ # noqa: E501 + data: JsonApiWorkspaceDataFilterIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceDataFilterIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_relationships.py new file mode 100644 index 000000000..910ba58d3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_relationships.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_workspace_data_filter_in_relationships_filter_settings import JsonApiWorkspaceDataFilterInRelationshipsFilterSettings +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterInRelationships(BaseModel): + """ + JsonApiWorkspaceDataFilterInRelationships + """ # noqa: E501 + filter_settings: Optional[JsonApiWorkspaceDataFilterInRelationshipsFilterSettings] = Field(default=None, alias="filterSettings") + __properties: ClassVar[List[str]] = ["filterSettings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterInRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of filter_settings + if self.filter_settings: + _dict['filterSettings'] = self.filter_settings.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterInRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "filterSettings": JsonApiWorkspaceDataFilterInRelationshipsFilterSettings.from_dict(obj["filterSettings"]) if obj.get("filterSettings") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_relationships_filter_settings.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_relationships_filter_settings.py new file mode 100644 index 000000000..ad8023518 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_in_relationships_filter_settings.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_workspace_data_filter_setting_linkage import JsonApiWorkspaceDataFilterSettingLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterInRelationshipsFilterSettings(BaseModel): + """ + JsonApiWorkspaceDataFilterInRelationshipsFilterSettings + """ # noqa: E501 + data: List[JsonApiWorkspaceDataFilterSettingLinkage] = Field(description="References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.") + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterInRelationshipsFilterSettings from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterInRelationshipsFilterSettings from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiWorkspaceDataFilterSettingLinkage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_linkage.py new file mode 100644 index 000000000..93d7dda0e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceDataFilter']): + raise ValueError("must be one of enum values ('workspaceDataFilter')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out.py new file mode 100644 index 000000000..7b2f3b6ab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterOut(BaseModel): + """ + JSON:API representation of workspaceDataFilter entity. + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceDataFilterInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiWorkspaceDataFilterInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceDataFilter']): + raise ValueError("must be one of enum values ('workspaceDataFilter')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceDataFilterInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiWorkspaceDataFilterInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out_document.py new file mode 100644 index 000000000..0a9728fe3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterOutDocument(BaseModel): + """ + JsonApiWorkspaceDataFilterOutDocument + """ # noqa: E501 + data: JsonApiWorkspaceDataFilterOut + included: Optional[List[JsonApiWorkspaceDataFilterSettingOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceDataFilterOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiWorkspaceDataFilterSettingOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out_list.py new file mode 100644 index 000000000..3b2f5d115 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiWorkspaceDataFilterOutWithLinks] + included: Optional[List[JsonApiWorkspaceDataFilterSettingOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiWorkspaceDataFilterOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiWorkspaceDataFilterSettingOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out_with_links.py new file mode 100644 index 000000000..46aeac16a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterOutWithLinks(BaseModel): + """ + JsonApiWorkspaceDataFilterOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceDataFilterInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiWorkspaceDataFilterInRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceDataFilter']): + raise ValueError("must be one of enum values ('workspaceDataFilter')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceDataFilterInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiWorkspaceDataFilterInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_patch.py new file mode 100644 index 000000000..a2087b958 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_patch.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_in_relationships import JsonApiWorkspaceDataFilterInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterPatch(BaseModel): + """ + JSON:API representation of patching workspaceDataFilter entity. + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceDataFilterInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiWorkspaceDataFilterInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceDataFilter']): + raise ValueError("must be one of enum values ('workspaceDataFilter')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceDataFilterInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiWorkspaceDataFilterInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_patch_document.py new file mode 100644 index 000000000..1bdde7794 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_workspace_data_filter_patch import JsonApiWorkspaceDataFilterPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterPatchDocument(BaseModel): + """ + JsonApiWorkspaceDataFilterPatchDocument + """ # noqa: E501 + data: JsonApiWorkspaceDataFilterPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceDataFilterPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in.py new file mode 100644 index 000000000..6005042d4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingIn(BaseModel): + """ + JSON:API representation of workspaceDataFilterSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceDataFilterSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiWorkspaceDataFilterSettingInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceDataFilterSetting']): + raise ValueError("must be one of enum values ('workspaceDataFilterSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceDataFilterSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiWorkspaceDataFilterSettingInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_attributes.py new file mode 100644 index 000000000..f0f8b5871 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_attributes.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingInAttributes(BaseModel): + """ + JsonApiWorkspaceDataFilterSettingInAttributes + """ # noqa: E501 + description: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = None + filter_values: Optional[List[StrictStr]] = Field(default=None, alias="filterValues") + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + __properties: ClassVar[List[str]] = ["description", "filterValues", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "filterValues": obj.get("filterValues"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_document.py new file mode 100644 index 000000000..85a723a8e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in import JsonApiWorkspaceDataFilterSettingIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingInDocument(BaseModel): + """ + JsonApiWorkspaceDataFilterSettingInDocument + """ # noqa: E501 + data: JsonApiWorkspaceDataFilterSettingIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceDataFilterSettingIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_relationships.py new file mode 100644 index 000000000..2176d6889 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_relationships.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter import JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingInRelationships(BaseModel): + """ + JsonApiWorkspaceDataFilterSettingInRelationships + """ # noqa: E501 + workspace_data_filter: Optional[JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter] = Field(default=None, alias="workspaceDataFilter") + __properties: ClassVar[List[str]] = ["workspaceDataFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingInRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of workspace_data_filter + if self.workspace_data_filter: + _dict['workspaceDataFilter'] = self.workspace_data_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingInRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "workspaceDataFilter": JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter.from_dict(obj["workspaceDataFilter"]) if obj.get("workspaceDataFilter") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter.py new file mode 100644 index 000000000..2b6fbf948 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_in_relationships_workspace_data_filter.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_workspace_data_filter_to_one_linkage import JsonApiWorkspaceDataFilterToOneLinkage +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter(BaseModel): + """ + JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter + """ # noqa: E501 + data: Optional[JsonApiWorkspaceDataFilterToOneLinkage] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceDataFilterToOneLinkage.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_linkage.py new file mode 100644 index 000000000..327af3842 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceDataFilterSetting']): + raise ValueError("must be one of enum values ('workspaceDataFilterSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out.py new file mode 100644 index 000000000..b6d4dd556 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingOut(BaseModel): + """ + JSON:API representation of workspaceDataFilterSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceDataFilterSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiWorkspaceDataFilterSettingInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceDataFilterSetting']): + raise ValueError("must be one of enum values ('workspaceDataFilterSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceDataFilterSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiWorkspaceDataFilterSettingInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out_document.py new file mode 100644 index 000000000..62364c61f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingOutDocument(BaseModel): + """ + JsonApiWorkspaceDataFilterSettingOutDocument + """ # noqa: E501 + data: JsonApiWorkspaceDataFilterSettingOut + included: Optional[List[JsonApiWorkspaceDataFilterOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceDataFilterSettingOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiWorkspaceDataFilterOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out_list.py new file mode 100644 index 000000000..0d7c6bc70 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out_list.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiWorkspaceDataFilterSettingOutWithLinks] + included: Optional[List[JsonApiWorkspaceDataFilterOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiWorkspaceDataFilterSettingOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiWorkspaceDataFilterOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out_with_links.py new file mode 100644 index 000000000..ad989570a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingOutWithLinks(BaseModel): + """ + JsonApiWorkspaceDataFilterSettingOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceDataFilterSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + relationships: Optional[JsonApiWorkspaceDataFilterSettingInRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceDataFilterSetting']): + raise ValueError("must be one of enum values ('workspaceDataFilterSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceDataFilterSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiWorkspaceDataFilterSettingInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_patch.py new file mode 100644 index 000000000..85f6be2e2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_patch.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_attributes import JsonApiWorkspaceDataFilterSettingInAttributes +from gooddata_api_client.models.json_api_workspace_data_filter_setting_in_relationships import JsonApiWorkspaceDataFilterSettingInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingPatch(BaseModel): + """ + JSON:API representation of patching workspaceDataFilterSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceDataFilterSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiWorkspaceDataFilterSettingInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceDataFilterSetting']): + raise ValueError("must be one of enum values ('workspaceDataFilterSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceDataFilterSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiWorkspaceDataFilterSettingInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_patch_document.py new file mode 100644 index 000000000..41623b6d5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_setting_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_workspace_data_filter_setting_patch import JsonApiWorkspaceDataFilterSettingPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceDataFilterSettingPatchDocument(BaseModel): + """ + JsonApiWorkspaceDataFilterSettingPatchDocument + """ # noqa: E501 + data: JsonApiWorkspaceDataFilterSettingPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceDataFilterSettingPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceDataFilterSettingPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_to_one_linkage.py new file mode 100644 index 000000000..7b00d81c6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_data_filter_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_workspace_data_filter_linkage import JsonApiWorkspaceDataFilterLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIWORKSPACEDATAFILTERTOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiWorkspaceDataFilterLinkage"] + +class JsonApiWorkspaceDataFilterToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiWorkspaceDataFilterLinkage + oneof_schema_1_validator: Optional[JsonApiWorkspaceDataFilterLinkage] = None + actual_instance: Optional[Union[JsonApiWorkspaceDataFilterLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiWorkspaceDataFilterLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiWorkspaceDataFilterToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiWorkspaceDataFilterLinkage + if not isinstance(v, JsonApiWorkspaceDataFilterLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiWorkspaceDataFilterLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiWorkspaceDataFilterToOneLinkage with oneOf schemas: JsonApiWorkspaceDataFilterLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiWorkspaceDataFilterToOneLinkage with oneOf schemas: JsonApiWorkspaceDataFilterLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiWorkspaceDataFilterLinkage + try: + instance.actual_instance = JsonApiWorkspaceDataFilterLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiWorkspaceDataFilterToOneLinkage with oneOf schemas: JsonApiWorkspaceDataFilterLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiWorkspaceDataFilterToOneLinkage with oneOf schemas: JsonApiWorkspaceDataFilterLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiWorkspaceDataFilterLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in.py new file mode 100644 index 000000000..87f4b9c31 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes +from gooddata_api_client.models.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceIn(BaseModel): + """ + JSON:API representation of workspace entity. + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiWorkspaceInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspace']): + raise ValueError("must be one of enum values ('workspace')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiWorkspaceInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_attributes.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_attributes.py new file mode 100644 index 000000000..ebc7f93de --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_attributes.py @@ -0,0 +1,140 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_workspace_in_attributes_data_source import JsonApiWorkspaceInAttributesDataSource +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceInAttributes(BaseModel): + """ + JsonApiWorkspaceInAttributes + """ # noqa: E501 + cache_extra_limit: Optional[StrictInt] = Field(default=None, alias="cacheExtraLimit") + data_source: Optional[JsonApiWorkspaceInAttributesDataSource] = Field(default=None, alias="dataSource") + description: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + early_access: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", alias="earlyAccess") + early_access_values: Optional[List[Annotated[str, Field(strict=True, max_length=255)]]] = Field(default=None, description="The early access feature identifiers. They are used to enable experimental features.", alias="earlyAccessValues") + name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + prefix: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Custom prefix of entity identifiers in workspace") + __properties: ClassVar[List[str]] = ["cacheExtraLimit", "dataSource", "description", "earlyAccess", "earlyAccessValues", "name", "prefix"] + + @field_validator('prefix') + def prefix_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceInAttributes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data_source + if self.data_source: + _dict['dataSource'] = self.data_source.to_dict() + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if early_access (nullable) is None + # and model_fields_set contains the field + if self.early_access is None and "early_access" in self.model_fields_set: + _dict['earlyAccess'] = None + + # set to None if early_access_values (nullable) is None + # and model_fields_set contains the field + if self.early_access_values is None and "early_access_values" in self.model_fields_set: + _dict['earlyAccessValues'] = None + + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + # set to None if prefix (nullable) is None + # and model_fields_set contains the field + if self.prefix is None and "prefix" in self.model_fields_set: + _dict['prefix'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceInAttributes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cacheExtraLimit": obj.get("cacheExtraLimit"), + "dataSource": JsonApiWorkspaceInAttributesDataSource.from_dict(obj["dataSource"]) if obj.get("dataSource") is not None else None, + "description": obj.get("description"), + "earlyAccess": obj.get("earlyAccess"), + "earlyAccessValues": obj.get("earlyAccessValues"), + "name": obj.get("name"), + "prefix": obj.get("prefix") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_attributes_data_source.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_attributes_data_source.py new file mode 100644 index 000000000..c96d368e5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_attributes_data_source.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceInAttributesDataSource(BaseModel): + """ + The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace. + """ # noqa: E501 + id: StrictStr = Field(description="The ID of the used data source.") + schema_path: Optional[List[StrictStr]] = Field(default=None, description="The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", alias="schemaPath") + __properties: ClassVar[List[str]] = ["id", "schemaPath"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceInAttributesDataSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceInAttributesDataSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "schemaPath": obj.get("schemaPath") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_document.py new file mode 100644 index 000000000..4f212d49e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_workspace_in import JsonApiWorkspaceIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceInDocument(BaseModel): + """ + JsonApiWorkspaceInDocument + """ # noqa: E501 + data: JsonApiWorkspaceIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_relationships.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_relationships.py new file mode 100644 index 000000000..7e5a97649 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_in_relationships.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_workspace_automation_out_relationships_workspace import JsonApiWorkspaceAutomationOutRelationshipsWorkspace +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceInRelationships(BaseModel): + """ + JsonApiWorkspaceInRelationships + """ # noqa: E501 + parent: Optional[JsonApiWorkspaceAutomationOutRelationshipsWorkspace] = None + __properties: ClassVar[List[str]] = ["parent"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceInRelationships from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of parent + if self.parent: + _dict['parent'] = self.parent.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceInRelationships from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "parent": JsonApiWorkspaceAutomationOutRelationshipsWorkspace.from_dict(obj["parent"]) if obj.get("parent") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_linkage.py new file mode 100644 index 000000000..e0da727a5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_linkage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceLinkage(BaseModel): + """ + The \\\"type\\\" and \\\"id\\\" to non-empty members. + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspace']): + raise ValueError("must be one of enum values ('workspace')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceLinkage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceLinkage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out.py new file mode 100644 index 000000000..715c4a77f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes +from gooddata_api_client.models.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships +from gooddata_api_client.models.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceOut(BaseModel): + """ + JSON:API representation of workspace entity. + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiWorkspaceOutMeta] = None + relationships: Optional[JsonApiWorkspaceInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspace']): + raise ValueError("must be one of enum values ('workspace')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiWorkspaceOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiWorkspaceInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_document.py new file mode 100644 index 000000000..c9a096933 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_document.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_workspace_out import JsonApiWorkspaceOut +from gooddata_api_client.models.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceOutDocument(BaseModel): + """ + JsonApiWorkspaceOutDocument + """ # noqa: E501 + data: JsonApiWorkspaceOut + included: Optional[List[JsonApiWorkspaceOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "included", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "included": [JsonApiWorkspaceOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_list.py new file mode 100644 index 000000000..98e1b9d2d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_list.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiWorkspaceOutWithLinks] + included: Optional[List[JsonApiWorkspaceOutWithLinks]] = Field(default=None, description="Included resources") + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "included", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiWorkspaceOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "included": [JsonApiWorkspaceOutWithLinks.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta.py new file mode 100644 index 000000000..e0cb19fc8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_workspace_out_meta_config import JsonApiWorkspaceOutMetaConfig +from gooddata_api_client.models.json_api_workspace_out_meta_data_model import JsonApiWorkspaceOutMetaDataModel +from gooddata_api_client.models.json_api_workspace_out_meta_hierarchy import JsonApiWorkspaceOutMetaHierarchy +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceOutMeta(BaseModel): + """ + JsonApiWorkspaceOutMeta + """ # noqa: E501 + config: Optional[JsonApiWorkspaceOutMetaConfig] = None + data_model: Optional[JsonApiWorkspaceOutMetaDataModel] = Field(default=None, alias="dataModel") + hierarchy: Optional[JsonApiWorkspaceOutMetaHierarchy] = None + permissions: Optional[List[StrictStr]] = Field(default=None, description="List of valid permissions for a logged-in user.") + __properties: ClassVar[List[str]] = ["config", "dataModel", "hierarchy", "permissions"] + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW']): + raise ValueError("each list item must be one of ('MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutMeta from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of config + if self.config: + _dict['config'] = self.config.to_dict() + # override the default output from pydantic by calling `to_dict()` of data_model + if self.data_model: + _dict['dataModel'] = self.data_model.to_dict() + # override the default output from pydantic by calling `to_dict()` of hierarchy + if self.hierarchy: + _dict['hierarchy'] = self.hierarchy.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutMeta from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "config": JsonApiWorkspaceOutMetaConfig.from_dict(obj["config"]) if obj.get("config") is not None else None, + "dataModel": JsonApiWorkspaceOutMetaDataModel.from_dict(obj["dataModel"]) if obj.get("dataModel") is not None else None, + "hierarchy": JsonApiWorkspaceOutMetaHierarchy.from_dict(obj["hierarchy"]) if obj.get("hierarchy") is not None else None, + "permissions": obj.get("permissions") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta_config.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta_config.py new file mode 100644 index 000000000..07433563a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta_config.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceOutMetaConfig(BaseModel): + """ + JsonApiWorkspaceOutMetaConfig + """ # noqa: E501 + approximate_count_available: Optional[StrictBool] = Field(default=False, description="is approximate count enabled - based on type of data-source connected to this workspace", alias="approximateCountAvailable") + data_sampling_available: Optional[StrictBool] = Field(default=False, description="is sampling enabled - based on type of data-source connected to this workspace", alias="dataSamplingAvailable") + show_all_values_on_dates_available: Optional[StrictBool] = Field(default=False, description="is 'show all values' displayed for dates - based on type of data-source connected to this workspace", alias="showAllValuesOnDatesAvailable") + __properties: ClassVar[List[str]] = ["approximateCountAvailable", "dataSamplingAvailable", "showAllValuesOnDatesAvailable"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutMetaConfig from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutMetaConfig from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "approximateCountAvailable": obj.get("approximateCountAvailable") if obj.get("approximateCountAvailable") is not None else False, + "dataSamplingAvailable": obj.get("dataSamplingAvailable") if obj.get("dataSamplingAvailable") is not None else False, + "showAllValuesOnDatesAvailable": obj.get("showAllValuesOnDatesAvailable") if obj.get("showAllValuesOnDatesAvailable") is not None else False + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta_data_model.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta_data_model.py new file mode 100644 index 000000000..23c8045b0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta_data_model.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceOutMetaDataModel(BaseModel): + """ + JsonApiWorkspaceOutMetaDataModel + """ # noqa: E501 + dataset_count: StrictInt = Field(description="include the number of dataset of each workspace", alias="datasetCount") + __properties: ClassVar[List[str]] = ["datasetCount"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutMetaDataModel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutMetaDataModel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "datasetCount": obj.get("datasetCount") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta_hierarchy.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta_hierarchy.py new file mode 100644 index 000000000..460ce3696 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_meta_hierarchy.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceOutMetaHierarchy(BaseModel): + """ + JsonApiWorkspaceOutMetaHierarchy + """ # noqa: E501 + children_count: StrictInt = Field(description="include the number of direct children of each workspace", alias="childrenCount") + __properties: ClassVar[List[str]] = ["childrenCount"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutMetaHierarchy from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutMetaHierarchy from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "childrenCount": obj.get("childrenCount") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_with_links.py new file mode 100644 index 000000000..ef660d734 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_out_with_links.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes +from gooddata_api_client.models.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships +from gooddata_api_client.models.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceOutWithLinks(BaseModel): + """ + JsonApiWorkspaceOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiWorkspaceOutMeta] = None + relationships: Optional[JsonApiWorkspaceInRelationships] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "relationships", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspace']): + raise ValueError("must be one of enum values ('workspace')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiWorkspaceOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "relationships": JsonApiWorkspaceInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_patch.py new file mode 100644 index 000000000..5ba439f4c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_patch.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes +from gooddata_api_client.models.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspacePatch(BaseModel): + """ + JSON:API representation of patching workspace entity. + """ # noqa: E501 + attributes: Optional[JsonApiWorkspaceInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + relationships: Optional[JsonApiWorkspaceInRelationships] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "relationships", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspace']): + raise ValueError("must be one of enum values ('workspace')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspacePatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of relationships + if self.relationships: + _dict['relationships'] = self.relationships.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspacePatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiWorkspaceInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "relationships": JsonApiWorkspaceInRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_patch_document.py new file mode 100644 index 000000000..dc00bd121 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_workspace_patch import JsonApiWorkspacePatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspacePatchDocument(BaseModel): + """ + JsonApiWorkspacePatchDocument + """ # noqa: E501 + data: JsonApiWorkspacePatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspacePatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspacePatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspacePatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_in.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_in.py new file mode 100644 index 000000000..a8360b6bc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_in.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceSettingIn(BaseModel): + """ + JSON:API representation of workspaceSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceSetting']): + raise ValueError("must be one of enum values ('workspaceSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingIn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingIn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_in_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_in_document.py new file mode 100644 index 000000000..3d569b11e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_in_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_workspace_setting_in import JsonApiWorkspaceSettingIn +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceSettingInDocument(BaseModel): + """ + JsonApiWorkspaceSettingInDocument + """ # noqa: E501 + data: JsonApiWorkspaceSettingIn + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingInDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingInDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceSettingIn.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out.py new file mode 100644 index 000000000..80528838d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceSettingOut(BaseModel): + """ + JSON:API representation of workspaceSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceSetting']): + raise ValueError("must be one of enum values ('workspaceSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingOut from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingOut from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out_document.py new file mode 100644 index 000000000..8ea6be441 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out_document.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceSettingOutDocument(BaseModel): + """ + JsonApiWorkspaceSettingOutDocument + """ # noqa: E501 + data: JsonApiWorkspaceSettingOut + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["data", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingOutDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingOutDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceSettingOut.from_dict(obj["data"]) if obj.get("data") is not None else None, + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out_list.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out_list.py new file mode 100644 index 000000000..869b6fa4a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta +from gooddata_api_client.models.json_api_workspace_setting_out_with_links import JsonApiWorkspaceSettingOutWithLinks +from gooddata_api_client.models.list_links import ListLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceSettingOutList(BaseModel): + """ + A JSON:API document with a list of resources + """ # noqa: E501 + data: List[JsonApiWorkspaceSettingOutWithLinks] + links: Optional[ListLinks] = None + meta: Optional[JsonApiAggregatedFactOutListMeta] = None + __properties: ClassVar[List[str]] = ["data", "links", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingOutList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingOutList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [JsonApiWorkspaceSettingOutWithLinks.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "links": ListLinks.from_dict(obj["links"]) if obj.get("links") is not None else None, + "meta": JsonApiAggregatedFactOutListMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out_with_links.py new file mode 100644 index 000000000..c15a00a9b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_out_with_links.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceSettingOutWithLinks(BaseModel): + """ + JsonApiWorkspaceSettingOutWithLinks + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + meta: Optional[JsonApiAggregatedFactOutMeta] = None + type: StrictStr = Field(description="Object type") + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["attributes", "id", "meta", "type", "links"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceSetting']): + raise ValueError("must be one of enum values ('workspaceSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingOutWithLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingOutWithLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "meta": JsonApiAggregatedFactOutMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "type": obj.get("type"), + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_patch.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_patch.py new file mode 100644 index 000000000..8cb91ea7c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_patch.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceSettingPatch(BaseModel): + """ + JSON:API representation of patching workspaceSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Annotated[str, Field(strict=True)] = Field(description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceSetting']): + raise ValueError("must be one of enum values ('workspaceSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingPatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_patch_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_patch_document.py new file mode 100644 index 000000000..23e59a028 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_patch_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_workspace_setting_patch import JsonApiWorkspaceSettingPatch +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceSettingPatchDocument(BaseModel): + """ + JsonApiWorkspaceSettingPatchDocument + """ # noqa: E501 + data: JsonApiWorkspaceSettingPatch + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingPatchDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingPatchDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceSettingPatch.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_post_optional_id.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_post_optional_id.py new file mode 100644 index 000000000..8cf1009d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_post_optional_id.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceSettingPostOptionalId(BaseModel): + """ + JSON:API representation of workspaceSetting entity. + """ # noqa: E501 + attributes: Optional[JsonApiOrganizationSettingInAttributes] = None + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="API identifier of an object") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["attributes", "id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspaceSetting']): + raise ValueError("must be one of enum values ('workspaceSetting')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingPostOptionalId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attributes + if self.attributes: + _dict['attributes'] = self.attributes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingPostOptionalId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": JsonApiOrganizationSettingInAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None, + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_post_optional_id_document.py new file mode 100644 index 000000000..f3cfdcb2e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_setting_post_optional_id_document.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id import JsonApiWorkspaceSettingPostOptionalId +from typing import Optional, Set +from typing_extensions import Self + +class JsonApiWorkspaceSettingPostOptionalIdDocument(BaseModel): + """ + JsonApiWorkspaceSettingPostOptionalIdDocument + """ # noqa: E501 + data: JsonApiWorkspaceSettingPostOptionalId + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingPostOptionalIdDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JsonApiWorkspaceSettingPostOptionalIdDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": JsonApiWorkspaceSettingPostOptionalId.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/json_api_workspace_to_one_linkage.py b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_to_one_linkage.py new file mode 100644 index 000000000..3ddc0e43b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/json_api_workspace_to_one_linkage.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.json_api_workspace_linkage import JsonApiWorkspaceLinkage +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +JSONAPIWORKSPACETOONELINKAGE_ONE_OF_SCHEMAS = ["JsonApiWorkspaceLinkage"] + +class JsonApiWorkspaceToOneLinkage(BaseModel): + """ + References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + """ + # data type: JsonApiWorkspaceLinkage + oneof_schema_1_validator: Optional[JsonApiWorkspaceLinkage] = None + actual_instance: Optional[Union[JsonApiWorkspaceLinkage]] = None + one_of_schemas: Set[str] = { "JsonApiWorkspaceLinkage" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = JsonApiWorkspaceToOneLinkage.model_construct() + error_messages = [] + match = 0 + # validate data type: JsonApiWorkspaceLinkage + if not isinstance(v, JsonApiWorkspaceLinkage): + error_messages.append(f"Error! Input type `{type(v)}` is not `JsonApiWorkspaceLinkage`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in JsonApiWorkspaceToOneLinkage with oneOf schemas: JsonApiWorkspaceLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in JsonApiWorkspaceToOneLinkage with oneOf schemas: JsonApiWorkspaceLinkage. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into JsonApiWorkspaceLinkage + try: + instance.actual_instance = JsonApiWorkspaceLinkage.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into JsonApiWorkspaceToOneLinkage with oneOf schemas: JsonApiWorkspaceLinkage. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into JsonApiWorkspaceToOneLinkage with oneOf schemas: JsonApiWorkspaceLinkage. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], JsonApiWorkspaceLinkage]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/key_drivers_dimension.py b/gooddata-api-client/gooddata_api_client/models/key_drivers_dimension.py new file mode 100644 index 000000000..148fde929 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/key_drivers_dimension.py @@ -0,0 +1,131 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.attribute_format import AttributeFormat +from gooddata_api_client.models.rest_api_identifier import RestApiIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class KeyDriversDimension(BaseModel): + """ + KeyDriversDimension + """ # noqa: E501 + attribute: RestApiIdentifier + attribute_name: StrictStr = Field(alias="attributeName") + format: Optional[AttributeFormat] = None + granularity: Optional[StrictStr] = None + label: RestApiIdentifier + label_name: StrictStr = Field(alias="labelName") + value_type: Optional[StrictStr] = Field(default=None, alias="valueType") + __properties: ClassVar[List[str]] = ["attribute", "attributeName", "format", "granularity", "label", "labelName", "valueType"] + + @field_validator('granularity') + def granularity_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR']): + raise ValueError("must be one of enum values ('MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR')") + return value + + @field_validator('value_type') + def value_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TEXT', 'HYPERLINK', 'GEO', 'GEO_LONGITUDE', 'GEO_LATITUDE', 'IMAGE']): + raise ValueError("must be one of enum values ('TEXT', 'HYPERLINK', 'GEO', 'GEO_LONGITUDE', 'GEO_LATITUDE', 'IMAGE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of KeyDriversDimension from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attribute + if self.attribute: + _dict['attribute'] = self.attribute.to_dict() + # override the default output from pydantic by calling `to_dict()` of format + if self.format: + _dict['format'] = self.format.to_dict() + # override the default output from pydantic by calling `to_dict()` of label + if self.label: + _dict['label'] = self.label.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of KeyDriversDimension from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attribute": RestApiIdentifier.from_dict(obj["attribute"]) if obj.get("attribute") is not None else None, + "attributeName": obj.get("attributeName"), + "format": AttributeFormat.from_dict(obj["format"]) if obj.get("format") is not None else None, + "granularity": obj.get("granularity"), + "label": RestApiIdentifier.from_dict(obj["label"]) if obj.get("label") is not None else None, + "labelName": obj.get("labelName"), + "valueType": obj.get("valueType") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/key_drivers_request.py b/gooddata-api-client/gooddata_api_client/models/key_drivers_request.py new file mode 100644 index 000000000..0695ca527 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/key_drivers_request.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.measure_item import MeasureItem +from typing import Optional, Set +from typing_extensions import Self + +class KeyDriversRequest(BaseModel): + """ + KeyDriversRequest + """ # noqa: E501 + aux_metrics: Optional[List[MeasureItem]] = Field(default=None, description="Additional metrics to be included in the computation, but excluded from the analysis.", alias="auxMetrics") + metric: MeasureItem + sort_direction: Optional[StrictStr] = Field(default='DESC', description="Sorting elements - ascending/descending order.", alias="sortDirection") + __properties: ClassVar[List[str]] = ["auxMetrics", "metric", "sortDirection"] + + @field_validator('sort_direction') + def sort_direction_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ASC', 'DESC']): + raise ValueError("must be one of enum values ('ASC', 'DESC')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of KeyDriversRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in aux_metrics (list) + _items = [] + if self.aux_metrics: + for _item_aux_metrics in self.aux_metrics: + if _item_aux_metrics: + _items.append(_item_aux_metrics.to_dict()) + _dict['auxMetrics'] = _items + # override the default output from pydantic by calling `to_dict()` of metric + if self.metric: + _dict['metric'] = self.metric.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of KeyDriversRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "auxMetrics": [MeasureItem.from_dict(_item) for _item in obj["auxMetrics"]] if obj.get("auxMetrics") is not None else None, + "metric": MeasureItem.from_dict(obj["metric"]) if obj.get("metric") is not None else None, + "sortDirection": obj.get("sortDirection") if obj.get("sortDirection") is not None else 'DESC' + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/key_drivers_response.py b/gooddata-api-client/gooddata_api_client/models/key_drivers_response.py new file mode 100644 index 000000000..5bcaff777 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/key_drivers_response.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.execution_links import ExecutionLinks +from gooddata_api_client.models.key_drivers_dimension import KeyDriversDimension +from typing import Optional, Set +from typing_extensions import Self + +class KeyDriversResponse(BaseModel): + """ + KeyDriversResponse + """ # noqa: E501 + dimensions: List[KeyDriversDimension] + links: ExecutionLinks + __properties: ClassVar[List[str]] = ["dimensions", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of KeyDriversResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensions (list) + _items = [] + if self.dimensions: + for _item_dimensions in self.dimensions: + if _item_dimensions: + _items.append(_item_dimensions.to_dict()) + _dict['dimensions'] = _items + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of KeyDriversResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensions": [KeyDriversDimension.from_dict(_item) for _item in obj["dimensions"]] if obj.get("dimensions") is not None else None, + "links": ExecutionLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/key_drivers_result.py b/gooddata-api-client/gooddata_api_client/models/key_drivers_result.py new file mode 100644 index 000000000..65acf820b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/key_drivers_result.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class KeyDriversResult(BaseModel): + """ + KeyDriversResult + """ # noqa: E501 + data: Dict[str, Any] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of KeyDriversResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of KeyDriversResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": obj.get("data") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/label_identifier.py b/gooddata-api-client/gooddata_api_client/models/label_identifier.py new file mode 100644 index 000000000..29c0142e2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/label_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class LabelIdentifier(BaseModel): + """ + A label identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Label ID.") + type: StrictStr = Field(description="A type of the label.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['label']): + raise ValueError("must be one of enum values ('label')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LabelIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LabelIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/list_links.py b/gooddata-api-client/gooddata_api_client/models/list_links.py new file mode 100644 index 000000000..4b1d2f744 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/list_links.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ListLinks(BaseModel): + """ + ListLinks + """ # noqa: E501 + var_self: StrictStr = Field(description="A string containing the link's URL.", alias="self") + next: Optional[StrictStr] = Field(default=None, description="A string containing the link's URL for the next page of data.") + __properties: ClassVar[List[str]] = ["self", "next"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ListLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ListLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "self": obj.get("self"), + "next": obj.get("next") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/local_identifier.py b/gooddata-api-client/gooddata_api_client/models/local_identifier.py new file mode 100644 index 000000000..e2e84ba06 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/local_identifier.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class LocalIdentifier(BaseModel): + """ + LocalIdentifier + """ # noqa: E501 + format: Optional[Annotated[str, Field(strict=True, max_length=2048)]] = Field(default='#,##0.00', description="Metric format.") + local_identifier: StrictStr = Field(description="Local identifier of the metric to be compared.", alias="localIdentifier") + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Metric title.") + __properties: ClassVar[List[str]] = ["format", "localIdentifier", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LocalIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if format (nullable) is None + # and model_fields_set contains the field + if self.format is None and "format" in self.model_fields_set: + _dict['format'] = None + + # set to None if title (nullable) is None + # and model_fields_set contains the field + if self.title is None and "title" in self.model_fields_set: + _dict['title'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LocalIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "format": obj.get("format") if obj.get("format") is not None else '#,##0.00', + "localIdentifier": obj.get("localIdentifier"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/locale_request.py b/gooddata-api-client/gooddata_api_client/models/locale_request.py new file mode 100644 index 000000000..3b283d067 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/locale_request.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class LocaleRequest(BaseModel): + """ + LocaleRequest + """ # noqa: E501 + locale: StrictStr = Field(description="Requested locale in the form of language tag (see RFC 5646).") + __properties: ClassVar[List[str]] = ["locale"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LocaleRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LocaleRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "locale": obj.get("locale") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/manage_dashboard_permissions_request_inner.py b/gooddata-api-client/gooddata_api_client/models/manage_dashboard_permissions_request_inner.py new file mode 100644 index 000000000..ce1581e84 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/manage_dashboard_permissions_request_inner.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.permissions_for_assignee import PermissionsForAssignee +from gooddata_api_client.models.permissions_for_assignee_rule import PermissionsForAssigneeRule +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +MANAGEDASHBOARDPERMISSIONSREQUESTINNER_ONE_OF_SCHEMAS = ["PermissionsForAssignee", "PermissionsForAssigneeRule"] + +class ManageDashboardPermissionsRequestInner(BaseModel): + """ + ManageDashboardPermissionsRequestInner + """ + # data type: PermissionsForAssignee + oneof_schema_1_validator: Optional[PermissionsForAssignee] = None + # data type: PermissionsForAssigneeRule + oneof_schema_2_validator: Optional[PermissionsForAssigneeRule] = None + actual_instance: Optional[Union[PermissionsForAssignee, PermissionsForAssigneeRule]] = None + one_of_schemas: Set[str] = { "PermissionsForAssignee", "PermissionsForAssigneeRule" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = ManageDashboardPermissionsRequestInner.model_construct() + error_messages = [] + match = 0 + # validate data type: PermissionsForAssignee + if not isinstance(v, PermissionsForAssignee): + error_messages.append(f"Error! Input type `{type(v)}` is not `PermissionsForAssignee`") + else: + match += 1 + # validate data type: PermissionsForAssigneeRule + if not isinstance(v, PermissionsForAssigneeRule): + error_messages.append(f"Error! Input type `{type(v)}` is not `PermissionsForAssigneeRule`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in ManageDashboardPermissionsRequestInner with oneOf schemas: PermissionsForAssignee, PermissionsForAssigneeRule. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in ManageDashboardPermissionsRequestInner with oneOf schemas: PermissionsForAssignee, PermissionsForAssigneeRule. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into PermissionsForAssignee + try: + instance.actual_instance = PermissionsForAssignee.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into PermissionsForAssigneeRule + try: + instance.actual_instance = PermissionsForAssigneeRule.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into ManageDashboardPermissionsRequestInner with oneOf schemas: PermissionsForAssignee, PermissionsForAssigneeRule. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into ManageDashboardPermissionsRequestInner with oneOf schemas: PermissionsForAssignee, PermissionsForAssigneeRule. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], PermissionsForAssignee, PermissionsForAssigneeRule]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/measure_definition.py b/gooddata-api-client/gooddata_api_client/models/measure_definition.py new file mode 100644 index 000000000..03b3ac90c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/measure_definition.py @@ -0,0 +1,166 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.arithmetic_measure_definition import ArithmeticMeasureDefinition +from gooddata_api_client.models.inline_measure_definition import InlineMeasureDefinition +from gooddata_api_client.models.pop_measure_definition import PopMeasureDefinition +from gooddata_api_client.models.simple_measure_definition import SimpleMeasureDefinition +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +MEASUREDEFINITION_ONE_OF_SCHEMAS = ["ArithmeticMeasureDefinition", "InlineMeasureDefinition", "PopMeasureDefinition", "SimpleMeasureDefinition"] + +class MeasureDefinition(BaseModel): + """ + Abstract metric definition type + """ + # data type: InlineMeasureDefinition + oneof_schema_1_validator: Optional[InlineMeasureDefinition] = None + # data type: ArithmeticMeasureDefinition + oneof_schema_2_validator: Optional[ArithmeticMeasureDefinition] = None + # data type: SimpleMeasureDefinition + oneof_schema_3_validator: Optional[SimpleMeasureDefinition] = None + # data type: PopMeasureDefinition + oneof_schema_4_validator: Optional[PopMeasureDefinition] = None + actual_instance: Optional[Union[ArithmeticMeasureDefinition, InlineMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition]] = None + one_of_schemas: Set[str] = { "ArithmeticMeasureDefinition", "InlineMeasureDefinition", "PopMeasureDefinition", "SimpleMeasureDefinition" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = MeasureDefinition.model_construct() + error_messages = [] + match = 0 + # validate data type: InlineMeasureDefinition + if not isinstance(v, InlineMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `InlineMeasureDefinition`") + else: + match += 1 + # validate data type: ArithmeticMeasureDefinition + if not isinstance(v, ArithmeticMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `ArithmeticMeasureDefinition`") + else: + match += 1 + # validate data type: SimpleMeasureDefinition + if not isinstance(v, SimpleMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `SimpleMeasureDefinition`") + else: + match += 1 + # validate data type: PopMeasureDefinition + if not isinstance(v, PopMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `PopMeasureDefinition`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in MeasureDefinition with oneOf schemas: ArithmeticMeasureDefinition, InlineMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in MeasureDefinition with oneOf schemas: ArithmeticMeasureDefinition, InlineMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into InlineMeasureDefinition + try: + instance.actual_instance = InlineMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into ArithmeticMeasureDefinition + try: + instance.actual_instance = ArithmeticMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into SimpleMeasureDefinition + try: + instance.actual_instance = SimpleMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into PopMeasureDefinition + try: + instance.actual_instance = PopMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into MeasureDefinition with oneOf schemas: ArithmeticMeasureDefinition, InlineMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into MeasureDefinition with oneOf schemas: ArithmeticMeasureDefinition, InlineMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], ArithmeticMeasureDefinition, InlineMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/measure_execution_result_header.py b/gooddata-api-client/gooddata_api_client/models/measure_execution_result_header.py new file mode 100644 index 000000000..906772553 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/measure_execution_result_header.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.measure_result_header import MeasureResultHeader +from typing import Optional, Set +from typing_extensions import Self + +class MeasureExecutionResultHeader(BaseModel): + """ + MeasureExecutionResultHeader + """ # noqa: E501 + measure_header: MeasureResultHeader = Field(alias="measureHeader") + __properties: ClassVar[List[str]] = ["measureHeader"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MeasureExecutionResultHeader from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of measure_header + if self.measure_header: + _dict['measureHeader'] = self.measure_header.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MeasureExecutionResultHeader from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "measureHeader": MeasureResultHeader.from_dict(obj["measureHeader"]) if obj.get("measureHeader") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/measure_group_headers.py b/gooddata-api-client/gooddata_api_client/models/measure_group_headers.py new file mode 100644 index 000000000..eb93592ed --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/measure_group_headers.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.measure_header import MeasureHeader +from typing import Optional, Set +from typing_extensions import Self + +class MeasureGroupHeaders(BaseModel): + """ + Measure group headers + """ # noqa: E501 + measure_group_headers: Optional[List[MeasureHeader]] = Field(default=None, alias="measureGroupHeaders") + __properties: ClassVar[List[str]] = ["measureGroupHeaders"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MeasureGroupHeaders from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in measure_group_headers (list) + _items = [] + if self.measure_group_headers: + for _item_measure_group_headers in self.measure_group_headers: + if _item_measure_group_headers: + _items.append(_item_measure_group_headers.to_dict()) + _dict['measureGroupHeaders'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MeasureGroupHeaders from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "measureGroupHeaders": [MeasureHeader.from_dict(_item) for _item in obj["measureGroupHeaders"]] if obj.get("measureGroupHeaders") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/measure_header.py b/gooddata-api-client/gooddata_api_client/models/measure_header.py new file mode 100644 index 000000000..9887e5b57 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/measure_header.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class MeasureHeader(BaseModel): + """ + MeasureHeader + """ # noqa: E501 + format: Optional[StrictStr] = Field(default=None, description="Format to be used to format the measure data.") + local_identifier: StrictStr = Field(description="Local identifier of the measure this header relates to.", alias="localIdentifier") + name: Optional[StrictStr] = Field(default=None, description="Name of the measure.") + __properties: ClassVar[List[str]] = ["format", "localIdentifier", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MeasureHeader from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MeasureHeader from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "format": obj.get("format"), + "localIdentifier": obj.get("localIdentifier"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/measure_item.py b/gooddata-api-client/gooddata_api_client/models/measure_item.py new file mode 100644 index 000000000..35983fbc7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/measure_item.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from gooddata_api_client.models.measure_item_definition import MeasureItemDefinition +from typing import Optional, Set +from typing_extensions import Self + +class MeasureItem(BaseModel): + """ + Metric is a quantity that is calculated from the data. + """ # noqa: E501 + definition: MeasureItemDefinition + local_identifier: Annotated[str, Field(strict=True)] = Field(description="Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", alias="localIdentifier") + __properties: ClassVar[List[str]] = ["definition", "localIdentifier"] + + @field_validator('local_identifier') + def local_identifier_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[.a-zA-Z0-9_-]+$", value): + raise ValueError(r"must validate the regular expression /^[.a-zA-Z0-9_-]+$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MeasureItem from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of definition + if self.definition: + _dict['definition'] = self.definition.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MeasureItem from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "definition": MeasureItemDefinition.from_dict(obj["definition"]) if obj.get("definition") is not None else None, + "localIdentifier": obj.get("localIdentifier") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/measure_item_definition.py b/gooddata-api-client/gooddata_api_client/models/measure_item_definition.py new file mode 100644 index 000000000..3ea8d4fb5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/measure_item_definition.py @@ -0,0 +1,194 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.arithmetic_measure_definition import ArithmeticMeasureDefinition +from gooddata_api_client.models.inline_measure_definition import InlineMeasureDefinition +from gooddata_api_client.models.pop_dataset_measure_definition import PopDatasetMeasureDefinition +from gooddata_api_client.models.pop_date_measure_definition import PopDateMeasureDefinition +from gooddata_api_client.models.pop_measure_definition import PopMeasureDefinition +from gooddata_api_client.models.simple_measure_definition import SimpleMeasureDefinition +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +MEASUREITEMDEFINITION_ONE_OF_SCHEMAS = ["ArithmeticMeasureDefinition", "InlineMeasureDefinition", "PopDatasetMeasureDefinition", "PopDateMeasureDefinition", "PopMeasureDefinition", "SimpleMeasureDefinition"] + +class MeasureItemDefinition(BaseModel): + """ + MeasureItemDefinition + """ + # data type: ArithmeticMeasureDefinition + oneof_schema_1_validator: Optional[ArithmeticMeasureDefinition] = None + # data type: InlineMeasureDefinition + oneof_schema_2_validator: Optional[InlineMeasureDefinition] = None + # data type: PopDatasetMeasureDefinition + oneof_schema_3_validator: Optional[PopDatasetMeasureDefinition] = None + # data type: PopDateMeasureDefinition + oneof_schema_4_validator: Optional[PopDateMeasureDefinition] = None + # data type: PopMeasureDefinition + oneof_schema_5_validator: Optional[PopMeasureDefinition] = None + # data type: SimpleMeasureDefinition + oneof_schema_6_validator: Optional[SimpleMeasureDefinition] = None + actual_instance: Optional[Union[ArithmeticMeasureDefinition, InlineMeasureDefinition, PopDatasetMeasureDefinition, PopDateMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition]] = None + one_of_schemas: Set[str] = { "ArithmeticMeasureDefinition", "InlineMeasureDefinition", "PopDatasetMeasureDefinition", "PopDateMeasureDefinition", "PopMeasureDefinition", "SimpleMeasureDefinition" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = MeasureItemDefinition.model_construct() + error_messages = [] + match = 0 + # validate data type: ArithmeticMeasureDefinition + if not isinstance(v, ArithmeticMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `ArithmeticMeasureDefinition`") + else: + match += 1 + # validate data type: InlineMeasureDefinition + if not isinstance(v, InlineMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `InlineMeasureDefinition`") + else: + match += 1 + # validate data type: PopDatasetMeasureDefinition + if not isinstance(v, PopDatasetMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `PopDatasetMeasureDefinition`") + else: + match += 1 + # validate data type: PopDateMeasureDefinition + if not isinstance(v, PopDateMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `PopDateMeasureDefinition`") + else: + match += 1 + # validate data type: PopMeasureDefinition + if not isinstance(v, PopMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `PopMeasureDefinition`") + else: + match += 1 + # validate data type: SimpleMeasureDefinition + if not isinstance(v, SimpleMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `SimpleMeasureDefinition`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in MeasureItemDefinition with oneOf schemas: ArithmeticMeasureDefinition, InlineMeasureDefinition, PopDatasetMeasureDefinition, PopDateMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in MeasureItemDefinition with oneOf schemas: ArithmeticMeasureDefinition, InlineMeasureDefinition, PopDatasetMeasureDefinition, PopDateMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into ArithmeticMeasureDefinition + try: + instance.actual_instance = ArithmeticMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into InlineMeasureDefinition + try: + instance.actual_instance = InlineMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into PopDatasetMeasureDefinition + try: + instance.actual_instance = PopDatasetMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into PopDateMeasureDefinition + try: + instance.actual_instance = PopDateMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into PopMeasureDefinition + try: + instance.actual_instance = PopMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into SimpleMeasureDefinition + try: + instance.actual_instance = SimpleMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into MeasureItemDefinition with oneOf schemas: ArithmeticMeasureDefinition, InlineMeasureDefinition, PopDatasetMeasureDefinition, PopDateMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into MeasureItemDefinition with oneOf schemas: ArithmeticMeasureDefinition, InlineMeasureDefinition, PopDatasetMeasureDefinition, PopDateMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], ArithmeticMeasureDefinition, InlineMeasureDefinition, PopDatasetMeasureDefinition, PopDateMeasureDefinition, PopMeasureDefinition, SimpleMeasureDefinition]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/measure_result_header.py b/gooddata-api-client/gooddata_api_client/models/measure_result_header.py new file mode 100644 index 000000000..c9df3cb1b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/measure_result_header.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class MeasureResultHeader(BaseModel): + """ + Header containing the information related to metrics. + """ # noqa: E501 + measure_index: StrictInt = Field(description="Metric index. Starts at 0.", alias="measureIndex") + __properties: ClassVar[List[str]] = ["measureIndex"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MeasureResultHeader from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MeasureResultHeader from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "measureIndex": obj.get("measureIndex") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/measure_value_filter.py b/gooddata-api-client/gooddata_api_client/models/measure_value_filter.py new file mode 100644 index 000000000..9ca21f46c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/measure_value_filter.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.comparison_measure_value_filter import ComparisonMeasureValueFilter +from gooddata_api_client.models.range_measure_value_filter import RangeMeasureValueFilter +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +MEASUREVALUEFILTER_ONE_OF_SCHEMAS = ["ComparisonMeasureValueFilter", "RangeMeasureValueFilter"] + +class MeasureValueFilter(BaseModel): + """ + Abstract filter definition type filtering by the value of the metric. + """ + # data type: ComparisonMeasureValueFilter + oneof_schema_1_validator: Optional[ComparisonMeasureValueFilter] = None + # data type: RangeMeasureValueFilter + oneof_schema_2_validator: Optional[RangeMeasureValueFilter] = None + actual_instance: Optional[Union[ComparisonMeasureValueFilter, RangeMeasureValueFilter]] = None + one_of_schemas: Set[str] = { "ComparisonMeasureValueFilter", "RangeMeasureValueFilter" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = MeasureValueFilter.model_construct() + error_messages = [] + match = 0 + # validate data type: ComparisonMeasureValueFilter + if not isinstance(v, ComparisonMeasureValueFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `ComparisonMeasureValueFilter`") + else: + match += 1 + # validate data type: RangeMeasureValueFilter + if not isinstance(v, RangeMeasureValueFilter): + error_messages.append(f"Error! Input type `{type(v)}` is not `RangeMeasureValueFilter`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in MeasureValueFilter with oneOf schemas: ComparisonMeasureValueFilter, RangeMeasureValueFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in MeasureValueFilter with oneOf schemas: ComparisonMeasureValueFilter, RangeMeasureValueFilter. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into ComparisonMeasureValueFilter + try: + instance.actual_instance = ComparisonMeasureValueFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into RangeMeasureValueFilter + try: + instance.actual_instance = RangeMeasureValueFilter.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into MeasureValueFilter with oneOf schemas: ComparisonMeasureValueFilter, RangeMeasureValueFilter. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into MeasureValueFilter with oneOf schemas: ComparisonMeasureValueFilter, RangeMeasureValueFilter. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], ComparisonMeasureValueFilter, RangeMeasureValueFilter]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/memory_item.py b/gooddata-api-client/gooddata_api_client/models/memory_item.py new file mode 100644 index 000000000..df4635433 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/memory_item.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.memory_item_use_cases import MemoryItemUseCases +from typing import Optional, Set +from typing_extensions import Self + +class MemoryItem(BaseModel): + """ + MemoryItem + """ # noqa: E501 + id: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Memory item ID") + instruction: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Instruction that will be injected into the prompt.") + keywords: List[StrictStr] = Field(description="List of keywords used to match the memory item.") + strategy: Optional[StrictStr] = Field(default=None, description="Defines the application strategy.") + use_cases: Optional[MemoryItemUseCases] = Field(default=None, alias="useCases") + __properties: ClassVar[List[str]] = ["id", "instruction", "keywords", "strategy", "useCases"] + + @field_validator('strategy') + def strategy_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MEMORY_ITEM_STRATEGY_ALLWAYS', 'MEMORY_ITEM_STRATEGY_NEVER', 'MEMORY_ITEM_STRATEGY_AUTO']): + raise ValueError("must be one of enum values ('MEMORY_ITEM_STRATEGY_ALLWAYS', 'MEMORY_ITEM_STRATEGY_NEVER', 'MEMORY_ITEM_STRATEGY_AUTO')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MemoryItem from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of use_cases + if self.use_cases: + _dict['useCases'] = self.use_cases.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MemoryItem from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "instruction": obj.get("instruction"), + "keywords": obj.get("keywords"), + "strategy": obj.get("strategy"), + "useCases": MemoryItemUseCases.from_dict(obj["useCases"]) if obj.get("useCases") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/memory_item_use_cases.py b/gooddata-api-client/gooddata_api_client/models/memory_item_use_cases.py new file mode 100644 index 000000000..9a8469304 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/memory_item_use_cases.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class MemoryItemUseCases(BaseModel): + """ + Defines the prompts where the given instruction should be applied. + """ # noqa: E501 + general: StrictBool = Field(description="Apply this memory item to the general answer prompt.") + howto: StrictBool = Field(description="Apply this memory item to the how-to prompt.") + keywords: StrictBool = Field(description="Apply this memory item to the search keyword extraction prompt.") + metric: StrictBool = Field(description="Apply this memory item to the metric selection prompt.") + normalize: StrictBool = Field(description="Apply this memory item to the normalize prompt.") + router: StrictBool = Field(description="Appy this memory item to the router prompt.") + search: StrictBool = Field(description="Apply this memory item to the search prompt.") + visualization: StrictBool = Field(description="Apply this memory item to the visualization prompt.") + __properties: ClassVar[List[str]] = ["general", "howto", "keywords", "metric", "normalize", "router", "search", "visualization"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MemoryItemUseCases from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MemoryItemUseCases from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "general": obj.get("general"), + "howto": obj.get("howto"), + "keywords": obj.get("keywords"), + "metric": obj.get("metric"), + "normalize": obj.get("normalize"), + "router": obj.get("router"), + "search": obj.get("search"), + "visualization": obj.get("visualization") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/metric.py b/gooddata-api-client/gooddata_api_client/models/metric.py new file mode 100644 index 000000000..da5ac03c0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/metric.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class Metric(BaseModel): + """ + List of metrics to be used in the new visualization + """ # noqa: E501 + agg_function: Optional[StrictStr] = Field(default=None, description="Agg function. Empty if a stored metric is used.", alias="aggFunction") + id: StrictStr = Field(description="ID of the object") + title: StrictStr = Field(description="Title of metric.") + type: StrictStr = Field(description="Object type") + __properties: ClassVar[List[str]] = ["aggFunction", "id", "title", "type"] + + @field_validator('agg_function') + def agg_function_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['COUNT', 'SUM', 'MIN', 'MAX', 'AVG', 'MEDIAN']): + raise ValueError("must be one of enum values ('COUNT', 'SUM', 'MIN', 'MAX', 'AVG', 'MEDIAN')") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['metric', 'fact', 'attribute']): + raise ValueError("must be one of enum values ('metric', 'fact', 'attribute')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Metric from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Metric from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "aggFunction": obj.get("aggFunction"), + "id": obj.get("id"), + "title": obj.get("title"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/metric_record.py b/gooddata-api-client/gooddata_api_client/models/metric_record.py new file mode 100644 index 000000000..79dad87e8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/metric_record.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class MetricRecord(BaseModel): + """ + MetricRecord + """ # noqa: E501 + formatted_value: Optional[StrictStr] = Field(default=None, alias="formattedValue") + value: Union[StrictFloat, StrictInt] + __properties: ClassVar[List[str]] = ["formattedValue", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MetricRecord from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MetricRecord from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "formattedValue": obj.get("formattedValue"), + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/negative_attribute_filter.py b/gooddata-api-client/gooddata_api_client/models/negative_attribute_filter.py new file mode 100644 index 000000000..66da3c6c9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/negative_attribute_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter +from typing import Optional, Set +from typing_extensions import Self + +class NegativeAttributeFilter(BaseModel): + """ + Filter able to limit element values by label and related selected negated elements. + """ # noqa: E501 + negative_attribute_filter: NegativeAttributeFilterNegativeAttributeFilter = Field(alias="negativeAttributeFilter") + __properties: ClassVar[List[str]] = ["negativeAttributeFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of NegativeAttributeFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of negative_attribute_filter + if self.negative_attribute_filter: + _dict['negativeAttributeFilter'] = self.negative_attribute_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of NegativeAttributeFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "negativeAttributeFilter": NegativeAttributeFilterNegativeAttributeFilter.from_dict(obj["negativeAttributeFilter"]) if obj.get("negativeAttributeFilter") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/negative_attribute_filter_negative_attribute_filter.py b/gooddata-api-client/gooddata_api_client/models/negative_attribute_filter_negative_attribute_filter.py new file mode 100644 index 000000000..9a985bb0c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/negative_attribute_filter_negative_attribute_filter.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.afm_identifier import AfmIdentifier +from gooddata_api_client.models.attribute_filter_elements import AttributeFilterElements +from typing import Optional, Set +from typing_extensions import Self + +class NegativeAttributeFilterNegativeAttributeFilter(BaseModel): + """ + NegativeAttributeFilterNegativeAttributeFilter + """ # noqa: E501 + apply_on_result: Optional[StrictBool] = Field(default=None, alias="applyOnResult") + label: AfmIdentifier + local_identifier: Optional[StrictStr] = Field(default=None, alias="localIdentifier") + not_in: AttributeFilterElements = Field(alias="notIn") + __properties: ClassVar[List[str]] = ["applyOnResult", "label", "localIdentifier", "notIn"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of NegativeAttributeFilterNegativeAttributeFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of label + if self.label: + _dict['label'] = self.label.to_dict() + # override the default output from pydantic by calling `to_dict()` of not_in + if self.not_in: + _dict['notIn'] = self.not_in.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of NegativeAttributeFilterNegativeAttributeFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applyOnResult": obj.get("applyOnResult"), + "label": AfmIdentifier.from_dict(obj["label"]) if obj.get("label") is not None else None, + "localIdentifier": obj.get("localIdentifier"), + "notIn": AttributeFilterElements.from_dict(obj["notIn"]) if obj.get("notIn") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/note.py b/gooddata-api-client/gooddata_api_client/models/note.py new file mode 100644 index 000000000..1f02863a8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/note.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class Note(BaseModel): + """ + Note + """ # noqa: E501 + applies_to: Optional[StrictStr] = Field(default=None, alias="appliesTo") + category: Optional[StrictStr] = None + content: Optional[StrictStr] = None + id: Optional[StrictStr] = None + other_attributes: Optional[Dict[str, StrictStr]] = Field(default=None, alias="otherAttributes") + priority: Optional[StrictInt] = None + __properties: ClassVar[List[str]] = ["appliesTo", "category", "content", "id", "otherAttributes", "priority"] + + @field_validator('applies_to') + def applies_to_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SOURCE', 'TARGET']): + raise ValueError("must be one of enum values ('SOURCE', 'TARGET')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Note from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Note from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "appliesTo": obj.get("appliesTo"), + "category": obj.get("category"), + "content": obj.get("content"), + "id": obj.get("id"), + "otherAttributes": obj.get("otherAttributes"), + "priority": obj.get("priority") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/notes.py b/gooddata-api-client/gooddata_api_client/models/notes.py new file mode 100644 index 000000000..b54b4fe8a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/notes.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.note import Note +from typing import Optional, Set +from typing_extensions import Self + +class Notes(BaseModel): + """ + Notes + """ # noqa: E501 + note: List[Note] + __properties: ClassVar[List[str]] = ["note"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Notes from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in note (list) + _items = [] + if self.note: + for _item_note in self.note: + if _item_note: + _items.append(_item_note.to_dict()) + _dict['note'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Notes from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "note": [Note.from_dict(_item) for _item in obj["note"]] if obj.get("note") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/notification.py b/gooddata-api-client/gooddata_api_client/models/notification.py new file mode 100644 index 000000000..2ee0cd95c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/notification.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.notification_data import NotificationData +from typing import Optional, Set +from typing_extensions import Self + +class Notification(BaseModel): + """ + Notification + """ # noqa: E501 + automation_id: Optional[StrictStr] = Field(default=None, alias="automationId") + created_at: datetime = Field(alias="createdAt") + data: NotificationData + id: StrictStr + is_read: StrictBool = Field(alias="isRead") + workspace_id: Optional[StrictStr] = Field(default=None, alias="workspaceId") + __properties: ClassVar[List[str]] = ["automationId", "createdAt", "data", "id", "isRead", "workspaceId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Notification from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Notification from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "automationId": obj.get("automationId"), + "createdAt": obj.get("createdAt"), + "data": NotificationData.from_dict(obj["data"]) if obj.get("data") is not None else None, + "id": obj.get("id"), + "isRead": obj.get("isRead"), + "workspaceId": obj.get("workspaceId") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/notification_channel_destination.py b/gooddata-api-client/gooddata_api_client/models/notification_channel_destination.py new file mode 100644 index 000000000..455c748cf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/notification_channel_destination.py @@ -0,0 +1,166 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.default_smtp import DefaultSmtp +from gooddata_api_client.models.in_platform import InPlatform +from gooddata_api_client.models.smtp import Smtp +from gooddata_api_client.models.webhook import Webhook +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +NOTIFICATIONCHANNELDESTINATION_ONE_OF_SCHEMAS = ["DefaultSmtp", "InPlatform", "Smtp", "Webhook"] + +class NotificationChannelDestination(BaseModel): + """ + NotificationChannelDestination + """ + # data type: Webhook + oneof_schema_1_validator: Optional[Webhook] = None + # data type: Smtp + oneof_schema_2_validator: Optional[Smtp] = None + # data type: DefaultSmtp + oneof_schema_3_validator: Optional[DefaultSmtp] = None + # data type: InPlatform + oneof_schema_4_validator: Optional[InPlatform] = None + actual_instance: Optional[Union[DefaultSmtp, InPlatform, Smtp, Webhook]] = None + one_of_schemas: Set[str] = { "DefaultSmtp", "InPlatform", "Smtp", "Webhook" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = NotificationChannelDestination.model_construct() + error_messages = [] + match = 0 + # validate data type: Webhook + if not isinstance(v, Webhook): + error_messages.append(f"Error! Input type `{type(v)}` is not `Webhook`") + else: + match += 1 + # validate data type: Smtp + if not isinstance(v, Smtp): + error_messages.append(f"Error! Input type `{type(v)}` is not `Smtp`") + else: + match += 1 + # validate data type: DefaultSmtp + if not isinstance(v, DefaultSmtp): + error_messages.append(f"Error! Input type `{type(v)}` is not `DefaultSmtp`") + else: + match += 1 + # validate data type: InPlatform + if not isinstance(v, InPlatform): + error_messages.append(f"Error! Input type `{type(v)}` is not `InPlatform`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in NotificationChannelDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in NotificationChannelDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into Webhook + try: + instance.actual_instance = Webhook.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into Smtp + try: + instance.actual_instance = Smtp.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into DefaultSmtp + try: + instance.actual_instance = DefaultSmtp.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into InPlatform + try: + instance.actual_instance = InPlatform.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into NotificationChannelDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into NotificationChannelDestination with oneOf schemas: DefaultSmtp, InPlatform, Smtp, Webhook. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], DefaultSmtp, InPlatform, Smtp, Webhook]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/notification_content.py b/gooddata-api-client/gooddata_api_client/models/notification_content.py new file mode 100644 index 000000000..bbdccea11 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/notification_content.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from importlib import import_module +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Union +from typing import Optional, Set +from typing_extensions import Self + +from typing import TYPE_CHECKING +if TYPE_CHECKING: + from gooddata_api_client.models.automation_notification import AutomationNotification + from gooddata_api_client.models.test_notification import TestNotification + +class NotificationContent(BaseModel): + """ + NotificationContent + """ # noqa: E501 + type: StrictStr + __properties: ClassVar[List[str]] = ["type"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + # JSON field name that stores the object type + __discriminator_property_name: ClassVar[str] = 'type' + + # discriminator mappings + __discriminator_value_class_map: ClassVar[Dict[str, str]] = { + 'AUTOMATION': 'AutomationNotification','TEST': 'TestNotification' + } + + @classmethod + def get_discriminator_value(cls, obj: Dict[str, Any]) -> Optional[str]: + """Returns the discriminator value (object type) of the data""" + discriminator_value = obj[cls.__discriminator_property_name] + if discriminator_value: + return cls.__discriminator_value_class_map.get(discriminator_value) + else: + return None + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Union[AutomationNotification, TestNotification]]: + """Create an instance of NotificationContent from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[AutomationNotification, TestNotification]]: + """Create an instance of NotificationContent from a dict""" + # look up the object type based on discriminator mapping + object_type = cls.get_discriminator_value(obj) + if object_type == 'AutomationNotification': + return import_module("gooddata_api_client.models.automation_notification").AutomationNotification.from_dict(obj) + if object_type == 'TestNotification': + return import_module("gooddata_api_client.models.test_notification").TestNotification.from_dict(obj) + + raise ValueError("NotificationContent failed to lookup discriminator value from " + + json.dumps(obj) + ". Discriminator property name: " + cls.__discriminator_property_name + + ", mapping: " + json.dumps(cls.__discriminator_value_class_map)) + + diff --git a/gooddata-api-client/gooddata_api_client/models/notification_data.py b/gooddata-api-client/gooddata_api_client/models/notification_data.py new file mode 100644 index 000000000..594e35f0b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/notification_data.py @@ -0,0 +1,141 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.automation_notification import AutomationNotification +from gooddata_api_client.models.test_notification import TestNotification +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +NOTIFICATIONDATA_ONE_OF_SCHEMAS = ["AutomationNotification", "TestNotification"] + +class NotificationData(BaseModel): + """ + NotificationData + """ + # data type: AutomationNotification + oneof_schema_1_validator: Optional[AutomationNotification] = None + # data type: TestNotification + oneof_schema_2_validator: Optional[TestNotification] = None + actual_instance: Optional[Union[AutomationNotification, TestNotification]] = None + one_of_schemas: Set[str] = { "AutomationNotification", "TestNotification" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + discriminator_value_class_map: Dict[str, str] = { + } + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = NotificationData.model_construct() + error_messages = [] + match = 0 + # validate data type: AutomationNotification + if not isinstance(v, AutomationNotification): + error_messages.append(f"Error! Input type `{type(v)}` is not `AutomationNotification`") + else: + match += 1 + # validate data type: TestNotification + if not isinstance(v, TestNotification): + error_messages.append(f"Error! Input type `{type(v)}` is not `TestNotification`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in NotificationData with oneOf schemas: AutomationNotification, TestNotification. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in NotificationData with oneOf schemas: AutomationNotification, TestNotification. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into AutomationNotification + try: + instance.actual_instance = AutomationNotification.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into TestNotification + try: + instance.actual_instance = TestNotification.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into NotificationData with oneOf schemas: AutomationNotification, TestNotification. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into NotificationData with oneOf schemas: AutomationNotification, TestNotification. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], AutomationNotification, TestNotification]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/notification_filter.py b/gooddata-api-client/gooddata_api_client/models/notification_filter.py new file mode 100644 index 000000000..dc5110868 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/notification_filter.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class NotificationFilter(BaseModel): + """ + NotificationFilter + """ # noqa: E501 + filter: StrictStr + title: StrictStr + __properties: ClassVar[List[str]] = ["filter", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of NotificationFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of NotificationFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "filter": obj.get("filter"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/notifications.py b/gooddata-api-client/gooddata_api_client/models/notifications.py new file mode 100644 index 000000000..22eb6d813 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/notifications.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.notification import Notification +from gooddata_api_client.models.notifications_meta import NotificationsMeta +from typing import Optional, Set +from typing_extensions import Self + +class Notifications(BaseModel): + """ + Notifications + """ # noqa: E501 + data: List[Notification] + meta: NotificationsMeta + __properties: ClassVar[List[str]] = ["data", "meta"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Notifications from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Notifications from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [Notification.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "meta": NotificationsMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/notifications_meta.py b/gooddata-api-client/gooddata_api_client/models/notifications_meta.py new file mode 100644 index 000000000..7bc99feec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/notifications_meta.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.notifications_meta_total import NotificationsMetaTotal +from typing import Optional, Set +from typing_extensions import Self + +class NotificationsMeta(BaseModel): + """ + NotificationsMeta + """ # noqa: E501 + total: Optional[NotificationsMetaTotal] = None + __properties: ClassVar[List[str]] = ["total"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of NotificationsMeta from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of total + if self.total: + _dict['total'] = self.total.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of NotificationsMeta from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "total": NotificationsMetaTotal.from_dict(obj["total"]) if obj.get("total") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/notifications_meta_total.py b/gooddata-api-client/gooddata_api_client/models/notifications_meta_total.py new file mode 100644 index 000000000..5901c699a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/notifications_meta_total.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class NotificationsMetaTotal(BaseModel): + """ + NotificationsMetaTotal + """ # noqa: E501 + all: StrictInt + unread: StrictInt + __properties: ClassVar[List[str]] = ["all", "unread"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of NotificationsMetaTotal from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of NotificationsMetaTotal from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "all": obj.get("all"), + "unread": obj.get("unread") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/object_links.py b/gooddata-api-client/gooddata_api_client/models/object_links.py new file mode 100644 index 000000000..70f91157f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/object_links.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ObjectLinks(BaseModel): + """ + ObjectLinks + """ # noqa: E501 + var_self: StrictStr = Field(description="A string containing the link's URL.", alias="self") + __properties: ClassVar[List[str]] = ["self"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ObjectLinks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ObjectLinks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "self": obj.get("self") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/object_links_container.py b/gooddata-api-client/gooddata_api_client/models/object_links_container.py new file mode 100644 index 000000000..7a68bb302 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/object_links_container.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.object_links import ObjectLinks +from typing import Optional, Set +from typing_extensions import Self + +class ObjectLinksContainer(BaseModel): + """ + ObjectLinksContainer + """ # noqa: E501 + links: Optional[ObjectLinks] = None + __properties: ClassVar[List[str]] = ["links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ObjectLinksContainer from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ObjectLinksContainer from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "links": ObjectLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/organization_automation_identifier.py b/gooddata-api-client/gooddata_api_client/models/organization_automation_identifier.py new file mode 100644 index 000000000..7ca48cd47 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/organization_automation_identifier.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class OrganizationAutomationIdentifier(BaseModel): + """ + OrganizationAutomationIdentifier + """ # noqa: E501 + id: StrictStr + workspace_id: StrictStr = Field(alias="workspaceId") + __properties: ClassVar[List[str]] = ["id", "workspaceId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of OrganizationAutomationIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of OrganizationAutomationIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "workspaceId": obj.get("workspaceId") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/organization_automation_management_bulk_request.py b/gooddata-api-client/gooddata_api_client/models/organization_automation_management_bulk_request.py new file mode 100644 index 000000000..95923e903 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/organization_automation_management_bulk_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.organization_automation_identifier import OrganizationAutomationIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class OrganizationAutomationManagementBulkRequest(BaseModel): + """ + OrganizationAutomationManagementBulkRequest + """ # noqa: E501 + automations: List[OrganizationAutomationIdentifier] + __properties: ClassVar[List[str]] = ["automations"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of OrganizationAutomationManagementBulkRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in automations (list) + _items = [] + if self.automations: + for _item_automations in self.automations: + if _item_automations: + _items.append(_item_automations.to_dict()) + _dict['automations'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of OrganizationAutomationManagementBulkRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "automations": [OrganizationAutomationIdentifier.from_dict(_item) for _item in obj["automations"]] if obj.get("automations") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/organization_permission_assignment.py b/gooddata-api-client/gooddata_api_client/models/organization_permission_assignment.py new file mode 100644 index 000000000..23460d628 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/organization_permission_assignment.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class OrganizationPermissionAssignment(BaseModel): + """ + Organization permission assignments + """ # noqa: E501 + assignee_identifier: AssigneeIdentifier = Field(alias="assigneeIdentifier") + permissions: List[StrictStr] + __properties: ClassVar[List[str]] = ["assigneeIdentifier", "permissions"] + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['MANAGE', 'SELF_CREATE_TOKEN']): + raise ValueError("each list item must be one of ('MANAGE', 'SELF_CREATE_TOKEN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of OrganizationPermissionAssignment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee_identifier + if self.assignee_identifier: + _dict['assigneeIdentifier'] = self.assignee_identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of OrganizationPermissionAssignment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assigneeIdentifier": AssigneeIdentifier.from_dict(obj["assigneeIdentifier"]) if obj.get("assigneeIdentifier") is not None else None, + "permissions": obj.get("permissions") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/over.py b/gooddata-api-client/gooddata_api_client/models/over.py new file mode 100644 index 000000000..4ed36cc7a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/over.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.identifier_ref import IdentifierRef +from typing import Optional, Set +from typing_extensions import Self + +class Over(BaseModel): + """ + Over + """ # noqa: E501 + attributes: List[IdentifierRef] + __properties: ClassVar[List[str]] = ["attributes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Over from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in attributes (list) + _items = [] + if self.attributes: + for _item_attributes in self.attributes: + if _item_attributes: + _items.append(_item_attributes.to_dict()) + _dict['attributes'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Over from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributes": [IdentifierRef.from_dict(_item) for _item in obj["attributes"]] if obj.get("attributes") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/page_metadata.py b/gooddata-api-client/gooddata_api_client/models/page_metadata.py new file mode 100644 index 000000000..4896090d9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/page_metadata.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class PageMetadata(BaseModel): + """ + PageMetadata + """ # noqa: E501 + number: Optional[StrictInt] = Field(default=None, description="The number of the current page") + size: Optional[StrictInt] = Field(default=None, description="The size of the current page") + total_elements: Optional[StrictInt] = Field(default=None, description="The total number of elements", alias="totalElements") + total_pages: Optional[StrictInt] = Field(default=None, description="The total number of pages", alias="totalPages") + __properties: ClassVar[List[str]] = ["number", "size", "totalElements", "totalPages"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PageMetadata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PageMetadata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "number": obj.get("number"), + "size": obj.get("size"), + "totalElements": obj.get("totalElements"), + "totalPages": obj.get("totalPages") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/paging.py b/gooddata-api-client/gooddata_api_client/models/paging.py new file mode 100644 index 000000000..8a218c8f6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/paging.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class Paging(BaseModel): + """ + Current page description. + """ # noqa: E501 + count: StrictInt = Field(description="Count of items in this page.") + next: Optional[StrictStr] = Field(default=None, description="Link to next page, or null if this is last page.") + offset: StrictInt = Field(description="Offset of this page.") + total: StrictInt = Field(description="Count of returnable items ignoring paging.") + __properties: ClassVar[List[str]] = ["count", "next", "offset", "total"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Paging from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Paging from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "count": obj.get("count"), + "next": obj.get("next"), + "offset": obj.get("offset"), + "total": obj.get("total") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/parameter.py b/gooddata-api-client/gooddata_api_client/models/parameter.py new file mode 100644 index 000000000..7c37f5ad1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/parameter.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class Parameter(BaseModel): + """ + Parameter + """ # noqa: E501 + name: StrictStr + value: StrictStr + __properties: ClassVar[List[str]] = ["name", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Parameter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Parameter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/pdf_table_style.py b/gooddata-api-client/gooddata_api_client/models/pdf_table_style.py new file mode 100644 index 000000000..213ff2d35 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/pdf_table_style.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.pdf_table_style_property import PdfTableStyleProperty +from typing import Optional, Set +from typing_extensions import Self + +class PdfTableStyle(BaseModel): + """ + Custom CSS styles for the table. (PDF, HTML) + """ # noqa: E501 + properties: Optional[List[PdfTableStyleProperty]] = Field(default=None, description="List of CSS properties.") + selector: StrictStr = Field(description="CSS selector where to apply given properties.") + __properties: ClassVar[List[str]] = ["properties", "selector"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PdfTableStyle from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in properties (list) + _items = [] + if self.properties: + for _item_properties in self.properties: + if _item_properties: + _items.append(_item_properties.to_dict()) + _dict['properties'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PdfTableStyle from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "properties": [PdfTableStyleProperty.from_dict(_item) for _item in obj["properties"]] if obj.get("properties") is not None else None, + "selector": obj.get("selector") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/pdf_table_style_property.py b/gooddata-api-client/gooddata_api_client/models/pdf_table_style_property.py new file mode 100644 index 000000000..bb31d16f9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/pdf_table_style_property.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class PdfTableStyleProperty(BaseModel): + """ + CSS property. + """ # noqa: E501 + key: StrictStr = Field(description="CSS property key.") + value: StrictStr = Field(description="CSS property value.") + __properties: ClassVar[List[str]] = ["key", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PdfTableStyleProperty from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PdfTableStyleProperty from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/pdm_ldm_request.py b/gooddata-api-client/gooddata_api_client/models/pdm_ldm_request.py new file mode 100644 index 000000000..bdca6ad68 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/pdm_ldm_request.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.declarative_table import DeclarativeTable +from gooddata_api_client.models.pdm_sql import PdmSql +from gooddata_api_client.models.table_override import TableOverride +from typing import Optional, Set +from typing_extensions import Self + +class PdmLdmRequest(BaseModel): + """ + PDM additions wrapper. + """ # noqa: E501 + sqls: Optional[List[PdmSql]] = Field(default=None, description="List of SQL datasets.") + table_overrides: Optional[List[TableOverride]] = Field(default=None, description="(BETA) List of table overrides.", alias="tableOverrides") + tables: Optional[List[DeclarativeTable]] = Field(default=None, description="List of physical database tables.") + __properties: ClassVar[List[str]] = ["sqls", "tableOverrides", "tables"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PdmLdmRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in sqls (list) + _items = [] + if self.sqls: + for _item_sqls in self.sqls: + if _item_sqls: + _items.append(_item_sqls.to_dict()) + _dict['sqls'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in table_overrides (list) + _items = [] + if self.table_overrides: + for _item_table_overrides in self.table_overrides: + if _item_table_overrides: + _items.append(_item_table_overrides.to_dict()) + _dict['tableOverrides'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in tables (list) + _items = [] + if self.tables: + for _item_tables in self.tables: + if _item_tables: + _items.append(_item_tables.to_dict()) + _dict['tables'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PdmLdmRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sqls": [PdmSql.from_dict(_item) for _item in obj["sqls"]] if obj.get("sqls") is not None else None, + "tableOverrides": [TableOverride.from_dict(_item) for _item in obj["tableOverrides"]] if obj.get("tableOverrides") is not None else None, + "tables": [DeclarativeTable.from_dict(_item) for _item in obj["tables"]] if obj.get("tables") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/pdm_sql.py b/gooddata-api-client/gooddata_api_client/models/pdm_sql.py new file mode 100644 index 000000000..6b6a8b815 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/pdm_sql.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.sql_column import SqlColumn +from typing import Optional, Set +from typing_extensions import Self + +class PdmSql(BaseModel): + """ + SQL dataset definition. + """ # noqa: E501 + columns: Optional[List[SqlColumn]] = Field(default=None, description="Columns defining SQL dataset.") + statement: StrictStr = Field(description="SQL statement.") + title: StrictStr = Field(description="SQL dataset title.") + __properties: ClassVar[List[str]] = ["columns", "statement", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PdmSql from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in columns (list) + _items = [] + if self.columns: + for _item_columns in self.columns: + if _item_columns: + _items.append(_item_columns.to_dict()) + _dict['columns'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PdmSql from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columns": [SqlColumn.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None, + "statement": obj.get("statement"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/permissions_assignment.py b/gooddata-api-client/gooddata_api_client/models/permissions_assignment.py new file mode 100644 index 000000000..053ee8c8e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/permissions_assignment.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment +from gooddata_api_client.models.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment +from typing import Optional, Set +from typing_extensions import Self + +class PermissionsAssignment(BaseModel): + """ + PermissionsAssignment + """ # noqa: E501 + assignees: List[AssigneeIdentifier] + data_sources: Optional[List[UserManagementDataSourcePermissionAssignment]] = Field(default=None, alias="dataSources") + workspaces: Optional[List[UserManagementWorkspacePermissionAssignment]] = None + __properties: ClassVar[List[str]] = ["assignees", "dataSources", "workspaces"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PermissionsAssignment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in assignees (list) + _items = [] + if self.assignees: + for _item_assignees in self.assignees: + if _item_assignees: + _items.append(_item_assignees.to_dict()) + _dict['assignees'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in data_sources (list) + _items = [] + if self.data_sources: + for _item_data_sources in self.data_sources: + if _item_data_sources: + _items.append(_item_data_sources.to_dict()) + _dict['dataSources'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in workspaces (list) + _items = [] + if self.workspaces: + for _item_workspaces in self.workspaces: + if _item_workspaces: + _items.append(_item_workspaces.to_dict()) + _dict['workspaces'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PermissionsAssignment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assignees": [AssigneeIdentifier.from_dict(_item) for _item in obj["assignees"]] if obj.get("assignees") is not None else None, + "dataSources": [UserManagementDataSourcePermissionAssignment.from_dict(_item) for _item in obj["dataSources"]] if obj.get("dataSources") is not None else None, + "workspaces": [UserManagementWorkspacePermissionAssignment.from_dict(_item) for _item in obj["workspaces"]] if obj.get("workspaces") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/permissions_for_assignee.py b/gooddata-api-client/gooddata_api_client/models/permissions_for_assignee.py new file mode 100644 index 000000000..2aa6a36f2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/permissions_for_assignee.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class PermissionsForAssignee(BaseModel): + """ + Desired levels of permissions for an assignee identified by an identifier. + """ # noqa: E501 + permissions: List[StrictStr] + assignee_identifier: AssigneeIdentifier = Field(alias="assigneeIdentifier") + __properties: ClassVar[List[str]] = ["permissions", "assigneeIdentifier"] + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['EDIT', 'SHARE', 'VIEW']): + raise ValueError("each list item must be one of ('EDIT', 'SHARE', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PermissionsForAssignee from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee_identifier + if self.assignee_identifier: + _dict['assigneeIdentifier'] = self.assignee_identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PermissionsForAssignee from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": obj.get("permissions"), + "assigneeIdentifier": AssigneeIdentifier.from_dict(obj["assigneeIdentifier"]) if obj.get("assigneeIdentifier") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/permissions_for_assignee_rule.py b/gooddata-api-client/gooddata_api_client/models/permissions_for_assignee_rule.py new file mode 100644 index 000000000..5745963c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/permissions_for_assignee_rule.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.assignee_rule import AssigneeRule +from typing import Optional, Set +from typing_extensions import Self + +class PermissionsForAssigneeRule(BaseModel): + """ + Desired levels of permissions for a collection of assignees identified by a rule. + """ # noqa: E501 + permissions: List[StrictStr] + assignee_rule: AssigneeRule = Field(alias="assigneeRule") + __properties: ClassVar[List[str]] = ["permissions", "assigneeRule"] + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['EDIT', 'SHARE', 'VIEW']): + raise ValueError("each list item must be one of ('EDIT', 'SHARE', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PermissionsForAssigneeRule from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee_rule + if self.assignee_rule: + _dict['assigneeRule'] = self.assignee_rule.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PermissionsForAssigneeRule from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": obj.get("permissions"), + "assigneeRule": AssigneeRule.from_dict(obj["assigneeRule"]) if obj.get("assigneeRule") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/platform_usage.py b/gooddata-api-client/gooddata_api_client/models/platform_usage.py new file mode 100644 index 000000000..d4fdb5db5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/platform_usage.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class PlatformUsage(BaseModel): + """ + PlatformUsage + """ # noqa: E501 + count: Optional[StrictInt] = None + name: StrictStr + __properties: ClassVar[List[str]] = ["count", "name"] + + @field_validator('name') + def name_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['UserCount', 'WorkspaceCount']): + raise ValueError("must be one of enum values ('UserCount', 'WorkspaceCount')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlatformUsage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlatformUsage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "count": obj.get("count"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/platform_usage_request.py b/gooddata-api-client/gooddata_api_client/models/platform_usage_request.py new file mode 100644 index 000000000..cee8eec2b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/platform_usage_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class PlatformUsageRequest(BaseModel): + """ + PlatformUsageRequest + """ # noqa: E501 + usage_item_names: List[StrictStr] = Field(alias="usageItemNames") + __properties: ClassVar[List[str]] = ["usageItemNames"] + + @field_validator('usage_item_names') + def usage_item_names_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['UserCount', 'WorkspaceCount']): + raise ValueError("each list item must be one of ('UserCount', 'WorkspaceCount')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlatformUsageRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlatformUsageRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "usageItemNames": obj.get("usageItemNames") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/pop_dataset.py b/gooddata-api-client/gooddata_api_client/models/pop_dataset.py new file mode 100644 index 000000000..bd17ef667 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/pop_dataset.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_object_identifier_dataset import AfmObjectIdentifierDataset +from typing import Optional, Set +from typing_extensions import Self + +class PopDataset(BaseModel): + """ + Combination of the date data set to use and how many periods ago to calculate the previous period for. + """ # noqa: E501 + dataset: AfmObjectIdentifierDataset + periods_ago: StrictInt = Field(description="Number of periods ago to calculate the previous period for.", alias="periodsAgo") + __properties: ClassVar[List[str]] = ["dataset", "periodsAgo"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PopDataset from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dataset + if self.dataset: + _dict['dataset'] = self.dataset.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PopDataset from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataset": AfmObjectIdentifierDataset.from_dict(obj["dataset"]) if obj.get("dataset") is not None else None, + "periodsAgo": obj.get("periodsAgo") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/pop_dataset_measure_definition.py b/gooddata-api-client/gooddata_api_client/models/pop_dataset_measure_definition.py new file mode 100644 index 000000000..7a0ffffa1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/pop_dataset_measure_definition.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.pop_dataset_measure_definition_previous_period_measure import PopDatasetMeasureDefinitionPreviousPeriodMeasure +from typing import Optional, Set +from typing_extensions import Self + +class PopDatasetMeasureDefinition(BaseModel): + """ + Previous period type of metric. + """ # noqa: E501 + previous_period_measure: PopDatasetMeasureDefinitionPreviousPeriodMeasure = Field(alias="previousPeriodMeasure") + __properties: ClassVar[List[str]] = ["previousPeriodMeasure"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PopDatasetMeasureDefinition from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of previous_period_measure + if self.previous_period_measure: + _dict['previousPeriodMeasure'] = self.previous_period_measure.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PopDatasetMeasureDefinition from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "previousPeriodMeasure": PopDatasetMeasureDefinitionPreviousPeriodMeasure.from_dict(obj["previousPeriodMeasure"]) if obj.get("previousPeriodMeasure") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/pop_dataset_measure_definition_previous_period_measure.py b/gooddata-api-client/gooddata_api_client/models/pop_dataset_measure_definition_previous_period_measure.py new file mode 100644 index 000000000..67903b39f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/pop_dataset_measure_definition_previous_period_measure.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_local_identifier import AfmLocalIdentifier +from gooddata_api_client.models.pop_dataset import PopDataset +from typing import Optional, Set +from typing_extensions import Self + +class PopDatasetMeasureDefinitionPreviousPeriodMeasure(BaseModel): + """ + PopDatasetMeasureDefinitionPreviousPeriodMeasure + """ # noqa: E501 + date_datasets: List[PopDataset] = Field(description="Specification of which date data sets to use for determining the period to calculate the previous period for.", alias="dateDatasets") + measure_identifier: AfmLocalIdentifier = Field(alias="measureIdentifier") + __properties: ClassVar[List[str]] = ["dateDatasets", "measureIdentifier"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PopDatasetMeasureDefinitionPreviousPeriodMeasure from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in date_datasets (list) + _items = [] + if self.date_datasets: + for _item_date_datasets in self.date_datasets: + if _item_date_datasets: + _items.append(_item_date_datasets.to_dict()) + _dict['dateDatasets'] = _items + # override the default output from pydantic by calling `to_dict()` of measure_identifier + if self.measure_identifier: + _dict['measureIdentifier'] = self.measure_identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PopDatasetMeasureDefinitionPreviousPeriodMeasure from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dateDatasets": [PopDataset.from_dict(_item) for _item in obj["dateDatasets"]] if obj.get("dateDatasets") is not None else None, + "measureIdentifier": AfmLocalIdentifier.from_dict(obj["measureIdentifier"]) if obj.get("measureIdentifier") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/pop_date.py b/gooddata-api-client/gooddata_api_client/models/pop_date.py new file mode 100644 index 000000000..e1df4841e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/pop_date.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_object_identifier_attribute import AfmObjectIdentifierAttribute +from typing import Optional, Set +from typing_extensions import Self + +class PopDate(BaseModel): + """ + Combination of the date attribute to use and how many periods ago to calculate the PoP for. + """ # noqa: E501 + attribute: AfmObjectIdentifierAttribute + periods_ago: StrictInt = Field(description="Number of periods ago to calculate the previous period for.", alias="periodsAgo") + __properties: ClassVar[List[str]] = ["attribute", "periodsAgo"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PopDate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attribute + if self.attribute: + _dict['attribute'] = self.attribute.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PopDate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attribute": AfmObjectIdentifierAttribute.from_dict(obj["attribute"]) if obj.get("attribute") is not None else None, + "periodsAgo": obj.get("periodsAgo") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/pop_date_measure_definition.py b/gooddata-api-client/gooddata_api_client/models/pop_date_measure_definition.py new file mode 100644 index 000000000..32946d892 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/pop_date_measure_definition.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.pop_date_measure_definition_over_period_measure import PopDateMeasureDefinitionOverPeriodMeasure +from typing import Optional, Set +from typing_extensions import Self + +class PopDateMeasureDefinition(BaseModel): + """ + Period over period type of metric. + """ # noqa: E501 + over_period_measure: PopDateMeasureDefinitionOverPeriodMeasure = Field(alias="overPeriodMeasure") + __properties: ClassVar[List[str]] = ["overPeriodMeasure"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PopDateMeasureDefinition from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of over_period_measure + if self.over_period_measure: + _dict['overPeriodMeasure'] = self.over_period_measure.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PopDateMeasureDefinition from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "overPeriodMeasure": PopDateMeasureDefinitionOverPeriodMeasure.from_dict(obj["overPeriodMeasure"]) if obj.get("overPeriodMeasure") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/pop_date_measure_definition_over_period_measure.py b/gooddata-api-client/gooddata_api_client/models/pop_date_measure_definition_over_period_measure.py new file mode 100644 index 000000000..5033cabdb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/pop_date_measure_definition_over_period_measure.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm_local_identifier import AfmLocalIdentifier +from gooddata_api_client.models.pop_date import PopDate +from typing import Optional, Set +from typing_extensions import Self + +class PopDateMeasureDefinitionOverPeriodMeasure(BaseModel): + """ + PopDateMeasureDefinitionOverPeriodMeasure + """ # noqa: E501 + date_attributes: List[PopDate] = Field(description="Attributes to use for determining the period to calculate the PoP for.", alias="dateAttributes") + measure_identifier: AfmLocalIdentifier = Field(alias="measureIdentifier") + __properties: ClassVar[List[str]] = ["dateAttributes", "measureIdentifier"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PopDateMeasureDefinitionOverPeriodMeasure from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in date_attributes (list) + _items = [] + if self.date_attributes: + for _item_date_attributes in self.date_attributes: + if _item_date_attributes: + _items.append(_item_date_attributes.to_dict()) + _dict['dateAttributes'] = _items + # override the default output from pydantic by calling `to_dict()` of measure_identifier + if self.measure_identifier: + _dict['measureIdentifier'] = self.measure_identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PopDateMeasureDefinitionOverPeriodMeasure from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dateAttributes": [PopDate.from_dict(_item) for _item in obj["dateAttributes"]] if obj.get("dateAttributes") is not None else None, + "measureIdentifier": AfmLocalIdentifier.from_dict(obj["measureIdentifier"]) if obj.get("measureIdentifier") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/pop_measure_definition.py b/gooddata-api-client/gooddata_api_client/models/pop_measure_definition.py new file mode 100644 index 000000000..9a95a0fd5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/pop_measure_definition.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.pop_dataset_measure_definition import PopDatasetMeasureDefinition +from gooddata_api_client.models.pop_date_measure_definition import PopDateMeasureDefinition +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +POPMEASUREDEFINITION_ONE_OF_SCHEMAS = ["PopDatasetMeasureDefinition", "PopDateMeasureDefinition"] + +class PopMeasureDefinition(BaseModel): + """ + PopMeasureDefinition + """ + # data type: PopDatasetMeasureDefinition + oneof_schema_1_validator: Optional[PopDatasetMeasureDefinition] = None + # data type: PopDateMeasureDefinition + oneof_schema_2_validator: Optional[PopDateMeasureDefinition] = None + actual_instance: Optional[Union[PopDatasetMeasureDefinition, PopDateMeasureDefinition]] = None + one_of_schemas: Set[str] = { "PopDatasetMeasureDefinition", "PopDateMeasureDefinition" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = PopMeasureDefinition.model_construct() + error_messages = [] + match = 0 + # validate data type: PopDatasetMeasureDefinition + if not isinstance(v, PopDatasetMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `PopDatasetMeasureDefinition`") + else: + match += 1 + # validate data type: PopDateMeasureDefinition + if not isinstance(v, PopDateMeasureDefinition): + error_messages.append(f"Error! Input type `{type(v)}` is not `PopDateMeasureDefinition`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in PopMeasureDefinition with oneOf schemas: PopDatasetMeasureDefinition, PopDateMeasureDefinition. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in PopMeasureDefinition with oneOf schemas: PopDatasetMeasureDefinition, PopDateMeasureDefinition. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into PopDatasetMeasureDefinition + try: + instance.actual_instance = PopDatasetMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into PopDateMeasureDefinition + try: + instance.actual_instance = PopDateMeasureDefinition.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into PopMeasureDefinition with oneOf schemas: PopDatasetMeasureDefinition, PopDateMeasureDefinition. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into PopMeasureDefinition with oneOf schemas: PopDatasetMeasureDefinition, PopDateMeasureDefinition. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], PopDatasetMeasureDefinition, PopDateMeasureDefinition]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/positive_attribute_filter.py b/gooddata-api-client/gooddata_api_client/models/positive_attribute_filter.py new file mode 100644 index 000000000..29adfa44b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/positive_attribute_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter +from typing import Optional, Set +from typing_extensions import Self + +class PositiveAttributeFilter(BaseModel): + """ + Filter able to limit element values by label and related selected elements. + """ # noqa: E501 + positive_attribute_filter: PositiveAttributeFilterPositiveAttributeFilter = Field(alias="positiveAttributeFilter") + __properties: ClassVar[List[str]] = ["positiveAttributeFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PositiveAttributeFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of positive_attribute_filter + if self.positive_attribute_filter: + _dict['positiveAttributeFilter'] = self.positive_attribute_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PositiveAttributeFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "positiveAttributeFilter": PositiveAttributeFilterPositiveAttributeFilter.from_dict(obj["positiveAttributeFilter"]) if obj.get("positiveAttributeFilter") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/positive_attribute_filter_positive_attribute_filter.py b/gooddata-api-client/gooddata_api_client/models/positive_attribute_filter_positive_attribute_filter.py new file mode 100644 index 000000000..9f3e1c2ae --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/positive_attribute_filter_positive_attribute_filter.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.afm_identifier import AfmIdentifier +from gooddata_api_client.models.attribute_filter_elements import AttributeFilterElements +from typing import Optional, Set +from typing_extensions import Self + +class PositiveAttributeFilterPositiveAttributeFilter(BaseModel): + """ + PositiveAttributeFilterPositiveAttributeFilter + """ # noqa: E501 + apply_on_result: Optional[StrictBool] = Field(default=None, alias="applyOnResult") + var_in: AttributeFilterElements = Field(alias="in") + label: AfmIdentifier + local_identifier: Optional[StrictStr] = Field(default=None, alias="localIdentifier") + __properties: ClassVar[List[str]] = ["applyOnResult", "in", "label", "localIdentifier"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PositiveAttributeFilterPositiveAttributeFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of var_in + if self.var_in: + _dict['in'] = self.var_in.to_dict() + # override the default output from pydantic by calling `to_dict()` of label + if self.label: + _dict['label'] = self.label.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PositiveAttributeFilterPositiveAttributeFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applyOnResult": obj.get("applyOnResult"), + "in": AttributeFilterElements.from_dict(obj["in"]) if obj.get("in") is not None else None, + "label": AfmIdentifier.from_dict(obj["label"]) if obj.get("label") is not None else None, + "localIdentifier": obj.get("localIdentifier") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/quality_issue.py b/gooddata-api-client/gooddata_api_client/models/quality_issue.py new file mode 100644 index 000000000..c06b41ddd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/quality_issue.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.quality_issue_object import QualityIssueObject +from typing import Optional, Set +from typing_extensions import Self + +class QualityIssue(BaseModel): + """ + QualityIssue + """ # noqa: E501 + code: StrictStr + detail: Dict[str, Dict[str, Any]] + objects: List[QualityIssueObject] + severity: StrictStr + __properties: ClassVar[List[str]] = ["code", "detail", "objects", "severity"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QualityIssue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in objects (list) + _items = [] + if self.objects: + for _item_objects in self.objects: + if _item_objects: + _items.append(_item_objects.to_dict()) + _dict['objects'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QualityIssue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "code": obj.get("code"), + "detail": obj.get("detail"), + "objects": [QualityIssueObject.from_dict(_item) for _item in obj["objects"]] if obj.get("objects") is not None else None, + "severity": obj.get("severity") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/quality_issue_object.py b/gooddata-api-client/gooddata_api_client/models/quality_issue_object.py new file mode 100644 index 000000000..ca7eb86ca --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/quality_issue_object.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class QualityIssueObject(BaseModel): + """ + QualityIssueObject + """ # noqa: E501 + id: StrictStr + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QualityIssueObject from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QualityIssueObject from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/range.py b/gooddata-api-client/gooddata_api_client/models/range.py new file mode 100644 index 000000000..555c2381d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/range.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.local_identifier import LocalIdentifier +from gooddata_api_client.models.value import Value +from typing import Optional, Set +from typing_extensions import Self + +class Range(BaseModel): + """ + Range + """ # noqa: E501 + var_from: Value = Field(alias="from") + measure: LocalIdentifier + operator: StrictStr + to: Value + __properties: ClassVar[List[str]] = ["from", "measure", "operator", "to"] + + @field_validator('operator') + def operator_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['BETWEEN', 'NOT_BETWEEN']): + raise ValueError("must be one of enum values ('BETWEEN', 'NOT_BETWEEN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Range from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of var_from + if self.var_from: + _dict['from'] = self.var_from.to_dict() + # override the default output from pydantic by calling `to_dict()` of measure + if self.measure: + _dict['measure'] = self.measure.to_dict() + # override the default output from pydantic by calling `to_dict()` of to + if self.to: + _dict['to'] = self.to.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Range from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "from": Value.from_dict(obj["from"]) if obj.get("from") is not None else None, + "measure": LocalIdentifier.from_dict(obj["measure"]) if obj.get("measure") is not None else None, + "operator": obj.get("operator"), + "to": Value.from_dict(obj["to"]) if obj.get("to") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/range_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/models/range_measure_value_filter.py new file mode 100644 index 000000000..f74af4d02 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/range_measure_value_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter +from typing import Optional, Set +from typing_extensions import Self + +class RangeMeasureValueFilter(BaseModel): + """ + Filter the result by comparing specified metric to given range of values. + """ # noqa: E501 + range_measure_value_filter: RangeMeasureValueFilterRangeMeasureValueFilter = Field(alias="rangeMeasureValueFilter") + __properties: ClassVar[List[str]] = ["rangeMeasureValueFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RangeMeasureValueFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of range_measure_value_filter + if self.range_measure_value_filter: + _dict['rangeMeasureValueFilter'] = self.range_measure_value_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RangeMeasureValueFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "rangeMeasureValueFilter": RangeMeasureValueFilterRangeMeasureValueFilter.from_dict(obj["rangeMeasureValueFilter"]) if obj.get("rangeMeasureValueFilter") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/range_measure_value_filter_range_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/models/range_measure_value_filter_range_measure_value_filter.py new file mode 100644 index 000000000..b59b5df4e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/range_measure_value_filter_range_measure_value_filter.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from gooddata_api_client.models.afm_identifier import AfmIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class RangeMeasureValueFilterRangeMeasureValueFilter(BaseModel): + """ + RangeMeasureValueFilterRangeMeasureValueFilter + """ # noqa: E501 + apply_on_result: Optional[StrictBool] = Field(default=None, alias="applyOnResult") + dimensionality: Optional[List[AfmIdentifier]] = Field(default=None, description="References to the attributes to be used when filtering.") + var_from: Union[StrictFloat, StrictInt] = Field(alias="from") + local_identifier: Optional[StrictStr] = Field(default=None, alias="localIdentifier") + measure: AfmIdentifier + operator: StrictStr + to: Union[StrictFloat, StrictInt] + treat_null_values_as: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="A value that will be substituted for null values in the metric for the comparisons.", alias="treatNullValuesAs") + __properties: ClassVar[List[str]] = ["applyOnResult", "dimensionality", "from", "localIdentifier", "measure", "operator", "to", "treatNullValuesAs"] + + @field_validator('operator') + def operator_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['BETWEEN', 'NOT_BETWEEN']): + raise ValueError("must be one of enum values ('BETWEEN', 'NOT_BETWEEN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RangeMeasureValueFilterRangeMeasureValueFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensionality (list) + _items = [] + if self.dimensionality: + for _item_dimensionality in self.dimensionality: + if _item_dimensionality: + _items.append(_item_dimensionality.to_dict()) + _dict['dimensionality'] = _items + # override the default output from pydantic by calling `to_dict()` of measure + if self.measure: + _dict['measure'] = self.measure.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RangeMeasureValueFilterRangeMeasureValueFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applyOnResult": obj.get("applyOnResult"), + "dimensionality": [AfmIdentifier.from_dict(_item) for _item in obj["dimensionality"]] if obj.get("dimensionality") is not None else None, + "from": obj.get("from"), + "localIdentifier": obj.get("localIdentifier"), + "measure": AfmIdentifier.from_dict(obj["measure"]) if obj.get("measure") is not None else None, + "operator": obj.get("operator"), + "to": obj.get("to"), + "treatNullValuesAs": obj.get("treatNullValuesAs") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/range_wrapper.py b/gooddata-api-client/gooddata_api_client/models/range_wrapper.py new file mode 100644 index 000000000..1601964ed --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/range_wrapper.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.range import Range +from typing import Optional, Set +from typing_extensions import Self + +class RangeWrapper(BaseModel): + """ + RangeWrapper + """ # noqa: E501 + range: Range + __properties: ClassVar[List[str]] = ["range"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RangeWrapper from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of range + if self.range: + _dict['range'] = self.range.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RangeWrapper from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "range": Range.from_dict(obj["range"]) if obj.get("range") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/ranking_filter.py b/gooddata-api-client/gooddata_api_client/models/ranking_filter.py new file mode 100644 index 000000000..903ff2a6b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/ranking_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.ranking_filter_ranking_filter import RankingFilterRankingFilter +from typing import Optional, Set +from typing_extensions import Self + +class RankingFilter(BaseModel): + """ + Filter the result on top/bottom N values according to given metric(s). + """ # noqa: E501 + ranking_filter: RankingFilterRankingFilter = Field(alias="rankingFilter") + __properties: ClassVar[List[str]] = ["rankingFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RankingFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of ranking_filter + if self.ranking_filter: + _dict['rankingFilter'] = self.ranking_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RankingFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "rankingFilter": RankingFilterRankingFilter.from_dict(obj["rankingFilter"]) if obj.get("rankingFilter") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/ranking_filter_ranking_filter.py b/gooddata-api-client/gooddata_api_client/models/ranking_filter_ranking_filter.py new file mode 100644 index 000000000..1755707a3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/ranking_filter_ranking_filter.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.afm_identifier import AfmIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class RankingFilterRankingFilter(BaseModel): + """ + RankingFilterRankingFilter + """ # noqa: E501 + apply_on_result: Optional[StrictBool] = Field(default=None, alias="applyOnResult") + dimensionality: Optional[List[AfmIdentifier]] = Field(default=None, description="References to the attributes to be used when filtering.") + local_identifier: Optional[StrictStr] = Field(default=None, alias="localIdentifier") + measures: List[AfmIdentifier] = Field(description="References to the metrics to be used when filtering.") + operator: StrictStr = Field(description="The type of ranking to use, TOP or BOTTOM.") + value: StrictInt = Field(description="Number of top/bottom values to filter.") + __properties: ClassVar[List[str]] = ["applyOnResult", "dimensionality", "localIdentifier", "measures", "operator", "value"] + + @field_validator('operator') + def operator_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['TOP', 'BOTTOM']): + raise ValueError("must be one of enum values ('TOP', 'BOTTOM')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RankingFilterRankingFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensionality (list) + _items = [] + if self.dimensionality: + for _item_dimensionality in self.dimensionality: + if _item_dimensionality: + _items.append(_item_dimensionality.to_dict()) + _dict['dimensionality'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in measures (list) + _items = [] + if self.measures: + for _item_measures in self.measures: + if _item_measures: + _items.append(_item_measures.to_dict()) + _dict['measures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RankingFilterRankingFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applyOnResult": obj.get("applyOnResult"), + "dimensionality": [AfmIdentifier.from_dict(_item) for _item in obj["dimensionality"]] if obj.get("dimensionality") is not None else None, + "localIdentifier": obj.get("localIdentifier"), + "measures": [AfmIdentifier.from_dict(_item) for _item in obj["measures"]] if obj.get("measures") is not None else None, + "operator": obj.get("operator"), + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/raw_custom_label.py b/gooddata-api-client/gooddata_api_client/models/raw_custom_label.py new file mode 100644 index 000000000..766eab43d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/raw_custom_label.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class RawCustomLabel(BaseModel): + """ + Custom label object override. + """ # noqa: E501 + title: StrictStr = Field(description="Override value.") + __properties: ClassVar[List[str]] = ["title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RawCustomLabel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RawCustomLabel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/raw_custom_metric.py b/gooddata-api-client/gooddata_api_client/models/raw_custom_metric.py new file mode 100644 index 000000000..8f9bc0656 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/raw_custom_metric.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class RawCustomMetric(BaseModel): + """ + Custom metric object override. + """ # noqa: E501 + title: StrictStr = Field(description="Metric title override.") + __properties: ClassVar[List[str]] = ["title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RawCustomMetric from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RawCustomMetric from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/raw_custom_override.py b/gooddata-api-client/gooddata_api_client/models/raw_custom_override.py new file mode 100644 index 000000000..e92d2f25f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/raw_custom_override.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.raw_custom_label import RawCustomLabel +from gooddata_api_client.models.raw_custom_metric import RawCustomMetric +from typing import Optional, Set +from typing_extensions import Self + +class RawCustomOverride(BaseModel): + """ + Custom cell value overrides (IDs will be replaced with specified values). + """ # noqa: E501 + labels: Optional[Dict[str, RawCustomLabel]] = Field(default=None, description="Map of CustomLabels with keys used as placeholders in export result.") + metrics: Optional[Dict[str, RawCustomMetric]] = Field(default=None, description="Map of CustomMetrics with keys used as placeholders in export result.") + __properties: ClassVar[List[str]] = ["labels", "metrics"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RawCustomOverride from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each value in labels (dict) + _field_dict = {} + if self.labels: + for _key_labels in self.labels: + if self.labels[_key_labels]: + _field_dict[_key_labels] = self.labels[_key_labels].to_dict() + _dict['labels'] = _field_dict + # override the default output from pydantic by calling `to_dict()` of each value in metrics (dict) + _field_dict = {} + if self.metrics: + for _key_metrics in self.metrics: + if self.metrics[_key_metrics]: + _field_dict[_key_metrics] = self.metrics[_key_metrics].to_dict() + _dict['metrics'] = _field_dict + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RawCustomOverride from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "labels": dict( + (_k, RawCustomLabel.from_dict(_v)) + for _k, _v in obj["labels"].items() + ) + if obj.get("labels") is not None + else None, + "metrics": dict( + (_k, RawCustomMetric.from_dict(_v)) + for _k, _v in obj["metrics"].items() + ) + if obj.get("metrics") is not None + else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/raw_export_automation_request.py b/gooddata-api-client/gooddata_api_client/models/raw_export_automation_request.py new file mode 100644 index 000000000..982315d5e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/raw_export_automation_request.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.afm import AFM +from gooddata_api_client.models.execution_settings import ExecutionSettings +from gooddata_api_client.models.raw_custom_override import RawCustomOverride +from typing import Optional, Set +from typing_extensions import Self + +class RawExportAutomationRequest(BaseModel): + """ + Export request object describing the export properties and overrides for raw exports. + """ # noqa: E501 + custom_override: Optional[RawCustomOverride] = Field(default=None, alias="customOverride") + execution: AFM + execution_settings: Optional[ExecutionSettings] = Field(default=None, alias="executionSettings") + file_name: StrictStr = Field(description="Filename of downloaded file without extension.", alias="fileName") + format: StrictStr = Field(description="Requested resulting file type.") + metadata: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON object") + __properties: ClassVar[List[str]] = ["customOverride", "execution", "executionSettings", "fileName", "format", "metadata"] + + @field_validator('format') + def format_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['ARROW_FILE', 'ARROW_STREAM', 'CSV']): + raise ValueError("must be one of enum values ('ARROW_FILE', 'ARROW_STREAM', 'CSV')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RawExportAutomationRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of custom_override + if self.custom_override: + _dict['customOverride'] = self.custom_override.to_dict() + # override the default output from pydantic by calling `to_dict()` of execution + if self.execution: + _dict['execution'] = self.execution.to_dict() + # override the default output from pydantic by calling `to_dict()` of execution_settings + if self.execution_settings: + _dict['executionSettings'] = self.execution_settings.to_dict() + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RawExportAutomationRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "customOverride": RawCustomOverride.from_dict(obj["customOverride"]) if obj.get("customOverride") is not None else None, + "execution": AFM.from_dict(obj["execution"]) if obj.get("execution") is not None else None, + "executionSettings": ExecutionSettings.from_dict(obj["executionSettings"]) if obj.get("executionSettings") is not None else None, + "fileName": obj.get("fileName"), + "format": obj.get("format"), + "metadata": obj.get("metadata") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/raw_export_request.py b/gooddata-api-client/gooddata_api_client/models/raw_export_request.py new file mode 100644 index 000000000..0cf255712 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/raw_export_request.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.afm import AFM +from gooddata_api_client.models.execution_settings import ExecutionSettings +from gooddata_api_client.models.raw_custom_override import RawCustomOverride +from typing import Optional, Set +from typing_extensions import Self + +class RawExportRequest(BaseModel): + """ + Export request object describing the export properties and overrides for raw exports. + """ # noqa: E501 + custom_override: Optional[RawCustomOverride] = Field(default=None, alias="customOverride") + execution: AFM + execution_settings: Optional[ExecutionSettings] = Field(default=None, alias="executionSettings") + file_name: StrictStr = Field(description="Filename of downloaded file without extension.", alias="fileName") + format: StrictStr = Field(description="Requested resulting file type.") + __properties: ClassVar[List[str]] = ["customOverride", "execution", "executionSettings", "fileName", "format"] + + @field_validator('format') + def format_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['ARROW_FILE', 'ARROW_STREAM', 'CSV']): + raise ValueError("must be one of enum values ('ARROW_FILE', 'ARROW_STREAM', 'CSV')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RawExportRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of custom_override + if self.custom_override: + _dict['customOverride'] = self.custom_override.to_dict() + # override the default output from pydantic by calling `to_dict()` of execution + if self.execution: + _dict['execution'] = self.execution.to_dict() + # override the default output from pydantic by calling `to_dict()` of execution_settings + if self.execution_settings: + _dict['executionSettings'] = self.execution_settings.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RawExportRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "customOverride": RawCustomOverride.from_dict(obj["customOverride"]) if obj.get("customOverride") is not None else None, + "execution": AFM.from_dict(obj["execution"]) if obj.get("execution") is not None else None, + "executionSettings": ExecutionSettings.from_dict(obj["executionSettings"]) if obj.get("executionSettings") is not None else None, + "fileName": obj.get("fileName"), + "format": obj.get("format") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/reference_identifier.py b/gooddata-api-client/gooddata_api_client/models/reference_identifier.py new file mode 100644 index 000000000..620dbc94b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/reference_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class ReferenceIdentifier(BaseModel): + """ + A reference identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Reference ID.") + type: StrictStr = Field(description="A type of the reference.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['dataset']): + raise ValueError("must be one of enum values ('dataset')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ReferenceIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ReferenceIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/reference_source_column.py b/gooddata-api-client/gooddata_api_client/models/reference_source_column.py new file mode 100644 index 000000000..f3d125585 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/reference_source_column.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.dataset_grain import DatasetGrain +from typing import Optional, Set +from typing_extensions import Self + +class ReferenceSourceColumn(BaseModel): + """ + ReferenceSourceColumn + """ # noqa: E501 + column: StrictStr + data_type: Optional[StrictStr] = Field(default=None, alias="dataType") + target: DatasetGrain + __properties: ClassVar[List[str]] = ["column", "dataType", "target"] + + @field_validator('data_type') + def data_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ReferenceSourceColumn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of target + if self.target: + _dict['target'] = self.target.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ReferenceSourceColumn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "column": obj.get("column"), + "dataType": obj.get("dataType"), + "target": DatasetGrain.from_dict(obj["target"]) if obj.get("target") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/relative.py b/gooddata-api-client/gooddata_api_client/models/relative.py new file mode 100644 index 000000000..6270f61ef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/relative.py @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.arithmetic_measure import ArithmeticMeasure +from gooddata_api_client.models.value import Value +from typing import Optional, Set +from typing_extensions import Self + +class Relative(BaseModel): + """ + Relative + """ # noqa: E501 + measure: ArithmeticMeasure + operator: StrictStr = Field(description="Relative condition operator. INCREASES_BY - the metric increases by the specified value. DECREASES_BY - the metric decreases by the specified value. CHANGES_BY - the metric increases or decreases by the specified value. ") + threshold: Value + __properties: ClassVar[List[str]] = ["measure", "operator", "threshold"] + + @field_validator('operator') + def operator_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['INCREASES_BY', 'DECREASES_BY', 'CHANGES_BY']): + raise ValueError("must be one of enum values ('INCREASES_BY', 'DECREASES_BY', 'CHANGES_BY')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Relative from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of measure + if self.measure: + _dict['measure'] = self.measure.to_dict() + # override the default output from pydantic by calling `to_dict()` of threshold + if self.threshold: + _dict['threshold'] = self.threshold.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Relative from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "measure": ArithmeticMeasure.from_dict(obj["measure"]) if obj.get("measure") is not None else None, + "operator": obj.get("operator"), + "threshold": Value.from_dict(obj["threshold"]) if obj.get("threshold") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/relative_bounded_date_filter.py b/gooddata-api-client/gooddata_api_client/models/relative_bounded_date_filter.py new file mode 100644 index 000000000..6c8ed1994 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/relative_bounded_date_filter.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class RelativeBoundedDateFilter(BaseModel): + """ + RelativeBoundedDateFilter + """ # noqa: E501 + var_from: Optional[StrictInt] = Field(default=None, alias="from") + granularity: StrictStr + to: Optional[StrictInt] = None + __properties: ClassVar[List[str]] = ["from", "granularity", "to"] + + @field_validator('granularity') + def granularity_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['ALL_TIME_GRANULARITY', 'GDC.time.year', 'GDC.time.week_us', 'GDC.time.week_in_year', 'GDC.time.week_in_quarter', 'GDC.time.week', 'GDC.time.euweek_in_year', 'GDC.time.euweek_in_quarter', 'GDC.time.quarter', 'GDC.time.quarter_in_year', 'GDC.time.month', 'GDC.time.month_in_quarter', 'GDC.time.month_in_year', 'GDC.time.day_in_year', 'GDC.time.day_in_quarter', 'GDC.time.day_in_month', 'GDC.time.day_in_week', 'GDC.time.day_in_euweek', 'GDC.time.date', 'GDC.time.hour', 'GDC.time.hour_in_day', 'GDC.time.minute', 'GDC.time.minute_in_hour']): + raise ValueError("must be one of enum values ('ALL_TIME_GRANULARITY', 'GDC.time.year', 'GDC.time.week_us', 'GDC.time.week_in_year', 'GDC.time.week_in_quarter', 'GDC.time.week', 'GDC.time.euweek_in_year', 'GDC.time.euweek_in_quarter', 'GDC.time.quarter', 'GDC.time.quarter_in_year', 'GDC.time.month', 'GDC.time.month_in_quarter', 'GDC.time.month_in_year', 'GDC.time.day_in_year', 'GDC.time.day_in_quarter', 'GDC.time.day_in_month', 'GDC.time.day_in_week', 'GDC.time.day_in_euweek', 'GDC.time.date', 'GDC.time.hour', 'GDC.time.hour_in_day', 'GDC.time.minute', 'GDC.time.minute_in_hour')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RelativeBoundedDateFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RelativeBoundedDateFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "from": obj.get("from"), + "granularity": obj.get("granularity"), + "to": obj.get("to") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/relative_date_filter.py b/gooddata-api-client/gooddata_api_client/models/relative_date_filter.py new file mode 100644 index 000000000..3392fd601 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/relative_date_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter +from typing import Optional, Set +from typing_extensions import Self + +class RelativeDateFilter(BaseModel): + """ + A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both. + """ # noqa: E501 + relative_date_filter: RelativeDateFilterRelativeDateFilter = Field(alias="relativeDateFilter") + __properties: ClassVar[List[str]] = ["relativeDateFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RelativeDateFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of relative_date_filter + if self.relative_date_filter: + _dict['relativeDateFilter'] = self.relative_date_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RelativeDateFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "relativeDateFilter": RelativeDateFilterRelativeDateFilter.from_dict(obj["relativeDateFilter"]) if obj.get("relativeDateFilter") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/relative_date_filter_relative_date_filter.py b/gooddata-api-client/gooddata_api_client/models/relative_date_filter_relative_date_filter.py new file mode 100644 index 000000000..6e1aa12ea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/relative_date_filter_relative_date_filter.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.afm_object_identifier_dataset import AfmObjectIdentifierDataset +from gooddata_api_client.models.bounded_filter import BoundedFilter +from typing import Optional, Set +from typing_extensions import Self + +class RelativeDateFilterRelativeDateFilter(BaseModel): + """ + RelativeDateFilterRelativeDateFilter + """ # noqa: E501 + apply_on_result: Optional[StrictBool] = Field(default=None, alias="applyOnResult") + bounded_filter: Optional[BoundedFilter] = Field(default=None, alias="boundedFilter") + dataset: AfmObjectIdentifierDataset + var_from: StrictInt = Field(description="Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", alias="from") + granularity: StrictStr = Field(description="Date granularity specifying particular date attribute in given dimension.") + local_identifier: Optional[StrictStr] = Field(default=None, alias="localIdentifier") + to: StrictInt = Field(description="End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).") + __properties: ClassVar[List[str]] = ["applyOnResult", "boundedFilter", "dataset", "from", "granularity", "localIdentifier", "to"] + + @field_validator('granularity') + def granularity_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR']): + raise ValueError("must be one of enum values ('MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', 'MINUTE_OF_HOUR', 'HOUR_OF_DAY', 'DAY_OF_WEEK', 'DAY_OF_MONTH', 'DAY_OF_QUARTER', 'DAY_OF_YEAR', 'WEEK_OF_YEAR', 'MONTH_OF_YEAR', 'QUARTER_OF_YEAR')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RelativeDateFilterRelativeDateFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of bounded_filter + if self.bounded_filter: + _dict['boundedFilter'] = self.bounded_filter.to_dict() + # override the default output from pydantic by calling `to_dict()` of dataset + if self.dataset: + _dict['dataset'] = self.dataset.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RelativeDateFilterRelativeDateFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applyOnResult": obj.get("applyOnResult"), + "boundedFilter": BoundedFilter.from_dict(obj["boundedFilter"]) if obj.get("boundedFilter") is not None else None, + "dataset": AfmObjectIdentifierDataset.from_dict(obj["dataset"]) if obj.get("dataset") is not None else None, + "from": obj.get("from"), + "granularity": obj.get("granularity"), + "localIdentifier": obj.get("localIdentifier"), + "to": obj.get("to") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/relative_wrapper.py b/gooddata-api-client/gooddata_api_client/models/relative_wrapper.py new file mode 100644 index 000000000..46f3ca1c3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/relative_wrapper.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.relative import Relative +from typing import Optional, Set +from typing_extensions import Self + +class RelativeWrapper(BaseModel): + """ + RelativeWrapper + """ # noqa: E501 + relative: Relative + __properties: ClassVar[List[str]] = ["relative"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RelativeWrapper from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of relative + if self.relative: + _dict['relative'] = self.relative.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RelativeWrapper from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "relative": Relative.from_dict(obj["relative"]) if obj.get("relative") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/resolve_settings_request.py b/gooddata-api-client/gooddata_api_client/models/resolve_settings_request.py new file mode 100644 index 000000000..3201a157e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/resolve_settings_request.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ResolveSettingsRequest(BaseModel): + """ + A request containing setting IDs to resolve. + """ # noqa: E501 + settings: List[StrictStr] = Field(description="An array of setting IDs to resolve.") + __properties: ClassVar[List[str]] = ["settings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ResolveSettingsRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ResolveSettingsRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "settings": obj.get("settings") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/resolved_llm_endpoint.py b/gooddata-api-client/gooddata_api_client/models/resolved_llm_endpoint.py new file mode 100644 index 000000000..4009ae2b7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/resolved_llm_endpoint.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ResolvedLlmEndpoint(BaseModel): + """ + ResolvedLlmEndpoint + """ # noqa: E501 + id: StrictStr = Field(description="Endpoint Id") + title: StrictStr = Field(description="Endpoint Title") + __properties: ClassVar[List[str]] = ["id", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ResolvedLlmEndpoint from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ResolvedLlmEndpoint from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/resolved_llm_endpoints.py b/gooddata-api-client/gooddata_api_client/models/resolved_llm_endpoints.py new file mode 100644 index 000000000..69495ac54 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/resolved_llm_endpoints.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.resolved_llm_endpoint import ResolvedLlmEndpoint +from typing import Optional, Set +from typing_extensions import Self + +class ResolvedLlmEndpoints(BaseModel): + """ + ResolvedLlmEndpoints + """ # noqa: E501 + data: List[ResolvedLlmEndpoint] + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ResolvedLlmEndpoints from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ResolvedLlmEndpoints from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [ResolvedLlmEndpoint.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/resolved_setting.py b/gooddata-api-client/gooddata_api_client/models/resolved_setting.py new file mode 100644 index 000000000..8bd905c6f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/resolved_setting.py @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ResolvedSetting(BaseModel): + """ + Setting and its value. + """ # noqa: E501 + content: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON object") + id: StrictStr = Field(description="Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type.") + type: Optional[StrictStr] = Field(default=None, description="Type of the setting.") + __properties: ClassVar[List[str]] = ["content", "id", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TIMEZONE', 'ACTIVE_THEME', 'ACTIVE_COLOR_PALETTE', 'ACTIVE_LLM_ENDPOINT', 'WHITE_LABELING', 'LOCALE', 'METADATA_LOCALE', 'FORMAT_LOCALE', 'MAPBOX_TOKEN', 'AG_GRID_TOKEN', 'WEEK_START', 'SHOW_HIDDEN_CATALOG_ITEMS', 'OPERATOR_OVERRIDES', 'TIMEZONE_VALIDATION_ENABLED', 'OPENAI_CONFIG', 'ENABLE_FILE_ANALYTICS', 'ALERT', 'SEPARATORS', 'DATE_FILTER_CONFIG', 'JIT_PROVISIONING', 'JWT_JIT_PROVISIONING', 'DASHBOARD_FILTERS_APPLY_MODE', 'ENABLE_SLIDES_EXPORT', 'AI_RATE_LIMIT', 'ATTACHMENT_SIZE_LIMIT', 'ATTACHMENT_LINK_TTL', 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE', 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS', 'ENABLE_AUTOMATION_EVALUATION_MODE', 'REGISTERED_PLUGGABLE_APPLICATIONS']): + raise ValueError("must be one of enum values ('TIMEZONE', 'ACTIVE_THEME', 'ACTIVE_COLOR_PALETTE', 'ACTIVE_LLM_ENDPOINT', 'WHITE_LABELING', 'LOCALE', 'METADATA_LOCALE', 'FORMAT_LOCALE', 'MAPBOX_TOKEN', 'AG_GRID_TOKEN', 'WEEK_START', 'SHOW_HIDDEN_CATALOG_ITEMS', 'OPERATOR_OVERRIDES', 'TIMEZONE_VALIDATION_ENABLED', 'OPENAI_CONFIG', 'ENABLE_FILE_ANALYTICS', 'ALERT', 'SEPARATORS', 'DATE_FILTER_CONFIG', 'JIT_PROVISIONING', 'JWT_JIT_PROVISIONING', 'DASHBOARD_FILTERS_APPLY_MODE', 'ENABLE_SLIDES_EXPORT', 'AI_RATE_LIMIT', 'ATTACHMENT_SIZE_LIMIT', 'ATTACHMENT_LINK_TTL', 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE', 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS', 'ENABLE_AUTOMATION_EVALUATION_MODE', 'REGISTERED_PLUGGABLE_APPLICATIONS')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ResolvedSetting from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ResolvedSetting from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/rest_api_identifier.py b/gooddata-api-client/gooddata_api_client/models/rest_api_identifier.py new file mode 100644 index 000000000..682fcae71 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/rest_api_identifier.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class RestApiIdentifier(BaseModel): + """ + Object identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] + type: StrictStr + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RestApiIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RestApiIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/result_cache_metadata.py b/gooddata-api-client/gooddata_api_client/models/result_cache_metadata.py new file mode 100644 index 000000000..b438f088d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/result_cache_metadata.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.afm import AFM +from gooddata_api_client.models.execution_response import ExecutionResponse +from gooddata_api_client.models.result_spec import ResultSpec +from typing import Optional, Set +from typing_extensions import Self + +class ResultCacheMetadata(BaseModel): + """ + All execution result's metadata used for calculation including ExecutionResponse + """ # noqa: E501 + afm: AFM + execution_response: ExecutionResponse = Field(alias="executionResponse") + result_size: StrictInt = Field(alias="resultSize") + result_spec: ResultSpec = Field(alias="resultSpec") + __properties: ClassVar[List[str]] = ["afm", "executionResponse", "resultSize", "resultSpec"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ResultCacheMetadata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of afm + if self.afm: + _dict['afm'] = self.afm.to_dict() + # override the default output from pydantic by calling `to_dict()` of execution_response + if self.execution_response: + _dict['executionResponse'] = self.execution_response.to_dict() + # override the default output from pydantic by calling `to_dict()` of result_spec + if self.result_spec: + _dict['resultSpec'] = self.result_spec.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ResultCacheMetadata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "afm": AFM.from_dict(obj["afm"]) if obj.get("afm") is not None else None, + "executionResponse": ExecutionResponse.from_dict(obj["executionResponse"]) if obj.get("executionResponse") is not None else None, + "resultSize": obj.get("resultSize"), + "resultSpec": ResultSpec.from_dict(obj["resultSpec"]) if obj.get("resultSpec") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/result_dimension.py b/gooddata-api-client/gooddata_api_client/models/result_dimension.py new file mode 100644 index 000000000..91b01ed74 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/result_dimension.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.result_dimension_header import ResultDimensionHeader +from typing import Optional, Set +from typing_extensions import Self + +class ResultDimension(BaseModel): + """ + Single result dimension + """ # noqa: E501 + headers: List[ResultDimensionHeader] + local_identifier: StrictStr = Field(description="Local identifier of the dimension.", alias="localIdentifier") + __properties: ClassVar[List[str]] = ["headers", "localIdentifier"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ResultDimension from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in headers (list) + _items = [] + if self.headers: + for _item_headers in self.headers: + if _item_headers: + _items.append(_item_headers.to_dict()) + _dict['headers'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ResultDimension from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "headers": [ResultDimensionHeader.from_dict(_item) for _item in obj["headers"]] if obj.get("headers") is not None else None, + "localIdentifier": obj.get("localIdentifier") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/result_dimension_header.py b/gooddata-api-client/gooddata_api_client/models/result_dimension_header.py new file mode 100644 index 000000000..39c2ed5f7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/result_dimension_header.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.attribute_header import AttributeHeader +from gooddata_api_client.models.measure_group_headers import MeasureGroupHeaders +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +RESULTDIMENSIONHEADER_ONE_OF_SCHEMAS = ["AttributeHeader", "MeasureGroupHeaders"] + +class ResultDimensionHeader(BaseModel): + """ + One of the headers in a result dimension. + """ + # data type: MeasureGroupHeaders + oneof_schema_1_validator: Optional[MeasureGroupHeaders] = None + # data type: AttributeHeader + oneof_schema_2_validator: Optional[AttributeHeader] = None + actual_instance: Optional[Union[AttributeHeader, MeasureGroupHeaders]] = None + one_of_schemas: Set[str] = { "AttributeHeader", "MeasureGroupHeaders" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = ResultDimensionHeader.model_construct() + error_messages = [] + match = 0 + # validate data type: MeasureGroupHeaders + if not isinstance(v, MeasureGroupHeaders): + error_messages.append(f"Error! Input type `{type(v)}` is not `MeasureGroupHeaders`") + else: + match += 1 + # validate data type: AttributeHeader + if not isinstance(v, AttributeHeader): + error_messages.append(f"Error! Input type `{type(v)}` is not `AttributeHeader`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in ResultDimensionHeader with oneOf schemas: AttributeHeader, MeasureGroupHeaders. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in ResultDimensionHeader with oneOf schemas: AttributeHeader, MeasureGroupHeaders. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into MeasureGroupHeaders + try: + instance.actual_instance = MeasureGroupHeaders.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into AttributeHeader + try: + instance.actual_instance = AttributeHeader.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into ResultDimensionHeader with oneOf schemas: AttributeHeader, MeasureGroupHeaders. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into ResultDimensionHeader with oneOf schemas: AttributeHeader, MeasureGroupHeaders. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], AttributeHeader, MeasureGroupHeaders]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/result_spec.py b/gooddata-api-client/gooddata_api_client/models/result_spec.py new file mode 100644 index 000000000..9da41c20c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/result_spec.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.dimension import Dimension +from gooddata_api_client.models.total import Total +from typing import Optional, Set +from typing_extensions import Self + +class ResultSpec(BaseModel): + """ + Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```). + """ # noqa: E501 + dimensions: List[Dimension] + totals: Optional[List[Total]] = None + __properties: ClassVar[List[str]] = ["dimensions", "totals"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ResultSpec from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensions (list) + _items = [] + if self.dimensions: + for _item_dimensions in self.dimensions: + if _item_dimensions: + _items.append(_item_dimensions.to_dict()) + _dict['dimensions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in totals (list) + _items = [] + if self.totals: + for _item_totals in self.totals: + if _item_totals: + _items.append(_item_totals.to_dict()) + _dict['totals'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ResultSpec from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensions": [Dimension.from_dict(_item) for _item in obj["dimensions"]] if obj.get("dimensions") is not None else None, + "totals": [Total.from_dict(_item) for _item in obj["totals"]] if obj.get("totals") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/route_result.py b/gooddata-api-client/gooddata_api_client/models/route_result.py new file mode 100644 index 000000000..0d8df8310 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/route_result.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class RouteResult(BaseModel): + """ + Question -> Use Case routing. May contain final answer is a special use case is not required. + """ # noqa: E501 + reasoning: StrictStr = Field(description="Explanation why LLM picked this use case.") + use_case: StrictStr = Field(description="Use case where LLM routed based on question.", alias="useCase") + __properties: ClassVar[List[str]] = ["reasoning", "useCase"] + + @field_validator('use_case') + def use_case_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['INVALID', 'GENERAL', 'SEARCH', 'CREATE_VISUALIZATION', 'EXTEND_VISUALIZATION', 'HOWTO']): + raise ValueError("must be one of enum values ('INVALID', 'GENERAL', 'SEARCH', 'CREATE_VISUALIZATION', 'EXTEND_VISUALIZATION', 'HOWTO')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RouteResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RouteResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "reasoning": obj.get("reasoning"), + "useCase": obj.get("useCase") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/rsa_specification.py b/gooddata-api-client/gooddata_api_client/models/rsa_specification.py new file mode 100644 index 000000000..4a10ec37b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/rsa_specification.py @@ -0,0 +1,131 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class RsaSpecification(BaseModel): + """ + RsaSpecification + """ # noqa: E501 + alg: StrictStr + e: StrictStr + kid: Annotated[str, Field(min_length=0, strict=True, max_length=255)] + kty: StrictStr + n: StrictStr + use: StrictStr + x5c: Optional[List[StrictStr]] = None + x5t: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["alg", "e", "kid", "kty", "n", "use", "x5c", "x5t"] + + @field_validator('alg') + def alg_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['RS256', 'RS384', 'RS512']): + raise ValueError("must be one of enum values ('RS256', 'RS384', 'RS512')") + return value + + @field_validator('kid') + def kid_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[^.]", value): + raise ValueError(r"must validate the regular expression /^[^.]/") + return value + + @field_validator('kty') + def kty_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['RSA']): + raise ValueError("must be one of enum values ('RSA')") + return value + + @field_validator('use') + def use_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['sig']): + raise ValueError("must be one of enum values ('sig')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RsaSpecification from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RsaSpecification from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "alg": obj.get("alg"), + "e": obj.get("e"), + "kid": obj.get("kid"), + "kty": obj.get("kty"), + "n": obj.get("n"), + "use": obj.get("use"), + "x5c": obj.get("x5c"), + "x5t": obj.get("x5t") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/rule_permission.py b/gooddata-api-client/gooddata_api_client/models/rule_permission.py new file mode 100644 index 000000000..3aee474bf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/rule_permission.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.granted_permission import GrantedPermission +from typing import Optional, Set +from typing_extensions import Self + +class RulePermission(BaseModel): + """ + List of rules + """ # noqa: E501 + permissions: Optional[List[GrantedPermission]] = Field(default=None, description="Permissions granted by the rule") + type: StrictStr = Field(description="Type of the rule") + __properties: ClassVar[List[str]] = ["permissions", "type"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RulePermission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RulePermission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": [GrantedPermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/running_section.py b/gooddata-api-client/gooddata_api_client/models/running_section.py new file mode 100644 index 000000000..c67958147 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/running_section.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class RunningSection(BaseModel): + """ + Footer section of the slide + """ # noqa: E501 + left: Optional[StrictStr] = Field(default=None, description="Either {{logo}} variable or custom text with combination of other variables.") + right: Optional[StrictStr] = Field(default=None, description="Either {{logo}} variable or custom text with combination of other variables.") + __properties: ClassVar[List[str]] = ["left", "right"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RunningSection from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if left (nullable) is None + # and model_fields_set contains the field + if self.left is None and "left" in self.model_fields_set: + _dict['left'] = None + + # set to None if right (nullable) is None + # and model_fields_set contains the field + if self.right is None and "right" in self.model_fields_set: + _dict['right'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RunningSection from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "left": obj.get("left"), + "right": obj.get("right") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/saved_visualization.py b/gooddata-api-client/gooddata_api_client/models/saved_visualization.py new file mode 100644 index 000000000..4ef90c976 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/saved_visualization.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SavedVisualization(BaseModel): + """ + Created and saved visualization IDs. + """ # noqa: E501 + created_visualization_id: StrictStr = Field(description="Created visualization ID.", alias="createdVisualizationId") + saved_visualization_id: StrictStr = Field(description="Saved visualization ID.", alias="savedVisualizationId") + __properties: ClassVar[List[str]] = ["createdVisualizationId", "savedVisualizationId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SavedVisualization from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SavedVisualization from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "createdVisualizationId": obj.get("createdVisualizationId"), + "savedVisualizationId": obj.get("savedVisualizationId") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/scan_request.py b/gooddata-api-client/gooddata_api_client/models/scan_request.py new file mode 100644 index 000000000..017913c28 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/scan_request.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ScanRequest(BaseModel): + """ + A request containing all information critical to model scanning. + """ # noqa: E501 + scan_tables: StrictBool = Field(description="A flag indicating whether the tables should be scanned.", alias="scanTables") + scan_views: StrictBool = Field(description="A flag indicating whether the views should be scanned.", alias="scanViews") + schemata: Optional[List[StrictStr]] = Field(default=None, description="What schemata will be scanned.") + separator: StrictStr = Field(description="A separator between prefixes and the names.") + table_prefix: Optional[StrictStr] = Field(default=None, description="Tables starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.", alias="tablePrefix") + view_prefix: Optional[StrictStr] = Field(default=None, description="Views starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.", alias="viewPrefix") + __properties: ClassVar[List[str]] = ["scanTables", "scanViews", "schemata", "separator", "tablePrefix", "viewPrefix"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ScanRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ScanRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "scanTables": obj.get("scanTables"), + "scanViews": obj.get("scanViews"), + "schemata": obj.get("schemata"), + "separator": obj.get("separator"), + "tablePrefix": obj.get("tablePrefix"), + "viewPrefix": obj.get("viewPrefix") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/scan_result_pdm.py b/gooddata-api-client/gooddata_api_client/models/scan_result_pdm.py new file mode 100644 index 000000000..10fbfb7b1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/scan_result_pdm.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.declarative_tables import DeclarativeTables +from gooddata_api_client.models.table_warning import TableWarning +from typing import Optional, Set +from typing_extensions import Self + +class ScanResultPdm(BaseModel): + """ + Result of scan of data source physical model. + """ # noqa: E501 + pdm: DeclarativeTables + warnings: List[TableWarning] + __properties: ClassVar[List[str]] = ["pdm", "warnings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ScanResultPdm from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of pdm + if self.pdm: + _dict['pdm'] = self.pdm.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in warnings (list) + _items = [] + if self.warnings: + for _item_warnings in self.warnings: + if _item_warnings: + _items.append(_item_warnings.to_dict()) + _dict['warnings'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ScanResultPdm from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pdm": DeclarativeTables.from_dict(obj["pdm"]) if obj.get("pdm") is not None else None, + "warnings": [TableWarning.from_dict(_item) for _item in obj["warnings"]] if obj.get("warnings") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/scan_sql_request.py b/gooddata-api-client/gooddata_api_client/models/scan_sql_request.py new file mode 100644 index 000000000..b643c26ff --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/scan_sql_request.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ScanSqlRequest(BaseModel): + """ + A request with SQL query to by analyzed. + """ # noqa: E501 + sql: StrictStr = Field(description="SQL query to be analyzed.") + __properties: ClassVar[List[str]] = ["sql"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ScanSqlRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ScanSqlRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sql": obj.get("sql") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/scan_sql_response.py b/gooddata-api-client/gooddata_api_client/models/scan_sql_response.py new file mode 100644 index 000000000..d155db3f1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/scan_sql_response.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.sql_column import SqlColumn +from typing import Optional, Set +from typing_extensions import Self + +class ScanSqlResponse(BaseModel): + """ + Result of scanSql. Consists of array of query columns including type. Sql query result data preview can be attached optionally + """ # noqa: E501 + columns: List[SqlColumn] = Field(description="Array of columns with types.") + data_preview: Optional[List[List[Optional[StrictStr]]]] = Field(default=None, description="Array of rows where each row is another array of string values.", alias="dataPreview") + __properties: ClassVar[List[str]] = ["columns", "dataPreview"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ScanSqlResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in columns (list) + _items = [] + if self.columns: + for _item_columns in self.columns: + if _item_columns: + _items.append(_item_columns.to_dict()) + _dict['columns'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ScanSqlResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columns": [SqlColumn.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None, + "dataPreview": obj.get("dataPreview") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/search_relationship_object.py b/gooddata-api-client/gooddata_api_client/models/search_relationship_object.py new file mode 100644 index 000000000..04beee8f9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/search_relationship_object.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SearchRelationshipObject(BaseModel): + """ + SearchRelationshipObject + """ # noqa: E501 + source_object_id: StrictStr = Field(description="Source object ID.", alias="sourceObjectId") + source_object_title: StrictStr = Field(description="Source object title.", alias="sourceObjectTitle") + source_object_type: StrictStr = Field(description="Source object type, e.g. dashboard.", alias="sourceObjectType") + source_workspace_id: StrictStr = Field(description="Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located.", alias="sourceWorkspaceId") + target_object_id: StrictStr = Field(description="Target object ID.", alias="targetObjectId") + target_object_title: StrictStr = Field(description="Target object title.", alias="targetObjectTitle") + target_object_type: StrictStr = Field(description="Target object type, e.g. visualization.", alias="targetObjectType") + target_workspace_id: StrictStr = Field(description="Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located.", alias="targetWorkspaceId") + __properties: ClassVar[List[str]] = ["sourceObjectId", "sourceObjectTitle", "sourceObjectType", "sourceWorkspaceId", "targetObjectId", "targetObjectTitle", "targetObjectType", "targetWorkspaceId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SearchRelationshipObject from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SearchRelationshipObject from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sourceObjectId": obj.get("sourceObjectId"), + "sourceObjectTitle": obj.get("sourceObjectTitle"), + "sourceObjectType": obj.get("sourceObjectType"), + "sourceWorkspaceId": obj.get("sourceWorkspaceId"), + "targetObjectId": obj.get("targetObjectId"), + "targetObjectTitle": obj.get("targetObjectTitle"), + "targetObjectType": obj.get("targetObjectType"), + "targetWorkspaceId": obj.get("targetWorkspaceId") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/search_request.py b/gooddata-api-client/gooddata_api_client/models/search_request.py new file mode 100644 index 000000000..3116dea9c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/search_request.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SearchRequest(BaseModel): + """ + SearchRequest + """ # noqa: E501 + deep_search: Optional[StrictBool] = Field(default=False, description="Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.", alias="deepSearch") + include_hidden: Optional[StrictBool] = Field(default=False, description="If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.", alias="includeHidden") + limit: Optional[StrictInt] = Field(default=10, description="Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested.") + object_types: Optional[List[StrictStr]] = Field(default=None, description="List of object types to search for.", alias="objectTypes") + question: Annotated[str, Field(strict=True, max_length=1000)] = Field(description="Keyword/sentence is input for search.") + relevant_score_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.3, description="Score, above which we return found objects. Below this score objects are not relevant.", alias="relevantScoreThreshold") + title_to_descriptor_ratio: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.7, description="Temporary for experiments. Ratio of title score to descriptor score.", alias="titleToDescriptorRatio") + __properties: ClassVar[List[str]] = ["deepSearch", "includeHidden", "limit", "objectTypes", "question", "relevantScoreThreshold", "titleToDescriptorRatio"] + + @field_validator('object_types') + def object_types_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['attribute', 'metric', 'fact', 'label', 'date', 'dataset', 'visualization', 'dashboard']): + raise ValueError("each list item must be one of ('attribute', 'metric', 'fact', 'label', 'date', 'dataset', 'visualization', 'dashboard')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SearchRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SearchRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "deepSearch": obj.get("deepSearch") if obj.get("deepSearch") is not None else False, + "includeHidden": obj.get("includeHidden") if obj.get("includeHidden") is not None else False, + "limit": obj.get("limit") if obj.get("limit") is not None else 10, + "objectTypes": obj.get("objectTypes"), + "question": obj.get("question"), + "relevantScoreThreshold": obj.get("relevantScoreThreshold") if obj.get("relevantScoreThreshold") is not None else 0.3, + "titleToDescriptorRatio": obj.get("titleToDescriptorRatio") if obj.get("titleToDescriptorRatio") is not None else 0.7 + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/search_result.py b/gooddata-api-client/gooddata_api_client/models/search_result.py new file mode 100644 index 000000000..45f42da22 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/search_result.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.search_relationship_object import SearchRelationshipObject +from gooddata_api_client.models.search_result_object import SearchResultObject +from typing import Optional, Set +from typing_extensions import Self + +class SearchResult(BaseModel): + """ + SearchResult + """ # noqa: E501 + reasoning: StrictStr = Field(description="If something is not working properly this field will contain explanation.") + relationships: List[SearchRelationshipObject] + results: List[SearchResultObject] + __properties: ClassVar[List[str]] = ["reasoning", "relationships", "results"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SearchResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in relationships (list) + _items = [] + if self.relationships: + for _item_relationships in self.relationships: + if _item_relationships: + _items.append(_item_relationships.to_dict()) + _dict['relationships'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in results (list) + _items = [] + if self.results: + for _item_results in self.results: + if _item_results: + _items.append(_item_results.to_dict()) + _dict['results'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SearchResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "reasoning": obj.get("reasoning"), + "relationships": [SearchRelationshipObject.from_dict(_item) for _item in obj["relationships"]] if obj.get("relationships") is not None else None, + "results": [SearchResultObject.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/search_result_object.py b/gooddata-api-client/gooddata_api_client/models/search_result_object.py new file mode 100644 index 000000000..13ed95e58 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/search_result_object.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class SearchResultObject(BaseModel): + """ + SearchResultObject + """ # noqa: E501 + created_at: Optional[datetime] = Field(default=None, description="Timestamp when object was created.", alias="createdAt") + description: Optional[StrictStr] = Field(default=None, description="Object description.") + id: StrictStr = Field(description="Object ID.") + is_hidden: Optional[StrictBool] = Field(default=None, description="If true, this object is hidden from AI search results by default.", alias="isHidden") + modified_at: Optional[datetime] = Field(default=None, description="Timestamp when object was last modified.", alias="modifiedAt") + score: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Result score calculated by a similarity search algorithm (cosine_distance).") + score_descriptor: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Result score for descriptor containing(now) description and tags.", alias="scoreDescriptor") + score_exact_match: Optional[StrictInt] = Field(default=None, description="Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.", alias="scoreExactMatch") + score_title: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Result score for object title.", alias="scoreTitle") + tags: Optional[List[StrictStr]] = None + title: StrictStr = Field(description="Object title.") + type: StrictStr = Field(description="Object type, e.g. dashboard.") + visualization_url: Optional[StrictStr] = Field(default=None, description="If the object is visualization, this field defines the type of visualization.", alias="visualizationUrl") + workspace_id: StrictStr = Field(description="Workspace ID.", alias="workspaceId") + __properties: ClassVar[List[str]] = ["createdAt", "description", "id", "isHidden", "modifiedAt", "score", "scoreDescriptor", "scoreExactMatch", "scoreTitle", "tags", "title", "type", "visualizationUrl", "workspaceId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SearchResultObject from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SearchResultObject from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "createdAt": obj.get("createdAt"), + "description": obj.get("description"), + "id": obj.get("id"), + "isHidden": obj.get("isHidden"), + "modifiedAt": obj.get("modifiedAt"), + "score": obj.get("score"), + "scoreDescriptor": obj.get("scoreDescriptor"), + "scoreExactMatch": obj.get("scoreExactMatch"), + "scoreTitle": obj.get("scoreTitle"), + "tags": obj.get("tags"), + "title": obj.get("title"), + "type": obj.get("type"), + "visualizationUrl": obj.get("visualizationUrl"), + "workspaceId": obj.get("workspaceId") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/section_slide_template.py b/gooddata-api-client/gooddata_api_client/models/section_slide_template.py new file mode 100644 index 000000000..ea3996b98 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/section_slide_template.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.running_section import RunningSection +from typing import Optional, Set +from typing_extensions import Self + +class SectionSlideTemplate(BaseModel): + """ + Settings for section slide. + """ # noqa: E501 + background_image: Optional[StrictBool] = Field(default=True, description="Show background image on the slide.", alias="backgroundImage") + footer: Optional[RunningSection] = None + header: Optional[RunningSection] = None + __properties: ClassVar[List[str]] = ["backgroundImage", "footer", "header"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SectionSlideTemplate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of footer + if self.footer: + _dict['footer'] = self.footer.to_dict() + # override the default output from pydantic by calling `to_dict()` of header + if self.header: + _dict['header'] = self.header.to_dict() + # set to None if footer (nullable) is None + # and model_fields_set contains the field + if self.footer is None and "footer" in self.model_fields_set: + _dict['footer'] = None + + # set to None if header (nullable) is None + # and model_fields_set contains the field + if self.header is None and "header" in self.model_fields_set: + _dict['header'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SectionSlideTemplate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "backgroundImage": obj.get("backgroundImage") if obj.get("backgroundImage") is not None else True, + "footer": RunningSection.from_dict(obj["footer"]) if obj.get("footer") is not None else None, + "header": RunningSection.from_dict(obj["header"]) if obj.get("header") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/settings.py b/gooddata-api-client/gooddata_api_client/models/settings.py new file mode 100644 index 000000000..8a3c39911 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/settings.py @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.pdf_table_style import PdfTableStyle +from typing import Optional, Set +from typing_extensions import Self + +class Settings(BaseModel): + """ + Additional settings. + """ # noqa: E501 + export_info: Optional[StrictBool] = Field(default=False, description="If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", alias="exportInfo") + merge_headers: Optional[StrictBool] = Field(default=None, description="Merge equal headers in neighbouring cells. (XLSX)", alias="mergeHeaders") + page_orientation: Optional[StrictStr] = Field(default='PORTRAIT', description="Set page orientation. (PDF)", alias="pageOrientation") + page_size: Optional[StrictStr] = Field(default='A4', description="Set page size. (PDF)", alias="pageSize") + pdf_page_size: Optional[StrictStr] = Field(default=None, description="Page size and orientation. (PDF)", alias="pdfPageSize") + pdf_table_style: Optional[List[PdfTableStyle]] = Field(default=None, description="Custom CSS styles for the table. (PDF, HTML)", alias="pdfTableStyle") + pdf_top_left_content: Optional[StrictStr] = Field(default=None, description="Top left header content. (PDF)", alias="pdfTopLeftContent") + pdf_top_right_content: Optional[StrictStr] = Field(default=None, description="Top right header content. (PDF)", alias="pdfTopRightContent") + show_filters: Optional[StrictBool] = Field(default=None, description="Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", alias="showFilters") + __properties: ClassVar[List[str]] = ["exportInfo", "mergeHeaders", "pageOrientation", "pageSize", "pdfPageSize", "pdfTableStyle", "pdfTopLeftContent", "pdfTopRightContent", "showFilters"] + + @field_validator('page_orientation') + def page_orientation_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['PORTRAIT', 'LANDSCAPE']): + raise ValueError("must be one of enum values ('PORTRAIT', 'LANDSCAPE')") + return value + + @field_validator('page_size') + def page_size_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['A3', 'A4', 'LETTER']): + raise ValueError("must be one of enum values ('A3', 'A4', 'LETTER')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Settings from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in pdf_table_style (list) + _items = [] + if self.pdf_table_style: + for _item_pdf_table_style in self.pdf_table_style: + if _item_pdf_table_style: + _items.append(_item_pdf_table_style.to_dict()) + _dict['pdfTableStyle'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Settings from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "exportInfo": obj.get("exportInfo") if obj.get("exportInfo") is not None else False, + "mergeHeaders": obj.get("mergeHeaders"), + "pageOrientation": obj.get("pageOrientation") if obj.get("pageOrientation") is not None else 'PORTRAIT', + "pageSize": obj.get("pageSize") if obj.get("pageSize") is not None else 'A4', + "pdfPageSize": obj.get("pdfPageSize"), + "pdfTableStyle": [PdfTableStyle.from_dict(_item) for _item in obj["pdfTableStyle"]] if obj.get("pdfTableStyle") is not None else None, + "pdfTopLeftContent": obj.get("pdfTopLeftContent"), + "pdfTopRightContent": obj.get("pdfTopRightContent"), + "showFilters": obj.get("showFilters") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/simple_measure_definition.py b/gooddata-api-client/gooddata_api_client/models/simple_measure_definition.py new file mode 100644 index 000000000..b20f276de --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/simple_measure_definition.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.simple_measure_definition_measure import SimpleMeasureDefinitionMeasure +from typing import Optional, Set +from typing_extensions import Self + +class SimpleMeasureDefinition(BaseModel): + """ + Metric defined by referencing a MAQL metric or an LDM fact object with aggregation. + """ # noqa: E501 + measure: SimpleMeasureDefinitionMeasure + __properties: ClassVar[List[str]] = ["measure"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SimpleMeasureDefinition from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of measure + if self.measure: + _dict['measure'] = self.measure.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SimpleMeasureDefinition from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "measure": SimpleMeasureDefinitionMeasure.from_dict(obj["measure"]) if obj.get("measure") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/simple_measure_definition_measure.py b/gooddata-api-client/gooddata_api_client/models/simple_measure_definition_measure.py new file mode 100644 index 000000000..a5bbfe2f0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/simple_measure_definition_measure.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.afm_object_identifier_core import AfmObjectIdentifierCore +from gooddata_api_client.models.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure +from typing import Optional, Set +from typing_extensions import Self + +class SimpleMeasureDefinitionMeasure(BaseModel): + """ + SimpleMeasureDefinitionMeasure + """ # noqa: E501 + aggregation: Optional[StrictStr] = Field(default=None, description="Definition of aggregation type of the metric.") + compute_ratio: Optional[StrictBool] = Field(default=False, description="If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", alias="computeRatio") + filters: Optional[List[FilterDefinitionForSimpleMeasure]] = Field(default=None, description="Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.") + item: AfmObjectIdentifierCore + __properties: ClassVar[List[str]] = ["aggregation", "computeRatio", "filters", "item"] + + @field_validator('aggregation') + def aggregation_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SUM', 'COUNT', 'AVG', 'MIN', 'MAX', 'MEDIAN', 'RUNSUM', 'APPROXIMATE_COUNT']): + raise ValueError("must be one of enum values ('SUM', 'COUNT', 'AVG', 'MIN', 'MAX', 'MEDIAN', 'RUNSUM', 'APPROXIMATE_COUNT')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SimpleMeasureDefinitionMeasure from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in filters (list) + _items = [] + if self.filters: + for _item_filters in self.filters: + if _item_filters: + _items.append(_item_filters.to_dict()) + _dict['filters'] = _items + # override the default output from pydantic by calling `to_dict()` of item + if self.item: + _dict['item'] = self.item.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SimpleMeasureDefinitionMeasure from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "aggregation": obj.get("aggregation"), + "computeRatio": obj.get("computeRatio") if obj.get("computeRatio") is not None else False, + "filters": [FilterDefinitionForSimpleMeasure.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None, + "item": AfmObjectIdentifierCore.from_dict(obj["item"]) if obj.get("item") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/skeleton.py b/gooddata-api-client/gooddata_api_client/models/skeleton.py new file mode 100644 index 000000000..a77267e81 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/skeleton.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class Skeleton(BaseModel): + """ + Skeleton + """ # noqa: E501 + content: Optional[List[Dict[str, Any]]] = None + href: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["content", "href"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Skeleton from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Skeleton from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "href": obj.get("href") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/slides_export_request.py b/gooddata-api-client/gooddata_api_client/models/slides_export_request.py new file mode 100644 index 000000000..5be2da1ea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/slides_export_request.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SlidesExportRequest(BaseModel): + """ + Export request object describing the export properties and metadata for slides exports. + """ # noqa: E501 + dashboard_id: Optional[StrictStr] = Field(default=None, description="Dashboard identifier", alias="dashboardId") + file_name: StrictStr = Field(description="File name to be used for retrieving the pdf document.", alias="fileName") + format: StrictStr = Field(description="Requested resulting file type.") + metadata: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON object") + template_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Export template identifier.", alias="templateId") + visualization_ids: Optional[Annotated[List[Annotated[str, Field(min_length=1, strict=True, max_length=255)]], Field(max_length=1)]] = Field(default=None, description="List of visualization ids to be exported. Note that only one visualization is currently supported.", alias="visualizationIds") + widget_ids: Optional[Annotated[List[Annotated[str, Field(min_length=1, strict=True, max_length=255)]], Field(max_length=1)]] = Field(default=None, description="List of widget identifiers to be exported. Note that only one widget is currently supported.", alias="widgetIds") + __properties: ClassVar[List[str]] = ["dashboardId", "fileName", "format", "metadata", "templateId", "visualizationIds", "widgetIds"] + + @field_validator('format') + def format_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['PDF', 'PPTX']): + raise ValueError("must be one of enum values ('PDF', 'PPTX')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SlidesExportRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + # set to None if template_id (nullable) is None + # and model_fields_set contains the field + if self.template_id is None and "template_id" in self.model_fields_set: + _dict['templateId'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SlidesExportRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dashboardId": obj.get("dashboardId"), + "fileName": obj.get("fileName"), + "format": obj.get("format"), + "metadata": obj.get("metadata"), + "templateId": obj.get("templateId"), + "visualizationIds": obj.get("visualizationIds"), + "widgetIds": obj.get("widgetIds") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/smart_function_response.py b/gooddata-api-client/gooddata_api_client/models/smart_function_response.py new file mode 100644 index 000000000..4aa6d7921 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/smart_function_response.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.execution_links import ExecutionLinks +from typing import Optional, Set +from typing_extensions import Self + +class SmartFunctionResponse(BaseModel): + """ + SmartFunctionResponse + """ # noqa: E501 + links: ExecutionLinks + __properties: ClassVar[List[str]] = ["links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SmartFunctionResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SmartFunctionResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "links": ExecutionLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/smtp.py b/gooddata-api-client/gooddata_api_client/models/smtp.py new file mode 100644 index 000000000..4c7d4825c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/smtp.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class Smtp(BaseModel): + """ + Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update + """ # noqa: E501 + from_email: Optional[StrictStr] = Field(default='no-reply@gooddata.com', description="E-mail address to send notifications from.", alias="fromEmail") + from_email_name: Optional[StrictStr] = Field(default='GoodData', description="An optional e-mail name to send notifications from.", alias="fromEmailName") + host: Optional[StrictStr] = Field(default=None, description="The SMTP server address.") + password: Optional[StrictStr] = Field(default=None, description="The SMTP server password.") + port: Optional[StrictInt] = Field(default=None, description="The SMTP server port.") + type: StrictStr = Field(description="The destination type.") + username: Optional[StrictStr] = Field(default=None, description="The SMTP server username.") + __properties: ClassVar[List[str]] = ["fromEmail", "fromEmailName", "host", "password", "port", "type", "username"] + + @field_validator('port') + def port_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set([25, 465, 587, 2525]): + raise ValueError("must be one of enum values (25, 465, 587, 2525)") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['SMTP']): + raise ValueError("must be one of enum values ('SMTP')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Smtp from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Smtp from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fromEmail": obj.get("fromEmail") if obj.get("fromEmail") is not None else 'no-reply@gooddata.com', + "fromEmailName": obj.get("fromEmailName") if obj.get("fromEmailName") is not None else 'GoodData', + "host": obj.get("host"), + "password": obj.get("password"), + "port": obj.get("port"), + "type": obj.get("type"), + "username": obj.get("username") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/sort_key.py b/gooddata-api-client/gooddata_api_client/models/sort_key.py new file mode 100644 index 000000000..31c25981e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/sort_key.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from gooddata_api_client.models.sort_key_attribute import SortKeyAttribute +from gooddata_api_client.models.sort_key_total import SortKeyTotal +from gooddata_api_client.models.sort_key_value import SortKeyValue +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +SORTKEY_ONE_OF_SCHEMAS = ["SortKeyAttribute", "SortKeyTotal", "SortKeyValue"] + +class SortKey(BaseModel): + """ + SortKey + """ + # data type: SortKeyAttribute + oneof_schema_1_validator: Optional[SortKeyAttribute] = None + # data type: SortKeyValue + oneof_schema_2_validator: Optional[SortKeyValue] = None + # data type: SortKeyTotal + oneof_schema_3_validator: Optional[SortKeyTotal] = None + actual_instance: Optional[Union[SortKeyAttribute, SortKeyTotal, SortKeyValue]] = None + one_of_schemas: Set[str] = { "SortKeyAttribute", "SortKeyTotal", "SortKeyValue" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = SortKey.model_construct() + error_messages = [] + match = 0 + # validate data type: SortKeyAttribute + if not isinstance(v, SortKeyAttribute): + error_messages.append(f"Error! Input type `{type(v)}` is not `SortKeyAttribute`") + else: + match += 1 + # validate data type: SortKeyValue + if not isinstance(v, SortKeyValue): + error_messages.append(f"Error! Input type `{type(v)}` is not `SortKeyValue`") + else: + match += 1 + # validate data type: SortKeyTotal + if not isinstance(v, SortKeyTotal): + error_messages.append(f"Error! Input type `{type(v)}` is not `SortKeyTotal`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in SortKey with oneOf schemas: SortKeyAttribute, SortKeyTotal, SortKeyValue. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in SortKey with oneOf schemas: SortKeyAttribute, SortKeyTotal, SortKeyValue. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into SortKeyAttribute + try: + instance.actual_instance = SortKeyAttribute.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into SortKeyValue + try: + instance.actual_instance = SortKeyValue.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into SortKeyTotal + try: + instance.actual_instance = SortKeyTotal.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into SortKey with oneOf schemas: SortKeyAttribute, SortKeyTotal, SortKeyValue. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into SortKey with oneOf schemas: SortKeyAttribute, SortKeyTotal, SortKeyValue. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], SortKeyAttribute, SortKeyTotal, SortKeyValue]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/gooddata-api-client/gooddata_api_client/models/sort_key_attribute.py b/gooddata-api-client/gooddata_api_client/models/sort_key_attribute.py new file mode 100644 index 000000000..f13dc713d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/sort_key_attribute.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.sort_key_attribute_attribute import SortKeyAttributeAttribute +from typing import Optional, Set +from typing_extensions import Self + +class SortKeyAttribute(BaseModel): + """ + Sorting rule for sorting by attribute value in current dimension. + """ # noqa: E501 + attribute: SortKeyAttributeAttribute + __properties: ClassVar[List[str]] = ["attribute"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SortKeyAttribute from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of attribute + if self.attribute: + _dict['attribute'] = self.attribute.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SortKeyAttribute from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attribute": SortKeyAttributeAttribute.from_dict(obj["attribute"]) if obj.get("attribute") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/sort_key_attribute_attribute.py b/gooddata-api-client/gooddata_api_client/models/sort_key_attribute_attribute.py new file mode 100644 index 000000000..7b11c9a1f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/sort_key_attribute_attribute.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class SortKeyAttributeAttribute(BaseModel): + """ + SortKeyAttributeAttribute + """ # noqa: E501 + attribute_identifier: StrictStr = Field(description="Item reference (to 'itemIdentifiers') referencing, which item should be used for sorting. Only references to attributes are allowed.", alias="attributeIdentifier") + direction: Optional[StrictStr] = Field(default=None, description="Sorting elements - ascending/descending order.") + sort_type: Optional[StrictStr] = Field(default='DEFAULT', description="Mechanism by which this attribute should be sorted. Available options are: - DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) - LABEL: sorting by this label values - ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label) - ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions.", alias="sortType") + __properties: ClassVar[List[str]] = ["attributeIdentifier", "direction", "sortType"] + + @field_validator('direction') + def direction_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ASC', 'DESC']): + raise ValueError("must be one of enum values ('ASC', 'DESC')") + return value + + @field_validator('sort_type') + def sort_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['DEFAULT', 'LABEL', 'ATTRIBUTE', 'AREA']): + raise ValueError("must be one of enum values ('DEFAULT', 'LABEL', 'ATTRIBUTE', 'AREA')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SortKeyAttributeAttribute from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SortKeyAttributeAttribute from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "attributeIdentifier": obj.get("attributeIdentifier"), + "direction": obj.get("direction"), + "sortType": obj.get("sortType") if obj.get("sortType") is not None else 'DEFAULT' + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/sort_key_total.py b/gooddata-api-client/gooddata_api_client/models/sort_key_total.py new file mode 100644 index 000000000..ee53eb358 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/sort_key_total.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.sort_key_total_total import SortKeyTotalTotal +from typing import Optional, Set +from typing_extensions import Self + +class SortKeyTotal(BaseModel): + """ + Sorting rule for sorting by total value. DataColumnLocators are only required if there is ambiguity. Locator for measureGroup is taken from the metric of the total. + """ # noqa: E501 + total: SortKeyTotalTotal + __properties: ClassVar[List[str]] = ["total"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SortKeyTotal from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of total + if self.total: + _dict['total'] = self.total.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SortKeyTotal from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "total": SortKeyTotalTotal.from_dict(obj["total"]) if obj.get("total") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/sort_key_total_total.py b/gooddata-api-client/gooddata_api_client/models/sort_key_total_total.py new file mode 100644 index 000000000..e0b11bb42 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/sort_key_total_total.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.data_column_locators import DataColumnLocators +from typing import Optional, Set +from typing_extensions import Self + +class SortKeyTotalTotal(BaseModel): + """ + SortKeyTotalTotal + """ # noqa: E501 + data_column_locators: Optional[DataColumnLocators] = Field(default=None, alias="dataColumnLocators") + direction: Optional[StrictStr] = Field(default=None, description="Sorting elements - ascending/descending order.") + total_identifier: StrictStr = Field(description="Local identifier of the total to sort by.", alias="totalIdentifier") + __properties: ClassVar[List[str]] = ["dataColumnLocators", "direction", "totalIdentifier"] + + @field_validator('direction') + def direction_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ASC', 'DESC']): + raise ValueError("must be one of enum values ('ASC', 'DESC')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SortKeyTotalTotal from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data_column_locators + if self.data_column_locators: + _dict['dataColumnLocators'] = self.data_column_locators.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SortKeyTotalTotal from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataColumnLocators": DataColumnLocators.from_dict(obj["dataColumnLocators"]) if obj.get("dataColumnLocators") is not None else None, + "direction": obj.get("direction"), + "totalIdentifier": obj.get("totalIdentifier") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/sort_key_value.py b/gooddata-api-client/gooddata_api_client/models/sort_key_value.py new file mode 100644 index 000000000..d7e35d13d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/sort_key_value.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.sort_key_value_value import SortKeyValueValue +from typing import Optional, Set +from typing_extensions import Self + +class SortKeyValue(BaseModel): + """ + Sorting rule for sorting by measure value. DataColumnLocators for each dimension opposite to the sorted one must be specified. + """ # noqa: E501 + value: SortKeyValueValue + __properties: ClassVar[List[str]] = ["value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SortKeyValue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of value + if self.value: + _dict['value'] = self.value.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SortKeyValue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "value": SortKeyValueValue.from_dict(obj["value"]) if obj.get("value") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/sort_key_value_value.py b/gooddata-api-client/gooddata_api_client/models/sort_key_value_value.py new file mode 100644 index 000000000..e4ec6b227 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/sort_key_value_value.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.data_column_locators import DataColumnLocators +from typing import Optional, Set +from typing_extensions import Self + +class SortKeyValueValue(BaseModel): + """ + SortKeyValueValue + """ # noqa: E501 + data_column_locators: DataColumnLocators = Field(alias="dataColumnLocators") + direction: Optional[StrictStr] = Field(default=None, description="Sorting elements - ascending/descending order.") + __properties: ClassVar[List[str]] = ["dataColumnLocators", "direction"] + + @field_validator('direction') + def direction_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ASC', 'DESC']): + raise ValueError("must be one of enum values ('ASC', 'DESC')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SortKeyValueValue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data_column_locators + if self.data_column_locators: + _dict['dataColumnLocators'] = self.data_column_locators.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SortKeyValueValue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataColumnLocators": DataColumnLocators.from_dict(obj["dataColumnLocators"]) if obj.get("dataColumnLocators") is not None else None, + "direction": obj.get("direction") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/sql_column.py b/gooddata-api-client/gooddata_api_client/models/sql_column.py new file mode 100644 index 000000000..ee35c25a5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/sql_column.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SqlColumn(BaseModel): + """ + A SQL query result column. + """ # noqa: E501 + data_type: StrictStr = Field(description="Column type", alias="dataType") + name: StrictStr = Field(description="Column name") + __properties: ClassVar[List[str]] = ["dataType", "name"] + + @field_validator('data_type') + def data_type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN']): + raise ValueError("must be one of enum values ('INT', 'STRING', 'DATE', 'NUMERIC', 'TIMESTAMP', 'TIMESTAMP_TZ', 'BOOLEAN')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SqlColumn from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SqlColumn from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataType": obj.get("dataType"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/sql_query.py b/gooddata-api-client/gooddata_api_client/models/sql_query.py new file mode 100644 index 000000000..3e24b38e6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/sql_query.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SqlQuery(BaseModel): + """ + SqlQuery + """ # noqa: E501 + sql: StrictStr + __properties: ClassVar[List[str]] = ["sql"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SqlQuery from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SqlQuery from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sql": obj.get("sql") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/suggestion.py b/gooddata-api-client/gooddata_api_client/models/suggestion.py new file mode 100644 index 000000000..041cf69d9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/suggestion.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class Suggestion(BaseModel): + """ + List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. + """ # noqa: E501 + label: StrictStr = Field(description="Suggestion button label") + query: StrictStr = Field(description="Suggestion query") + __properties: ClassVar[List[str]] = ["label", "query"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Suggestion from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Suggestion from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "label": obj.get("label"), + "query": obj.get("query") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/switch_identity_provider_request.py b/gooddata-api-client/gooddata_api_client/models/switch_identity_provider_request.py new file mode 100644 index 000000000..dd350fada --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/switch_identity_provider_request.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SwitchIdentityProviderRequest(BaseModel): + """ + SwitchIdentityProviderRequest + """ # noqa: E501 + idp_id: StrictStr = Field(description="Identity provider ID to set as active for the organization.", alias="idpId") + __properties: ClassVar[List[str]] = ["idpId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SwitchIdentityProviderRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SwitchIdentityProviderRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "idpId": obj.get("idpId") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/table.py b/gooddata-api-client/gooddata_api_client/models/table.py new file mode 100644 index 000000000..15a20e00d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/table.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class Table(BaseModel): + """ + Table + """ # noqa: E501 + table_name: StrictStr = Field(alias="tableName") + __properties: ClassVar[List[str]] = ["tableName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Table from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Table from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tableName": obj.get("tableName") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/table_override.py b/gooddata-api-client/gooddata_api_client/models/table_override.py new file mode 100644 index 000000000..0bbe75132 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/table_override.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.column_override import ColumnOverride +from typing import Optional, Set +from typing_extensions import Self + +class TableOverride(BaseModel): + """ + Table override settings. + """ # noqa: E501 + columns: List[ColumnOverride] = Field(description="An array of column overrides") + path: List[StrictStr] = Field(description="Path for the table.") + __properties: ClassVar[List[str]] = ["columns", "path"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TableOverride from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in columns (list) + _items = [] + if self.columns: + for _item_columns in self.columns: + if _item_columns: + _items.append(_item_columns.to_dict()) + _dict['columns'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TableOverride from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columns": [ColumnOverride.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None, + "path": obj.get("path") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/table_warning.py b/gooddata-api-client/gooddata_api_client/models/table_warning.py new file mode 100644 index 000000000..7cc4459ba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/table_warning.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.column_warning import ColumnWarning +from typing import Optional, Set +from typing_extensions import Self + +class TableWarning(BaseModel): + """ + Warnings related to single table. + """ # noqa: E501 + columns: List[ColumnWarning] + message: Optional[StrictStr] = Field(default=None, description="Warning message related to the table.") + name: StrictStr = Field(description="Table name.") + __properties: ClassVar[List[str]] = ["columns", "message", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TableWarning from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in columns (list) + _items = [] + if self.columns: + for _item_columns in self.columns: + if _item_columns: + _items.append(_item_columns.to_dict()) + _dict['columns'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TableWarning from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columns": [ColumnWarning.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None, + "message": obj.get("message"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/tabular_export_request.py b/gooddata-api-client/gooddata_api_client/models/tabular_export_request.py new file mode 100644 index 000000000..2b45c86cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/tabular_export_request.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.custom_override import CustomOverride +from gooddata_api_client.models.settings import Settings +from typing import Optional, Set +from typing_extensions import Self + +class TabularExportRequest(BaseModel): + """ + Export request object describing the export properties and overrides for tabular exports. + """ # noqa: E501 + custom_override: Optional[CustomOverride] = Field(default=None, alias="customOverride") + execution_result: Optional[StrictStr] = Field(default=None, description="Execution result identifier.", alias="executionResult") + file_name: StrictStr = Field(description="Filename of downloaded file without extension.", alias="fileName") + format: StrictStr = Field(description="Expected file format.") + metadata: Optional[Dict[str, Any]] = Field(default=None, description="Free-form JSON object") + related_dashboard_id: Optional[StrictStr] = Field(default=None, description="Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", alias="relatedDashboardId") + settings: Optional[Settings] = None + visualization_object: Optional[StrictStr] = Field(default=None, description="Visualization object identifier. Alternative to executionResult property.", alias="visualizationObject") + visualization_object_custom_filters: Optional[List[Dict[str, Any]]] = Field(default=None, description="Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", alias="visualizationObjectCustomFilters") + __properties: ClassVar[List[str]] = ["customOverride", "executionResult", "fileName", "format", "metadata", "relatedDashboardId", "settings", "visualizationObject", "visualizationObjectCustomFilters"] + + @field_validator('format') + def format_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['CSV', 'XLSX', 'HTML', 'PDF']): + raise ValueError("must be one of enum values ('CSV', 'XLSX', 'HTML', 'PDF')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TabularExportRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of custom_override + if self.custom_override: + _dict['customOverride'] = self.custom_override.to_dict() + # override the default output from pydantic by calling `to_dict()` of settings + if self.settings: + _dict['settings'] = self.settings.to_dict() + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TabularExportRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "customOverride": CustomOverride.from_dict(obj["customOverride"]) if obj.get("customOverride") is not None else None, + "executionResult": obj.get("executionResult"), + "fileName": obj.get("fileName"), + "format": obj.get("format"), + "metadata": obj.get("metadata"), + "relatedDashboardId": obj.get("relatedDashboardId"), + "settings": Settings.from_dict(obj["settings"]) if obj.get("settings") is not None else None, + "visualizationObject": obj.get("visualizationObject"), + "visualizationObjectCustomFilters": obj.get("visualizationObjectCustomFilters") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/test_definition_request.py b/gooddata-api-client/gooddata_api_client/models/test_definition_request.py new file mode 100644 index 000000000..c8f5b4645 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/test_definition_request.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.data_source_parameter import DataSourceParameter +from typing import Optional, Set +from typing_extensions import Self + +class TestDefinitionRequest(BaseModel): + """ + A request containing all information for testing data source definition. + """ # noqa: E501 + client_id: Optional[StrictStr] = Field(default=None, description="Id for client based authentication for data sources which supports it.", alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, description="Secret for client based authentication for data sources which supports it.", alias="clientSecret") + parameters: Optional[List[DataSourceParameter]] = None + password: Optional[StrictStr] = Field(default=None, description="Database user password.") + private_key: Optional[StrictStr] = Field(default=None, description="Private key for data sources which supports key-pair authentication.", alias="privateKey") + private_key_passphrase: Optional[StrictStr] = Field(default=None, description="Passphrase for a encrypted version of a private key.", alias="privateKeyPassphrase") + var_schema: Optional[StrictStr] = Field(default=None, description="Database schema.", alias="schema") + token: Optional[StrictStr] = Field(default=None, description="Secret for token based authentication for data sources which supports it.") + type: StrictStr = Field(description="Type of database, where test should connect to.") + url: Optional[StrictStr] = Field(default=None, description="URL to database in JDBC format, where test should connect to.") + username: Optional[StrictStr] = Field(default=None, description="Database user name.") + __properties: ClassVar[List[str]] = ["clientId", "clientSecret", "parameters", "password", "privateKey", "privateKeyPassphrase", "schema", "token", "type", "url", "username"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB']): + raise ValueError("must be one of enum values ('POSTGRESQL', 'REDSHIFT', 'VERTICA', 'SNOWFLAKE', 'ADS', 'BIGQUERY', 'MSSQL', 'PRESTO', 'DREMIO', 'DRILL', 'GREENPLUM', 'AZURESQL', 'SYNAPSESQL', 'DATABRICKS', 'GDSTORAGE', 'CLICKHOUSE', 'MYSQL', 'MARIADB', 'ORACLE', 'PINOT', 'SINGLESTORE', 'MOTHERDUCK', 'FLEXCONNECT', 'STARROCKS', 'ATHENA', 'MONGODB')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TestDefinitionRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in parameters (list) + _items = [] + if self.parameters: + for _item_parameters in self.parameters: + if _item_parameters: + _items.append(_item_parameters.to_dict()) + _dict['parameters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TestDefinitionRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "parameters": [DataSourceParameter.from_dict(_item) for _item in obj["parameters"]] if obj.get("parameters") is not None else None, + "password": obj.get("password"), + "privateKey": obj.get("privateKey"), + "privateKeyPassphrase": obj.get("privateKeyPassphrase"), + "schema": obj.get("schema"), + "token": obj.get("token"), + "type": obj.get("type"), + "url": obj.get("url"), + "username": obj.get("username") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/test_destination_request.py b/gooddata-api-client/gooddata_api_client/models/test_destination_request.py new file mode 100644 index 000000000..824b46c56 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/test_destination_request.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.automation_external_recipient import AutomationExternalRecipient +from gooddata_api_client.models.declarative_notification_channel_destination import DeclarativeNotificationChannelDestination +from typing import Optional, Set +from typing_extensions import Self + +class TestDestinationRequest(BaseModel): + """ + Request body with notification channel destination to test. + """ # noqa: E501 + destination: DeclarativeNotificationChannelDestination + external_recipients: Optional[Annotated[List[AutomationExternalRecipient], Field(max_length=1)]] = Field(default=None, description="External recipients of the test result.", alias="externalRecipients") + __properties: ClassVar[List[str]] = ["destination", "externalRecipients"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TestDestinationRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of destination + if self.destination: + _dict['destination'] = self.destination.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in external_recipients (list) + _items = [] + if self.external_recipients: + for _item_external_recipients in self.external_recipients: + if _item_external_recipients: + _items.append(_item_external_recipients.to_dict()) + _dict['externalRecipients'] = _items + # set to None if external_recipients (nullable) is None + # and model_fields_set contains the field + if self.external_recipients is None and "external_recipients" in self.model_fields_set: + _dict['externalRecipients'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TestDestinationRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "destination": DeclarativeNotificationChannelDestination.from_dict(obj["destination"]) if obj.get("destination") is not None else None, + "externalRecipients": [AutomationExternalRecipient.from_dict(_item) for _item in obj["externalRecipients"]] if obj.get("externalRecipients") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/test_notification.py b/gooddata-api-client/gooddata_api_client/models/test_notification.py new file mode 100644 index 000000000..f413a377f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/test_notification.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.notification_content import NotificationContent +from typing import Optional, Set +from typing_extensions import Self + +class TestNotification(NotificationContent): + """ + TestNotification + """ # noqa: E501 + message: StrictStr + __properties: ClassVar[List[str]] = ["type", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TestNotification from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TestNotification from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "type": obj.get("type"), + "message": obj.get("message") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/test_query_duration.py b/gooddata-api-client/gooddata_api_client/models/test_query_duration.py new file mode 100644 index 000000000..871abccf0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/test_query_duration.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class TestQueryDuration(BaseModel): + """ + A structure containing duration of the test queries run on a data source. It is omitted if an error happens. + """ # noqa: E501 + create_cache_table: Optional[StrictInt] = Field(default=None, description="Field containing duration of a test 'create table as select' query on a datasource. In milliseconds. The field is omitted if a data source doesn't support caching.", alias="createCacheTable") + simple_select: StrictInt = Field(description="Field containing duration of a test select query on a data source. In milliseconds.", alias="simpleSelect") + __properties: ClassVar[List[str]] = ["createCacheTable", "simpleSelect"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TestQueryDuration from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TestQueryDuration from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "createCacheTable": obj.get("createCacheTable"), + "simpleSelect": obj.get("simpleSelect") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/test_request.py b/gooddata-api-client/gooddata_api_client/models/test_request.py new file mode 100644 index 000000000..08d861113 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/test_request.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.data_source_parameter import DataSourceParameter +from typing import Optional, Set +from typing_extensions import Self + +class TestRequest(BaseModel): + """ + A request containing all information for testing existing data source. + """ # noqa: E501 + client_id: Optional[StrictStr] = Field(default=None, description="Id for client based authentication for data sources which supports it.", alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, description="Secret for client based authentication for data sources which supports it.", alias="clientSecret") + parameters: Optional[List[DataSourceParameter]] = None + password: Optional[StrictStr] = Field(default=None, description="Database user password.") + private_key: Optional[StrictStr] = Field(default=None, description="Private key for data sources which supports key-pair authentication.", alias="privateKey") + private_key_passphrase: Optional[StrictStr] = Field(default=None, description="Passphrase for a encrypted version of a private key.", alias="privateKeyPassphrase") + var_schema: Optional[StrictStr] = Field(default=None, description="Database schema.", alias="schema") + token: Optional[StrictStr] = Field(default=None, description="Secret for token based authentication for data sources which supports it.") + url: Optional[StrictStr] = Field(default=None, description="URL to database in JDBC format, where test should connect to.") + username: Optional[StrictStr] = Field(default=None, description="Database user name.") + __properties: ClassVar[List[str]] = ["clientId", "clientSecret", "parameters", "password", "privateKey", "privateKeyPassphrase", "schema", "token", "url", "username"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TestRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in parameters (list) + _items = [] + if self.parameters: + for _item_parameters in self.parameters: + if _item_parameters: + _items.append(_item_parameters.to_dict()) + _dict['parameters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TestRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "parameters": [DataSourceParameter.from_dict(_item) for _item in obj["parameters"]] if obj.get("parameters") is not None else None, + "password": obj.get("password"), + "privateKey": obj.get("privateKey"), + "privateKeyPassphrase": obj.get("privateKeyPassphrase"), + "schema": obj.get("schema"), + "token": obj.get("token"), + "url": obj.get("url"), + "username": obj.get("username") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/test_response.py b/gooddata-api-client/gooddata_api_client/models/test_response.py new file mode 100644 index 000000000..c03271cab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/test_response.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.test_query_duration import TestQueryDuration +from typing import Optional, Set +from typing_extensions import Self + +class TestResponse(BaseModel): + """ + Response from data source testing. + """ # noqa: E501 + error: Optional[StrictStr] = Field(default=None, description="Field containing more details in case of a failure. Details are available to a privileged user only.") + query_duration_millis: Optional[TestQueryDuration] = Field(default=None, alias="queryDurationMillis") + successful: StrictBool = Field(description="A flag indicating whether test passed or not.") + __properties: ClassVar[List[str]] = ["error", "queryDurationMillis", "successful"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TestResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of query_duration_millis + if self.query_duration_millis: + _dict['queryDurationMillis'] = self.query_duration_millis.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TestResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "error": obj.get("error"), + "queryDurationMillis": TestQueryDuration.from_dict(obj["queryDurationMillis"]) if obj.get("queryDurationMillis") is not None else None, + "successful": obj.get("successful") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/total.py b/gooddata-api-client/gooddata_api_client/models/total.py new file mode 100644 index 000000000..d2852754b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/total.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.total_dimension import TotalDimension +from typing import Optional, Set +from typing_extensions import Self + +class Total(BaseModel): + """ + Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it's described in `TotalDimension` + """ # noqa: E501 + function: StrictStr = Field(description="Aggregation function to compute the total.") + local_identifier: StrictStr = Field(description="Total identification within this request. Used e.g. in sorting by a total.", alias="localIdentifier") + metric: StrictStr = Field(description="The metric for which the total will be computed") + total_dimensions: List[TotalDimension] = Field(alias="totalDimensions") + __properties: ClassVar[List[str]] = ["function", "localIdentifier", "metric", "totalDimensions"] + + @field_validator('function') + def function_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['SUM', 'MIN', 'MAX', 'AVG', 'MED', 'NAT']): + raise ValueError("must be one of enum values ('SUM', 'MIN', 'MAX', 'AVG', 'MED', 'NAT')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Total from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in total_dimensions (list) + _items = [] + if self.total_dimensions: + for _item_total_dimensions in self.total_dimensions: + if _item_total_dimensions: + _items.append(_item_total_dimensions.to_dict()) + _dict['totalDimensions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Total from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "function": obj.get("function"), + "localIdentifier": obj.get("localIdentifier"), + "metric": obj.get("metric"), + "totalDimensions": [TotalDimension.from_dict(_item) for _item in obj["totalDimensions"]] if obj.get("totalDimensions") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/total_dimension.py b/gooddata-api-client/gooddata_api_client/models/total_dimension.py new file mode 100644 index 000000000..bbf7d948e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/total_dimension.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class TotalDimension(BaseModel): + """ + A list of dimensions across which the total will be computed. Total headers for only these dimensions will be returned in the result. + """ # noqa: E501 + dimension_identifier: Annotated[str, Field(strict=True)] = Field(description="An identifier of a dimension for which the total will be computed.", alias="dimensionIdentifier") + total_dimension_items: List[StrictStr] = Field(description="List of dimension items which will be used for total computation. The total is a grand total in this dimension if the list is empty or it includes the first dimension item from the dimension definition, and its data and header will be returned in a separate `ExecutionResultGrandTotal` structure. Otherwise, it is a subtotal and the data will be integrated into the main result.", alias="totalDimensionItems") + __properties: ClassVar[List[str]] = ["dimensionIdentifier", "totalDimensionItems"] + + @field_validator('dimension_identifier') + def dimension_identifier_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[.a-zA-Z0-9_-]+$", value): + raise ValueError(r"must validate the regular expression /^[.a-zA-Z0-9_-]+$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TotalDimension from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TotalDimension from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensionIdentifier": obj.get("dimensionIdentifier"), + "totalDimensionItems": obj.get("totalDimensionItems") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/total_execution_result_header.py b/gooddata-api-client/gooddata_api_client/models/total_execution_result_header.py new file mode 100644 index 000000000..f3789fb5d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/total_execution_result_header.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.total_result_header import TotalResultHeader +from typing import Optional, Set +from typing_extensions import Self + +class TotalExecutionResultHeader(BaseModel): + """ + TotalExecutionResultHeader + """ # noqa: E501 + total_header: TotalResultHeader = Field(alias="totalHeader") + __properties: ClassVar[List[str]] = ["totalHeader"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TotalExecutionResultHeader from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of total_header + if self.total_header: + _dict['totalHeader'] = self.total_header.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TotalExecutionResultHeader from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "totalHeader": TotalResultHeader.from_dict(obj["totalHeader"]) if obj.get("totalHeader") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/total_result_header.py b/gooddata-api-client/gooddata_api_client/models/total_result_header.py new file mode 100644 index 000000000..59547cd40 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/total_result_header.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class TotalResultHeader(BaseModel): + """ + Header containing the information related to a subtotal. + """ # noqa: E501 + function: StrictStr + __properties: ClassVar[List[str]] = ["function"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TotalResultHeader from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TotalResultHeader from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "function": obj.get("function") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/trigger_automation_request.py b/gooddata-api-client/gooddata_api_client/models/trigger_automation_request.py new file mode 100644 index 000000000..768321fa9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/trigger_automation_request.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.ad_hoc_automation import AdHocAutomation +from typing import Optional, Set +from typing_extensions import Self + +class TriggerAutomationRequest(BaseModel): + """ + TriggerAutomationRequest + """ # noqa: E501 + automation: AdHocAutomation + __properties: ClassVar[List[str]] = ["automation"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TriggerAutomationRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of automation + if self.automation: + _dict['automation'] = self.automation.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TriggerAutomationRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "automation": AdHocAutomation.from_dict(obj["automation"]) if obj.get("automation") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_assignee.py b/gooddata-api-client/gooddata_api_client/models/user_assignee.py new file mode 100644 index 000000000..f3687d191 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_assignee.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class UserAssignee(BaseModel): + """ + List of users + """ # noqa: E501 + email: Optional[StrictStr] = Field(default=None, description="User email address") + id: StrictStr + name: Optional[StrictStr] = Field(default=None, description="User name") + __properties: ClassVar[List[str]] = ["email", "id", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserAssignee from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserAssignee from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "email": obj.get("email"), + "id": obj.get("id"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_context.py b/gooddata-api-client/gooddata_api_client/models/user_context.py new file mode 100644 index 000000000..4c717e5c0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_context.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.active_object_identification import ActiveObjectIdentification +from typing import Optional, Set +from typing_extensions import Self + +class UserContext(BaseModel): + """ + User context, which can affect the behavior of the underlying AI features. + """ # noqa: E501 + active_object: ActiveObjectIdentification = Field(alias="activeObject") + __properties: ClassVar[List[str]] = ["activeObject"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserContext from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of active_object + if self.active_object: + _dict['activeObject'] = self.active_object.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserContext from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "activeObject": ActiveObjectIdentification.from_dict(obj["activeObject"]) if obj.get("activeObject") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_group_assignee.py b/gooddata-api-client/gooddata_api_client/models/user_group_assignee.py new file mode 100644 index 000000000..c1b2ef2d3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_group_assignee.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class UserGroupAssignee(BaseModel): + """ + List of user groups + """ # noqa: E501 + id: StrictStr + name: Optional[StrictStr] = Field(default=None, description="User group name") + __properties: ClassVar[List[str]] = ["id", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserGroupAssignee from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserGroupAssignee from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_group_identifier.py b/gooddata-api-client/gooddata_api_client/models/user_group_identifier.py new file mode 100644 index 000000000..dcddbb8bb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_group_identifier.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class UserGroupIdentifier(BaseModel): + """ + A list of groups where user is a member + """ # noqa: E501 + id: StrictStr + name: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["id", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserGroupIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserGroupIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_group_permission.py b/gooddata-api-client/gooddata_api_client/models/user_group_permission.py new file mode 100644 index 000000000..deddb7ccf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_group_permission.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.granted_permission import GrantedPermission +from typing import Optional, Set +from typing_extensions import Self + +class UserGroupPermission(BaseModel): + """ + List of user groups + """ # noqa: E501 + id: StrictStr + name: Optional[StrictStr] = Field(default=None, description="Name of the user group") + permissions: Optional[List[GrantedPermission]] = Field(default=None, description="Permissions granted to the user group") + __properties: ClassVar[List[str]] = ["id", "name", "permissions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserGroupPermission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserGroupPermission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "permissions": [GrantedPermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_management_data_source_permission_assignment.py b/gooddata-api-client/gooddata_api_client/models/user_management_data_source_permission_assignment.py new file mode 100644 index 000000000..febf65c0b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_management_data_source_permission_assignment.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class UserManagementDataSourcePermissionAssignment(BaseModel): + """ + Datasource permission assignments for users and userGroups + """ # noqa: E501 + id: StrictStr = Field(description="Id of the datasource") + name: Optional[StrictStr] = Field(default=None, description="Name of the datasource") + permissions: List[StrictStr] + __properties: ClassVar[List[str]] = ["id", "name", "permissions"] + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['MANAGE', 'USE']): + raise ValueError("each list item must be one of ('MANAGE', 'USE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserManagementDataSourcePermissionAssignment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "name", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserManagementDataSourcePermissionAssignment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "permissions": obj.get("permissions") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_management_permission_assignments.py b/gooddata-api-client/gooddata_api_client/models/user_management_permission_assignments.py new file mode 100644 index 000000000..2d7adb2d6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_management_permission_assignments.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment +from gooddata_api_client.models.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment +from typing import Optional, Set +from typing_extensions import Self + +class UserManagementPermissionAssignments(BaseModel): + """ + UserManagementPermissionAssignments + """ # noqa: E501 + data_sources: List[UserManagementDataSourcePermissionAssignment] = Field(alias="dataSources") + workspaces: List[UserManagementWorkspacePermissionAssignment] + __properties: ClassVar[List[str]] = ["dataSources", "workspaces"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserManagementPermissionAssignments from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_sources (list) + _items = [] + if self.data_sources: + for _item_data_sources in self.data_sources: + if _item_data_sources: + _items.append(_item_data_sources.to_dict()) + _dict['dataSources'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in workspaces (list) + _items = [] + if self.workspaces: + for _item_workspaces in self.workspaces: + if _item_workspaces: + _items.append(_item_workspaces.to_dict()) + _dict['workspaces'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserManagementPermissionAssignments from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataSources": [UserManagementDataSourcePermissionAssignment.from_dict(_item) for _item in obj["dataSources"]] if obj.get("dataSources") is not None else None, + "workspaces": [UserManagementWorkspacePermissionAssignment.from_dict(_item) for _item in obj["workspaces"]] if obj.get("workspaces") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_management_user_group_member.py b/gooddata-api-client/gooddata_api_client/models/user_management_user_group_member.py new file mode 100644 index 000000000..43d783065 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_management_user_group_member.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class UserManagementUserGroupMember(BaseModel): + """ + UserManagementUserGroupMember + """ # noqa: E501 + id: StrictStr + name: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["id", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserManagementUserGroupMember from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "name", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserManagementUserGroupMember from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_management_user_group_members.py b/gooddata-api-client/gooddata_api_client/models/user_management_user_group_members.py new file mode 100644 index 000000000..7607430ca --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_management_user_group_members.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.user_management_user_group_member import UserManagementUserGroupMember +from typing import Optional, Set +from typing_extensions import Self + +class UserManagementUserGroupMembers(BaseModel): + """ + UserManagementUserGroupMembers + """ # noqa: E501 + members: List[UserManagementUserGroupMember] + __properties: ClassVar[List[str]] = ["members"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserManagementUserGroupMembers from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in members (list) + _items = [] + if self.members: + for _item_members in self.members: + if _item_members: + _items.append(_item_members.to_dict()) + _dict['members'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserManagementUserGroupMembers from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "members": [UserManagementUserGroupMember.from_dict(_item) for _item in obj["members"]] if obj.get("members") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_management_user_groups.py b/gooddata-api-client/gooddata_api_client/models/user_management_user_groups.py new file mode 100644 index 000000000..a93e871a4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_management_user_groups.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.user_management_user_groups_item import UserManagementUserGroupsItem +from typing import Optional, Set +from typing_extensions import Self + +class UserManagementUserGroups(BaseModel): + """ + UserManagementUserGroups + """ # noqa: E501 + total_count: StrictInt = Field(description="Total number of groups", alias="totalCount") + user_groups: List[UserManagementUserGroupsItem] = Field(alias="userGroups") + __properties: ClassVar[List[str]] = ["totalCount", "userGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserManagementUserGroups from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserManagementUserGroups from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "totalCount": obj.get("totalCount"), + "userGroups": [UserManagementUserGroupsItem.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_management_user_groups_item.py b/gooddata-api-client/gooddata_api_client/models/user_management_user_groups_item.py new file mode 100644 index 000000000..e4abb9da1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_management_user_groups_item.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment +from gooddata_api_client.models.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment +from typing import Optional, Set +from typing_extensions import Self + +class UserManagementUserGroupsItem(BaseModel): + """ + List of groups + """ # noqa: E501 + data_sources: List[UserManagementDataSourcePermissionAssignment] = Field(alias="dataSources") + id: StrictStr + name: Optional[StrictStr] = Field(default=None, description="Group name") + organization_admin: StrictBool = Field(description="Is group organization admin", alias="organizationAdmin") + user_count: StrictInt = Field(description="The number of users belonging to the group", alias="userCount") + workspaces: List[UserManagementWorkspacePermissionAssignment] + __properties: ClassVar[List[str]] = ["dataSources", "id", "name", "organizationAdmin", "userCount", "workspaces"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserManagementUserGroupsItem from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_sources (list) + _items = [] + if self.data_sources: + for _item_data_sources in self.data_sources: + if _item_data_sources: + _items.append(_item_data_sources.to_dict()) + _dict['dataSources'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in workspaces (list) + _items = [] + if self.workspaces: + for _item_workspaces in self.workspaces: + if _item_workspaces: + _items.append(_item_workspaces.to_dict()) + _dict['workspaces'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserManagementUserGroupsItem from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataSources": [UserManagementDataSourcePermissionAssignment.from_dict(_item) for _item in obj["dataSources"]] if obj.get("dataSources") is not None else None, + "id": obj.get("id"), + "name": obj.get("name"), + "organizationAdmin": obj.get("organizationAdmin"), + "userCount": obj.get("userCount"), + "workspaces": [UserManagementWorkspacePermissionAssignment.from_dict(_item) for _item in obj["workspaces"]] if obj.get("workspaces") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_management_users.py b/gooddata-api-client/gooddata_api_client/models/user_management_users.py new file mode 100644 index 000000000..690dee6dc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_management_users.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.user_management_users_item import UserManagementUsersItem +from typing import Optional, Set +from typing_extensions import Self + +class UserManagementUsers(BaseModel): + """ + UserManagementUsers + """ # noqa: E501 + total_count: StrictInt = Field(description="The total number of users is based on applied filters.", alias="totalCount") + users: List[UserManagementUsersItem] + __properties: ClassVar[List[str]] = ["totalCount", "users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserManagementUsers from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserManagementUsers from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "totalCount": obj.get("totalCount"), + "users": [UserManagementUsersItem.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_management_users_item.py b/gooddata-api-client/gooddata_api_client/models/user_management_users_item.py new file mode 100644 index 000000000..915e71b47 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_management_users_item.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.user_group_identifier import UserGroupIdentifier +from gooddata_api_client.models.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment +from gooddata_api_client.models.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment +from typing import Optional, Set +from typing_extensions import Self + +class UserManagementUsersItem(BaseModel): + """ + List of users + """ # noqa: E501 + data_sources: List[UserManagementDataSourcePermissionAssignment] = Field(alias="dataSources") + email: Optional[StrictStr] = Field(default=None, description="User email address") + id: StrictStr + name: Optional[StrictStr] = Field(default=None, description="User name") + organization_admin: StrictBool = Field(description="Is user organization admin", alias="organizationAdmin") + user_groups: List[UserGroupIdentifier] = Field(alias="userGroups") + workspaces: List[UserManagementWorkspacePermissionAssignment] + __properties: ClassVar[List[str]] = ["dataSources", "email", "id", "name", "organizationAdmin", "userGroups", "workspaces"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserManagementUsersItem from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_sources (list) + _items = [] + if self.data_sources: + for _item_data_sources in self.data_sources: + if _item_data_sources: + _items.append(_item_data_sources.to_dict()) + _dict['dataSources'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in workspaces (list) + _items = [] + if self.workspaces: + for _item_workspaces in self.workspaces: + if _item_workspaces: + _items.append(_item_workspaces.to_dict()) + _dict['workspaces'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserManagementUsersItem from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataSources": [UserManagementDataSourcePermissionAssignment.from_dict(_item) for _item in obj["dataSources"]] if obj.get("dataSources") is not None else None, + "email": obj.get("email"), + "id": obj.get("id"), + "name": obj.get("name"), + "organizationAdmin": obj.get("organizationAdmin"), + "userGroups": [UserGroupIdentifier.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None, + "workspaces": [UserManagementWorkspacePermissionAssignment.from_dict(_item) for _item in obj["workspaces"]] if obj.get("workspaces") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_management_workspace_permission_assignment.py b/gooddata-api-client/gooddata_api_client/models/user_management_workspace_permission_assignment.py new file mode 100644 index 000000000..6309aaa50 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_management_workspace_permission_assignment.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class UserManagementWorkspacePermissionAssignment(BaseModel): + """ + Workspace permission assignments for users and userGroups + """ # noqa: E501 + hierarchy_permissions: List[StrictStr] = Field(alias="hierarchyPermissions") + id: StrictStr + name: Optional[StrictStr] = None + permissions: List[StrictStr] + __properties: ClassVar[List[str]] = ["hierarchyPermissions", "id", "name", "permissions"] + + @field_validator('hierarchy_permissions') + def hierarchy_permissions_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW']): + raise ValueError("each list item must be one of ('MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW')") + return value + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW']): + raise ValueError("each list item must be one of ('MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserManagementWorkspacePermissionAssignment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "name", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserManagementWorkspacePermissionAssignment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "hierarchyPermissions": obj.get("hierarchyPermissions"), + "id": obj.get("id"), + "name": obj.get("name"), + "permissions": obj.get("permissions") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/user_permission.py b/gooddata-api-client/gooddata_api_client/models/user_permission.py new file mode 100644 index 000000000..e404a0088 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/user_permission.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.granted_permission import GrantedPermission +from typing import Optional, Set +from typing_extensions import Self + +class UserPermission(BaseModel): + """ + List of users + """ # noqa: E501 + email: Optional[StrictStr] = Field(default=None, description="User email address") + id: StrictStr + name: Optional[StrictStr] = Field(default=None, description="Name of user") + permissions: Optional[List[GrantedPermission]] = Field(default=None, description="Permissions granted to the user") + __properties: ClassVar[List[str]] = ["email", "id", "name", "permissions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserPermission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserPermission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "email": obj.get("email"), + "id": obj.get("id"), + "name": obj.get("name"), + "permissions": [GrantedPermission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/validate_by_item.py b/gooddata-api-client/gooddata_api_client/models/validate_by_item.py new file mode 100644 index 000000000..96416fc3f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/validate_by_item.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class ValidateByItem(BaseModel): + """ + ValidateByItem + """ # noqa: E501 + id: StrictStr = Field(description="Specifies entity used for valid elements computation.") + type: Annotated[str, Field(strict=True)] = Field(description="Specifies entity type which could be label, attribute, fact, or metric.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('type') + def type_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(label)|(attribute)|(fact)|(metric)$", value): + raise ValueError(r"must validate the regular expression /^(label)|(attribute)|(fact)|(metric)$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ValidateByItem from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ValidateByItem from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/validate_llm_endpoint_by_id_request.py b/gooddata-api-client/gooddata_api_client/models/validate_llm_endpoint_by_id_request.py new file mode 100644 index 000000000..218c13de1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/validate_llm_endpoint_by_id_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ValidateLLMEndpointByIdRequest(BaseModel): + """ + ValidateLLMEndpointByIdRequest + """ # noqa: E501 + base_url: Optional[StrictStr] = Field(default=None, description="Base URL for the LLM endpoint validation", alias="baseUrl") + llm_model: Optional[StrictStr] = Field(default=None, description="LLM model for the LLM endpoint validation", alias="llmModel") + llm_organization: Optional[StrictStr] = Field(default=None, description="Organization name for the LLM endpoint validation", alias="llmOrganization") + provider: Optional[StrictStr] = Field(default=None, description="Provider for the LLM endpoint validation") + token: Optional[StrictStr] = Field(default=None, description="Token for the LLM endpoint validation") + __properties: ClassVar[List[str]] = ["baseUrl", "llmModel", "llmOrganization", "provider", "token"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ValidateLLMEndpointByIdRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ValidateLLMEndpointByIdRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "baseUrl": obj.get("baseUrl"), + "llmModel": obj.get("llmModel"), + "llmOrganization": obj.get("llmOrganization"), + "provider": obj.get("provider"), + "token": obj.get("token") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/validate_llm_endpoint_request.py b/gooddata-api-client/gooddata_api_client/models/validate_llm_endpoint_request.py new file mode 100644 index 000000000..a656535b6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/validate_llm_endpoint_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ValidateLLMEndpointRequest(BaseModel): + """ + ValidateLLMEndpointRequest + """ # noqa: E501 + base_url: Optional[StrictStr] = Field(default=None, description="Base URL for the LLM endpoint validation", alias="baseUrl") + llm_model: Optional[StrictStr] = Field(default=None, description="LLM model for the LLM endpoint validation", alias="llmModel") + llm_organization: Optional[StrictStr] = Field(default=None, description="Organization name for the LLM endpoint validation", alias="llmOrganization") + provider: StrictStr = Field(description="Provider for the LLM endpoint validation") + token: StrictStr = Field(description="Token for the LLM endpoint validation") + __properties: ClassVar[List[str]] = ["baseUrl", "llmModel", "llmOrganization", "provider", "token"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ValidateLLMEndpointRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ValidateLLMEndpointRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "baseUrl": obj.get("baseUrl"), + "llmModel": obj.get("llmModel"), + "llmOrganization": obj.get("llmOrganization"), + "provider": obj.get("provider"), + "token": obj.get("token") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/validate_llm_endpoint_response.py b/gooddata-api-client/gooddata_api_client/models/validate_llm_endpoint_response.py new file mode 100644 index 000000000..7a0ebc9df --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/validate_llm_endpoint_response.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ValidateLLMEndpointResponse(BaseModel): + """ + ValidateLLMEndpointResponse + """ # noqa: E501 + message: StrictStr = Field(description="Additional message about the LLM endpoint validation") + successful: StrictBool = Field(description="Whether the LLM endpoint validation was successful") + __properties: ClassVar[List[str]] = ["message", "successful"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ValidateLLMEndpointResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ValidateLLMEndpointResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "successful": obj.get("successful") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/value.py b/gooddata-api-client/gooddata_api_client/models/value.py new file mode 100644 index 000000000..a97dc6bd2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/value.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt +from typing import Any, ClassVar, Dict, List, Union +from typing import Optional, Set +from typing_extensions import Self + +class Value(BaseModel): + """ + Value + """ # noqa: E501 + value: Union[StrictFloat, StrictInt] = Field(description="Value of the alert threshold to compare the metric to.") + __properties: ClassVar[List[str]] = ["value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Value from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Value from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "value": obj.get("value") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/visible_filter.py b/gooddata-api-client/gooddata_api_client/models/visible_filter.py new file mode 100644 index 000000000..c9bd80257 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/visible_filter.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class VisibleFilter(BaseModel): + """ + VisibleFilter + """ # noqa: E501 + is_all_time_date_filter: Optional[StrictBool] = Field(default=False, description="Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.", alias="isAllTimeDateFilter") + local_identifier: Optional[StrictStr] = Field(default=None, alias="localIdentifier") + title: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["isAllTimeDateFilter", "localIdentifier", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of VisibleFilter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of VisibleFilter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "isAllTimeDateFilter": obj.get("isAllTimeDateFilter") if obj.get("isAllTimeDateFilter") is not None else False, + "localIdentifier": obj.get("localIdentifier"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/visual_export_request.py b/gooddata-api-client/gooddata_api_client/models/visual_export_request.py new file mode 100644 index 000000000..5f04c980e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/visual_export_request.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class VisualExportRequest(BaseModel): + """ + Export request object describing the export properties and metadata for dashboard PDF exports. + """ # noqa: E501 + dashboard_id: StrictStr = Field(description="Dashboard identifier", alias="dashboardId") + file_name: StrictStr = Field(description="File name to be used for retrieving the pdf document.", alias="fileName") + metadata: Optional[Dict[str, Any]] = Field(default=None, description="Metadata definition in free-form JSON format.") + __properties: ClassVar[List[str]] = ["dashboardId", "fileName", "metadata"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of VisualExportRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of VisualExportRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dashboardId": obj.get("dashboardId"), + "fileName": obj.get("fileName"), + "metadata": obj.get("metadata") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/webhook.py b/gooddata-api-client/gooddata_api_client/models/webhook.py new file mode 100644 index 000000000..86075f656 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/webhook.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class Webhook(BaseModel): + """ + Webhook destination for notifications. The property url is required on create and update. + """ # noqa: E501 + has_token: Optional[StrictBool] = Field(default=None, description="Flag indicating if webhook has a token.", alias="hasToken") + token: Optional[Annotated[str, Field(strict=True, max_length=10000)]] = Field(default=None, description="Bearer token for the webhook.") + type: StrictStr = Field(description="The destination type.") + url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="The webhook URL.") + __properties: ClassVar[List[str]] = ["hasToken", "token", "type", "url"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['WEBHOOK']): + raise ValueError("must be one of enum values ('WEBHOOK')") + return value + + @field_validator('url') + def url_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"https?\:\/\/.*", value): + raise ValueError(r"must validate the regular expression /https?\:\/\/.*/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Webhook from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "has_token", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if has_token (nullable) is None + # and model_fields_set contains the field + if self.has_token is None and "has_token" in self.model_fields_set: + _dict['hasToken'] = None + + # set to None if token (nullable) is None + # and model_fields_set contains the field + if self.token is None and "token" in self.model_fields_set: + _dict['token'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Webhook from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "hasToken": obj.get("hasToken"), + "token": obj.get("token"), + "type": obj.get("type"), + "url": obj.get("url") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/webhook_automation_info.py b/gooddata-api-client/gooddata_api_client/models/webhook_automation_info.py new file mode 100644 index 000000000..07fa14cfc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/webhook_automation_info.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class WebhookAutomationInfo(BaseModel): + """ + WebhookAutomationInfo + """ # noqa: E501 + dashboard_title: Optional[StrictStr] = Field(default=None, alias="dashboardTitle") + dashboard_url: StrictStr = Field(alias="dashboardURL") + id: StrictStr + is_custom_dashboard_url: StrictBool = Field(alias="isCustomDashboardURL") + title: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["dashboardTitle", "dashboardURL", "id", "isCustomDashboardURL", "title"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WebhookAutomationInfo from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WebhookAutomationInfo from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dashboardTitle": obj.get("dashboardTitle"), + "dashboardURL": obj.get("dashboardURL"), + "id": obj.get("id"), + "isCustomDashboardURL": obj.get("isCustomDashboardURL"), + "title": obj.get("title") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/webhook_message.py b/gooddata-api-client/gooddata_api_client/models/webhook_message.py new file mode 100644 index 000000000..764ee62fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/webhook_message.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.webhook_message_data import WebhookMessageData +from typing import Optional, Set +from typing_extensions import Self + +class WebhookMessage(BaseModel): + """ + WebhookMessage + """ # noqa: E501 + data: WebhookMessageData + timestamp: datetime + type: StrictStr + __properties: ClassVar[List[str]] = ["data", "timestamp", "type"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['automation-task.completed', 'automation-task.limit-exceeded']): + raise ValueError("must be one of enum values ('automation-task.completed', 'automation-task.limit-exceeded')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WebhookMessage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WebhookMessage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": WebhookMessageData.from_dict(obj["data"]) if obj.get("data") is not None else None, + "timestamp": obj.get("timestamp"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/webhook_message_data.py b/gooddata-api-client/gooddata_api_client/models/webhook_message_data.py new file mode 100644 index 000000000..44971edd7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/webhook_message_data.py @@ -0,0 +1,179 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.alert_description import AlertDescription +from gooddata_api_client.models.export_result import ExportResult +from gooddata_api_client.models.notification_filter import NotificationFilter +from gooddata_api_client.models.webhook_automation_info import WebhookAutomationInfo +from gooddata_api_client.models.webhook_recipient import WebhookRecipient +from typing import Optional, Set +from typing_extensions import Self + +class WebhookMessageData(BaseModel): + """ + WebhookMessageData + """ # noqa: E501 + alert: Optional[AlertDescription] = None + automation: WebhookAutomationInfo + dashboard_tabular_exports: Optional[List[ExportResult]] = Field(default=None, alias="dashboardTabularExports") + details: Optional[Dict[str, StrictStr]] = None + filters: Optional[List[NotificationFilter]] = None + image_exports: Optional[List[ExportResult]] = Field(default=None, alias="imageExports") + notification_source: Optional[StrictStr] = Field(default=None, alias="notificationSource") + raw_exports: Optional[List[ExportResult]] = Field(default=None, alias="rawExports") + recipients: Optional[List[WebhookRecipient]] = None + remaining_action_count: Optional[StrictInt] = Field(default=None, alias="remainingActionCount") + slides_exports: Optional[List[ExportResult]] = Field(default=None, alias="slidesExports") + tabular_exports: Optional[List[ExportResult]] = Field(default=None, alias="tabularExports") + visual_exports: Optional[List[ExportResult]] = Field(default=None, alias="visualExports") + __properties: ClassVar[List[str]] = ["alert", "automation", "dashboardTabularExports", "details", "filters", "imageExports", "notificationSource", "rawExports", "recipients", "remainingActionCount", "slidesExports", "tabularExports", "visualExports"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WebhookMessageData from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of alert + if self.alert: + _dict['alert'] = self.alert.to_dict() + # override the default output from pydantic by calling `to_dict()` of automation + if self.automation: + _dict['automation'] = self.automation.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in dashboard_tabular_exports (list) + _items = [] + if self.dashboard_tabular_exports: + for _item_dashboard_tabular_exports in self.dashboard_tabular_exports: + if _item_dashboard_tabular_exports: + _items.append(_item_dashboard_tabular_exports.to_dict()) + _dict['dashboardTabularExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in filters (list) + _items = [] + if self.filters: + for _item_filters in self.filters: + if _item_filters: + _items.append(_item_filters.to_dict()) + _dict['filters'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in image_exports (list) + _items = [] + if self.image_exports: + for _item_image_exports in self.image_exports: + if _item_image_exports: + _items.append(_item_image_exports.to_dict()) + _dict['imageExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in raw_exports (list) + _items = [] + if self.raw_exports: + for _item_raw_exports in self.raw_exports: + if _item_raw_exports: + _items.append(_item_raw_exports.to_dict()) + _dict['rawExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in recipients (list) + _items = [] + if self.recipients: + for _item_recipients in self.recipients: + if _item_recipients: + _items.append(_item_recipients.to_dict()) + _dict['recipients'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in slides_exports (list) + _items = [] + if self.slides_exports: + for _item_slides_exports in self.slides_exports: + if _item_slides_exports: + _items.append(_item_slides_exports.to_dict()) + _dict['slidesExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in tabular_exports (list) + _items = [] + if self.tabular_exports: + for _item_tabular_exports in self.tabular_exports: + if _item_tabular_exports: + _items.append(_item_tabular_exports.to_dict()) + _dict['tabularExports'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in visual_exports (list) + _items = [] + if self.visual_exports: + for _item_visual_exports in self.visual_exports: + if _item_visual_exports: + _items.append(_item_visual_exports.to_dict()) + _dict['visualExports'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WebhookMessageData from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "alert": AlertDescription.from_dict(obj["alert"]) if obj.get("alert") is not None else None, + "automation": WebhookAutomationInfo.from_dict(obj["automation"]) if obj.get("automation") is not None else None, + "dashboardTabularExports": [ExportResult.from_dict(_item) for _item in obj["dashboardTabularExports"]] if obj.get("dashboardTabularExports") is not None else None, + "details": obj.get("details"), + "filters": [NotificationFilter.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None, + "imageExports": [ExportResult.from_dict(_item) for _item in obj["imageExports"]] if obj.get("imageExports") is not None else None, + "notificationSource": obj.get("notificationSource"), + "rawExports": [ExportResult.from_dict(_item) for _item in obj["rawExports"]] if obj.get("rawExports") is not None else None, + "recipients": [WebhookRecipient.from_dict(_item) for _item in obj["recipients"]] if obj.get("recipients") is not None else None, + "remainingActionCount": obj.get("remainingActionCount"), + "slidesExports": [ExportResult.from_dict(_item) for _item in obj["slidesExports"]] if obj.get("slidesExports") is not None else None, + "tabularExports": [ExportResult.from_dict(_item) for _item in obj["tabularExports"]] if obj.get("tabularExports") is not None else None, + "visualExports": [ExportResult.from_dict(_item) for _item in obj["visualExports"]] if obj.get("visualExports") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/webhook_recipient.py b/gooddata-api-client/gooddata_api_client/models/webhook_recipient.py new file mode 100644 index 000000000..c28c8a7b6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/webhook_recipient.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class WebhookRecipient(BaseModel): + """ + WebhookRecipient + """ # noqa: E501 + email: StrictStr + id: StrictStr + __properties: ClassVar[List[str]] = ["email", "id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WebhookRecipient from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WebhookRecipient from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "email": obj.get("email"), + "id": obj.get("id") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/widget_slides_template.py b/gooddata-api-client/gooddata_api_client/models/widget_slides_template.py new file mode 100644 index 000000000..90d6de280 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/widget_slides_template.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from gooddata_api_client.models.content_slide_template import ContentSlideTemplate +from typing import Optional, Set +from typing_extensions import Self + +class WidgetSlidesTemplate(BaseModel): + """ + Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + """ # noqa: E501 + applied_on: Annotated[List[StrictStr], Field(min_length=1)] = Field(description="Export types this template applies to.", alias="appliedOn") + content_slide: Optional[ContentSlideTemplate] = Field(default=None, alias="contentSlide") + __properties: ClassVar[List[str]] = ["appliedOn", "contentSlide"] + + @field_validator('applied_on') + def applied_on_validate_enum(cls, value): + """Validates the enum""" + for i in value: + if i not in set(['PDF', 'PPTX']): + raise ValueError("each list item must be one of ('PDF', 'PPTX')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WidgetSlidesTemplate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of content_slide + if self.content_slide: + _dict['contentSlide'] = self.content_slide.to_dict() + # set to None if content_slide (nullable) is None + # and model_fields_set contains the field + if self.content_slide is None and "content_slide" in self.model_fields_set: + _dict['contentSlide'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WidgetSlidesTemplate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "appliedOn": obj.get("appliedOn"), + "contentSlide": ContentSlideTemplate.from_dict(obj["contentSlide"]) if obj.get("contentSlide") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/workspace_automation_identifier.py b/gooddata-api-client/gooddata_api_client/models/workspace_automation_identifier.py new file mode 100644 index 000000000..1dd79a496 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/workspace_automation_identifier.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class WorkspaceAutomationIdentifier(BaseModel): + """ + WorkspaceAutomationIdentifier + """ # noqa: E501 + id: StrictStr + __properties: ClassVar[List[str]] = ["id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkspaceAutomationIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkspaceAutomationIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/workspace_automation_management_bulk_request.py b/gooddata-api-client/gooddata_api_client/models/workspace_automation_management_bulk_request.py new file mode 100644 index 000000000..02d7281a0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/workspace_automation_management_bulk_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.workspace_automation_identifier import WorkspaceAutomationIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class WorkspaceAutomationManagementBulkRequest(BaseModel): + """ + WorkspaceAutomationManagementBulkRequest + """ # noqa: E501 + automations: List[WorkspaceAutomationIdentifier] + __properties: ClassVar[List[str]] = ["automations"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkspaceAutomationManagementBulkRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in automations (list) + _items = [] + if self.automations: + for _item_automations in self.automations: + if _item_automations: + _items.append(_item_automations.to_dict()) + _dict['automations'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkspaceAutomationManagementBulkRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "automations": [WorkspaceAutomationIdentifier.from_dict(_item) for _item in obj["automations"]] if obj.get("automations") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/workspace_data_source.py b/gooddata-api-client/gooddata_api_client/models/workspace_data_source.py new file mode 100644 index 000000000..2835ffa9a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/workspace_data_source.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class WorkspaceDataSource(BaseModel): + """ + The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace. + """ # noqa: E501 + id: StrictStr = Field(description="The ID of the used data source.") + schema_path: Optional[List[StrictStr]] = Field(default=None, description="The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", alias="schemaPath") + __properties: ClassVar[List[str]] = ["id", "schemaPath"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkspaceDataSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkspaceDataSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "schemaPath": obj.get("schemaPath") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/workspace_identifier.py b/gooddata-api-client/gooddata_api_client/models/workspace_identifier.py new file mode 100644 index 000000000..62fbbba23 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/workspace_identifier.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class WorkspaceIdentifier(BaseModel): + """ + A workspace identifier. + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Identifier of the workspace.") + type: StrictStr = Field(description="A type.") + __properties: ClassVar[List[str]] = ["id", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?!\.)[.A-Za-z0-9_-]{1,255}$", value): + raise ValueError(r"must validate the regular expression /^(?!\.)[.A-Za-z0-9_-]{1,255}$/") + return value + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['workspace']): + raise ValueError("must be one of enum values ('workspace')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkspaceIdentifier from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkspaceIdentifier from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/workspace_permission_assignment.py b/gooddata-api-client/gooddata_api_client/models/workspace_permission_assignment.py new file mode 100644 index 000000000..584612522 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/workspace_permission_assignment.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from typing import Optional, Set +from typing_extensions import Self + +class WorkspacePermissionAssignment(BaseModel): + """ + Workspace permission assignments + """ # noqa: E501 + assignee_identifier: AssigneeIdentifier = Field(alias="assigneeIdentifier") + hierarchy_permissions: Optional[List[StrictStr]] = Field(default=None, alias="hierarchyPermissions") + permissions: Optional[List[StrictStr]] = None + __properties: ClassVar[List[str]] = ["assigneeIdentifier", "hierarchyPermissions", "permissions"] + + @field_validator('hierarchy_permissions') + def hierarchy_permissions_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW']): + raise ValueError("each list item must be one of ('MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW')") + return value + + @field_validator('permissions') + def permissions_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW']): + raise ValueError("each list item must be one of ('MANAGE', 'ANALYZE', 'EXPORT', 'EXPORT_TABULAR', 'EXPORT_PDF', 'CREATE_AUTOMATION', 'USE_AI_ASSISTANT', 'CREATE_FILTER_VIEW', 'VIEW')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkspacePermissionAssignment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of assignee_identifier + if self.assignee_identifier: + _dict['assigneeIdentifier'] = self.assignee_identifier.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkspacePermissionAssignment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assigneeIdentifier": AssigneeIdentifier.from_dict(obj["assigneeIdentifier"]) if obj.get("assigneeIdentifier") is not None else None, + "hierarchyPermissions": obj.get("hierarchyPermissions"), + "permissions": obj.get("permissions") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/workspace_user.py b/gooddata-api-client/gooddata_api_client/models/workspace_user.py new file mode 100644 index 000000000..cf82fbb71 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/workspace_user.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class WorkspaceUser(BaseModel): + """ + List of workspace users + """ # noqa: E501 + email: Optional[StrictStr] = Field(default=None, description="User email address") + id: StrictStr + name: Optional[StrictStr] = Field(default=None, description="User name") + __properties: ClassVar[List[str]] = ["email", "id", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkspaceUser from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkspaceUser from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "email": obj.get("email"), + "id": obj.get("id"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/workspace_user_group.py b/gooddata-api-client/gooddata_api_client/models/workspace_user_group.py new file mode 100644 index 000000000..8ab1e37ab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/workspace_user_group.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class WorkspaceUserGroup(BaseModel): + """ + List of workspace groups + """ # noqa: E501 + id: StrictStr + name: Optional[StrictStr] = Field(default=None, description="Group name") + __properties: ClassVar[List[str]] = ["id", "name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkspaceUserGroup from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkspaceUserGroup from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/workspace_user_groups.py b/gooddata-api-client/gooddata_api_client/models/workspace_user_groups.py new file mode 100644 index 000000000..4904e1af9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/workspace_user_groups.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.workspace_user_group import WorkspaceUserGroup +from typing import Optional, Set +from typing_extensions import Self + +class WorkspaceUserGroups(BaseModel): + """ + WorkspaceUserGroups + """ # noqa: E501 + total_count: StrictInt = Field(description="Total number of groups", alias="totalCount") + user_groups: List[WorkspaceUserGroup] = Field(alias="userGroups") + __properties: ClassVar[List[str]] = ["totalCount", "userGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkspaceUserGroups from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkspaceUserGroups from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "totalCount": obj.get("totalCount"), + "userGroups": [WorkspaceUserGroup.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/workspace_users.py b/gooddata-api-client/gooddata_api_client/models/workspace_users.py new file mode 100644 index 000000000..83e041377 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/workspace_users.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from gooddata_api_client.models.workspace_user import WorkspaceUser +from typing import Optional, Set +from typing_extensions import Self + +class WorkspaceUsers(BaseModel): + """ + WorkspaceUsers + """ # noqa: E501 + total_count: StrictInt = Field(description="The total number of users is based on applied filters.", alias="totalCount") + users: List[WorkspaceUser] + __properties: ClassVar[List[str]] = ["totalCount", "users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkspaceUsers from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkspaceUsers from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "totalCount": obj.get("totalCount"), + "users": [WorkspaceUser.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/models/xliff.py b/gooddata-api-client/gooddata_api_client/models/xliff.py new file mode 100644 index 000000000..6fabd48f6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/models/xliff.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from gooddata_api_client.models.file import File +from typing import Optional, Set +from typing_extensions import Self + +class Xliff(BaseModel): + """ + Xliff + """ # noqa: E501 + file: List[File] + other_attributes: Optional[Dict[str, StrictStr]] = Field(default=None, alias="otherAttributes") + space: Optional[StrictStr] = None + src_lang: Optional[StrictStr] = Field(default=None, alias="srcLang") + trg_lang: Optional[StrictStr] = Field(default=None, alias="trgLang") + version: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["file", "otherAttributes", "space", "srcLang", "trgLang", "version"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Xliff from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in file (list) + _items = [] + if self.file: + for _item_file in self.file: + if _item_file: + _items.append(_item_file.to_dict()) + _dict['file'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Xliff from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "file": [File.from_dict(_item) for _item in obj["file"]] if obj.get("file") is not None else None, + "otherAttributes": obj.get("otherAttributes"), + "space": obj.get("space"), + "srcLang": obj.get("srcLang"), + "trgLang": obj.get("trgLang"), + "version": obj.get("version") + }) + return _obj + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/get.py index 4560978a4..4d0b2d475 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage import PlatformUsage from . import path @@ -37,7 +37,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['PlatformUsage']: return PlatformUsage @@ -260,5 +260,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/get.pyi index fba6fa16e..cdafa6a8d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage import PlatformUsage @@ -35,7 +35,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['PlatformUsage']: return PlatformUsage @@ -255,5 +255,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/post.py index d143284dd..d4ebe4ba2 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage_request import PlatformUsageRequest +from gooddata_api_client.models.platform_usage import PlatformUsage from . import path @@ -49,7 +49,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['PlatformUsage']: return PlatformUsage @@ -355,5 +355,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/post.pyi index cf40a3592..31859ec2c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_collect_usage/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest -from gooddata_api_client.model.platform_usage import PlatformUsage +from gooddata_api_client.models.platform_usage_request import PlatformUsageRequest +from gooddata_api_client.models.platform_usage import PlatformUsage # body param SchemaForRequestBodyApplicationJson = PlatformUsageRequest @@ -47,7 +47,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['PlatformUsage']: return PlatformUsage @@ -350,5 +350,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_source_test/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_source_test/post.py index efb35f899..bee4c006f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_source_test/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_source_test/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest from . import path @@ -330,5 +330,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_source_test/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_source_test/post.pyi index 66bbda50a..7534a41da 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_source_test/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_source_test/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest # body param SchemaForRequestBodyApplicationJson = TestDefinitionRequest @@ -325,5 +325,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model/post.py index 839945f04..66475fe26 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_model import DeclarativeModel -from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest from . import path @@ -387,5 +387,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model/post.pyi index bd43ac641..64a14b692 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_model import DeclarativeModel -from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.models.declarative_model import DeclarativeModel +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest # Path params DataSourceIdSchema = schemas.StrSchema @@ -382,5 +382,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan/post.py index 22f0e7a36..bace7d863 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.scan_request import ScanRequest -from gooddata_api_client.model.scan_result_pdm import ScanResultPdm +from gooddata_api_client.models.scan_request import ScanRequest +from gooddata_api_client.models.scan_result_pdm import ScanResultPdm from . import path @@ -397,5 +397,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan/post.pyi index a6b0bb4f9..9107c3e88 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.scan_request import ScanRequest -from gooddata_api_client.model.scan_result_pdm import ScanResultPdm +from gooddata_api_client.models.scan_request import ScanRequest +from gooddata_api_client.models.scan_result_pdm import ScanResultPdm # Path params @@ -387,5 +387,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_schemata/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_schemata/get.py index edd9dd22d..b19aa1ddd 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_schemata/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_schemata/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.data_source_schemata import DataSourceSchemata +from gooddata_api_client.models.data_source_schemata import DataSourceSchemata from . import path @@ -299,5 +299,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_schemata/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_schemata/get.pyi index 60d26927e..ff64ec36b 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_schemata/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_schemata/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.data_source_schemata import DataSourceSchemata +from gooddata_api_client.models.data_source_schemata import DataSourceSchemata # Path params @@ -289,5 +289,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_sql/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_sql/post.py index 2996215ce..7e618beeb 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_sql/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_sql/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.scan_sql_response import ScanSqlResponse -from gooddata_api_client.model.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest from . import path @@ -397,5 +397,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_sql/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_sql/post.pyi index d4d9acf12..7de1b2671 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_sql/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_scan_sql/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.scan_sql_response import ScanSqlResponse -from gooddata_api_client.model.scan_sql_request import ScanSqlRequest +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest # Path params @@ -387,5 +387,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_test/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_test/post.py index ff601152b..fbe8125ed 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_test/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_test/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_request import TestRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.models.test_request import TestRequest from . import path @@ -397,5 +397,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_test/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_test/post.pyi index f32b9bcab..ad6009ac9 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_test/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_test/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.test_request import TestRequest +from gooddata_api_client.models.test_response import TestResponse +from gooddata_api_client.models.test_request import TestRequest # Path params @@ -387,5 +387,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/get.py index 07c82b10f..f352a83fd 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.api_entitlement import ApiEntitlement +from gooddata_api_client.models.api_entitlement import ApiEntitlement from . import path @@ -37,7 +37,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['ApiEntitlement']: return ApiEntitlement @@ -260,5 +260,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/get.pyi index 3dec408e3..484a56abc 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.api_entitlement import ApiEntitlement +from gooddata_api_client.models.api_entitlement import ApiEntitlement @@ -35,7 +35,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['ApiEntitlement']: return ApiEntitlement @@ -255,5 +255,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/post.py index 14c44bee9..97da76bb4 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.api_entitlement import ApiEntitlement -from gooddata_api_client.model.entitlements_request import EntitlementsRequest +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.models.entitlements_request import EntitlementsRequest from . import path @@ -49,7 +49,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['ApiEntitlement']: return ApiEntitlement @@ -355,5 +355,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/post.pyi index 48b797d71..73188013f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_entitlements/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.api_entitlement import ApiEntitlement -from gooddata_api_client.model.entitlements_request import EntitlementsRequest +from gooddata_api_client.models.api_entitlement import ApiEntitlement +from gooddata_api_client.models.entitlements_request import EntitlementsRequest # body param SchemaForRequestBodyApplicationJson = EntitlementsRequest @@ -47,7 +47,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['ApiEntitlement']: return ApiEntitlement @@ -350,5 +350,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/get.py index 02beeb27d..fd452230c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting from . import path @@ -37,7 +37,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['ResolvedSetting']: return ResolvedSetting @@ -260,5 +260,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/get.pyi index bf646e2d1..7f983a818 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting @@ -35,7 +35,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['ResolvedSetting']: return ResolvedSetting @@ -255,5 +255,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/post.py index a9163c2eb..82240f68f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest from . import path @@ -49,7 +49,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['ResolvedSetting']: return ResolvedSetting @@ -355,5 +355,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/post.pyi index 93aed0136..41aa85779 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_resolve_settings/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest # body param SchemaForRequestBodyApplicationJson = ResolveSettingsRequest @@ -47,7 +47,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['ResolvedSetting']: return ResolvedSetting @@ -350,5 +350,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_available_assignees/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_available_assignees/get.py index 2e6b5fbb7..be46e67c1 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_available_assignees/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_available_assignees/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.available_assignees import AvailableAssignees +from gooddata_api_client.models.available_assignees import AvailableAssignees from . import path @@ -298,5 +298,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_available_assignees/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_available_assignees/get.pyi index eb57ad6f1..16b670589 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_available_assignees/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_available_assignees/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.available_assignees import AvailableAssignees +from gooddata_api_client.models.available_assignees import AvailableAssignees # Path params WorkspaceIdSchema = schemas.StrSchema @@ -293,5 +293,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_manage_permissions/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_manage_permissions/post.py index b77a4942a..87fa1df02 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_manage_permissions/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_manage_permissions/post.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.permissions_for_assignee import PermissionsForAssignee +from gooddata_api_client.models.permissions_for_assignee import PermissionsForAssignee from . import path @@ -72,7 +72,7 @@ class SchemaForRequestBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['PermissionsForAssignee']: return PermissionsForAssignee @@ -390,5 +390,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_manage_permissions/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_manage_permissions/post.pyi index bfd978b04..88cfae592 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_manage_permissions/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_manage_permissions/post.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.permissions_for_assignee import PermissionsForAssignee +from gooddata_api_client.models.permissions_for_assignee import PermissionsForAssignee # Path params WorkspaceIdSchema = schemas.StrSchema @@ -70,7 +70,7 @@ class SchemaForRequestBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['PermissionsForAssignee']: return PermissionsForAssignee @@ -385,5 +385,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_permissions/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_permissions/get.py index d9a8bd093..98ba88bbe 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_permissions/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_permissions/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.dashboard_permissions import DashboardPermissions +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions from . import path @@ -298,5 +298,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_permissions/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_permissions/get.pyi index 814b6cdd6..17b6a799d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_permissions/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_permissions/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.dashboard_permissions import DashboardPermissions +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions # Path params WorkspaceIdSchema = schemas.StrSchema @@ -293,5 +293,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_check_entity_overrides/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_check_entity_overrides/post.py index a85ed28d6..1804a51d7 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_check_entity_overrides/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_check_entity_overrides/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.hierarchy_object_identification import HierarchyObjectIdentification +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications from . import path @@ -65,7 +65,7 @@ class SchemaForRequestBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['HierarchyObjectIdentification']: return HierarchyObjectIdentification @@ -100,7 +100,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['IdentifierDuplications']: return IdentifierDuplications @@ -437,5 +437,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_check_entity_overrides/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_check_entity_overrides/post.pyi index bc27f7bbb..872e583f1 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_check_entity_overrides/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_check_entity_overrides/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.hierarchy_object_identification import HierarchyObjectIdentification +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications # Path params WorkspaceIdSchema = schemas.StrSchema @@ -63,7 +63,7 @@ class SchemaForRequestBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['HierarchyObjectIdentification']: return HierarchyObjectIdentification @@ -98,7 +98,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['IdentifierDuplications']: return IdentifierDuplications @@ -432,5 +432,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/get.py index 1d573f29f..aeed2dcc2 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse from . import path @@ -289,5 +289,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/get.pyi index 54fe98ef1..b3e312f80 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse # Path params WorkspaceIdSchema = schemas.StrSchema @@ -284,5 +284,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/post.py index ffe16f883..006f9a8f0 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse from . import path @@ -387,5 +387,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/post.pyi index 52f6ead1e..34813458e 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_dependent_entities_graph/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse # Path params WorkspaceIdSchema = schemas.StrSchema @@ -382,5 +382,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_objects/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_objects/post.py index 7f742c596..88cf42684 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_objects/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_objects/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.afm_valid_objects_query import AfmValidObjectsQuery -from gooddata_api_client.model.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.models.afm_valid_objects_query import AfmValidObjectsQuery +from gooddata_api_client.models.afm_valid_objects_response import AfmValidObjectsResponse from . import path @@ -397,5 +397,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_objects/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_objects/post.pyi index ed678d2ef..e5123df9f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_objects/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_objects/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.afm_valid_objects_query import AfmValidObjectsQuery -from gooddata_api_client.model.afm_valid_objects_response import AfmValidObjectsResponse +from gooddata_api_client.models.afm_valid_objects_query import AfmValidObjectsQuery +from gooddata_api_client.models.afm_valid_objects_response import AfmValidObjectsResponse # Path params @@ -387,5 +387,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute/post.py index 83175c1f7..1e4de9359 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution_response import AfmExecutionResponse +from gooddata_api_client.models.afm_execution import AfmExecution from . import path @@ -456,5 +456,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute/post.pyi index dec5bbd83..7cdad4dde 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution_response import AfmExecutionResponse +from gooddata_api_client.models.afm_execution import AfmExecution # Header params SkipCacheSchema = schemas.BoolSchema @@ -446,5 +446,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id/get.py index 5ea3622e0..c723522cb 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.execution_result import ExecutionResult +from gooddata_api_client.models.execution_result import ExecutionResult from . import path @@ -443,5 +443,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id/get.pyi index ff57ff4dc..2b08bf28b 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.execution_result import ExecutionResult +from gooddata_api_client.models.execution_result import ExecutionResult # Query params @@ -433,5 +433,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id_metadata/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id_metadata/get.py index 0ef7e5a0b..4e748ba88 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id_metadata/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id_metadata/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.models.result_cache_metadata import ResultCacheMetadata from . import path @@ -308,5 +308,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id_metadata/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id_metadata/get.pyi index 3695fda46..891ed00b8 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id_metadata/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_execute_result_result_id_metadata/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.models.result_cache_metadata import ResultCacheMetadata # Path params @@ -298,5 +298,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_explain/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_explain/post.py index a673a6ee7..b264f379f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_explain/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_explain/post.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution import AfmExecution from . import path @@ -51,43 +51,43 @@ class MetaOapg: "SQL": "SQL", "SETTINGS": "SETTINGS", } - + @schemas.classproperty def MAQL(cls): return cls("MAQL") - + @schemas.classproperty def GRPC_MODEL(cls): return cls("GRPC_MODEL") - + @schemas.classproperty def GRPC_MODEL_SVG(cls): return cls("GRPC_MODEL_SVG") - + @schemas.classproperty def WDF(cls): return cls("WDF") - + @schemas.classproperty def QT(cls): return cls("QT") - + @schemas.classproperty def QT_SVG(cls): return cls("QT_SVG") - + @schemas.classproperty def OPT_QT(cls): return cls("OPT_QT") - + @schemas.classproperty def OPT_QT_SVG(cls): return cls("OPT_QT_SVG") - + @schemas.classproperty def SQL(cls): return cls("SQL") - + @schemas.classproperty def SETTINGS(cls): return cls("SETTINGS") @@ -522,5 +522,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_explain/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_explain/post.pyi index 11d70ee1c..9570c6cfa 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_explain/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_explain/post.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.afm_execution import AfmExecution +from gooddata_api_client.models.afm_execution import AfmExecution # Query params @@ -34,43 +34,43 @@ class ExplainTypeSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def MAQL(cls): return cls("MAQL") - + @schemas.classproperty def GRPC_MODEL(cls): return cls("GRPC_MODEL") - + @schemas.classproperty def GRPC_MODEL_SVG(cls): return cls("GRPC_MODEL_SVG") - + @schemas.classproperty def WDF(cls): return cls("WDF") - + @schemas.classproperty def QT(cls): return cls("QT") - + @schemas.classproperty def QT_SVG(cls): return cls("QT_SVG") - + @schemas.classproperty def OPT_QT(cls): return cls("OPT_QT") - + @schemas.classproperty def OPT_QT_SVG(cls): return cls("OPT_QT_SVG") - + @schemas.classproperty def SQL(cls): return cls("SQL") - + @schemas.classproperty def SETTINGS(cls): return cls("SETTINGS") @@ -497,5 +497,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_collect_label_elements/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_collect_label_elements/post.py index a8ffa24e1..d00785675 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_collect_label_elements/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_collect_label_elements/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.elements_request import ElementsRequest -from gooddata_api_client.model.elements_response import ElementsResponse +from gooddata_api_client.models.elements_request import ElementsRequest +from gooddata_api_client.models.elements_response import ElementsResponse from . import path @@ -534,5 +534,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_collect_label_elements/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_collect_label_elements/post.pyi index 222bf3a17..335376c60 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_collect_label_elements/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_collect_label_elements/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.elements_request import ElementsRequest -from gooddata_api_client.model.elements_response import ElementsResponse +from gooddata_api_client.models.elements_request import ElementsRequest +from gooddata_api_client.models.elements_response import ElementsResponse # Query params @@ -514,5 +514,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_tabular/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_tabular/post.py index 74b5390c6..9276a83ed 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_tabular/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_tabular/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.tabular_export_request import TabularExportRequest from . import path @@ -387,5 +387,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_tabular/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_tabular/post.pyi index f6dae507f..a9005cd22 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_tabular/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_tabular/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.tabular_export_request import TabularExportRequest # Path params WorkspaceIdSchema = schemas.StrSchema @@ -382,5 +382,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_visual/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_visual/post.py index cc61041f2..1f04a8ae4 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_visual/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_visual/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.pdf_export_request import PdfExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.pdf_export_request import PdfExportRequest from . import path @@ -387,5 +387,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_visual/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_visual/post.pyi index f1b629879..95fc6aa8c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_visual/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_visual/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.pdf_export_request import PdfExportRequest +from gooddata_api_client.models.export_response import ExportResponse +from gooddata_api_client.models.pdf_export_request import PdfExportRequest # Path params WorkspaceIdSchema = schemas.StrSchema @@ -382,5 +382,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_conflicts/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_conflicts/get.py index aa4f6d08e..8a7035986 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_conflicts/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_conflicts/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications from . import path @@ -63,7 +63,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['IdentifierDuplications']: return IdentifierDuplications @@ -314,5 +314,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_conflicts/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_conflicts/get.pyi index d2ecfe0c0..b10318d53 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_conflicts/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_conflicts/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications # Path params WorkspaceIdSchema = schemas.StrSchema @@ -61,7 +61,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['IdentifierDuplications']: return IdentifierDuplications @@ -309,5 +309,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_overridden_child_entities/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_overridden_child_entities/get.py index db1fcc4e0..b27a5e7aa 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_overridden_child_entities/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_overridden_child_entities/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications from . import path @@ -63,7 +63,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['IdentifierDuplications']: return IdentifierDuplications @@ -314,5 +314,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_overridden_child_entities/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_overridden_child_entities/get.pyi index c108110a6..87fe286da 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_overridden_child_entities/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_overridden_child_entities/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from gooddata_api_client.models.identifier_duplications import IdentifierDuplications # Path params WorkspaceIdSchema = schemas.StrSchema @@ -61,7 +61,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['IdentifierDuplications']: return IdentifierDuplications @@ -309,5 +309,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/get.py index 136ea1023..c20a88ab8 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting from . import path @@ -63,7 +63,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['ResolvedSetting']: return ResolvedSetting @@ -314,5 +314,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/get.pyi index 5644cd92b..5a5b49de2 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolved_setting import ResolvedSetting # Path params WorkspaceIdSchema = schemas.StrSchema @@ -61,7 +61,7 @@ class SchemaFor200ResponseBodyApplicationJson( class MetaOapg: - + @staticmethod def items() -> typing.Type['ResolvedSetting']: return ResolvedSetting @@ -309,5 +309,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/post.py index f417bcb08..380e9084b 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest from . import path @@ -412,5 +412,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/post.pyi index e618e866c..e85756b39 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_resolve_settings/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolved_setting import ResolvedSetting +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest # Path params WorkspaceIdSchema = schemas.StrSchema @@ -407,5 +407,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/get.py index fdecdef92..8913de808 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument from . import path @@ -353,5 +353,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/get.pyi index 57fcac35f..fb0238c41 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument # Query params FilterSchema = schemas.StrSchema @@ -343,5 +343,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/patch.py index 1d6daf49f..6b8dfbafc 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument from . import path @@ -454,5 +454,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/patch.pyi index 31fc6d39a..56a68de73 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/put.py index e0bec1c8c..8e5ade67a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument from . import path @@ -454,5 +454,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/put.pyi index 5cda96a82..b252891c0 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_cookie_security_configurations_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.models.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/get.py index 6f2556cab..f45a19e99 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "users": "USERS", @@ -55,23 +55,23 @@ class MetaOapg: "bootstrapUserGroup": "BOOTSTRAP_USER_GROUP", "ALL": "ALL", } - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def BOOTSTRAP_USER(cls): return cls("bootstrapUser") - + @schemas.classproperty def BOOTSTRAP_USER_GROUP(cls): return cls("bootstrapUserGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -98,29 +98,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "permissions": "PERMISSIONS", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -474,5 +474,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/get.pyi index 1eaf06201..314605cf6 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,29 +37,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def BOOTSTRAP_USER(cls): return cls("bootstrapUser") - + @schemas.classproperty def BOOTSTRAP_USER_GROUP(cls): return cls("bootstrapUserGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -85,21 +85,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -445,5 +445,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/patch.py index 48c22880e..f36418cac 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument from . import path @@ -40,14 +40,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "users": "USERS", @@ -56,23 +56,23 @@ class MetaOapg: "bootstrapUserGroup": "BOOTSTRAP_USER_GROUP", "ALL": "ALL", } - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def BOOTSTRAP_USER(cls): return cls("bootstrapUser") - + @schemas.classproperty def BOOTSTRAP_USER_GROUP(cls): return cls("bootstrapUserGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -519,5 +519,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/patch.pyi index 15b6de30e..be2722547 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_patch_document import JsonApiOrganizationPatchDocument # Query params FilterSchema = schemas.StrSchema @@ -38,29 +38,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def BOOTSTRAP_USER(cls): return cls("bootstrapUser") - + @schemas.classproperty def BOOTSTRAP_USER_GROUP(cls): return cls("bootstrapUserGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -499,5 +499,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/put.py index 5024d0573..b7e76e605 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument from . import path @@ -40,14 +40,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "users": "USERS", @@ -56,23 +56,23 @@ class MetaOapg: "bootstrapUserGroup": "BOOTSTRAP_USER_GROUP", "ALL": "ALL", } - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def BOOTSTRAP_USER(cls): return cls("bootstrapUser") - + @schemas.classproperty def BOOTSTRAP_USER_GROUP(cls): return cls("bootstrapUserGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -519,5 +519,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/put.pyi index 0388b5054..78a035a00 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_admin_organizations_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument # Query params FilterSchema = schemas.StrSchema @@ -38,29 +38,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def BOOTSTRAP_USER(cls): return cls("bootstrapUser") - + @schemas.classproperty def BOOTSTRAP_USER_GROUP(cls): return cls("bootstrapUserGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -499,5 +499,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/get.py index 420b4b290..c57269e78 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList from . import path @@ -338,5 +338,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/get.pyi index f2a6b451f..10190675b 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.models.json_api_color_palette_out_list import JsonApiColorPaletteOutList # Query params FilterSchema = schemas.StrSchema @@ -333,5 +333,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/post.py index 83d601940..6b9b47b61 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from . import path @@ -330,5 +330,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/post.pyi index 2f9bf8a23..6fecfd5ae 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument # body param SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiColorPaletteInDocument @@ -325,5 +325,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/get.py index 99b6d8fd5..466545fdb 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from . import path @@ -353,5 +353,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/get.pyi index 80c594df4..df825ebc5 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument # Query params FilterSchema = schemas.StrSchema @@ -343,5 +343,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/patch.py index f71b1e90c..c4a29ee40 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from . import path @@ -454,5 +454,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/patch.pyi index 3bfc33965..f3f692719 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/put.py index fd1728b62..dee7995cd 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from . import path @@ -454,5 +454,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/put.pyi index 0495b6237..cec2605a4 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_color_palettes_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.models.json_api_color_palette_in_document import JsonApiColorPaletteInDocument +from gooddata_api_client.models.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/get.py index 78c561dcf..dc73e73f6 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList from . import path @@ -338,5 +338,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/get.pyi index aae129e8a..35159c3d7 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.models.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList # Query params FilterSchema = schemas.StrSchema @@ -333,5 +333,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/post.py index 6b5567d11..2ee1717d5 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument from . import path @@ -330,5 +330,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/post.pyi index 551a889e5..9bc55e0d7 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument # body param SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiCspDirectiveInDocument @@ -325,5 +325,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/get.py index 5e94c102d..adb900432 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument from . import path @@ -353,5 +353,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/get.pyi index 2f0576a4f..4a012a1d0 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument # Query params FilterSchema = schemas.StrSchema @@ -343,5 +343,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/patch.py index c5c0a82c7..2bb82e16a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument from . import path @@ -454,5 +454,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/patch.pyi index 1bc364a43..3d1d2951c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/put.py index 4bbcf1750..1c47d2633 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument from . import path @@ -454,5 +454,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/put.pyi index 19fd302bc..9137f2b92 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_csp_directives_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers/get.py index 41dbbd36c..13b65ee0a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList from . import path @@ -65,29 +65,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "permissions": "PERMISSIONS", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -394,5 +394,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers/get.pyi index 7fb27edb2..edb255c24 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.models.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList # Query params FilterSchema = schemas.StrSchema @@ -62,21 +62,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -380,5 +380,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers_id/get.py index cf2bd6094..d14e4a0e5 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument from . import path @@ -40,29 +40,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "permissions": "PERMISSIONS", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -409,5 +409,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers_id/get.pyi index ee338d633..9836c0ba5 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_source_identifiers_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.models.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -390,5 +390,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/get.py index 3e9329ab1..c100c2df5 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList from . import path @@ -65,29 +65,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "permissions": "PERMISSIONS", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -394,5 +394,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/get.pyi index 9f77b63d0..51d4e6025 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.models.json_api_data_source_out_list import JsonApiDataSourceOutList # Query params FilterSchema = schemas.StrSchema @@ -62,21 +62,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -380,5 +380,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/post.py index b1edd6ae2..2540902cd 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from . import path @@ -40,29 +40,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "permissions": "PERMISSIONS", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -434,5 +434,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/post.pyi index ecee20c5f..0a4511679 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument # Query params @@ -37,21 +37,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -420,5 +420,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables/get.py index fc7722215..f4c6c0a9b 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_table_out_list import JsonApiDataSourceTableOutList +from gooddata_api_client.models.json_api_data_source_table_out_list import JsonApiDataSourceTableOutList from . import path @@ -391,5 +391,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables/get.pyi index 5b75a6f87..3b301c27e 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_table_out_list import JsonApiDataSourceTableOutList +from gooddata_api_client.models.json_api_data_source_table_out_list import JsonApiDataSourceTableOutList # Query params FilterSchema = schemas.StrSchema @@ -386,5 +386,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables_id/get.py index eb5a7864e..38945ba19 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_table_out_document import JsonApiDataSourceTableOutDocument +from gooddata_api_client.models.json_api_data_source_table_out_document import JsonApiDataSourceTableOutDocument from . import path @@ -361,5 +361,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables_id/get.pyi index ec27c5de2..902f0e6e3 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_data_source_id_data_source_tables_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_table_out_document import JsonApiDataSourceTableOutDocument +from gooddata_api_client.models.json_api_data_source_table_out_document import JsonApiDataSourceTableOutDocument # Query params FilterSchema = schemas.StrSchema @@ -351,5 +351,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/get.py index b5fa22167..fd98860f2 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from . import path @@ -40,29 +40,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "permissions": "PERMISSIONS", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -409,5 +409,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/get.pyi index e579682fc..e34cbee8f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -390,5 +390,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/patch.py index a77fa390b..5648a61e0 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from . import path @@ -454,5 +454,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/patch.pyi index c87cc1b87..308e308b6 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/put.py index f838ced98..cf09d5455 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument from . import path @@ -454,5 +454,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/put.pyi index 8e65b0d08..c437e1a7d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_data_sources_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_out_document import JsonApiDataSourceOutDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements/get.py index 0bec1ac68..4d2f7f056 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList from . import path @@ -338,5 +338,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements/get.pyi index 051797dc1..0baab6f27 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.models.json_api_entitlement_out_list import JsonApiEntitlementOutList # Query params FilterSchema = schemas.StrSchema @@ -333,5 +333,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements_id/get.py index 6b9ba6fed..e49c26899 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument from . import path @@ -353,5 +353,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements_id/get.pyi index 4b2ec5e3f..c270703e1 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_entitlements_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.models.json_api_entitlement_out_document import JsonApiEntitlementOutDocument # Query params FilterSchema = schemas.StrSchema @@ -343,5 +343,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/get.py index ab6f57fe5..0263da536 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList from . import path @@ -338,5 +338,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/get.pyi index 77c194cb8..5d492730d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.models.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList # Query params FilterSchema = schemas.StrSchema @@ -333,5 +333,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/post.py index 604ff6cf3..be62e0768 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from . import path @@ -330,5 +330,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/post.pyi index 726bf2f0e..a36bc25f3 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument # body param SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiOrganizationSettingInDocument @@ -325,5 +325,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/get.py index 7d076ec82..8c9beed7e 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from . import path @@ -353,5 +353,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/get.pyi index 856e1e92d..ce8481774 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument # Query params FilterSchema = schemas.StrSchema @@ -343,5 +343,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/patch.py index db005e6d3..6bb25c101 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument from . import path @@ -454,5 +454,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/patch.pyi index 51d4c4bc9..06e1f224b 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/put.py index 29b85db9d..f5c178e34 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument from . import path @@ -454,5 +454,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/put.pyi index dd55b06f9..af2a8eb01 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_settings_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/get.py index 2cedcaf7d..f67c002fe 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList from . import path @@ -338,5 +338,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/get.pyi index 9cb69f175..992e1858f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.models.json_api_theme_out_list import JsonApiThemeOutList # Query params FilterSchema = schemas.StrSchema @@ -333,5 +333,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/post.py index 0df912b13..72f39b596 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from . import path @@ -330,5 +330,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/post.pyi index 534ad0f3f..aa93164a9 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument # body param SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiThemeInDocument @@ -325,5 +325,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/get.py index 3eb76e888..5e9f89449 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from . import path @@ -353,5 +353,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/get.pyi index b2e8dd430..e70a2e235 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument # Query params FilterSchema = schemas.StrSchema @@ -343,5 +343,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/patch.py index 927089100..d42698e83 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from . import path @@ -454,5 +454,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/patch.pyi index 852cef35c..47ca52099 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/put.py index ab172f54d..95aa826cb 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument from . import path @@ -454,5 +454,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/put.pyi index 76c37bef7..fe8107a2f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_themes_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.models.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.models.json_api_theme_out_document import JsonApiThemeOutDocument # Query params FilterSchema = schemas.StrSchema @@ -444,5 +444,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/get.py index 1e1fc0cc8..534db9853 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList from . import path @@ -39,29 +39,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "userGroups": "USER_GROUPS", "parents": "PARENTS", "ALL": "ALL", } - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def PARENTS(cls): return cls("parents") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -393,5 +393,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/get.pyi index 87412d034..f923d7588 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.models.json_api_user_group_out_list import JsonApiUserGroupOutList # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def PARENTS(cls): return cls("parents") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -380,5 +380,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/post.py index b018e5898..39efe86e0 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from . import path @@ -39,29 +39,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "userGroups": "USER_GROUPS", "parents": "PARENTS", "ALL": "ALL", } - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def PARENTS(cls): return cls("parents") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -433,5 +433,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/post.pyi index ae21757db..0569b4eee 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument # Query params @@ -37,21 +37,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def PARENTS(cls): return cls("parents") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -420,5 +420,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/get.py index a60ce3581..2b775978a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from . import path @@ -39,29 +39,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "userGroups": "USER_GROUPS", "parents": "PARENTS", "ALL": "ALL", } - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def PARENTS(cls): return cls("parents") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -408,5 +408,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/get.pyi index 5fd6d4f29..abe241ea8 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def PARENTS(cls): return cls("parents") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -390,5 +390,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/patch.py index 7e8c8cba6..26807b55a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument from . import path @@ -40,29 +40,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "userGroups": "USER_GROUPS", "parents": "PARENTS", "ALL": "ALL", } - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def PARENTS(cls): return cls("parents") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -509,5 +509,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/patch.pyi index 162fd2083..e4b19872a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument -from gooddata_api_client.model.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_patch_document import JsonApiUserGroupPatchDocument # Query params FilterSchema = schemas.StrSchema @@ -38,21 +38,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def PARENTS(cls): return cls("parents") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -491,5 +491,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/put.py index 433269515..e145bf5c5 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument from . import path @@ -40,29 +40,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "userGroups": "USER_GROUPS", "parents": "PARENTS", "ALL": "ALL", } - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def PARENTS(cls): return cls("parents") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -509,5 +509,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/put.pyi index 6df444bd1..bbe1196eb 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_groups_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_out_document import JsonApiUserGroupOutDocument # Query params FilterSchema = schemas.StrSchema @@ -38,21 +38,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def PARENTS(cls): return cls("parents") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -491,5 +491,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/get.py index 82ffbae52..16ea1435a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList from . import path @@ -39,24 +39,24 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "userGroups": "USER_GROUPS", "ALL": "ALL", } - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -388,5 +388,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/get.pyi index ffa8eb817..b069ba10e 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.models.json_api_user_out_list import JsonApiUserOutList # Query params FilterSchema = schemas.StrSchema @@ -37,17 +37,17 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -376,5 +376,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/post.py index 6797c7c01..5572708c5 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from . import path @@ -39,24 +39,24 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "userGroups": "USER_GROUPS", "ALL": "ALL", } - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -428,5 +428,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/post.pyi index 41e541aaa..9ddaa9655 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument # Query params @@ -37,17 +37,17 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -416,5 +416,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/get.py index 46c41c7e6..7501c796d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from . import path @@ -39,24 +39,24 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "userGroups": "USER_GROUPS", "ALL": "ALL", } - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -403,5 +403,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/get.pyi index 06defcd62..9a00b5bb4 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,17 +37,17 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -386,5 +386,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/patch.py index a2735b7e4..1e8021e89 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument from . import path @@ -40,24 +40,24 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "userGroups": "USER_GROUPS", "ALL": "ALL", } - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -504,5 +504,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/patch.pyi index bd5462c43..1edffbc2f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument -from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_patch_document import JsonApiUserPatchDocument # Query params FilterSchema = schemas.StrSchema @@ -38,17 +38,17 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -487,5 +487,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/put.py index 91818b6a5..6ca9c3ef2 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument from . import path @@ -40,24 +40,24 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "userGroups": "USER_GROUPS", "ALL": "ALL", } - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -504,5 +504,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/put.pyi index 6d630c55d..c259df607 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_out_document import JsonApiUserOutDocument # Query params FilterSchema = schemas.StrSchema @@ -38,17 +38,17 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -487,5 +487,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/get.py index 32064c7a9..de823b4d5 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList from . import path @@ -392,5 +392,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/get.pyi index 9ea526e2d..6a97622aa 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.models.json_api_api_token_out_list import JsonApiApiTokenOutList # Query params FilterSchema = schemas.StrSchema @@ -387,5 +387,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/post.py index 406a270ab..ddf5bc6a1 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument from . import path @@ -387,5 +387,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/post.pyi index c25c9fb6e..54cad02ae 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument # Path params UserIdSchema = schemas.StrSchema @@ -382,5 +382,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/get.py index dffdda3c0..882929cf6 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument from . import path @@ -362,5 +362,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/get.pyi index 60f54b2cb..18d060ea9 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument # Query params FilterSchema = schemas.StrSchema @@ -352,5 +352,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/put.py index 7e8aa719f..35f515666 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument from . import path @@ -463,5 +463,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/put.pyi index 93794d3b4..a566b578f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_api_tokens_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument # Query params FilterSchema = schemas.StrSchema @@ -453,5 +453,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/get.py index a4168c978..356399752 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList from . import path @@ -392,5 +392,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/get.pyi index e5db3f6dc..50980ce89 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.models.json_api_user_setting_out_list import JsonApiUserSettingOutList # Query params FilterSchema = schemas.StrSchema @@ -387,5 +387,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/post.py index e3c644e45..4dddfd87b 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument from . import path @@ -387,5 +387,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/post.pyi index fe1447ef1..037f24102 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument # Path params UserIdSchema = schemas.StrSchema @@ -382,5 +382,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/get.py index 38b24f079..bbbf3fc5c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument from . import path @@ -362,5 +362,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/get.pyi index ab129a852..f03844b57 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument # Query params FilterSchema = schemas.StrSchema @@ -352,5 +352,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/put.py index 2636674e7..7e12c2d77 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument from . import path @@ -463,5 +463,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/put.pyi index 618f5a161..36304d076 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_users_user_id_user_settings_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.models.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.models.json_api_user_setting_in_document import JsonApiUserSettingInDocument # Query params FilterSchema = schemas.StrSchema @@ -453,5 +453,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/get.py index cc2254bee..428d1c545 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList from . import path @@ -39,29 +39,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "workspaces": "WORKSPACES", "parent": "PARENT", "ALL": "ALL", } - + @schemas.classproperty def WORKSPACES(cls): return cls("workspaces") - + @schemas.classproperty def PARENT(cls): return cls("parent") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -113,14 +113,14 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "config": "CONFIG", @@ -128,19 +128,19 @@ class MetaOapg: "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def CONFIG(cls): return cls("config") - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -454,5 +454,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/get.pyi index 9d05b2293..2e364d0ef 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.models.json_api_workspace_out_list import JsonApiWorkspaceOutList # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACES(cls): return cls("workspaces") - + @schemas.classproperty def PARENT(cls): return cls("parent") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -102,25 +102,25 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def CONFIG(cls): return cls("config") - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -431,5 +431,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/post.py index 0a3b5fb76..3e72e1031 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument from . import path @@ -39,29 +39,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "workspaces": "WORKSPACES", "parent": "PARENT", "ALL": "ALL", } - + @schemas.classproperty def WORKSPACES(cls): return cls("workspaces") - + @schemas.classproperty def PARENT(cls): return cls("parent") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -88,14 +88,14 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "config": "CONFIG", @@ -103,19 +103,19 @@ class MetaOapg: "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def CONFIG(cls): return cls("config") - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -494,5 +494,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/post.pyi index e2512a88e..1d393c087 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument # Query params @@ -37,21 +37,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACES(cls): return cls("workspaces") - + @schemas.classproperty def PARENT(cls): return cls("parent") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -77,25 +77,25 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def CONFIG(cls): return cls("config") - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -471,5 +471,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/get.py index 7d7bbf275..7c0dfc3be 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument from . import path @@ -39,29 +39,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "workspaces": "WORKSPACES", "parent": "PARENT", "ALL": "ALL", } - + @schemas.classproperty def WORKSPACES(cls): return cls("workspaces") - + @schemas.classproperty def PARENT(cls): return cls("parent") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -88,14 +88,14 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "config": "CONFIG", @@ -103,19 +103,19 @@ class MetaOapg: "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def CONFIG(cls): return cls("config") - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -469,5 +469,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/get.pyi index 859c5921e..c8cfbd98e 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACES(cls): return cls("workspaces") - + @schemas.classproperty def PARENT(cls): return cls("parent") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -77,25 +77,25 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def CONFIG(cls): return cls("config") - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -441,5 +441,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/patch.py index 78196c8b6..ff5fc0d8d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument from . import path @@ -40,29 +40,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "workspaces": "WORKSPACES", "parent": "PARENT", "ALL": "ALL", } - + @schemas.classproperty def WORKSPACES(cls): return cls("workspaces") - + @schemas.classproperty def PARENT(cls): return cls("parent") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -509,5 +509,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/patch.pyi index 6e70dddd6..ba565d4f6 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_patch_document import JsonApiWorkspacePatchDocument # Query params FilterSchema = schemas.StrSchema @@ -491,5 +491,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/put.py index 9ffc3da9f..2fd841b14 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument from . import path @@ -40,29 +40,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "workspaces": "WORKSPACES", "parent": "PARENT", "ALL": "ALL", } - + @schemas.classproperty def WORKSPACES(cls): return cls("workspaces") - + @schemas.classproperty def PARENT(cls): return cls("parent") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -509,5 +509,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/put.pyi index 32a048374..db3bb3dba 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument # Query params FilterSchema = schemas.StrSchema @@ -38,21 +38,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACES(cls): return cls("workspaces") - + @schemas.classproperty def PARENT(cls): return cls("parent") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -491,5 +491,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/get.py index 5a44365c6..0573a6072 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -65,14 +65,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "visualizationObjects": "VISUALIZATION_OBJECTS", @@ -84,35 +84,35 @@ class MetaOapg: "dashboardPlugins": "DASHBOARD_PLUGINS", "ALL": "ALL", } - + @schemas.classproperty def VISUALIZATION_OBJECTS(cls): return cls("visualizationObjects") - + @schemas.classproperty def ANALYTICAL_DASHBOARDS(cls): return cls("analyticalDashboards") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def FILTER_CONTEXTS(cls): return cls("filterContexts") - + @schemas.classproperty def DASHBOARD_PLUGINS(cls): return cls("dashboardPlugins") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -164,14 +164,14 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "permissions": "PERMISSIONS", @@ -180,23 +180,23 @@ class MetaOapg: "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ACCESS_INFO(cls): return cls("accessInfo") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -620,5 +620,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/get.pyi index 69b40f624..cc7fad752 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.models.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -55,41 +55,41 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def VISUALIZATION_OBJECTS(cls): return cls("visualizationObjects") - + @schemas.classproperty def ANALYTICAL_DASHBOARDS(cls): return cls("analyticalDashboards") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def FILTER_CONTEXTS(cls): return cls("filterContexts") - + @schemas.classproperty def DASHBOARD_PLUGINS(cls): return cls("dashboardPlugins") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -140,29 +140,29 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ACCESS_INFO(cls): return cls("accessInfo") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -583,5 +583,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/post.py index eb5651f40..88b1178ac 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "visualizationObjects": "VISUALIZATION_OBJECTS", @@ -58,35 +58,35 @@ class MetaOapg: "dashboardPlugins": "DASHBOARD_PLUGINS", "ALL": "ALL", } - + @schemas.classproperty def VISUALIZATION_OBJECTS(cls): return cls("visualizationObjects") - + @schemas.classproperty def ANALYTICAL_DASHBOARDS(cls): return cls("analyticalDashboards") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def FILTER_CONTEXTS(cls): return cls("filterContexts") - + @schemas.classproperty def DASHBOARD_PLUGINS(cls): return cls("dashboardPlugins") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -113,14 +113,14 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "permissions": "PERMISSIONS", @@ -129,23 +129,23 @@ class MetaOapg: "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ACCESS_INFO(cls): return cls("accessInfo") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -581,5 +581,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/post.pyi index 7c83f817d..7e5787077 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument # Query params @@ -37,41 +37,41 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def VISUALIZATION_OBJECTS(cls): return cls("visualizationObjects") - + @schemas.classproperty def ANALYTICAL_DASHBOARDS(cls): return cls("analyticalDashboards") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def FILTER_CONTEXTS(cls): return cls("filterContexts") - + @schemas.classproperty def DASHBOARD_PLUGINS(cls): return cls("dashboardPlugins") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -97,29 +97,29 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ACCESS_INFO(cls): return cls("accessInfo") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -552,5 +552,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/get.py index f1ee130a0..e7608866a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "visualizationObjects": "VISUALIZATION_OBJECTS", @@ -58,35 +58,35 @@ class MetaOapg: "dashboardPlugins": "DASHBOARD_PLUGINS", "ALL": "ALL", } - + @schemas.classproperty def VISUALIZATION_OBJECTS(cls): return cls("visualizationObjects") - + @schemas.classproperty def ANALYTICAL_DASHBOARDS(cls): return cls("analyticalDashboards") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def FILTER_CONTEXTS(cls): return cls("filterContexts") - + @schemas.classproperty def DASHBOARD_PLUGINS(cls): return cls("dashboardPlugins") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -113,14 +113,14 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "permissions": "PERMISSIONS", @@ -129,23 +129,23 @@ class MetaOapg: "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ACCESS_INFO(cls): return cls("accessInfo") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -546,5 +546,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/get.pyi index c7c4ebc02..50567edf7 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,41 +37,41 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def VISUALIZATION_OBJECTS(cls): return cls("visualizationObjects") - + @schemas.classproperty def ANALYTICAL_DASHBOARDS(cls): return cls("analyticalDashboards") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def FILTER_CONTEXTS(cls): return cls("filterContexts") - + @schemas.classproperty def DASHBOARD_PLUGINS(cls): return cls("dashboardPlugins") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -97,29 +97,29 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def PERMISSIONS(cls): return cls("permissions") - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ACCESS_INFO(cls): return cls("accessInfo") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -517,5 +517,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/patch.py index b7a9b78a9..10f4306f3 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from . import path @@ -40,14 +40,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "visualizationObjects": "VISUALIZATION_OBJECTS", @@ -59,35 +59,35 @@ class MetaOapg: "dashboardPlugins": "DASHBOARD_PLUGINS", "ALL": "ALL", } - + @schemas.classproperty def VISUALIZATION_OBJECTS(cls): return cls("visualizationObjects") - + @schemas.classproperty def ANALYTICAL_DASHBOARDS(cls): return cls("analyticalDashboards") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def FILTER_CONTEXTS(cls): return cls("filterContexts") - + @schemas.classproperty def DASHBOARD_PLUGINS(cls): return cls("dashboardPlugins") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -533,5 +533,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/patch.pyi index dbf969b4a..11b7434b3 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument # Query params FilterSchema = schemas.StrSchema @@ -38,41 +38,41 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def VISUALIZATION_OBJECTS(cls): return cls("visualizationObjects") - + @schemas.classproperty def ANALYTICAL_DASHBOARDS(cls): return cls("analyticalDashboards") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def FILTER_CONTEXTS(cls): return cls("filterContexts") - + @schemas.classproperty def DASHBOARD_PLUGINS(cls): return cls("dashboardPlugins") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -515,5 +515,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/put.py index ee92d720a..ae524b6eb 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from . import path @@ -40,14 +40,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "visualizationObjects": "VISUALIZATION_OBJECTS", @@ -59,35 +59,35 @@ class MetaOapg: "dashboardPlugins": "DASHBOARD_PLUGINS", "ALL": "ALL", } - + @schemas.classproperty def VISUALIZATION_OBJECTS(cls): return cls("visualizationObjects") - + @schemas.classproperty def ANALYTICAL_DASHBOARDS(cls): return cls("analyticalDashboards") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def FILTER_CONTEXTS(cls): return cls("filterContexts") - + @schemas.classproperty def DASHBOARD_PLUGINS(cls): return cls("dashboardPlugins") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -533,5 +533,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/put.pyi index d18e6ec5d..b8e11177c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_object_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.models.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.models.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument # Query params FilterSchema = schemas.StrSchema @@ -38,41 +38,41 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def VISUALIZATION_OBJECTS(cls): return cls("visualizationObjects") - + @schemas.classproperty def ANALYTICAL_DASHBOARDS(cls): return cls("analyticalDashboards") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def FILTER_CONTEXTS(cls): return cls("filterContexts") - + @schemas.classproperty def DASHBOARD_PLUGINS(cls): return cls("dashboardPlugins") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -515,5 +515,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes/get.py index 871f40520..d9dc93d7f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -65,14 +65,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "datasets": "DATASETS", @@ -81,23 +81,23 @@ class MetaOapg: "defaultView": "DEFAULT_VIEW", "ALL": "ALL", } - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def DATASET(cls): return cls("dataset") - + @schemas.classproperty def DEFAULT_VIEW(cls): return cls("defaultView") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -149,29 +149,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -595,5 +595,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes/get.pyi index 8a028ed76..4269c5010 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.models.json_api_attribute_out_list import JsonApiAttributeOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -55,29 +55,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def DATASET(cls): return cls("dataset") - + @schemas.classproperty def DEFAULT_VIEW(cls): return cls("defaultView") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -128,21 +128,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -563,5 +563,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/get.py index f1594355a..b12dc327d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "datasets": "DATASETS", @@ -55,23 +55,23 @@ class MetaOapg: "defaultView": "DEFAULT_VIEW", "ALL": "ALL", } - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def DATASET(cls): return cls("dataset") - + @schemas.classproperty def DEFAULT_VIEW(cls): return cls("defaultView") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -98,29 +98,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -521,5 +521,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/get.pyi index e0bc87f4a..e8dfdbf45 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.models.json_api_attribute_out_document import JsonApiAttributeOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,29 +37,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def DATASET(cls): return cls("dataset") - + @schemas.classproperty def DEFAULT_VIEW(cls): return cls("defaultView") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -85,21 +85,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -497,5 +497,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/get.py index 000cfbb23..8a3472bdb 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -91,29 +91,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -530,5 +530,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/get.pyi index 66904fd3b..f6de88d2b 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.models.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -80,21 +80,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -508,5 +508,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/post.py index 2bb4ea48d..65fddba92 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument from . import path @@ -40,29 +40,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -491,5 +491,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/post.pyi index 2dc29fab8..de04c49b7 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument # Query params @@ -37,21 +37,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -477,5 +477,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/get.py index 85ea2b126..b63d67435 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from . import path @@ -40,29 +40,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -456,5 +456,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/get.pyi index 7aae11672..641e0889c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -442,5 +442,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/patch.py index f2bab7b2d..e5664410d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from . import path @@ -453,5 +453,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/patch.pyi index f4809bf2e..dce67f1b0 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument # Query params FilterSchema = schemas.StrSchema @@ -448,5 +448,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/put.py index 0ba01a994..2b238741f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument from . import path @@ -453,5 +453,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/put.pyi index a18d8b984..4e5308579 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_object_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.models.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.models.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument # Query params FilterSchema = schemas.StrSchema @@ -448,5 +448,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/get.py index 390594eed..33e909d60 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -91,29 +91,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -530,5 +530,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/get.pyi index 5117a08bc..a484c2fdd 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.models.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -80,21 +80,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -508,5 +508,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/post.py index 8b197343c..437db887c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument from . import path @@ -40,29 +40,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -491,5 +491,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/post.pyi index a32dd60bf..8d1a0b8ba 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument # Query params @@ -37,21 +37,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -477,5 +477,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/get.py index 0a6d89c16..d29bce4c6 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument from . import path @@ -456,5 +456,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/get.pyi index f1c1c2770..7f4779951 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -442,5 +442,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/patch.py index 03ea705b0..fa61a9890 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument from . import path @@ -453,5 +453,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/patch.pyi index 9605fae23..e2ebfcaa2 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument # Query params FilterSchema = schemas.StrSchema @@ -448,5 +448,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/put.py index 482a7216f..c40c9e6ea 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument from . import path @@ -453,5 +453,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/put.pyi index 8c0f41b8f..ff0ee73ec 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_object_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.models.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.models.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument # Query params FilterSchema = schemas.StrSchema @@ -448,5 +448,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets/get.py index d84e7a713..d01376e4c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -65,14 +65,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "attributes": "ATTRIBUTES", @@ -81,23 +81,23 @@ class MetaOapg: "references": "REFERENCES", "ALL": "ALL", } - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def REFERENCES(cls): return cls("references") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -149,29 +149,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -595,5 +595,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets/get.pyi index 400002030..161e39154 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.models.json_api_dataset_out_list import JsonApiDatasetOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -55,29 +55,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def REFERENCES(cls): return cls("references") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -128,21 +128,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -563,5 +563,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/get.py index 4fbc4caac..a66ac9306 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "attributes": "ATTRIBUTES", @@ -55,23 +55,23 @@ class MetaOapg: "references": "REFERENCES", "ALL": "ALL", } - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def REFERENCES(cls): return cls("references") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -98,29 +98,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -521,5 +521,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/get.pyi index ac55c52ef..96d1c1363 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.models.json_api_dataset_out_document import JsonApiDatasetOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,29 +37,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def REFERENCES(cls): return cls("references") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -85,21 +85,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -497,5 +497,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts/get.py index 672a7bb10..d15d306b5 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -65,29 +65,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "datasets": "DATASETS", "dataset": "DATASET", "ALL": "ALL", } - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def DATASET(cls): return cls("dataset") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -139,29 +139,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -585,5 +585,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts/get.pyi index c1376ae3b..6fc7ddedf 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.models.json_api_fact_out_list import JsonApiFactOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -55,21 +55,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def DATASET(cls): return cls("dataset") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -120,21 +120,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -555,5 +555,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/get.py index 1ce4476ab..c2dc01f85 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument from . import path @@ -39,29 +39,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "datasets": "DATASETS", "dataset": "DATASET", "ALL": "ALL", } - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def DATASET(cls): return cls("dataset") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -88,29 +88,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -511,5 +511,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/get.pyi index 8d1bede78..cab5b07e6 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.models.json_api_fact_out_document import JsonApiFactOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def DATASET(cls): return cls("dataset") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -77,21 +77,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -489,5 +489,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/get.py index c99dd5069..c4c53ec31 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -65,14 +65,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "attributes": "ATTRIBUTES", @@ -80,19 +80,19 @@ class MetaOapg: "labels": "LABELS", "ALL": "ALL", } - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -144,29 +144,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -590,5 +590,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/get.pyi index bee64c32b..805faf7d6 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.models.json_api_filter_context_out_list import JsonApiFilterContextOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -55,25 +55,25 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -124,21 +124,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -559,5 +559,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/post.py index c7c48e630..444088c72 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "attributes": "ATTRIBUTES", @@ -54,19 +54,19 @@ class MetaOapg: "labels": "LABELS", "ALL": "ALL", } - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -93,29 +93,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -551,5 +551,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/post.pyi index 1a27d9fcb..ca0afaef7 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument # Query params @@ -37,25 +37,25 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -81,21 +81,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -528,5 +528,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/get.py index 837edb19f..0efd93b97 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "attributes": "ATTRIBUTES", @@ -54,19 +54,19 @@ class MetaOapg: "labels": "LABELS", "ALL": "ALL", } - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -93,29 +93,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -516,5 +516,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/get.pyi index b15a1e198..cb33f9f2d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,25 +37,25 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -81,21 +81,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -493,5 +493,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/patch.py index 6cb5f4b82..e87e00ac0 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from . import path @@ -40,14 +40,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "attributes": "ATTRIBUTES", @@ -55,19 +55,19 @@ class MetaOapg: "labels": "LABELS", "ALL": "ALL", } - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -513,5 +513,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/patch.pyi index c212621e4..c0b3fe4b9 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument # Query params FilterSchema = schemas.StrSchema @@ -499,5 +499,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/put.py index 6d6a3f2f3..996822c63 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument from . import path @@ -40,14 +40,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "attributes": "ATTRIBUTES", @@ -55,19 +55,19 @@ class MetaOapg: "labels": "LABELS", "ALL": "ALL", } - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -513,5 +513,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/put.pyi index 8387aa728..5b8e02ea4 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_object_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.models.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.models.json_api_filter_context_out_document import JsonApiFilterContextOutDocument # Query params FilterSchema = schemas.StrSchema @@ -38,25 +38,25 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -499,5 +499,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels/get.py index ae81026dd..d910e6bb8 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -65,29 +65,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "attributes": "ATTRIBUTES", "attribute": "ATTRIBUTE", "ALL": "ALL", } - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def ATTRIBUTE(cls): return cls("attribute") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -139,29 +139,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -585,5 +585,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels/get.pyi index d1e831828..fe6b6e01b 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.models.json_api_label_out_list import JsonApiLabelOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -55,21 +55,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def ATTRIBUTE(cls): return cls("attribute") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -120,21 +120,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -555,5 +555,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/get.py index 3634ea77a..c97a874af 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument from . import path @@ -39,29 +39,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "attributes": "ATTRIBUTES", "attribute": "ATTRIBUTE", "ALL": "ALL", } - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def ATTRIBUTE(cls): return cls("attribute") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -88,29 +88,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -511,5 +511,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/get.pyi index e6bb2323e..3f4e1a168 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.models.json_api_label_out_document import JsonApiLabelOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def ATTRIBUTE(cls): return cls("attribute") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -77,21 +77,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -489,5 +489,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/get.py index 370ad2ae2..53cca88c2 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -65,14 +65,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "facts": "FACTS", @@ -82,27 +82,27 @@ class MetaOapg: "datasets": "DATASETS", "ALL": "ALL", } - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -154,29 +154,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -600,5 +600,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/get.pyi index 15ccd7988..e3cbc2a1d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.models.json_api_metric_out_list import JsonApiMetricOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -55,33 +55,33 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -132,21 +132,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -567,5 +567,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/post.py index 63388dfd1..7676f395c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "facts": "FACTS", @@ -56,27 +56,27 @@ class MetaOapg: "datasets": "DATASETS", "ALL": "ALL", } - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -103,29 +103,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -561,5 +561,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/post.pyi index c396e38cd..8caa94fcf 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument # Query params @@ -37,33 +37,33 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -89,21 +89,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -536,5 +536,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/get.py index b0b92f8c0..4faab68fd 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "facts": "FACTS", @@ -56,27 +56,27 @@ class MetaOapg: "datasets": "DATASETS", "ALL": "ALL", } - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -103,29 +103,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -526,5 +526,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/get.pyi index 5000fbeab..e90941d4c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,33 +37,33 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -89,21 +89,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -501,5 +501,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/patch.py index 7384bfd3d..19597d47a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from . import path @@ -40,14 +40,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "facts": "FACTS", @@ -57,27 +57,27 @@ class MetaOapg: "datasets": "DATASETS", "ALL": "ALL", } - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -523,5 +523,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/patch.pyi index 81a9108c2..29525a5c8 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument # Query params FilterSchema = schemas.StrSchema @@ -38,33 +38,33 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -507,5 +507,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/put.py index 9f3d83481..ce552b95d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument from . import path @@ -40,14 +40,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "facts": "FACTS", @@ -57,27 +57,27 @@ class MetaOapg: "datasets": "DATASETS", "ALL": "ALL", } - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -523,5 +523,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/put.pyi index 418dcf822..81a3ea3fe 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_object_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.models.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.models.json_api_metric_out_document import JsonApiMetricOutDocument # Query params FilterSchema = schemas.StrSchema @@ -38,33 +38,33 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -507,5 +507,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/get.py index 845d201a3..719838969 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -65,14 +65,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "users": "USERS", @@ -86,43 +86,43 @@ class MetaOapg: "userGroup": "USER_GROUP", "ALL": "ALL", } - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def USER(cls): return cls("user") - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -174,29 +174,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -620,5 +620,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/get.pyi index 685c5bcf3..35ec69c69 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.models.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -55,49 +55,49 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def USER(cls): return cls("user") - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -148,21 +148,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -583,5 +583,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/post.py index 401bf44ed..dadf939ab 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "users": "USERS", @@ -60,43 +60,43 @@ class MetaOapg: "userGroup": "USER_GROUP", "ALL": "ALL", } - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def USER(cls): return cls("user") - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -123,29 +123,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -581,5 +581,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/post.pyi index 4255e46c7..adad8e389 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument # Query params @@ -37,49 +37,49 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def USER(cls): return cls("user") - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -105,21 +105,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -552,5 +552,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/get.py index 97cbcd28b..9b32d0a06 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "users": "USERS", @@ -60,43 +60,43 @@ class MetaOapg: "userGroup": "USER_GROUP", "ALL": "ALL", } - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def USER(cls): return cls("user") - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -123,29 +123,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -546,5 +546,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/get.pyi index a2f9ffd9b..00e241a74 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,49 +37,49 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def USER(cls): return cls("user") - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -105,21 +105,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -517,5 +517,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/patch.py index 43700d93c..b4b2a247a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument from . import path @@ -543,5 +543,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/patch.pyi index 8a3a1d303..f688a5905 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument # Query params FilterSchema = schemas.StrSchema @@ -38,49 +38,49 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def USER(cls): return cls("user") - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -523,5 +523,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/put.py index ed69fc123..ba7fb6b49 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument from . import path @@ -40,14 +40,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "users": "USERS", @@ -61,43 +61,43 @@ class MetaOapg: "userGroup": "USER_GROUP", "ALL": "ALL", } - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def USER(cls): return cls("user") - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -543,5 +543,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/put.pyi index bfc475a89..aa69bb20a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_object_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument # Query params FilterSchema = schemas.StrSchema @@ -38,49 +38,49 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def USERS(cls): return cls("users") - + @schemas.classproperty def USER_GROUPS(cls): return cls("userGroups") - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def USER(cls): return cls("user") - + @schemas.classproperty def USER_GROUP(cls): return cls("userGroup") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -523,5 +523,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/get.py index 271adf42c..33554a423 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -65,14 +65,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "facts": "FACTS", @@ -82,27 +82,27 @@ class MetaOapg: "datasets": "DATASETS", "ALL": "ALL", } - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -154,29 +154,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -600,5 +600,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/get.pyi index 95fe9ef2e..ae8f02ae0 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.models.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -55,33 +55,33 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -132,21 +132,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -567,5 +567,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/post.py index 313f69dd6..cd05130ff 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "facts": "FACTS", @@ -56,27 +56,27 @@ class MetaOapg: "datasets": "DATASETS", "ALL": "ALL", } - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -103,29 +103,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -561,5 +561,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/post.pyi index 1337912ff..295568dc3 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument # Query params @@ -37,33 +37,33 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -89,21 +89,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -536,5 +536,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/get.py index 6bdbb240e..2a8f40a23 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument from . import path @@ -39,14 +39,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "facts": "FACTS", @@ -56,27 +56,27 @@ class MetaOapg: "datasets": "DATASETS", "ALL": "ALL", } - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -103,29 +103,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -526,5 +526,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/get.pyi index 0a5335671..97059f9e6 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,33 +37,33 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -89,21 +89,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -501,5 +501,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/patch.py index 151db9b5e..feb24fc64 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument from . import path @@ -40,14 +40,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "facts": "FACTS", @@ -57,27 +57,27 @@ class MetaOapg: "datasets": "DATASETS", "ALL": "ALL", } - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -523,5 +523,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/patch.pyi index a44c49e29..c1f7bfcbe 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument # Query params FilterSchema = schemas.StrSchema @@ -38,33 +38,33 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -507,5 +507,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/put.py index baad90e83..22b34280c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument from . import path @@ -40,14 +40,14 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "facts": "FACTS", @@ -57,27 +57,27 @@ class MetaOapg: "datasets": "DATASETS", "ALL": "ALL", } - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -523,5 +523,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/put.pyi index c33777d9d..9029f0788 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_object_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.models.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.models.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument # Query params FilterSchema = schemas.StrSchema @@ -38,33 +38,33 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def FACTS(cls): return cls("facts") - + @schemas.classproperty def ATTRIBUTES(cls): return cls("attributes") - + @schemas.classproperty def LABELS(cls): return cls("labels") - + @schemas.classproperty def METRICS(cls): return cls("metrics") - + @schemas.classproperty def DATASETS(cls): return cls("datasets") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -507,5 +507,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/get.py index f264f0d1b..5daedd288 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList from . import path @@ -529,5 +529,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/get.pyi index c8742fe54..3fe52c712 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -55,21 +55,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACE_DATA_FILTERS(cls): return cls("workspaceDataFilters") - + @schemas.classproperty def WORKSPACE_DATA_FILTER(cls): return cls("workspaceDataFilter") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -508,5 +508,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/get.py index efcc5d653..2ccb6c246 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument from . import path @@ -39,29 +39,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "workspaceDataFilters": "WORKSPACE_DATA_FILTERS", "workspaceDataFilter": "WORKSPACE_DATA_FILTER", "ALL": "ALL", } - + @schemas.classproperty def WORKSPACE_DATA_FILTERS(cls): return cls("workspaceDataFilters") - + @schemas.classproperty def WORKSPACE_DATA_FILTER(cls): return cls("workspaceDataFilter") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -455,5 +455,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/get.pyi index 0d109beed..a0f37dd7e 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACE_DATA_FILTERS(cls): return cls("workspaceDataFilters") - + @schemas.classproperty def WORKSPACE_DATA_FILTER(cls): return cls("workspaceDataFilter") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -442,5 +442,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/get.py index f6d7f6183..f03a26242 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -65,29 +65,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "workspaceDataFilterSettings": "WORKSPACE_DATA_FILTER_SETTINGS", "filterSettings": "FILTER_SETTINGS", "ALL": "ALL", } - + @schemas.classproperty def WORKSPACE_DATA_FILTER_SETTINGS(cls): return cls("workspaceDataFilterSettings") - + @schemas.classproperty def FILTER_SETTINGS(cls): return cls("filterSettings") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -529,5 +529,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/get.pyi index bc311b532..987585d78 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.models.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -55,21 +55,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACE_DATA_FILTER_SETTINGS(cls): return cls("workspaceDataFilterSettings") - + @schemas.classproperty def FILTER_SETTINGS(cls): return cls("filterSettings") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -508,5 +508,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/post.py index a740a84a4..5b2b2757d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument from . import path @@ -39,29 +39,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "workspaceDataFilterSettings": "WORKSPACE_DATA_FILTER_SETTINGS", "filterSettings": "FILTER_SETTINGS", "ALL": "ALL", } - + @schemas.classproperty def WORKSPACE_DATA_FILTER_SETTINGS(cls): return cls("workspaceDataFilterSettings") - + @schemas.classproperty def FILTER_SETTINGS(cls): return cls("filterSettings") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -490,5 +490,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/post.pyi index 9d58d14d0..0f7b16ae4 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument # Query params @@ -37,21 +37,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACE_DATA_FILTER_SETTINGS(cls): return cls("workspaceDataFilterSettings") - + @schemas.classproperty def FILTER_SETTINGS(cls): return cls("filterSettings") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -477,5 +477,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/get.py index 694cdebd0..44cd150f9 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument from . import path @@ -39,29 +39,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "workspaceDataFilterSettings": "WORKSPACE_DATA_FILTER_SETTINGS", "filterSettings": "FILTER_SETTINGS", "ALL": "ALL", } - + @schemas.classproperty def WORKSPACE_DATA_FILTER_SETTINGS(cls): return cls("workspaceDataFilterSettings") - + @schemas.classproperty def FILTER_SETTINGS(cls): return cls("filterSettings") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -455,5 +455,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/get.pyi index 4443ceef7..fb8843e09 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACE_DATA_FILTER_SETTINGS(cls): return cls("workspaceDataFilterSettings") - + @schemas.classproperty def FILTER_SETTINGS(cls): return cls("filterSettings") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -442,5 +442,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/patch.py index 2e3bb540e..ec7b954fe 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument from . import path @@ -40,29 +40,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "workspaceDataFilterSettings": "WORKSPACE_DATA_FILTER_SETTINGS", "filterSettings": "FILTER_SETTINGS", "ALL": "ALL", } - + @schemas.classproperty def WORKSPACE_DATA_FILTER_SETTINGS(cls): return cls("workspaceDataFilterSettings") - + @schemas.classproperty def FILTER_SETTINGS(cls): return cls("filterSettings") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -508,5 +508,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/patch.pyi index 34fd20021..8e43ad6eb 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument # Query params FilterSchema = schemas.StrSchema @@ -38,21 +38,21 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def WORKSPACE_DATA_FILTER_SETTINGS(cls): return cls("workspaceDataFilterSettings") - + @schemas.classproperty def FILTER_SETTINGS(cls): return cls("filterSettings") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -495,5 +495,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/put.py index 64416a1f3..09909e1be 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument from . import path @@ -40,29 +40,29 @@ class IncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "workspaceDataFilterSettings": "WORKSPACE_DATA_FILTER_SETTINGS", "filterSettings": "FILTER_SETTINGS", "ALL": "ALL", } - + @schemas.classproperty def WORKSPACE_DATA_FILTER_SETTINGS(cls): return cls("workspaceDataFilterSettings") - + @schemas.classproperty def FILTER_SETTINGS(cls): return cls("filterSettings") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -508,5 +508,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/put.pyi index cee296a97..9f1ea5969 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_object_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.models.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.models.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument # Query params FilterSchema = schemas.StrSchema @@ -495,5 +495,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/get.py index ef8837647..2f5b150bc 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList from . import path @@ -44,15 +44,15 @@ class MetaOapg: "PARENTS": "PARENTS", "NATIVE": "NATIVE", } - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -91,29 +91,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -530,5 +530,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/get.pyi index bf6cf3086..aa0bb7f5a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.models.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList # Query params @@ -34,15 +34,15 @@ class OriginSchema( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ALL(cls): return cls("ALL") - + @schemas.classproperty def PARENTS(cls): return cls("PARENTS") - + @schemas.classproperty def NATIVE(cls): return cls("NATIVE") @@ -80,21 +80,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -508,5 +508,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/post.py index ff216f076..a481c6441 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/post.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/post.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from . import path @@ -40,29 +40,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -491,5 +491,3 @@ def post( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/post.pyi index b37306593..f302f98b2 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/post.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings/post.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument # Query params @@ -37,21 +37,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -477,5 +477,3 @@ class ApiForpost(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/get.py index e757a84cb..04e6b11c4 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from . import path @@ -40,29 +40,29 @@ class MetaIncludeSchema( class MetaOapg: unique_items = True - - + + class items( schemas.EnumBase, schemas.StrSchema ): - - + + class MetaOapg: enum_value_to_name = { "origin": "ORIGIN", "all": "ALL", "ALL": "ALL", } - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -456,5 +456,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/get.pyi index 6e9095343..191a4d9ed 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument # Query params FilterSchema = schemas.StrSchema @@ -37,21 +37,21 @@ class MetaIncludeSchema( class MetaOapg: - - + + class items( schemas.EnumBase, schemas.StrSchema ): - + @schemas.classproperty def ORIGIN(cls): return cls("origin") - + @schemas.classproperty def ALL(cls): return cls("all") - + @schemas.classproperty def ALL(cls): return cls("ALL") @@ -442,5 +442,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/patch.py index 8882ab77d..6383464e9 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/patch.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/patch.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument from . import path @@ -453,5 +453,3 @@ def patch( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/patch.pyi index cc32092f4..fb2f5938d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/patch.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/patch.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument # Query params FilterSchema = schemas.StrSchema @@ -448,5 +448,3 @@ class ApiForpatch(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/put.py index c67bdbf92..de2362907 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/put.py @@ -25,8 +25,8 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from . import path @@ -453,5 +453,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/put.pyi index 7772ea6b1..e6b267833 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_object_id/put.pyi @@ -25,8 +25,8 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument # Query params FilterSchema = schemas.StrSchema @@ -448,5 +448,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/get.py index f8775ad41..f6de274b3 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources from . import path @@ -235,5 +235,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/get.pyi index 4e2aac244..55f060e6a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources SchemaFor200ResponseBodyApplicationJson = DeclarativeDataSources @@ -230,5 +230,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/put.py index dc692c083..510030b5b 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources from . import path @@ -299,5 +299,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/put.pyi index 7de7505af..792edab00 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources # body param SchemaForRequestBodyApplicationJson = DeclarativeDataSources @@ -294,5 +294,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/get.py index eac38f788..bc4d558e6 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_pdm import DeclarativePdm +from gooddata_api_client.models.declarative_pdm import DeclarativePdm from . import path @@ -289,5 +289,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/get.pyi index c33762844..b18d3772c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_pdm import DeclarativePdm +from gooddata_api_client.models.declarative_pdm import DeclarativePdm # Path params DataSourceIdSchema = schemas.StrSchema @@ -284,5 +284,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/put.py index 8b8ccbc8e..f1b75e3a5 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_pdm import DeclarativePdm +from gooddata_api_client.models.declarative_pdm import DeclarativePdm from . import path @@ -356,5 +356,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/put.pyi index a435e47b8..ed51fe599 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_physical_model/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_pdm import DeclarativePdm +from gooddata_api_client.models.declarative_pdm import DeclarativePdm # Path params DataSourceIdSchema = schemas.StrSchema @@ -351,5 +351,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/get.py index c4c1d7c0f..e37557b04 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization from . import path @@ -235,5 +235,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/get.pyi index b896dd2fb..947d80ed0 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization SchemaFor200ResponseBodyApplicationJson = DeclarativeOrganization @@ -230,5 +230,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/put.py index ef3af7ae1..692e17947 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization from . import path @@ -299,5 +299,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/put.pyi index b3cbd940d..21fef4e6d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_organization import DeclarativeOrganization +from gooddata_api_client.models.declarative_organization import DeclarativeOrganization # body param SchemaForRequestBodyApplicationJson = DeclarativeOrganization @@ -294,5 +294,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/get.py index 1c788b84e..a5cf3bf03 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups from . import path @@ -235,5 +235,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/get.pyi index 91e69b5c0..4b448e086 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups SchemaFor200ResponseBodyApplicationJson = DeclarativeUserGroups @@ -230,5 +230,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/put.py index e6b20ef3a..066acea84 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups from . import path @@ -299,5 +299,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/put.pyi index 0f3ec1354..1aa0b6918 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups # body param SchemaForRequestBodyApplicationJson = DeclarativeUserGroups @@ -294,5 +294,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/get.py index e1fff4bac..78850a1ce 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions from . import path @@ -289,5 +289,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/get.pyi index 3a1398896..d2457afdd 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions # Path params UserGroupIdSchema = schemas.StrSchema @@ -284,5 +284,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/put.py index bb355cf0d..0e1cc28a1 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions from . import path @@ -356,5 +356,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/put.pyi index 3bf31c8d2..f49580f3d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_user_groups_user_group_id_permissions/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions +from gooddata_api_client.models.declarative_user_group_permissions import DeclarativeUserGroupPermissions # Path params UserGroupIdSchema = schemas.StrSchema @@ -351,5 +351,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/get.py index ea9391a69..19ac38bb4 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers from . import path @@ -235,5 +235,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/get.pyi index 248c37812..972961930 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers SchemaFor200ResponseBodyApplicationJson = DeclarativeUsers @@ -230,5 +230,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/put.py index 47701e64e..5ac6423df 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers from . import path @@ -299,5 +299,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/put.pyi index a7fd9a0f0..47626855a 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_users import DeclarativeUsers # body param SchemaForRequestBodyApplicationJson = DeclarativeUsers @@ -294,5 +294,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/get.py index 643470756..816a7f2cc 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups from . import path @@ -235,5 +235,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/get.pyi index 37d2b15f8..d8aea2060 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups SchemaFor200ResponseBodyApplicationJson = DeclarativeUsersUserGroups @@ -230,5 +230,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/put.py index 02f3bf690..11c6e2150 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups from . import path @@ -299,5 +299,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/put.pyi index 4ea0c8745..af231808e 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_and_user_groups/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups # body param SchemaForRequestBodyApplicationJson = DeclarativeUsersUserGroups @@ -294,5 +294,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/get.py index 1625abda9..2bbc3cda7 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions from . import path @@ -289,5 +289,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/get.pyi index 9ddde2dd3..0bb6e11c1 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions # Path params UserIdSchema = schemas.StrSchema @@ -284,5 +284,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/put.py index 5038b0438..4e2e005fb 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions from . import path @@ -356,5 +356,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/put.pyi index dbe983ac1..7c123c7ce 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_users_user_id_permissions/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions +from gooddata_api_client.models.declarative_user_permissions import DeclarativeUserPermissions # Path params UserIdSchema = schemas.StrSchema @@ -351,5 +351,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/get.py index cd96c72b9..beb50041c 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters from . import path @@ -235,5 +235,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/get.pyi index f4c71ba26..f7f738482 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters SchemaFor200ResponseBodyApplicationJson = DeclarativeWorkspaceDataFilters @@ -230,5 +230,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/put.py index 4ab83b7f7..be0b5dd6d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters from . import path @@ -299,5 +299,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/put.pyi index 1da7e6d7d..6be4eb800 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspace_data_filters/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters # body param SchemaForRequestBodyApplicationJson = DeclarativeWorkspaceDataFilters @@ -294,5 +294,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/get.py index 28cd93e20..025cec393 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces from . import path @@ -235,5 +235,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/get.pyi index 0c17b3195..db380d049 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces SchemaFor200ResponseBodyApplicationJson = DeclarativeWorkspaces @@ -230,5 +230,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/put.py index 345004397..1d88a99cf 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces from . import path @@ -299,5 +299,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/put.pyi index a79cd2f50..efa89916b 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces # body param SchemaForRequestBodyApplicationJson = DeclarativeWorkspaces @@ -294,5 +294,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/get.py index 579510f75..40f85ddce 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel from . import path @@ -289,5 +289,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/get.pyi index d052e37fb..ae63ea225 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel # Path params WorkspaceIdSchema = schemas.StrSchema @@ -284,5 +284,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/put.py index 1a81339d9..08d7d6563 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel from . import path @@ -356,5 +356,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/put.pyi index d552b0695..953067e20 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel # Path params WorkspaceIdSchema = schemas.StrSchema @@ -351,5 +351,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/get.py index c907a1f5a..aea341adf 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics from . import path @@ -289,5 +289,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/get.pyi index b061de071..1875947d8 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics # Path params WorkspaceIdSchema = schemas.StrSchema @@ -284,5 +284,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/put.py index 5935e3f4a..a8c4be746 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics from . import path @@ -356,5 +356,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/put.pyi index 7bce7b4b1..6ceaa1d4e 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_analytics_model/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics # Path params WorkspaceIdSchema = schemas.StrSchema @@ -351,5 +351,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/get.py index 140a0b6cc..3a038334f 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel from . import path @@ -343,5 +343,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/get.pyi index fa25a0531..3b3a39b85 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel # Query params IncludeParentsSchema = schemas.BoolSchema @@ -338,5 +338,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/put.py index c39225996..ea0e765ae 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel from . import path @@ -356,5 +356,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/put.pyi index f0e1cb9d1..49ae0f65d 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_logical_model/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_model import DeclarativeModel # Path params WorkspaceIdSchema = schemas.StrSchema @@ -351,5 +351,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/get.py index c2b126084..d89dd38c1 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions from . import path @@ -289,5 +289,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/get.pyi index 570d6d915..261eea939 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions # Path params WorkspaceIdSchema = schemas.StrSchema @@ -284,5 +284,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/put.py index 6b3bbcbc4..16f1469ec 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions from . import path @@ -356,5 +356,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/put.pyi index 13edccea9..342ede0cf 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_permissions/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions # Path params WorkspaceIdSchema = schemas.StrSchema @@ -351,5 +351,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/get.py index aac083318..e8b03dfb3 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/get.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/get.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters from . import path @@ -289,5 +289,3 @@ def get( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/get.pyi index 7b8fbe2d7..66c07c839 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/get.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/get.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters # Path params WorkspaceIdSchema = schemas.StrSchema @@ -284,5 +284,3 @@ class ApiForget(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/put.py index b5bbbe255..5548c4254 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/put.py +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/put.py @@ -25,7 +25,7 @@ from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters from . import path @@ -356,5 +356,3 @@ def put( timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/put.pyi index 50f27c973..5dde1ebb4 100644 --- a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/put.pyi +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_user_data_filters/put.pyi @@ -25,7 +25,7 @@ import frozendict # noqa: F401 from gooddata_api_client import schemas # noqa: F401 -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters # Path params WorkspaceIdSchema = schemas.StrSchema @@ -351,5 +351,3 @@ class ApiForput(BaseApi): timeout=timeout, skip_deserialization=skip_deserialization ) - - diff --git a/gooddata-api-client/gooddata_api_client/py.typed b/gooddata-api-client/gooddata_api_client/py.typed new file mode 100644 index 000000000..e69de29bb diff --git a/gooddata-api-client/gooddata_api_client/rest.py b/gooddata-api-client/gooddata_api_client/rest.py index cc9e27616..403424d59 100644 --- a/gooddata-api-client/gooddata_api_client/rest.py +++ b/gooddata-api-client/gooddata_api_client/rest.py @@ -1,55 +1,69 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 import io import json -import logging import re import ssl -from urllib.parse import urlencode -from urllib.parse import urlparse -from urllib.request import proxy_bypass_environment + import urllib3 -import ipaddress -from gooddata_api_client.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError +from gooddata_api_client.exceptions import ApiException, ApiValueError +SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"} +RESTResponseType = urllib3.HTTPResponse -logger = logging.getLogger(__name__) + +def is_socks_proxy_url(url): + if url is None: + return False + split_section = url.split("://") + if len(split_section) < 2: + return False + else: + return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES class RESTResponse(io.IOBase): - def __init__(self, resp): - self.urllib3_response = resp + def __init__(self, resp) -> None: + self.response = resp self.status = resp.status self.reason = resp.reason - self.data = resp.data + self.data = None + + def read(self): + if self.data is None: + self.data = self.response.data + return self.data def getheaders(self): """Returns a dictionary of the response headers.""" - return self.urllib3_response.getheaders() + return self.response.headers def getheader(self, name, default=None): """Returns a given response header.""" - return self.urllib3_response.getheader(name, default) + return self.response.headers.get(name, default) -class RESTClientObject(object): +class RESTClientObject: - def __init__(self, configuration, pools_size=4, maxsize=None): + def __init__(self, configuration) -> None: # urllib3.PoolManager will pass all kw parameters to connectionpool # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 - # maxsize is the number of requests to host that are allowed in parallel # noqa: E501 # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 # cert_reqs @@ -58,71 +72,79 @@ def __init__(self, configuration, pools_size=4, maxsize=None): else: cert_reqs = ssl.CERT_NONE - addition_pool_args = {} + pool_args = { + "cert_reqs": cert_reqs, + "ca_certs": configuration.ssl_ca_cert, + "cert_file": configuration.cert_file, + "key_file": configuration.key_file, + } if configuration.assert_hostname is not None: - addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 + pool_args['assert_hostname'] = ( + configuration.assert_hostname + ) if configuration.retries is not None: - addition_pool_args['retries'] = configuration.retries + pool_args['retries'] = configuration.retries + + if configuration.tls_server_name: + pool_args['server_hostname'] = configuration.tls_server_name + if configuration.socket_options is not None: - addition_pool_args['socket_options'] = configuration.socket_options + pool_args['socket_options'] = configuration.socket_options - if maxsize is None: - if configuration.connection_pool_maxsize is not None: - maxsize = configuration.connection_pool_maxsize - else: - maxsize = 4 + if configuration.connection_pool_maxsize is not None: + pool_args['maxsize'] = configuration.connection_pool_maxsize # https pool manager - if configuration.proxy and not should_bypass_proxies( - configuration.host, no_proxy=configuration.no_proxy or ''): - self.pool_manager = urllib3.ProxyManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=configuration.ssl_ca_cert, - cert_file=configuration.cert_file, - key_file=configuration.key_file, - proxy_url=configuration.proxy, - proxy_headers=configuration.proxy_headers, - **addition_pool_args - ) + self.pool_manager: urllib3.PoolManager + + if configuration.proxy: + if is_socks_proxy_url(configuration.proxy): + from urllib3.contrib.socks import SOCKSProxyManager + pool_args["proxy_url"] = configuration.proxy + pool_args["headers"] = configuration.proxy_headers + self.pool_manager = SOCKSProxyManager(**pool_args) + else: + pool_args["proxy_url"] = configuration.proxy + pool_args["proxy_headers"] = configuration.proxy_headers + self.pool_manager = urllib3.ProxyManager(**pool_args) else: - self.pool_manager = urllib3.PoolManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=configuration.ssl_ca_cert, - cert_file=configuration.cert_file, - key_file=configuration.key_file, - **addition_pool_args - ) - - def request(self, method, url, query_params=None, headers=None, - body=None, post_params=None, _preload_content=True, - _request_timeout=None): + self.pool_manager = urllib3.PoolManager(**pool_args) + + def request( + self, + method, + url, + headers=None, + body=None, + post_params=None, + _request_timeout=None + ): """Perform requests. :param method: http request method :param url: http request url - :param query_params: query parameters in the url :param headers: http request headers :param body: request json body, for `application/json` :param post_params: request post parameters, `application/x-www-form-urlencoded` and `multipart/form-data` - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. :param _request_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. """ method = method.upper() - assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', - 'PATCH', 'OPTIONS'] + assert method in [ + 'GET', + 'HEAD', + 'DELETE', + 'POST', + 'PUT', + 'PATCH', + 'OPTIONS' + ] if post_params and body: raise ApiValueError( @@ -134,61 +156,83 @@ def request(self, method, url, query_params=None, headers=None, timeout = None if _request_timeout: - if isinstance(_request_timeout, (int, float)): # noqa: E501,F821 + if isinstance(_request_timeout, (int, float)): timeout = urllib3.Timeout(total=_request_timeout) - elif (isinstance(_request_timeout, tuple) and - len(_request_timeout) == 2): + elif ( + isinstance(_request_timeout, tuple) + and len(_request_timeout) == 2 + ): timeout = urllib3.Timeout( - connect=_request_timeout[0], read=_request_timeout[1]) + connect=_request_timeout[0], + read=_request_timeout[1] + ) try: # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: - # Only set a default Content-Type for POST, PUT, PATCH and OPTIONS requests - if (method != 'DELETE') and ('Content-Type' not in headers): - headers['Content-Type'] = 'application/json' - if query_params: - url += '?' + urlencode(query_params) - if ('Content-Type' not in headers) or (re.search('json', - headers['Content-Type'], re.IGNORECASE)): + + # no content type provided or payload is json + content_type = headers.get('Content-Type') + if ( + not content_type + or re.search('json', content_type, re.IGNORECASE) + ): request_body = None if body is not None: request_body = json.dumps(body) r = self.pool_manager.request( - method, url, + method, + url, body=request_body, - preload_content=_preload_content, timeout=timeout, - headers=headers) - elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 + headers=headers, + preload_content=False + ) + elif content_type == 'application/x-www-form-urlencoded': r = self.pool_manager.request( - method, url, + method, + url, fields=post_params, encode_multipart=False, - preload_content=_preload_content, timeout=timeout, - headers=headers) - elif headers['Content-Type'] == 'multipart/form-data': + headers=headers, + preload_content=False + ) + elif content_type == 'multipart/form-data': # must del headers['Content-Type'], or the correct # Content-Type which generated by urllib3 will be # overwritten. del headers['Content-Type'] + # Ensures that dict objects are serialized + post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params] r = self.pool_manager.request( - method, url, + method, + url, fields=post_params, encode_multipart=True, - preload_content=_preload_content, timeout=timeout, - headers=headers) + headers=headers, + preload_content=False + ) # Pass a `string` parameter directly in the body to support - # other content types than Json when `body` argument is - # provided in serialized form + # other content types than JSON when `body` argument is + # provided in serialized form. elif isinstance(body, str) or isinstance(body, bytes): - request_body = body r = self.pool_manager.request( - method, url, + method, + url, + body=body, + timeout=timeout, + headers=headers, + preload_content=False + ) + elif headers['Content-Type'].startswith('text/') and isinstance(body, bool): + request_body = "true" if body else "false" + r = self.pool_manager.request( + method, + url, body=request_body, - preload_content=_preload_content, + preload_content=False, timeout=timeout, headers=headers) else: @@ -199,155 +243,16 @@ def request(self, method, url, query_params=None, headers=None, raise ApiException(status=0, reason=msg) # For `GET`, `HEAD` else: - r = self.pool_manager.request(method, url, - fields=query_params, - preload_content=_preload_content, - timeout=timeout, - headers=headers) + r = self.pool_manager.request( + method, + url, + fields={}, + timeout=timeout, + headers=headers, + preload_content=False + ) except urllib3.exceptions.SSLError as e: - msg = "{0}\n{1}".format(type(e).__name__, str(e)) + msg = "\n".join([type(e).__name__, str(e)]) raise ApiException(status=0, reason=msg) - if _preload_content: - r = RESTResponse(r) - - # log response body - logger.debug("response body: %s", r.data) - - if not 200 <= r.status <= 299: - if r.status == 401: - raise UnauthorizedException(http_resp=r) - - if r.status == 403: - raise ForbiddenException(http_resp=r) - - if r.status == 404: - raise NotFoundException(http_resp=r) - - if 500 <= r.status <= 599: - raise ServiceException(http_resp=r) - - raise ApiException(http_resp=r) - - return r - - def GET(self, url, headers=None, query_params=None, _preload_content=True, - _request_timeout=None): - return self.request("GET", url, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - query_params=query_params) - - def HEAD(self, url, headers=None, query_params=None, _preload_content=True, - _request_timeout=None): - return self.request("HEAD", url, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - query_params=query_params) - - def OPTIONS(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("OPTIONS", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def DELETE(self, url, headers=None, query_params=None, body=None, - _preload_content=True, _request_timeout=None): - return self.request("DELETE", url, - headers=headers, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def POST(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("POST", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def PUT(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("PUT", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def PATCH(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("PATCH", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - -# end of class RESTClientObject - - -def is_ipv4(target): - """ Test if IPv4 address or not - """ - try: - chk = ipaddress.IPv4Address(target) - return True - except ipaddress.AddressValueError: - return False - - -def in_ipv4net(target, net): - """ Test if target belongs to given IPv4 network - """ - try: - nw = ipaddress.IPv4Network(net) - ip = ipaddress.IPv4Address(target) - if ip in nw: - return True - return False - except ipaddress.AddressValueError: - return False - except ipaddress.NetmaskValueError: - return False - - -def should_bypass_proxies(url, no_proxy=None): - """ Yet another requests.should_bypass_proxies - Test if proxies should not be used for a particular url. - """ - - parsed = urlparse(url) - - # special cases - if parsed.hostname in [None, '']: - return True - - # special cases - if no_proxy in [None, '']: - return False - if no_proxy == '*': - return True - - no_proxy = no_proxy.lower().replace(' ', ''); - entries = ( - host for host in no_proxy.split(',') if host - ) - - if is_ipv4(parsed.hostname): - for item in entries: - if in_ipv4net(parsed.hostname, item): - return True - return proxy_bypass_environment(parsed.hostname, {'no': no_proxy}) + return RESTResponse(r) diff --git a/gooddata-api-client/pyproject.toml b/gooddata-api-client/pyproject.toml new file mode 100644 index 000000000..0fd4825a3 --- /dev/null +++ b/gooddata-api-client/pyproject.toml @@ -0,0 +1,89 @@ +[tool.poetry] +name = "gooddata_api_client" +version = "1.51.0" +description = "OpenAPI definition" +authors = ["GoodData (generated by OpenAPI Generator) "] +license = "MIT" +readme = "README.md" +repository = "https://github.com/GIT_USER_ID/GIT_REPO_ID" +keywords = ["OpenAPI", "OpenAPI-Generator", "OpenAPI definition"] +include = ["gooddata_api_client/py.typed"] + +[tool.poetry.dependencies] +python = "^3.8" + +urllib3 = ">= 1.25.3, < 3.0.0" +python-dateutil = ">= 2.8.2" +pydantic = ">= 2" +typing-extensions = ">= 4.7.1" + +[tool.poetry.dev-dependencies] +pytest = ">= 7.2.1" +pytest-cov = ">= 2.8.1" +tox = ">= 3.9.0" +flake8 = ">= 4.0.0" +types-python-dateutil = ">= 2.8.19.14" +mypy = ">= 1.5" + + +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[tool.pylint.'MESSAGES CONTROL'] +extension-pkg-whitelist = "pydantic" + +[tool.mypy] +files = [ + "gooddata_api_client", + #"test", # auto-generated tests + "tests", # hand-written tests +] +# TODO: enable "strict" once all these individual checks are passing +# strict = true + +# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options +warn_unused_configs = true +warn_redundant_casts = true +warn_unused_ignores = true + +## Getting these passing should be easy +strict_equality = true +extra_checks = true + +## Strongly recommend enabling this one as soon as you can +check_untyped_defs = true + +## These shouldn't be too much additional work, but may be tricky to +## get passing if you use a lot of untyped libraries +disallow_subclassing_any = true +disallow_untyped_decorators = true +disallow_any_generics = true + +### These next few are various gradations of forcing use of type annotations +#disallow_untyped_calls = true +#disallow_incomplete_defs = true +#disallow_untyped_defs = true +# +### This one isn't too hard to get passing, but return on investment is lower +#no_implicit_reexport = true +# +### This one can be tricky to get passing if you use a lot of untyped libraries +#warn_return_any = true + +[[tool.mypy.overrides]] +module = [ + "gooddata_api_client.configuration", +] +warn_unused_ignores = true +strict_equality = true +extra_checks = true +check_untyped_defs = true +disallow_subclassing_any = true +disallow_untyped_decorators = true +disallow_any_generics = true +disallow_untyped_calls = true +disallow_incomplete_defs = true +disallow_untyped_defs = true +no_implicit_reexport = true +warn_return_any = true diff --git a/gooddata-api-client/requirements.txt b/gooddata-api-client/requirements.txt index 96947f604..67f7f68df 100644 --- a/gooddata-api-client/requirements.txt +++ b/gooddata-api-client/requirements.txt @@ -1,3 +1,4 @@ -python_dateutil >= 2.5.3 -setuptools >= 21.0.0 -urllib3 >= 1.25.3 +urllib3 >= 1.25.3, < 3.0.0 +python_dateutil >= 2.8.2 +pydantic >= 2 +typing-extensions >= 4.7.1 diff --git a/gooddata-api-client/setup.py b/gooddata-api-client/setup.py index 4892d4131..3894557f9 100644 --- a/gooddata-api-client/setup.py +++ b/gooddata-api-client/setup.py @@ -1,12 +1,16 @@ +# coding: utf-8 + """ OpenAPI definition - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: v0 Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 from setuptools import setup, find_packages # noqa: H301 @@ -25,8 +29,10 @@ # http://pypi.python.org/pypi/setuptools REQUIRES = [ - "urllib3 >= 1.25.3", - "python-dateutil", + "urllib3 >= 1.25.3, < 3.0.0", + "python-dateutil >= 2.8.2", + "pydantic >= 2", + "typing-extensions >= 4.7.1", ] setup( @@ -37,7 +43,7 @@ author_email="support@gooddata.com", url="", keywords=["OpenAPI", "OpenAPI-Generator", "OpenAPI definition"], - python_requires=">=3.6", + python_requires=">=3.8", install_requires=REQUIRES, packages=find_packages(exclude=["test", "tests"]), include_package_data=True, diff --git a/gooddata-api-client/test-requirements.txt b/gooddata-api-client/test-requirements.txt index bb4f22bb7..e98555c11 100644 --- a/gooddata-api-client/test-requirements.txt +++ b/gooddata-api-client/test-requirements.txt @@ -1 +1,6 @@ -pytest-cov>=2.8.1 +pytest >= 7.2.1 +pytest-cov >= 2.8.1 +tox >= 3.9.0 +flake8 >= 4.0.0 +types-python-dateutil >= 2.8.19.14 +mypy >= 1.5 diff --git a/gooddata-dbt/test-requirements.txt b/gooddata-dbt/test-requirements.txt index ce3f0ce4e..3b7aa6b42 100644 --- a/gooddata-dbt/test-requirements.txt +++ b/gooddata-dbt/test-requirements.txt @@ -1,2 +1,3 @@ pytest~=8.3.4 pytest-cov~=6.0.0 +pydantic >= 2 diff --git a/gooddata-fdw/test-requirements.txt b/gooddata-fdw/test-requirements.txt index c64329c7e..5d71de150 100644 --- a/gooddata-fdw/test-requirements.txt +++ b/gooddata-fdw/test-requirements.txt @@ -3,4 +3,5 @@ pytest-cov~=6.0.0 vcrpy~=7.0.0 # TODO - Bump the version together with bumping the version of openapi generator urllib3==1.26.9 +pydantic >= 2 pyyaml diff --git a/gooddata-flexconnect/test-requirements.txt b/gooddata-flexconnect/test-requirements.txt index 86bb99d4a..114436c01 100644 --- a/gooddata-flexconnect/test-requirements.txt +++ b/gooddata-flexconnect/test-requirements.txt @@ -1,3 +1,4 @@ jsonschema~=4.23.0 pytest~=8.3.4 pytest-cov~=6.0.0 +pydantic >= 2 diff --git a/gooddata-pandas/gooddata_pandas/dataframe.py b/gooddata-pandas/gooddata_pandas/dataframe.py index e5d3b943f..f8494080d 100644 --- a/gooddata-pandas/gooddata_pandas/dataframe.py +++ b/gooddata-pandas/gooddata_pandas/dataframe.py @@ -404,9 +404,7 @@ def for_exec_result_id( execution_response=BareExecutionResponse( api_client=self._sdk.client, workspace_id=self._workspace_id, - execution_response=models.AfmExecutionResponse( - result_cache_metadata.execution_response, _check_type=False - ), + execution_response=models.AfmExecutionResponse(result_cache_metadata.execution_response), ), result_cache_metadata=result_cache_metadata, label_overrides=label_overrides, diff --git a/gooddata-pandas/test-requirements.txt b/gooddata-pandas/test-requirements.txt index 3d1fcf495..55066ea3e 100644 --- a/gooddata-pandas/test-requirements.txt +++ b/gooddata-pandas/test-requirements.txt @@ -3,5 +3,6 @@ pytest-cov~=6.0.0 vcrpy~=7.0.0 # TODO - Bump the version together with bumping the version of openapi generator urllib3==1.26.9 +pydantic >= 2 python-dotenv~=1.0.0 pyyaml diff --git a/gooddata-sdk/gooddata_sdk/catalog/catalog_service_base.py b/gooddata-sdk/gooddata_sdk/catalog/catalog_service_base.py index 3da72a6b4..cb3858c29 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/catalog_service_base.py +++ b/gooddata-sdk/gooddata_sdk/catalog/catalog_service_base.py @@ -3,8 +3,8 @@ from pathlib import Path -from gooddata_api_client import apis -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client import api +from gooddata_api_client.models.json_api_organization_out_document import JsonApiOrganizationOutDocument from gooddata_sdk.catalog.organization.entity_model.organization import CatalogOrganization from gooddata_sdk.client import GoodDataApiClient @@ -15,10 +15,10 @@ class CatalogServiceBase: def __init__(self, api_client: GoodDataApiClient) -> None: self._client = api_client - self._entities_api: apis.EntitiesApi = api_client.entities_api - self._layout_api: apis.LayoutApi = api_client.layout_api - self._actions_api: apis.ActionsApi = api_client.actions_api - self._user_management_api: apis.UserManagementApi = api_client.user_management_api + self._entities_api: api.EntitiesApi = api_client.entities_api + self._layout_api: api.LayoutApi = api_client.layout_api + self._actions_api: api.ActionsApi = api_client.actions_api + self._user_management_api: api.UserManagementApi = api_client.user_management_api def get_organization(self) -> CatalogOrganization: # The generated client does work properly with redirecting APIs diff --git a/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/ldm_request.py b/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/ldm_request.py index 320e87971..0d5598fcf 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/ldm_request.py +++ b/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/ldm_request.py @@ -4,9 +4,9 @@ from typing import Optional import attr -from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest -from gooddata_api_client.model.pdm_ldm_request import PdmLdmRequest -from gooddata_api_client.model.pdm_sql import PdmSql +from gooddata_api_client.models.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.models.pdm_ldm_request import PdmLdmRequest +from gooddata_api_client.models.pdm_sql import PdmSql from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.data_source.action_model.sql_column import SqlColumn diff --git a/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/scan_model_request.py b/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/scan_model_request.py index 38cdf0e7e..368845bdd 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/scan_model_request.py +++ b/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/scan_model_request.py @@ -5,7 +5,7 @@ import attr from attr import field -from gooddata_api_client.model.scan_request import ScanRequest +from gooddata_api_client.models.scan_request import ScanRequest from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/scan_sql_request.py b/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/scan_sql_request.py index cb1a7dd2b..bfb79a945 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/scan_sql_request.py +++ b/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/requests/scan_sql_request.py @@ -2,7 +2,7 @@ from __future__ import annotations import attr -from gooddata_api_client.model.scan_sql_request import ScanSqlRequest as ApiScanSqlRequest +from gooddata_api_client.models.scan_sql_request import ScanSqlRequest as ApiScanSqlRequest from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/responses/scan_sql_response.py b/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/responses/scan_sql_response.py index 1dbcb0be9..e301dc08c 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/responses/scan_sql_response.py +++ b/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/responses/scan_sql_response.py @@ -4,7 +4,7 @@ from typing import Optional import attr -from gooddata_api_client.model.scan_sql_response import ScanSqlResponse as ApiScanSqlResponse +from gooddata_api_client.models.scan_sql_response import ScanSqlResponse as ApiScanSqlResponse from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.data_source.action_model.sql_column import SqlColumn diff --git a/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/sql_column.py b/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/sql_column.py index 92e865d6a..c0b6528a7 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/sql_column.py +++ b/gooddata-sdk/gooddata_sdk/catalog/data_source/action_model/sql_column.py @@ -2,7 +2,7 @@ from __future__ import annotations import attr -from gooddata_api_client.model.sql_column import SqlColumn as ApiSqlColumn +from gooddata_api_client.models.sql_column import SqlColumn as ApiSqlColumn from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/data_source.py b/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/data_source.py index 94bcb8cb2..e2cf9a8d4 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/data_source.py +++ b/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/data_source.py @@ -7,9 +7,9 @@ from warnings import warn import attr -from gooddata_api_client.model.declarative_data_source import DeclarativeDataSource -from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources -from gooddata_api_client.model.test_definition_request import TestDefinitionRequest +from gooddata_api_client.models.declarative_data_source import DeclarativeDataSource +from gooddata_api_client.models.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.models.test_definition_request import TestDefinitionRequest from gooddata_sdk.catalog.base import Base, value_in_allowed from gooddata_sdk.catalog.entity import ClientSecretCredentialsFromFile, TokenCredentialsFromFile diff --git a/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/column.py b/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/column.py index 95344c1a8..d023aef31 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/column.py +++ b/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/column.py @@ -4,7 +4,7 @@ from typing import Optional import attr -from gooddata_api_client.model.declarative_column import DeclarativeColumn +from gooddata_api_client.models.declarative_column import DeclarativeColumn from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/pdm.py b/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/pdm.py index ce7bb4b69..40567fe05 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/pdm.py +++ b/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/pdm.py @@ -4,7 +4,7 @@ from pathlib import Path import attr -from gooddata_api_client.model.declarative_tables import DeclarativeTables +from gooddata_api_client.models.declarative_tables import DeclarativeTables from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.data_source.declarative_model.physical_model.table import CatalogDeclarativeTable diff --git a/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/table.py b/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/table.py index ea80d4a15..4608bdf91 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/table.py +++ b/gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/table.py @@ -6,7 +6,7 @@ from typing import Optional import attr -from gooddata_api_client.model.declarative_table import DeclarativeTable +from gooddata_api_client.models.declarative_table import DeclarativeTable from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.data_source.declarative_model.physical_model.column import CatalogDeclarativeColumn diff --git a/gooddata-sdk/gooddata_sdk/catalog/data_source/entity_model/data_source.py b/gooddata-sdk/gooddata_sdk/catalog/data_source/entity_model/data_source.py index 73ff6ab28..935130dd2 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/data_source/entity_model/data_source.py +++ b/gooddata-sdk/gooddata_sdk/catalog/data_source/entity_model/data_source.py @@ -6,12 +6,12 @@ import attr from cattrs import structure -from gooddata_api_client.model.json_api_data_source_in import JsonApiDataSourceIn -from gooddata_api_client.model.json_api_data_source_in_attributes import JsonApiDataSourceInAttributes -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_patch import JsonApiDataSourcePatch -from gooddata_api_client.model.json_api_data_source_patch_attributes import JsonApiDataSourcePatchAttributes -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.models.json_api_data_source_in import JsonApiDataSourceIn +from gooddata_api_client.models.json_api_data_source_in_attributes import JsonApiDataSourceInAttributes +from gooddata_api_client.models.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.models.json_api_data_source_patch import JsonApiDataSourcePatch +from gooddata_api_client.models.json_api_data_source_patch_attributes import JsonApiDataSourcePatchAttributes +from gooddata_api_client.models.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument from gooddata_sdk.catalog.base import Base, value_in_allowed from gooddata_sdk.catalog.entity import ( diff --git a/gooddata-sdk/gooddata_sdk/catalog/data_source/service.py b/gooddata-sdk/gooddata_sdk/catalog/data_source/service.py index e3e0b88fb..5ff474584 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/data_source/service.py +++ b/gooddata-sdk/gooddata_sdk/catalog/data_source/service.py @@ -1,7 +1,6 @@ # (C) 2022 GoodData Corporation from __future__ import annotations -import functools from pathlib import Path from typing import Any, Optional, Union @@ -129,11 +128,7 @@ def list_data_sources(self) -> list[CatalogDataSource]: list[CatalogDataSource]: List of all Data Sources in the whole organization. """ - get_data_sources = functools.partial( - self._entities_api.get_all_entities_data_sources, - _check_return_type=False, - ) - data_sources = load_all_entities_dict(get_data_sources) + data_sources = load_all_entities_dict(self._entities_api.get_all_entities_data_sources) return [CatalogDataSource.from_api(ds) for ds in data_sources["data"]] # Declarative methods are listed below diff --git a/gooddata-sdk/gooddata_sdk/catalog/depends_on.py b/gooddata-sdk/gooddata_sdk/catalog/depends_on.py index a31bfdaa4..21a253aad 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/depends_on.py +++ b/gooddata-sdk/gooddata_sdk/catalog/depends_on.py @@ -4,9 +4,9 @@ from typing import Union import attr -from gooddata_api_client.model.absolute_date_filter import AbsoluteDateFilter as AbsoluteDateFilterAPI -from gooddata_api_client.model.elements_request_depends_on_inner import ElementsRequestDependsOnInner -from gooddata_api_client.model.relative_date_filter import RelativeDateFilter as RelativeDateFilterAPI +from gooddata_api_client.models.absolute_date_filter import AbsoluteDateFilter as AbsoluteDateFilterAPI +from gooddata_api_client.models.elements_request_depends_on_inner import ElementsRequestDependsOnInner +from gooddata_api_client.models.relative_date_filter import RelativeDateFilter as RelativeDateFilterAPI from gooddata_sdk.catalog.base import Base from gooddata_sdk.compute.model.filter import AbsoluteDateFilter, RelativeDateFilter diff --git a/gooddata-sdk/gooddata_sdk/catalog/export/request.py b/gooddata-sdk/gooddata_sdk/catalog/export/request.py index d2a2a783f..cfdecdf9c 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/export/request.py +++ b/gooddata-sdk/gooddata_sdk/catalog/export/request.py @@ -2,13 +2,13 @@ from typing import Literal, Optional from attrs import define -from gooddata_api_client.model.custom_label import CustomLabel as ApiCustomLabel -from gooddata_api_client.model.custom_metric import CustomMetric as ApiCustomMetric -from gooddata_api_client.model.custom_override import CustomOverride as ApiCustomOverride -from gooddata_api_client.model.settings import Settings as ApiSettings -from gooddata_api_client.model.slides_export_request import SlidesExportRequest as SlidesExportRequestApi -from gooddata_api_client.model.tabular_export_request import TabularExportRequest -from gooddata_api_client.model.visual_export_request import VisualExportRequest as VisualExportRequestApi +from gooddata_api_client.models.custom_label import CustomLabel as ApiCustomLabel +from gooddata_api_client.models.custom_metric import CustomMetric as ApiCustomMetric +from gooddata_api_client.models.custom_override import CustomOverride as ApiCustomOverride +from gooddata_api_client.models.settings import Settings as ApiSettings +from gooddata_api_client.models.slides_export_request import SlidesExportRequest as SlidesExportRequestApi +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.visual_export_request import VisualExportRequest as VisualExportRequestApi from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/export/service.py b/gooddata-sdk/gooddata_sdk/catalog/export/service.py index 8774b3c98..c743feb90 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/export/service.py +++ b/gooddata-sdk/gooddata_sdk/catalog/export/service.py @@ -4,9 +4,9 @@ from typing import Any, Callable, Optional, Union from gooddata_api_client.exceptions import NotFoundException -from gooddata_api_client.model.slides_export_request import SlidesExportRequest as SlidesExportRequestApi -from gooddata_api_client.model.tabular_export_request import TabularExportRequest -from gooddata_api_client.model.visual_export_request import VisualExportRequest +from gooddata_api_client.models.slides_export_request import SlidesExportRequest as SlidesExportRequestApi +from gooddata_api_client.models.tabular_export_request import TabularExportRequest +from gooddata_api_client.models.visual_export_request import VisualExportRequest from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase from gooddata_sdk.catalog.export.request import ( @@ -85,14 +85,14 @@ def _get_exported_content( ) assert timeout > retry, f"Retry value {retry} cannot be higher than timeout value {timeout}" assert retry <= max_retry, f"Retry value {retry} must be smaller or the same as max retry value {max_retry}" - response = get_func(workspace_id=workspace_id, export_id=export_id, _preload_content=False) + response = get_func(workspace_id=workspace_id, export_id=export_id) if response.status == 202: counter = 0 while counter * retry <= timeout: time.sleep(retry) retry = min(retry * 2, max_retry) counter += 1 - response = get_func(workspace_id=workspace_id, export_id=export_id, _preload_content=False) + response = get_func(workspace_id=workspace_id, export_id=export_id) if response.status != 202: break if response.status != 200: @@ -116,7 +116,7 @@ def _create_export( str: The export result from the response object. """ response = create_func(workspace_id, request) - return response["export_result"] + return response.export_result def _dashboard_id_exists(self, workspace_id: str, dashboard_id: str) -> bool: """ @@ -222,7 +222,7 @@ def export_pdf( request = VisualExportRequest(dashboard_id=dashboard_id, file_name=file_name, metadata=metadata) file_path = store_path / f"{file_name}.pdf" create_func = self._actions_api.create_pdf_export - get_func = self._actions_api.get_exported_file + get_func = self._actions_api.get_exported_file_without_preload_content self._export_common(workspace_id, request, file_path, create_func, get_func, timeout, retry, max_retry) def export_tabular( @@ -253,7 +253,7 @@ def export_tabular( store_path = store_path if isinstance(store_path, Path) else Path(store_path) file_path = store_path / export_request.file create_func = self._actions_api.create_tabular_export - get_func = self._actions_api.get_tabular_export + get_func = self._actions_api.get_tabular_export_without_preload_content self._export_common( workspace_id, export_request.to_api(), file_path, create_func, get_func, timeout, retry, max_retry ) @@ -344,5 +344,5 @@ def export_slides( store_path = store_path if isinstance(store_path, Path) else Path(store_path) file_path = store_path / f"{request.file_name}.{request.format.lower()}" create_func = self._actions_api.create_slides_export - get_func = self._actions_api.get_slides_export + get_func = self._actions_api.get_slides_export_without_preload_content self._export_common(workspace_id, request.to_api(), file_path, create_func, get_func, timeout, retry, max_retry) diff --git a/gooddata-sdk/gooddata_sdk/catalog/filter_by.py b/gooddata-sdk/gooddata_sdk/catalog/filter_by.py index c6961c7c6..c0eae72e4 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/filter_by.py +++ b/gooddata-sdk/gooddata_sdk/catalog/filter_by.py @@ -4,7 +4,7 @@ from typing import Optional import attr -from gooddata_api_client.model.filter_by import FilterBy +from gooddata_api_client.models.filter_by import FilterBy from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/identifier.py b/gooddata-sdk/gooddata_sdk/catalog/identifier.py index 9e7472df2..c059dfbec 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/identifier.py +++ b/gooddata-sdk/gooddata_sdk/catalog/identifier.py @@ -5,22 +5,22 @@ import attr from attrs import define -from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier -from gooddata_api_client.model.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier -from gooddata_api_client.model.declarative_analytical_dashboard_identifier import ( +from gooddata_api_client.models.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.models.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier +from gooddata_api_client.models.declarative_analytical_dashboard_identifier import ( DeclarativeAnalyticalDashboardIdentifier, ) -from gooddata_api_client.model.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier -from gooddata_api_client.model.declarative_notification_channel_identifier import ( +from gooddata_api_client.models.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier +from gooddata_api_client.models.declarative_notification_channel_identifier import ( DeclarativeNotificationChannelIdentifier, ) -from gooddata_api_client.model.declarative_user_group_identifier import DeclarativeUserGroupIdentifier -from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier -from gooddata_api_client.model.fact_identifier import FactIdentifier -from gooddata_api_client.model.grain_identifier import GrainIdentifier -from gooddata_api_client.model.label_identifier import LabelIdentifier -from gooddata_api_client.model.reference_identifier import ReferenceIdentifier -from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier +from gooddata_api_client.models.declarative_user_group_identifier import DeclarativeUserGroupIdentifier +from gooddata_api_client.models.declarative_user_identifier import DeclarativeUserIdentifier +from gooddata_api_client.models.fact_identifier import FactIdentifier +from gooddata_api_client.models.grain_identifier import GrainIdentifier +from gooddata_api_client.models.label_identifier import LabelIdentifier +from gooddata_api_client.models.reference_identifier import ReferenceIdentifier +from gooddata_api_client.models.workspace_identifier import WorkspaceIdentifier from gooddata_sdk.catalog.base import Base, value_in_allowed diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/directive.py b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/directive.py index 8ca43a226..7233e4676 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/directive.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/directive.py @@ -2,8 +2,8 @@ from __future__ import annotations import attr -from gooddata_api_client.model.json_api_csp_directive_in import JsonApiCspDirectiveIn -from gooddata_api_client.model.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes +from gooddata_api_client.models.json_api_csp_directive_in import JsonApiCspDirectiveIn +from gooddata_api_client.models.json_api_csp_directive_in_attributes import JsonApiCspDirectiveInAttributes from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/export_template.py b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/export_template.py index f66734682..438fbd0fb 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/export_template.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/export_template.py @@ -5,8 +5,8 @@ from typing import Optional from attrs import define -from gooddata_api_client.model.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes -from gooddata_api_client.model.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId +from gooddata_api_client.models.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes +from gooddata_api_client.models.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.organization.common.dashboard_slides_template import CatalogDashboardSlidesTemplate diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/identity_provider.py b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/identity_provider.py index 0e850ff3e..64d935894 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/identity_provider.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/identity_provider.py @@ -4,11 +4,11 @@ from typing import Any, Optional import attr -from gooddata_api_client.model.json_api_identity_provider_in import JsonApiIdentityProviderIn -from gooddata_api_client.model.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument -from gooddata_api_client.model.json_api_identity_provider_patch import JsonApiIdentityProviderPatch -from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument +from gooddata_api_client.models.json_api_identity_provider_in import JsonApiIdentityProviderIn +from gooddata_api_client.models.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_identity_provider_patch import JsonApiIdentityProviderPatch +from gooddata_api_client.models.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument from gooddata_sdk.catalog.base import Base from gooddata_sdk.utils import safeget diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/jwk.py b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/jwk.py index bf93c4b71..b69d42043 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/jwk.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/jwk.py @@ -4,10 +4,10 @@ from typing import Optional import attr -from gooddata_api_client.model.json_api_jwk_in import JsonApiJwkIn -from gooddata_api_client.model.json_api_jwk_in_attributes import JsonApiJwkInAttributes -from gooddata_api_client.model.json_api_jwk_in_attributes_content import JsonApiJwkInAttributesContent -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.models.json_api_jwk_in import JsonApiJwkIn +from gooddata_api_client.models.json_api_jwk_in_attributes import JsonApiJwkInAttributes +from gooddata_api_client.models.json_api_jwk_in_attributes_content import JsonApiJwkInAttributesContent +from gooddata_api_client.models.json_api_jwk_in_document import JsonApiJwkInDocument from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/llm_endpoint.py b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/llm_endpoint.py index 24dbd9295..47b81d6c7 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/llm_endpoint.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/llm_endpoint.py @@ -4,12 +4,12 @@ from typing import Any, Optional from attr import define -from gooddata_api_client.model.json_api_llm_endpoint_in import JsonApiLlmEndpointIn -from gooddata_api_client.model.json_api_llm_endpoint_in_attributes import JsonApiLlmEndpointInAttributes -from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument -from gooddata_api_client.model.json_api_llm_endpoint_patch import JsonApiLlmEndpointPatch -from gooddata_api_client.model.json_api_llm_endpoint_patch_attributes import JsonApiLlmEndpointPatchAttributes -from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.models.json_api_llm_endpoint_in import JsonApiLlmEndpointIn +from gooddata_api_client.models.json_api_llm_endpoint_in_attributes import JsonApiLlmEndpointInAttributes +from gooddata_api_client.models.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.models.json_api_llm_endpoint_patch import JsonApiLlmEndpointPatch +from gooddata_api_client.models.json_api_llm_endpoint_patch_attributes import JsonApiLlmEndpointPatchAttributes +from gooddata_api_client.models.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument from gooddata_sdk.catalog.base import Base from gooddata_sdk.utils import safeget diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/organization.py b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/organization.py index 765afc3fc..0d4ad8e60 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/organization.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/organization.py @@ -4,12 +4,12 @@ from typing import Any, Optional import attr -from gooddata_api_client.model.json_api_identity_provider_to_one_linkage import JsonApiIdentityProviderToOneLinkage -from gooddata_api_client.model.json_api_organization_in import JsonApiOrganizationIn -from gooddata_api_client.model.json_api_organization_in_attributes import JsonApiOrganizationInAttributes -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument -from gooddata_api_client.model.json_api_organization_in_relationships import JsonApiOrganizationInRelationships -from gooddata_api_client.model.json_api_organization_in_relationships_identity_provider import ( +from gooddata_api_client.models.json_api_identity_provider_to_one_linkage import JsonApiIdentityProviderToOneLinkage +from gooddata_api_client.models.json_api_organization_in import JsonApiOrganizationIn +from gooddata_api_client.models.json_api_organization_in_attributes import JsonApiOrganizationInAttributes +from gooddata_api_client.models.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.models.json_api_organization_in_relationships import JsonApiOrganizationInRelationships +from gooddata_api_client.models.json_api_organization_in_relationships_identity_provider import ( JsonApiOrganizationInRelationshipsIdentityProvider, ) diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/setting.py b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/setting.py index fa4fc8f23..0976812d8 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/setting.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/setting.py @@ -5,8 +5,10 @@ from typing import Any, Optional import attr -from gooddata_api_client.model.json_api_organization_setting_in import JsonApiOrganizationSettingIn -from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from gooddata_api_client.models.json_api_organization_setting_in import JsonApiOrganizationSettingIn +from gooddata_api_client.models.json_api_organization_setting_in_attributes import ( + JsonApiOrganizationSettingInAttributes, +) from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/layout/export_template.py b/gooddata-sdk/gooddata_sdk/catalog/organization/layout/export_template.py index ae1fb57dd..fb88c3407 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/layout/export_template.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/layout/export_template.py @@ -3,7 +3,7 @@ from typing import Optional from attrs import define -from gooddata_api_client.model.declarative_export_template import DeclarativeExportTemplate +from gooddata_api_client.models.declarative_export_template import DeclarativeExportTemplate from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.organization.common.dashboard_slides_template import CatalogDashboardSlidesTemplate diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/layout/identity_provider.py b/gooddata-sdk/gooddata_sdk/catalog/organization/layout/identity_provider.py index 1a403e7e5..b0c0daa1e 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/layout/identity_provider.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/layout/identity_provider.py @@ -3,7 +3,7 @@ from typing import Optional import attr -from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider +from gooddata_api_client.models.declarative_identity_provider import DeclarativeIdentityProvider from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/layout/notification_channel.py b/gooddata-sdk/gooddata_sdk/catalog/organization/layout/notification_channel.py index a74e8d0b1..d2b589e50 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/layout/notification_channel.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/layout/notification_channel.py @@ -3,8 +3,8 @@ from typing import Optional from attrs import define, field -from gooddata_api_client.model.declarative_notification_channel import DeclarativeNotificationChannel -from gooddata_api_client.model.webhook import Webhook +from gooddata_api_client.models.declarative_notification_channel import DeclarativeNotificationChannel +from gooddata_api_client.models.webhook import Webhook from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/service.py b/gooddata-sdk/gooddata_sdk/catalog/organization/service.py index 134a3cd45..c711800e4 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/service.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/service.py @@ -5,16 +5,16 @@ from typing import Any, Optional from gooddata_api_client.exceptions import NotFoundException -from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates -from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels -from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument -from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument -from gooddata_api_client.model.json_api_export_template_post_optional_id_document import ( +from gooddata_api_client.models.declarative_export_templates import DeclarativeExportTemplates +from gooddata_api_client.models.declarative_notification_channels import DeclarativeNotificationChannels +from gooddata_api_client.models.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.models.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.models.json_api_export_template_post_optional_id_document import ( JsonApiExportTemplatePostOptionalIdDocument, ) -from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument -from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument -from gooddata_api_client.model.switch_identity_provider_request import SwitchIdentityProviderRequest +from gooddata_api_client.models.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from gooddata_api_client.models.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_api_client.models.switch_identity_provider_request import SwitchIdentityProviderRequest from gooddata_sdk import CatalogDeclarativeExportTemplate, CatalogExportTemplate from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase @@ -165,8 +165,7 @@ def list_jwks(self) -> list[CatalogJwk]: list[CatalogJwk]: List of jwks in the current organization. """ - get_jwks = functools.partial(self._entities_api.get_all_entities_jwks, _check_return_type=False) - jwks = load_all_entities(get_jwks) + jwks = load_all_entities(self._entities_api.get_all_entities_jwks) return [CatalogJwk.from_api(jwk) for jwk in jwks.data] def list_organization_settings(self) -> list[CatalogOrganizationSetting]: @@ -176,10 +175,7 @@ def list_organization_settings(self) -> list[CatalogOrganizationSetting]: list[CatalogOrganizationSettings]: List of organization settings in the current organization. """ - get_organization_settings = functools.partial( - self._entities_api.get_all_entities_organization_settings, _check_return_type=False - ) - organization_settings = load_all_entities(get_organization_settings) + organization_settings = load_all_entities(self._entities_api.get_all_entities_organization_settings) return [ CatalogOrganizationSetting.from_api(organization_settings) for organization_settings in organization_settings.data @@ -268,9 +264,7 @@ def list_csp_directives(self) -> list[CatalogCspDirective]: list[CatalogCspDirective]: List of csp directives in the current organization. """ - get_csp_directives = functools.partial( - self._entities_api.get_all_entities_csp_directives, _check_return_type=False - ) + get_csp_directives = functools.partial(self._entities_api.get_all_entities_csp_directives) csp_directives = load_all_entities(get_csp_directives) return [CatalogCspDirective.from_api(csp_directive) for csp_directive in csp_directives.data] @@ -347,11 +341,9 @@ def list_identity_providers(self) -> list[CatalogIdentityProvider]: list[CatalogIdentityProvider]: List of identity providers in the current organization. """ - get_identity_providers = functools.partial( - self._entities_api.get_all_entities_identity_providers, - _check_return_type=False, + identity_providers = load_all_entities_dict( + self._entities_api.get_all_entities_identity_providers, camel_case=False ) - identity_providers = load_all_entities_dict(get_identity_providers, camel_case=False) return [ CatalogIdentityProvider.from_dict(identity_provider, camel_case=False) for identity_provider in identity_providers["data"] @@ -507,11 +499,9 @@ def list_export_templates(self) -> list[CatalogExportTemplate]: list[CatalogExportTemplate]: List of export templates in the current organization. """ - get_export_templates = functools.partial( - self._entities_api.get_all_entities_export_templates, - _check_return_type=False, + export_templates = load_all_entities_dict( + self._entities_api.get_all_entities_export_templates, camel_case=False ) - export_templates = load_all_entities_dict(get_export_templates, camel_case=False) return [ CatalogExportTemplate.from_dict(export_template, camel_case=False) for export_template in export_templates["data"] @@ -527,7 +517,7 @@ def get_llm_endpoint(self, id: str) -> CatalogLlmEndpoint: Returns: CatalogLlmEndpoint: Retrieved LLM endpoint """ - response = self._entities_api.get_entity_llm_endpoints(id, _check_return_type=False) + response = self._entities_api.get_entity_llm_endpoints(id) return CatalogLlmEndpoint.from_api(response.data) def list_llm_endpoints( @@ -565,7 +555,6 @@ def list_llm_endpoints( kwargs["sort"] = sort if meta_include is not None: kwargs["meta_include"] = meta_include - kwargs["_check_return_type"] = False response = self._entities_api.get_all_entities_llm_endpoints(**kwargs) return [CatalogLlmEndpoint.from_api(endpoint) for endpoint in response.data] @@ -606,7 +595,7 @@ def create_llm_endpoint( ) llm_endpoint_document = CatalogLlmEndpointDocument(data=llm_endpoint) response = self._entities_api.create_entity_llm_endpoints( - json_api_llm_endpoint_in_document=llm_endpoint_document.to_api(), _check_return_type=False + json_api_llm_endpoint_in_document=llm_endpoint_document.to_api() ) return CatalogLlmEndpoint.from_api(response.data) @@ -645,9 +634,7 @@ def update_llm_endpoint( llm_model=llm_model, ) llm_endpoint_patch_document = CatalogLlmEndpointPatchDocument(data=llm_endpoint_patch) - response = self._entities_api.patch_entity_llm_endpoints( - id, llm_endpoint_patch_document.to_api(), _check_return_type=False - ) + response = self._entities_api.patch_entity_llm_endpoints(id, llm_endpoint_patch_document.to_api()) return CatalogLlmEndpoint.from_api(response.data) def delete_llm_endpoint(self, id: str) -> None: @@ -657,7 +644,7 @@ def delete_llm_endpoint(self, id: str) -> None: Args: id: LLM endpoint identifier """ - self._entities_api.delete_entity_llm_endpoints(id, _check_return_type=False) + self._entities_api.delete_entity_llm_endpoints(id) # Layout APIs @@ -765,7 +752,7 @@ def switch_active_identity_provider(self, identity_provider_id: str) -> None: """ try: request = SwitchIdentityProviderRequest(idp_id=identity_provider_id) - self._actions_api.switch_active_identity_provider(request, _check_return_type=False) + self._actions_api.switch_active_identity_provider(request) except NotFoundException: raise ValueError( diff --git a/gooddata-sdk/gooddata_sdk/catalog/parameter.py b/gooddata-sdk/gooddata_sdk/catalog/parameter.py index ff02ce4a7..e8175acad 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/parameter.py +++ b/gooddata-sdk/gooddata_sdk/catalog/parameter.py @@ -1,7 +1,7 @@ # (C) 2022 GoodData Corporation import attr -from gooddata_api_client.model.data_source_parameter import DataSourceParameter -from gooddata_api_client.model.parameter import Parameter +from gooddata_api_client.models.data_source_parameter import DataSourceParameter +from gooddata_api_client.models.parameter import Parameter from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/dashboard_assignees.py b/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/dashboard_assignees.py index d3cd217d6..68c41b19d 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/dashboard_assignees.py +++ b/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/dashboard_assignees.py @@ -2,9 +2,9 @@ from typing import Optional import attr -from gooddata_api_client.model.available_assignees import AvailableAssignees -from gooddata_api_client.model.user_assignee import UserAssignee -from gooddata_api_client.model.user_group_assignee import UserGroupAssignee +from gooddata_api_client.models.available_assignees import AvailableAssignees +from gooddata_api_client.models.user_assignee import UserAssignee +from gooddata_api_client.models.user_group_assignee import UserGroupAssignee from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/dashboard_permissions.py b/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/dashboard_permissions.py index 1dac059bc..e7574aa7c 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/dashboard_permissions.py +++ b/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/dashboard_permissions.py @@ -3,11 +3,11 @@ from typing import Optional import attr -from gooddata_api_client.model.dashboard_permissions import DashboardPermissions -from gooddata_api_client.model.granted_permission import GrantedPermission -from gooddata_api_client.model.rule_permission import RulePermission -from gooddata_api_client.model.user_group_permission import UserGroupPermission -from gooddata_api_client.model.user_permission import UserPermission +from gooddata_api_client.models.dashboard_permissions import DashboardPermissions +from gooddata_api_client.models.granted_permission import GrantedPermission +from gooddata_api_client.models.rule_permission import RulePermission +from gooddata_api_client.models.user_group_permission import UserGroupPermission +from gooddata_api_client.models.user_permission import UserPermission from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/manage_dashboard_permissions.py b/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/manage_dashboard_permissions.py index 8b2194280..1465a63d5 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/manage_dashboard_permissions.py +++ b/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/manage_dashboard_permissions.py @@ -1,6 +1,6 @@ # (C) 2023 GoodData Corporation import attr -from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.models.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.identifier import CatalogAssigneeIdentifier diff --git a/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/permission.py b/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/permission.py index c6dcbebef..f69b4be58 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/permission.py +++ b/gooddata-sdk/gooddata_sdk/catalog/permission/declarative_model/permission.py @@ -2,18 +2,20 @@ from __future__ import annotations import attr -from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee import ( +from gooddata_api_client.models.declarative_analytical_dashboard_permission_for_assignee import ( DeclarativeAnalyticalDashboardPermissionForAssignee, ) -from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee_rule import ( +from gooddata_api_client.models.declarative_analytical_dashboard_permission_for_assignee_rule import ( DeclarativeAnalyticalDashboardPermissionForAssigneeRule, ) -from gooddata_api_client.model.declarative_data_source_permission import DeclarativeDataSourcePermission -from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission -from gooddata_api_client.model.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission -from gooddata_api_client.model.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission -from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions -from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment +from gooddata_api_client.models.declarative_data_source_permission import DeclarativeDataSourcePermission +from gooddata_api_client.models.declarative_organization_permission import DeclarativeOrganizationPermission +from gooddata_api_client.models.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission +from gooddata_api_client.models.declarative_workspace_hierarchy_permission import ( + DeclarativeWorkspaceHierarchyPermission, +) +from gooddata_api_client.models.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.models.organization_permission_assignment import OrganizationPermissionAssignment from gooddata_sdk.catalog.base import Base, value_in_allowed from gooddata_sdk.catalog.identifier import CatalogAssigneeIdentifier diff --git a/gooddata-sdk/gooddata_sdk/catalog/permission/service.py b/gooddata-sdk/gooddata_sdk/catalog/permission/service.py index 5c4c4e3d6..106b373e9 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/permission/service.py +++ b/gooddata-sdk/gooddata_sdk/catalog/permission/service.py @@ -64,7 +64,7 @@ def list_available_assignees(self, workspace_id: str, dashboard_id: str) -> Cata Object containing users and user groups """ return CatalogAvailableAssignees.from_dict( - self._actions_api.available_assignees(workspace_id, dashboard_id, _check_return_type=False), + self._actions_api.available_assignees(workspace_id, dashboard_id), camel_case=False, ) @@ -81,7 +81,7 @@ def list_dashboard_permissions(self, workspace_id: str, dashboard_id: str) -> Ca Object containing users and user groups and granted dashboard permissions """ return CatalogDashboardPermissions.from_dict( - self._actions_api.dashboard_permissions(workspace_id, dashboard_id, _check_return_type=False), + self._actions_api.dashboard_permissions(workspace_id, dashboard_id), camel_case=False, ) @@ -107,10 +107,7 @@ def manage_dashboard_permissions( None """ self._actions_api.manage_dashboard_permissions( - workspace_id, - dashboard_id, - [permission.to_api() for permission in permissions_for_assignee], - _check_return_type=False, + workspace_id, dashboard_id, [permission.to_api() for permission in permissions_for_assignee] ) def get_declarative_organization_permissions(self) -> list[CatalogDeclarativeOrganizationPermission]: @@ -159,4 +156,4 @@ def manage_organization_permissions( None """ permissions = [permission.to_api() for permission in organization_permission_assignments] - self._actions_api.manage_organization_permissions(permissions, _check_return_type=False) + self._actions_api.manage_organization_permissions(permissions) diff --git a/gooddata-sdk/gooddata_sdk/catalog/rule.py b/gooddata-sdk/gooddata_sdk/catalog/rule.py index 086b8fa5f..e793949b6 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/rule.py +++ b/gooddata-sdk/gooddata_sdk/catalog/rule.py @@ -4,7 +4,7 @@ import builtins import attr -from gooddata_api_client.model.assignee_rule import AssigneeRule +from gooddata_api_client.models.assignee_rule import AssigneeRule from gooddata_sdk.catalog.base import Base, value_in_allowed diff --git a/gooddata-sdk/gooddata_sdk/catalog/setting.py b/gooddata-sdk/gooddata_sdk/catalog/setting.py index eda818e14..54995af5e 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/setting.py +++ b/gooddata-sdk/gooddata_sdk/catalog/setting.py @@ -5,8 +5,8 @@ from typing import Any, Optional import attr -from gooddata_api_client.model.declarative_custom_application_setting import DeclarativeCustomApplicationSetting -from gooddata_api_client.model.declarative_setting import DeclarativeSetting +from gooddata_api_client.models.declarative_custom_application_setting import DeclarativeCustomApplicationSetting +from gooddata_api_client.models.declarative_setting import DeclarativeSetting from gooddata_sdk.catalog.base import Base, value_in_allowed diff --git a/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user.py b/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user.py index ebabafd0b..c670dd33f 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user.py +++ b/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user.py @@ -5,9 +5,9 @@ from typing import Optional import attr -from gooddata_api_client.model.declarative_user import DeclarativeUser -from gooddata_api_client.model.declarative_user_permission import DeclarativeUserPermission -from gooddata_api_client.model.declarative_users import DeclarativeUsers +from gooddata_api_client.models.declarative_user import DeclarativeUser +from gooddata_api_client.models.declarative_user_permission import DeclarativeUserPermission +from gooddata_api_client.models.declarative_users import DeclarativeUsers from gooddata_sdk.catalog.base import Base, value_in_allowed from gooddata_sdk.catalog.identifier import CatalogAssigneeIdentifier, CatalogDeclarativeUserGroupIdentifier diff --git a/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user_and_user_groups.py b/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user_and_user_groups.py index 7222b425e..41f9dc9aa 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user_and_user_groups.py +++ b/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user_and_user_groups.py @@ -4,7 +4,7 @@ from pathlib import Path import attr -from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups +from gooddata_api_client.models.declarative_users_user_groups import DeclarativeUsersUserGroups from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.user.declarative_model.user import CatalogDeclarativeUser, CatalogDeclarativeUsers diff --git a/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user_group.py b/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user_group.py index da514ca8d..241f1537d 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user_group.py +++ b/gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user_group.py @@ -5,9 +5,9 @@ from typing import Optional import attr -from gooddata_api_client.model.declarative_user_group import DeclarativeUserGroup -from gooddata_api_client.model.declarative_user_group_permission import DeclarativeUserGroupPermission -from gooddata_api_client.model.declarative_user_groups import DeclarativeUserGroups +from gooddata_api_client.models.declarative_user_group import DeclarativeUserGroup +from gooddata_api_client.models.declarative_user_group_permission import DeclarativeUserGroupPermission +from gooddata_api_client.models.declarative_user_groups import DeclarativeUserGroups from gooddata_sdk.catalog.base import Base, value_in_allowed from gooddata_sdk.catalog.identifier import CatalogAssigneeIdentifier, CatalogDeclarativeUserGroupIdentifier diff --git a/gooddata-sdk/gooddata_sdk/catalog/user/entity_model/user.py b/gooddata-sdk/gooddata_sdk/catalog/user/entity_model/user.py index cd35fa770..875e3f64c 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/user/entity_model/user.py +++ b/gooddata-sdk/gooddata_sdk/catalog/user/entity_model/user.py @@ -4,8 +4,8 @@ from typing import Optional import attr -from gooddata_api_client.model.json_api_user_in import JsonApiUserIn -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.models.json_api_user_in import JsonApiUserIn +from gooddata_api_client.models.json_api_user_in_document import JsonApiUserInDocument from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.user.entity_model.user_group import CatalogUserGroup diff --git a/gooddata-sdk/gooddata_sdk/catalog/user/entity_model/user_group.py b/gooddata-sdk/gooddata_sdk/catalog/user/entity_model/user_group.py index 03dd40e03..098ad343d 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/user/entity_model/user_group.py +++ b/gooddata-sdk/gooddata_sdk/catalog/user/entity_model/user_group.py @@ -4,8 +4,8 @@ from typing import Optional import attr -from gooddata_api_client.model.json_api_user_group_in import JsonApiUserGroupIn -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.models.json_api_user_group_in import JsonApiUserGroupIn +from gooddata_api_client.models.json_api_user_group_in_document import JsonApiUserGroupInDocument from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/user/management_model/management.py b/gooddata-sdk/gooddata_sdk/catalog/user/management_model/management.py index 24ff3f6b1..547c025e0 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/user/management_model/management.py +++ b/gooddata-sdk/gooddata_sdk/catalog/user/management_model/management.py @@ -3,12 +3,12 @@ from typing import Optional import attrs -from gooddata_api_client.model.permissions_assignment import PermissionsAssignment -from gooddata_api_client.model.user_management_data_source_permission_assignment import ( +from gooddata_api_client.models.permissions_assignment import PermissionsAssignment +from gooddata_api_client.models.user_management_data_source_permission_assignment import ( UserManagementDataSourcePermissionAssignment, ) -from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments -from gooddata_api_client.model.user_management_workspace_permission_assignment import ( +from gooddata_api_client.models.user_management_permission_assignments import UserManagementPermissionAssignments +from gooddata_api_client.models.user_management_workspace_permission_assignment import ( UserManagementWorkspacePermissionAssignment, ) diff --git a/gooddata-sdk/gooddata_sdk/catalog/user/service.py b/gooddata-sdk/gooddata_sdk/catalog/user/service.py index 23a71452e..fde2c8a9f 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/user/service.py +++ b/gooddata-sdk/gooddata_sdk/catalog/user/service.py @@ -5,8 +5,8 @@ from pathlib import Path from gooddata_api_client.exceptions import NotFoundException -from gooddata_api_client.model.json_api_api_token_in import JsonApiApiTokenIn -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +from gooddata_api_client.models.json_api_api_token_in import JsonApiApiTokenIn +from gooddata_api_client.models.json_api_api_token_in_document import JsonApiApiTokenInDocument from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase from gooddata_sdk.catalog.user.declarative_model.user import CatalogDeclarativeUsers @@ -85,7 +85,6 @@ def list_users(self) -> list[CatalogUser]: get_users = functools.partial( self._entities_api.get_all_entities_users, include=["userGroups"], - _check_return_type=False, ) users = load_all_entities_dict(get_users, camel_case=False) return [CatalogUser.from_dict(v, camel_case=False) for v in users["data"]] @@ -153,7 +152,6 @@ def list_user_groups(self) -> list[CatalogUserGroup]: get_user_groups = functools.partial( self._entities_api.get_all_entities_user_groups, include=["userGroups"], - _check_return_type=False, ) user_groups = load_all_entities(get_user_groups) return [CatalogUserGroup.from_api(v) for v in user_groups.data] @@ -455,19 +453,18 @@ def list_user_api_tokens(self, user_id: str) -> list[CatalogApiToken]: get_api_tokens = functools.partial( self._entities_api.get_all_entities_api_tokens, user_id, - _check_return_type=False, ) api_tokens = load_all_entities(get_api_tokens) return [CatalogApiToken(id=v["id"]) for v in api_tokens.data] def create_user_api_token(self, user_id: str, api_token_id: str) -> CatalogApiToken: document = JsonApiApiTokenInDocument(data=JsonApiApiTokenIn(id=api_token_id, type="apiToken")) - api_token = self._entities_api.create_entity_api_tokens(user_id, document, _check_return_type=False) + api_token = self._entities_api.create_entity_api_tokens(user_id, document) v = api_token.data return CatalogApiToken(id=v["id"], bearer_token=v.get("attributes", {}).get("bearerToken")) def get_user_api_token(self, user_id: str, api_token_id: str) -> CatalogApiToken: - api_token = self._entities_api.get_entity_api_tokens(user_id, api_token_id, _check_return_type=False) + api_token = self._entities_api.get_entity_api_tokens(user_id, api_token_id) v = api_token.data return CatalogApiToken(id=v["id"]) diff --git a/gooddata-sdk/gooddata_sdk/catalog/validate_by_item.py b/gooddata-sdk/gooddata_sdk/catalog/validate_by_item.py index defc7f3cd..d3e7fd74f 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/validate_by_item.py +++ b/gooddata-sdk/gooddata_sdk/catalog/validate_by_item.py @@ -4,7 +4,7 @@ import builtins import attr -from gooddata_api_client.model.validate_by_item import ValidateByItem +from gooddata_api_client.models.validate_by_item import ValidateByItem from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/content_service.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/content_service.py index 4acc65c7f..7888fdd36 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/content_service.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/content_service.py @@ -7,7 +7,7 @@ from typing import Literal, Optional, Union import gooddata_api_client.models as afm_models -from gooddata_api_client.model.elements_request import ElementsRequest +from gooddata_api_client.models.elements_request import ElementsRequest from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase from gooddata_sdk.catalog.data_source.validation.data_source import DataSourceValidator @@ -80,19 +80,15 @@ def get_full_catalog(self, workspace_id: str, inject_valid_objects_func: bool = self._entities_api.get_all_entities_datasets, workspace_id, include=["attributes", "facts", "aggregatedFacts"], - _check_return_type=False, ) get_attributes = functools.partial( self._entities_api.get_all_entities_attributes, workspace_id, include=["labels", "datasets"], - _check_return_type=False, ) - get_metrics = functools.partial( - self._entities_api.get_all_entities_metrics, workspace_id, _check_return_type=False - ) + get_metrics = functools.partial(self._entities_api.get_all_entities_metrics, workspace_id) attributes = load_all_entities(get_attributes) datasets = load_all_entities(get_datasets) @@ -127,10 +123,7 @@ def get_attributes_catalog( if not set(include).issubset(available_includes): raise ValueError(f"Invalid include parameter. Available values: {available_includes}, got: {include}") get_attributes = functools.partial( - self._entities_api.get_all_entities_attributes, - workspace_id, - include=include, - _check_return_type=False, + self._entities_api.get_all_entities_attributes, workspace_id, include=include ) if rsql_filter is not None: get_attributes = functools.partial(get_attributes, filter=rsql_filter) @@ -149,11 +142,7 @@ def get_labels_catalog(self, workspace_id: str) -> list[CatalogLabel]: list[CatalogLabel]: List of all labels in a given workspace. """ - get_labels = functools.partial( - self._entities_api.get_all_entities_labels, - workspace_id, - _check_return_type=False, - ) + get_labels = functools.partial(self._entities_api.get_all_entities_labels, workspace_id) labels = load_all_entities(get_labels) catalog_labels = [CatalogLabel.from_api(label) for label in labels.data] return catalog_labels @@ -169,9 +158,7 @@ def get_metrics_catalog(self, workspace_id: str) -> list[CatalogMetric]: list[CatalogMetric]: List of all metrics in a given workspace. """ - get_metrics = functools.partial( - self._entities_api.get_all_entities_metrics, workspace_id, _check_return_type=False - ) + get_metrics = functools.partial(self._entities_api.get_all_entities_metrics, workspace_id) metrics = load_all_entities(get_metrics) catalog_metrics = [CatalogMetric.from_api(metric) for metric in metrics.data] return catalog_metrics @@ -187,7 +174,7 @@ def get_facts_catalog(self, workspace_id: str) -> list[CatalogFact]: list[CatalogFact]: List of all facts in a given workspace. """ - get_facts = functools.partial(self._entities_api.get_all_entities_facts, workspace_id, _check_return_type=False) + get_facts = functools.partial(self._entities_api.get_all_entities_facts, workspace_id) facts = load_all_entities(get_facts) catalog_facts = [CatalogFact.from_api(fact) for fact in facts.data] return catalog_facts @@ -203,9 +190,7 @@ def get_aggregated_facts_catalog(self, workspace_id: str) -> list[CatalogAggrega list[CatalogAggregatedFact]: List of all aggregated facts in a given workspace. """ - get_agg_facts = functools.partial( - self._entities_api.get_all_entities_aggregated_facts, workspace_id, _check_return_type=False - ) + get_agg_facts = functools.partial(self._entities_api.get_all_entities_aggregated_facts, workspace_id) agg_facts = load_all_entities(get_agg_facts) catalog_agg_facts = [CatalogAggregatedFact.from_api(agg_fact) for agg_fact in agg_facts.data] return catalog_agg_facts @@ -680,7 +665,5 @@ def get_label_elements( paging_params["limit"] = limit # TODO - fix return type of Paging.next in Backend + add support for this API to SDK - values = self._actions_api.compute_label_elements_post( - workspace_id, request, _check_return_type=False, **paging_params - ) + values = self._actions_api.compute_label_elements_post(workspace_id, request, **paging_params) return [v["title"] for v in values["elements"]] diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/analytics_model.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/analytics_model.py index ffd7606a1..25c16cc26 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/analytics_model.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/analytics_model.py @@ -7,15 +7,17 @@ import attr from attrs import define from cattrs import global_converter, structure -from gooddata_api_client.model.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard -from gooddata_api_client.model.declarative_analytical_dashboard_extension import DeclarativeAnalyticalDashboardExtension -from gooddata_api_client.model.declarative_analytics import DeclarativeAnalytics -from gooddata_api_client.model.declarative_analytics_layer import DeclarativeAnalyticsLayer -from gooddata_api_client.model.declarative_attribute_hierarchy import DeclarativeAttributeHierarchy -from gooddata_api_client.model.declarative_dashboard_plugin import DeclarativeDashboardPlugin -from gooddata_api_client.model.declarative_filter_context import DeclarativeFilterContext -from gooddata_api_client.model.declarative_metric import DeclarativeMetric -from gooddata_api_client.model.declarative_visualization_object import DeclarativeVisualizationObject +from gooddata_api_client.models.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard +from gooddata_api_client.models.declarative_analytical_dashboard_extension import ( + DeclarativeAnalyticalDashboardExtension, +) +from gooddata_api_client.models.declarative_analytics import DeclarativeAnalytics +from gooddata_api_client.models.declarative_analytics_layer import DeclarativeAnalyticsLayer +from gooddata_api_client.models.declarative_attribute_hierarchy import DeclarativeAttributeHierarchy +from gooddata_api_client.models.declarative_dashboard_plugin import DeclarativeDashboardPlugin +from gooddata_api_client.models.declarative_filter_context import DeclarativeFilterContext +from gooddata_api_client.models.declarative_metric import DeclarativeMetric +from gooddata_api_client.models.declarative_visualization_object import DeclarativeVisualizationObject from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.permission.declarative_model.permission import ( diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/export_definition.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/export_definition.py index 2baf7862a..0d6eca43c 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/export_definition.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/export_definition.py @@ -2,8 +2,8 @@ from typing import Optional from attrs import define -from gooddata_api_client.model.declarative_export_definition import DeclarativeExportDefinition -from gooddata_api_client.model.declarative_export_definition_request_payload import ( +from gooddata_api_client.models.declarative_export_definition import DeclarativeExportDefinition +from gooddata_api_client.models.declarative_export_definition_request_payload import ( DeclarativeExportDefinitionRequestPayload, ) diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/automation.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/automation.py index c837cf10b..065149539 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/automation.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/automation.py @@ -3,10 +3,10 @@ from typing import Any, Optional from attrs import define, field -from gooddata_api_client.model.automation_schedule import AutomationSchedule -from gooddata_api_client.model.automation_tabular_export import AutomationTabularExport -from gooddata_api_client.model.automation_visual_export import AutomationVisualExport -from gooddata_api_client.model.declarative_automation import DeclarativeAutomation +from gooddata_api_client.models.automation_schedule import AutomationSchedule +from gooddata_api_client.models.automation_tabular_export import AutomationTabularExport +from gooddata_api_client.models.automation_visual_export import AutomationVisualExport +from gooddata_api_client.models.declarative_automation import DeclarativeAutomation from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.export.request import ( diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/data_filter_references.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/data_filter_references.py index ab4a3678f..785617eeb 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/data_filter_references.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/data_filter_references.py @@ -1,6 +1,6 @@ # (C) 2023 GoodData Corporation import attr -from gooddata_api_client.model.declarative_workspace_data_filter_references import ( +from gooddata_api_client.models.declarative_workspace_data_filter_references import ( DeclarativeWorkspaceDataFilterReferences, ) diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/dataset/dataset.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/dataset/dataset.py index deda48af1..3822b4430 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/dataset/dataset.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/dataset/dataset.py @@ -6,17 +6,17 @@ import attr import attrs -from gooddata_api_client.model.data_source_table_identifier import DataSourceTableIdentifier -from gooddata_api_client.model.declarative_aggregated_fact import DeclarativeAggregatedFact -from gooddata_api_client.model.declarative_attribute import DeclarativeAttribute -from gooddata_api_client.model.declarative_dataset import DeclarativeDataset -from gooddata_api_client.model.declarative_dataset_sql import DeclarativeDatasetSql -from gooddata_api_client.model.declarative_fact import DeclarativeFact -from gooddata_api_client.model.declarative_label import DeclarativeLabel -from gooddata_api_client.model.declarative_reference import DeclarativeReference -from gooddata_api_client.model.declarative_reference_source import DeclarativeReferenceSource -from gooddata_api_client.model.declarative_source_fact_reference import DeclarativeSourceFactReference -from gooddata_api_client.model.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn +from gooddata_api_client.models.data_source_table_identifier import DataSourceTableIdentifier +from gooddata_api_client.models.declarative_aggregated_fact import DeclarativeAggregatedFact +from gooddata_api_client.models.declarative_attribute import DeclarativeAttribute +from gooddata_api_client.models.declarative_dataset import DeclarativeDataset +from gooddata_api_client.models.declarative_dataset_sql import DeclarativeDatasetSql +from gooddata_api_client.models.declarative_fact import DeclarativeFact +from gooddata_api_client.models.declarative_label import DeclarativeLabel +from gooddata_api_client.models.declarative_reference import DeclarativeReference +from gooddata_api_client.models.declarative_reference_source import DeclarativeReferenceSource +from gooddata_api_client.models.declarative_source_fact_reference import DeclarativeSourceFactReference +from gooddata_api_client.models.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.identifier import ( diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/dataset_extensions/dataset_extension.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/dataset_extensions/dataset_extension.py index d33f1590c..19de8d1ab 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/dataset_extensions/dataset_extension.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/dataset_extensions/dataset_extension.py @@ -2,7 +2,7 @@ from pathlib import Path import attr -from gooddata_api_client.model.declarative_dataset_extension import DeclarativeDatasetExtension +from gooddata_api_client.models.declarative_dataset_extension import DeclarativeDatasetExtension from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.workspace.declarative_model.workspace.logical_model.data_filter_references import ( diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/date_dataset/date_dataset.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/date_dataset/date_dataset.py index 7a2270581..c8b0d2564 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/date_dataset/date_dataset.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/date_dataset/date_dataset.py @@ -5,8 +5,8 @@ from typing import Optional import attr -from gooddata_api_client.model.declarative_date_dataset import DeclarativeDateDataset -from gooddata_api_client.model.granularities_formatting import GranularitiesFormatting +from gooddata_api_client.models.declarative_date_dataset import DeclarativeDateDataset +from gooddata_api_client.models.granularities_formatting import GranularitiesFormatting from gooddata_sdk.catalog.base import Base from gooddata_sdk.utils import read_layout_from_file, write_layout_to_file diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/ldm.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/ldm.py index 2436c9939..ee928cd44 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/ldm.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/ldm.py @@ -5,8 +5,8 @@ from typing import Optional import attr -from gooddata_api_client.model.declarative_ldm import DeclarativeLdm -from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.models.declarative_ldm import DeclarativeLdm +from gooddata_api_client.models.declarative_model import DeclarativeModel from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.workspace.declarative_model.workspace.logical_model.dataset.dataset import ( diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/workspace.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/workspace.py index d131fa8fb..c71e325d3 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/workspace.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/workspace.py @@ -6,15 +6,15 @@ from typing import Any, Optional import attr -from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView -from gooddata_api_client.model.declarative_user_data_filter import DeclarativeUserDataFilter -from gooddata_api_client.model.declarative_user_data_filters import DeclarativeUserDataFilters -from gooddata_api_client.model.declarative_workspace import DeclarativeWorkspace -from gooddata_api_client.model.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter -from gooddata_api_client.model.declarative_workspace_data_filter_setting import DeclarativeWorkspaceDataFilterSetting -from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters -from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_filter_view import DeclarativeFilterView +from gooddata_api_client.models.declarative_user_data_filter import DeclarativeUserDataFilter +from gooddata_api_client.models.declarative_user_data_filters import DeclarativeUserDataFilters +from gooddata_api_client.models.declarative_workspace import DeclarativeWorkspace +from gooddata_api_client.models.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter +from gooddata_api_client.models.declarative_workspace_data_filter_setting import DeclarativeWorkspaceDataFilterSetting +from gooddata_api_client.models.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.models.declarative_workspace_model import DeclarativeWorkspaceModel +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.identifier import ( diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/dataset.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/dataset.py index 41754b96c..9eeb423de 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/dataset.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/dataset.py @@ -5,11 +5,11 @@ import attr import attrs -from gooddata_api_client.model.json_api_aggregated_fact_out import JsonApiAggregatedFactOut -from gooddata_api_client.model.json_api_attribute_out import JsonApiAttributeOut -from gooddata_api_client.model.json_api_dataset_out import JsonApiDatasetOut -from gooddata_api_client.model.json_api_fact_out import JsonApiFactOut -from gooddata_api_client.model.json_api_label_out import JsonApiLabelOut +from gooddata_api_client.models.json_api_aggregated_fact_out import JsonApiAggregatedFactOut +from gooddata_api_client.models.json_api_attribute_out import JsonApiAttributeOut +from gooddata_api_client.models.json_api_dataset_out import JsonApiDatasetOut +from gooddata_api_client.models.json_api_fact_out import JsonApiFactOut +from gooddata_api_client.models.json_api_label_out import JsonApiLabelOut from gooddata_sdk.catalog.entity import AttrCatalogEntity from gooddata_sdk.catalog.types import ValidObjects diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/metric.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/metric.py index 92301bae9..cecbec561 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/metric.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/metric.py @@ -4,7 +4,7 @@ from typing import Any, Optional import attr -from gooddata_api_client.model.json_api_metric_out import JsonApiMetricOut +from gooddata_api_client.models.json_api_metric_out import JsonApiMetricOut from gooddata_sdk.catalog.entity import AttrCatalogEntity from gooddata_sdk.compute.model.metric import Metric, SimpleMetric diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/workspace_setting.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/workspace_setting.py index 4e7f55f48..a0c04daed 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/workspace_setting.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/workspace_setting.py @@ -5,12 +5,14 @@ from typing import Any, Union import attr -from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes -from gooddata_api_client.model.json_api_workspace_setting_in import JsonApiWorkspaceSettingIn -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id import JsonApiWorkspaceSettingPostOptionalId -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import ( +from gooddata_api_client.models.json_api_organization_setting_in_attributes import ( + JsonApiOrganizationSettingInAttributes, +) +from gooddata_api_client.models.json_api_workspace_setting_in import JsonApiWorkspaceSettingIn +from gooddata_api_client.models.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.models.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id import JsonApiWorkspaceSettingPostOptionalId +from gooddata_api_client.models.json_api_workspace_setting_post_optional_id_document import ( JsonApiWorkspaceSettingPostOptionalIdDocument, ) diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/filter_view.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/filter_view.py index 87364998e..490f55add 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/filter_view.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/filter_view.py @@ -4,10 +4,10 @@ from typing import Any, Optional, Union import attr -from gooddata_api_client.model.json_api_filter_view_in import JsonApiFilterViewIn -from gooddata_api_client.model.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships +from gooddata_api_client.models.json_api_filter_view_in import JsonApiFilterViewIn +from gooddata_api_client.models.json_api_filter_view_in_attributes import JsonApiFilterViewInAttributes +from gooddata_api_client.models.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.models.json_api_filter_view_in_relationships import JsonApiFilterViewInRelationships from gooddata_sdk.catalog.base import Base from gooddata_sdk.catalog.identifier import CatalogDeclarativeAnalyticalDashboardIdentifier, CatalogUserIdentifier diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/graph_objects/graph.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/graph_objects/graph.py index 936bffa2c..78b0001db 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/graph_objects/graph.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/graph_objects/graph.py @@ -5,11 +5,11 @@ from typing import Optional import attr -from gooddata_api_client.model.dependent_entities_graph import DependentEntitiesGraph -from gooddata_api_client.model.dependent_entities_node import DependentEntitiesNode -from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse -from gooddata_api_client.model.entity_identifier import EntityIdentifier +from gooddata_api_client.models.dependent_entities_graph import DependentEntitiesGraph +from gooddata_api_client.models.dependent_entities_node import DependentEntitiesNode +from gooddata_api_client.models.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.models.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.models.entity_identifier import EntityIdentifier from gooddata_sdk.catalog.base import Base diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/user_data_filter.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/user_data_filter.py index 428d55754..2cac8b7a3 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/user_data_filter.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/user_data_filter.py @@ -4,12 +4,12 @@ from typing import Any, Optional, Union import attr -from gooddata_api_client.model.json_api_user_data_filter_in import JsonApiUserDataFilterIn -from gooddata_api_client.model.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument -from gooddata_api_client.model.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id import JsonApiUserDataFilterPostOptionalId -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import ( +from gooddata_api_client.models.json_api_user_data_filter_in import JsonApiUserDataFilterIn +from gooddata_api_client.models.json_api_user_data_filter_in_attributes import JsonApiUserDataFilterInAttributes +from gooddata_api_client.models.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.models.json_api_user_data_filter_in_relationships import JsonApiUserDataFilterInRelationships +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id import JsonApiUserDataFilterPostOptionalId +from gooddata_api_client.models.json_api_user_data_filter_post_optional_id_document import ( JsonApiUserDataFilterPostOptionalIdDocument, ) diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/workspace.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/workspace.py index b3e06f9f4..035d1627f 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/workspace.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/workspace.py @@ -4,14 +4,14 @@ from typing import Any, Optional import attr -from gooddata_api_client.model.json_api_workspace_automation_out_relationships_workspace import ( +from gooddata_api_client.models.json_api_workspace_automation_out_relationships_workspace import ( JsonApiWorkspaceAutomationOutRelationshipsWorkspace, ) -from gooddata_api_client.model.json_api_workspace_in import JsonApiWorkspaceIn -from gooddata_api_client.model.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument -from gooddata_api_client.model.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships -from gooddata_api_client.model.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage +from gooddata_api_client.models.json_api_workspace_in import JsonApiWorkspaceIn +from gooddata_api_client.models.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes +from gooddata_api_client.models.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.models.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships +from gooddata_api_client.models.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage from gooddata_sdk.catalog.base import Base from gooddata_sdk.utils import safeget diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/service.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/service.py index 79b8efc07..39aed6c09 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/service.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/service.py @@ -15,7 +15,7 @@ import attrs from gooddata_api_client.api.translations_api import LocaleRequest from gooddata_api_client.exceptions import NotFoundException -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.models.resolve_settings_request import ResolveSettingsRequest from gooddata_sdk import CatalogDeclarativeAutomation from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase @@ -140,7 +140,6 @@ def list_workspaces(self) -> list[CatalogWorkspace]: get_workspaces = functools.partial( self._entities_api.get_all_entities_workspaces, include=["workspaces"], - _check_return_type=False, ) workspaces = load_all_entities(get_workspaces) return [CatalogWorkspace.from_api(w) for w in workspaces.data] @@ -185,7 +184,6 @@ def list_workspace_settings(self, workspace_id: str) -> list[CatalogWorkspaceSet get_workspace_settings = functools.partial( self._entities_api.get_all_entities_workspace_settings, workspace_id, - _check_return_type=False, ) workspace_settings = load_all_entities(get_workspace_settings).data return [CatalogWorkspaceSetting.from_api(ws) for ws in workspace_settings] @@ -202,11 +200,7 @@ def resolve_all_workspace_settings(self, workspace_id: str) -> dict: # note: in case some settings were recently added and the API client was not regenerated it can fail on # invalid value when validating allowed types on the client side before request is sent to the server resolved_workspace_settings = [ - setting.to_dict() - for setting in self._client.actions_api.workspace_resolve_all_settings( - workspace_id, - _check_return_type=False, - ) + setting.to_dict() for setting in self._client.actions_api.workspace_resolve_all_settings(workspace_id) ] return {setting["type"]: setting for setting in resolved_workspace_settings} @@ -223,9 +217,7 @@ def resolve_workspace_settings(self, workspace_id: str, settings: list) -> dict: resolved_workspace_settings = [ setting.to_dict() for setting in self._client.actions_api.workspace_resolve_settings( - workspace_id, - ResolveSettingsRequest(settings=settings), - _check_return_type=False, + workspace_id, ResolveSettingsRequest(settings=settings) ) ] return {setting["type"]: setting for setting in resolved_workspace_settings} @@ -1115,10 +1107,7 @@ def list_user_data_filters(self, workspace_id: str) -> list[CatalogUserDataFilte List of user data filter entities. """ get_user_data_filters = functools.partial( - self._entities_api.get_all_entities_user_data_filters, - workspace_id, - _check_return_type=False, - include=["ALL"], + self._entities_api.get_all_entities_user_data_filters, workspace_id, include=["ALL"] ) user_data_filters = load_all_entities_dict(get_user_data_filters, camel_case=False) return [CatalogUserDataFilter.from_dict(v, camel_case=False) for v in user_data_filters["data"]] @@ -1169,10 +1158,7 @@ def get_user_data_filter(self, workspace_id: str, user_data_filter_id: str) -> C UserDataFilter entity object. """ user_data_filter_dict = self._entities_api.get_entity_user_data_filters( - workspace_id=workspace_id, - object_id=user_data_filter_id, - include=["ALL"], - _check_return_type=False, + workspace_id=workspace_id, object_id=user_data_filter_id, include=["ALL"] ).data return CatalogUserDataFilter.from_dict(user_data_filter_dict, camel_case=True) @@ -1317,10 +1303,7 @@ def list_filters_views(self, workspace_id: str) -> list[CatalogFilterView]: List of filter view entities. """ get_filter_views = functools.partial( - self._entities_api.get_all_entities_filter_views, - workspace_id, - _check_return_type=False, - include=["ALL"], + self._entities_api.get_all_entities_filter_views, workspace_id, include=["ALL"] ) filter_views = load_all_entities_dict(get_filter_views, camel_case=False) return [CatalogFilterView.from_dict(v, camel_case=False) for v in filter_views["data"]] @@ -1371,10 +1354,7 @@ def get_filter_view(self, workspace_id: str, filter_view_id: str) -> CatalogFilt FilterView entity object. """ filter_view_dict = self._entities_api.get_entity_filter_views( - workspace_id=workspace_id, - object_id=filter_view_id, - include=["ALL"], - _check_return_type=False, + workspace_id=workspace_id, object_id=filter_view_id, include=["ALL"] ).data return CatalogFilterView.from_dict(filter_view_dict, camel_case=True) diff --git a/gooddata-sdk/gooddata_sdk/client.py b/gooddata-sdk/gooddata_sdk/client.py index cfa0ed848..e5df1fc0c 100644 --- a/gooddata-sdk/gooddata_sdk/client.py +++ b/gooddata-sdk/gooddata_sdk/client.py @@ -7,7 +7,7 @@ import gooddata_api_client as api_client import requests -from gooddata_api_client import apis +from gooddata_api_client import api from gooddata_sdk import __version__ from gooddata_sdk.utils import HttpMethod @@ -58,10 +58,10 @@ def __init__( self._api_client.default_headers[header_name] = header_value self._api_client.user_agent = user_agent - self._entities_api = apis.EntitiesApi(self._api_client) - self._layout_api = apis.LayoutApi(self._api_client) - self._actions_api = apis.ActionsApi(self._api_client) - self._user_management_api = apis.UserManagementApi(self._api_client) + self._entities_api = api.EntitiesApi(self._api_client) + self._layout_api = api.LayoutApi(self._api_client) + self._actions_api = api.ActionsApi(self._api_client) + self._user_management_api = api.UserManagementApi(self._api_client) self._executions_cancellable = executions_cancellable def _do_post_request( @@ -130,19 +130,19 @@ def custom_headers(self) -> dict[str, str]: return self._custom_headers @property - def entities_api(self) -> apis.EntitiesApi: + def entities_api(self) -> api.EntitiesApi: return self._entities_api @property - def layout_api(self) -> apis.LayoutApi: + def layout_api(self) -> api.LayoutApi: return self._layout_api @property - def actions_api(self) -> apis.ActionsApi: + def actions_api(self) -> api.ActionsApi: return self._actions_api @property - def user_management_api(self) -> apis.UserManagementApi: + def user_management_api(self) -> api.UserManagementApi: return self._user_management_api @property diff --git a/gooddata-sdk/gooddata_sdk/compute/model/base.py b/gooddata-sdk/gooddata_sdk/compute/model/base.py index 753897313..e0cde52a0 100644 --- a/gooddata-sdk/gooddata_sdk/compute/model/base.py +++ b/gooddata-sdk/gooddata_sdk/compute/model/base.py @@ -4,7 +4,7 @@ from typing import Optional, Union import gooddata_api_client.models as afm_models -from gooddata_api_client.model_utils import OpenApiModel +from pydantic import BaseModel class ObjId: @@ -25,6 +25,11 @@ def as_afm_id(self) -> afm_models.AfmObjectIdentifier: identifier=afm_models.AfmObjectIdentifierIdentifier(id=self._id, type=self._type) ) + def as_afm_id_core(self) -> afm_models.AfmObjectIdentifierCore: + return afm_models.AfmObjectIdentifierCore( + identifier=afm_models.AfmObjectIdentifierCoreIdentifier(id=self._id, type=self._type) + ) + def as_afm_id_label(self) -> afm_models.AfmObjectIdentifierLabel: return afm_models.AfmObjectIdentifierLabel( identifier=afm_models.AfmObjectIdentifierLabelIdentifier(id=self._id) @@ -43,7 +48,6 @@ def as_afm_id_attribute(self) -> afm_models.AfmObjectIdentifierAttribute: def as_identifier(self) -> afm_models.AfmIdentifier: return afm_models.AfmIdentifier( identifier=afm_models.AfmObjectIdentifierIdentifier(id=self._id, type=self._type), - _check_type=False, ) def __eq__(self, other: object) -> bool: @@ -66,7 +70,7 @@ class ExecModelEntity: def __init__(self) -> None: pass - def as_api_model(self) -> OpenApiModel: + def as_api_model(self) -> BaseModel: raise NotImplementedError() @@ -83,7 +87,7 @@ def apply_on_result(self) -> Union[bool, None]: def is_noop(self) -> bool: raise NotImplementedError() - def as_api_model(self) -> OpenApiModel: + def as_api_model(self) -> BaseModel: raise NotImplementedError() def description(self, labels: dict[str, str], format_locale: Optional[str] = None) -> str: diff --git a/gooddata-sdk/gooddata_sdk/compute/model/execution.py b/gooddata-sdk/gooddata_sdk/compute/model/execution.py index 046d49226..87c299a32 100644 --- a/gooddata-sdk/gooddata_sdk/compute/model/execution.py +++ b/gooddata-sdk/gooddata_sdk/compute/model/execution.py @@ -7,9 +7,9 @@ from attr.setters import frozen as frozen_attr from attrs import define, field from gooddata_api_client import models -from gooddata_api_client.model.afm import AFM -from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens -from gooddata_api_client.model.result_spec import ResultSpec +from gooddata_api_client.models.afm import AFM +from gooddata_api_client.models.afm_cancel_tokens import AfmCancelTokens +from gooddata_api_client.models.result_spec import ResultSpec from gooddata_sdk.client import GoodDataApiClient from gooddata_sdk.compute.model.attribute import Attribute @@ -351,8 +351,6 @@ def read_result(self, limit: Union[int, list[int]], offset: Union[None, int, lis result_id=self.result_id, offset=_offset, limit=_limit, - _check_return_type=False, - _return_http_data_only=False, **({"x_gdc_cancel_token": self.cancel_token} if self.cancel_token else {}), ) custom_headers = self._api_client.custom_headers diff --git a/gooddata-sdk/gooddata_sdk/compute/model/filter.py b/gooddata-sdk/gooddata_sdk/compute/model/filter.py index 23c0581bf..2a5baa304 100644 --- a/gooddata-sdk/gooddata_sdk/compute/model/filter.py +++ b/gooddata-sdk/gooddata_sdk/compute/model/filter.py @@ -6,13 +6,13 @@ from typing import Any, Optional, Union import attrs -from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline +from gooddata_api_client.models.inline_filter_definition_inline import InlineFilterDefinitionInline +from pydantic import BaseModel if find_spec("icu") is not None: from icu import Locale, SimpleDateFormat # type: ignore[import-not-found] import gooddata_api_client.models as afm_models -from gooddata_api_client.model_utils import OpenApiModel from gooddata_api_client.models import AbsoluteDateFilterAbsoluteDateFilter as AbsoluteDateFilterBody from gooddata_api_client.models import ( ComparisonMeasureValueFilterComparisonMeasureValueFilter as ComparisonMeasureValueFilterBody, @@ -99,7 +99,7 @@ def values(self) -> list[str]: def is_noop(self) -> bool: return False - def as_api_model(self) -> OpenApiModel: + def as_api_model(self) -> BaseModel: raise NotImplementedError() def __eq__(self, other: object) -> bool: @@ -110,8 +110,8 @@ class PositiveAttributeFilter(AttributeFilter): def as_api_model(self) -> afm_models.PositiveAttributeFilter: label_id = _to_identifier(self._label) elements = afm_models.AttributeFilterElements(values=self.values) - body = PositiveAttributeFilterBody(label=label_id, _in=elements, _check_type=False) - return afm_models.PositiveAttributeFilter(body, _check_type=False) + body = PositiveAttributeFilterBody(label=label_id, _in=elements) + return afm_models.PositiveAttributeFilter(body) def description(self, labels: dict[str, str], format_locale: Optional[str] = None) -> str: label_id = self.label.id if isinstance(self.label, ObjId) else self.label @@ -126,7 +126,7 @@ def is_noop(self) -> bool: def as_api_model(self) -> afm_models.NegativeAttributeFilter: label_id = _to_identifier(self._label) elements = afm_models.AttributeFilterElements(values=self.values) - body = NegativeAttributeFilterBody(label=label_id, not_in=elements, _check_type=False) + body = NegativeAttributeFilterBody(label=label_id, not_in=elements) return afm_models.NegativeAttributeFilter(body) def description(self, labels: dict[str, str], format_locale: Optional[str] = None) -> str: @@ -168,9 +168,8 @@ def __attrs_post_init__(self) -> None: def as_api_model(self) -> afm_models.BoundedFilter: return afm_models.BoundedFilter( granularity=self.granularity, - _from=self.from_shift, + var_from=self.from_shift, to=self.to_shift, - _check_type=False, ) @@ -223,9 +222,8 @@ def as_api_model(self) -> afm_models.RelativeDateFilter: body_params = { "dataset": self.dataset.as_afm_id(), "granularity": self.granularity, - "_from": self.from_shift, + "var_from": self.from_shift, "to": self.to_shift, - "_check_type": False, } if self.bounded_filter is not None: @@ -327,9 +325,8 @@ def is_noop(self) -> bool: def as_api_model(self) -> afm_models.AbsoluteDateFilter: body = AbsoluteDateFilterBody( dataset=self.dataset.as_afm_id(), - _from=self._from_date, + var_from=self._from_date, to=self._to_date, - _check_type=False, ) return afm_models.AbsoluteDateFilter(body) @@ -450,7 +447,6 @@ def as_api_model(self) -> Union[afm_models.ComparisonMeasureValueFilter, afm_mod kwargs = dict( measure=measure, operator=self.operator, - _check_type=False, ) if self.treat_nulls_as is not None: kwargs["treat_null_values_as"] = self.treat_nulls_as @@ -461,7 +457,7 @@ def as_api_model(self) -> Union[afm_models.ComparisonMeasureValueFilter, afm_mod body = ComparisonMeasureValueFilterBody(**kwargs) return afm_models.ComparisonMeasureValueFilter(body) else: - kwargs["_from"] = min(self.values) + kwargs["var_from"] = min(self.values) kwargs["to"] = max(self.values) body = RangeMeasureValueFilterBody(**kwargs) @@ -526,9 +522,7 @@ def as_api_model(self) -> afm_models.RankingFilter: dimensionality = {} if self.dimensionality: dimensionality["dimensionality"] = [_to_identifier(d) for d in self.dimensionality] - body = RankingFilterBody( - measures=measures, operator=self.operator, value=self.value, _check_type=False, **dimensionality - ) + body = RankingFilterBody(measures=measures, operator=self.operator, value=self.value, **dimensionality) return afm_models.RankingFilter(body) def description(self, labels: dict[str, str], format_locale: Optional[str] = None) -> str: @@ -585,4 +579,4 @@ def as_api_model(self) -> afm_models.InlineFilterDefinition: if self.local_identifier is not None: kwargs["local_identifier"] = str(self.local_identifier) body = InlineFilterDefinitionInline(self.maql, **kwargs) - return afm_models.InlineFilterDefinition(body, _check_type=False) + return afm_models.InlineFilterDefinition(body) diff --git a/gooddata-sdk/gooddata_sdk/compute/model/metric.py b/gooddata-sdk/gooddata_sdk/compute/model/metric.py index 8f8b44887..5bc10772c 100644 --- a/gooddata-sdk/gooddata_sdk/compute/model/metric.py +++ b/gooddata-sdk/gooddata_sdk/compute/model/metric.py @@ -4,7 +4,7 @@ from typing import Optional, Union import gooddata_api_client.models as afm_models -from gooddata_api_client.model_utils import OpenApiModel +from pydantic import BaseModel from gooddata_sdk.compute.model.attribute import Attribute from gooddata_sdk.compute.model.base import ExecModelEntity, Filter, ObjId @@ -32,7 +32,7 @@ def as_api_model(self) -> afm_models.MeasureItem: return afm_models.MeasureItem(local_identifier=self._local_id, definition=definition) - def _body_as_api_model(self) -> OpenApiModel: + def _body_as_api_model(self) -> BaseModel: raise NotImplementedError() @@ -103,21 +103,19 @@ def _body_as_api_model(self) -> afm_models.SimpleMeasureDefinition: # aggregation is optional yet the model bombs if None is sent :( if self.aggregation is not None: return afm_models.SimpleMeasureDefinition( - afm_models.SimpleMeasureDefinitionMeasure( - item=self.item.as_afm_id(), + measure=afm_models.SimpleMeasureDefinitionMeasure( + item=self.item.as_afm_id_core(), aggregation=self.aggregation, compute_ratio=self.compute_ratio, filters=_filters, - _check_type=False, ) ) else: return afm_models.SimpleMeasureDefinition( - afm_models.SimpleMeasureDefinitionMeasure( - item=self.item.as_afm_id(), + measure=afm_models.SimpleMeasureDefinitionMeasure( + item=self.item.as_afm_id_core(), compute_ratio=self.compute_ratio, filters=_filters, - _check_type=False, ) ) diff --git a/gooddata-sdk/gooddata_sdk/compute/service.py b/gooddata-sdk/gooddata_sdk/compute/service.py index 64d2e31b3..be7aac2d4 100644 --- a/gooddata-sdk/gooddata_sdk/compute/service.py +++ b/gooddata-sdk/gooddata_sdk/compute/service.py @@ -7,14 +7,14 @@ from typing import Any, Optional from gooddata_api_client import ApiException -from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens -from gooddata_api_client.model.chat_history_request import ChatHistoryRequest -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_request import ChatRequest -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.saved_visualization import SavedVisualization -from gooddata_api_client.model.search_request import SearchRequest -from gooddata_api_client.model.search_result import SearchResult +from gooddata_api_client.models.afm_cancel_tokens import AfmCancelTokens +from gooddata_api_client.models.chat_history_request import ChatHistoryRequest +from gooddata_api_client.models.chat_history_result import ChatHistoryResult +from gooddata_api_client.models.chat_request import ChatRequest +from gooddata_api_client.models.chat_result import ChatResult +from gooddata_api_client.models.saved_visualization import SavedVisualization +from gooddata_api_client.models.search_request import SearchRequest +from gooddata_api_client.models.search_result import SearchResult from gooddata_sdk.client import GoodDataApiClient from gooddata_sdk.compute.model.execution import ( @@ -49,9 +49,7 @@ def for_exec_def(self, workspace_id: str, exec_def: ExecutionDefinition) -> Exec exec_def: execution definition - this prescribes what to calculate, how to place labels and metric values into dimensions """ - response, _, headers = self._actions_api.compute_report( - workspace_id, exec_def.as_api_model(), _check_return_type=False, _return_http_data_only=False - ) + response, _, headers = self._actions_api.compute_report(workspace_id, exec_def.as_api_model()) return Execution( api_client=self._api_client, @@ -76,8 +74,6 @@ def retrieve_result_cache_metadata(self, workspace_id: str, result_id: str) -> R result_cache_metadata, _, http_headers = self._actions_api.retrieve_execution_metadata( workspace_id, result_id, - _check_return_type=False, - _return_http_data_only=False, ) custom_headers = self._api_client.custom_headers if "X-GDC-TRACE-ID" in custom_headers and "X-GDC-TRACE-ID" in http_headers: @@ -136,7 +132,7 @@ def ai_chat(self, workspace_id: str, question: str) -> ChatResult: ChatResult: Chat response """ chat_request = ChatRequest(question=question) - response = self._actions_api.ai_chat(workspace_id, chat_request, _check_return_type=False) + response = self._actions_api.ai_chat(workspace_id, chat_request) return response def _parse_sse_events(self, raw: str) -> Iterator[Any]: @@ -161,9 +157,7 @@ def ai_chat_stream(self, workspace_id: str, question: str) -> Iterator[Any]: Iterator[Any]: Yields parsed JSON objects from each SSE event's data field """ chat_request = ChatRequest(question=question) - response = self._actions_api.ai_chat_stream( - workspace_id, chat_request, _check_return_type=False, _preload_content=False - ) + response = self._actions_api.ai_chat_stream_without_preload_content(workspace_id, chat_request) buffer = "" try: for chunk in response.stream(decode_content=True): @@ -194,7 +188,7 @@ def get_ai_chat_history( chat_history_request = ChatHistoryRequest( chat_history_interaction_id=chat_history_interaction_id, reset=False, thread_id_suffix=thread_id_suffix ) - response = self._actions_api.ai_chat_history(workspace_id, chat_history_request, _check_return_type=False) + response = self._actions_api.ai_chat_history(workspace_id, chat_history_request) return response def reset_ai_chat_history(self, workspace_id: str) -> None: @@ -205,7 +199,7 @@ def reset_ai_chat_history(self, workspace_id: str) -> None: workspace_id (str): workspace identifier """ chat_history_request = ChatHistoryRequest(reset=True) - self._actions_api.ai_chat_history(workspace_id, chat_history_request, _check_return_type=False) + self._actions_api.ai_chat_history(workspace_id, chat_history_request) def set_ai_chat_history_feedback( self, @@ -229,7 +223,7 @@ def set_ai_chat_history_feedback( thread_id_suffix=thread_id_suffix, reset=False, ) - self._actions_api.ai_chat_history(workspace_id, chat_history_request, _check_return_type=False) + self._actions_api.ai_chat_history(workspace_id, chat_history_request) def set_ai_chat_history_saved_visualization( self, @@ -259,7 +253,7 @@ def set_ai_chat_history_saved_visualization( thread_id_suffix=thread_id_suffix, reset=False, ) - self._actions_api.ai_chat_history(workspace_id, chat_history_request, _check_return_type=False) + self._actions_api.ai_chat_history(workspace_id, chat_history_request) def search_ai( self, @@ -302,7 +296,7 @@ def search_ai( if title_to_descriptor_ratio is not None: search_params["title_to_descriptor_ratio"] = title_to_descriptor_ratio search_request = SearchRequest(question=question, **search_params) - response = self._actions_api.ai_search(workspace_id, search_request, _check_return_type=False) + response = self._actions_api.ai_search(workspace_id, search_request) return response def cancel_executions(self, executions: dict[str, dict[str, str]]) -> None: @@ -339,4 +333,4 @@ def sync_metadata(self, workspace_id: str, async_req: bool = False) -> None: Returns: None """ - self._actions_api.metadata_sync(workspace_id, async_req=async_req, _check_return_type=False) + self._actions_api.metadata_sync(workspace_id, async_req=async_req) diff --git a/gooddata-sdk/gooddata_sdk/utils.py b/gooddata-sdk/gooddata_sdk/utils.py index 7f45b8a15..7b62c79c1 100644 --- a/gooddata-sdk/gooddata_sdk/utils.py +++ b/gooddata-sdk/gooddata_sdk/utils.py @@ -17,7 +17,7 @@ from cattrs import structure from cattrs.errors import ClassValidationError from gooddata_api_client import ApiAttributeError -from gooddata_api_client.model_utils import OpenApiModel +from pydantic import BaseModel from gooddata_sdk.compute.model.attribute import Attribute from gooddata_sdk.compute.model.base import ObjId @@ -101,7 +101,7 @@ def load_all_entities(get_page_func: functools.partial[Any], page_size: int = 50 >>> import gooddata_api_client.apis as apis >>> api = apis.EntitiesApi(api_client.ApiClient()) >>> get_func = functools.partial(api.get_all_entities_visualization_objects, 'some-workspace-id', - >>> include=["ALL"], _check_return_type=False) + >>> include=["ALL"]) >>> vis_objects = load_all_entities(get_func) :param get_page_func: an API controller from the metadata client @@ -364,9 +364,9 @@ def safeget(var: Any, path: list[str]) -> Any: if len(path) == 0: # base case: we have reached the innermost key return var - elif not isinstance(var, (dict, OpenApiModel)): + elif not isinstance(var, (dict, BaseModel)): # base case: var is not a dictionary, so we can't proceed - # in this repository, we also use OpenApiModel objects, which support "to_dict" + # in this repository, we also use BaseModel objects, which support "to_dict" return None else: # recursive case: we still have keys to traverse diff --git a/gooddata-sdk/gooddata_sdk/visualization.py b/gooddata-sdk/gooddata_sdk/visualization.py index 8d65ac0f3..13ce3329b 100644 --- a/gooddata-sdk/gooddata_sdk/visualization.py +++ b/gooddata-sdk/gooddata_sdk/visualization.py @@ -757,10 +757,7 @@ def get_visualizations(self, workspace_id: str) -> list[Visualization]: each visualization will contain side loaded metadata about the entities it references """ get_func = functools.partial( - self._entities_api.get_all_entities_visualization_objects, - workspace_id, - include=["ALL"], - _check_return_type=False, + self._entities_api.get_all_entities_visualization_objects, workspace_id, include=["ALL"] ) vis_objects = load_all_entities(get_func) @@ -788,11 +785,7 @@ def get_visualization( A single visualization object contains side loaded metadata about the entities it references """ vis_obj = self._entities_api.get_entity_visualization_objects( - workspace_id, - object_id=visualization_id, - include=["ALL"], - _check_return_type=False, - _request_timeout=timeout, + workspace_id, object_id=visualization_id, include=["ALL"], _request_timeout=timeout ) side_loads = None if hasattr(vis_obj, "included"): diff --git a/gooddata-sdk/test-requirements.txt b/gooddata-sdk/test-requirements.txt index e3987ba3a..7212b484c 100644 --- a/gooddata-sdk/test-requirements.txt +++ b/gooddata-sdk/test-requirements.txt @@ -5,6 +5,7 @@ pytest-order~=1.3.0 vcrpy~=7.0.0 # TODO - Bump the version together with bumping the version of openapi generator urllib3==1.26.9 +pydantic >= 2 python-dotenv~=1.0.0 attrs>=21.4.0,<=24.2.0 cattrs>=22.1.0,<=24.1.1 diff --git a/gooddata-sdk/tests/catalog/test_catalog_data_source.py b/gooddata-sdk/tests/catalog/test_catalog_data_source.py index 62073708c..432fe3444 100644 --- a/gooddata-sdk/tests/catalog/test_catalog_data_source.py +++ b/gooddata-sdk/tests/catalog/test_catalog_data_source.py @@ -7,7 +7,7 @@ from unittest.mock import MagicMock import pytest -from gooddata_api_client.model.json_api_data_source_in_attributes import JsonApiDataSourceInAttributes +from gooddata_api_client.models.json_api_data_source_in_attributes import JsonApiDataSourceInAttributes from gooddata_sdk import ( BasicCredentials, CatalogDataSource, diff --git a/gooddata-sdk/tests/catalog/utils.py b/gooddata-sdk/tests/catalog/utils.py index a78620ba1..5ceb2ed89 100644 --- a/gooddata-sdk/tests/catalog/utils.py +++ b/gooddata-sdk/tests/catalog/utils.py @@ -2,7 +2,7 @@ import json from pathlib import Path -from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces +from gooddata_api_client.models.declarative_workspaces import DeclarativeWorkspaces from gooddata_sdk import GoodDataSdk _current_dir = Path(__file__).parent.absolute() diff --git a/scripts/generate_client.sh b/scripts/generate_client.sh index a83274fa7..61210b0d4 100755 --- a/scripts/generate_client.sh +++ b/scripts/generate_client.sh @@ -127,7 +127,7 @@ docker run --rm \ -v "${ROOT_DIR}:/local" \ -u $(id -u ${USER}):$(id -g ${USER}) \ ${CONN_NETWORK_ARG} \ - openapitools/openapi-generator-cli:v6.0.1 generate \ + openapitools/openapi-generator-cli:v7.11.0 generate \ -c "/local/.openapi-generator/configs/${GD_API_CLIENT}.yaml" \ -i "${GD_API_URI_PATH}" \ -o "/local/${GD_API_CLIENT}"